Refactor "IncreaseReadability" to "SpaceAfterComma"

This more precisely covers what the formatter option does.
MiniProfiler · Jul 1, 2021 · 5a32d33 · 5a32d33
1 parent 202ab85
commit 5a32d33
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/src/MiniProfiler.Shared/SqlFormatters/InlineFormatter.cs b/src/MiniProfiler.Shared/SqlFormatters/InlineFormatter.cs
@@ -13,9 +13,9 @@ public class InlineFormatter : ISqlFormatter
         private static bool includeTypeInfo;
 
         /// <summary>
-        /// Modifies the output query to increase readibility by adding spaces around crowded commas.
+        /// Modifies the output query by adding spaces after commas.
         /// </summary>
-        public bool IncreaseReadability { get; set; } = true;
+        public bool SpaceAfterComma { get; set; } = true;
 
         /// <summary>
         /// Creates a new <see cref="InlineFormatter"/>, optionally including the parameter type info 
@@ -40,7 +40,7 @@ public string FormatSql(string commandText, List<SqlTimingParameter> parameters)
                 return commandText;
             }
 
-            if (IncreaseReadability)
+            if (SpaceAfterComma)
             {
                 commandText = CommandSpacing.Replace(commandText, ", $1");
             }

diff --git a/src/MiniProfiler.Shared/SqlFormatters/SqlServerFormatter.cs b/src/MiniProfiler.Shared/SqlFormatters/SqlServerFormatter.cs
@@ -21,9 +21,9 @@ public class SqlServerFormatter : ISqlFormatter
         public bool IncludeParameterValues { get; set; } = true;
 
         /// <summary>
-        /// Modifies the output query to increase readibility by adding spaces around crowded commas.
+        /// Modifies the output query by adding spaces after commas.
         /// </summary>
-        public bool IncreaseReadability { get; set; } = true;
+        public bool SpaceAfterComma { get; set; } = true;
 
         /// <summary>
         /// Lookup a function for translating a parameter by parameter type
@@ -120,7 +120,7 @@ public virtual string FormatSql(string commandText, List<SqlTimingParameter> par
                       .Append("\n\n");
             }
 
-            if (IncreaseReadability)
+            if (SpaceAfterComma)
             {
                 commandText = CommandSpacing.Replace(commandText, ", $1");
             }

diff --git a/tests/MiniProfiler.Tests/SqlFormatterTests.cs b/tests/MiniProfiler.Tests/SqlFormatterTests.cs
@@ -93,7 +93,7 @@ public void InlineParameterNamesInParameterValues()
         {
             var formatter = new InlineFormatter()
             {
-                IncreaseReadability = false
+                SpaceAfterComma = false
             };
             var parameters = new List<SqlTimingParameter>
             {
@@ -119,11 +119,11 @@ public void InlineParameterValuesDisplayNullForStrings()
         }
 
         [Fact]
-        public void InlineIncreaseReadabilityEnabled()
+        public void InlineSpaceAfterCommaEnabled()
         {
             var formatter = new InlineFormatter()
             {
-                IncreaseReadability = true
+                SpaceAfterComma = true
             };
             var parameters = new List<SqlTimingParameter>
             {
@@ -136,11 +136,11 @@ public void InlineIncreaseReadabilityEnabled()
         }
 
         [Fact]
-        public void InlineIncreaseReadabilityDisabled()
+        public void InlineSpaceAfterCommaDisabled()
         {
             var formatter = new InlineFormatter()
             {
-                IncreaseReadability = false
+                SpaceAfterComma = false
             };
             var parameters = new List<SqlTimingParameter>
             {
@@ -264,7 +264,7 @@ public void TableQueryWithTwoParametersDisabled(string at)
 
         [Theory]
         [MemberData(nameof(GetParamPrefixes))]
-        public void TableQueryWithIncreasedReadabilityEnabled(string at)
+        public void TableQueryWithSpaceAfterCommaEnabled(string at)
         {
             const string text = "select 1 from dbo.Table where x = @x,y = @y";
             var cmd = CreateDbCommand(CommandType.Text, text);
@@ -273,7 +273,7 @@ public void TableQueryWithIncreasedReadabilityEnabled(string at)
 
             var formatter = new SqlServerFormatter()
             {
-                IncreaseReadability = true
+                SpaceAfterComma = true
             };
             var actualOutput = GenerateOutput(formatter, cmd, text);
 
@@ -283,7 +283,7 @@ public void TableQueryWithIncreasedReadabilityEnabled(string at)
 
         [Theory]
         [MemberData(nameof(GetParamPrefixes))]
-        public void TableQueryWithIncreasedReadabilityDisabled(string at)
+        public void TableQueryWithSpaceAfterCommaDisabled(string at)
         {
             const string text = "select 1 from dbo.Table where x = @x,y = @y";
             var cmd = CreateDbCommand(CommandType.Text, text);
@@ -292,7 +292,7 @@ public void TableQueryWithIncreasedReadabilityDisabled(string at)
 
             var formatter = new SqlServerFormatter()
             {
-                IncreaseReadability = false
+                SpaceAfterComma = false
             };
             var actualOutput = GenerateOutput(formatter, cmd, text);