Merge branch 'master' into swift-4

# Conflicts:
#	Sources/ToJSON.swift
#	Tests/ObjectMapperTests/ImmutableTests.swift

Author: tristanhimmelman

.swift-version

@@ -1 +1 @@
-3.1
+4.0

.travis.yml

@@ -15,12 +15,12 @@ env:
     - TVOS_SDK=appletvsimulator10.2
     - WATCHOS_SDK=watchsimulator3.2
   matrix:
-    - DESTINATION="OS=10.3,name=iPhone 5"            SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
-    - DESTINATION="OS=10.3,name=iPhone 5s"           SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
-    - DESTINATION="OS=10.3,name=iPhone 6"            SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
-    - DESTINATION="OS=10.3,name=iPhone 6 Plus"       SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
-    - DESTINATION="OS=10.3,name=iPhone 6s"           SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
-    - DESTINATION="OS=10.3,name=iPhone 6s Plus"      SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
+    - DESTINATION="OS=10.3.1,name=iPhone 5s"           SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
+    - DESTINATION="OS=10.3.1,name=iPhone 6"            SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
+    - DESTINATION="OS=10.3.1,name=iPhone 6 Plus"       SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
+    - DESTINATION="OS=10.3.1,name=iPhone 6s"           SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
+    - DESTINATION="OS=10.3.1,name=iPhone 6s Plus"      SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
+    - DESTINATION="OS=10.3.1,name=iPhone 7"            SCHEME="$IOS_FRAMEWORK_SCHEME"     SDK="$IOS_SDK"     RUN_TESTS="YES"
     - DESTINATION="arch=x86_64"                      SCHEME="$OSX_FRAMEWORK_SCHEME"     SDK="$OSX_SDK"     RUN_TESTS="YES"
     - DESTINATION="OS=10.2,name=Apple TV 1080p"      SCHEME="$TVOS_FRAMEWORK_SCHEME"    SDK="$TVOS_SDK"    RUN_TESTS="YES"
     - DESTINATION="OS=3.2,name=Apple Watch - 38mm"   SCHEME="$WATCHOS_FRAMEWORK_SCHEME" SDK="$WATCHOS_SDK" RUN_TESTS="NO"

ObjectMapper.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'ObjectMapper'
-  s.version = '2.2.7'
+  s.version = '2.3.0'
   s.license = 'MIT'
   s.summary = 'JSON Object mapping written in Swift'
   s.homepage = 'https://github.com/Hearst-DD/ObjectMapper'
@@ -14,7 +14,7 @@ Pod::Spec.new do |s|
 
 
   s.pod_target_xcconfig = {
-    'SWIFT_VERSION' => '3.1',
+    'SWIFT_VERSION' => '4.0',
   }
 
   s.requires_arc = true

README.md

@@ -27,7 +27,7 @@ ObjectMapper is a framework written in Swift that makes it easy for you to conve
 - Nested Objects (stand alone, in arrays or in dictionaries)
 - Custom transformations during mapping
 - Struct support
-- [Immutable support](#immutablemappable-protocol-beta) (currently in beta)
+- [Immutable support](#immutablemappable-protocol)
 
 # The Basics
 To support mapping, a class or struct just needs to implement the ```Mappable``` protocol which includes the following functions:
@@ -93,7 +93,7 @@ let JSONString = user.toJSONString(prettyPrint: true)
 ```
 
 Alternatively, the `Mapper.swift` class can also be used to accomplish the above (it also provides extra functionality for other situations):
-```
+```swift
 // Convert JSON String to Model
 let user = Mapper<User>().map(JSONString: JSONString)
 // Create JSON String from Model
@@ -148,9 +148,7 @@ ObjectMapper uses this function to get objects to use for mapping. Developers sh
 
 If you need to implemented ObjectMapper in an extension, you will need to select this protocol instead of `Mappable`. 
 
-## `ImmutableMappable` Protocol (Beta)
-
-> ⚠️ This feature is currently in Beta. There might be breaking API changes in the future.
+## `ImmutableMappable` Protocol
 
 `ImmutableMappable` provides the ability to map immutable properties. This is how `ImmutableMappable` differs from `Mappable`:
 
@@ -203,7 +201,7 @@ mutating func mapping(map: Map) {
   <tr>
     <td>
 <pre>
-mutating func mapping(map: Map) {
+func mapping(map: Map) {
   id   <strong>>>></strong> map["id"]
   name <strong>>>></strong> map["name"]
 }
@@ -446,6 +444,8 @@ class Model: Object, Mappable {
 
 If you want to serialize associated RealmObjects, you can use [ObjectMapper+Realm](https://github.com/jakenberg/ObjectMapper-Realm). It is a simple Realm extension that serializes arbitrary JSON into Realm's List class.
 
+To serialize Swift String, Int, Double and Bool arrays you can use [ObjectMapperAdditions/Realm](https://github.com/APUtils/ObjectMapperAdditions#realm-features). It'll wrap Swift types into RealmValues that can be stored in Realm's List class.
+
 Note: Generating a JSON string of a Realm Object using ObjectMappers' `toJSON` function only works within a Realm write transaction. This is caused because ObjectMapper uses the `inout` flag in its mapping functions (`<-`) which are used both for serializing and deserializing. Realm detects the flag and forces the `toJSON` function to be called within a write block even though the objects are not being modified.
 
 # Projects Using ObjectMapper

Sources/FromJSON.swift

@@ -48,7 +48,7 @@ internal final class FromJSON {
 	/// Mappable object
 	class func object<N: BaseMappable>(_ field: inout N, map: Map) {
 		if map.toObject {
-			_ = Mapper(context: map.context).map(JSONObject: map.currentValue, toObject: field)
+			field = Mapper(context: map.context).map(JSONObject: map.currentValue, toObject: field)
 		} else if let value: N = Mapper(context: map.context).map(JSONObject: map.currentValue) {
 			field = value
 		}
@@ -57,17 +57,17 @@ internal final class FromJSON {
 	/// Optional Mappable Object
 
 	class func optionalObject<N: BaseMappable>(_ field: inout N?, map: Map) {
-		if let field = field , map.toObject && map.currentValue != nil {
-			_ = Mapper(context: map.context).map(JSONObject: map.currentValue, toObject: field)
+		if let f = field , map.toObject && map.currentValue != nil {
+			 field = Mapper(context: map.context).map(JSONObject: map.currentValue, toObject: f)
 		} else {
 			field = Mapper(context: map.context).map(JSONObject: map.currentValue)
 		}
 	}
 
 	/// Implicitly unwrapped Optional Mappable Object
 	class func optionalObject<N: BaseMappable>(_ field: inout N!, map: Map) {
-		if let field = field , map.toObject && map.currentValue != nil {
-			_ = Mapper(context: map.context).map(JSONObject: map.currentValue, toObject: field)
+		if let f = field , map.toObject && map.currentValue != nil {
+			field = Mapper(context: map.context).map(JSONObject: map.currentValue, toObject: f)
 		} else {
 			field = Mapper(context: map.context).map(JSONObject: map.currentValue)
 		}
@@ -119,7 +119,7 @@ internal final class FromJSON {
 	/// Dctionary containing Mappable objects
 	class func objectDictionary<N: BaseMappable>(_ field: inout Dictionary<String, N>, map: Map) {
 		if map.toObject {
-			_ = Mapper<N>(context: map.context).mapDictionary(JSONObject: map.currentValue, toDictionary: field)
+			field = Mapper<N>(context: map.context).mapDictionary(JSONObject: map.currentValue, toDictionary: field)
 		} else {
 			if let objects = Mapper<N>(context: map.context).mapDictionary(JSONObject: map.currentValue) {
 				field = objects
@@ -129,17 +129,17 @@ internal final class FromJSON {
 
 	/// Optional dictionary containing Mappable objects
 	class func optionalObjectDictionary<N: BaseMappable>(_ field: inout Dictionary<String, N>?, map: Map) {
-		if let field = field , map.toObject && map.currentValue != nil {
-			_ = Mapper(context: map.context).mapDictionary(JSONObject: map.currentValue, toDictionary: field)
+		if let f = field , map.toObject && map.currentValue != nil {
+			field = Mapper(context: map.context).mapDictionary(JSONObject: map.currentValue, toDictionary: f)
 		} else {
 			field = Mapper(context: map.context).mapDictionary(JSONObject: map.currentValue)
 		}
 	}
 
 	/// Implicitly unwrapped Dictionary containing Mappable objects
 	class func optionalObjectDictionary<N: BaseMappable>(_ field: inout Dictionary<String, N>!, map: Map) {
-		if let field = field , map.toObject && map.currentValue != nil {
-			_ = Mapper(context: map.context).mapDictionary(JSONObject: map.currentValue, toDictionary: field)
+		if let f = field , map.toObject && map.currentValue != nil {
+			field = Mapper(context: map.context).mapDictionary(JSONObject: map.currentValue, toDictionary: f)
 		} else {
 			field = Mapper(context: map.context).mapDictionary(JSONObject: map.currentValue)
 		}

Sources/ISO8601DateTransform.swift

@@ -28,14 +28,20 @@
 
 import Foundation
 
+public extension DateFormatter {
+	public convenience init(withFormat format : String, locale : String) {
+		self.init()
+		self.locale = Locale(identifier: locale)
+		dateFormat = format
+	}
+}
+
 open class ISO8601DateTransform: DateFormatterTransform {
+	
+	static let reusableISODateFormatter = DateFormatter(withFormat: "yyyy-MM-dd'T'HH:mm:ssZZZZZ", locale: "en_US_POSIX")
 
 	public init() {
-		let formatter = DateFormatter()
-		formatter.locale = Locale(identifier: "en_US_POSIX")
-		formatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ssZZZZZ"
-		
-		super.init(dateFormatter: formatter)
+		super.init(dateFormatter: ISO8601DateTransform.reusableISODateFormatter)
 	}
-	
 }
+

Sources/ImmutableMappable.swift

@@ -83,6 +83,11 @@ public extension Map {
 	public func value<T: RawRepresentable>(_ key: String, nested: Bool? = nil, delimiter: String = ".", file: StaticString = #file, function: StaticString = #function, line: UInt = #line) throws -> T {
 		return try self.value(key, nested: nested, delimiter: delimiter, using: EnumTransform(), file: file, function: function, line: line)
 	}
+	
+	/// Returns a `[RawRepresentable]` type or throws an error.
+	public func value<T: RawRepresentable>(_ key: String, nested: Bool? = nil, delimiter: String = ".", file: StaticString = #file, function: StaticString = #function, line: UInt = #line) throws -> [T] {
+		return try self.value(key, nested: nested, delimiter: delimiter, using: EnumTransform(), file: file, function: function, line: line)
+	}
 
 	// MARK: BaseMappable
 

Sources/Map.swift

@@ -47,7 +47,7 @@ public final class Map {
 	public var context: MapContext?
 	public var shouldIncludeNilValues = false  /// If this is set to true, toJSON output will include null values for any variables that are not set.
 
-	let toObject: Bool // indicates whether the mapping is being applied to an existing object
+	public let toObject: Bool // indicates whether the mapping is being applied to an existing object
 
 	public init(mappingType: MappingType, JSON: [String: Any], toObject: Bool = false, context: MapContext? = nil, shouldIncludeNilValues: Bool = false) {
 

Sources/Operators.swift

@@ -327,7 +327,7 @@ public func <- <T: BaseMappable>(left: inout Array<Array<T>>!, right: Map) {
 	}
 }
 
-// MARK:- Set of Mappable objects - Set<T: BaseMappable where T: Hashable>
+// MARK:- Set of Mappable objects - Set<T: BaseMappable>
 
 /// Set of Mappable objects
 public func <- <T: BaseMappable>(left: inout Set<T>, right: Map) {

Sources/ToJSON.swift

@@ -103,7 +103,7 @@ internal final class ToJSON {
 	}
 
 	class func object<N: BaseMappable>(_ field: N, map: Map) {
-		if let result = Mapper(context: map.context).toJSON(field) as Any? {
+		if let result = Mapper(context: map.context, shouldIncludeNilValues: map.shouldIncludeNilValues).toJSON(field) as Any? {
 			setValue(result, map: map)
 		}
 	}
@@ -115,7 +115,7 @@ internal final class ToJSON {
 	}
 
 	class func objectArray<N: BaseMappable>(_ field: Array<N>, map: Map) {
-		let JSONObjects = Mapper(context: map.context).toJSONArray(field)
+		let JSONObjects = Mapper(context: map.context, shouldIncludeNilValues: map.shouldIncludeNilValues).toJSONArray(field)
 
 		setValue(JSONObjects, map: map)
 	}
@@ -129,7 +129,7 @@ internal final class ToJSON {
 	class func twoDimensionalObjectArray<N: BaseMappable>(_ field: Array<Array<N>>, map: Map) {
 		var array = [[[String: Any]]]()
 		for innerArray in field {
-			let JSONObjects = Mapper(context: map.context).toJSONArray(innerArray)
+			let JSONObjects = Mapper(context: map.context, shouldIncludeNilValues: map.shouldIncludeNilValues).toJSONArray(innerArray)
 			array.append(JSONObjects)
 		}
 		setValue(array, map: map)
@@ -142,7 +142,7 @@ internal final class ToJSON {
 	}
 
 	class func objectSet<N: BaseMappable>(_ field: Set<N>, map: Map) {
-		let JSONObjects = Mapper(context: map.context).toJSONSet(field)
+		let JSONObjects = Mapper(context: map.context, shouldIncludeNilValues: map.shouldIncludeNilValues).toJSONSet(field)
 
 		setValue(JSONObjects, map: map)
 	}
@@ -154,7 +154,7 @@ internal final class ToJSON {
 	}
 
 	class func objectDictionary<N: BaseMappable>(_ field: Dictionary<String, N>, map: Map) {
-		let JSONObjects = Mapper(context: map.context).toJSONDictionary(field)
+		let JSONObjects = Mapper(context: map.context, shouldIncludeNilValues: map.shouldIncludeNilValues).toJSONDictionary(field)
 
 		setValue(JSONObjects, map: map)
 	}
@@ -166,7 +166,7 @@ internal final class ToJSON {
 	}
 
 	class func objectDictionaryOfArrays<N: BaseMappable>(_ field: Dictionary<String, [N]>, map: Map) {
-		let JSONObjects = Mapper(context: map.context).toJSONDictionaryOfArrays(field)
+		let JSONObjects = Mapper(context: map.context, shouldIncludeNilValues: map.shouldIncludeNilValues).toJSONDictionaryOfArrays(field)
 
 		setValue(JSONObjects, map: map)
 	}

Sources/TransformOperators.swift

@@ -522,7 +522,7 @@ public func <- <Transform: TransformType>(left: inout [[Transform.Object]]!, rig
 	}
 }
 
-// MARK:- Set of Mappable objects with a transform - Set<T: BaseMappable where T: Hashable>
+// MARK:- Set of Mappable objects with a transform - Set<T: BaseMappable>
 
 /// Set of Mappable objects with transform
 public func <- <Transform: TransformType>(left: inout Set<Transform.Object>, right: (Map, Transform)) where Transform.Object: BaseMappable {

Tests/ObjectMapperTests/ImmutableTests.swift

@@ -78,18 +78,23 @@ class ImmutableObjectTests: XCTestCase {
 		// RawRepresentable
 		"prop27a": NSNumber(value: 0),
 		"prop27b": NSNumber(value: 1000),
-		
+		"prop27c": [NSNumber(value: 0), NSNumber(value: 1000)],
+
 		"prop28a": Int(0),
 		"prop28b": Int(255),
-		
+		"prop28c": [Int(0), Int(255)],
+
 		"prop29a": Double(0),
 		"prop29b": Double(100),
-		
+		"prop29c": [Double(0), Double(100)],
+
 		"prop30a": Float(0),
 		"prop30b": Float(100),
+		"prop30c": [Float(0), Float(100)],
 
 		"prop31a": "String A",
 		"prop31b": "String B",
+		"prop31c": ["String A", "String B"],
 
 		// [[String]]
 		"prop32": [["prop32"]],
@@ -157,18 +162,23 @@ class ImmutableObjectTests: XCTestCase {
 
 		XCTAssertEqual(immutable.prop27a.rawValue, Int64Enum.a.rawValue)
 		XCTAssertEqual(immutable.prop27b.rawValue, Int64Enum.b.rawValue)
+		XCTAssertEqual(immutable.prop27c, [Int64Enum.a, Int64Enum.b])
 
 		XCTAssertEqual(immutable.prop28a.rawValue, IntEnum.a.rawValue)
 		XCTAssertEqual(immutable.prop28b.rawValue, IntEnum.b.rawValue)
+		XCTAssertEqual(immutable.prop28c, [IntEnum.a, IntEnum.b])
 
 		XCTAssertEqual(immutable.prop29a.rawValue, DoubleEnum.a.rawValue)
 		XCTAssertEqual(immutable.prop29b.rawValue, DoubleEnum.b.rawValue)
+		XCTAssertEqual(immutable.prop29c, [DoubleEnum.a, DoubleEnum.b])
 
 		XCTAssertEqual(immutable.prop30a.rawValue, FloatEnum.a.rawValue)
 		XCTAssertEqual(immutable.prop30b.rawValue, FloatEnum.b.rawValue)
+		XCTAssertEqual(immutable.prop30c, [FloatEnum.a, FloatEnum.b])
 
 		XCTAssertEqual(immutable.prop31a.rawValue, StringEnum.A.rawValue)
 		XCTAssertEqual(immutable.prop31b.rawValue, StringEnum.B.rawValue)
+		XCTAssertEqual(immutable.prop31c, [StringEnum.A, StringEnum.B])
 
 		XCTAssertEqual(immutable.prop32[0][0], "prop32_TRANSFORMED")
 		XCTAssertEqual(immutable.prop33![0][0], "prop33_TRANSFORMED")
@@ -362,18 +372,23 @@ struct Struct {
 	// RawRepresentable
 	let prop27a: Int64Enum
 	let prop27b: Int64Enum
+	let prop27c: [Int64Enum]
 
 	let prop28a: IntEnum
 	let prop28b: IntEnum
+	let prop28c: [IntEnum]
 
 	let prop29a: DoubleEnum
 	let prop29b: DoubleEnum
+	let prop29c: [DoubleEnum]
 
 	let prop30a: FloatEnum
 	let prop30b: FloatEnum
+	let prop30c: [FloatEnum]
 
 	let prop31a: StringEnum
 	let prop31b: StringEnum
+	let prop31c: [StringEnum]
 
 	let prop32: [[String]]
 	let prop33: [[String]]?
@@ -428,18 +443,23 @@ extension Struct: ImmutableMappable {
 
 		prop27a = try map.value("prop27a")
 		prop27b = try map.value("prop27b")
+		prop27c = try map.value("prop27c")
 
 		prop28a = try map.value("prop28a")
 		prop28b = try map.value("prop28b")
+		prop28c = try map.value("prop28c")
 
 		prop29a = try map.value("prop29a")
 		prop29b = try map.value("prop29b")
+		prop29c = try map.value("prop29c")
 
 		prop30a = try map.value("prop30a")
 		prop30b = try map.value("prop30b")
+		prop30c = try map.value("prop30c")
 
 		prop31a = try map.value("prop31a")
 		prop31b = try map.value("prop31b")
+		prop31c = try map.value("prop31c")
 
 		prop32 = try map.value("prop32", using: stringTransform)
 		prop33 = try? map.value("prop33", using: stringTransform)
@@ -499,19 +519,24 @@ extension Struct: ImmutableMappable {
 
 		prop27a >>> map["prop27a"]
 		prop27b >>> map["prop27b"]
+		prop27c >>> map["prop27c"]
 
 		prop28a >>> map["prop28a"]
 		prop28b >>> map["prop28b"]
+		prop28c >>> map["prop28c"]
 
 		prop29a >>> map["prop29a"]
 		prop29b >>> map["prop29b"]
+		prop29c >>> map["prop29c"]
 
 		prop30a >>> map["prop30a"]
 		prop30b >>> map["prop30b"]
+		prop30c >>> map["prop30c"]
 
 		prop31a >>> map["prop31a"]
 		prop31b >>> map["prop31b"]
-		
+		prop31c >>> map["prop31c"]
+
 		prop32 >>> (map["prop32"], stringTransform)
 		prop33 >>> (map["prop33"], stringTransform)
 		prop34 >>> (map["prop34"], stringTransform)