Merge pull request #2496 from millenomi/nsmeasurement-nscoding

Author: swift-ci

Foundation/NSMeasurement.swift

@@ -81,9 +81,39 @@ open class NSMeasurement : NSObject, NSCopying, NSSecureCoding {
 
     open class var supportsSecureCoding: Bool { return true }
 
-    open func encode(with aCoder: NSCoder) { NSUnimplemented() }
+    private enum NSCodingKeys {
+        static let value = "NS.value"
+        static let unit = "NS.unit"
+    }
 
-    public required init?(coder aDecoder: NSCoder) { NSUnimplemented() }
+    public required init?(coder aDecoder: NSCoder) {
+        let value = aDecoder.decodeDouble(forKey: NSCodingKeys.value)
+        guard let unit = aDecoder.decodeObject(of: Unit.self, forKey: NSCodingKeys.unit) else {
+            aDecoder.failWithError(NSError(domain: NSCocoaErrorDomain, code: CocoaError.coderReadCorrupt.rawValue, userInfo: [NSLocalizedDescriptionKey: "Unit class object has been corrupted!"]))
+            return nil
+        }
+        
+        self.doubleValue = value
+        self.unit = unit
+    }
+    
+    open func encode(with aCoder: NSCoder) {
+        guard aCoder.allowsKeyedCoding else {
+            fatalError("NSMeasurement cannot be encoded by non-keyed archivers")
+        }
+        
+        aCoder.encode(doubleValue, forKey: "NS.value")
+        aCoder.encode(unit, forKey: "NS.unit")
+    }
+    
+    open override func isEqual(_ object: Any?) -> Bool {
+        guard let measurement = object as? NSMeasurement else { return false }
+        return measurement.unit.isEqual(self.unit) && doubleValue == measurement.doubleValue
+    }
+    
+    open override var hash: Int {
+        return Int(doubleValue) ^ unit.hash
+    }
 }
 
 extension NSMeasurement : _StructTypeBridgeable {

Foundation/Unit.swift

@@ -94,43 +94,44 @@ open class UnitConverterLinear : UnitConverter, NSSecureCoding {
     }
 }
 
-private class UnitConverterReciprocal : UnitConverter, NSSecureCoding {
+// This must be named with a NS prefix because it can be sometimes encoded by Darwin, and we need to match the name in the archive.
+internal class NSUnitConverterReciprocal : UnitConverter, NSSecureCoding {
 
 
     private var reciprocal: Double
 
 
-    fileprivate init(reciprocal: Double) {
+    init(reciprocal: Double) {
         self.reciprocal = reciprocal
     }
 
-    fileprivate override func baseUnitValue(fromValue value: Double) -> Double {
+    override func baseUnitValue(fromValue value: Double) -> Double {
         return reciprocal / value
     }
 
-    fileprivate override func value(fromBaseUnitValue baseUnitValue: Double) -> Double {
+    override func value(fromBaseUnitValue baseUnitValue: Double) -> Double {
         return reciprocal / baseUnitValue
     }
 
-    fileprivate required convenience init?(coder aDecoder: NSCoder) {
+    required convenience init?(coder aDecoder: NSCoder) {
         guard aDecoder.allowsKeyedCoding else {
             preconditionFailure("Unkeyed coding is unsupported.")
         }
         let reciprocal = aDecoder.decodeDouble(forKey: "NS.reciprocal")
         self.init(reciprocal: reciprocal)
     }
 
-    fileprivate func encode(with aCoder: NSCoder) {
+    func encode(with aCoder: NSCoder) {
         guard aCoder.allowsKeyedCoding else {
             preconditionFailure("Unkeyed coding is unsupported.")
         }
         aCoder.encode(self.reciprocal, forKey:"NS.reciprocal")
     }
 
-    fileprivate static var supportsSecureCoding: Bool { return true }
+    static var supportsSecureCoding: Bool { return true }
 
     open override func isEqual(_ object: Any?) -> Bool {
-        guard let other = object as? UnitConverterReciprocal else {
+        guard let other = object as? NSUnitConverterReciprocal else {
             return false
         }
 
@@ -215,8 +216,8 @@ open class Dimension : Unit {
             preconditionFailure("Unkeyed coding is unsupported.")
         }
         guard
-            let symbol = aDecoder.decodeObject(forKey: "NS.symbol") as? String,
-            let converter = aDecoder.decodeObject(forKey: "NS.converter") as? UnitConverter
+            let symbol = aDecoder.decodeObject(of: NSString.self, forKey: "NS.symbol")?._swiftObject,
+            let converter = aDecoder.decodeObject(of: [UnitConverterLinear.self, NSUnitConverterReciprocal.self], forKey: "NS.converter") as? UnitConverter
             else { return nil }
         self.converter = converter
         super.init(symbol: symbol)
@@ -1168,7 +1169,7 @@ public final class UnitFuelEfficiency : Dimension {
     }
 
     private convenience init(symbol: String, reciprocal: Double) {
-        self.init(symbol: symbol, converter: UnitConverterReciprocal(reciprocal: reciprocal))
+        self.init(symbol: symbol, converter: NSUnitConverterReciprocal(reciprocal: reciprocal))
     }
 
     public class var litersPer100Kilometers: UnitFuelEfficiency {

TestFoundation/FixtureValues.swift

@@ -301,6 +301,25 @@ enum Fixtures {
         return NSMutableOrderedSet()
     }
 
+    // ===== NSMeasurement =====
+    
+    static let zeroMeasurement = TypedFixture<NSMeasurement>("NSMeasurement-Zero") {
+        let noUnit = Unit(symbol: "")
+        return NSMeasurement(doubleValue: 0, unit: noUnit)
+    }
+    
+    static let lengthMeasurement = TypedFixture<NSMeasurement>("NSMeasurement-Length") {
+        return NSMeasurement(doubleValue: 45, unit: UnitLength.miles)
+    }
+    
+    static let frequencyMeasurement = TypedFixture<NSMeasurement>("NSMeasurement-Frequency") {
+        return NSMeasurement(doubleValue: 1400, unit: UnitFrequency.megahertz)
+    }
+    
+    static let angleMeasurement = TypedFixture<NSMeasurement>("NSMeasurement-Angle") {
+        return NSMeasurement(doubleValue: 90, unit: UnitAngle.degrees)
+    }
+    
     // ===== Fixture list =====
 
     static let _listOfAllFixtures: [AnyFixture] = [
@@ -341,6 +360,10 @@ enum Fixtures {
         AnyFixture(Fixtures.orderedSetEmpty),
         AnyFixture(Fixtures.mutableOrderedSetOfNumbers),
         AnyFixture(Fixtures.mutableOrderedSetEmpty),
+        AnyFixture(Fixtures.zeroMeasurement),
+        AnyFixture(Fixtures.lengthMeasurement),
+        AnyFixture(Fixtures.frequencyMeasurement),
+        AnyFixture(Fixtures.angleMeasurement),
     ]
 
     // This ensures that we do not have fixtures with duplicate identifiers:

TestFoundation/Fixtures/macOS-10.14/NSMeasurement-Angle.archive

@@ -23,12 +23,6 @@ class CustomUnit: Unit {
 #endif
 
 class TestMeasurement: XCTestCase {
-    static var allTests: [(String, (TestMeasurement) -> () throws -> Void)] {
-        return [
-            ("testHashing", testHashing),
-        ]
-    }
-
     func testHashing() {
         let lengths: [[Measurement<UnitLength>]] = [
             [
@@ -75,5 +69,29 @@ class TestMeasurement: XCTestCase {
         checkHashable(custom, equalityOracle: { $0 == $1 })
 #endif
     }
+    
+    let fixtures = [
+        Fixtures.zeroMeasurement,
+        Fixtures.lengthMeasurement,
+        Fixtures.frequencyMeasurement,
+        Fixtures.angleMeasurement,
+    ]
 
+    func testCodingRoundtrip() throws {
+        for fixture in fixtures {
+            try fixture.assertValueRoundtripsInCoder()
+        }
+    }
+    
+    func testLoadedValuesMatch() throws {
+        for fixture in fixtures {
+            try fixture.assertLoadedValuesMatch()
+        }
+    }
+    
+    static let allTests = [
+        ("testHashing", testHashing),
+        ("testCodingRoundtrip", testCodingRoundtrip),
+        ("testLoadedValuesMatch", testLoadedValuesMatch),
+    ]
 }

TestFoundation/Fixtures/macOS-10.14/NSMeasurement-Frequency.archive

@@ -273,7 +273,7 @@ class TestUnitConverter: XCTestCase {
         XCTAssertNotEqual(u1, u4)
         XCTAssertNotEqual(u4, u1)
 
-        // Cannot test UnitConverterReciprocal due to no support for @testable import.
+        // Cannot test NSUnitConverterReciprocal due to no support for @testable import.
     }
 
 }