added convinience method for mapping, refactored the code

grevolution · grevolution · commit 154b73a3e7ac · 2015-03-14T22:45:08.000+11:00
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@ SHModelObject
 
 `SHModelObject` is a utility model Base Class that uses objective-c runtime to assign the values to instance variables and properties of the model class from an `NSDictionary`, Which is a basic usecase when using webservices that return JSON response.
 
-[![Build Status](https://travis-ci.org/grevolution/SHModelObject.svg?branch=master)](https://travis-ci.org/grevolution/SHModelObject)
+[![Build Status](https://img.shields.io/travis/grevolution/SHModelObject.svg?branch=master)](https://travis-ci.org/grevolution/SHModelObject) [![Pod Version](https://img.shields.io/cocoapods/v/SHModelObject.svg)](https://img.shields.io/cocoapods/v/SHModelObject.svg) [![License](https://img.shields.io/cocoapods/l/SHModelObject.svg)](https://img.shields.io/cocoapods/l/SHModelObject.svg)
 
 Let say you have a WebService that serves you back the following Response:
 
@@ -79,7 +79,110 @@ you can override `- (void)serializeValue:(id)value withKey:(id)key` method if yo
 
 ##Parsing .NET JSON Dates to NSDate or NSTimeInterval
 
-you can use `kDateConversionOption` to convert the .NET JSON Date Strings to either `NSDate` or `NSTimeInterval` or keep it as `NSString` and parse yourself.
+you can use `kDateConversionOption` to convert the .NET JSON Date Strings to either `NSDate` or `NSTimeInterval` or keep it as `NSString` and parse yourself and also you can define `kInputDateFormat` to specify your input date format (JSON format, .NET Simple or .NET with timezone)
+
+
+##Parsing instance variables which are also a subclass of `SHModelObject` 
+
+you dont have to do anything :). `SHModelObject` automatically handles it. checkout the sample code.
+
+for example, following JSON
+
+```
+
+{
+	"name" : "Shan Ul Haq",
+	"person_id" : 123,
+	"image" : {
+		"image_id" : 234,
+		"image_url" : http://image_url,
+		"orientation" : "portrait"
+	}
+}
+
+```
+will be automatically parsed into following object:
+
+```
+@interface Person : SHModelObject
+
+@property(nonatomic, strong) NSString *name;
+@property(nonatomic) int personId;
+@property(nonatomic, strong) Image *image;
+
+@end
+```
+where Image object is also a `SHModelObject`
+
+```
+@interface Image : SHModelObject
+
+@property(nonatomic) int imageId;
+@property(nonatomic, strong) NSString *imageUrl;
+@property(nonatomic, strong) NSString *orientation;
+
+@end
+```
+
+###Parsing arrays of objects which are a subclass of `SHModelObject`
+
+similar to parsing `SHModelObject` instance variables, arrays can be handled too. you need to specify the mapping which will define that the JSON array consist of which object type.
+
+for example, if you have following JSON
+
+```
+{ 
+     "aKey" : "aValue",
+     "arrayOfModels" : [
+             {
+                 "modelId" : 2,
+                 "modelName" : "My Model 2",
+                 "modelType" : "My Model Type 2"
+                 },{
+                 "modelId" : 3,
+                 "modelName" : "My Model 3",
+                 "modelType" : "My Model Type 3"
+                 },{
+                 "modelId" : 4,
+                 "modelName" : "My Model 4",
+                 "modelType" : "My Model Type 4"
+                 }
+             ]
+     }
+}
+
+```
+which translates to following objects.
+
+```
+@interface MyObject : SHModelObject
+
+@property(nonatomic, strong) NSString *aKey;
+@property(nonatomic, strong) NSArray *arrayOfModels;
+
+@end
+
+@interface AModel : SHModelObject
+
+@property(nonatomic) int modelId;
+@property(nonatomic, strong) NSString *modelName;
+@property(nonatomic, strong) NSString *modelType;
+
+@end
+
+
+```
+
+you can convert json like this:
+
+```
+// key is the variable name and value is the class name.
+NSDictionary *mappingDictionary = @{@"arrayOfModels" : "AModel"}; 
+
+MyObject *myObject = [MyObject objectWithDictionary:dictionary mapping:mappingDictionary];
+
+```
+
 
 ##How to Use it.
 
@@ -96,8 +199,9 @@ you can use `kDateConversionOption` to convert the .NET JSON Date Strings to eit
 ##Tasks Pending
 
 - [X] adding to cocoapods.
-- [ ] adding support for custom instance variable types that are also subclasses of `SHModelObject`
-- [ ] implementing `NSCoding` for archiving/unarchiving the model objects.
+- [X] adding support for custom instance variable types that are also subclasses of `SHModelObject`
+- [X] implementing `NSCoding` for archiving/unarchiving the model objects.
+- [X] adding support for handling arrays of custom `SHModelObject` objects.
 - [ ] implementing a deserializer for converting the object to NSDictionary. 
 
 ##Contact Me
diff --git a/SHModelObject.xcodeproj/project.xcworkspace/xcuserdata/shanulhaq.xcuserdatad/UserInterfaceState.xcuserstate b/SHModelObject.xcodeproj/project.xcworkspace/xcuserdata/shanulhaq.xcuserdatad/UserInterfaceState.xcuserstate
diff --git a/SHModelObject.xcodeproj/xcuserdata/shanulhaq.xcuserdatad/xcdebugger/Breakpoints_v2.xcbkptlist b/SHModelObject.xcodeproj/xcuserdata/shanulhaq.xcuserdatad/xcdebugger/Breakpoints_v2.xcbkptlist
@@ -3,34 +3,18 @@
    type = "1"
    version = "2.0">
    <Breakpoints>
-      <BreakpointProxy
-         BreakpointExtensionID = "Xcode.Breakpoint.FileBreakpoint">
-         <BreakpointContent
-            shouldBeEnabled = "Yes"
-            ignoreCount = "0"
-            continueAfterRunningActions = "No"
-            filePath = "SHModelObject/SHModelObject/SHModelObject.m"
-            timestampString = "448012336.337347"
-            startingColumnNumber = "9223372036854775807"
-            endingColumnNumber = "9223372036854775807"
-            startingLineNumber = "308"
-            endingLineNumber = "308"
-            landmarkName = "-serializeValue:withKey:"
-            landmarkType = "5">
-         </BreakpointContent>
-      </BreakpointProxy>
       <BreakpointProxy
          BreakpointExtensionID = "Xcode.Breakpoint.FileBreakpoint">
          <BreakpointContent
             shouldBeEnabled = "Yes"
             ignoreCount = "0"
             continueAfterRunningActions = "No"
             filePath = "SHModelObject/SHAppDelegate.m"
-            timestampString = "448012488.962849"
+            timestampString = "448026024.247668"
             startingColumnNumber = "9223372036854775807"
             endingColumnNumber = "9223372036854775807"
-            startingLineNumber = "80"
-            endingLineNumber = "80"
+            startingLineNumber = "79"
+            endingLineNumber = "79"
             landmarkName = "-application:didFinishLaunchingWithOptions:"
             landmarkType = "5">
          </BreakpointContent>
diff --git a/SHModelObject/SHAppDelegate.m b/SHModelObject/SHAppDelegate.m
@@ -33,7 +33,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [self.window makeKeyAndVisible];
     
     
-    NSDictionary *a = @{ @"string_value" : @"shan",
+    NSDictionary *aDictionary = @{ @"string_value" : @"shan",
                          @"another_string_value" : @"ul haq",
                          @"INTVALUE" : @12,
                          @"AnotherIntValue" : @23,
@@ -72,19 +72,18 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
                                  ]
                          };
     
-    NSDictionary *mapping = @{@"time1":@"",@"time2":@"",@"time3":@"", @"arrayOfAnotherModels" : @"SHAnotherModel"};
-    SHTestModal *modal = [[SHTestModal alloc] initWithDictionary:a
-                                            dateConversionOption:kDateConverstionFromNSStringToNSDateOption
-                                                   inputDateType:kInputDateFormatDotNetWithTimeZone mappings:mapping];
+    NSDictionary *mapping = @{@"arrayOfAnotherModels" : @"SHAnotherModel"};
     
+    SHTestModal *model = [SHTestModal objectWithDictionary:aDictionary dateConversionOption:kDateConverstionFromNSStringToNSTimeIntervalOption inputDateType:kInputDateFormatDotNetWithTimeZone mappings:mapping];
+
     NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
     NSString *documentsDirectoryPath = [paths objectAtIndex:0];
     NSString *filePath = [documentsDirectoryPath stringByAppendingPathComponent:@"appData"];
     
-    BOOL isArchived = [NSKeyedArchiver archiveRootObject:modal toFile:filePath];
+    BOOL isArchived = [NSKeyedArchiver archiveRootObject:model toFile:filePath];
     SHTestModal *unarchived = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
 
-    NSLog([modal description], nil);
+    NSLog([model description], nil);
     NSLog([unarchived description], nil);
 
     
diff --git a/SHModelObject/SHModelObject/SHModelObject.h b/SHModelObject/SHModelObject/SHModelObject.h
@@ -68,7 +68,7 @@ typedef NS_ENUM(int, kInputDateFormat) {
  */
 - (instancetype)initWithDictionary:(NSDictionary *)dictionary dateConversionOption:(kDateConversionOption)option
                      inputDateType:(kInputDateFormat)inputDateType
-                          mappings:(NSDictionary *)dateValueMapping;
+                          mappings:(NSDictionary *)mapping;
 
 /**
  *  static variant of class initializer with nil check for the dictionary passed
@@ -79,18 +79,31 @@ typedef NS_ENUM(int, kInputDateFormat) {
  */
 + (instancetype)objectWithDictionary:(NSDictionary *)dictionary;
 
+/**
+ *  static variant of class initializer with nil check for the dictionary passed and mapping dictionary
+ *  this will use the default date conversion options (kDateConverstionFromNSStringToNSStringOption and
+ *  kInputDateFormatJSON)
+ *
+ *  @param dictionary dictionary containing key/value pairs for the object
+ *  @param mapping dictionary to define the mappings for date conversion and array <-> object.
+ *
+ *  @return object of type instancetype populated with the values from `dictionary`
+ */
++ (instancetype)objectWithDictionary:(NSDictionary *)dictionary mappings:(NSDictionary *)mapping;
+
 /**
  *  static variant of class initializer with nil check for the dictionary passed
  *
  *  @param dictionary dictionary containing key/value pairs for the object
  *  @param option `kDateConverstionOption` to determine what to do when the value from dictionary is a DOT.NET Date type.
  *  @param inputDateType `kInputDateFormat` to determine what what is the input format of the date.
+ *  @param mapping dictionary to define the mappings for date conversion and array <-> object.
  *
  *  @return object of type instancetype populated with the values from `dictionary`
  */
 + (instancetype)objectWithDictionary:(NSDictionary *)dictionary dateConversionOption:(kDateConversionOption)option
                        inputDateType:(kInputDateFormat)inputDateType
-                            mappings:(NSDictionary *)dateValueMapping;
+                            mappings:(NSDictionary *)mapping;
 
 /**
  *  update the instance with new dictionary values
@@ -107,12 +120,13 @@ typedef NS_ENUM(int, kInputDateFormat) {
  *  @param dictionary dictionary containing key/value pairs for the object
  *  @param option `kDateConverstionOption` to determine what to do when the value from dictionary is a DOT.NET Date type.
  *  @param inputDateType `kInputDateFormat` to determine what what is the input format of the date.
+ *  @param mapping dictionary to define the mappings for date conversion and array <-> object.
  *
  *  @return object of type instancetype populated with the values from `dictionary`
  */
 - (instancetype)updateWithDictionary:(NSDictionary *)dictionary dateConversionOption:(kDateConversionOption)option
                        inputDateType:(kInputDateFormat)inputDateType
-                            mappings:(NSDictionary *)dateValueMapping;
+                            mappings:(NSDictionary *)mapping;
 @end
 
 
diff --git a/SHModelObject/SHModelObject/SHModelObject.m b/SHModelObject/SHModelObject/SHModelObject.m
