Merge pull request #5 from yv989c/feature/new-types

Feature/new types

Author: yv989c

README.md

@@ -1,8 +1,8 @@
 <Project>
 	<PropertyGroup>
-		<VersionEFCore3>3.2.0</VersionEFCore3>
-		<VersionEFCore5>5.2.0</VersionEFCore5>
-		<VersionEFCore6>6.2.0</VersionEFCore6>
+		<VersionEFCore3>3.3.0</VersionEFCore3>
+		<VersionEFCore5>5.3.0</VersionEFCore5>
+		<VersionEFCore6>6.3.0</VersionEFCore6>
 	</PropertyGroup>
 	<!--4a1164f5-e747-41d5-b575-cbd08bdbedbd-->
 </Project>

Version.xml

@@ -1,36 +1,36 @@
 # QueryableValues
 
-This library allows us to efficiently compose an [IEnumerable<T>] in our [Entity Framework Core] queries when using the [SQL Server Database Provider]. This is done by using the `AsQueryableValues` extension method that is made available on the [DbContext] class. Everything is evaluated on the server with a single roundtrip, in a way that preserves the query's [execution plan], even when the values behind the [IEnumerable<T>] are changed on subsequent executions.
+This library allows you to efficiently compose an [IEnumerable<T>] in your [Entity Framework Core] queries when using the [SQL Server Database Provider]. This is accomplished by using the `AsQueryableValues` extension method available on the [DbContext] class. Everything is evaluated on the server with a single round trip, in a way that preserves the query's [execution plan], even when the values behind the [IEnumerable<T>] are changed on subsequent executions.
 
 The supported types for `T` are:
-- Simple Type: [Int32], [Int64], [Decimal], [Double], [DateTime], [DateTimeOffset], [Guid], and [String].
+- Simple Type: [Byte], [Int16], [Int32], [Int64], [Decimal], [Single], [Double], [DateTime], [DateTimeOffset], [Guid], [Char], and [String].
 - Complex Type:
   - Can be an anonymous type.
-  - Can be a user defined class or struct, with read/write properties and a public constructor.
-  - Must have one or more simple type properties.
+  - Can be a user-defined class or struct with read/write properties and a public constructor.
+  - Must have one or more simple type properties, including [Boolean].
 
 For a detailed explanation, please continue reading [here][readme-background].
 
-## When Should I Use It?
-The `AsQueryableValues` extension method is intended for queries that are dependent on a *non-constant* sequence of external values. In this case, the underline SQL query will be efficient on subsequent executions.
+## 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.
 
-It provides a solution to the following long standing EF Core [issue](https://github.com/dotnet/efcore/issues/13617) and enables other currently unsupported scenarios; like the ability to efficiently create joins with in-memory data.
+It provides a solution to the following long standing [EF Core issue](https://github.com/dotnet/efcore/issues/13617) and enables other currently unsupported scenarios; like the ability to efficiently create joins with in-memory data.
 
 ## Getting Started
 
 ### Installation
-QueryableValues is distributed as a [NuGet Package]. The major version number of this library is aligned with the version of [Entity Framework Core] that's supported by it; for example, if you are using EF Core 5, then you must use version 5 of QueryableValues.
+QueryableValues is distributed as a [NuGet Package]. The major version number of this library is aligned with the version of [Entity Framework Core] by which it's supported (e.g. If you are using EF Core 5, then you must use version 5 of QueryableValues).
 
 Please choose the appropriate command below to install it using the NuGet Package Manager Console window in Visual Studio:
 
 EF Core | Command
 :---: | ---
-3.x | `Install-Package BlazarTech.QueryableValues.SqlServer -Version 3.2.0`
-5.x | `Install-Package BlazarTech.QueryableValues.SqlServer -Version 5.2.0`
-6.x | `Install-Package BlazarTech.QueryableValues.SqlServer -Version 6.2.0`
+3.x | `Install-Package BlazarTech.QueryableValues.SqlServer -Version 3.3.0`
+5.x | `Install-Package BlazarTech.QueryableValues.SqlServer -Version 5.3.0`
+6.x | `Install-Package BlazarTech.QueryableValues.SqlServer -Version 6.3.0`
 
 ### Configuration
-Look for the place in your code where you are setting up your [DbContext] and calling the [UseSqlServer] extension method, then use a lambda expression to access the `SqlServerDbContextOptionsBuilder` provided by it. It is on this builder that you must call the `UseQueryableValues` extension method, as shown in the following simplified examples:
+Look for the place in your code where you are setting up your [DbContext] and calling the [UseSqlServer] extension method, then use a lambda expression to access the `SqlServerDbContextOptionsBuilder` provided by it. It is on this builder that you must call the `UseQueryableValues` extension method as shown in the following simplified examples:
 
 When using the `OnConfiguring` method inside your [DbContext]:
 ```c#
@@ -71,13 +71,13 @@ public class Startup
 }
 ```
 
-### How Do I 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 in order for it to appear as a method of your [DbContext] instance:
+### 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:
 ```
 using BlazarTech.QueryableValues;
 ```
 
-Below you can find a few examples composing a query using the values provided by an [IEnumerable<T>].
+Below are a few examples composing a query using the values provided by an [IEnumerable<T>].
 
 #### Simple Type Examples
 Using the [Contains][ContainsQueryable] LINQ method:
@@ -138,10 +138,11 @@ var myQuery2 =
         i.PropA
     });
 ```
-#### Complex Type Examples
+#### Complex Type Example
 ```c#
-// If your IEnumerable<T> variable's item type is a complex type with many properties,
-// project only what you need to a new variable and use it in your query.
+// Performance Tip:
+// If your IEnumerable<T> item type (T) has many properties, project only 
+// the ones you need to a new variable and use it in your query.
 var projectedItems = items.Select(i => new { i.CategoryId, i.ColorName });
 
 var myQuery = 
@@ -154,12 +155,12 @@ var myQuery =
     };
 ```
 **About Complex Types**
-> :warning: All the data provided by this type is transmitted to the server, therefore, ensure that it only contains the properties that you need for your query. Not following this recommendation will degrade the query's performance.
+> :warning: All the data provided by this type is transmitted to the server; therefore, ensure that it only contains the properties you need for your query. Not following this recommendation will degrade the query's performance.
 
-> :warning: There is a limit of up to ten properties for any given simple type (e.g., cannot have more than ten [Int32] properties). Exceeding that limit will cause an exception and may also be a sign that you should rethink your strategy.
+> :warning: There is a limit of up to 10 properties for any given simple type (e.g. cannot have more than 10 [Int32] properties). Exceeding that limit will cause an exception and may also suggest that you should rethink your strategy.
 
-## Do You Want to Know More? 📚
-Please take a look at the repository [here](https://github.com/yv989c/BlazarTech.QueryableValues).
+## Do You Want To Know More? 📚
+Please take a look at the [repository](https://github.com/yv989c/BlazarTech.QueryableValues).
 
 
 [Entity Framework Core]: https://docs.microsoft.com/en-us/ef/core/
@@ -176,11 +177,16 @@ Please take a look at the repository [here](https://github.com/yv989c/BlazarTech
 [NuGet Package]: https://www.nuget.org/packages/BlazarTech.QueryableValues.SqlServer/
 [readme-background]: https://github.com/yv989c/BlazarTech.QueryableValues#background-
 [execution plan]: https://docs.microsoft.com/en-us/sql/relational-databases/query-processing-architecture-guide?#execution-plan-caching-and-reuse
+[Boolean]: https://docs.microsoft.com/en-us/dotnet/api/system.boolean
+[Byte]: https://docs.microsoft.com/en-us/dotnet/api/system.byte
+[Int16]: https://docs.microsoft.com/en-us/dotnet/api/system.int16
 [Int32]: https://docs.microsoft.com/en-us/dotnet/api/system.int32
 [Int64]: https://docs.microsoft.com/en-us/dotnet/api/system.int64
 [Decimal]: https://docs.microsoft.com/en-us/dotnet/api/system.decimal
+[Single]: https://docs.microsoft.com/en-us/dotnet/api/system.single
 [Double]: https://docs.microsoft.com/en-us/dotnet/api/system.double
 [DateTime]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime
 [DateTimeOffset]: https://docs.microsoft.com/en-us/dotnet/api/system.datetimeoffset
 [Guid]: https://docs.microsoft.com/en-us/dotnet/api/system.guid
+[Char]: https://docs.microsoft.com/en-us/dotnet/api/system.char
 [String]: https://docs.microsoft.com/en-us/dotnet/api/system.string

docs/README.md

@@ -52,7 +52,7 @@ public PropertyOptionsBuilder<TProperty> Property<TProperty>(Expression<Func<T,
         }
 
         /// <summary>
-        /// Sets the default behavior for the handling of unicode characters in <see cref="string"/> properties.
+        /// Sets the default behavior for the handling of unicode characters in <see cref="char"/> and <see cref="string"/> properties.
         /// </summary>
         /// <param name="isUnicode">A value indicating whether support for unicode characters is enabled by default.</param>
         /// <returns>The same builder instance so that multiple configuration calls can be chained.</returns>

src/QueryableValues.SqlServer/Builders/EntityOptionsBuilder.cs

@@ -23,16 +23,21 @@ internal PropertyOptionsBuilder(MemberInfo memberInfo)
         }
 
         /// <summary>
-        /// Configures the property as capable of handling unicode characters. Can only be set on <see cref="string"/> properties.
+        /// Configures the property as capable of handling unicode characters. Can only be set on <see cref="char"/> and <see cref="string"/> properties.
         /// </summary>
         /// <param name="isUnicode">A value indicating whether the property can handle unicode characters.</param>
         /// <returns>The same builder instance so that multiple configuration calls can be chained.</returns>
         /// <exception cref="InvalidOperationException"></exception>
         public PropertyOptionsBuilder<TProperty> IsUnicode(bool isUnicode = true)
         {
-            if (typeof(TProperty) != typeof(string))
+            var isValidType =
+                typeof(TProperty) == typeof(string) ||
+                typeof(TProperty) == typeof(char) ||
+                typeof(TProperty) == typeof(char?);
+
+            if (!isValidType)
             {
-                throw new InvalidOperationException("This method can only be used on String properties.");
+                throw new InvalidOperationException("This method can only be used on Char and String properties.");
             }
 
             _isUnicode = isUnicode;

src/QueryableValues.SqlServer/Builders/PropertyOptionsBuilder.cs

@@ -74,6 +74,18 @@ public long ToInt64(IFormatProvider? provider)
         public ulong ToUInt64(IFormatProvider? provider) => throw new NotImplementedException();
     }
 
+    internal sealed class DeferredByteValues : DeferredValues<byte>
+    {
+        public DeferredByteValues(IEnumerable<byte> values) : base(values) { }
+        public override string ToString(IFormatProvider? provider) => XmlUtil.GetXml(_values);
+    }
+
+    internal sealed class DeferredInt16Values : DeferredValues<short>
+    {
+        public DeferredInt16Values(IEnumerable<short> values) : base(values) { }
+        public override string ToString(IFormatProvider? provider) => XmlUtil.GetXml(_values);
+    }
+
     internal sealed class DeferredInt32Values : DeferredValues<int>
     {
         public DeferredInt32Values(IEnumerable<int> values) : base(values) { }
@@ -92,6 +104,12 @@ public DeferredDecimalValues(IEnumerable<decimal> values) : base(values) { }
         public override string ToString(IFormatProvider? provider) => XmlUtil.GetXml(_values);
     }
 
+    internal sealed class DeferredSingleValues : DeferredValues<float>
+    {
+        public DeferredSingleValues(IEnumerable<float> values) : base(values) { }
+        public override string ToString(IFormatProvider? provider) => XmlUtil.GetXml(_values);
+    }
+
     internal sealed class DeferredDoubleValues : DeferredValues<double>
     {
         public DeferredDoubleValues(IEnumerable<double> values) : base(values) { }
@@ -116,10 +134,15 @@ public DeferredGuidValues(IEnumerable<Guid> values) : base(values) { }
         public override string ToString(IFormatProvider? provider) => XmlUtil.GetXml(_values);
     }
 
+    internal sealed class DeferredCharValues : DeferredValues<char>
+    {
+        public DeferredCharValues(IEnumerable<char> values) : base(values) { }
+        public override string ToString(IFormatProvider? provider) => XmlUtil.GetXml(_values);
+    }
+
     internal sealed class DeferredStringValues : DeferredValues<string>
     {
         public DeferredStringValues(IEnumerable<string> values) : base(values) { }
-
         public override string ToString(IFormatProvider? provider) => XmlUtil.GetXml(_values);
     }
 
@@ -133,6 +156,7 @@ public DeferredEntityValues(IEnumerable<T> values, IReadOnlyList<EntityPropertyM
         {
             _mappings = mappings;
         }
+
         public override string ToString(IFormatProvider? provider) => XmlUtil.GetXml(_values, _mappings);
     }
 }

src/QueryableValues.SqlServer/DeferredValues.cs

@@ -8,9 +8,10 @@ namespace BlazarTech.QueryableValues
 {
     internal sealed class EntityPropertyMapping
     {
+        internal static readonly IReadOnlyDictionary<Type, EntityPropertyTypeName> SimpleTypes;
+
         private static readonly PropertyInfo[] EntityProperties = typeof(QueryableValuesEntity).GetProperties();
         private static readonly ConcurrentDictionary<Type, IReadOnlyList<EntityPropertyMapping>> MappingCache = new ConcurrentDictionary<Type, IReadOnlyList<EntityPropertyMapping>>();
-        private static readonly Dictionary<Type, EntityPropertyTypeName> SimpleTypes;
 
         public PropertyInfo Source { get; }
         public PropertyInfo Target { get; }
@@ -21,13 +22,18 @@ static EntityPropertyMapping()
         {
             SimpleTypes = new Dictionary<Type, EntityPropertyTypeName>
             {
-                { typeof(int), EntityPropertyTypeName.Int },
-                { typeof(long), EntityPropertyTypeName.Long },
+                { typeof(bool), EntityPropertyTypeName.Boolean },
+                { typeof(byte), EntityPropertyTypeName.Byte },
+                { typeof(short), EntityPropertyTypeName.Int16 },
+                { typeof(int), EntityPropertyTypeName.Int32 },
+                { typeof(long), EntityPropertyTypeName.Int64 },
                 { typeof(decimal), EntityPropertyTypeName.Decimal },
+                { typeof(float), EntityPropertyTypeName.Single },
                 { typeof(double), EntityPropertyTypeName.Double },
                 { typeof(DateTime), EntityPropertyTypeName.DateTime },
                 { typeof(DateTimeOffset), EntityPropertyTypeName.DateTimeOffset },
                 { typeof(Guid), EntityPropertyTypeName.Guid },
+                { typeof(char), EntityPropertyTypeName.Char },
                 { typeof(string), EntityPropertyTypeName.String }
             };
         }

src/QueryableValues.SqlServer/EntityPropertyMapping.cs

@@ -2,13 +2,18 @@
 {
     internal enum EntityPropertyTypeName
     {
-        Int,
-        Long,
+        Boolean,
+        Byte,
+        Int16,
+        Int32,
+        Int64,
         Decimal,
+        Single,
         Double,
         DateTime,
         DateTimeOffset,
         Guid,
+        Char,
         String
     }
 }

src/QueryableValues.SqlServer/EntityPropertyTypeName.cs

@@ -37,14 +37,18 @@ private static void SetupEntity(ModelBuilder modelBuilder)
 
         public void Customize(ModelBuilder modelBuilder, DbContext context)
         {
+            SetupEntity<byte>(modelBuilder);
+            SetupEntity<short>(modelBuilder);
             SetupEntity<int>(modelBuilder);
             SetupEntity<long>(modelBuilder);
             SetupEntity<decimal>(modelBuilder);
+            SetupEntity<float>(modelBuilder);
             SetupEntity<double>(modelBuilder);
             SetupEntity<DateTime>(modelBuilder);
             SetupEntity<DateTimeOffset>(modelBuilder);
-            SetupEntity<string>(modelBuilder);
             SetupEntity<Guid>(modelBuilder);
+            SetupEntity<char>(modelBuilder);
+            SetupEntity<string>(modelBuilder);
 
             SetupEntity(modelBuilder);