Rename ModelRocket class to fix namespacing issue

Author: jlandon

ModelRocket.playground/Contents.swift

@@ -11,7 +11,7 @@ unwrapped safely, since the object will be created iff all properties where
 
 */
 
-class Vehicle: ModelRocket {
+class Vehicle: Model {
     let model = Property<String>(key: "model")
     let year = Property<Int>(key: "year")
     let color = Property<UIColor>(key: "color")

ModelRocket.playground/contents.xcplayground

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<playground version='5.0' target-platform='ios' requires-full-environment='true' last-migration='0700'>
+<playground version='5.0' target-platform='ios' requires-full-environment='true'>
     <timeline fileName='timeline.xctimeline'/>
 </playground>

ModelRocket.xcodeproj/project.pbxproj

@@ -18,7 +18,7 @@
 		81F54F681A82D5D9005C8275 /* PropertyDescription.swift in Sources */ = {isa = PBXBuildFile; fileRef = 81F54F671A82D5D9005C8275 /* PropertyDescription.swift */; };
 		81F54F6B1A82D5E1005C8275 /* JSONTransformable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 81F54F6A1A82D5E1005C8275 /* JSONTransformable.swift */; };
 		81F54F6E1A82D5ED005C8275 /* Property.swift in Sources */ = {isa = PBXBuildFile; fileRef = 81F54F6D1A82D5ED005C8275 /* Property.swift */; };
-		81F54F711A82D5F5005C8275 /* ModelRocket.swift in Sources */ = {isa = PBXBuildFile; fileRef = 81F54F701A82D5F5005C8275 /* ModelRocket.swift */; };
+		81F54F711A82D5F5005C8275 /* Model.swift in Sources */ = {isa = PBXBuildFile; fileRef = 81F54F701A82D5F5005C8275 /* Model.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -46,7 +46,7 @@
 		81F54F671A82D5D9005C8275 /* PropertyDescription.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = PropertyDescription.swift; path = ../ModelRocket/PropertyDescription.swift; sourceTree = "<group>"; };
 		81F54F6A1A82D5E1005C8275 /* JSONTransformable.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = JSONTransformable.swift; path = ../ModelRocket/JSONTransformable.swift; sourceTree = "<group>"; };
 		81F54F6D1A82D5ED005C8275 /* Property.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = Property.swift; path = ../ModelRocket/Property.swift; sourceTree = "<group>"; };
-		81F54F701A82D5F5005C8275 /* ModelRocket.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = ModelRocket.swift; path = ../ModelRocket/ModelRocket.swift; sourceTree = "<group>"; };
+		81F54F701A82D5F5005C8275 /* Model.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Model.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -95,7 +95,7 @@
 				81F54F6D1A82D5ED005C8275 /* Property.swift */,
 				810653281A847016004CA201 /* PropertyArray.swift */,
 				81629FCD1A95780100C2C42D /* PropertyDictionary.swift */,
-				81F54F701A82D5F5005C8275 /* ModelRocket.swift */,
+				81F54F701A82D5F5005C8275 /* Model.swift */,
 				81BECF191B8BBBF5000F08E9 /* JSON.swift */,
 				8143C8E41A82BA480077DE22 /* Supporting Files */,
 			);
@@ -242,7 +242,7 @@
 			files = (
 				810653291A847016004CA201 /* PropertyArray.swift in Sources */,
 				81BECF1A1B8BBBF5000F08E9 /* JSON.swift in Sources */,
-				81F54F711A82D5F5005C8275 /* ModelRocket.swift in Sources */,
+				81F54F711A82D5F5005C8275 /* Model.swift in Sources */,
 				81629FCE1A95780100C2C42D /* PropertyDictionary.swift in Sources */,
 				81F54F6B1A82D5E1005C8275 /* JSONTransformable.swift in Sources */,
 				81F54F6E1A82D5ED005C8275 /* Property.swift in Sources */,

ModelRocket/JSONTransformable.swift

@@ -33,9 +33,9 @@ public protocol JSONTransformable {
     func toJSON() -> AnyObject
 }
 
-// MARK: Default implementation for ModelRocket subclasses
+// MARK: Default implementation for Model subclasses
 
-extension JSONTransformable where Self: ModelRocket {
+extension JSONTransformable where Self: Model {
     public static func fromJSON(json: JSON) -> Self? {
         return Self(json: json)
     }
@@ -48,10 +48,7 @@ extension JSONTransformable where Self: ModelRocket {
 
 extension JSONTransformable where Self: RawRepresentable, Self.RawValue == String {
     public static func fromJSON(json: JSON) -> Self? {
-        if let string = json.string {
-            return Self(rawValue: string)
-        }
-        return nil
+        return Self(rawValue: json.stringValue)
     }
     public func toJSON() -> AnyObject {
         return rawValue
@@ -60,10 +57,7 @@ extension JSONTransformable where Self: RawRepresentable, Self.RawValue == Strin
 
 extension JSONTransformable where Self: RawRepresentable, Self.RawValue == Int {
     public static func fromJSON(json: JSON) -> Self? {
-        if let int = json.int {
-            return Self(rawValue: int)
-        }
-        return nil
+        return Self(rawValue: json.intValue)
     }
     public func toJSON() -> AnyObject {
         return rawValue

ModelRocket/ModelRocket.swift renamed to ModelRocket/Model.swift

@@ -1,4 +1,4 @@
-// ModelRocket.swift
+// Model.swift
 //
 // Copyright (c) 2015 Oven Bits, LLC
 //
@@ -22,7 +22,7 @@
 
 import Foundation
 
-public class ModelRocket: NSObject, NSCoding {
+public class Model: NSObject, NSCoding {
 
     private var JSONMappings: [PropertyDescription] {
         let mirror = Mirror(reflecting: self)
@@ -90,12 +90,12 @@ public class ModelRocket: NSObject, NSCoding {
         }
     }
 
-    public class func modelForJSON(json: JSON) -> ModelRocket {
-        return ModelRocket(json: json)
+    public class func modelForJSON(json: JSON) -> Model {
+        return Model(json: json)
     }
 
-    public class func modelForStrictJSON(json: JSON) -> ModelRocket? {
-        return ModelRocket(strictJSON: json)
+    public class func modelForStrictJSON(json: JSON) -> Model? {
+        return Model(strictJSON: json)
     }
 
     // MARK: JSON

ModelRocket/PropertyDescription.swift

@@ -45,8 +45,8 @@ public protocol PropertyDescription {
     /// Encode object from NSCoder
     func decode(decoder: NSCoder)
 
-    /// After the whole ModelRocket object has been initialized and its Property properties initalized fromJSON(), 
+    /// After the whole Model object has been initialized and its Property properties initalized fromJSON(),
     /// invoked to permit further post-processing of the Property that may depend upon other information from the
-    /// whole of the ModelRocket object.
+    /// whole of the Model object.
     func initPostProcess()
 }

ModelRocketTests/ModelRocketTests.swift

@@ -492,7 +492,7 @@ class ModelRocketTests: XCTestCase {
 
 // MARK: - Models
 
-class TestModel: ModelRocket {
+class TestModel: Model {
     let string  = Property<String>(key: "string")
     let date    = Property<NSDate>(key: "date")
     let color   = Property<UIColor>(key: "color")
@@ -505,27 +505,27 @@ class TestModel: ModelRocket {
     let uInt    = Property<UInt>(key: "u_int")
 }
 
-class TestArrayModel: ModelRocket {
+class TestArrayModel: Model {
     let strings = PropertyArray<String>(key: "strings")
 }
 
-class TestDictionaryModel: ModelRocket {
+class TestDictionaryModel: Model {
     let ints = PropertyDictionary<Int>(key: "ints")
 }
 
-class TestSimpleNestedModel: ModelRocket {
+class TestSimpleNestedModel: Model {
     let nestedInt = Property<Int>(key: "nest1.nestedInt")
     let nestedString = Property<String>(key: "nest1.nest2.nestedString")
 }
 
-class TestComplexNestedModel: ModelRocket {
+class TestComplexNestedModel: Model {
     let int1 = Property<Int>(key: "int1")
     let int2 = Property<Int>(key: "nest1.nest2.int2")
     let string1 = Property<String>(key: "nest1.nest2.nest3.nest4.string1")
     let string2 = Property<String>(key: "nest1.string2")
 }
 
-class TestVeryComplexNestedModel: ModelRocket {
+class TestVeryComplexNestedModel: Model {
     let string1 = Property<String>(key: "nest1.nest2.nest3.nest4.string1")
     let string2 = Property<String>(key: "nest1.nest2.nest3.nest5.string2")
     let string3 = Property<String>(key: "nest1.nest2.nest6.nest7.string3")
@@ -536,7 +536,7 @@ class TestSubclassModel: TestModel {
     let string2 = Property<String>(key: "string2")
 }
 
-class TestRequiredModel: ModelRocket {
+class TestRequiredModel: Model {
     let requiredString = Property<String>(key: "required_string", required: true)
     let unrequiredInt = Property<Int>(key: "unrequired_int")
 }

README.md

@@ -65,8 +65,10 @@ Then, run `pod install`.
 
 ### Creating a custom object
 
+> NOTE: Due to a namespacing issue in v1.0 with the framework and the base model class (`ModelRocket`) having the same name, we decided to rename the `ModelRocket` class to simply `Model`. This change will be effective in the v1.1 release when Swift 2 is officially released. Hooray namespacing!
+
 ```swift
-class Vehicle: ModelRocket {
+class Vehicle: Model {
 	let make  = Property<String>(key: "make")
 	let model = Property<String>(key: "model", required: true)
 	let year  = Property<Int>(key: "year") { year in
@@ -77,7 +79,7 @@ class Vehicle: ModelRocket {
 	let color = Property<UIColor>(key: "color", defaultValue: UIColor.blackColor())
 }
 ```
-> NOTE: As with all Swift variables, `let` should always be used, unless `var` is absolutely needed. In the case of ModelRocket objects, `let` should be used for all `Property[Array|Dictionary]` properties, as it still allows the underlying `value` to be changed, unless you truly need to reassign the property
+> NOTE: As with all Swift variables, `let` should always be used, unless `var` is absolutely needed. In the case of Model objects, `let` should be used for all `Property[Array|Dictionary]` properties, as it still allows the underlying `value` to be changed, unless you truly need to reassign the property
 
 #### Supported Types
 
@@ -99,7 +101,7 @@ classes out of the box:
 ### Creating an object with a typed array
 
 ```swift
-class Vehicles: ModelRocket {
+class Vehicles: Model {
     let vehicles = PropertyArray<Vehicle>(key: "vehicles")
 }
 ```
@@ -157,7 +159,7 @@ if let make = vehicle.make.value {
 }
 ```
 
-ModelRocket objects also contain a failable initializer, which will only return an initialized object if all properties marked as `required = true` are non-nil.
+Model objects also contain a failable initializer, which will only return an initialized object if all properties marked as `required = true` are non-nil.
 
 ```swift
 // instantiate object, only if `json` contains a value for the `make` property
@@ -187,11 +189,11 @@ The custom object must conform to the JSONTransformable protocol by defining the
 
 
 ```swift
-class Vehicle: ModelRocket {
+class Vehicle: Model {
 	let manufacturer = Property<Manufacturer>(key: "manufacturer")
 }
 
-class Manufacturer: ModelRocket {
+class Manufacturer: Model {
     let companyName = Property<String>(key: "company_name")
     let headquarters = Property<String>(key: "headquarters")
     let founded = Property<NSDate>(key: "founded")
@@ -209,11 +211,11 @@ extension Manufacturer: JSONTransformable {
 
 ### Property `postProcess` hook
 
-The `Property` `postProcess` closure (also available on `PropertyArray` and `PropertyDictionary`) provides a mechanism for work to be done after all properties of a `ModelRocket` object have been initialized from JSON but before the `ModelRocket` object has finished initializing. 
+The `Property` `postProcess` closure (also available on `PropertyArray` and `PropertyDictionary`) provides a mechanism for work to be done after all properties of a `Model` object have been initialized from JSON but before the `Model` object has finished initializing. 
 
 
 ```swift
-class Vehicles: ModelRocket {
+class Vehicles: Model {
     let vehicles = PropertyArray<Vehicle>(key: "vehicles") { (values) -> Void in
         for vehicle in values {
             println("postHook vehicle: \(vehicle.make.value!)")
@@ -256,24 +258,24 @@ This usage pattern enables:
 
 
 ### Implementing a class cluster
-Override the `modelForJSON(json: JSON) -> ModelRocket` function
+Override the `modelForJSON(json: JSON) -> Model` function
 
 ```swift
-class Vehicle: ModelRocket {
+class Vehicle: Model {
     let make = Property<String>(key: "make")
     let model = Property<String>(key: "model")
     let year = Property<Int>(key: "year")
     let color = Property<UIColor>(key: "color")
     let manufacturer = Property<Manufacturer>(key: "manufacturer")
 
-    override class func modelForJSON(json: JSON) -> ModelRocket {
+    override class func modelForJSON(json: JSON) -> Vehicle {
 
-        switch json["type"].string {
-        case .Some("car"):
+        switch json["type"].stringValue {
+        case "car":
             return Car(json: json)
-        case .Some("plane"):
+        case "plane":
             return Plane(json: json)
-        case .Some("bike"):
+        case "bike":
             return Bike(json: json)
         default:
             return Vehicle(json: json)
@@ -301,7 +303,7 @@ default:
 
 ### Obtaining the object's JSON representation
 
-Calling the `json()` function on a ModelRocket subclass returns a tuple containing:
+Calling the `json()` function on a Model subclass returns a tuple containing:
 
 - `dictionary: [String : AnyObject]`
 - `json: JSON`