Merge dev into master

GraphODataTemplateWriter.Test/TypeHelperTests.cs

@@ -0,0 +1,95 @@
+using Microsoft.Graph.ODataTemplateWriter.CodeHelpers.CSharp;
+using Microsoft.Graph.ODataTemplateWriter.CodeHelpers.TypeScript;
+using Microsoft.Graph.ODataTemplateWriter.CodeHelpers.PHP;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Vipr.Core.CodeModel;
+
+
+namespace GraphODataTemplateWriter.Test
+{
+    [TestClass]
+    public class TypeHelperTests
+    {
+        OdcmProperty testProperty;
+        string actualInputString = "\r\n Test string";
+        string expectedOutputString = "\r\n/// Test string";
+
+        [TestInitialize]
+        public void Initialize()
+        {
+            testProperty = new OdcmProperty("testPropertyName");
+        }
+
+        /// <summary>
+        /// Test that GetSanitizedLongDescription provides long descriptions without uncommented lines of text.
+        /// </summary>
+        [TestMethod]
+        public void Long_Description_Doesnt_Contain_Uncommented_NewLine_For_CSharp()
+        {
+            testProperty.LongDescription = actualInputString;
+            string sanitizedString = TypeHelperCSharp.GetSanitizedLongDescription(testProperty); // Explicitly bind to extension method.
+
+            Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
+        }
+
+        /// <summary>
+        /// Test that GetSanitizedLongDescription provides descriptions without uncommented lines of text.
+        /// </summary>
+        [TestMethod]
+        public void Description_Doesnt_Contain_Uncommented_NewLine_For_CSharp()
+        {
+            testProperty.Description = actualInputString;
+            string sanitizedString = TypeHelperCSharp.GetSanitizedLongDescription(testProperty);
+
+            Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
+        }
+
+        /// <summary>
+        /// Test that GetSanitizedLongDescription provides long descriptions without uncommented lines of text for Typescript.
+        /// </summary>
+        [TestMethod]
+        public void Long_Description_Doesnt_Contain_Uncommented_NewLine_For_Typescript()
+        {
+            testProperty.LongDescription = actualInputString;
+            string sanitizedString = TypeHelperTypeScript.GetSanitizedLongDescription(testProperty); // Explicitly bind to extension method.
+
+            Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
+        }
+
+        /// <summary>
+        /// Test that GetSanitizedLongDescription provides descriptions without uncommented lines of text for Typescript.
+        /// </summary>
+        [TestMethod]
+        public void Description_Doesnt_Contain_Uncommented_NewLine_For_Typescript()
+        {
+            testProperty.Description = actualInputString;
+            string sanitizedString = TypeHelperTypeScript.GetSanitizedLongDescription(testProperty);
+
+            Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
+        }
+
+        /// <summary>
+        /// Test that GetSanitizedLongDescription provides long descriptions without uncommented lines of text for PHP.
+        /// </summary>
+        [TestMethod]
+        public void Long_Description_Doesnt_Contain_Uncommented_NewLine_For_PHP()
+        {
+            testProperty.LongDescription = actualInputString;
+            string sanitizedString = TypeHelperPHP.GetSanitizedLongDescription(testProperty); // Explicitly bind to extension method.
+
+            Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
+        }
+
+        /// <summary>
+        /// Test that GetSanitizedLongDescription provides descriptions without uncommented lines of text for PHP.
+        /// </summary>
+        [TestMethod]
+        public void Description_Doesnt_Contain_Uncommented_NewLine_For_PHP()
+        {
+            testProperty.Description = actualInputString;
+            string sanitizedString = TypeHelperPHP.GetSanitizedLongDescription(testProperty);
+
+            Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
+        }
+    }
+}

README.md

@@ -109,7 +109,11 @@ and optionally :
 
 Example :
 
-` { "Template": "EntityType", "SubProcessor": "EntityType", "Type": "Model", "Name": "<Class>", "Matches" : "includeThisType", "Exclude" : "ExcludedTypeName;OtherExcludedTypeName" }`
+` { "Template": "EntityCollectionPage", "SubProcessor": "NavigationCollectionProperty", "Type": "Request", "Name": "<Class><Property>CollectionPage", "Matches" : "includeThisType", "Exclude" : "ExcludedTypeName;OtherExcludedTypeName" }`
+
+It is important to understand that subprocessors are mapped to methods that query the **OdcmModel** and return a set of OData objects. This mapping is maintained in [TemplateProcess.InitializeSubprocessor()](https://github.com/microsoftgraph/MSGraph-SDK-Code-Generator/blob/dev/src/GraphODataTemplateWriter/TemplateProcessor/TemplateProcessor.cs#L54). The language specific mappings exist in the [config directory](https://github.com/microsoftgraph/MSGraph-SDK-Code-Generator/tree/dev/src/GraphODataTemplateWriter/.config). Each OData object returned by the subprocessor is applied to the mapped template which results in a code file output per each OData object.
+
+In the above example, the objects in result set of the NavigationCollectionProperty subprocessor will each be applied to the EntityCollectionPage template. Each result will be a code file for each object returned by the NavigationCollectionProperty subprocessor. 
 
 #### SubProcessors
 

Templates/CSharp/Base/EntityRequest.Base.template.tt

@@ -350,7 +350,9 @@ public void AppendUpdateAsyncHeader(string entityName, string lowerCaseEntityNam
     {
         stringBuilder.Append(Environment.NewLine);
         stringBuilder.Append("        /// <param name=\"cancellationToken\">The <see cref=\"CancellationToken\"/> for the request.</param>");
-    }
+        stringBuilder.Append(Environment.NewLine);
+        stringBuilder.Append("        /// <exception cref=\"ClientException\">Thrown when an object returned in a response is used for updating an object in Microsoft Graph.</exception>");
+	}
 
     stringBuilder.Append(Environment.NewLine);
     stringBuilder.AppendFormat("        /// <returns>The updated {0}.</returns>", entityName);
@@ -390,6 +392,58 @@ public string GetEntityUpdateAsyncMethod(OdcmClass odcmClass, bool initializeCol
     stringBuilder.AppendFormat("        public async System.Threading.Tasks.Task<{0}> UpdateAsync({0} {1}ToUpdate, CancellationToken cancellationToken)", entityName, lowerCaseEntityName);
     stringBuilder.Append(Environment.NewLine);
     stringBuilder.Append("        {");
+	stringBuilder.Append(Environment.NewLine);
+	stringBuilder.AppendFormat("			if ({0}ToUpdate.AdditionalData != null)", lowerCaseEntityName);
+	stringBuilder.Append(Environment.NewLine);
+	stringBuilder.Append("			{");
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.AppendFormat("				if ({0}ToUpdate.AdditionalData.ContainsKey(Constants.HttpPropertyNames.ResponseHeaders) ||", lowerCaseEntityName);       
+    stringBuilder.Append(Environment.NewLine);           
+    stringBuilder.AppendFormat("					{0}ToUpdate.AdditionalData.ContainsKey(Constants.HttpPropertyNames.StatusCode))", lowerCaseEntityName);          
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("				{");         
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("					throw new ClientException(");                
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("						new Error");                  
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("						{");                    
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("							Code = GeneratedErrorConstants.Codes.NotAllowed,");                        
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.AppendFormat("							Message = String.Format(GeneratedErrorConstants.Messages.ResponseObjectUsedForUpdate, {0}ToUpdate.GetType().Name)", lowerCaseEntityName);                        
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("						});");                   
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("				}");   
+	stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("			}");	
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.AppendFormat("            if ({0}ToUpdate.AdditionalData != null)", lowerCaseEntityName);
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("            {");
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.AppendFormat("                if ({0}ToUpdate.AdditionalData.ContainsKey(Constants.HttpPropertyNames.ResponseHeaders) ||", lowerCaseEntityName);
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.AppendFormat("                    {0}ToUpdate.AdditionalData.ContainsKey(Constants.HttpPropertyNames.StatusCode))", lowerCaseEntityName);
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("                {");
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("                    throw new ClientException(");
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("                        new Error");
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("                        {");
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("                            Code = GeneratedErrorConstants.Codes.NotAllowed,");
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.AppendFormat("                            Message = String.Format(GeneratedErrorConstants.Messages.ResponseObjectUsedForUpdate, {0}ToUpdate.GetType().Name)", lowerCaseEntityName);
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("                        });");
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("                }");
+    stringBuilder.Append(Environment.NewLine);
+    stringBuilder.Append("            }");	
     stringBuilder.Append(Environment.NewLine);
     stringBuilder.AppendFormat("            this.ContentType = \"{0}\";", templateWriter.jsonContentType);
     stringBuilder.Append(Environment.NewLine);

Templates/CSharp/Base/IEntityRequest.Base.template.tt

@@ -274,6 +274,8 @@ public void AppendUpdateAsyncMethodHeader(string entityName, string lowerCaseEnt
     {
         stringBuilder.Append(Environment.NewLine);
         stringBuilder.Append("        /// <param name=\"cancellationToken\">The <see cref=\"CancellationToken\"/> for the request.</param>");
+        stringBuilder.Append(Environment.NewLine);
+        stringBuilder.Append("        /// <exception cref=\"ClientException\">Thrown when an object returned in a response is used for updating an object in Microsoft Graph.</exception>");
     }
 
     stringBuilder.Append(Environment.NewLine);

Templates/CSharp/Base/IRequestBuilder.Base.template.tt

@@ -40,7 +40,7 @@ public string GetInterfaceDefinition(string interfaceName)
     stringBuilder.Append(Environment.NewLine);
     stringBuilder.Append("    /// </summary>");
     stringBuilder.Append(Environment.NewLine);
-    stringBuilder.AppendFormat("    public partial interface I{0}", interfaceName);
+    stringBuilder.AppendFormat("    public partial interface I{0} : IBaseRequestBuilder", interfaceName);
 
     return stringBuilder.ToString();
 }

Templates/CSharp/Base/SharedCSharp.template.tt

@@ -11,6 +11,7 @@ bool logTemplateSrc = true;
 <#=writer.WriteHeader()#>
 
 // **NOTE** This file was generated by a tool and any changes will be overwritten.
+// <auto-generated/>
 
 <# if (logTemplateSrc) { #>
 // Template Source: <#= TemplateName(host.TemplateFile) #>

Templates/CSharp/Model/ComplexType.cs.tt

@@ -48,10 +48,14 @@ namespace <#=complex.Namespace.GetNamespaceName()#>
 // to disambiguate the type of the descendant class being sent. 
 if (complex.IsBaseAbstractAndReferencedAsPropertyType() && !complex.IsAbstract)
 {
-#>        public <#=complexTypeName#>()
+#>        /// <summary>
+        /// Initializes a new instance of the <see cref="<#=complexTypeName#>"/> class.
+        /// </summary>
+        public <#=complexTypeName#>()
         {
             this.ODataType = "<#=complex.FullName#>";
-        }<#
+        }
+<#
 }
         foreach(var property in complex.Properties)
         {

Templates/CSharp/Model/EnumType.cs.tt

@@ -30,7 +30,7 @@ namespace <#=enumT.Namespace.GetNamespaceName()#>
     #>
 
         /// <summary>
-        /// <#=emumMember.Name.SplitCamelCase()#>
+        /// <#=emumMember.Name.ToUpperFirstChar().SplitCamelCase()#>
         /// </summary>
         <#=emumMember.Name.ToCheckedCase().GetSanitizedPropertyName()#> = <#=emumMember.Value#>,
 	<#

Templates/PHP/Model/EnumType.php.tt

@@ -42,7 +42,7 @@ class <#=enumT.Name.ToUpperFirstChar()#> extends Enum
 <#
 		} else {
 #>
-    const <#= value.Name.ToUnderscore().ToUpper()#> = "<#= value.Name.ToCamelize()#>";
+    const <#= value.Name.ToUnderscorePHPEnum().ToUpper()#> = "<#= value.Name.ToCamelize()#>";
 <#		}
 	count++;
     }

Templates/TypeScript/src/entity_types.ts.tt

@@ -10,16 +10,16 @@
     var enumTypes               = model.GetEnumTypes();
     var complexTypes            = model.GetComplexTypes();
 #>
-// Type definitions for the Microsoft Graph API
+// Type definitions for the Microsoft Graph <VERSION_STRING>
 // Project: https://github.com/microsoftgraph/msgraph-typescript-typings
 // Definitions by: Microsoft Graph Team <https://github.com/microsoftgraph>
-
-<#= writer.WriteHeader() #>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.1
 
 export as namespace microsoftgraph;
 
 <# foreach(var enumType in enumTypes) { #>
-export type <#= enumType.Name.UpperCaseFirstChar() #> = <#= enumType.GetEnumValues() #>
+export type <#= enumType.Name.UpperCaseFirstChar() #> = <#= enumType.GetEnumValues() #>;
 <# } #>
 <#
   foreach(var entityType in entityTypes)
@@ -28,13 +28,11 @@ export type <#= enumType.Name.UpperCaseFirstChar() #> = <#= enumType.GetEnumValu
 #>
 
 export interface <#= entityType.Name.UpperCaseFirstChar() #><# if (entityType.Base != null) { #> extends <#=  entityType.Base.Name.UpperCaseFirstChar() #><# }#> {
-
 <# foreach(var prop in entityType.Properties.ToList()) { #>
 	<# if (prop.LongDescription != null || prop.Description != null) { #>
     /** <#=prop.GetSanitizedLongDescription()#> */
 	<# } #>
-	<#=  prop.Name #>?: <#= prop.GetTypeString() #>
-
+	<#=  prop.Name #>?: <#= prop.GetTypeString() #>;
 <# } #>
 }
 <#
@@ -45,13 +43,11 @@ export interface <#= entityType.Name.UpperCaseFirstChar() #><# if (entityType.Ba
   {
 #>
 export interface <#= complexType.Name.UpperCaseFirstChar()#><# if (complexType.Base != null) { #> extends <#=  complexType.Base.Name.UpperCaseFirstChar() #><# }#> {
-
 <# foreach(var prop in complexType.Properties) { #>
 	<# if (prop.LongDescription != null || prop.Description != null) { #>
     /** <#=prop.GetSanitizedLongDescription()#> */
 	<# } #>
-	<#= prop.Name #>?: <#= prop.GetTypeString() #>
-
+	<#= prop.Name #>?: <#= prop.GetTypeString() #>;
 <# } #>
 }
 <# } #>

src/GraphODataTemplateWriter/.config/ObjCSettings.json

@@ -1,21 +1,51 @@
 {
-    "StaticCodePrefix": "MS",
-    "TemplateMapping": {
-        "Shared": [
-          {
-            "_Comment" : "HACK: It seems the entire 'Shared' section is copy pasted from TemplateWriterSettings.json",
-            "_Comment2" : "with the sole purpose of preventing the Client from being named 'MSGraphGraphServiceClient'.",
-            "Template": "EntityClient", "SubProcessor": "EntityContainer", "Type": "Client", "Name": "Client"
-          },
+  "StaticCodePrefix": "MS",
+  "NamespacePrefix": "MSGraph",
+  "TemplateMapping": {
+    "Shared": [
+      {
+        "_Comment": "HACK: It seems the entire 'Shared' section is copy pasted from TemplateWriterSettings.json",
+        "_Comment2": "with the sole purpose of preventing the Client from being named 'MSGraphGraphServiceClient'.",
+        "Template": "EntityClient",
+        "SubProcessor": "EntityContainer",
+        "Type": "Client",
+        "Name": "Client"
+      },
 
-            { "Template": "EntityType", "SubProcessor": "EntityType", "Type": "Model", "Name": "<Class>" },
-            { "Template": "ComplexType", "SubProcessor": "ComplexType", "Type": "Model", "Name": "<Class>", "Ignore": "methodResponse" },
-            { "Template": "EnumType", "SubProcessor": "EnumType", "Type": "Model", "Name": "<Class>" }
-        ],
+      {
+        "Template": "EntityType",
+        "SubProcessor": "EntityType",
+        "Type": "Model",
+        "Name": "<Class>"
+      },
+      {
+        "Template": "ComplexType",
+        "SubProcessor": "ComplexType",
+        "Type": "Model",
+        "Name": "<Class>",
+        "Ignore": "methodResponse"
+      },
+      {
+        "Template": "EnumType",
+        "SubProcessor": "EnumType",
+        "Type": "Model",
+        "Name": "<Class>"
+      }
+    ],
 
-        "ObjC": [
-            { "Template": "ClientModels", "SubProcessor": "Other", "Type": "Model", "Name": "ClientModels" },
-            { "Template": "ODataEntities", "SubProcessor": "Other", "Type": "Model", "Name": "ODataEntities" }
-        ]
-    }
+    "ObjC": [
+      {
+        "Template": "ClientModels",
+        "SubProcessor": "Other",
+        "Type": "Model",
+        "Name": "ClientModels"
+      },
+      {
+        "Template": "ODataEntities",
+        "SubProcessor": "Other",
+        "Type": "Model",
+        "Name": "ODataEntities"
+      }
+    ]
+  }
 }

src/GraphODataTemplateWriter/CodeHelpers/CSharp/TypeHelperCSharp.cs

@@ -217,7 +217,10 @@ public static string GetSanitizedLongDescription(this OdcmProperty property)
 
             if (description != null)
             {
-                return description.Replace("<", "&lt;").Replace(">", "&gt;").Replace("&", "&amp;");
+                return description.Replace("<", "&lt;")
+                                  .Replace(">", "&gt;")
+                                  .Replace("&", "&amp;")
+                                  .Replace("\r\n", "\r\n///"); // &#xD;&#xA; The HTML encoded has already been converted to escaped chars.
             }
             return null;
         }

src/GraphODataTemplateWriter/CodeHelpers/PHP/TypeHelperPHP.cs

@@ -43,7 +43,10 @@ public static string GetSanitizedLongDescription(this OdcmProperty property)
 
             if (description != null)
             {
-                return description.Replace("<", "&lt;").Replace(">", "&gt;").Replace("&", "&amp;");
+                return description.Replace("<", "&lt;")
+                                  .Replace(">", "&gt;")
+                                  .Replace("&", "&amp;")
+                                  .Replace("\r\n", "\r\n///"); // &#xD;&#xA; The HTML encoded has already been converted to escaped chars.
             }
             return null;
         }