Add the UseRazorEmailTemplates() extension method.

Author: GillesTourreau

src/Emailing.Azure/AzureEmailingBuilderExtensions.cs

@@ -25,9 +25,10 @@ public static class AzureEmailingBuilderExtensions
         /// <param name="builder"><see cref="EmailingBuilder"/> which to configure.</param>
         /// <param name="uri">Uri to the the <c>Azure Communication Service</c> instance.</param>
         /// <param name="clientBuilder">Allows to configure the <see cref="EmailClient"/> used by the provider.</param>
+        /// <returns>The <paramref name="builder"/> instance to continue the configuration of the emailing feature.</returns>
         /// <exception cref="ArgumentNullException">Thrown when the <paramref name="builder"/> argument is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentNullException">Thrown when the <paramref name="uri"/> argument is <see langword="null"/>.</exception>
-        public static void UseAzureCommunicationService(this EmailingBuilder builder, Uri uri, Action<IAzureClientBuilder<EmailClient, EmailClientOptions>>? clientBuilder = null)
+        public static EmailingBuilder UseAzureCommunicationService(this EmailingBuilder builder, Uri uri, Action<IAzureClientBuilder<EmailClient, EmailClientOptions>>? clientBuilder = null)
         {
             ArgumentNullException.ThrowIfNull(builder);
             ArgumentNullException.ThrowIfNull(uri);
@@ -43,6 +44,8 @@ public static void UseAzureCommunicationService(this EmailingBuilder builder, Ur
                     clientBuilder(emailClientBuilder);
                 }
             });
+
+            return builder;
         }
 
         /// <summary>
@@ -51,9 +54,10 @@ public static void UseAzureCommunicationService(this EmailingBuilder builder, Ur
         /// <param name="builder"><see cref="EmailingBuilder"/> which to configure.</param>
         /// <param name="connectionString">Connection string to the <c>Azure Communication Service</c> instance.</param>
         /// <param name="clientBuilder">Allows to configure the <see cref="EmailClient"/> used by the provider.</param>
+        /// <returns>The <paramref name="builder"/> instance to continue the configuration of the emailing feature.</returns>
         /// <exception cref="ArgumentNullException">Thrown when the <paramref name="builder"/> argument is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentNullException">Thrown when the <paramref name="connectionString"/> argument is <see langword="null"/>.</exception>
-        public static void UseAzureCommunicationService(this EmailingBuilder builder, string connectionString, Action<IAzureClientBuilder<EmailClient, EmailClientOptions>>? clientBuilder = null)
+        public static EmailingBuilder UseAzureCommunicationService(this EmailingBuilder builder, string connectionString, Action<IAzureClientBuilder<EmailClient, EmailClientOptions>>? clientBuilder = null)
         {
             ArgumentNullException.ThrowIfNull(builder);
             ArgumentNullException.ThrowIfNull(connectionString);
@@ -69,6 +73,8 @@ public static void UseAzureCommunicationService(this EmailingBuilder builder, st
                     clientBuilder(emailClientBuilder);
                 }
             });
+
+            return builder;
         }
     }
 }

src/Emailing.Graph/GraphEmailingBuilderExtensions.cs

@@ -24,9 +24,10 @@ public static class GraphEmailingBuilderExtensions
         /// <param name="builder"><see cref="EmailingBuilder"/> which to configure.</param>
         /// <param name="tokenCredential">The <see cref="TokenCredential"/> for authenticating to Microsoft Graph API.</param>
         /// <param name="baseUrl">The base service URL of the API Graph. If not specified the <c>https://graph.microsoft.com/v1.0</c> will be use.</param>
+        /// <returns>The <paramref name="builder"/> instance to continue the configuration of the emailing feature.</returns>
         /// <exception cref="ArgumentNullException">Thrown when the <paramref name="builder"/> argument is <see langword="null"/>.</exception>
         /// <exception cref="ArgumentNullException">Thrown when the <paramref name="tokenCredential"/> argument is <see langword="null"/>.</exception>
-        public static void UseGraph(this EmailingBuilder builder, TokenCredential tokenCredential, string? baseUrl = null)
+        public static EmailingBuilder UseGraph(this EmailingBuilder builder, TokenCredential tokenCredential, string? baseUrl = null)
         {
             ArgumentNullException.ThrowIfNull(builder);
             ArgumentNullException.ThrowIfNull(tokenCredential);
@@ -37,6 +38,8 @@ public static void UseGraph(this EmailingBuilder builder, TokenCredential tokenC
 
                 return new GraphEmailProvider(serviceClient);
             });
+
+            return builder;
         }
     }
 }

src/Emailing.Templates.Razor/README.md

@@ -10,8 +10,8 @@ provides helpers to create `EmailTemplate<TModel>` instances using Razor compone
 
 It is built on top of:
 
-- [PosInformatique.Foundations.Emailing](https://www.nuget.org/packages/PosInformatique.Foundations.Emailing.Templates.Razor/)
-- [PosInformatique.Foundations.Text.Templates.Razor](https://www.nuget.org/packages/PosInformatique.Foundations.Emailing.Templates.Razor/)
+- [PosInformatique.Foundations.Emailing](https://www.nuget.org/packages/PosInformatique.Foundations.Emailing/)
+- [PosInformatique.Foundations.Text.Templates.Razor](https://www.nuget.org/packages/PosInformatique.Foundations.Text.Templating.Razor/)
 
 This allows you to design your email content with Blazor-style Razor components, benefiting from layout reuse, strongly-typed models, and familiar Razor syntax.
 
@@ -33,10 +33,30 @@ You also need a Blazor-compatible environment for compiling/executing Razor comp
   - `RazorEmailTemplateBody<TModel>` for email HTML body.
 - Strongly-typed model support via the `Model` parameter.
 - Supports Razor layout features for the email body (reuse consistent layout across multiple templates).
+- `UseRazorEmailTemplates()` extension method to enable Razor-based email templates in the emailing configuration.
 
-## Creating Razor components for subject and body
+## Configuring emailing with Razor email templates
 
-### 1. Define the email model
+### 1. Configure emailing services
+
+Use `AddEmailing(...)` and then `UseRazorEmailTemplates()`.
+
+```csharp
+using Microsoft.Extensions.DependencyInjection;
+
+var services = new ServiceCollection();
+
+var emailingBuilder = services.AddEmailing(options =>
+{
+    // Configure emailing options here and register the templates
+})
+UseRazorEmailTemplates();.
+```
+
+- `AddEmailing(...)` registers the core emailing services and the templates.
+- `UseRazorEmailTemplates()` enables Razor-based text templating for emailing.
+
+### 2. Define the email model
 
 Example model used by the templates:
 
@@ -50,7 +70,7 @@ public sealed class InvitationEmailTemplateModel
 }
 ```
 
-### 2. Subject component
+### 3. Subject component
 
 Create a Razor component for the subject that inherits from `RazorEmailTemplateSubject<TModel>` and uses the `Model` parameter.
 
@@ -69,7 +89,7 @@ This component:
 - Renders a single line of text.
 - Uses the strongly-typed `Model` to build the subject.
 
-### 3. Body component with layout
+### 4. Body component with layout
 
 You can define a layout component that centralizes common HTML structure (header, footer, styles, etc.),
 then reuse it across different email bodies.
@@ -85,33 +105,33 @@ then reuse it across different email bodies.
     <meta charset="utf-8" />
     <title>@Title</title>
     <style>
-        body {
-            font-family: Arial, sans-serif;
-            font-size: 14px;
-        }
-
-        .email-container {
-            max-width: 600px;
-            margin: 0 auto;
-        }
-
-        .email-header {
-            background-color: #1f2937;
-            color: #ffffff;
-            padding: 16px;
-            font-size: 18px;
-            font-weight: bold;
-        }
-
-        .email-content {
-            padding: 16px;
-        }
-
-        .email-footer {
-            padding: 16px;
-            font-size: 12px;
-            color: #6b7280;
-        }
+    body {
+        font-family: Arial, sans-serif;
+        font-size: 14px;
+    }
+
+    .email-container {
+        max-width: 600px;
+        margin: 0 auto;
+    }
+
+    .email-header {
+        background-color: #1f2937;
+        color: #ffffff;
+        padding: 16px;
+        font-size: 18px;
+        font-weight: bold;
+    }
+
+    .email-content {
+        padding: 16px;
+    }
+
+    .email-footer {
+        padding: 16px;
+        font-size: 12px;
+        color: #6b7280;
+    }
     </style>
 </head>
 <body>

src/Emailing.Templates.Razor/RazorEmailTemplateServiceCollectionExtensions.cs

@@ -0,0 +1,29 @@
+//-----------------------------------------------------------------------
+// <copyright file="RazorEmailTemplateServiceCollectionExtensions.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace Microsoft.Extensions.DependencyInjection
+{
+    /// <summary>
+    /// Extension methods to configure the Email templates based on Razor components.
+    /// </summary>
+    public static class RazorEmailTemplateServiceCollectionExtensions
+    {
+        /// <summary>
+        /// Adds Razor text templating support to the emailing services.
+        /// </summary>
+        /// <param name="builder"><see cref="EmailingBuilder"/> to configure.</param>
+        /// <returns>The <paramref name="builder"/> instance to continue the configuration of the emailing service.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when the <paramref name="builder"/> argument is <see langword="null"/>.</exception>
+        public static EmailingBuilder UseRazorEmailTemplates(this EmailingBuilder builder)
+        {
+            ArgumentNullException.ThrowIfNull(builder);
+
+            builder.Services.AddRazorTextTemplating();
+
+            return builder;
+        }
+    }
+}

tests/Emailing.Azure.Tests/AzureEmailingBuilderExtensionsTest.cs

@@ -18,7 +18,8 @@ public void UseAzureCommunicationService_WithConnectionString()
             var serviceCollection = new ServiceCollection();
             var builder = new EmailingBuilder(serviceCollection);
 
-            builder.UseAzureCommunicationService("endpoint=https://my-acs-resource.communication.azure.com/;accesskey=2x3Yz==");
+            builder.UseAzureCommunicationService("endpoint=https://my-acs-resource.communication.azure.com/;accesskey=2x3Yz==")
+                .Should().BeSameAs(builder);
 
             var sp = builder.Services.BuildServiceProvider();
 
@@ -44,7 +45,8 @@ public void UseAzureCommunicationService_WithConnectionString_WithClientBuilder(
             builder.UseAzureCommunicationService("endpoint=https://my-acs-resource.communication.azure.com/;accesskey=2x3Yz==", clientBuilder =>
             {
                 clientBuilderCalled = true;
-            });
+            })
+            .Should().BeSameAs(builder);
 
             var sp = builder.Services.BuildServiceProvider();
 
@@ -93,7 +95,8 @@ public void UseAzureCommunicationService_WithUri()
             var serviceCollection = new ServiceCollection();
             var builder = new EmailingBuilder(serviceCollection);
 
-            builder.UseAzureCommunicationService(new Uri("https://my-acs-resource.communication.azure.com/"));
+            builder.UseAzureCommunicationService(new Uri("https://my-acs-resource.communication.azure.com/"))
+                .Should().BeSameAs(builder);
 
             var sp = builder.Services.BuildServiceProvider();
 
@@ -119,7 +122,8 @@ public void UseAzureCommunicationService_WithUri_WithClientBuilder()
             builder.UseAzureCommunicationService(new Uri("https://my-acs-resource.communication.azure.com/"), clientBuilder =>
             {
                 clientBuilderCalled = true;
-            });
+            })
+            .Should().BeSameAs(builder);
 
             var sp = builder.Services.BuildServiceProvider();
 

tests/Emailing.Graph.Tests/GraphBuilderExtensionsTest.cs

@@ -24,7 +24,8 @@ public void UseGraph(string baseUrl, string expectedBaseUrl)
 
             var credential = Mock.Of<TokenCredential>(MockBehavior.Strict);
 
-            builder.UseGraph(credential, baseUrl);
+            builder.UseGraph(credential, baseUrl)
+                .Should().BeSameAs(builder);
 
             var sp = builder.Services.BuildServiceProvider();
 

tests/Emailing.Templates.Razor.Tests/RazorEmailTemplateServiceCollectionExtensionsTest.cs

@@ -0,0 +1,42 @@
+//-----------------------------------------------------------------------
+// <copyright file="RazorEmailTemplateServiceCollectionExtensionsTest.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace Microsoft.Extensions.DependencyInjection.Tests
+{
+    using Microsoft.Extensions.Logging;
+
+    public class RazorEmailTemplateServiceCollectionExtensionsTest
+    {
+        private static readonly Type IRazorTextTemplateRendererInterface = Type.GetType("PosInformatique.Foundations.Text.Templating.Razor.IRazorTextTemplateRenderer, PosInformatique.Foundations.Text.Templating.Razor");
+        private static readonly Type RazorTextTemplateRendererClass = Type.GetType("PosInformatique.Foundations.Text.Templating.Razor.RazorTextTemplateRenderer, PosInformatique.Foundations.Text.Templating.Razor");
+
+        [Fact]
+        public void UseRazorEmailTemplates()
+        {
+            var serviceCollection = new ServiceCollection();
+            var emailingBuilder = new EmailingBuilder(serviceCollection);
+
+            emailingBuilder.UseRazorEmailTemplates().Should().BeSameAs(emailingBuilder);
+
+            var sp = serviceCollection.BuildServiceProvider();
+
+            sp.GetRequiredService(IRazorTextTemplateRendererInterface).Should().BeOfType(RazorTextTemplateRendererClass);
+            sp.GetRequiredService<ILogger<string>>().Should().NotBeNull();
+        }
+
+        [Fact]
+        public void UseRazorEmailTemplates_WithBuilderArgumentNull()
+        {
+            var act = () =>
+            {
+                RazorEmailTemplateServiceCollectionExtensions.UseRazorEmailTemplates(null);
+            };
+
+            act.Should().ThrowExactly<ArgumentNullException>()
+                .WithParameterName("builder");
+        }
+    }
+}