better alias

Author: SimonCropp

readme.md

@@ -87,7 +87,7 @@ builder.UseSqlServer(connection);
 builder.EnableRecording();
 var data = new SampleDbContext(builder.Options);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L384-L391' title='Snippet source file'>snippet source</a> | <a href='#snippet-EnableRecording' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L340-L347' title='Snippet source file'>snippet source</a> | <a href='#snippet-EnableRecording' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 `EnableRecording` should only be called in the test context.
@@ -116,7 +116,7 @@ await data
 
 await Verify();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L483-L501' title='Snippet source file'>snippet source</a> | <a href='#snippet-Recording' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L439-L457' title='Snippet source file'>snippet source</a> | <a href='#snippet-Recording' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file:
@@ -168,7 +168,7 @@ await Verify(
         entries
     });
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L674-L699' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingSpecific' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L630-L655' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingSpecific' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -200,7 +200,7 @@ await data2
 
 await Verify();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L451-L474' title='Snippet source file'>snippet source</a> | <a href='#snippet-MultiDbContexts' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L407-L430' title='Snippet source file'>snippet source</a> | <a href='#snippet-MultiDbContexts' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: CoreTests.MultiDbContexts.verified.txt -->
@@ -265,7 +265,7 @@ await data
 
 await Verify();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L545-L568' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingDisableForInstance' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L501-L524' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordingDisableForInstance' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 <!-- snippet: CoreTests.RecordingDisabledTest.verified.txt -->
@@ -313,7 +313,7 @@ public async Task Added()
     await Verify(data.ChangeTracker);
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L87-L103' title='Snippet source file'>snippet source</a> | <a href='#snippet-Added' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L43-L59' title='Snippet source file'>snippet source</a> | <a href='#snippet-Added' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file:
@@ -358,7 +358,7 @@ public async Task Deleted()
     await Verify(data.ChangeTracker);
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L105-L124' title='Snippet source file'>snippet source</a> | <a href='#snippet-Deleted' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L61-L80' title='Snippet source file'>snippet source</a> | <a href='#snippet-Deleted' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file:
@@ -403,7 +403,7 @@ public async Task Modified()
     await Verify(data.ChangeTracker);
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L126-L146' title='Snippet source file'>snippet source</a> | <a href='#snippet-Modified' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L82-L102' title='Snippet source file'>snippet source</a> | <a href='#snippet-Modified' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file:
@@ -438,7 +438,7 @@ var queryable = data.Companies
     .Where(_ => _.Name == "company name");
 await Verify(queryable);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L341-L347' title='Snippet source file'>snippet source</a> | <a href='#snippet-Queryable' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L297-L303' title='Snippet source file'>snippet source</a> | <a href='#snippet-Queryable' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified files:
@@ -505,7 +505,7 @@ await Verify(data.AllData())
         serializer =>
             serializer.TypeNameHandling = TypeNameHandling.Objects);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L320-L327' title='Snippet source file'>snippet source</a> | <a href='#snippet-AllData' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L276-L283' title='Snippet source file'>snippet source</a> | <a href='#snippet-AllData' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Will result in the following verified file with all data in the database:
@@ -588,7 +588,7 @@ public async Task IgnoreNavigationProperties()
         .IgnoreNavigationProperties();
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L148-L170' title='Snippet source file'>snippet source</a> | <a href='#snippet-IgnoreNavigationProperties' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L104-L126' title='Snippet source file'>snippet source</a> | <a href='#snippet-IgnoreNavigationProperties' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -601,7 +601,7 @@ var options = DbContextOptions();
 using var data = new SampleDbContext(options);
 VerifyEntityFramework.IgnoreNavigationProperties();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L198-L204' title='Snippet source file'>snippet source</a> | <a href='#snippet-IgnoreNavigationPropertiesGlobal' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L154-L160' title='Snippet source file'>snippet source</a> | <a href='#snippet-IgnoreNavigationPropertiesGlobal' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -622,7 +622,7 @@ protected override void ConfigureWebHost(IWebHostBuilder webBuilder)
             _ => dataBuilder.Options));
 }
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L628-L640' title='Snippet source file'>snippet source</a> | <a href='#snippet-EnableRecordingWithIdentifier' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L584-L596' title='Snippet source file'>snippet source</a> | <a href='#snippet-EnableRecordingWithIdentifier' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Then use the same identifier for recording:
@@ -638,7 +638,7 @@ var companies = await httpClient.GetFromJsonAsync<Company[]>("/companies");
 
 var entries = Recording.Stop(testName);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L601-L611' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordWithIdentifier' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L557-L567' title='Snippet source file'>snippet source</a> | <a href='#snippet-RecordWithIdentifier' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 The results will not be automatically included in verified file so it will have to be verified manually:
@@ -653,7 +653,7 @@ await Verify(
         sql = entries
     });
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L613-L622' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyRecordedCommandsWithIdentifier' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L569-L578' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyRecordedCommandsWithIdentifier' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -680,7 +680,7 @@ var settings = new VerifySettings();
 settings.ScrubInlineEfDateTimes();
 await Verify(target, settings);
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L34-L40' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesInstance' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L21-L27' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesInstance' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 
@@ -692,7 +692,7 @@ await Verify(target, settings);
 await Verify(target)
     .ScrubInlineEfDateTimes();
 ```
-<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L48-L53' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesFluent' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.EntityFramework.Tests/CoreTests.cs#L35-L40' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubInlineEfDateTimesFluent' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

src/Verify.EntityFramework.Tests/CoreTests.DescriptiveTableAliases.verified.sql

@@ -0,0 +1,4 @@
+SELECT [companies].[Id], [companies].[Name], [employees].[Id], [employees].[Age], [employees].[CompanyId], [employees].[Name]
+FROM [Companies] AS [companies]
+LEFT JOIN [Employees] AS [employees] ON [companies].[Id] = [employees].[CompanyId]
+ORDER BY [companies].[Name], [companies].[Id]

…CoreTests.WithNestedOrderBy.verified.txt …sts.DescriptiveTableAliases.verified.txtsrc/Verify.EntityFramework.Tests/CoreTests.WithNestedOrderBy.verified.txt renamed to src/Verify.EntityFramework.Tests/CoreTests.DescriptiveTableAliases.verified.txt src/Verify.EntityFramework.Tests/CoreTests.WithNestedOrderBy.verified.txt renamed to src/Verify.EntityFramework.Tests/CoreTests.DescriptiveTableAliases.verified.txt

@@ -3,27 +3,14 @@
 public class CoreTests
 {
     [Test]
-    public async Task MissingOrderBy()
+    public async Task DescriptiveTableAliases()
     {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
+        await using var database = await DbContextBuilder.GetDescriptiveAliasDatabase();
         var data = database.Context;
-        await ThrowsTask(
-                () => data.Companies
-                    .ToListAsync())
-            .IgnoreStackTrace();
-    }
-
-    [Test]
-    public async Task NestedMissingOrderBy()
-    {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
-        var data = database.Context;
-        await ThrowsTask(
-                () => data.Companies
-                    .Include(_ => _.Employees)
-                    .OrderBy(_ => _.Name)
-                    .ToListAsync())
-            .IgnoreStackTrace();
+        var queryable = data.Companies
+            .Include(_ => _.Employees)
+            .OrderBy(_ => _.Name);
+        await Verify(queryable);
     }
 
     [Test]
@@ -53,37 +40,6 @@ await Verify(target)
         #endregion
     }
 
-    [Test]
-    public async Task WithOrderBy()
-    {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
-        var data = database.Context;
-        await Verify(
-            data.Companies
-                .OrderBy(_ => _.Name)
-                .ToListAsync());
-    }
-
-    [Test]
-    public async Task SingleMissingOrder()
-    {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
-        var data = database.Context;
-        await Verify(data.Companies.Where(_ => _.Name == "Company1").SingleAsync());
-    }
-
-    [Test]
-    public async Task WithNestedOrderBy()
-    {
-        await using var database = await DbContextBuilder.GetOrderRequiredDatabase();
-        var data = database.Context;
-        await Verify(
-            data.Companies
-                .Include(_ => _.Employees.OrderBy(_ => _.Age))
-                .OrderBy(_ => _.Name)
-                .ToListAsync());
-    }
-
     #region Added
 
     [Test]

src/Verify.EntityFramework.Tests/CoreTests.MissingOrderBy.verified.txt

@@ -12,19 +12,19 @@ static DbContextBuilder()
                 builder.EnableRecording();
                 return new(builder.Options);
             });
-        orderRequiredSqlInstance = new(
+        descriptiveAliasSqlInstance = new(
             buildTemplate: CreateDb,
-            storage: Storage.FromSuffix<SampleDbContext>("ThrowForMissingOrderBy"),
+            storage: Storage.FromSuffix<SampleDbContext>("DescriptiveTableAliases"),
             constructInstance: builder =>
             {
                 builder.EnableRecording();
-                builder.ThrowForMissingOrderBy();
+                builder.UseDescriptiveTableAliases();
                 return new(builder.Options);
             });
     }
 
     static SqlInstance<SampleDbContext> sqlInstance;
-    static SqlInstance<SampleDbContext> orderRequiredSqlInstance;
+    static SqlInstance<SampleDbContext> descriptiveAliasSqlInstance;
 
     static async Task CreateDb(SampleDbContext data)
     {
@@ -78,6 +78,6 @@ static async Task CreateDb(SampleDbContext data)
     public static Task<SqlDatabase<SampleDbContext>> GetDatabase([CallerMemberName] string suffix = "")
         => sqlInstance.Build(suffix);
 
-    public static Task<SqlDatabase<SampleDbContext>> GetOrderRequiredDatabase([CallerMemberName] string suffix = "")
-        => orderRequiredSqlInstance.Build(suffix);
+    public static Task<SqlDatabase<SampleDbContext>> GetDescriptiveAliasDatabase([CallerMemberName] string suffix = "")
+        => descriptiveAliasSqlInstance.Build(suffix);
 }

src/Verify.EntityFramework.Tests/CoreTests.NestedMissingOrderBy.verified.txt

@@ -0,0 +1,24 @@
+#pragma warning disable EF9002
+
+class DescriptiveSqlAliasManager : SqlAliasManager
+{
+    Dictionary<string, int> aliases = new(StringComparer.OrdinalIgnoreCase);
+
+    public override string GenerateTableAlias(string name)
+    {
+        var lowerName = name.ToLowerInvariant();
+
+        if (aliases.TryGetValue(lowerName, out var counter))
+        {
+            aliases[lowerName] = counter + 1;
+            return lowerName + counter;
+        }
+
+        aliases[lowerName] = 0;
+        return lowerName;
+    }
+
+    protected override Dictionary<string, string>? RemapTableAliases(IReadOnlySet<string> usedAliases) =>
+        // Skip gap-closing since the base implementation assumes single-char alias prefixes
+        null;
+}