Split mediator into two packages: abstractions & full implementation (#37)

* add abstraction package

* update README.md

Author: hasanxdev

.github/workflows/build-release.yml

@@ -51,10 +51,14 @@ jobs:
         if: startsWith(github.ref, 'refs/tags/v')
         run: echo "version=${GITHUB_REF#refs/tags/v}" >> "$GITHUB_OUTPUT"
 
-      - name: Pack project
+      - name: Pack DispatchR project
         if: startsWith(github.ref, 'refs/tags/v')
         run: dotnet pack src/DispatchR/DispatchR.csproj --configuration Release --no-build -o ./nupkgs /p:PackageVersion=${{ steps.get_version.outputs.version }}
 
+      - name: Pack DispatchR Abstractions project
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: dotnet pack src/DispatchR.Abstractions/DispatchR.Abstractions.csproj --configuration Release --no-build -o ./nupkgs /p:PackageVersion=${{ steps.get_version.outputs.version }}
+
       - name: Push to NuGet
         if: startsWith(github.ref, 'refs/tags/v')
         run: dotnet nuget push "./nupkgs/*.nupkg" --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json

DispatchR.sln

@@ -43,6 +43,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DispatchR.IntegrationTest",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DispatchR.TestCommon", "tests\DispatchR.TestCommon\DispatchR.TestCommon.csproj", "{F01B6563-64D0-4316-947C-AB75426D9924}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DispatchR.Abstractions", "src\DispatchR.Abstractions\DispatchR.Abstractions.csproj", "{27CFB785-B631-4044-AA90-4B21FA908C0A}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -173,6 +175,18 @@ Global
 		{F01B6563-64D0-4316-947C-AB75426D9924}.Release|x64.Build.0 = Release|Any CPU
 		{F01B6563-64D0-4316-947C-AB75426D9924}.Release|x86.ActiveCfg = Release|Any CPU
 		{F01B6563-64D0-4316-947C-AB75426D9924}.Release|x86.Build.0 = Release|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Debug|x64.Build.0 = Debug|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Debug|x86.Build.0 = Debug|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Release|Any CPU.Build.0 = Release|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Release|x64.ActiveCfg = Release|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Release|x64.Build.0 = Release|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Release|x86.ActiveCfg = Release|Any CPU
+		{27CFB785-B631-4044-AA90-4B21FA908C0A}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -191,5 +205,6 @@ Global
 		{806030F5-86B1-4EFC-923C-94FF7D32DFC9} = {7F7601D5-C62E-4EA3-8B71-E946A62B4529}
 		{D8646A62-9FE7-4E79-861C-49391007F98A} = {7F7601D5-C62E-4EA3-8B71-E946A62B4529}
 		{F01B6563-64D0-4316-947C-AB75426D9924} = {7F7601D5-C62E-4EA3-8B71-E946A62B4529}
+		{27CFB785-B631-4044-AA90-4B21FA908C0A} = {89F559F6-C217-4D24-9A2F-DF25AE215A7C}
 	EndGlobalSection
 EndGlobal

README.md

@@ -1,4 +1,4 @@
-# DispatchR 🚀
+# <img src="./icon-mini.png" width="25">ispatchR 🚀
 
 ![CI](https://github.com/hasanxdev/DispatchR/workflows/Release/badge.svg)
 [![codecov](https://codecov.io/github/hasanxdev/dispatchr/graph/badge.svg?token=1FUG5DPUOE)](https://codecov.io/github/hasanxdev/dispatchr)
@@ -33,6 +33,15 @@
         2. `INotificationHandler<TRequestEvent>`
 > :bulb: **Tip:** *If you're looking for a mediator with the raw performance of hand-written code, DispatchR is built for you.*
 
+## ✨ How to install?
+```
+dotnet add package DispatchR.Mediator
+```
+You can also separately add only the abstractions, which include the interfaces, in another layer:
+```
+dotnet add package DispatchR.Mediator.Abstractions
+```
+
 # Syntax Comparison: DispatchR vs MediatR
 
 ###### In the following, you will see the key differences and implementation details between MediatR and DispatchR.
@@ -369,11 +378,6 @@ builder.Services.AddScoped<INotificationHandler<Event>, EventHandler>();
 2. Manual registration allows for custom pipeline or notification ordering
 3. You can implement custom reflection if needed
 
-## ✨ How to install?
-```
-dotnet add package DispatchR.Mediator
-```
-
 # 🧪 Bechmark Result:
 > [!IMPORTANT]
 > This benchmark was conducted using MediatR version 12.5.0 and the stable release of Mediator Source Generator, version 2.1.7.

icon-mini.png

@@ -1,4 +1,4 @@
-using DispatchR.Requests.Send;
+using DispatchR.Abstractions.Send;
 
 namespace AspireModularSample.Modules
 {

icon.jpg

@@ -1,4 +1,4 @@
-using DispatchR.Requests.Send;
+using DispatchR.Abstractions.Send;
 
 namespace AspireModularSample.Modules
 {

src/AspireModularExample/AspireModularSample.Modules/Ping.cs

@@ -1,8 +1,7 @@
 using System.Reflection;
 using AspireModularSample.Modules;
+using DispatchR;
 using DispatchR.Extensions;
-using DispatchR.Requests;
-using DispatchR.Requests.Send;
 
 var builder = WebApplication.CreateBuilder(args);
 

src/AspireModularExample/AspireModularSample.Modules/Pong.cs

@@ -1,7 +1,7 @@
 using System.Reflection;
 using AspireModularSample.Modules;
+using DispatchR;
 using DispatchR.Extensions;
-using DispatchR.Requests;
 
 var builder = WebApplication.CreateBuilder(args);
 

src/AspireModularExample/AspireModularSample.ServiceA/Program.cs

@@ -5,7 +5,7 @@ namespace Benchmark.Notification.MultiHandlers;
 public sealed class MultiHandler0
     : INotificationHandler<MultiHandlersNotification>,
         MediatR.INotificationHandler<MultiHandlersNotification>,
-        DispatchR.Requests.Notification.INotificationHandler<MultiHandlersNotification>
+        DispatchR.Abstractions.Notification.INotificationHandler<MultiHandlersNotification>
 {
     public ValueTask Handle(MultiHandlersNotification notification, CancellationToken cancellationToken) => default;