chore(sonar)!: mark public Markdown generator methods static (CA1822)
SonarQube Analysis / sonarqube (pull_request) Successful in 3m30s

Three public methods on the SqlServer-namespaced Markdown generators no
longer touch instance state and now carry the `static` keyword:

- `Markdown.SqlServer.QueryBreakdownGenerator.GenerateMermaidDiagram(QueryBreakdown, string?)`
- `Markdown.SqlServer.SqlStatementGenerator.GenerateSequenceDiagram(ISqlBreakdown, string?)`
- `Markdown.SqlServer.SqlStatementGenerator.GenerateEntityRelationshipDiagram(IEnumerable<string>, string?)`

Plus one private bonus the analyzer caught on the same pass:
- `LinqExpressionVisitor.ExtractSelectExpression` → static (non-breaking).

Internal callers in the Snowflake/LinqToSql/PostgreSql wrapper classes
and in the test fixtures are updated to the type-name form
(`SqlServer.SqlStatementGenerator.GenerateSequenceDiagram(...)`).
The wrappers retain their `_baseGenerator` field for now even though it
is no longer used — that S4487 / unused-field cleanup is its own commit.

BREAKING CHANGE: External NuGet consumers calling
`generatorInstance.GenerateMermaidDiagram(...)`,
`generatorInstance.GenerateSequenceDiagram(...)`, or
`generatorInstance.GenerateEntityRelationshipDiagram(...)` on the
SqlServer-namespaced generators must switch to type-name form, e.g.
`Markdown.SqlServer.SqlStatementGenerator.GenerateSequenceDiagram(...)`.
Calls through the Snowflake / LinqToSql / PostgreSql wrapper classes are
unaffected at the call site.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Thom Lamb
2026-05-27 14:22:27 -05:00
co-authored by Claude Opus 4.7
parent 3c602a4625
commit 5202d93e8e
12 changed files with 29 additions and 29 deletions
@@ -277,7 +277,7 @@ public class LinqExpressionVisitor : ExpressionVisitor
return base.VisitMember(node);
}
private string ExtractSelectExpression(Expression expression)
private static string ExtractSelectExpression(Expression expression)
{
if (expression is NewExpression newExpr)
{
@@ -28,7 +28,7 @@ public class QueryBreakdownGenerator
{
// Since LinqQueryBreakdown inherits from SqlServer.QueryBreakdown,
// we can use the base generator which works with the shared properties
return _baseGenerator.GenerateMermaidDiagram(queryBreakdown, title);
return SqlServer.QueryBreakdownGenerator.GenerateMermaidDiagram(queryBreakdown, title);
}
/// <summary>
@@ -28,7 +28,7 @@ public class SqlStatementGenerator
/// <returns>A string containing the Mermaid sequence diagram markdown.</returns>
public string GenerateSequenceDiagram(ISqlBreakdown sqlBreakdown, string? title = null)
{
return _baseGenerator.GenerateSequenceDiagram(sqlBreakdown, title);
return SqlServer.SqlStatementGenerator.GenerateSequenceDiagram(sqlBreakdown, title);
}
/// <summary>
@@ -49,7 +49,7 @@ public class SqlStatementGenerator
tableNames.Add(fromClauseText);
}
return _baseGenerator.GenerateEntityRelationshipDiagram(tableNames, title);
return SqlServer.SqlStatementGenerator.GenerateEntityRelationshipDiagram(tableNames, title);
}
/// <summary>
@@ -28,6 +28,6 @@ public class QueryBreakdownGenerator
{
// Since PostgreSql.QueryBreakdown inherits from SqlServer.QueryBreakdown,
// we can use the base generator which works with the shared properties
return _baseGenerator.GenerateMermaidDiagram(queryBreakdown, title);
return SqlServer.QueryBreakdownGenerator.GenerateMermaidDiagram(queryBreakdown, title);
}
}
@@ -26,7 +26,7 @@ public class SqlStatementGenerator
/// <returns>A string containing the Mermaid sequence diagram markdown.</returns>
public string GenerateSequenceDiagram(SqlBreakdownBase sqlBreakdown, string? title = null)
{
return _baseGenerator.GenerateSequenceDiagram(sqlBreakdown, title);
return SqlServer.SqlStatementGenerator.GenerateSequenceDiagram(sqlBreakdown, title);
}
/// <summary>
@@ -37,6 +37,6 @@ public class SqlStatementGenerator
/// <returns>A string containing the Mermaid ER diagram markdown.</returns>
public string GenerateEntityRelationshipDiagram(IEnumerable<string> tables, string? title = null)
{
return _baseGenerator.GenerateEntityRelationshipDiagram(tables, title);
return SqlServer.SqlStatementGenerator.GenerateEntityRelationshipDiagram(tables, title);
}
}
@@ -28,6 +28,6 @@ public class QueryBreakdownGenerator
{
// Since Snowflake.QueryBreakdown inherits from SqlServer.QueryBreakdown,
// we can use the base generator which works with the shared properties
return _baseGenerator.GenerateMermaidDiagram(queryBreakdown, title);
return SqlServer.QueryBreakdownGenerator.GenerateMermaidDiagram(queryBreakdown, title);
}
}
@@ -26,7 +26,7 @@ public class SqlStatementGenerator
/// <returns>A string containing the Mermaid sequence diagram markdown.</returns>
public string GenerateSequenceDiagram(SqlBreakdownBase sqlBreakdown, string? title = null)
{
return _baseGenerator.GenerateSequenceDiagram(sqlBreakdown, title);
return SqlServer.SqlStatementGenerator.GenerateSequenceDiagram(sqlBreakdown, title);
}
/// <summary>
@@ -37,6 +37,6 @@ public class SqlStatementGenerator
/// <returns>A string containing the Mermaid ER diagram markdown.</returns>
public string GenerateEntityRelationshipDiagram(IEnumerable<string> tables, string? title = null)
{
return _baseGenerator.GenerateEntityRelationshipDiagram(tables, title);
return SqlServer.SqlStatementGenerator.GenerateEntityRelationshipDiagram(tables, title);
}
}
@@ -16,7 +16,7 @@ public class QueryBreakdownGenerator
/// <param name="queryBreakdown">The QueryBreakdown to visualize.</param>
/// <param name="title">Optional title for the diagram.</param>
/// <returns>A string containing the Mermaid markdown diagram.</returns>
public string GenerateMermaidDiagram(QueryBreakdown queryBreakdown, string? title = null)
public static string GenerateMermaidDiagram(QueryBreakdown queryBreakdown, string? title = null)
{
var sb = new StringBuilder();
@@ -14,7 +14,7 @@ public class SqlStatementGenerator
/// <param name="sqlBreakdown">The SQL breakdown to visualize.</param>
/// <param name="title">Optional title for the diagram.</param>
/// <returns>A string containing the Mermaid markdown sequence diagram.</returns>
public string GenerateSequenceDiagram(ISqlBreakdown sqlBreakdown, string? title = null)
public static string GenerateSequenceDiagram(ISqlBreakdown sqlBreakdown, string? title = null)
{
var sb = new StringBuilder();
@@ -74,7 +74,7 @@ public class SqlStatementGenerator
/// <param name="tableNames">List of table names referenced in the query.</param>
/// <param name="title">Optional title for the diagram.</param>
/// <returns>A string containing the Mermaid markdown ER diagram.</returns>
public string GenerateEntityRelationshipDiagram(IEnumerable<string> tableNames, string? title = null)
public static string GenerateEntityRelationshipDiagram(IEnumerable<string> tableNames, string? title = null)
{
var sb = new StringBuilder();
@@ -22,7 +22,7 @@ public class QueryBreakdownGeneratorTests
var query = new QueryBreakdown("ID, Name", "Users");
// Act
var result = _generator.GenerateMermaidDiagram(query);
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Does.Contain("```mermaid"));
@@ -46,7 +46,7 @@ public class QueryBreakdownGeneratorTests
query.OrderByClause.Clause = "OrderCount DESC";
// Act
var result = _generator.GenerateMermaidDiagram(query, "User Orders Query");
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query, "User Orders Query");
// Assert
Assert.That(result, Does.Contain("### User Orders Query"));
@@ -65,7 +65,7 @@ public class QueryBreakdownGeneratorTests
var query = new QueryBreakdown("*", "Products", "Price > 100");
// Act
var result = _generator.GenerateMermaidDiagram(query);
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Does.Contain("WHERE"));
@@ -86,7 +86,7 @@ public class QueryBreakdownGeneratorTests
var query = QueryBreakdown.Parse(sql);
// Act
var result = _generator.GenerateMermaidDiagram(query);
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Is.Not.Null);
@@ -102,7 +102,7 @@ public class QueryBreakdownGeneratorTests
var query = new QueryBreakdown("*", "Users");
// Act
var result = _generator.GenerateMermaidDiagram(query, "Test Query");
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query, "Test Query");
// Assert
Assert.That(result, Does.StartWith("### Test Query"));
@@ -115,7 +115,7 @@ public class QueryBreakdownGeneratorTests
var query = new QueryBreakdown("*", "Users");
// Act
var result = _generator.GenerateMermaidDiagram(query);
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Does.Not.StartWith("###"));
@@ -130,7 +130,7 @@ public class QueryBreakdownGeneratorTests
var query = new QueryBreakdown(longSelect, "LargeTable");
// Act
var result = _generator.GenerateMermaidDiagram(query);
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Does.Contain("..."));
@@ -59,7 +59,7 @@ public class QueryMarkdownGenerationTests
var queryBreakdown = QueryBreakdown.Parse(sqlContent);
// Generate markdown with the filename as title
var markdown = _generator.GenerateMermaidDiagram(queryBreakdown, fileName);
var markdown = QueryBreakdownGenerator.GenerateMermaidDiagram(queryBreakdown, fileName);
// Verify markdown was generated
Assert.That(markdown, Is.Not.Null);
@@ -107,7 +107,7 @@ public class QueryMarkdownGenerationTests
try
{
var queryBreakdown = QueryBreakdown.Parse(sqlContent);
var markdown = _generator.GenerateMermaidDiagram(queryBreakdown, fileName);
var markdown = QueryBreakdownGenerator.GenerateMermaidDiagram(queryBreakdown, fileName);
// Add source SQL to the markdown
var fullMarkdown = $"{markdown}\n\n## Source SQL\n\n```sql\n{sqlContent}\n```\n";
@@ -21,7 +21,7 @@ public class SqlStatementGeneratorTests
var query = new QueryBreakdown("*", "Users");
// Act
var result = _generator.GenerateSequenceDiagram(query);
var result = SqlStatementGenerator.GenerateSequenceDiagram(query);
// Assert
Assert.That(result, Does.Contain("```mermaid"));
@@ -39,7 +39,7 @@ public class SqlStatementGeneratorTests
query.SetupClauses.Add("CREATE TEMP TABLE #Temp (ID INT)");
// Act
var result = _generator.GenerateSequenceDiagram(query);
var result = SqlStatementGenerator.GenerateSequenceDiagram(query);
// Assert
Assert.That(result, Does.Contain("Setup Clauses"));
@@ -55,7 +55,7 @@ public class SqlStatementGeneratorTests
query.FinishClauses.Add("DROP TABLE #Temp");
// Act
var result = _generator.GenerateSequenceDiagram(query);
var result = SqlStatementGenerator.GenerateSequenceDiagram(query);
// Assert
Assert.That(result, Does.Contain("Finish Clauses"));
@@ -69,7 +69,7 @@ public class SqlStatementGeneratorTests
var query = new QueryBreakdown("*", "Users");
// Act
var result = _generator.GenerateSequenceDiagram(query, "Query Execution");
var result = SqlStatementGenerator.GenerateSequenceDiagram(query, "Query Execution");
// Assert
Assert.That(result, Does.StartWith("### Query Execution"));
@@ -82,7 +82,7 @@ public class SqlStatementGeneratorTests
var tables = new[] { "Users", "Orders", "Products" };
// Act
var result = _generator.GenerateEntityRelationshipDiagram(tables);
var result = SqlStatementGenerator.GenerateEntityRelationshipDiagram(tables);
// Assert
Assert.That(result, Does.Contain("```mermaid"));
@@ -100,7 +100,7 @@ public class SqlStatementGeneratorTests
var tables = new[] { "Users", "Orders" };
// Act
var result = _generator.GenerateEntityRelationshipDiagram(tables, "Database Schema");
var result = SqlStatementGenerator.GenerateEntityRelationshipDiagram(tables, "Database Schema");
// Assert
Assert.That(result, Does.StartWith("### Database Schema"));
@@ -113,7 +113,7 @@ public class SqlStatementGeneratorTests
var tables = new[] { "[dbo].[Users]", "schema.Orders" };
// Act
var result = _generator.GenerateEntityRelationshipDiagram(tables);
var result = SqlStatementGenerator.GenerateEntityRelationshipDiagram(tables);
// Assert
Assert.That(result, Does.Contain("dbo_Users"));