Skip to content

Commit 514060d

Browse files
paulirwinclaude
paulirwin
and
claude
committed
Implement LuceneDev2000-2008 numeric culture analyzers (#924)
Adds nine Roslyn analyzers under the new Globalization category that flag culture-sensitive numeric format/parse calls so the Lucene.NET team can audit each one against Java Lucene's invariant-culture default: - 2000: BCL Parse/TryParse without IFormatProvider - 2001: BCL ToString/TryFormat without IFormatProvider (exempts ToString() overrides) - 2002: Convert.ToXxx / Convert.ToString numeric without IFormatProvider - 2003: string.Format with numeric arg, no IFormatProvider - 2004: J2N.Numerics.* without IFormatProvider - 2005: implicit numeric formatting via string concatenation - 2006: implicit numeric formatting via string interpolation (skips FormattableString.Invariant and string.Create with InvariantCulture) - 2007: explicit IFormatProvider, but not InvariantCulture - 2008: explicit InvariantCulture (review-sweep aid; off by default) Also adds three CodeFixProviders covering 2000/2001/2002/2004, 2003, and 2005/2006, and a NumericTypeHelper utility shared by the analyzers. Sample project gets a violation file plus a J2N package reference. Tests cover positive and negative paths for all analyzers and the codefix outputs (180 tests total, all passing). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 68a5922 commit 514060d

31 files changed

Lines changed: 2645 additions & 0 deletions

File tree

‎Directory.Packages.props‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,6 @@
4343
<PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.Common" Version="$(RoslynAnalyzerPackageVersion)" />
4444
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.4.0" />
4545
<PackageVersion Include="Microsoft.VSSDK.BuildTools" Version="17.14.2094" />
46+
<PackageVersion Include="J2N" Version="2.1.0" />
4647
</ItemGroup>
4748
</Project>

‎src/Lucene.Net.CodeAnalysis.Dev.CodeFixes/LuceneDev2xxx/LuceneDev2000_2001_2002_2004_AddInvariantCultureCodeFixProvider.cs‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file for additional information.
4+
* The ASF licenses this file under the Apache License, Version 2.0.
5+
*/
6+
7+
using System.Collections.Immutable;
8+
using System.Composition;
9+
using System.Linq;
10+
using System.Threading;
11+
using System.Threading.Tasks;
12+
using Lucene.Net.CodeAnalysis.Dev.Utility;
13+
using Microsoft.CodeAnalysis;
14+
using Microsoft.CodeAnalysis.CodeActions;
15+
using Microsoft.CodeAnalysis.CodeFixes;
16+
using Microsoft.CodeAnalysis.CSharp;
17+
using Microsoft.CodeAnalysis.CSharp.Syntax;
18+
19+
namespace Lucene.Net.CodeAnalysis.Dev.CodeFixes.LuceneDev2xxx
20+
{
21+
[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(LuceneDev2000_2001_2002_2004_AddInvariantCultureCodeFixProvider)), Shared]
22+
public sealed class LuceneDev2000_2001_2002_2004_AddInvariantCultureCodeFixProvider : CodeFixProvider
23+
{
24+
private const string TitleInvariant = "Add CultureInfo.InvariantCulture";
25+
private const string TitleCurrent = "Add CultureInfo.CurrentCulture";
26+
27+
public override ImmutableArray<string> FixableDiagnosticIds =>
28+
ImmutableArray.Create(
29+
Descriptors.LuceneDev2000_BclNumericParseMissingFormatProvider.Id,
30+
Descriptors.LuceneDev2001_BclNumericToStringMissingFormatProvider.Id,
31+
Descriptors.LuceneDev2002_ConvertNumericMissingFormatProvider.Id,
32+
Descriptors.LuceneDev2004_J2NNumericMissingFormatProvider.Id);
33+
34+
public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;
35+
36+
public override async Task RegisterCodeFixesAsync(CodeFixContext context)
37+
{
38+
var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
39+
if (root is null) return;
40+
41+
foreach (var diagnostic in context.Diagnostics)
42+
{
43+
var invocation = root.FindToken(diagnostic.Location.SourceSpan.Start)
44+
.Parent?
45+
.AncestorsAndSelf()
46+
.OfType<InvocationExpressionSyntax>()
47+
.FirstOrDefault();
48+
if (invocation is null) continue;
49+
50+
RegisterFix(context, invocation, "InvariantCulture", TitleInvariant, diagnostic);
51+
RegisterFix(context, invocation, "CurrentCulture", TitleCurrent, diagnostic);
52+
}
53+
}
54+
55+
private static void RegisterFix(
56+
CodeFixContext context,
57+
InvocationExpressionSyntax invocation,
58+
string cultureMember,
59+
string title,
60+
Diagnostic diagnostic)
61+
{
62+
context.RegisterCodeFix(CodeAction.Create(
63+
title: title,
64+
createChangedDocument: c => AddCultureArgumentAsync(context.Document, invocation, cultureMember, c),
65+
equivalenceKey: title),
66+
diagnostic);
67+
}
68+
69+
private static async Task<Document> AddCultureArgumentAsync(
70+
Document document,
71+
InvocationExpressionSyntax invocation,
72+
string cultureMember,
73+
CancellationToken cancellationToken)
74+
{
75+
var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false);
76+
if (root is null) return document;
77+
78+
var cultureExpr = SyntaxFactory.MemberAccessExpression(
79+
SyntaxKind.SimpleMemberAccessExpression,
80+
SyntaxFactory.IdentifierName("CultureInfo"),
81+
SyntaxFactory.IdentifierName(cultureMember));
82+
var newArg = SyntaxFactory.Argument(cultureExpr);
83+
84+
var newInvocation = invocation.WithArgumentList(invocation.ArgumentList.AddArguments(newArg));
85+
var newRoot = EnsureGlobalizationUsing(root).ReplaceNode(invocation, newInvocation);
86+
return document.WithSyntaxRoot(newRoot);
87+
}
88+
89+
internal static SyntaxNode EnsureGlobalizationUsing(SyntaxNode root)
90+
{
91+
if (root is CompilationUnitSyntax compilationUnit)
92+
{
93+
var hasUsing = compilationUnit.Usings.Any(u => u.Name?.ToString() == "System.Globalization");
94+
if (!hasUsing)
95+
{
96+
var usingDirective = SyntaxFactory.UsingDirective(
97+
SyntaxFactory.QualifiedName(
98+
SyntaxFactory.IdentifierName("System"),
99+
SyntaxFactory.IdentifierName("Globalization")))
100+
.WithTrailingTrivia(SyntaxFactory.ElasticEndOfLine("\n"));
101+
return compilationUnit.AddUsings(usingDirective);
102+
}
103+
}
104+
return root;
105+
}
106+
}
107+
}

‎src/Lucene.Net.CodeAnalysis.Dev.CodeFixes/LuceneDev2xxx/LuceneDev2003_AddInvariantCultureToStringFormatCodeFixProvider.cs‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file for additional information.
4+
* The ASF licenses this file under the Apache License, Version 2.0.
5+
*/
6+
7+
using System.Collections.Immutable;
8+
using System.Composition;
9+
using System.Linq;
10+
using System.Threading;
11+
using System.Threading.Tasks;
12+
using Lucene.Net.CodeAnalysis.Dev.Utility;
13+
using Microsoft.CodeAnalysis;
14+
using Microsoft.CodeAnalysis.CodeActions;
15+
using Microsoft.CodeAnalysis.CodeFixes;
16+
using Microsoft.CodeAnalysis.CSharp;
17+
using Microsoft.CodeAnalysis.CSharp.Syntax;
18+
19+
namespace Lucene.Net.CodeAnalysis.Dev.CodeFixes.LuceneDev2xxx
20+
{
21+
[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(LuceneDev2003_AddInvariantCultureToStringFormatCodeFixProvider)), Shared]
22+
public sealed class LuceneDev2003_AddInvariantCultureToStringFormatCodeFixProvider : CodeFixProvider
23+
{
24+
private const string TitleInvariant = "Add CultureInfo.InvariantCulture";
25+
private const string TitleCurrent = "Add CultureInfo.CurrentCulture";
26+
27+
public override ImmutableArray<string> FixableDiagnosticIds =>
28+
ImmutableArray.Create(Descriptors.LuceneDev2003_StringFormatNumericMissingFormatProvider.Id);
29+
30+
public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;
31+
32+
public override async Task RegisterCodeFixesAsync(CodeFixContext context)
33+
{
34+
var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
35+
if (root is null) return;
36+
37+
foreach (var diagnostic in context.Diagnostics)
38+
{
39+
var invocation = root.FindToken(diagnostic.Location.SourceSpan.Start)
40+
.Parent?
41+
.AncestorsAndSelf()
42+
.OfType<InvocationExpressionSyntax>()
43+
.FirstOrDefault();
44+
if (invocation is null) continue;
45+
46+
Register(context, invocation, "InvariantCulture", TitleInvariant, diagnostic);
47+
Register(context, invocation, "CurrentCulture", TitleCurrent, diagnostic);
48+
}
49+
}
50+
51+
private static void Register(
52+
CodeFixContext context,
53+
InvocationExpressionSyntax invocation,
54+
string cultureMember,
55+
string title,
56+
Diagnostic diagnostic)
57+
{
58+
context.RegisterCodeFix(CodeAction.Create(
59+
title: title,
60+
createChangedDocument: c => InsertProviderAsync(context.Document, invocation, cultureMember, c),
61+
equivalenceKey: title),
62+
diagnostic);
63+
}
64+
65+
private static async Task<Document> InsertProviderAsync(
66+
Document document,
67+
InvocationExpressionSyntax invocation,
68+
string cultureMember,
69+
CancellationToken cancellationToken)
70+
{
71+
var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false);
72+
if (root is null) return document;
73+
74+
var cultureExpr = SyntaxFactory.MemberAccessExpression(
75+
SyntaxKind.SimpleMemberAccessExpression,
76+
SyntaxFactory.IdentifierName("CultureInfo"),
77+
SyntaxFactory.IdentifierName(cultureMember));
78+
var providerArg = SyntaxFactory.Argument(cultureExpr);
79+
80+
// Insert as the new first argument; existing args shift right.
81+
var newArgs = invocation.ArgumentList.Arguments.Insert(0, providerArg);
82+
var newArgList = invocation.ArgumentList.WithArguments(newArgs);
83+
var newInvocation = invocation.WithArgumentList(newArgList);
84+
85+
var newRoot = LuceneDev2000_2001_2002_2004_AddInvariantCultureCodeFixProvider
86+
.EnsureGlobalizationUsing(root)
87+
.ReplaceNode(invocation, newInvocation);
88+
return document.WithSyntaxRoot(newRoot);
89+
}
90+
}
91+
}

‎src/Lucene.Net.CodeAnalysis.Dev.CodeFixes/LuceneDev2xxx/LuceneDev2005_2006_WrapNumericWithInvariantCodeFixProvider.cs‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file for additional information.
4+
* The ASF licenses this file under the Apache License, Version 2.0.
5+
*/
6+
7+
using System.Collections.Immutable;
8+
using System.Composition;
9+
using System.Linq;
10+
using System.Threading;
11+
using System.Threading.Tasks;
12+
using Lucene.Net.CodeAnalysis.Dev.Utility;
13+
using Microsoft.CodeAnalysis;
14+
using Microsoft.CodeAnalysis.CodeActions;
15+
using Microsoft.CodeAnalysis.CodeFixes;
16+
using Microsoft.CodeAnalysis.CSharp;
17+
using Microsoft.CodeAnalysis.CSharp.Syntax;
18+
19+
namespace Lucene.Net.CodeAnalysis.Dev.CodeFixes.LuceneDev2xxx
20+
{
21+
[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(LuceneDev2005_2006_WrapNumericWithInvariantCodeFixProvider)), Shared]
22+
public sealed class LuceneDev2005_2006_WrapNumericWithInvariantCodeFixProvider : CodeFixProvider
23+
{
24+
private const string TitleInvariant = "Wrap with .ToString(CultureInfo.InvariantCulture)";
25+
private const string TitleCurrent = "Wrap with .ToString(CultureInfo.CurrentCulture)";
26+
27+
public override ImmutableArray<string> FixableDiagnosticIds =>
28+
ImmutableArray.Create(
29+
Descriptors.LuceneDev2005_NumericStringConcatenation.Id,
30+
Descriptors.LuceneDev2006_NumericStringInterpolation.Id);
31+
32+
public override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;
33+
34+
public override async Task RegisterCodeFixesAsync(CodeFixContext context)
35+
{
36+
var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
37+
if (root is null) return;
38+
39+
foreach (var diagnostic in context.Diagnostics)
40+
{
41+
var token = root.FindToken(diagnostic.Location.SourceSpan.Start);
42+
var expression = token.Parent?
43+
.AncestorsAndSelf()
44+
.OfType<ExpressionSyntax>()
45+
.FirstOrDefault(e => e.Span == diagnostic.Location.SourceSpan);
46+
47+
if (expression is null) continue;
48+
49+
Register(context, expression, "InvariantCulture", TitleInvariant, diagnostic);
50+
Register(context, expression, "CurrentCulture", TitleCurrent, diagnostic);
51+
}
52+
}
53+
54+
private static void Register(
55+
CodeFixContext context,
56+
ExpressionSyntax expression,
57+
string cultureMember,
58+
string title,
59+
Diagnostic diagnostic)
60+
{
61+
context.RegisterCodeFix(CodeAction.Create(
62+
title: title,
63+
createChangedDocument: c => WrapAsync(context.Document, expression, cultureMember, c),
64+
equivalenceKey: title),
65+
diagnostic);
66+
}
67+
68+
private static async Task<Document> WrapAsync(
69+
Document document,
70+
ExpressionSyntax expression,
71+
string cultureMember,
72+
CancellationToken cancellationToken)
73+
{
74+
var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false);
75+
if (root is null) return document;
76+
77+
// Parenthesize complex expressions so we don't accidentally bind .ToString to part of a larger expression.
78+
ExpressionSyntax receiver = expression is IdentifierNameSyntax || expression is LiteralExpressionSyntax || expression is InvocationExpressionSyntax || expression is MemberAccessExpressionSyntax
79+
? expression.WithoutTrivia()
80+
: SyntaxFactory.ParenthesizedExpression(expression.WithoutTrivia());
81+
82+
var cultureExpr = SyntaxFactory.MemberAccessExpression(
83+
SyntaxKind.SimpleMemberAccessExpression,
84+
SyntaxFactory.IdentifierName("CultureInfo"),
85+
SyntaxFactory.IdentifierName(cultureMember));
86+
87+
var toStringCall = SyntaxFactory.InvocationExpression(
88+
SyntaxFactory.MemberAccessExpression(
89+
SyntaxKind.SimpleMemberAccessExpression,
90+
receiver,
91+
SyntaxFactory.IdentifierName("ToString")),
92+
SyntaxFactory.ArgumentList(SyntaxFactory.SingletonSeparatedList(SyntaxFactory.Argument(cultureExpr))))
93+
.WithLeadingTrivia(expression.GetLeadingTrivia())
94+
.WithTrailingTrivia(expression.GetTrailingTrivia());
95+
96+
var newRoot = LuceneDev2000_2001_2002_2004_AddInvariantCultureCodeFixProvider
97+
.EnsureGlobalizationUsing(root)
98+
.ReplaceNode(expression, toStringCall);
99+
return document.WithSyntaxRoot(newRoot);
100+
}
101+
}
102+
}

‎src/Lucene.Net.CodeAnalysis.Dev.Sample/Lucene.Net.CodeAnalysis.Dev.Sample.csproj‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ under the License.
5656
<PackageReference Include="Lucene.Net.CodeAnalysis.Dev" VersionOverride="$(_CodeAnalysisPackageVersion)" />
5757
</ItemGroup>
5858

59+
<ItemGroup>
60+
<PackageReference Include="J2N" />
61+
</ItemGroup>
62+
5963
<Target Name="EnsureNuGetPackageBuilt" BeforeTargets="PrepareForBuild" Condition="'$(DesignTimeBuild)' != 'true'">
6064

6165
<Message Importance="high" Text="Running NuGet Package Build..." />

0 commit comments

Comments
 (0)