Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve S3398: Fix code smells #6827

Merged
merged 2 commits into from Mar 1, 2023
Merged

Improve S3398: Fix code smells #6827

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67905c8
Fix code smells
zsolt-kolbay-sonarsource Feb 28, 2023
d59de47
Revert previous refactor
zsolt-kolbay-sonarsource Mar 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 11 additions & 17 deletions analyzers/src/SonarAnalyzer.CSharp/Rules/PrivateStaticMethodUsedOnlyByNestedClass.cs
View file
Open in desktop
Expand Up @@ -102,25 +102,18 @@ private static bool IsPrivateAndStatic(MethodDeclarationSyntax method, TypeDecla

private static TypeDeclarationSyntax LowestCommonAncestorOrSelf(IEnumerable<TypeDeclarationSyntax> declaredTypes)
{
var typeHierarchyFromTopToBottom = declaredTypes.Select(PathFromTop);
var typeHierarchyFromTopToBottom = declaredTypes.Select(PathFromTop).ToArray();
var minPathLength = typeHierarchyFromTopToBottom.Select(x => x.Length).Min();
var firstPath = typeHierarchyFromTopToBottom.First();
var levels = Enumerable.Range(0, minPathLength);
var firstDifferingLevel = levels.FirstOrDefault(NotEveryNodeIsTheSameOnLevel);
int levelOfLowestCommonAncestor = firstDifferingLevel == default
? minPathLength - 1
: firstDifferingLevel - 1;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

having -1 makes it a bit difficult to follow the logic...

there's another implicit negation here: Differ rather then Common in the name of the method: LowestCommonAncestorOrSelf

So the method is named Common, but the logic inside is looking for Different

return firstPath[levelOfLowestCommonAncestor];

var lastCommonPathIndex = 0;
for (int i = 0; i < minPathLength; i++)
{
var isPartOfCommonPath = typeHierarchyFromTopToBottom.All(x => x[i] == firstPath[i]);
if (isPartOfCommonPath)
{
lastCommonPathIndex = i;
}
else
{
break;
}
}

return firstPath[lastCommonPathIndex];
bool NotEveryNodeIsTheSameOnLevel(int level) =>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't find this clearer because it's two negations:

  • NotEveryNodeIsTheSameOnLevel
  • != inside Any

Also, levels refers to indeces, whereas NotEveryNodeIsTheSameOnLevel is iterating over typeHierarchyFromTopToBottom

But NotEveryNodeIsTheSameOnLevel is called on levels

There's a lot of indirection in here. levels.Do(Action) actually iterates on a different data structure, using the indeces inside levels

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted it. Now the only change is splitting the comment to multiple lines.

typeHierarchyFromTopToBottom.Any(x => x[level] != firstPath[level]);

static TypeDeclarationSyntax[] PathFromTop(SyntaxNode node) =>
node.AncestorsAndSelf()
Expand Down Expand Up @@ -178,7 +171,8 @@ private sealed record MethodUsedByTypes(MethodDeclarationSyntax Method, TypeDecl
/// <summary>
/// Collects all the potential references to a set of methods inside the given syntax node.
/// The collector looks for identifiers which match any of the methods' names, but does not try to resolve them to symbols with the semantic model.
/// Performance gains: by only using the syntax tree to find matches we can eliminate certain methods (which are only used by the type which has declared it) without using the more costly symbolic lookup.
/// Performance gains: by only using the syntax tree to find matches we can eliminate certain methods (which are only used by the type which has declared it)
/// without using the more costly symbolic lookup.
/// </summary>
private sealed class PotentialMethodReferenceCollector : CSharpSyntaxWalker
{
Expand Down