Skip to content

Commit 86a1e7c

Browse files
MIchaelMainerMIchaelMainer
authored
Merge dev into master (#206)
* Add NamespacePrefix that's used as the class name prefix for generating ObjC models. * Added preprocessors for nav properties * Support updating the default base Graph URL via the endpointVersion argument. * add rule to add containsTarget=true to labelPolicy navigation * Convert edm.Decimal to number * Handle CRLF in doc annotations as code comments. * Updated request builder interfaces to inherit from common interface * Added IBaseRequestBuilder to consumers of IRequestBuilder.Base * Applied <auto-generated/> comment tag to all generated c# files. * Added comments to all complex types class definitions. * Fix for enum naming for camelcased+underscore scenario (#194) * Fix duplicate PHP enum name generation * Add back camelcase-ization to limit the changes. * Added preprocess rule for new intune navigation (#195) * Updating EntityRequest.Base.template with code fix for response headers issue (#202) * Updating template with response headers fix. * New changes will propagate the fix for having response headers and status codes in request objects when UpdateAsync method is called in entities * Adding the exception documentation in IEntityRequest.Base * Refactoring in EntityRequest.Base to include this if includeSendParams == true so that it shows in the async UpdateAsync() method. * Fixed spacing indentation (#204) * New changes will propagate the fix for having response headers and status codes in request objects when UpdateAsync method is called in entities * Adding exception description to documentation * Adding and refactoring exception documentation * Adding the exception documentation in IEntityRequest.Base * Refactoring in EntityRequest.Base to include this if includeSendParams == true so that it shows in the async UpdateAsync() method. * Space Indentation Fixes * Fixed bugs for publishing in definitely typed repo (#203) * Add contains target for new entities. (#205)
1 parent df5eb92 commit 86a1e7c

File tree

21 files changed

+357
-42
lines changed

21 files changed

+357
-42
lines changed

‎GraphODataTemplateWriter.Test/TypeHelperTests.cs‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
using Microsoft.Graph.ODataTemplateWriter.CodeHelpers.CSharp;
2+
using Microsoft.Graph.ODataTemplateWriter.CodeHelpers.TypeScript;
3+
using Microsoft.Graph.ODataTemplateWriter.CodeHelpers.PHP;
4+
using Microsoft.VisualStudio.TestTools.UnitTesting;
5+
using Vipr.Core.CodeModel;
6+
7+
8+
namespace GraphODataTemplateWriter.Test
9+
{
10+
[TestClass]
11+
public class TypeHelperTests
12+
{
13+
OdcmProperty testProperty;
14+
string actualInputString = "\r\n Test string";
15+
string expectedOutputString = "\r\n/// Test string";
16+
17+
[TestInitialize]
18+
public void Initialize()
19+
{
20+
testProperty = new OdcmProperty("testPropertyName");
21+
}
22+
23+
/// <summary>
24+
/// Test that GetSanitizedLongDescription provides long descriptions without uncommented lines of text.
25+
/// </summary>
26+
[TestMethod]
27+
public void Long_Description_Doesnt_Contain_Uncommented_NewLine_For_CSharp()
28+
{
29+
testProperty.LongDescription = actualInputString;
30+
string sanitizedString = TypeHelperCSharp.GetSanitizedLongDescription(testProperty); // Explicitly bind to extension method.
31+
32+
Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
33+
}
34+
35+
/// <summary>
36+
/// Test that GetSanitizedLongDescription provides descriptions without uncommented lines of text.
37+
/// </summary>
38+
[TestMethod]
39+
public void Description_Doesnt_Contain_Uncommented_NewLine_For_CSharp()
40+
{
41+
testProperty.Description = actualInputString;
42+
string sanitizedString = TypeHelperCSharp.GetSanitizedLongDescription(testProperty);
43+
44+
Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
45+
}
46+
47+
/// <summary>
48+
/// Test that GetSanitizedLongDescription provides long descriptions without uncommented lines of text for Typescript.
49+
/// </summary>
50+
[TestMethod]
51+
public void Long_Description_Doesnt_Contain_Uncommented_NewLine_For_Typescript()
52+
{
53+
testProperty.LongDescription = actualInputString;
54+
string sanitizedString = TypeHelperTypeScript.GetSanitizedLongDescription(testProperty); // Explicitly bind to extension method.
55+
56+
Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
57+
}
58+
59+
/// <summary>
60+
/// Test that GetSanitizedLongDescription provides descriptions without uncommented lines of text for Typescript.
61+
/// </summary>
62+
[TestMethod]
63+
public void Description_Doesnt_Contain_Uncommented_NewLine_For_Typescript()
64+
{
65+
testProperty.Description = actualInputString;
66+
string sanitizedString = TypeHelperTypeScript.GetSanitizedLongDescription(testProperty);
67+
68+
Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
69+
}
70+
71+
/// <summary>
72+
/// Test that GetSanitizedLongDescription provides long descriptions without uncommented lines of text for PHP.
73+
/// </summary>
74+
[TestMethod]
75+
public void Long_Description_Doesnt_Contain_Uncommented_NewLine_For_PHP()
76+
{
77+
testProperty.LongDescription = actualInputString;
78+
string sanitizedString = TypeHelperPHP.GetSanitizedLongDescription(testProperty); // Explicitly bind to extension method.
79+
80+
Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
81+
}
82+
83+
/// <summary>
84+
/// Test that GetSanitizedLongDescription provides descriptions without uncommented lines of text for PHP.
85+
/// </summary>
86+
[TestMethod]
87+
public void Description_Doesnt_Contain_Uncommented_NewLine_For_PHP()
88+
{
89+
testProperty.Description = actualInputString;
90+
string sanitizedString = TypeHelperPHP.GetSanitizedLongDescription(testProperty);
91+
92+
Assert.AreEqual(expectedOutputString, sanitizedString, "GetSanitizedLongDescription is not handling escaped CRLF.");
93+
}
94+
}
95+
}

‎README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,11 @@ and optionally :
109109

110110
Example :
111111

112-
` { "Template": "EntityType", "SubProcessor": "EntityType", "Type": "Model", "Name": "<Class>", "Matches" : "includeThisType", "Exclude" : "ExcludedTypeName;OtherExcludedTypeName" }`
112+
` { "Template": "EntityCollectionPage", "SubProcessor": "NavigationCollectionProperty", "Type": "Request", "Name": "<Class><Property>CollectionPage", "Matches" : "includeThisType", "Exclude" : "ExcludedTypeName;OtherExcludedTypeName" }`
113+
114+
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.
115+
116+
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.
113117

114118
#### SubProcessors
115119

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

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,9 @@ public void AppendUpdateAsyncHeader(string entityName, string lowerCaseEntityNam
350350
{
351351
stringBuilder.Append(Environment.NewLine);
352352
stringBuilder.Append(" /// <param name=\"cancellationToken\">The <see cref=\"CancellationToken\"/> for the request.</param>");
353-
}
353+
stringBuilder.Append(Environment.NewLine);
354+
stringBuilder.Append(" /// <exception cref=\"ClientException\">Thrown when an object returned in a response is used for updating an object in Microsoft Graph.</exception>");
355+
}
354356

355357
stringBuilder.Append(Environment.NewLine);
356358
stringBuilder.AppendFormat(" /// <returns>The updated {0}.</returns>", entityName);
@@ -390,6 +392,58 @@ public string GetEntityUpdateAsyncMethod(OdcmClass odcmClass, bool initializeCol
390392
stringBuilder.AppendFormat(" public async System.Threading.Tasks.Task<{0}> UpdateAsync({0} {1}ToUpdate, CancellationToken cancellationToken)", entityName, lowerCaseEntityName);
391393
stringBuilder.Append(Environment.NewLine);
392394
stringBuilder.Append(" {");
395+
stringBuilder.Append(Environment.NewLine);
396+
stringBuilder.AppendFormat(" if ({0}ToUpdate.AdditionalData != null)", lowerCaseEntityName);
397+
stringBuilder.Append(Environment.NewLine);
398+
stringBuilder.Append(" {");
399+
stringBuilder.Append(Environment.NewLine);
400+
stringBuilder.AppendFormat(" if ({0}ToUpdate.AdditionalData.ContainsKey(Constants.HttpPropertyNames.ResponseHeaders) ||", lowerCaseEntityName);
401+
stringBuilder.Append(Environment.NewLine);
402+
stringBuilder.AppendFormat(" {0}ToUpdate.AdditionalData.ContainsKey(Constants.HttpPropertyNames.StatusCode))", lowerCaseEntityName);
403+
stringBuilder.Append(Environment.NewLine);
404+
stringBuilder.Append(" {");
405+
stringBuilder.Append(Environment.NewLine);
406+
stringBuilder.Append(" throw new ClientException(");
407+
stringBuilder.Append(Environment.NewLine);
408+
stringBuilder.Append(" new Error");
409+
stringBuilder.Append(Environment.NewLine);
410+
stringBuilder.Append(" {");
411+
stringBuilder.Append(Environment.NewLine);
412+
stringBuilder.Append(" Code = GeneratedErrorConstants.Codes.NotAllowed,");
413+
stringBuilder.Append(Environment.NewLine);
414+
stringBuilder.AppendFormat(" Message = String.Format(GeneratedErrorConstants.Messages.ResponseObjectUsedForUpdate, {0}ToUpdate.GetType().Name)", lowerCaseEntityName);
415+
stringBuilder.Append(Environment.NewLine);
416+
stringBuilder.Append(" });");
417+
stringBuilder.Append(Environment.NewLine);
418+
stringBuilder.Append(" }");
419+
stringBuilder.Append(Environment.NewLine);
420+
stringBuilder.Append(" }");
421+
stringBuilder.Append(Environment.NewLine);
422+
stringBuilder.AppendFormat(" if ({0}ToUpdate.AdditionalData != null)", lowerCaseEntityName);
423+
stringBuilder.Append(Environment.NewLine);
424+
stringBuilder.Append(" {");
425+
stringBuilder.Append(Environment.NewLine);
426+
stringBuilder.AppendFormat(" if ({0}ToUpdate.AdditionalData.ContainsKey(Constants.HttpPropertyNames.ResponseHeaders) ||", lowerCaseEntityName);
427+
stringBuilder.Append(Environment.NewLine);
428+
stringBuilder.AppendFormat(" {0}ToUpdate.AdditionalData.ContainsKey(Constants.HttpPropertyNames.StatusCode))", lowerCaseEntityName);
429+
stringBuilder.Append(Environment.NewLine);
430+
stringBuilder.Append(" {");
431+
stringBuilder.Append(Environment.NewLine);
432+
stringBuilder.Append(" throw new ClientException(");
433+
stringBuilder.Append(Environment.NewLine);
434+
stringBuilder.Append(" new Error");
435+
stringBuilder.Append(Environment.NewLine);
436+
stringBuilder.Append(" {");
437+
stringBuilder.Append(Environment.NewLine);
438+
stringBuilder.Append(" Code = GeneratedErrorConstants.Codes.NotAllowed,");
439+
stringBuilder.Append(Environment.NewLine);
440+
stringBuilder.AppendFormat(" Message = String.Format(GeneratedErrorConstants.Messages.ResponseObjectUsedForUpdate, {0}ToUpdate.GetType().Name)", lowerCaseEntityName);
441+
stringBuilder.Append(Environment.NewLine);
442+
stringBuilder.Append(" });");
443+
stringBuilder.Append(Environment.NewLine);
444+
stringBuilder.Append(" }");
445+
stringBuilder.Append(Environment.NewLine);
446+
stringBuilder.Append(" }");
393447
stringBuilder.Append(Environment.NewLine);
394448
stringBuilder.AppendFormat(" this.ContentType = \"{0}\";", templateWriter.jsonContentType);
395449
stringBuilder.Append(Environment.NewLine);

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,8 @@ public void AppendUpdateAsyncMethodHeader(string entityName, string lowerCaseEnt
274274
{
275275
stringBuilder.Append(Environment.NewLine);
276276
stringBuilder.Append(" /// <param name=\"cancellationToken\">The <see cref=\"CancellationToken\"/> for the request.</param>");
277+
stringBuilder.Append(Environment.NewLine);
278+
stringBuilder.Append(" /// <exception cref=\"ClientException\">Thrown when an object returned in a response is used for updating an object in Microsoft Graph.</exception>");
277279
}
278280

279281
stringBuilder.Append(Environment.NewLine);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public string GetInterfaceDefinition(string interfaceName)
4040
stringBuilder.Append(Environment.NewLine);
4141
stringBuilder.Append(" /// </summary>");
4242
stringBuilder.Append(Environment.NewLine);
43-
stringBuilder.AppendFormat(" public partial interface I{0}", interfaceName);
43+
stringBuilder.AppendFormat(" public partial interface I{0} : IBaseRequestBuilder", interfaceName);
4444

4545
return stringBuilder.ToString();
4646
}

‎Templates/CSharp/Base/SharedCSharp.template.tt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ bool logTemplateSrc = true;
1111
<#=writer.WriteHeader()#>
1212

1313
// **NOTE** This file was generated by a tool and any changes will be overwritten.
14+
// <auto-generated/>
1415

1516
<# if (logTemplateSrc) { #>
1617
// Template Source: <#= TemplateName(host.TemplateFile) #>

‎Templates/CSharp/Model/ComplexType.cs.tt‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,14 @@ namespace <#=complex.Namespace.GetNamespaceName()#>
4848
// to disambiguate the type of the descendant class being sent.
4949
if (complex.IsBaseAbstractAndReferencedAsPropertyType() && !complex.IsAbstract)
5050
{
51-
#> public <#=complexTypeName#>()
51+
#> /// <summary>
52+
/// Initializes a new instance of the <see cref="<#=complexTypeName#>"/> class.
53+
/// </summary>
54+
public <#=complexTypeName#>()
5255
{
5356
this.ODataType = "<#=complex.FullName#>";
54-
}<#
57+
}
58+
<#
5559
}
5660
foreach(var property in complex.Properties)
5761
{

‎Templates/CSharp/Model/EnumType.cs.tt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ namespace <#=enumT.Namespace.GetNamespaceName()#>
3030
#>
3131

3232
/// <summary>
33-
/// <#=emumMember.Name.SplitCamelCase()#>
33+
/// <#=emumMember.Name.ToUpperFirstChar().SplitCamelCase()#>
3434
/// </summary>
3535
<#=emumMember.Name.ToCheckedCase().GetSanitizedPropertyName()#> = <#=emumMember.Value#>,
3636
<#

‎Templates/PHP/Model/EnumType.php.tt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class <#=enumT.Name.ToUpperFirstChar()#> extends Enum
4242
<#
4343
} else {
4444
#>
45-
const <#= value.Name.ToUnderscore().ToUpper()#> = "<#= value.Name.ToCamelize()#>";
45+
const <#= value.Name.ToUnderscorePHPEnum().ToUpper()#> = "<#= value.Name.ToCamelize()#>";
4646
<# }
4747
count++;
4848
}

‎Templates/TypeScript/src/entity_types.ts.tt‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@
1010
var enumTypes = model.GetEnumTypes();
1111
var complexTypes = model.GetComplexTypes();
1212
#>
13-
// Type definitions for the Microsoft Graph API
13+
// Type definitions for the Microsoft Graph <VERSION_STRING>
1414
// Project: https://github.com/microsoftgraph/msgraph-typescript-typings
1515
// Definitions by: Microsoft Graph Team <https://github.com/microsoftgraph>
16-
17-
<#= writer.WriteHeader() #>
16+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
17+
// TypeScript Version: 2.1
1818

1919
export as namespace microsoftgraph;
2020

2121
<# foreach(var enumType in enumTypes) { #>
22-
export type <#= enumType.Name.UpperCaseFirstChar() #> = <#= enumType.GetEnumValues() #>
22+
export type <#= enumType.Name.UpperCaseFirstChar() #> = <#= enumType.GetEnumValues() #>;
2323
<# } #>
2424
<#
2525
foreach(var entityType in entityTypes)
@@ -28,13 +28,11 @@ export type <#= enumType.Name.UpperCaseFirstChar() #> = <#= enumType.GetEnumValu
2828
#>
2929

3030
export interface <#= entityType.Name.UpperCaseFirstChar() #><# if (entityType.Base != null) { #> extends <#= entityType.Base.Name.UpperCaseFirstChar() #><# }#> {
31-
3231
<# foreach(var prop in entityType.Properties.ToList()) { #>
3332
<# if (prop.LongDescription != null || prop.Description != null) { #>
3433
/** <#=prop.GetSanitizedLongDescription()#> */
3534
<# } #>
36-
<#= prop.Name #>?: <#= prop.GetTypeString() #>
37-
35+
<#= prop.Name #>?: <#= prop.GetTypeString() #>;
3836
<# } #>
3937
}
4038
<#
@@ -45,13 +43,11 @@ export interface <#= entityType.Name.UpperCaseFirstChar() #><# if (entityType.Ba
4543
{
4644
#>
4745
export interface <#= complexType.Name.UpperCaseFirstChar()#><# if (complexType.Base != null) { #> extends <#= complexType.Base.Name.UpperCaseFirstChar() #><# }#> {
48-
4946
<# foreach(var prop in complexType.Properties) { #>
5047
<# if (prop.LongDescription != null || prop.Description != null) { #>
5148
/** <#=prop.GetSanitizedLongDescription()#> */
5249
<# } #>
53-
<#= prop.Name #>?: <#= prop.GetTypeString() #>
54-
50+
<#= prop.Name #>?: <#= prop.GetTypeString() #>;
5551
<# } #>
5652
}
5753
<# } #>

0 commit comments

Comments
 (0)