Merge branch 'master' into mattmatt/decode-null-into-nil

mdmathias · web-flow · commit 738726f0bfdf · 2016-09-08T17:16:48.000-04:00
diff --git a/Configurations/Base.xcconfig b/Configurations/Base.xcconfig
@@ -42,3 +42,5 @@ ENABLE_BITCODE[sdk=macosx*] = NO
 CODE_SIGN_IDENTITY[sdk=macosx*] = -
 CODE_SIGN_IDENTITY[sdk=iphoneos*] = iPhone Developer
 CODE_SIGN_IDENTITY[sdk=appletvos*] = iPhone Developer
+
+SWIFT_VERSION = 2.3
diff --git a/Configurations/Release.xcconfig b/Configurations/Release.xcconfig
@@ -7,5 +7,5 @@ VALIDATE_PRODUCT = YES
 GCC_OPTIMIZATION_LEVEL = s
 ENABLE_NS_ASSERTIONS = NO
 GCC_PREPROCESSOR_DEFINITIONS =
-SWIFT_OPTIMIZATION_LEVEL = -O
+SWIFT_OPTIMIZATION_LEVEL = -Owholemodule
 COPY_PHASE_STRIP = YES
diff --git a/Freddy.xcodeproj/project.pbxproj b/Freddy.xcodeproj/project.pbxproj
@@ -462,9 +462,11 @@
 					};
 					DB6ADF3D1C23612000D77BF1 = {
 						CreatedOnToolsVersion = 7.2;
+						LastSwiftMigration = 0800;
 					};
 					DB6ADF461C23612000D77BF1 = {
 						CreatedOnToolsVersion = 7.2;
+						LastSwiftMigration = 0800;
 					};
 					DB6ADF591C23612900D77BF1 = {
 						CreatedOnToolsVersion = 7.2;
diff --git a/Sources/JSONDecodable.swift b/Sources/JSONDecodable.swift
@@ -67,10 +67,19 @@ extension String: JSONDecodable {
     ///           an instance of `String` cannot be created from the `JSON` value that was
     ///           passed to this initializer.
     public init(json: JSON) throws {
-        guard case let .String(string) = json else {
+        
+        switch json {
+        case let .String(string):
+            self = string
+        case let .Int(int):
+            self = String(int)
+        case let .Bool(bool):
+            self = String(bool)
+        case let .Double(double):
+            self = String(double)
+        default:
             throw JSON.Error.ValueNotConvertible(value: json, to: Swift.String)
         }
-        self = string
     }
     
 }
@@ -110,6 +119,7 @@ extension RawRepresentable where RawValue: JSONDecodable {
 internal extension JSON {
 
     /// Retrieves a `[JSON]` from the JSON.
+    /// - parameter: A `JSON` to be used to create the returned `Array`.
     /// - returns: An `Array` of `JSON` elements
     /// - throws: Any of the `JSON.Error` cases thrown by `decode(type:)`.
     /// - seealso: `JSON.decode(_:type:)`
@@ -122,6 +132,7 @@ internal extension JSON {
     }
     
     /// Retrieves a `[String: JSON]` from the JSON.
+    /// - parameter: A `JSON` to be used to create the returned `Dictionary`.
     /// - returns: An `Dictionary` of `String` mapping to `JSON` elements
     /// - throws: Any of the `JSON.Error` cases thrown by `decode(type:)`.
     /// - seealso: `JSON.decode(_:type:)`
@@ -135,10 +146,8 @@ internal extension JSON {
     
     /// Attempts to decode many values from a descendant JSON array at a path
     /// into JSON.
-    /// - parameter type: If the context this method is called from does not
-    ///   make the return type clear, pass a type implementing `JSONDecodable`
-    ///   to disambiguate the type to decode with.
-    /// - returns: An `Array` of decoded elements
+    /// - parameter: A `JSON` to be used to create the returned `Array` of some type conforming to `JSONDecodable`.
+    /// - returns: An `Array` of `Decoded` elements.
     /// - throws: Any of the `JSON.Error` cases thrown by `decode(type:)`, as
     ///   well as any error that arises from decoding the contained values.
     /// - seealso: `JSON.decode(_:type:)`
@@ -148,4 +157,21 @@ internal extension JSON {
         return try getArray(json).map(Decoded.init)
     }
     
+    /// Attempts to decode many values from a descendant JSON object at a path
+    /// into JSON.
+    /// - returns: A `Dictionary` of string keys and `Decoded` values.
+    /// - throws: One of the `JSON.Error` cases thrown by `decode(_:type:)` or
+    ///           any error that arises from decoding the contained values.
+    /// - seealso: `JSON.decode(_:type:)`
+    static func getDictionaryOf<Decoded: JSONDecodable>(json: JSON) throws -> [Swift.String: Decoded] {
+        guard case let .Dictionary(dictionary) = json else {
+            throw Error.ValueNotConvertible(value: json, to: Swift.Dictionary<Swift.String, Decoded>)
+        }
+        var decodedDictionary = Swift.Dictionary<Swift.String, Decoded>(minimumCapacity: dictionary.count)
+        for (key, value) in dictionary {
+            decodedDictionary[key] = try Decoded(json: value)
+        }
+        return decodedDictionary
+    }
+    
 }
diff --git a/Sources/JSONParser.swift b/Sources/JSONParser.swift
@@ -158,8 +158,12 @@ public struct JSONParser {
                 return try decodeNumberAsString(start)
             }
         }
-        
-        throw Error.ValueInvalid(offset: loc, character: UnicodeScalar(input[loc]))
+
+        if loc < input.count {
+            throw Error.ValueInvalid(offset: loc, character: UnicodeScalar(input[loc]))
+        } else {
+            throw Error.EndOfStreamUnexpected
+        }
     }
 
     private mutating func skipWhitespace() {
@@ -659,12 +663,16 @@ private struct NumberParser {
             return
         }
 
-        guard input[loc] == Literal.PERIOD else {
+        switch input[loc] {
+        case Literal.PERIOD:
+            state = .Decimal
+
+        case Literal.e, Literal.E:
+            state = .Exponent
+
+        default:
             state = .Done
-            return
         }
-
-        state = .Decimal
     }
 
     mutating func parsePreDecimalDigits(@noescape f: (UInt8) throws -> Void) rethrows {
diff --git a/Sources/JSONSubscripting.swift b/Sources/JSONSubscripting.swift
@@ -49,6 +49,7 @@ extension JSONPathType {
 extension String: JSONPathType {
 
     /// A method used to retrieve a value from a given dictionary for a specific key.
+    /// - parameter dictionary: A `Dictionary` with `String` keys and `JSON` values.
     /// - throws: `.KeyNotFound` with an associated value of `self`, where `self` is a `String`, 
     ///           should the key not be present within the `JSON`.
     /// - returns: The `JSON` value associated with the given key.
@@ -64,6 +65,7 @@ extension String: JSONPathType {
 extension Int: JSONPathType {
 
     /// A method used to retrieve a value from a given array for a specific index.
+    /// - parameter array: An `Array` of `JSON`.
     /// - throws: `.IndexOutOfBounds` with an associated value of `self`, where `self` is an `Int`, 
     ///           should the index not be within the valid range for the array of `JSON`.
     /// - returns: The `JSON` value found at the given index.
@@ -189,7 +191,7 @@ extension JSON {
         return try JSON.getArray(valueAtPath(path))
     }
 
-    /// Attempts to decodes many values from a desendant JSON array at a path
+    /// Attempts to decode many values from a descendant JSON array at a path
     /// into JSON.
     /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
     /// - parameter type: If the context this method is called from does not
@@ -211,6 +213,20 @@ extension JSON {
     public func dictionary(path: JSONPathType...) throws -> [Swift.String: JSON] {
         return try JSON.getDictionary(valueAtPath(path))
     }
+    
+    /// Attempts to decode many values from a descendant JSON object at a path
+    /// into JSON.
+    /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
+    /// - parameter type: If the context this method is called from does not
+    ///                   make the return type clear, pass a type implementing `JSONDecodable`
+    ///                   to disambiguate the value type to decode with.
+    /// - returns: A `Dictionary` of `String` keys and decoded values.
+    /// - throws: One of the `JSON.Error` cases thrown by `decode(_:type:)` or
+    ///           any error that arises from decoding the contained values.
+    /// - seealso: `JSON.decode(_:type:)`
+    public func dictionaryOf<Decoded: JSONDecodable>(path: JSONPathType..., type: Decoded.Type = Decoded.self) throws -> [Swift.String: Decoded] {
+        return try JSON.getDictionaryOf(valueAtPath(path))
+    }
 
 }
 
@@ -376,6 +392,9 @@ extension JSON {
     /// JSON.
     /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
     /// - parameter alongPath: Options that control what should be done with values that are `null` or keys that are missing.
+    /// - parameter type: If the context this method is called from does not
+    ///                   make the return type clear, pass a type implementing `JSONDecodable`
+    ///                   to disambiguate the value type to decode with.
     /// - returns: An `Array` of decoded elements if found, otherwise `nil`.
     /// - throws: One of the following errors contained in `JSON.Error`:
     ///   * `KeyNotFound`: A key `path` does not exist inside a descendant
@@ -409,6 +428,29 @@ extension JSON {
     public func dictionary(path: JSONPathType..., alongPath options: SubscriptingOptions) throws -> [Swift.String: JSON]? {
         return try mapOptionalAtPath(path, alongPath: options, transform: JSON.getDictionary)
     }
+    
+    /// Optionally attempts to decode many values from a descendant object at a path
+    /// into JSON.
+    /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
+    /// - parameter alongPath: Options that control what should be done with values that are `null` or keys that are missing.
+    /// - parameter type: If the context this method is called from does not
+    ///                   make the return type clear, pass a type implementing `JSONDecodable`
+    ///                   to disambiguate the value type to decode with.
+    /// - returns: A `Dictionary` of `String` mapping to decoded elements if a
+    ///            value could be found, otherwise `nil`.
+    /// - throws: One of the following errors contained in `JSON.Error`:
+    ///   * `KeyNotFound`: A key `path` does not exist inside a descendant
+    ///     `JSON` dictionary.
+    ///   * `IndexOutOfBounds`: An index `path` is outside the bounds of a
+    ///     descendant `JSON` array.
+    ///   * `UnexpectedSubscript`: A `path` item cannot be used with the
+    ///     corresponding `JSON` value.
+    ///   * `TypeNotConvertible`: The target value's type inside of the `JSON`
+    ///     instance does not match the decoded value.
+    ///   * Any error that arises from decoding the value.
+    public func dictionaryOf<Decoded: JSONDecodable>(path: JSONPathType..., alongPath options: SubscriptingOptions, type: Decoded.Type = Decoded.self) throws -> [Swift.String: Decoded]? {
+        return try mapOptionalAtPath(path, alongPath: options, transform: JSON.getDictionaryOf)
+    }
 
 }
 
@@ -436,7 +478,7 @@ extension JSON {
     
     /// Retrieves a `Double` from a path into JSON or a fallback if not found.
     /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
-    /// - parameter fallback: Array to use when one is missing at the subscript.
+    /// - parameter fallback: `Double` to use when one is missing at the subscript.
     /// - returns: A floating-point `Double`
     /// - throws: One of the `JSON.Error` cases thrown by calling `mapOptionalAtPath(_:fallback:transform:)`.
     /// - seealso: `optionalAtPath(_:ifNotFound)`.
@@ -446,7 +488,7 @@ extension JSON {
     
     /// Retrieves an `Int` from a path into JSON or a fallback if not found.
     /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
-    /// - parameter fallback: Array to use when one is missing at the subscript.
+    /// - parameter fallback: `Int` to use when one is missing at the subscript.
     /// - returns: A numeric `Int`
     /// - throws: One of the following errors contained in `JSON.Error`:
     ///   * `KeyNotFound`: A key `path` does not exist inside a descendant
@@ -463,7 +505,7 @@ extension JSON {
     
     /// Retrieves a `String` from a path into JSON or a fallback if not found.
     /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
-    /// - parameter fallback: Array to use when one is missing at the subscript.
+    /// - parameter fallback: `String` to use when one is missing at the subscript.
     /// - returns: A textual `String`
     /// - throws: One of the following errors contained in `JSON.Error`:
     ///   * `KeyNotFound`: A key `path` does not exist inside a descendant
@@ -480,7 +522,7 @@ extension JSON {
     
     /// Retrieves a `Bool` from a path into JSON or a fallback if not found.
     /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
-    /// - parameter fallback: Array to use when one is missing at the subscript.
+    /// - parameter fallback: `Bool` to use when one is missing at the subscript.
     /// - returns: A truthy `Bool`
     /// - throws: One of the following errors contained in `JSON.Error`:
     ///   * `KeyNotFound`: A key `path` does not exist inside a descendant
@@ -497,7 +539,7 @@ extension JSON {
     
     /// Retrieves a `[JSON]` from a path into JSON or a fallback if not found.
     /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
-    /// - parameter fallback: Array to use when one is missing at the subscript.
+    /// - parameter fallback: `Array` to use when one is missing at the subscript.
     /// - returns: An `Array` of `JSON` elements
     /// - throws: One of the following errors contained in `JSON.Error`:
     ///   * `KeyNotFound`: A key `path` does not exist inside a descendant
@@ -515,7 +557,7 @@ extension JSON {
     /// Attempts to decodes many values from a desendant JSON array at a path
     /// into the recieving structure, returning a fallback if not found.
     /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
-    /// - parameter fallback: Array to use when one is missing at the subscript.
+    /// - parameter fallback: `Array` to use when one is missing at the subscript.
     /// - returns: An `Array` of decoded elements
     /// - throws: One of the following errors contained in `JSON.Error`:
     ///   * `KeyNotFound`: A key `path` does not exist inside a descendant
@@ -534,7 +576,7 @@ extension JSON {
     /// Retrieves a `[String: JSON]` from a path into JSON or a fallback if not
     /// found.
     /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
-    /// - parameter fallback: Value to use when one is missing at the subscript
+    /// - parameter fallback: `Dictionary` to use when one is missing at the subscript.
     /// - returns: An `Dictionary` of `String` mapping to `JSON` elements
     /// - throws: One of the following errors contained in `JSON.Error`:
     ///   * `KeyNotFound`: A key `path` does not exist inside a descendant
@@ -549,6 +591,26 @@ extension JSON {
         return try mapOptionalAtPath(path, fallback: fallback, transform: JSON.getDictionary)
     }
     
+    /// Attempts to decode many values from a descendant JSON object at a path
+    /// into the receiving structure, returning a fallback if not found.
+    /// - parameter path: 0 or more `String` or `Int` that subscript the `JSON`
+    /// - parameter fallback: Value to use when one is missing at the subscript
+    /// - returns: A `Dictionary` of `String` mapping to decoded elements.
+    /// - throws: One of the following errors contained in `JSON.Error`:
+    ///   * `KeyNotFound`: A key `path` does not exist inside a descendant
+    ///     `JSON` dictionary.
+    ///   * `IndexOutOfBounds`: An index `path` is outside the bounds of a
+    ///     descendant `JSON` array.
+    ///   * `UnexpectedSubscript`: A `path` item cannot be used with the
+    ///     corresponding `JSON` value.
+    ///   * `TypeNotConvertible`: The target value's type inside of the `JSON`
+    ///     instance does not match the decoded value.
+    ///   * Any error that arises from decoding the value.
+    public func dictionaryOf<Decoded: JSONDecodable>(path: JSONPathType..., @autoclosure or fallback: () -> [Swift.String: Decoded]) throws -> [Swift.String: Decoded] {
+        return try mapOptionalAtPath(path, fallback: fallback, transform: JSON.getDictionaryOf)
+    }
+    
+    
 }
 
 // MARK: - Deprecated methods
diff --git a/Tests/JSONDecodableTests.swift b/Tests/JSONDecodableTests.swift
@@ -95,10 +95,28 @@ class JSONDecodableTests: XCTestCase {
         }
         
         do {
-            _ = try String(json: 4)
-            XCTFail("Should not be able to instantiate `String` with `Int` `JSON`.")
+            let four = try String(json: 4)
+            XCTAssertEqual(four, "4", "`four` and `4` should be equal.")
         } catch JSON.Error.ValueNotConvertible(let type) {
-            XCTAssert(true, "\(type) should not be covertible from 'bad' `Int.")
+            XCTAssert(true, "\(type) should be covertible from `Int.")
+        } catch {
+            XCTFail("Failed for unknown reason: \(error).")
+        }
+        
+        do {
+            let twoAndHalf = try String(json: 2.5)
+            XCTAssertEqual(twoAndHalf, "2.5", "`twoAndHalf` and `2.5` should be equal.")
+        } catch JSON.Error.ValueNotConvertible(let type) {
+            XCTAssert(true, "\(type) should be covertible from `Double.")
+        } catch {
+            XCTFail("Failed for unknown reason: \(error).")
+        }
+        
+        do {
+            let positive = try String(json: true)
+            XCTAssertEqual(positive, "true", "`positive` and `true` should be equal.")
+        } catch JSON.Error.ValueNotConvertible(let type) {
+            XCTAssert(true, "\(type) should be covertible from `Bool.")
         } catch {
             XCTFail("Failed for unknown reason: \(error).")
         }
@@ -188,6 +206,17 @@ class JSONDecodableTests: XCTestCase {
         }
     }
     
+    func testThatDictionaryOfCanReturnDictionaryOfJSONDecodable() {
+        let oneTwoThreeJSON: JSON = ["one": 1, "two": 2, "three": 3]
+        
+        do {
+            let decodedOneTwoThree = try oneTwoThreeJSON.dictionaryOf(type: Swift.Int)
+            XCTAssertEqual(decodedOneTwoThree, ["one": 1, "two": 2, "three": 3], "`decodedOneTwoThree` should be equal to `[\"one\": 1, \"two\": 2, \"three\": 3]`.")
+        } catch {
+            XCTFail("`decodedOneTwoThree` should be equal to `[\"one\": 1, \"two\": 2, \"three\": 3]`.")
+        }
+    }
+    
     func testThatNullIsDecodedToNilWhenRequestedAtTopLevel() {
         let JSONDictionary: JSON = ["key": .Null]
         
diff --git a/Tests/JSONParserTests.swift b/Tests/JSONParserTests.swift
diff --git a/Tests/JSONSubscriptingTests.swift b/Tests/JSONSubscriptingTests.swift

Original file line number	Diff line number	Diff line change
`@@ -158,8 +158,12 @@ public struct JSONParser {`
`158`	`158`	`return try decodeNumberAsString(start)`
`159`	`159`	`}`
`160`	`160`	`}`
`161`		`-`
`162`		`- throw Error.ValueInvalid(offset: loc, character: UnicodeScalar(input[loc]))`
	`161`	`+`
	`162`	`+ if loc < input.count {`
	`163`	`+ throw Error.ValueInvalid(offset: loc, character: UnicodeScalar(input[loc]))`
	`164`	`+ } else {`
	`165`	`+ throw Error.EndOfStreamUnexpected`
	`166`	`+ }`
`163`	`167`	`}`
`164`	`168`
`165`	`169`	`private mutating func skipWhitespace() {`
`@@ -659,12 +663,16 @@ private struct NumberParser {`
`659`	`663`	`return`
`660`	`664`	`}`
`661`	`665`
`662`		`- guard input[loc] == Literal.PERIOD else {`
	`666`	`+ switch input[loc] {`
	`667`	`+ case Literal.PERIOD:`
	`668`	`+ state = .Decimal`
	`669`	`+`
	`670`	`+ case Literal.e, Literal.E:`
	`671`	`+ state = .Exponent`
	`672`	`+`
	`673`	`+ default:`
`663`	`674`	`state = .Done`
`664`		`- return`
`665`	`675`	`}`
`666`		`-`
`667`		`- state = .Decimal`
`668`	`676`	`}`
`669`	`677`
`670`	`678`	`mutating func parsePreDecimalDigits(@noescape f: (UInt8) throws -> Void) rethrows {`