Merged upstream changes

Author: garethj-msft

9-22-16-staging-v1_noannots.xml

@@ -30,4 +30,4 @@ Global
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
-EndGlobal
+EndGlobal

GraphODataTemplateWriter.sln

@@ -7,17 +7,16 @@ Source code writers for [VIPR][vipr-source-repo] utilizing T4 templates. The Gra
 Currently the following target languages are supported by this writer:
 - Android
 - CSharp
-- JavaScript
 - Objective-C
 - Python
+- TypeScript
 
 # Contents
-- [Prerequisites](#Prerequisites)
-- [Getting started](#Getting-started)
-- [Using Vipr with this writer](#Using-Vipr-with-this-Writer)
-- [Using generated code](#Using-generated-code)
-- [Contributing](#Contributing)
-- [License](#License)
+- [Prerequisites](#prerequisites)
+- [Getting started](#getting-started)
+- [Using Vipr with this writer](#using-vipr-with-this-writer)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Prerequisites
 - [Visual Studio SDK](https://www.microsoft.com/en-us/download/details.aspx?id=40758)
@@ -36,16 +35,16 @@ For more information on submodules read [this chapter](http://git-scm.com/book/e
 ## Using Vipr with this Writer
 
 1. Build the solution in Visual Studio.
-2. Go to the `src\T4TemplateWriter\bin\debug` folder to find all compiled components.
+2. Go to the `src\GraphODataTemplateWriter\bin\debug` folder to find all compiled components.
 3. In that folder, modify `.config\TemplateWriterSettings.json` to specify your template mapping see [Template Writer Settings](##Template-Writer-Settings) for more details.
-4. Open a command prompt as administrator in the same folder and run `Vipr.exe <path-or-url-to-metadata> --writer="Graph.ODataTemplateWriter"`
+4. Open a command prompt as administrator in the same folder and run `Vipr.exe <path-or-url-to-metadata> --writer="GraphODataTemplateWriter"`.  An example metadata file can be found in the root of this project.
 
 By default, output source code will be put in a folder named "output" next to the Vipr executable.
 
 ## Template Writer Settings
 ### Available Languages
 
-There are four languages to choose from at the moment.  Java, ObjC, CSharp, and Python.  Specify which language you want to generate in the `TargetLanguage` setting.
+There are five languages to choose from at the moment.  Java, ObjC, CSharp, TypeScript and Python.  Specify which language you want to generate in the `TargetLanguage` setting.
 
 ### Templates
 You must specify a template directory under the `TemplatesDirectory` Settings.  The directory can be a full path or relative to the running directory.  The directory must contain a sub directory for each platform you want to generate code for. See the Templates directory for an example.

README.md

@@ -5,16 +5,48 @@
     CustomT4Host host          = (CustomT4Host) Host;
     var model                  = host.CurrentModel;
     CodeWriterAndroid writer   = (CodeWriterAndroid) host.CodeWriter;
+    bool logTemplateSrc        = false;
     var c = host.CurrentType;
+#>
+<# if (logTemplateSrc) { #>
+// Template Source: <#= TemplateName(host.TemplateFile) #>
+<# } #>
+<#+
 
-    if (c == null)
-    {
-//        throw new InvalidOperationException("Unable to get the current type!");
+    /// Is this request type a post?
+    public bool IsPostRequestType(OdcmMethod method) {
+        return method.IsAction()
+            && null != method.Parameters
+            && method.Parameters.Any();
+    }
+
+    /// Choose an intermediate class type based on GETs/POSTs
+    public string RequestBuilderSuperClass(OdcmObject currentType) {
+        var isPostAction =
+            IsPostRequestType(
+                currentType.AsOdcmMethod()
+            );
+
+        string superClass;
+
+        if (isPostAction) {
+            superClass = "BasePostMethodRequestBuilder";
+        } else {
+            superClass = "BaseGetMethodRequestBuilder";
+        }
+
+        return superClass;
+    }
+
+    /// <summary>
+    /// Get the name of the current template being processed
+    /// </summary>
+    /// <param name="templateFile">The full path of the current template</param>
+    /// <returns>The template name, relative to the Templates directory.</returns>
+    public string TemplateName(string templateFile) {
+        return templateFile.Substring(templateFile.LastIndexOf("Templates"));
     }
 
-#>
-<# //="// Template Source: '" + host.TemplateFile + "', Name: '" + c.Name + "' , TypeName: '" + TypeName(c) + "'"#>
-<#+
     public string TypeName(OdcmObject c) {
         if (c is OdcmMethod) {
             return ((OdcmMethod)c).Class.Name.ToUpperFirstChar() + c.Name.Substring(c.Name.IndexOf(".") + 1).ToUpperFirstChar();
@@ -331,14 +363,18 @@
         return "Base" + TypeBody(c);
     }
 
+    /// Creates an 'm' prepended name for a field
+    /// based on its name as defined by the service $metadata
     public string FieldName(OdcmParameter c) {
         return "m" + ParamName(c).ToUpperFirstChar();
     }
 
+    /// Returns the name of the service <parameter> with the first char lowercase
     public string ParamName(OdcmParameter c) {
         return c.Name.ToLowerFirstChar();
     }
 
+    /// The Type of this param, as a string
     public string ParamType(OdcmParameter c) {
         if (c.IsCollection){
             return String.Format("List<{0}>", c.Type.GetTypeString());
@@ -352,19 +388,19 @@
         }
         return "Void";
     }
-
-    public string MethodParametersSignature(OdcmObject c) {
+    
+    public string MethodParametersSignature(OdcmMethod method) {
         var parameterSignatureBuilder = new StringBuilder();
-        foreach (var p in c.AsOdcmMethod().Parameters)
+        foreach (var p in method.Parameters)
         {
             parameterSignatureBuilder.AppendFormat(", final {0} {1}", ParamType(p), ParamName(p));
         }
         return parameterSignatureBuilder.ToString();
     }
 
-    public string MethodParametersValues(OdcmObject c) {
+    public string MethodParametersValues(OdcmMethod method) {
         var parameterValuesBuilder = new StringBuilder();
-        foreach (var p in c.AsOdcmMethod().Parameters)
+        foreach (var p in method.Parameters)
         {
             parameterValuesBuilder.AppendFormat(", {0}", ParamName(p));
         }
@@ -437,9 +473,15 @@
         return null;
     }
 
+    public string OdcmMethodReturnType(OdcmMethod method) {
+        return method.ReturnType is OdcmPrimitiveType
+            ? method.ReturnType.GetTypeString() : method.ReturnType.Name.ToCheckedCase();
+    }
+
     public string CollectionPageGeneric(OdcmObject c) {
         if (c is OdcmMethod) {
-            return "<" + ClassTypeName(c) + ", " + ITypeCollectionRequestBuilder(c) + ">";
+            string returnType = OdcmMethodReturnType(c as OdcmMethod);
+            return "<" + returnType + ", " + ITypeCollectionRequestBuilder(c) + ">";
         }
         return "<" + TypeName(c) + ", " + ITypeCollectionRequestBuilder(c) + ">";
     }
@@ -477,6 +519,10 @@ import java.util.List;";
             host.TemplateInfo.OutputParentDirectory);
         }
 
+    /// Creates a class declaration
+    /// name = the name of the class
+    /// extends = the class it extends
+    /// implements = the interface it extends
     public string CreateClassDef(string name, string extends = null, string implements = null)
     {
         return this.CreateClassOrInterface(name, true, extends, implements);
@@ -631,12 +677,13 @@ public {1} {2}{3}{4} {{";
 ";
         foreach (var p in parameters)
         {
-            var propertyType = p.IsCollection ? string.Format("List<{0}>", ParamType(p)) : ParamType(p);
-                sb.AppendFormat(format,
+            sb.AppendFormat(
+                format,
                 ParamName(p).SplitCamelCase(),
                 ParamName(p),
                 ParamType(p),
-                p.SanitizePropertyName().ToLowerFirstChar());
+                p.SanitizePropertyName().ToLowerFirstChar()
+            );
         }
         return sb.ToString();
     }

Templates/Android/BaseModel.template.tt

@@ -16,5 +16,4 @@
     public <#=TypeCollectionPage(c)#>(final <#=BaseTypeCollectionResponse(c)#> response, final <#=ITypeCollectionRequestBuilder(c)#> builder) {
         super(response, builder);
     }
-
 }

Templates/Android/extensions/EntityCollectionPage.java.tt

@@ -16,5 +16,4 @@
     public <#=TypeCollectionWithReferencesPage(c)#>(final <#=BaseTypeCollectionResponse(c)#> response, final <#=ITypeCollectionWithReferencesRequestBuilder(c)#> builder) {
         super(response, builder);
     }
-
 }

Templates/Android/extensions/EntityCollectionWithReferencesPage.java.tt

@@ -18,4 +18,4 @@
     public <#=TypeReferenceRequestBuilder(c)#>(final String requestUrl, final <#=IBaseClientType()#> client, final List<Option> options) {
         super(requestUrl, client, options);
     }
- }
+}

Templates/Android/extensions/EntityReferenceRequestBuilder.java.tt

@@ -18,4 +18,4 @@
     public <#=TypeRequestBuilder(c)#>(final String requestUrl, final <#=IBaseClientType()#> client, final List<Option> options) {
         super(requestUrl, client, options);
     }
- }
+}

Templates/Android/extensions/EntityRequestBuilder.java.tt

@@ -18,4 +18,4 @@
     public <#=TypeStreamRequestBuilder(c)#>(final String requestUrl, final <#=IBaseClientType()#> client, final List<Option> options) {
         super(requestUrl, client, options);
     }
- }
+}

Templates/Android/extensions/EntityStreamRequestBuilder.java.tt

@@ -18,4 +18,4 @@
     public <#=TypeWithReferencesRequestBuilder(c)#>(final String requestUrl, final <#=IBaseClientType()#> client, final List<Option> options) {
         super(requestUrl, client, options);
     }
- }
+}