Move GetName to DocumentationCommentExtensions

nbarbettini · nbarbettini · commit 62e06b121781 · 2016-02-06T11:19:39.000-08:00
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/DocumentationRules/SA1615SA1616CodeFixProvider.cs b/StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/DocumentationRules/SA1615SA1616CodeFixProvider.cs
@@ -79,7 +79,7 @@ private static async Task<Document> GetTransformedDocumentAsync(Document documen
                 documentationComment == null
                 || documentationComment.Content
                     .Where(x => x is XmlElementSyntax || x is XmlEmptyElementSyntax)
-                    .All(x => string.Equals(GetName(x)?.ToString(), XmlCommentHelper.IncludeXmlTag));
+                    .All(x => string.Equals(x.GetName()?.ToString(), XmlCommentHelper.IncludeXmlTag));
 
             if (canIgnoreDocumentation)
             {
@@ -230,12 +230,6 @@ private static bool IsAsynchronousTestMethod(SemanticModel semanticModel, Method
             return false;
         }
 
-        private static XmlNameSyntax GetName(XmlNodeSyntax element)
-        {
-            return (element as XmlElementSyntax)?.StartTag?.Name
-                ?? (element as XmlEmptyElementSyntax)?.Name;
-        }
-
         private static SyntaxTrivia GetLastDocumentationCommentExteriorTrivia(SyntaxNode node)
         {
             return node
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/ElementDocumentationBase.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/ElementDocumentationBase.cs
@@ -210,7 +210,7 @@ private void HandleDeclaration(SyntaxNodeAnalysisContext context, SyntaxNode nod
             IEnumerable<XmlNodeSyntax> matchingXmlElements = string.IsNullOrEmpty(this.matchElementName)
                 ? documentation.Content
                     .Where(x => x is XmlElementSyntax || x is XmlEmptyElementSyntax)
-                    .Where(x => !string.Equals(GetName(x)?.ToString(), XmlCommentHelper.IncludeXmlTag))
+                    .Where(x => !string.Equals(x.GetName()?.ToString(), XmlCommentHelper.IncludeXmlTag))
                 : documentation.Content.GetXmlElements(this.matchElementName);
 
             if (!matchingXmlElements.Any())
@@ -236,11 +236,5 @@ private void HandleDeclaration(SyntaxNodeAnalysisContext context, SyntaxNode nod
 
             this.HandleXmlElement(context, matchingXmlElements, locations);
         }
-
-        private static XmlNameSyntax GetName(XmlNodeSyntax element)
-        {
-            return (element as XmlElementSyntax)?.StartTag?.Name
-                ?? (element as XmlEmptyElementSyntax)?.Name;
-        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1613ElementParameterDocumentationMustDeclareParameterName.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1613ElementParameterDocumentationMustDeclareParameterName.cs
@@ -60,7 +60,7 @@ public SA1613ElementParameterDocumentationMustDeclareParameterName()
         protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, IEnumerable<XmlNodeSyntax> syntaxList, params Location[] diagnosticLocations)
         {
             var xmlParameterNames = syntaxList
-                .Where(x => string.Equals(GetName(x)?.ToString(), XmlCommentHelper.ParamXmlTag))
+                .Where(x => string.Equals(x.GetName()?.ToString(), XmlCommentHelper.ParamXmlTag))
                 .Select(x =>
                 {
                     var nameAttribute = XmlCommentHelper.GetFirstAttributeOrDefault<XmlNameAttributeSyntax>(x);
@@ -109,18 +109,5 @@ private static void VerifyParameters(SyntaxNodeAnalysisContext context, Immutabl
                 index++;
             }
         }
-
-        private static XmlNameSyntax GetName(XmlNodeSyntax element)
-        {
-            return (element as XmlElementSyntax)?.StartTag?.Name
-                ?? (element as XmlEmptyElementSyntax)?.Name;
-        }
-
-        private static SyntaxToken GetIdentifier(SyntaxNode node)
-        {
-            return (node as MethodDeclarationSyntax)?.Identifier
-                ?? (node as IndexerDeclarationSyntax)?.ThisKeyword
-                ?? (node as DelegateDeclarationSyntax).Identifier;
-        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1614ElementParameterDocumentationMustHaveText.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1614ElementParameterDocumentationMustHaveText.cs
@@ -56,7 +56,7 @@ public SA1614ElementParameterDocumentationMustHaveText()
         protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, IEnumerable<XmlNodeSyntax> syntaxList, params Location[] diagnosticLocations)
         {
             var xmlParameterNames = syntaxList
-                .Where(x => string.Equals(GetName(x)?.ToString(), XmlCommentHelper.ParamXmlTag))
+                .Where(x => string.Equals(x.GetName()?.ToString(), XmlCommentHelper.ParamXmlTag))
                 .Select(x =>
                 {
                     bool isEmpty = x is XmlEmptyElementSyntax || XmlCommentHelper.IsConsideredEmpty(x);
@@ -98,11 +98,5 @@ private static void VerifyParameters(SyntaxNodeAnalysisContext context, Immutabl
                 index++;
             }
         }
-
-        private static XmlNameSyntax GetName(XmlNodeSyntax element)
-        {
-            return (element as XmlElementSyntax)?.StartTag?.Name
-                ?? (element as XmlEmptyElementSyntax)?.Name;
-        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1620GenericTypeParameterDocumentationMustMatchTypeParameters.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1620GenericTypeParameterDocumentationMustMatchTypeParameters.cs
@@ -82,21 +82,15 @@ private static void HandleDocumentationTrivia(SyntaxNodeAnalysisContext context)
             ImmutableArray<string> parentTypeParameters = parentTypeParametersEnumerable.ToImmutableArray();
 
             ImmutableArray<XmlNodeSyntax> nodes = syntax.Content
-                .Where(node => string.Equals(GetName(node)?.ToString(), XmlCommentHelper.TypeParamXmlTag))
+                .Where(node => string.Equals(node.GetName()?.ToString(), XmlCommentHelper.TypeParamXmlTag))
                 .ToImmutableArray();
 
             for (int i = 0; i < nodes.Length; i++)
             {
-                HandleElement(context, nodes[i], parentTypeParameters, i, GetName(nodes[i])?.GetLocation());
+                HandleElement(context, nodes[i], parentTypeParameters, i, nodes[i]?.GetName()?.GetLocation());
             }
         }
 
-        private static XmlNameSyntax GetName(XmlNodeSyntax element)
-        {
-            return (element as XmlElementSyntax)?.StartTag?.Name
-                ?? (element as XmlEmptyElementSyntax)?.Name;
-        }
-
         private static void HandleElement(SyntaxNodeAnalysisContext context, XmlNodeSyntax element, ImmutableArray<string> parentTypeParameters, int index, Location alternativeDiagnosticLocation)
         {
             var nameAttribute = XmlCommentHelper.GetFirstAttributeOrDefault<XmlNameAttributeSyntax>(element);
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/DocumentationCommentExtensions.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/DocumentationCommentExtensions.cs
@@ -245,6 +245,12 @@ where token.HasTrailingTrivia
             return node.ReplaceTokens(replacements.Keys, (originalToken, rewrittenToken) => replacements[originalToken]);
         }
 
+        public static XmlNameSyntax GetName(this XmlNodeSyntax element)
+        {
+            return (element as XmlElementSyntax)?.StartTag?.Name
+                ?? (element as XmlEmptyElementSyntax)?.Name;
+        }
+
         private static SyntaxTrivia SelectExteriorTrivia(SyntaxTrivia rewrittenTrivia, SyntaxTrivia trivia, SyntaxTrivia triviaWithSpace)
         {
             // if the trivia had a trailing space, make sure to preserve it

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ private static async Task<Document> GetTransformedDocumentAsync(Document documen`
`79`	`79`	`documentationComment == null`
`80`	`80`	`\|\| documentationComment.Content`
`81`	`81`	`.Where(x => x is XmlElementSyntax \|\| x is XmlEmptyElementSyntax)`
`82`		`- .All(x => string.Equals(GetName(x)?.ToString(), XmlCommentHelper.IncludeXmlTag));`
	`82`	`+ .All(x => string.Equals(x.GetName()?.ToString(), XmlCommentHelper.IncludeXmlTag));`
`83`	`83`
`84`	`84`	`if (canIgnoreDocumentation)`
`85`	`85`	`{`
`@@ -230,12 +230,6 @@ private static bool IsAsynchronousTestMethod(SemanticModel semanticModel, Method`
`230`	`230`	`return false;`
`231`	`231`	`}`
`232`	`232`
`233`		`- private static XmlNameSyntax GetName(XmlNodeSyntax element)`
`234`		`- {`
`235`		`- return (element as XmlElementSyntax)?.StartTag?.Name`
`236`		`- ?? (element as XmlEmptyElementSyntax)?.Name;`
`237`		`- }`
`238`		`-`
`239`	`233`	`private static SyntaxTrivia GetLastDocumentationCommentExteriorTrivia(SyntaxNode node)`
`240`	`234`	`{`
`241`	`235`	`return node`
Original file line number	Diff line number	Diff line change
`@@ -210,7 +210,7 @@ private void HandleDeclaration(SyntaxNodeAnalysisContext context, SyntaxNode nod`
`210`	`210`	`IEnumerable<XmlNodeSyntax> matchingXmlElements = string.IsNullOrEmpty(this.matchElementName)`
`211`	`211`	`? documentation.Content`
`212`	`212`	`.Where(x => x is XmlElementSyntax \|\| x is XmlEmptyElementSyntax)`
`213`		`- .Where(x => !string.Equals(GetName(x)?.ToString(), XmlCommentHelper.IncludeXmlTag))`
	`213`	`+ .Where(x => !string.Equals(x.GetName()?.ToString(), XmlCommentHelper.IncludeXmlTag))`
`214`	`214`	`: documentation.Content.GetXmlElements(this.matchElementName);`
`215`	`215`
`216`	`216`	`if (!matchingXmlElements.Any())`
`@@ -236,11 +236,5 @@ private void HandleDeclaration(SyntaxNodeAnalysisContext context, SyntaxNode nod`
`236`	`236`
`237`	`237`	`this.HandleXmlElement(context, matchingXmlElements, locations);`
`238`	`238`	`}`
`239`		`-`
`240`		`- private static XmlNameSyntax GetName(XmlNodeSyntax element)`
`241`		`- {`
`242`		`- return (element as XmlElementSyntax)?.StartTag?.Name`
`243`		`- ?? (element as XmlEmptyElementSyntax)?.Name;`
`244`		`- }`
`245`	`239`	`}`
`246`	`240`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public SA1613ElementParameterDocumentationMustDeclareParameterName()`
`60`	`60`	`protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, IEnumerable<XmlNodeSyntax> syntaxList, params Location[] diagnosticLocations)`
`61`	`61`	`{`
`62`	`62`	`var xmlParameterNames = syntaxList`
`63`		`- .Where(x => string.Equals(GetName(x)?.ToString(), XmlCommentHelper.ParamXmlTag))`
	`63`	`+ .Where(x => string.Equals(x.GetName()?.ToString(), XmlCommentHelper.ParamXmlTag))`
`64`	`64`	`.Select(x =>`
`65`	`65`	`{`
`66`	`66`	`var nameAttribute = XmlCommentHelper.GetFirstAttributeOrDefault<XmlNameAttributeSyntax>(x);`
`@@ -109,18 +109,5 @@ private static void VerifyParameters(SyntaxNodeAnalysisContext context, Immutabl`
`109`	`109`	`index++;`
`110`	`110`	`}`
`111`	`111`	`}`
`112`		`-`
`113`		`- private static XmlNameSyntax GetName(XmlNodeSyntax element)`
`114`		`- {`
`115`		`- return (element as XmlElementSyntax)?.StartTag?.Name`
`116`		`- ?? (element as XmlEmptyElementSyntax)?.Name;`
`117`		`- }`
`118`		`-`
`119`		`- private static SyntaxToken GetIdentifier(SyntaxNode node)`
`120`		`- {`
`121`		`- return (node as MethodDeclarationSyntax)?.Identifier`
`122`		`- ?? (node as IndexerDeclarationSyntax)?.ThisKeyword`
`123`		`- ?? (node as DelegateDeclarationSyntax).Identifier;`
`124`		`- }`
`125`	`112`	`}`
`126`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public SA1614ElementParameterDocumentationMustHaveText()`
`56`	`56`	`protected override void HandleXmlElement(SyntaxNodeAnalysisContext context, IEnumerable<XmlNodeSyntax> syntaxList, params Location[] diagnosticLocations)`
`57`	`57`	`{`
`58`	`58`	`var xmlParameterNames = syntaxList`
`59`		`- .Where(x => string.Equals(GetName(x)?.ToString(), XmlCommentHelper.ParamXmlTag))`
	`59`	`+ .Where(x => string.Equals(x.GetName()?.ToString(), XmlCommentHelper.ParamXmlTag))`
`60`	`60`	`.Select(x =>`
`61`	`61`	`{`
`62`	`62`	`bool isEmpty = x is XmlEmptyElementSyntax \|\| XmlCommentHelper.IsConsideredEmpty(x);`
`@@ -98,11 +98,5 @@ private static void VerifyParameters(SyntaxNodeAnalysisContext context, Immutabl`
`98`	`98`	`index++;`
`99`	`99`	`}`
`100`	`100`	`}`
`101`		`-`
`102`		`- private static XmlNameSyntax GetName(XmlNodeSyntax element)`
`103`		`- {`
`104`		`- return (element as XmlElementSyntax)?.StartTag?.Name`
`105`		`- ?? (element as XmlEmptyElementSyntax)?.Name;`
`106`		`- }`
`107`	`101`	`}`
`108`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,21 +82,15 @@ private static void HandleDocumentationTrivia(SyntaxNodeAnalysisContext context)`
`82`	`82`	`ImmutableArray<string> parentTypeParameters = parentTypeParametersEnumerable.ToImmutableArray();`
`83`	`83`
`84`	`84`	`ImmutableArray<XmlNodeSyntax> nodes = syntax.Content`
`85`		`- .Where(node => string.Equals(GetName(node)?.ToString(), XmlCommentHelper.TypeParamXmlTag))`
	`85`	`+ .Where(node => string.Equals(node.GetName()?.ToString(), XmlCommentHelper.TypeParamXmlTag))`
`86`	`86`	`.ToImmutableArray();`
`87`	`87`
`88`	`88`	`for (int i = 0; i < nodes.Length; i++)`
`89`	`89`	`{`
`90`		`- HandleElement(context, nodes[i], parentTypeParameters, i, GetName(nodes[i])?.GetLocation());`
	`90`	`+ HandleElement(context, nodes[i], parentTypeParameters, i, nodes[i]?.GetName()?.GetLocation());`
`91`	`91`	`}`
`92`	`92`	`}`
`93`	`93`
`94`		`- private static XmlNameSyntax GetName(XmlNodeSyntax element)`
`95`		`- {`
`96`		`- return (element as XmlElementSyntax)?.StartTag?.Name`
`97`		`- ?? (element as XmlEmptyElementSyntax)?.Name;`
`98`		`- }`
`99`		`-`
`100`	`94`	`private static void HandleElement(SyntaxNodeAnalysisContext context, XmlNodeSyntax element, ImmutableArray<string> parentTypeParameters, int index, Location alternativeDiagnosticLocation)`
`101`	`95`	`{`
`102`	`96`	`var nameAttribute = XmlCommentHelper.GetFirstAttributeOrDefault<XmlNameAttributeSyntax>(element);`
Original file line number	Diff line number	Diff line change
`@@ -245,6 +245,12 @@ where token.HasTrailingTrivia`
`245`	`245`	`return node.ReplaceTokens(replacements.Keys, (originalToken, rewrittenToken) => replacements[originalToken]);`
`246`	`246`	`}`
`247`	`247`
	`248`	`+ public static XmlNameSyntax GetName(this XmlNodeSyntax element)`
	`249`	`+ {`
	`250`	`+ return (element as XmlElementSyntax)?.StartTag?.Name`
	`251`	`+ ?? (element as XmlEmptyElementSyntax)?.Name;`
	`252`	`+ }`
	`253`	`+`
`248`	`254`	`private static SyntaxTrivia SelectExteriorTrivia(SyntaxTrivia rewrittenTrivia, SyntaxTrivia trivia, SyntaxTrivia triviaWithSpace)`
`249`	`255`	`{`
`250`	`256`	`// if the trivia had a trailing space, make sure to preserve it`