bump version to 0.2.0

enable gha building and publishing to nuget
renamed to Klean.EntityFrameworkCore.DataProtection

Author: ddjerqq

.github/workflows/build.yaml .github/workflows/nuget.yaml.github/workflows/build.yaml renamed to .github/workflows/nuget.yaml

@@ -1,18 +1,15 @@
 name: Build and publish
 
 on:
-  workflow_dispatch:
-#  push:
-#    branches: [ main ]
-#  pull_request:
-#    branches: [ main ]
+  release:
+    types: [published]
 
 env:
   DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
   DOTNET_CLI_TELEMETRY_OPTOUT: true
 
 jobs:
-  build-library:
+  build-and-push-on-nuget:
     concurrency: ci-${{ github.ref }}
     runs-on: ubuntu-latest
 
@@ -47,8 +44,11 @@ jobs:
       - name: Restore 📦
         run: dotnet restore --verbosity minimal
 
+      - name: Build 🔧
+        run: dotnet build --no-restore --verbosity minimal
+
       - name: Test 🧪
-        run: dotnet test --no-restore --verbosity minimal
+        run: dotnet test --no-restore --no-build --verbosity minimal
 
       - name: Pack 📦
         run: dotnet pack --configuration Release --output .

.github/workflows/test.yaml

@@ -0,0 +1,53 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+  DOTNET_CLI_TELEMETRY_OPTOUT: true
+
+jobs:
+  test:
+    concurrency: ci-${{ github.ref }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+
+      - name: Setup .NET 🛠️
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            6.0.x
+            7.0.x
+            8.0.x
+            9.0.x
+
+      - name: Load cache 🔃
+        id: nuget-cache
+        uses: actions/cache@v4
+        with:
+          path: "~/.nuget/packages"
+          key: "${{ runner.os }}-nuget-api-${{ hashFiles('**/*.csproj') }}"
+          restore-keys: "${{ runner.os }}-nuget-api-"
+
+      - name: Cache status ✅
+        run: |
+          echo "Cache hit: ${{ steps.nuget-cache.outputs.cache-hit }}"
+
+      - name: Display .NET version 📚
+        run: dotnet --version
+
+      - name: Restore 📦
+        run: dotnet restore --verbosity minimal
+
+      - name: Build 🔧
+        run: dotnet build --no-restore --verbosity minimal
+
+      - name: Test 🧪
+        run: dotnet test --no-restore --no-build --verbosity minimal

EntityFrameworkCore.DataProtection.sln

@@ -1,12 +1,12 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "src/EntityFrameworkCore.DataProtection", "src/EntityFrameworkCore.DataProtection/EntityFrameworkCore.DataProtection.csproj", "{23817096-829D-465B-9C81-39EF87D90468}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Klean.EntityFrameworkCore.DataProtection", "src\Klean.EntityFrameworkCore.DataProtection\Klean.EntityFrameworkCore.DataProtection.csproj", "{23817096-829D-465B-9C81-39EF87D90468}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{08CF6BCC-3928-4FB6-A1A0-ABF5DE162D6C}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{6A01C6D2-B6BE-4584-897B-60710734DC66}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EntityFrameworkCore.DataProtection.Test", "test/EntityFrameworkCore.DataProtection.Test/EntityFrameworkCore.DataProtection.Test.csproj", "{AEACE4E1-D3F5-4A5D-8632-695AFDBDC020}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Klean.EntityFrameworkCore.DataProtection.Test", "test\Klean.EntityFrameworkCore.DataProtection.Test\Klean.EntityFrameworkCore.DataProtection.Test.csproj", "{AEACE4E1-D3F5-4A5D-8632-695AFDBDC020}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

README.md

@@ -1,10 +1,10 @@
-# EntityFrameworkCore.DataProtection
+# Klean.EntityFrameworkCore.DataProtection
 
-[![.NET](https://github.com/ddjerqq/EntityFrameworkCore.DataProtection/actions/workflows/build.yml/badge.svg)](https://github.com/ddjerqq/EntityFrameworkCore.DataProtection/actions/workflows/build.yml)
-[![Nuget](https://img.shields.io/nuget/v/EntityFrameworkCore.DataProtection.svg)](https://www.nuget.org/packages/EntityFrameworkCore.DataProtection)
-[![Nuget Downloads](https://img.shields.io/nuget/dt/EntityFrameworkCore.DataProtection)](https://www.nuget.org/packages/EntityFrameworkCore.DataProtection)
+[![tests](https://github.com/ddjerqq/Klean.EntityFrameworkCore.DataProtection/actions/workflows/build.yml/badge.svg)](https://github.com/ddjerqq/Klean.EntityFrameworkCore.DataProtection/actions/workflows/test.yml)
+[![Nuget](https://img.shields.io/nuget/v/Klean.EntityFrameworkCore.DataProtection.svg)](https://www.nuget.org/packages/Klean.EntityFrameworkCore.DataProtection)
+[![Nuget Downloads](https://img.shields.io/nuget/dt/Klean.EntityFrameworkCore.DataProtection)](https://www.nuget.org/packages/Klean.EntityFrameworkCore.DataProtection)
 
-`EntityFrameworkCore.DataProtection` is a [Microsoft Entity Framework Core](https://github.com/aspnet/EntityFrameworkCore) extension which
+`Klean.EntityFrameworkCore.DataProtection` is a [Microsoft Entity Framework Core](https://github.com/aspnet/EntityFrameworkCore) extension which
 adds support for data protection and querying for encrypted properties for your entities.
 
 # What problem does this library solve?
@@ -41,32 +41,22 @@ Keeping your encryption keys secure is your responsibility. If you lose your enc
 Install the package from [NuGet](https://www.nuget.org/) or from the `Package Manager Console` :
 
 ```powershell
-PM> Install-Package EntityFrameworkCore.DataProtection
+PM> Install-Package Klean.EntityFrameworkCore.DataProtection
 ```
 
 ### Configuring Data Protection in your DbContext
 
 `YourDbContext.cs`
 
 ```csharp
-//                                                vv injected from DI
 public class Your(DbContextOptions<Your> options, IDataProtectionProvider dataProtectionProvider) : DbContext(options)
 {
     public DbSet<User> Users => Set<User>();
 
     protected override void OnModelCreating(ModelBuilder builder)
     {
-        // if you are using IEntityTypeConfiguration<T> in your project
-        // then ApplyConfigurationsFromAssembly must come before base.OnModelCreating
-        builder.ApplyConfigurationsFromAssembly(typeof(YourDbContext).Assembly);
-        
         base.OnModelCreating(builder);
-        
-        //      UseDataProtection MUST come after base.OnModelCreating
         builder.UseDataProtection(dataProtectionProvider);
-        
-        // anything else you want to do with the builder must come after the call to UseDataProtection, unless you know exactly what you are doing
-        builder.SnakeCaseRename();
     }
 }
 ```
@@ -80,7 +70,13 @@ public class Your(DbContextOptions<Your> options, IDataProtectionProvider dataPr
 `Program.cs`
 
 ```csharp
-var keyDirectory = new DirectoryInfo("keys");
+builder.Services.AddDataProtectionServices();
+```
+
+To persist keys in file system use the following code:
+
+```csharp
+var keyDirectory = new DirectoryInfo("path/to/solution/.aspnet/dp/keys");
 builder.Services.AddDataProtectionServices()
     .PersistKeysToFileSystem(keyDirectory);
 ```
@@ -95,13 +91,15 @@ builder.Services.AddDataProtectionServices()
 ```csharp
 services.AddDbContext<YourDbContext>(opt => opt
     .AddDataProtectionInterceptors()
-    .UseSqlite()); // or anything else
+    /* ... */);
 ```
 
 > [!WARNING]
-> You **MUST** call `AddDataProtectionInterceptors` if you are using any encrypted properties marked as queryable in your entities.
+> You **MUST** call `AddDataProtectionInterceptors` if you are using any encrypted properties that are queryable in your entities.
 > If you are not using any queryable encrypted properties, you can skip this step.
 
+## Usage:
+
 ### Marking your properties as encrypted
 
 There are three ways you can mark your properties as encrypted:
@@ -110,7 +108,6 @@ Using the EncryptedAttribute:
 ```csharp
 class User
 {
-  //       v default           v default
   [Encrypt(IsQueryable = true, IsUnique = true)]
   public string SocialSecurityNumber { get; set; }
 
@@ -136,21 +133,11 @@ protected override void OnModelCreating(ModelBuilder builder)
 }
 ```
 
-Creating a custom `EntityTypeConfiguration` (Recommended for DDD):
-```csharp
-class UserConfiguration : IEntityTypeConfiguration<User>
-{
-  public void Configure(EntityTypeBuilder<User> builder)
-  {
-    builder.Property(e => e.SocialSecurityNumber).IsEncryptedQueryable();
-    builder.Property(e => e.IdPicture).IsEncrypted();
-  }
-}
-```
+The above step also applies to custom `EntityTypeConfiguration`s
 
 ### Querying encrypted properties
 
-You can query encrypted properties that are marked as Queryable using the `QueryableExt.WherePdEquals` extension method:
+You can query encrypted properties that are marked as Queryable using the `IQueryable<T>.WherePdEquals` extension method:
 
 ```csharp
 var foo = await DbContext.Users
@@ -159,11 +146,14 @@ var foo = await DbContext.Users
 ```
 
 > [!WARNING]
-> The `QueryableExt.WherePdEquals` method is only available for properties that are marked as Queryable using the `[Encrypt(isQueryable: true)]` attribute or the
-> `IsEncrypted(isQueryable: true)` method.
-> And before using `WherePdEquals` you **MUST** call `AddDataProtectionInterceptors` in your `DbContext` configuration.
+> The `QueryableExt.WherePdEquals` method is only available for properties that are marked as Queryable using the `[Encrypt(IsQueryable = true)]` attribute or the
+> `IsEncryptedQueryable()` method.
 
-> [!TIP]
+> [!CAUTION]
+> Before using `WherePdEquals` you **MUST** call `AddDataProtectionInterceptors` in your `DbContext` configuration.
+> There will be no error if you forget to call `AddDataProtectionInterceptors`, but the query will not work as expected.
+
+> [!NOTE]
 > The `WherePdEquals` extension method generates an expression like this one under the hood:<br/>
 > `Where(e => EF.Property<string>(e, $"{propertyName}ShadowHash") == value.Sha256Hash())`
 

…kCore.DataProtection/EncryptAttribute.cs …kCore.DataProtection/EncryptAttribute.cssrc/EntityFrameworkCore.DataProtection/EncryptAttribute.cs renamed to src/Klean.EntityFrameworkCore.DataProtection/EncryptAttribute.cs src/EntityFrameworkCore.DataProtection/EncryptAttribute.cs renamed to src/Klean.EntityFrameworkCore.DataProtection/EncryptAttribute.cs

@@ -47,7 +47,7 @@ public static class ModelBuilderExt
     /// </exception>
     public static ModelBuilder UseDataProtection(this ModelBuilder builder, IDataProtectionProvider dataProtectionProvider)
     {
-        var protector = dataProtectionProvider.CreateProtector("EntityFrameworkCore.DataProtection");
+        var protector = dataProtectionProvider.CreateProtector("Klean.EntityFrameworkCore.DataProtection");
 
         var properties = (
                 from entityType in builder.Model.GetEntityTypes()

…Extensions/DbContextOptionsBuilderExt.cs …Extensions/DbContextOptionsBuilderExt.cssrc/EntityFrameworkCore.DataProtection/Extensions/DbContextOptionsBuilderExt.cs renamed to src/Klean.EntityFrameworkCore.DataProtection/Extensions/DbContextOptionsBuilderExt.cs src/EntityFrameworkCore.DataProtection/Extensions/DbContextOptionsBuilderExt.cs renamed to src/Klean.EntityFrameworkCore.DataProtection/Extensions/DbContextOptionsBuilderExt.cs

@@ -9,13 +9,13 @@ namespace EntityFrameworkCore.DataProtection.Extensions;
 /// </summary>
 public static class PropertyBuilderExt
 {
-    private const string IsEncryptedAnnotationName = "EntityFrameworkCore.DataProtection.IsEncrypted";
-    private const string IsQueryableAnnotationName = "EntityFrameworkCore.DataProtection.IsQueryable";
-    private const string IsUniqueIndexAnnotationName = "EntityFrameworkCore.DataProtection.IsUniqueIndex";
+    private const string IsEncryptedAnnotationName = "Klean.EntityFrameworkCore.DataProtection.IsEncrypted";
+    private const string IsQueryableAnnotationName = "Klean.EntityFrameworkCore.DataProtection.IsQueryable";
+    private const string IsUniqueIndexAnnotationName = "Klean.EntityFrameworkCore.DataProtection.IsUniqueIndex";
 
     internal static readonly InvalidOperationException InvalidTypeException =
         new("Only string and byte[] properties are supported for now. " +
-            "Please open an issue on https://github.com/ddjerqq/EntityFrameworkCore.DataProtection/issues to request a new feature");
+            "Please open an issue on https://github.com/ddjerqq/Klean.EntityFrameworkCore.DataProtection/issues to request a new feature");
 
     /// <summary>
     /// Marks the property as encrypted.