✨ better support for Int-based dictionaries

Signed-off-by: Florian Krüger <[email protected]>

Author: floriankrueger

JSONCodable.xcodeproj/project.pbxproj

@@ -32,7 +32,8 @@
 		A1B71C7E1D37E90B006DA33A /* MirrorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A1B71C7D1D37E90B006DA33A /* MirrorTests.swift */; };
 		A1B71C801D37E982006DA33A /* ClassInheritance.swift in Sources */ = {isa = PBXBuildFile; fileRef = A1B71C7F1D37E982006DA33A /* ClassInheritance.swift */; };
 		A5481F9E22D637B600D8DF85 /* IntBasedTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5481F9D22D637B600D8DF85 /* IntBasedTests.swift */; };
-		A5481FA022D6386D00D8DF85 /* Companies.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5481F9F22D6386D00D8DF85 /* Companies.swift */; };
+		A5481FA022D6386D00D8DF85 /* IntBasedModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5481F9F22D6386D00D8DF85 /* IntBasedModel.swift */; };
+		A5481FA722D71BFE00D8DF85 /* ComplexIntBasedModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = A5481FA622D71BFE00D8DF85 /* ComplexIntBasedModel.swift */; };
 		BD885BBE1D17358E00CA767A /* EncodeNestingTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = BD885BBD1D17358E00CA767A /* EncodeNestingTests.swift */; };
 		BD885BC01D173A0700CA767A /* PropertyItem.swift in Sources */ = {isa = PBXBuildFile; fileRef = BD885BBF1D173A0700CA767A /* PropertyItem.swift */; };
 		BDD667CC1D1F3572003F94D7 /* Messages.swift in Sources */ = {isa = PBXBuildFile; fileRef = BDD667CB1D1F3572003F94D7 /* Messages.swift */; };
@@ -78,7 +79,8 @@
 		A1B71C7D1D37E90B006DA33A /* MirrorTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MirrorTests.swift; sourceTree = "<group>"; };
 		A1B71C7F1D37E982006DA33A /* ClassInheritance.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ClassInheritance.swift; sourceTree = "<group>"; };
 		A5481F9D22D637B600D8DF85 /* IntBasedTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IntBasedTests.swift; sourceTree = "<group>"; };
-		A5481F9F22D6386D00D8DF85 /* Companies.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Companies.swift; sourceTree = "<group>"; };
+		A5481F9F22D6386D00D8DF85 /* IntBasedModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IntBasedModel.swift; sourceTree = "<group>"; };
+		A5481FA622D71BFE00D8DF85 /* ComplexIntBasedModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ComplexIntBasedModel.swift; sourceTree = "<group>"; };
 		BD885BBD1D17358E00CA767A /* EncodeNestingTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EncodeNestingTests.swift; sourceTree = "<group>"; };
 		BD885BBF1D173A0700CA767A /* PropertyItem.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PropertyItem.swift; sourceTree = "<group>"; };
 		BDD667CB1D1F3572003F94D7 /* Messages.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Messages.swift; sourceTree = "<group>"; };
@@ -125,7 +127,8 @@
 				9E455C081BCE1DE100070A4F /* Company.swift */,
 				9ECF00C11BCF6E43008D557C /* ImageAsset.swift */,
 				A1B71C7F1D37E982006DA33A /* ClassInheritance.swift */,
-				A5481F9F22D6386D00D8DF85 /* Companies.swift */,
+				A5481F9F22D6386D00D8DF85 /* IntBasedModel.swift */,
+				A5481FA622D71BFE00D8DF85 /* ComplexIntBasedModel.swift */,
 			);
 			name = Models;
 			sourceTree = "<group>";
@@ -300,7 +303,7 @@
 			files = (
 				52E8F44F1C9087D200F40F7F /* UtilityTests.swift in Sources */,
 				A1B71C801D37E982006DA33A /* ClassInheritance.swift in Sources */,
-				A5481FA022D6386D00D8DF85 /* Companies.swift in Sources */,
+				A5481FA022D6386D00D8DF85 /* IntBasedModel.swift in Sources */,
 				5211CD0A1CE2EBFB0097F255 /* NestItem.swift in Sources */,
 				A5481F9E22D637B600D8DF85 /* IntBasedTests.swift in Sources */,
 				A1B71C7E1D37E90B006DA33A /* MirrorTests.swift in Sources */,
@@ -318,6 +321,7 @@
 				9E455C051BCE1D0700070A4F /* User.swift in Sources */,
 				BD885BC01D173A0700CA767A /* PropertyItem.swift in Sources */,
 				9E455C091BCE1DE100070A4F /* Company.swift in Sources */,
+				A5481FA722D71BFE00D8DF85 /* ComplexIntBasedModel.swift in Sources */,
 				A10DFC4C1DF71BF400B7D6D7 /* ClassInheritanceTests.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

JSONCodable/JSONDecodable.swift

@@ -419,6 +419,40 @@ public class JSONDecoder {
         return decoded
     }
 
+    // [Int:[JSONDecodable]]
+    public func decode<Element: JSONDecodable>(_ key: String) throws -> [Int: [Element]] {
+        guard let value = get(key) else {
+            throw JSONDecodableError.missingTypeError(key: key)
+        }
+        guard let dictionary = value as? [Int: [JSONObject]] else {
+            throw JSONDecodableError.incompatibleTypeError(key: key, elementType: type(of: value), expectedType: [Int: Element].self)
+        }
+        var decoded = [Int: [Element]]()
+        try dictionary.forEach {
+            decoded[$0] = try $1.map { element in
+                return try Element(object: element)
+            }
+        }
+        return decoded
+    }
+    
+    // [Int:[JSONDecodable]]?
+    public func decode<Element: JSONDecodable>(_ key: String) throws -> [Int: [Element]]? {
+        guard let value = get(key) else {
+            return nil
+        }
+        guard let dictionary = value as? [Int: [JSONObject]] else {
+            throw JSONDecodableError.incompatibleTypeError(key: key, elementType: type(of: value), expectedType: [Int: Element].self)
+        }
+        var decoded = [Int: [Element]]()
+        try dictionary.forEach {
+            decoded[$0] = try $1.map { element in
+                return try Element(object: element)
+            }
+        }
+        return decoded
+    }
+    
     // JSONTransformable
     public func decode<EncodedType, DecodedType>(_ key: String, transformer: JSONTransformer<EncodedType, DecodedType>) throws -> DecodedType {
         guard let value = get(key) else {

JSONCodable/JSONEncodable.swift

@@ -121,7 +121,7 @@ public extension Array { //where Element: JSONEncodable {
 
 // Dictionary convenience methods
 
-public extension Dictionary {//where Key: String, Value: JSONEncodable {
+public extension Dictionary where Key == String { //Value: JSONEncodable {
     func toJSON() throws -> Any {
         var result: [String: Any] = [:]
         for (k, item) in self {
@@ -136,6 +136,24 @@ public extension Dictionary {//where Key: String, Value: JSONEncodable {
     }
 }
 
+public extension Dictionary where Key == Int { //Value: JSONEncodable {
+    func toJSON() throws -> Any {
+        var result: [Int: Any] = [:]
+        for (k, item) in self {
+            if let item = item as? JSONEncodable {
+                result[k] = try item.toJSON()
+            }
+            else if let items = item as? [JSONEncodable] {
+                result[k] = try items.map { try $0.toJSON() }
+            }
+            else {
+                throw JSONEncodableError.dictionaryIncompatibleTypeError(elementType: type(of: item))
+            }
+        }
+        return result
+    }
+}
+
 // JSONEncoder - provides utility methods for encoding
 
 public class JSONEncoder {
@@ -291,6 +309,44 @@ public class JSONEncoder {
         let result = try actual.toJSON()
         object = update(object: object, keys: key.components(separatedBy: "."), value: result)
     }
+    
+    // [Int:JSONEncodable]
+    public func encode<Encodable: JSONEncodable>(_ dictionary: [Int:Encodable], key: String) throws {
+        let result = try dictionary.toJSON()
+        object = update(object: object, keys: key.components(separatedBy: "."), value: result)
+    }
+    public func encode(_ dictionary: [Int:JSONEncodable], key: String) throws {
+        let result = try dictionary.toJSON()
+        object[key] = result
+    }
+    
+    // [Int:JSONEncodable]?
+    public func encode<Encodable: JSONEncodable>(_ value: [Int:Encodable]?, key: String) throws {
+        guard let actual = value else {
+            return
+        }
+        let result = try actual.toJSON()
+        object = update(object: object, keys: key.components(separatedBy: "."), value: result)
+    }
+    
+    // [Int:[JSONEncodable]]
+    public func encode<Encodable: JSONEncodable>(_ dictionary: [Int:[Encodable]], key: String) throws {
+        let result = try dictionary.toJSON()
+        object = update(object: object, keys: key.components(separatedBy: "."), value: result)
+    }
+    public func encode(_ dictionary: [Int:[JSONEncodable]], key: String) throws {
+        let result = try dictionary.toJSON()
+        object[key] = result
+    }
+    
+    // [Int:[JSONEncodable]]?
+    public func encode<Encodable: JSONEncodable>(_ value: [Int:[Encodable]]?, key: String) throws {
+        guard let actual = value else {
+            return
+        }
+        let result = try actual.toJSON()
+        object = update(object: object, keys: key.components(separatedBy: "."), value: result)
+    }
 
     // JSONTransformable
     public func encode<EncodedType, DecodedType>(_ value: DecodedType, key: String, transformer: JSONTransformer<EncodedType, DecodedType>) throws {

JSONCodableTests/Companies.swift

@@ -0,0 +1,27 @@
+//
+//  ComplexIntBasedModel.swift
+//  JSONCodableTests
+//
+//  Created by Florian Krüger on 11.07.19.
+//
+
+import JSONCodable
+
+struct ComplexIntBasedModel {
+    let usersByLikes: [Int: [User]]
+}
+
+extension ComplexIntBasedModel: JSONDecodable {
+    init(object: JSONObject) throws {
+        let decoder = JSONDecoder(object: object)
+        usersByLikes = try decoder.decode("users_by_likes")
+    }
+}
+
+extension ComplexIntBasedModel: JSONEncodable {
+    func toJSON() throws -> Any {
+        return try JSONEncoder.create { (encoder) -> Void in
+            try encoder.encode(usersByLikes, key: "users_by_likes")
+        }
+    }
+}

JSONCodableTests/ComplexIntBasedModel.swift

@@ -0,0 +1,27 @@
+//
+//  IntBasedModel.swift
+//  JSONCodableTests
+//
+//  Created by Florian Krüger on 10.07.19.
+//
+
+import JSONCodable
+
+struct IntBasedModel {
+    let companies: [Int: Company]
+}
+
+extension IntBasedModel: JSONDecodable {
+    init(object: JSONObject) throws {
+        let decoder = JSONDecoder(object: object)
+        companies = try decoder.decode("companies")
+    }
+}
+
+extension IntBasedModel: JSONEncodable {
+    func toJSON() throws -> Any {
+        return try JSONEncoder.create { (encoder) -> Void in
+            try encoder.encode(companies, key: "companies")
+        }
+    }
+}

JSONCodableTests/IntBasedModel.swift

@@ -6,10 +6,11 @@
 //
 
 import XCTest
+import JSONCodable
 
 class IntBasedTests: XCTestCase {
 
-    let encodedCompanies: [String: Any] = [
+    let encodedIntBasedModel: [String: Any] = [
         "companies": [
             0: [ "name": "Apple",
                  "address": "1 Infinite Loop, Cupertino, CA"
@@ -23,13 +24,116 @@ class IntBasedTests: XCTestCase {
     let decodedCompany0 = Company(name: "Apple", address: "1 Infinite Loop, Cupertino, CA")
     let decodedCompany1 = Company(name: "Propeller", address: "1212 broadway, Oakland, CA")
 
-    func testDecoding() {
-        guard let companies = try? Companies(object: encodedCompanies) else {
+    lazy var decodedIntBasedModel: IntBasedModel = {
+        IntBasedModel(companies: [
+            0: decodedCompany0,
+            1: decodedCompany1
+        ])
+    }()
+    
+    let encodedComplexIntBasedModel: [String: Any] = [
+        "users_by_likes": [
+            1000: [
+                ["id": 27, "likes": 1000, "full_name": "Bob Jefferson", "friends" : [], ],
+                ["id": 29, "likes": 1000, "full_name": "Jen Jackson", "friends" : [], ],
+            ],
+            9000: [
+                ["id": 36, "likes": 9000, "full_name": "Grace Ferguson", "friends" : [], ],
+            ]
+        ]
+    ]
+    
+    let decodedUser1000_0 = User(
+        id: 27,
+        likes: 1000,
+        name: "Bob Jefferson",
+        email: nil,
+        company: nil,
+        friends: [],
+        friendsLookup: nil
+    )
+    
+    let decodedUser1000_1 = User(
+        id: 29,
+        likes: 1000,
+        name: "Jen Jackson",
+        email: nil,
+        company: nil,
+        friends: [],
+        friendsLookup: nil
+    )
+    
+    let decodedUser9000_0 = User(
+        id: 36,
+        likes: 9000,
+        name: "Grace Ferguson",
+        email: nil,
+        company: nil,
+        friends: [],
+        friendsLookup: nil
+    )
+    
+    lazy var decodedComplexIntBasedModel: ComplexIntBasedModel = {
+        ComplexIntBasedModel(usersByLikes: [
+            1000: [decodedUser1000_0, decodedUser1000_1],
+            9000: [decodedUser9000_0]
+        ])
+    }()
+    
+    func testIntBasedDecoding() {
+        guard let decoded = try? IntBasedModel(object: encodedIntBasedModel) else {
             XCTFail()
             return
         }
-        XCTAssertEqual(companies.companies[0], decodedCompany0)
-        XCTAssertEqual(companies.companies[1], decodedCompany1)
+        XCTAssertEqual(decoded.companies[0], decodedCompany0)
+        XCTAssertEqual(decoded.companies[1], decodedCompany1)
+    }
+    
+    func testIntBasedEncoding() {
+        do {
+            guard
+                let json = try decodedIntBasedModel.toJSON() as? JSONObject
+                else { XCTFail(); return }
+            
+            let decoded = try IntBasedModel(object: json)
+            
+            XCTAssertEqual(decoded.companies.count, decodedIntBasedModel.companies.count)
+            XCTAssertEqual(decoded.companies[0], decodedIntBasedModel.companies[0])
+            XCTAssertEqual(decoded.companies[1], decodedIntBasedModel.companies[1])
+        } catch {
+            print("\(error.localizedDescription)")
+            XCTFail()
+        }
+    }
+    
+    func testComplexIntBasedDecoding() {
+        guard let decoded = try? ComplexIntBasedModel(object: encodedComplexIntBasedModel) else {
+            XCTFail()
+            return
+        }
+        XCTAssertEqual(decoded.usersByLikes[1000]?[0], decodedUser1000_0)
+        XCTAssertEqual(decoded.usersByLikes[1000]?[1], decodedUser1000_1)
+        XCTAssertEqual(decoded.usersByLikes[9000]?[0], decodedUser9000_0)
+    }
+    
+    func testComplexIntBasedEncoding() {
+        do {
+            guard
+                let json = try decodedComplexIntBasedModel.toJSON() as? JSONObject
+                else { XCTFail(); return }
+            
+            let decoded = try ComplexIntBasedModel(object: json)
+            
+            XCTAssertEqual(decoded.usersByLikes.count, 2)
+            XCTAssertEqual(decoded.usersByLikes[1000]?.count, 2)
+            XCTAssertEqual(decoded.usersByLikes[1000]?[0], decodedUser1000_0)
+            XCTAssertEqual(decoded.usersByLikes[1000]?[1], decodedUser1000_1)
+            XCTAssertEqual(decoded.usersByLikes[9000]?.count, 1)
+            XCTAssertEqual(decoded.usersByLikes[9000]?[0], decodedUser9000_0)
+        } catch {
+            print("\(error.localizedDescription)")
+            XCTFail()
+        }
     }
 
 }