Merge pull request #6 from kevklam/master

New collection & enum patterns

Author: kevklam

Templates/ObjC/Base/SharedObjC.template.tt

@@ -29,35 +29,11 @@ private string GetObjCTypeIdentifier(OdcmObject o, bool getUnderlyingType=false)
         OdcmProperty prop=(OdcmProperty)o;
         if(prop.IsCollection && !getUnderlyingType)
         {
-            if(IsNSJSONSerializable(prop.Type))
-            {
-                return GetStaticCollectionObject();
-            }
-            else
-            {
-                return prop.Type.GetCollectionTypeString();
-            }
+            return @"NSArray";
         }
 
         return GetObjCTypeIdentifier(prop.Type,getUnderlyingType);
     }
-    else if(o is OdcmMethod)
-    {
-        OdcmMethod method = (OdcmMethod)o;
-        if (method.IsCollection && !getUnderlyingType)
-        {
-            if (IsNSJSONSerializable(method.ReturnType))
-            {
-                return GetStaticCollectionObject();
-            }
-            else
-            {
-                return method.ReturnType.GetCollectionTypeString();
-            }
-        }
-
-        return GetObjCTypeIdentifier(method.ReturnType, getUnderlyingType);
-    }
     else if(o is OdcmType)
     {
         return ((OdcmType)o).GetTypeString();
@@ -108,14 +84,19 @@ private string GetObjCPropertySetter(OdcmProperty prop)
     return "set" + GetObjCProperty(prop).ToUpperFirstChar();
 }
 
-private bool IsNSJSONSerializable(OdcmType type)
+private bool IsObjCTypeSameAsJsonType(OdcmType type)
 {
+    // TODO: To be more correct, we should add a GetJsonType() method
+    //       and return (GetObjCType(type) == GetJsonType(type)). Practically speaking though,
+    //       only Edm.String has the same friendly ObjC type and JSON serializer type.
     string ts=GetObjCTypeIdentifier(type);
-    return ts=="NSString" || ts=="NSNumber" || ts=="NSArray" || ts=="NSDictionary" || ts=="NSNull";
+    return ts=="NSString";
 }
 
-private string GetHydratedPropertyFromNSJSONSerializableExpression(string expr,OdcmProperty prop)
+private string GetJsonToObjCExpressionConversion(string expr,OdcmProperty prop)
 {
+    // This generates a wrapper around a provided JSON-typed expression (i.e. types obtained from NSJSONSerialization)
+    //   that converts it to a user-friendly ObjC type i.e. generated Entity/enum class etc.
     if(GetObjCTypeIdentifier(prop,true)=="NSDate")
     {
         return String.Format(@"[NSDate ms_dateFromString: {0}]",expr);
@@ -128,11 +109,11 @@ private string GetHydratedPropertyFromNSJSONSerializableExpression(string expr,O
         expr,
         GetObjCTypeIdentifier(prop,true));
     }
-    //Complex catch-all
-    if(prop.IsComplex())
+
+    if(prop.Type is OdcmEntityClass || prop.Type is OdcmMediaClass || prop.Type is OdcmComplexClass)
     {
         return String.Format(
-        @"[[{0} alloc] initWithDictionary: {1} ]",
+        @"[[{0} alloc] initWithDictionary: {1}]",
         GetObjCTypeIdentifier(prop,true),
         expr);
     }
@@ -143,94 +124,66 @@ private string GetHydratedPropertyFromNSJSONSerializableExpression(string expr,O
     prop.Type.GetNSNumberValueMethod());
 }
 
-private string GetHydratedPropertyFromNSJSONSerializableExpression(string expr,OdcmMethod method)
-{
-    if(GetObjCTypeIdentifier(method,true)=="NSDate")
-    {
-        return String.Format(@"[NSDate ms_dateFromString: {0}]",expr);
-    }
-
-    if(method.IsEnum())
-    {
-        return String.Format(
-        @"[{0} to{1}]",
-        expr,
-        GetObjCTypeIdentifier(method,true));
-    }
-    //Complex catch-all
-    if(method.IsComplex())
-    {
-        return String.Format(
-        @"[[{0} alloc] initWithDictionary: {1} ]",
-        GetObjCTypeIdentifier(method,true),
-        expr);
-    }
-
-    return String.Format(
-    @"[{0} {1}]",
-    expr,
-    method.ReturnType.GetNSNumberValueMethod());
-}
-
 private string GetHydratedPropertyFromDictionary(OdcmProperty prop)
 {
-    return GetHydratedPropertyFromNSJSONSerializableExpression(String.Format(@"self.dictionary[@""{0}""]",prop.Name),prop);
+    return GetJsonToObjCExpressionConversion(String.Format(@"self.dictionary[@""{0}""]",prop.Name),prop);
 }
 
-private string SetNSJSONPermitedExpressionSerialized(OdcmType type,string val)
+private string GetObjCToJsonConvertibleExpressionConversion(OdcmType type, bool isCollection, string val)
 {
-    //Fallback to complex entities that must support ms_toString
-    if(type.IsComplex())
+    // This generates a wrapper around a provided friendly-ObjC-typed expression that converts it
+    //   to an expression that can be passed into [MSObject getNSJsonSerializationCompatibleValue].
+    //
+    // The categories of Obj-C property types are as follows:
+    //   Entity/Complex generated classes
+    //   Collections (NSArrays)
+    //   Enum generated classes
+    //   System object-types (NSString, NSDate)
+    //   System primitives (int types, BOOL)
+    // 
+    // All of these implement the methods (some via extensions) dictionary/arrayWithItem or ms_toString
+    //   except for system primitives, which we need to box here using @().
+    if (type.IsPrimitive() && !isCollection)
     {
-        return val;
+        return "@(" + val + ")";
     }
 
-    if(type is OdcmEnum)
-    {
-        return String.Format("[NSString stringWith{0}:{1}]",GetObjCTypeIdentifier(type),val);
-    }
-
-    return "@(" + val + ")";
+    return val;
 }
 
-private string SetNSJSONPermitedExpressionSerialized(OdcmProperty prop,string val)
+private string GetObjCToJsonConvertibleExpressionConversion(OdcmProperty prop,string val)
 {
-    //Fallback to complex entities that must support ms_toString
-    if(prop.IsCollection)
-    {
-        return val;
-    }
-
-    return SetNSJSONPermitedExpressionSerialized(prop.Type,val);
+    return GetObjCToJsonConvertibleExpressionConversion(prop.Type, prop.IsCollection, val);
 }
 
-private string SetDictionaryPropertySerialized(OdcmProperty prop, string val)
+private string SetDictionaryPropertyInJsonConvertibleForm(OdcmProperty prop, string val)
 {
-    return String.Format(@"self.dictionary[@""{0}""] = {1};",prop.Name,SetNSJSONPermitedExpressionSerialized(prop,val));
+    // Dictionary entries can either be directly NSJSON-typed, or convertible to
+    //   a NSJSON type via [MSObject getNSJsonSerializationCompatibleValue].
+    // 
+    return String.Format(@"self.dictionary[@""{0}""] = {1};",prop.Name,GetObjCToJsonConvertibleExpressionConversion(prop,val));
 }
 
 private string GetHydratedIVarFromDictionary(OdcmProperty prop)
 {
     if(prop.IsCollection)
     {
         return String.Format(@"
-    NSMutableArray *{0}Collection = [NSMutableArray array];
-    NSArray *{0}s = self.dictionary[@""{1}""];
+    NSMutableArray *{0}Result = [NSMutableArray array];
+    NSArray *{0} = self.dictionary[@""{1}""];
 
-    if ([{0}s isKindOfClass:[NSArray class]]){{
-        for (id {0} in {0}s){{
-            [{0}Collection addObject:{2}];
-         }}
+    if ([{0} isKindOfClass:[NSArray class]]){{
+        for (id {2} in {0}){{
+            [{0}Result addObject:{3}];
+        }}
     }}
 
-    if ([{0}Collection count] > 0){{
-        _{0} = [[{3} alloc] initWithArray:{0}Collection nextLink:self.dictionary[@""@nextLink""] additionalData:self.dictionary];
-    }}
+    _{0} = {0}Result;
         ",
         GetObjCProperty(prop),
         prop.Name,
-        GetObjCProperty(prop),
-        GetObjCTypeIdentifier(prop));
+        prop.Type.Name.ToLowerFirstChar(),
+        GetJsonToObjCExpressionConversion(prop.Type.Name.ToLowerFirstChar(), prop));
     }
 
     return String.Format(@"_{0} = {1};",GetObjCProperty(prop),GetHydratedPropertyFromDictionary(prop));
@@ -254,7 +207,7 @@ public string GetFunctionParameterDictionary(List<OdcmParameter> parameters)
     {
         result.AppendFormat("[{0}Object getNSJsonSerializationCompatibleValue:{1}],",
         writer.GetStaticCodePrefix(),
-        SetNSJSONPermitedExpressionSerialized(param.Type,"_"+param.Name.ToLowerFirstChar()));
+        GetObjCToJsonConvertibleExpressionConversion(param.Type, param.IsCollection, "_"+param.Name.ToLowerFirstChar()));
 
         result.AppendFormat("@\"{0}\",", param.Name);
     }
@@ -292,7 +245,7 @@ private void PropertyGetterImplementation(OdcmProperty prop)
 - (<#=GetObjCTypeForVarDeclaration(prop)#>) <#=GetObjCPropertyGetter(prop)#>
 {
 <#+
-    if(IsNSJSONSerializable(prop.Type))
+    if(IsObjCTypeSameAsJsonType(prop.Type))
     {
 #>
     return self.dictionary[@"<#=prop.Name#>"];
@@ -331,7 +284,7 @@ private void PropertySetterImplementation(OdcmProperty prop)
 - (void) <#=GetObjCPropertySetter(prop)#>: (<#=GetObjCTypeForVarDeclaration(prop)#>) val
 {
 <#+
-    if(IsNSJSONSerializable(prop.Type))
+    if(IsObjCTypeSameAsJsonType(prop.Type))
     {
 #>
     self.dictionary[@"<#=prop.Name#>"] = val;
@@ -341,7 +294,7 @@ private void PropertySetterImplementation(OdcmProperty prop)
     {
 #>
     _<#=GetObjCProperty(prop)#> = val;
-    <#=SetDictionaryPropertySerialized(prop,"val")#>
+    <#=SetDictionaryPropertyInJsonConvertibleForm(prop,"val")#>
 <#+
     }
 #>

Templates/ObjC/Models/CollectionType.h.tt

@@ -4,12 +4,11 @@
 <#
 var entity = host.CurrentType.AsOdcmClass();
 var baseEntity = entity.Base;
-
 #>
-<#=writer.GetImportsClass(entity.Properties,entity.Properties.Where(prop => prop.IsCollection).Select(prop => GetObjCTypeIdentifier(prop)).Distinct())#>
+
+<#=writer.GetImportsClass(entity.Properties)#>
 
 #import "<#=GetObjCTypeIdentifier(baseEntity)#>.h"
-#import "<#=GetStaticCollectionObject()#>.h"
 
 @interface <#=GetObjCTypeIdentifier(entity)#> : <#=GetObjCTypeIdentifier(baseEntity)#>
 

Templates/ObjC/Models/CollectionType.m.tt

@@ -5,11 +5,11 @@
 var entity = host.CurrentType.AsOdcmClass();
 var baseEntity = entity.Base;
 
+IEnumerable<string> extraClasses = null;
 #>
-<#=writer.GetImportsClass(entity.Properties,entity.Properties.Where(prop => prop.IsCollection).Select(prop => GetObjCTypeIdentifier(prop)).Distinct())#>
+<#=writer.GetImportsClass(entity.Properties, extraClasses:extraClasses)#>
 
 #import "<#=GetObjCTypeIdentifier(baseEntity)#>.h"
-#import "<#=GetStaticCollectionObject()#>.h"
 
 @interface <#=GetObjCTypeIdentifier(entity)#> : <#=GetObjCTypeIdentifier(baseEntity)#>
 
@@ -28,7 +28,7 @@ foreach(var prop in entity.Properties.Where(prop => GetObjCTypeIdentifier(prop)!
   <#
 }
 
-foreach (var prop in entity.Properties.Where(prop => prop.IsCollection && !prop.LongDescriptionContains("not-enumerable")))
+foreach (var prop in entity.Properties.Where(prop => prop.IsCollection && prop.LongDescriptionContains("enumerable")))
 {
 #>
 - (<#=GetObjCTypeForVarDeclaration(prop,true)#>) <#=GetObjCProperty(prop)#>:(NSInteger)index;