Objective-C namespaces support (#273)

* ObjC namespaces support

* handle special case for Edm namespace

* fix documentation

Author: zengin

Templates/ObjC/Base/SharedObjC.template.tt

@@ -275,7 +275,7 @@ private string GetJsonToObjCExpressionConversionOpenType(OdcmProperty prop)
 {
     string objCIdentifierType = GetObjCTypeIdentifierCollection(prop);
 
-    if(model.GetComplexTypes().Any(complexType => objCIdentifierType.Equals(writer.GetPrefix() + complexType.Name.ToUpperFirstChar())))
+    if(model.GetComplexTypes().Any(complexType => objCIdentifierType.Equals(writer.GetNamespacePrefixForType(complexType) + complexType.Name.ToUpperFirstChar())))
     {
         return String.Format("[[{0} alloc] initWithDictionary:value]", objCIdentifierType);
     }

Templates/ObjC/Models/ClientModels.h.tt

@@ -10,23 +10,23 @@ var enums = model.GetEnumTypes();
 foreach(var e in enums)
 {
 #>
-#import "<#=writer.GetPrefix() + e.Name.ToUpperFirstChar()#>.h"
+#import "<#=writer.GetNamespacePrefixForType(e) + e.Name.ToUpperFirstChar()#>.h"
 <#
 }
 
 var complexTypes = model.GetComplexTypes().Where(complexType => !complexType.LongDescriptionContains("methodResponse"));
 foreach(var c in complexTypes)
 {
 #>
-#import "<#=writer.GetPrefix() + c.Name.ToUpperFirstChar()#>.h"
+#import "<#=writer.GetNamespacePrefixForType(c) + c.Name.ToUpperFirstChar()#>.h"
 <#
 }
 
 var entityTypes = model.GetEntityTypes();
 foreach(var et in entityTypes)
 {	 
 #>
-#import "<#=writer.GetPrefix() + et.Name.ToUpperFirstChar()#>.h"
+#import "<#=writer.GetNamespacePrefixForType(et) + et.Name.ToUpperFirstChar()#>.h"
 <#
 }
 

src/GraphODataTemplateWriter/CodeHelpers/ObjC/CodeWriterObjC.cs

@@ -21,10 +21,9 @@ public CodeWriterObjC(OdcmModel model) : base(model)
         {
         }
 
-        public string GetPrefix()
-        {
-            return TypeHelperObjC.Prefix;
-        }
+        public string GetPrefix() => ConfigurationService.Settings.NamespacePrefix;
+
+        public string GetNamespacePrefixForType(OdcmType type) => TypeHelperObjC.GetNamespacePrefixForType(type);
 
         public string GetStaticCodePrefix()
         {
@@ -56,15 +55,15 @@ public string GetInterfaceLine(OdcmClass entityType, string baseClass = null)
             else
             {
                 baseEntity = entityType.Base == null ? "NSObject"
-                                           : this.GetPrefix() + entityType.Base.Name.Substring(entityType.Base.Name.LastIndexOf(".") + 1);
+                                           : GetNamespacePrefixForType(entityType.Base) + entityType.Base.Name.Substring(entityType.Base.Name.LastIndexOf(".") + 1);
             }
             var interfaceLineBuilder = new StringBuilder();
             // NSObject lives in Foundation/Foundation.h
             var baseImport = (baseEntity.Equals("NSObject")) ? "#import <Foundation/Foundation.h>" : String.Format("#import \"{0}.h\"", baseEntity);
             interfaceLineBuilder.AppendLine(baseImport);
 
             interfaceLineBuilder.AppendLine().AppendLine().AppendLine(this.GetHeaderDoc(entityType.Name))
-            .AppendFormat("@interface {0}{1} : {2}", this.GetPrefix(), entityType.Name.ToUpperFirstChar(), baseEntity);
+            .AppendFormat("@interface {0}{1} : {2}", GetNamespacePrefixForType(entityType), entityType.Name.ToUpperFirstChar(), baseEntity);
 
             return interfaceLineBuilder.ToString();
         }

src/GraphODataTemplateWriter/CodeHelpers/ObjC/TypeHelperObjC.cs

@@ -8,11 +8,10 @@ namespace Microsoft.Graph.ODataTemplateWriter.CodeHelpers.ObjC
     using Microsoft.Graph.ODataTemplateWriter.Settings;
     using Vipr.Core.CodeModel;
     using NLog;
+    using System;
 
     public static class TypeHelperObjC
     {
-        public static string Prefix = ConfigurationService.Settings.NamespacePrefix;
-
         private static Logger logger = LogManager.GetCurrentClassLogger();
 
         private static ICollection<string> reservedNames;
@@ -136,8 +135,34 @@ public static string GetTypeString(this OdcmType type)
                     return "Byte";
 
                 default:
-                    return Prefix + type.Name.ToUpperFirstChar();
+                    return GetNamespacePrefixForType(type) + type.Name.ToUpperFirstChar();
+            }
+        }
+        public static string GetNamespacePrefixForType(OdcmType type) => GetNamespacePrefix(type.Namespace.Name);
+
+        /// <summary>
+        /// Constructs a namespace prefix for ObjC types, microsoft.graph is converted into MSGraph and rest of
+        /// the namespace parts are concatenated with PascalCase.
+        /// e.g. microsoft.graph.sub1.sub2 is converted into the prefix MSGraphSub1Sub2
+        /// </summary>
+        /// <param name="namespace">namespace that will be converted into a prefix</param>
+        /// <returns>ObjC representation of an Odcm namespace</returns>
+        public static string GetNamespacePrefix(string @namespace)
+        {
+            if (@namespace.Equals("Edm", StringComparison.OrdinalIgnoreCase))
+            {
+                return string.Empty;
             }
+
+            var primaryNamespace = ConfigurationService.Settings.PrimaryNamespaceName; // microsoft.graph
+            var defaultPrefix = ConfigurationService.Settings.NamespacePrefix; // MSGraph
+            if (@namespace.Equals(primaryNamespace, StringComparison.OrdinalIgnoreCase))
+            {
+                return defaultPrefix;
+            }
+
+            var subNamespace = @namespace.Substring(primaryNamespace.Length + 1); // extract sub1.sub2 from microsoft.graph.sub1.sub2
+            return defaultPrefix + string.Join(string.Empty, subNamespace.Split('.').Select(x => x.ToPascalize()));
         }
 
         public static string GetTypeString(this OdcmProperty property)

src/GraphODataTemplateWriter/PathWriters/ObjCPathWriter.cs

@@ -4,24 +4,22 @@ namespace Microsoft.Graph.ODataTemplateWriter.PathWriters
 {
     using System;
     using System.IO;
+    using Microsoft.Graph.ODataTemplateWriter.CodeHelpers.ObjC;
     using Microsoft.Graph.ODataTemplateWriter.Settings;
     using Microsoft.Graph.ODataTemplateWriter.TemplateProcessor;
 
     class ObjCPathWriter : PathWriterBase
     {
-
-        public override string WritePath(ITemplateInfo template, string entityTypeName)
+        public override string WritePath(ITemplateInfo template, string @namespace, string entityTypeName)
         {
-            string prefix = ConfigurationService.Settings.NamespacePrefix;
             string coreFileName = this.TransformFileName(template, entityTypeName);
+            string prefix = TypeHelperObjC.GetNamespacePrefix(@namespace);
+            return Path.Combine(template.OutputParentDirectory, prefix + coreFileName);
+        }
 
-            return Path.Combine(
-                template.OutputParentDirectory, 
-                String.Format("{0}{1}",
-                    prefix,
-                    coreFileName
-                )
-            );
+        public override string WritePath(ITemplateInfo template, string entityTypeName)
+        {
+            return WritePath(template, ConfigurationService.Settings.PrimaryNamespaceName, entityTypeName);
         }
 
     }

test/Typewriter.Test/MultipleNamespacesTestRunner.cs

@@ -13,7 +13,8 @@ public enum TestLanguage
         CSharp,
         Java,
         TypeScript,
-        PHP
+        PHP,
+        ObjC
     }
 
     public static class MultipleNamespacesTestRunner
@@ -26,7 +27,7 @@ public static class MultipleNamespacesTestRunner
         private const string MetadataMultipleNamespacesFile = "MetadataMultipleNamespaces.xml";
 
         // contains microsoft.graph and microsoft.graph.callRecords
-        // TypeScript and PHP rely on the assumption that all namespaces will be a subnamespace to microsoft.graph
+        // TypeScript, ObjC and PHP rely on the assumption that all namespaces will be a subnamespace to microsoft.graph
         // and generation process creates a single file with nested namespaces
         private const string MetadataWithSubNamespacesFile = "MetadataWithSubNamespaces.xml";
 
@@ -44,6 +45,8 @@ string getMetadataFile(TestLanguage testLanguage)
                         return MetadataWithSubNamespacesFile;
                     case TestLanguage.PHP:
                         return MetadataWithSubNamespacesFile;
+                    case TestLanguage.ObjC:
+                        return MetadataWithSubNamespacesFile;
                     default:
                         throw new ArgumentException("unexpected test language", nameof(testLanguage));
                 }
@@ -136,26 +139,32 @@ private static void CompareFiles(StringBuilder testOutputBuilder, string expecte
         /// <returns></returns>
         private static IEnumerable<(string, string)> GetFilePaths(TestLanguage language, string dataDirectory, string testDataDirectoryName, string outputDirectoryName)
         {
-            string extension = string.Empty;
+            HashSet<string> extensions = new HashSet<string>();
             switch (language)
             {
                 case TestLanguage.CSharp:
-                    extension = "*.cs";
+                    extensions.Add(".cs");
                     break;
                 case TestLanguage.Java:
-                    extension = "*.java";
+                    extensions.Add(".java");
                     break;
                 case TestLanguage.TypeScript:
-                    extension = "*.ts";
+                    extensions.Add(".ts");
                     break;
                 case TestLanguage.PHP:
-                    extension = "*.php";
+                    extensions.Add(".php");
+                    break;
+                case TestLanguage.ObjC:
+                    extensions.Add(".m");
+                    extensions.Add(".h");
                     break;
                 default:
                     throw new ArgumentException("unexpected test language", nameof(language));
             }
 
-            return from file in new DirectoryInfo(dataDirectory).GetFiles(extension, SearchOption.AllDirectories)
+            return from file in new DirectoryInfo(dataDirectory)
+                       .EnumerateFiles("*", SearchOption.AllDirectories)
+                       .Where(f => extensions.Contains(f.Extension))
                    let actualOutputFilePath = file.FullName.Replace(testDataDirectoryName, outputDirectoryName)
                    let expectedFilePath = file.FullName
                    select (expectedFilePath, actualOutputFilePath);

test/Typewriter.Test/ObjCMultipeNamespacesTests.cs

@@ -0,0 +1,14 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace Typewriter.Test
+{
+    [TestClass]
+    public class ObjCMultipeNamespacesTests
+    {
+        [TestMethod]
+        public void Test()
+        {
+            MultipleNamespacesTestRunner.Run(TestLanguage.ObjC);
+        }
+    }
+}

test/Typewriter.Test/TestDataObjC/Models/MSGraphCall.h

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.  See License in the project root for license information.
+
+
+
+
+#import "MSGraphEntity.h"
+
+@interface MSGraphCall : MSGraphEntity
+
+  @property (nullable, nonatomic, setter=setSubject:, getter=subject) NSString* subject;
+  
+@end

test/Typewriter.Test/TestDataObjC/Models/MSGraphCall.m

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.  See License in the project root for license information.
+
+
+
+#import "NSDate+MSSerialization.h"
+
+#import "MSGraphClientModels.h"
+
+@interface MSObject()
+
+@property (strong, nonatomic) NSMutableDictionary *dictionary;
+
+@end
+
+@interface MSGraphCall()
+{
+    NSString* _subject;
+}
+@end
+
+@implementation MSGraphCall
+
+- (id) init
+{
+    if (self = [super init]) {
+        self.oDataType = @"#microsoft.graph.call";
+    }
+    return self;
+}
+- (NSString*) subject
+{
+    if([[NSNull null] isEqual:self.dictionary[@"subject"]])
+    {
+        return nil;
+    }   
+    return self.dictionary[@"subject"];
+}
+
+- (void) setSubject: (NSString*) val
+{
+    self.dictionary[@"subject"] = val;
+}
+
+
+@end

test/Typewriter.Test/TestDataObjC/Models/MSGraphCallRecordsCallRecord.h

@@ -0,0 +1,25 @@
+// Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.  See License in the project root for license information.
+
+
+@class MSGraphIdentitySet, MSGraphCallRecordsSession, MSGraphEntityType2; 
+#import "MSGraphCallRecordsCallType.h"
+#import "MSGraphCallRecordsModality.h"
+
+
+#import "MSGraphEntity.h"
+
+@interface MSGraphCallRecordsCallRecord : MSGraphEntity
+
+  @property (nonatomic, setter=setVersion:, getter=version) int64_t version;
+    @property (nonnull, nonatomic, setter=setType:, getter=type) MSGraphCallRecordsCallType* type;
+    @property (nonnull, nonatomic, setter=setModalities:, getter=modalities) NSArray* modalities;
+    @property (nonnull, nonatomic, setter=setLastModifiedDateTime:, getter=lastModifiedDateTime) NSDate* lastModifiedDateTime;
+    @property (nonnull, nonatomic, setter=setStartDateTime:, getter=startDateTime) NSDate* startDateTime;
+    @property (nonnull, nonatomic, setter=setEndDateTime:, getter=endDateTime) NSDate* endDateTime;
+    @property (nullable, nonatomic, setter=setOrganizer:, getter=organizer) MSGraphIdentitySet* organizer;
+    @property (nullable, nonatomic, setter=setParticipants:, getter=participants) NSArray* participants;
+    @property (nullable, nonatomic, setter=setJoinWebUrl:, getter=joinWebUrl) NSString* joinWebUrl;
+    @property (nullable, nonatomic, setter=setSessions:, getter=sessions) NSArray* sessions;
+    @property (nullable, nonatomic, setter=setRecipients:, getter=recipients) NSArray* recipients;
+  
+@end