Merge pull request #3 from insanoid/v0.0.3

Release 0.0.3

Author: Karthikeya Udupa KM

README.md

@@ -1,19 +1,24 @@
 # SwiftyJSONAccelerator
 
-**(Alpha v0.0.2)**
+**(Alpha v0.0.3)**
 
-[Download the .app (v0.0.2)](https://github.com/insanoid/SwiftyJSONAccelerator/releases/download/v0.0.2/SwiftyJSONAccelerator.zip)
+[Download the .app (v0.0.3)](https://github.com/insanoid/SwiftyJSONAccelerator/releases/download/v0.0.3/SwiftyJSONAccelertor.zip)
 
 ![Logo](https://raw.githubusercontent.com/insanoid/SwiftyJSONAccelerator/master/SwiftyJSONAccelerator/Assets.xcassets/AppIcon.appiconset/Icon_32x32%402x.png)
 
-A swift model generator like the Objective-C [JSONAccelerator](http://nerdery.com/json-accelerator). Formats and generates models for the given JSON and also breaks them into files making it easy to manage and share between several models. it relies on [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON) and requires you to include it in your project.
+A swift model generator like the Objective-C [JSONAccelerator](http://nerdery.com/json-accelerator). Formats and generates models for the given JSON and also breaks them into files making it easy to manage and share between several models.
+
+The models that are generated depend on JSON object mapping libraries, currently the model can be generated to depend on any of the below mentioned mapping libraries:
+
+- [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON)
+- [Hearst-DD/ObjectMapper](https://github.com/Hearst-DD/ObjectMapper) (Contributed by: [brendan09](https://github.com/brendan09))
 
 Currently, the pattern is very similar to its Objective-C counterpart. It generates classes with following properties.
 
-- Initalize with `JSON` (SwiftyJSON based)
+- Initalize with `JSON` (SwiftyJSON or ObjectMapper)
 - Initalize with `AnyObject`
-- `NSCoding` compliant (Can be Archived using `NSKeyedArchiver`)
-- Convert to `NSDictionary`
+- Optional `NSCoding` compliance.
+- Convert object to `NSDictionary`
 
 ![Preview](https://raw.githubusercontent.com/insanoid/SwiftyJSONAccelerator/master/preview.png)
 
@@ -22,14 +27,14 @@ Currently, the pattern is very similar to its Objective-C counterpart. It genera
 
 ![Preview](https://raw.githubusercontent.com/insanoid/SwiftyJSONAccelerator/master/preview_ii.png)
 
-*Files are generated individually making it more easy to use.*
+*Each class in the JSON is generated as a file.*
 
 ## TODO
 
 - Handle blank array a bit better.
 - Better User Interface and icon.
 - Generate both `struct` and `class`.
-- Support for generation of models that do not need SwiftyJSON.
+- Support for further JSON object modelling libraries.
 - Add tests and integrate with Travis CI.
 - Create a Xcode plugin and a command line executor.
 

SwiftyJSONAccelerator/Base Files/BaseTemplate.txt

@@ -15,11 +15,8 @@ public {OBJECT_KIND} {OBJECT_NAME}: {OBJECT_BASE_CLASS}{NSCODING_PROTOCOL_SUPPOR
     // MARK: Properties
 {PROPERTIES}
 
-    // MARK: Initalizers
 {SWIFTY_JSON_SUPPORT}
-
 {OBJECT_MAPPER_SUPPORT}
-
     /**
     Generates description of the object in the form of a NSDictionary.
     - returns: A Key value pair containing all valid values in the object.
@@ -28,10 +25,7 @@ public {OBJECT_KIND} {OBJECT_NAME}: {OBJECT_BASE_CLASS}{NSCODING_PROTOCOL_SUPPOR
 
         var dictionary: [String : AnyObject ] = [ : ]
 {DESC}
-
         return dictionary
     }
-
     {NSCODING_SUPPORT}
-
 }

SwiftyJSONAccelerator/Base Files/NSCodingTemplate.txt

@@ -1,8 +1,9 @@
-// MARK: NSCoding Protocol
+
+    // MARK: NSCoding Protocol
     required public init(coder aDecoder: NSCoder) {
 {DECODERS}
     }
 
     public func encodeWithCoder(aCoder: NSCoder) {
 {ENCODERS}
-    }
+    }

SwiftyJSONAccelerator/Base Files/ObjectMapperTemplate.txt

@@ -1,3 +1,4 @@
+    // MARK: ObjectMapper Initalizers
     /**
     Map a JSON object to this class using ObjectMapper
     - parameter map: A mapping from ObjectMapper

SwiftyJSONAccelerator/Base Files/SwiftyJSONTemplate.txt

@@ -1,3 +1,4 @@
+    // MARK: SwiftyJSON Initalizers
     /**
     Initates the class based on the object
     - parameter object: The object of either Dictionary or Array kind that was passed.
@@ -14,4 +15,4 @@
     */
     public init(json: JSON) {
 {INITALIZER}
-    }
+    }

SwiftyJSONAccelerator/Base.lproj/Main.storyboard

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<document type="com.apple.InterfaceBuilder3.Cocoa.Storyboard.XIB" version="3.0" toolsVersion="9059" systemVersion="15A282b" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none" useAutolayout="YES" initialViewController="B8D-0N-5wS">
+<document type="com.apple.InterfaceBuilder3.Cocoa.Storyboard.XIB" version="3.0" toolsVersion="9059" systemVersion="15A284" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none" useAutolayout="YES" initialViewController="B8D-0N-5wS">
     <dependencies>
         <deployment identifier="macosx"/>
         <plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="9059"/>
@@ -699,10 +699,10 @@
                                             <animations/>
                                             <color key="textColor" white="1" alpha="1" colorSpace="calibratedWhite"/>
                                             <color key="backgroundColor" white="0.0" alpha="1" colorSpace="calibratedWhite"/>
-                                            <size key="minSize" width="700" height="461"/>
+                                            <size key="minSize" width="715" height="461"/>
                                             <size key="maxSize" width="717" height="10000000"/>
                                             <color key="insertionPointColor" name="controlLightHighlightColor" catalog="System" colorSpace="catalog"/>
-                                            <size key="minSize" width="700" height="461"/>
+                                            <size key="minSize" width="715" height="461"/>
                                             <size key="maxSize" width="717" height="10000000"/>
                                         </textView>
                                     </subviews>
@@ -716,7 +716,7 @@
                                     <animations/>
                                 </scroller>
                                 <scroller key="verticalScroller" verticalHuggingPriority="750" horizontal="NO" id="9fh-RH-upi">
-                                    <rect key="frame" x="701" y="1" width="15" height="461"/>
+                                    <rect key="frame" x="700" y="1" width="16" height="461"/>
                                     <autoresizingMask key="autoresizingMask"/>
                                     <animations/>
                                 </scroller>

SwiftyJSONAccelerator/SJEditorViewController.swift

@@ -12,14 +12,14 @@ import Cocoa
 class SJEditorViewController: NSViewController, NSTextViewDelegate {
 
     // MARK: Outlet files.
-    @IBOutlet var textView: SJTextView?
-    @IBOutlet var messageLabel: NSTextField?
-    @IBOutlet var errorImageView: NSImageView?
-    @IBOutlet var baseClassTextField: NSTextField?
-    @IBOutlet var prefixClassTextField: NSTextField?
-    @IBOutlet var companyNameTextField: NSTextField?
-    @IBOutlet var authorNameTextField: NSTextField?
-    @IBOutlet var includeSwiftyCheckbox: NSButton?
+    @IBOutlet var textView: SJTextView!
+    @IBOutlet var messageLabel: NSTextField!
+    @IBOutlet var errorImageView: NSImageView!
+    @IBOutlet var baseClassTextField: NSTextField!
+    @IBOutlet var prefixClassTextField: NSTextField!
+    @IBOutlet var companyNameTextField: NSTextField!
+    @IBOutlet var authorNameTextField: NSTextField!
+    @IBOutlet var includeSwiftyCheckbox: NSButton!
     @IBOutlet var supportNSCodingCheckbox: NSButton!
     @IBOutlet var supportSwiftyJSONCheckbox: NSButton!
     @IBOutlet var supportObjectMapperCheckbox: NSButton!
@@ -49,12 +49,12 @@ class SJEditorViewController: NSViewController, NSTextViewDelegate {
     }
 
     /**
-    Validates and updates the textview.
+     Validates and updates the textview.
 
-    - parameter pretty: If the JSON is to be pretty printed.
+     - parameter pretty: If the JSON is to be pretty printed.
 
-    - returns: if the format was valid.
-    */
+     - returns: if the format was valid.
+     */
     func validateAndFormat(pretty: Bool) -> Bool {
 
         if textView?.string?.characters.count == 0 {
@@ -80,8 +80,8 @@ class SJEditorViewController: NSViewController, NSTextViewDelegate {
     }
 
     /**
-    Actual function that generates the model.
-    */
+     Actual function that generates the model.
+     */
     func generateModel() {
 
         // The base class field is blank, cannot proceed without it. Possibly can have a default value in the future.
@@ -106,13 +106,24 @@ class SJEditorViewController: NSViewController, NSTextViewDelegate {
 
             let swiftyState = self.includeSwiftyCheckbox?.state == 1 ? true : false
             let supportSwiftyState = self.supportSwiftyJSONCheckbox?.state == 1 ? true : false
-            
+
             let nscodingState = self.supportNSCodingCheckbox?.state == 1 ? true : false
-            
+
             let objectMapperState = self.includeObjectMapperCheckbox?.state == 1 ? true : false
             let supportObjectMapperState = self.supportObjectMapperCheckbox?.state == 1 ? true : false
 
-            let generator: ModelGenerator = ModelGenerator.init(baseContent: JSON(object!), prefix:  prefixClassTextField?.stringValue, baseClassName: (baseClassTextField?.stringValue)!, authorName: authorNameTextField?.stringValue, companyName: companyNameTextField?.stringValue, type: ModelType.kClassType, filePath:  filePath!, supportSwiftyJSON: supportSwiftyState, includeSwiftyJSON: swiftyState, supportObjectMapper: supportObjectMapperState, includeObjectMapper: objectMapperState, supportNSCoding: nscodingState)
+            let generator: ModelGenerator = ModelGenerator.init(baseContent: JSON(object!), baseClassName: baseClassTextField.stringValue, filePath: filePath!)
+
+            generator.prefix = prefixClassTextField.stringValue
+            generator.authorName = authorNameTextField.stringValue
+            generator.companyName = companyNameTextField.stringValue
+            generator.type = ModelType.kClassType
+            generator.supportSwiftyJSON = supportSwiftyState
+            generator.includeSwiftyJSON = swiftyState
+            generator.supportObjectMapper = supportObjectMapperState
+            generator.includeObjectMapper = objectMapperState
+            generator.supportNSCoding = nscodingState
+
             generator.generate()
         } else {
             let alert:NSAlert = NSAlert()
@@ -122,7 +133,7 @@ class SJEditorViewController: NSViewController, NSTextViewDelegate {
     }
 
     @IBAction func recalcEnabledBoxes(sender: AnyObject) {
-        
+
         let supportSwiftyState = self.supportSwiftyJSONCheckbox?.state == 1 ? true : false
         let supportObjectMapperState = self.supportObjectMapperCheckbox?.state == 1 ? true : false
 
@@ -132,15 +143,15 @@ class SJEditorViewController: NSViewController, NSTextViewDelegate {
         else {
             self.includeSwiftyCheckbox?.enabled = false
         }
-        
+
         if supportObjectMapperState {
             self.includeObjectMapperCheckbox?.enabled = true
         }
         else {
             self.includeObjectMapperCheckbox?.enabled = false
         }
     }
-    
+
     // MARK: Internal Methods
 
     /**
@@ -177,11 +188,11 @@ class SJEditorViewController: NSViewController, NSTextViewDelegate {
     }
 
     /**
-    Handle Error message that is provided by the JSON helper and extract the message and showing them accordingly.
+     Handle Error message that is provided by the JSON helper and extract the message and showing them accordingly.
 
-    - parameters:
-    - error: NSError that was provided.
-    */
+     - parameters:
+     - error: NSError that was provided.
+     */
     func handleError(error: NSError?) {
         if let _ = error!.userInfo["debugDescription"] as? String? {
             let message: String = error!.userInfo["NSDebugDescription"]! as! String
@@ -214,19 +225,19 @@ class SJEditorViewController: NSViewController, NSTextViewDelegate {
     }
 
     /**
-    Show that the JSON is fine with proper icon.
-    */
+     Show that the JSON is fine with proper icon.
+     */
     func correctJSONMessage() {
         errorImageView?.image = NSImage.init(named: "success")
         messageLabel?.stringValue = "Valid JSON!"
     }
 
     /**
-    Show the invalid JSON error with proper error and message.
+     Show the invalid JSON error with proper error and message.
 
-    - parameters:
-    - message: Error message that is to be shown.
-    */
+     - parameters:
+     - message: Error message that is to be shown.
+     */
     func invalidJSONError(message: String) {
         errorImageView?.image = NSImage.init(named: "failure")
         messageLabel?.stringValue = message