Merge pull request #17 from yv989c/develop

Enhancements

Author: yv989c

.github/workflows/ci-workflow.yml

@@ -15,45 +15,46 @@ on:
   release:
     types:
       - published
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
 env:
-  # Stop wasting time caching packages
   DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
-  # Disable sending usage data to Microsoft
   DOTNET_CLI_TELEMETRY_OPTOUT: true
-  # Project name to pack and publish
-  PROJECT_NAME: BlazarTech.QueryableValues.SqlServer
+  DOTNET_GENERATE_ASPNET_CERTIFICATE: false
+ 
   # GitHub Packages Feed settings
   GITHUB_FEED: https://nuget.pkg.github.com/yv989c/index.json
   GITHUB_USER: yv989c
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   LOCAL_NUGET_PAT: ${{ secrets.LOCAL_NUGET_PAT }}
+
   # Official NuGet Feed settings
   NUGET_FEED: https://api.nuget.org/v3/index.json
   NUGET_USER: yv989c
   NUGET_TOKEN: ${{ secrets.NUGET_KEY }}
+
 jobs:
   build:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ windows-latest ]
+    runs-on: windows-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - name: Setup .NET 6
-        uses: actions/setup-dotnet@v1
-        with:
-          dotnet-version: 6.0.x
+          
       - name: Restore
         run: dotnet restore BlazarTech.QueryableValues.sln
+
       - name: Test All
         run: dotnet test BlazarTech.QueryableValues.sln -c Test_All --no-restore
+
       - name: PreRelease-Pack
         if: github.event_name != 'release'
         run: dotnet build BlazarTech.QueryableValues.SqlServer.sln -c Release --no-restore --version-suffix=build.$env:GITHUB_RUN_NUMBER
       - name: Release-Pack
         if: github.event_name == 'release'
         run: dotnet build BlazarTech.QueryableValues.SqlServer.sln -c Release --no-restore
+
       - name: Upload Artifacts
         uses: actions/upload-artifact@v2
         with:

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img src="https://raw.githubusercontent.com/yv989c/BlazarTech.QueryableValues/develop/docs/images/icon.png" alt="Logo" style="width: 80px;">
+    <img src="/docs/images/icon.png" alt="Logo" style="width: 80px;">
 </p>
 
 # QueryableValues
@@ -19,8 +19,7 @@ The supported types for `T` are:
 
 For a detailed explanation of the problem solved by QueryableValues, please continue reading [here][readme-background].
 
-> 💡 Still on Entity Framework 6 (non-core)?
-> [This Stack Overflow answer](https://stackoverflow.com/a/70587979/2206145) may be helpful.
+> 💡 Still on Entity Framework 6 (non-core)? Then [QueryableValues `EF6 Edition`](https://github.com/yv989c/BlazarTech.QueryableValues.EF6) is what you need.
 
 ## When Should You Use It?
 The `AsQueryableValues` extension method is intended for queries that are dependent upon a *non-constant* sequence of external values. In such cases, the underlying SQL query will be efficient on subsequent executions.
@@ -92,10 +91,12 @@ public class Startup
 
 ## How Do You Use It?
 The `AsQueryableValues` extension method is provided by the `BlazarTech.QueryableValues` namespace; therefore, you must add the following `using` directive to your source code file for it to appear as a method of your [DbContext] instance:
-```
+```c#
 using BlazarTech.QueryableValues;
 ```
 
+> 💡 If you access your [DbContext] via an interface, you can also make the `AsQueryableValues` extension methods available on it by inheriting from the `IQueryableValuesEnabledDbContext` interface.
+
 Below are a few examples composing a query using the values provided by an [IEnumerable&lt;T&gt;].
 
 ### Simple Type Examples

Version.xml

@@ -1,9 +1,8 @@
 <Project>
 	<PropertyGroup>
-		<VersionEFCore3>3.4.0</VersionEFCore3>
-		<VersionEFCore5>5.4.0</VersionEFCore5>
-		<VersionEFCore6>6.4.0</VersionEFCore6>
-		<VersionEFCore7>7.0.0-preview.1</VersionEFCore7>
+		<VersionEFCore3>3.5.0</VersionEFCore3>
+		<VersionEFCore5>5.5.0</VersionEFCore5>
+		<VersionEFCore6>6.5.0</VersionEFCore6>
+		<VersionEFCore7>7.0.0-preview.2</VersionEFCore7>
 	</PropertyGroup>
-	<!--d0816a78-e3a1-44f1-9548-f02338ca15ef-->
 </Project>

docs/README.md

@@ -15,8 +15,7 @@ The supported types for `T` are:
 
 For a detailed explanation of the problem solved by QueryableValues, please continue reading [here][readme-background].
 
-> 💡 Still on Entity Framework 6 (non-core)?
-> [This Stack Overflow answer](https://stackoverflow.com/a/70587979/2206145) may be helpful.
+> 💡 Still on Entity Framework 6 (non-core)? Then [QueryableValues `EF6 Edition`](https://github.com/yv989c/BlazarTech.QueryableValues.EF6) is what you need.
 
 ## When Should You Use It?
 The `AsQueryableValues` extension method is intended for queries that are dependent upon a *non-constant* sequence of external values. In such cases, the underlying SQL query will be efficient on subsequent executions.
@@ -88,10 +87,12 @@ public class Startup
 
 ## How Do You Use It?
 The `AsQueryableValues` extension method is provided by the `BlazarTech.QueryableValues` namespace; therefore, you must add the following `using` directive to your source code file for it to appear as a method of your [DbContext] instance:
-```
+```c#
 using BlazarTech.QueryableValues;
 ```
 
+> 💡 If you access your [DbContext] via an interface, you can also make the `AsQueryableValues` extension methods available on it by inheriting from the `IQueryableValuesEnabledDbContext` interface.
+
 Below are a few examples composing a query using the values provided by an [IEnumerable<T>].
 
 ### Simple Type Examples

src/QueryableValues.SqlServer/IQueryableValuesEnabledDbContext.cs

@@ -0,0 +1,17 @@
+#if EFCORE
+using Microsoft.EntityFrameworkCore;
+
+namespace BlazarTech.QueryableValues
+{
+    /// <summary>
+    /// Makes the <see cref="QueryableValuesDbContextExtensions"/> available on the type implementing this interface.
+    /// </summary>
+    /// <remarks>
+    /// Useful when your <see cref="DbContext"/> is behind an interface.
+    /// You can implement <see cref="IQueryableValuesEnabledDbContext"/> on that interface to make the <see cref="QueryableValuesDbContextExtensions"/> available on it.
+    /// </remarks>
+    public interface IQueryableValuesEnabledDbContext
+    {
+    }
+}
+#endif

src/QueryableValues.SqlServer/QueryableValuesDbContextExtensions.cs

@@ -181,11 +181,11 @@ public static IQueryable<DateTimeOffset> AsQueryableValues(this DbContext dbCont
         /// </summary>
         /// <param name="dbContext">The <see cref="DbContext"/> owning the query.</param>
         /// <param name="values">The sequence of values to compose.</param>
-        /// <param name="isUnicode">If <c>true</c>, will cast the <paramref name="values"/> as <c>nvarchar</c>, otherwise, <c>varchar</c>.</param>
+        /// <param name="isUnicode">If <see langword="true"/>, will cast the <paramref name="values"/> as <c>nvarchar</c>, otherwise, <c>varchar</c>.</param>
         /// <returns>An <see cref="IQueryable{Char}">IQueryable&lt;char&gt;</see> that can be composed with other entities in the query.</returns>
         /// <remarks>
         /// About Performance: If the result is going to be composed against the property of an entity that uses 
-        /// unicode (<c>nvarchar</c>), then <paramref name="isUnicode"/> should be <c>true</c>.
+        /// unicode (<c>nvarchar</c>), then <paramref name="isUnicode"/> should be <see langword="true"/>.
         /// Failing to do this may force SQL Server's query engine to do an implicit casting, which results 
         /// in a scan instead of an index seek (assuming there's a covering index).
         /// </remarks>
@@ -202,11 +202,11 @@ public static IQueryable<char> AsQueryableValues(this DbContext dbContext, IEnum
         /// </summary>
         /// <param name="dbContext">The <see cref="DbContext"/> owning the query.</param>
         /// <param name="values">The sequence of values to compose.</param>
-        /// <param name="isUnicode">If <c>true</c>, will cast the <paramref name="values"/> as <c>nvarchar</c>, otherwise, <c>varchar</c>.</param>
+        /// <param name="isUnicode">If <see langword="true"/>, will cast the <paramref name="values"/> as <c>nvarchar</c>, otherwise, <c>varchar</c>.</param>
         /// <returns>An <see cref="IQueryable{String}">IQueryable&lt;string&gt;</see> that can be composed with other entities in the query.</returns>
         /// <remarks>
         /// About Performance: If the result is going to be composed against the property of an entity that uses 
-        /// unicode (<c>nvarchar</c>), then <paramref name="isUnicode"/> should be <c>true</c>.
+        /// unicode (<c>nvarchar</c>), then <paramref name="isUnicode"/> should be <see langword="true"/>.
         /// Failing to do this may force SQL Server's query engine to do an implicit casting, which results 
         /// in a scan instead of an index seek (assuming there's a covering index).
         /// </remarks>