🖋️ feat: Transform signature to value object

.github/action.yml

@@ -20,13 +20,13 @@ runs:
       run: |
         cd ${{ github.workspace }}/${{ inputs.path }}
 
-        if dotnet nuget list source | grep -q $NugetSourceName; then
-          echo "Removing existing nuget source: $NugetSourceName"
-          dotnet nuget remove source $NugetSourceName
+        if dotnet nuget list source | grep -q ${{ inputs.nuget-source-name }}; then
+          echo "Removing existing nuget source: '${{ inputs.nuget-source-name }}'"
+          dotnet nuget remove source '${{ inputs.nuget-source-name }}'
         else
           echo "Nuget source $NugetSourceName does not exist. Skipping removal."
         fi
 
         dotnet nuget add source --username ${{ inputs.owner }} --password ${{ inputs.github-token }} --store-password-in-clear-text --name ${{ inputs.nuget-source-name }} "https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json"
         dotnet nuget list source
-      shell: bash
+      shell: bash

.github/workflows/chapter-4-contracts-workflow.yml

@@ -29,7 +29,7 @@ jobs:
         with:
           dotnet-version: 8.0.x
       - name: Add Evolutionary Architecture Nuget Source
-        uses: evolutionary-architecture/evolutionary-architecture-by-example/.github@main
+        uses: evolutionary-architecture/evolutionary-architecture-by-example/.github@feature/add_signature_value_object
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           owner: ${{ github.repository_owner }}
@@ -54,7 +54,7 @@ jobs:
         with:
           dotnet-version: 8.0.x
       - name: Add Evolutionary Architecture Nuget Source
-        uses: evolutionary-architecture/evolutionary-architecture-by-example/.github@main
+        uses: evolutionary-architecture/evolutionary-architecture-by-example/.github@feature/add_signature_value_object
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           owner: ${{ github.repository_owner }}

Chapter-2-modules-separation/Src/Fitnet/appsettings.json

@@ -8,28 +8,16 @@
   "AllowedHosts": "*",
    "Modules": {
     "Passes": {
-      "Enabled": true,
-      "ConnectionStrings": {
-        "Primary": ""
-      }
+      "Enabled": false
     },
     "Contracts": {
-      "Enabled": true,
-      "ConnectionStrings": {
-        "Primary": ""
-      }
+      "Enabled": true
     },
     "Reports": {
-      "Enabled": true,
-      "ConnectionStrings": {
-        "Primary": ""
-      }
+      "Enabled": false
     },
     "Offers": {
-      "Enabled": true,
-      "ConnectionStrings": {
-        "Primary": ""
-      }
+      "Enabled": false
     }
    }
 }

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Api.UnitTests/SignContract/SignContractRequestValidatorTests.cs

@@ -5,14 +5,15 @@ namespace EvolutionaryArchitecture.Fitnet.Contracts.Api.UnitTests.SignContract;
 
 public sealed class SignContractRequestValidatorTests
 {
+    private const string ValidSignatureText = "John Doe";
     private readonly SignContractRequestValidator _validator = new();
     private readonly DateTimeOffset _fakeNow = new Faker().Date.RecentOffset();
 
     [Fact]
     internal void Given_sign_contract_request_validation_When_request_is_valid_Then_result_should_have_no_errors()
     {
         // Arrange
-        var request = new SignContractRequest(_fakeNow);
+        var request = new SignContractRequest(_fakeNow, ValidSignatureText);
 
         // Act
         var result = _validator.TestValidate(request);
@@ -25,7 +26,7 @@ internal void Given_sign_contract_request_validation_When_request_is_valid_Then_
     internal void Given_sign_contract_request_validation_When_signed_at_not_provided_Then_result_should_have_error()
     {
         // Arrange
-        var request = new SignContractRequest(default);
+        var request = new SignContractRequest(default, ValidSignatureText);
 
         // Act
         var result = _validator.TestValidate(request);

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Api/PrepareContract/PrepareContractEndpoint.cs

@@ -11,9 +11,17 @@ internal static class PrepareContractEndpoint
 {
     internal static void MapPrepareContract(this IEndpointRouteBuilder app) =>
         app.MapPost(ContractsApiPaths.Prepare,
-            async Task (PrepareContractRequest request, IContractsModule contractsModule, CancellationToken cancellationToken) =>
-                await contractsModule.ExecuteCommandAsync(request.ToCommand(), cancellationToken).Match(
-                contractId => Results.Created(ContractsApiPaths.GetPreparedContractPath(contractId), (object?)contractId),
+            async Task<IResult> (PrepareContractRequest request, IContractsModule contractsModule, CancellationToken cancellationToken) =>
+                await contractsModule.ExecuteCommandAsync(request.ToCommand(), cancellationToken)
+                    .Match(
+                contractId =>
+                {
+                    var uri = ContractsApiPaths.GetPreparedContractPath(contractId);
+                    var value = (object?)contractId;
+                    var response = Results.Created(uri, value);
+
+                    return response;
+                },
                 errors => errors.ToProblem()))
         .ValidateRequest<PrepareContractRequest>()
         .WithOpenApi(operation => new(operation)

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Api/SignContract/SignContractEndpoint.cs

@@ -9,7 +9,8 @@ namespace EvolutionaryArchitecture.Fitnet.Contracts.Api.SignContract;
 
 internal static class SignContractEndpoint
 {
-    internal static void MapSignContract(this IEndpointRouteBuilder app) => app.MapPatch(ContractsApiPaths.Sign, async (
+    internal static void MapSignContract(this IEndpointRouteBuilder app) => app.MapPatch(ContractsApiPaths.Sign,
+            async Task<IResult> (
                 Guid id,
                 SignContractRequest request,
                 IContractsModule contractsModule, CancellationToken cancellationToken) =>

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Api/SignContract/SignContractRequest.cs

@@ -2,8 +2,8 @@ namespace EvolutionaryArchitecture.Fitnet.Contracts.Api.SignContract;
 
 using EvolutionaryArchitecture.Fitnet.Contracts.Application.SignContract;
 
-internal sealed record SignContractRequest(DateTimeOffset SignedAt)
+internal sealed record SignContractRequest(DateTimeOffset SignedAt, string SignatureText)
 {
     internal SignContractCommand ToCommand(Guid id) =>
-        new(id, SignedAt);
+        new(id, SignatureText, SignedAt);
 }

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Api/SignContract/SignContractRequestValidator.cs

@@ -4,6 +4,13 @@ namespace EvolutionaryArchitecture.Fitnet.Contracts.Api.SignContract;
 
 internal sealed class SignContractRequestValidator : AbstractValidator<SignContractRequest>
 {
-    public SignContractRequestValidator() => RuleFor(signContractRequest => signContractRequest.SignedAt)
-        .NotEmpty();
+    public SignContractRequestValidator()
+    {
+        RuleFor(signContractRequest => signContractRequest.SignatureText)
+            .NotEmpty()
+            .MaximumLength(100);
+
+        RuleFor(signContractRequest => signContractRequest.SignedAt)
+            .NotEmpty();
+    }
 }

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Application/SignContract/SignContractCommand.cs

@@ -1,3 +1,3 @@
 namespace EvolutionaryArchitecture.Fitnet.Contracts.Application.SignContract;
 
-public sealed record SignContractCommand(Guid Id, DateTimeOffset SignedAt) : ICommand<ErrorOr<Guid>>;
+public sealed record SignContractCommand(Guid Id, string SignatureText, DateTimeOffset SignedAt) : ICommand<ErrorOr<Guid>>;

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Application/SignContract/SignContractCommandHandler.cs

@@ -1,5 +1,6 @@
 namespace EvolutionaryArchitecture.Fitnet.Contracts.Application.SignContract;
 
+using Core;
 using IntegrationEvents;
 using MassTransit;
 
@@ -12,14 +13,14 @@ internal sealed class SignContractCommandHandler(
 {
     public async Task<ErrorOr<Guid>> Handle(SignContractCommand command, CancellationToken cancellationToken) =>
         await contractsRepository.GetByIdAsync(command.Id, cancellationToken)
-            .ThenAsync(async contract => await contract.Sign(command.SignedAt, timeProvider.GetUtcNow())
+            .ThenAsync(async contract => await contract.Sign(Signature.From(command.SignedAt, command.SignatureText), timeProvider.GetUtcNow())
                 .ThenAsync(async bindingContract =>
                 {
                     await bindingContractsRepository.AddAsync(bindingContract, cancellationToken);
                     await contractsRepository.CommitAsync(cancellationToken);
                     var @event = ContractSignedEvent.Create(contract.Id.Value,
                         contract.CustomerId,
-                        contract.SignedAt!.Value,
+                        contract.Signature!.Date,
                         contract.ExpiringAt!.Value);
                     await publishEndpoint.Publish(@event, cancellationToken);
 

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Core.UnitTests/Common/Builders/SignContractBuilder.cs

@@ -15,7 +15,8 @@ public SignContractBuilder SignedOn(DateTimeOffset signDay, DateTimeOffset fakeT
 
     private BindingContract Build()
     {
-        var bindingContract = parentBuilder.Sign(_signDay, _fakeToday);
+        var signature = Signature.From(_signDay, "John Doe");
+        var bindingContract = parentBuilder.Sign(signature, _fakeToday);
 
         return bindingContract.Value;
     }

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Core.UnitTests/SignContract/SignContractTests.cs

@@ -6,6 +6,8 @@ namespace EvolutionaryArchitecture.Fitnet.Contracts.Core.UnitTests.SignContract;
 
 public sealed class SignContractTests
 {
+    private const string SignatureText = "John Doe";
+
     [Theory]
     [ClassData(typeof(SignContractTestData))]
     internal void Given_sign_contract_Then_expiration_date_is_set_to_contract_duration_from_now(
@@ -18,9 +20,10 @@ internal void Given_sign_contract_Then_expiration_date_is_set_to_contract_durati
         Contract contract = ContractBuilder
             .Prepared()
             .PreparedAt(preparedAt);
+        var signature = Signature.From(signedAt, SignatureText);
 
         // Act
-        var signResult = contract.Sign(signedAt, fakeNow);
+        var signResult = contract.Sign(signature, fakeNow);
 
         // Assert
         var @event = signResult.Value.GetPublishedEvent<BindingContractStartedEvent>();
@@ -36,9 +39,10 @@ internal void Given_sign_contract_Then_contracts_becomes_binding_contract()
         // Arrange
         Contract contract = ContractBuilder
             .Prepared();
+        var signature = Signature.From(SignedAt, SignatureText);
 
         // Act
-        var signResult = contract.Sign(SignedAt, FakeNow);
+        var signResult = contract.Sign(signature, FakeNow);
 
         // Assert
         var @event = signResult.Value.GetPublishedEvent<BindingContractStartedEvent>();

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Core.UnitTests/SignContract/SignedContractBuilder.cs

@@ -4,6 +4,7 @@
 
 internal sealed class SignedContractBuilder(Contract parentBuilder)
 {
+    private const string SignatureText = "John Doe";
     private DateTimeOffset? _signDay;
     private DateTimeOffset? _fakeToday;
 
@@ -19,7 +20,8 @@ private BindingContract Build()
     {
         var signDay = _signDay ?? FakeContractDates.SignDay;
         var fakeToday = _fakeToday ?? FakeContractDates.SignDay;
-        var bindingContract = parentBuilder.Sign(signDay, fakeToday).Value;
+        var signature = Signature.From(signDay, SignatureText);
+        var bindingContract = parentBuilder.Sign(signature, fakeToday).Value;
 
         return bindingContract;
     }

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Core/Contract.cs

@@ -17,10 +17,10 @@ public sealed class Contract : Entity
     public DateTimeOffset PreparedAt { get; init; }
     public TimeSpan Duration { get; init; }
 
-    public DateTimeOffset? SignedAt { get; private set; }
+    public Signature? Signature { get; private set; }
     public DateTimeOffset? ExpiringAt { get; private set; }
 
-    public bool IsSigned => SignedAt.HasValue;
+    public bool IsSigned => Signature is not null;
 
     // EF needs this constructor to create non-primitive types
     private Contract() { }
@@ -51,13 +51,13 @@ public static ErrorOr<Contract> Prepare(
             new PreviousContractHasToBeSignedRule(isPreviousContractSigned))
             .Then<Contract>(_ => new Contract(customerId, preparedAt, StandardDuration));
 
-    public ErrorOr<BindingContract> Sign(DateTimeOffset signedAt, DateTimeOffset now) =>
+    public ErrorOr<BindingContract> Sign(Signature signature, DateTimeOffset now) =>
         BusinessRuleValidator.Validate(
                 new ContractMustNotBeAlreadySignedRule(IsSigned),
-                new ContractCanOnlyBeSignedWithin30DaysFromPreparationRule(PreparedAt, signedAt))
+                new ContractCanOnlyBeSignedWithin30DaysFromPreparationRule(PreparedAt, signature.Date))
             .Then(_ =>
             {
-                SignedAt = signedAt;
+                Signature = signature;
                 ExpiringAt = now.Add(Duration);
                 var bindingContract = BindingContract.Start(Id, CustomerId, Duration, now, ExpiringAt.Value);
 

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Core/Signature.cs

@@ -0,0 +1,29 @@
+namespace EvolutionaryArchitecture.Fitnet.Contracts.Core;
+
+using System.Text.RegularExpressions;
+
+public sealed partial class Signature
+{
+    private static readonly Regex SignatureTextPattern = SignatureAllowedCharacters();
+    public DateTimeOffset Date { get; }
+    public string Text { get; }
+
+    private Signature(DateTimeOffset date, string text)
+    {
+        Date = date;
+        if (!SignatureTextPattern.IsMatch(text))
+        {
+            throw new SignatureNotValidException(text);
+        }
+
+        Text = text;
+    }
+
+    public static Signature From(DateTimeOffset signedAt, string signatureText) =>
+        new(signedAt, signatureText);
+
+    [GeneratedRegex(@"^[A-Za-z\s]+$")]
+    private static partial Regex SignatureAllowedCharacters();
+}
+
+public sealed class SignatureNotValidException(string signatureText) : InvalidOperationException($"Signature text: '{signatureText}' contains invalid characters.");

Chapter-4-applying-tactical-domain-driven-design/Fitnet.Contracts/Src/Fitnet.Contracts.Infrastructure/Database/Configurations/ContractEntityConfiguration.cs

@@ -2,6 +2,7 @@ namespace EvolutionaryArchitecture.Fitnet.Contracts.Infrastructure.Database.Conf
 
 using Core;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Design;
 using Microsoft.EntityFrameworkCore.Metadata.Builders;
 
 internal sealed class ContractEntityConfiguration : IEntityTypeConfiguration<Contract>
@@ -17,6 +18,21 @@ public void Configure(EntityTypeBuilder<Contract> builder)
                 value => new ContractId(value))
             .ValueGeneratedOnAdd();
         builder.Property(contract => contract.PreparedAt).IsRequired();
-        builder.Property(contract => contract.SignedAt).IsRequired(false);
+        builder.OwnsOne<Signature>("Signature", signatureBuilder =>
+        {
+            signatureBuilder.Property(signature => signature.Date).IsRequired();
+            signatureBuilder.Property(signature => signature.Text).IsRequired().HasMaxLength(100);
+        });
+    }
+}
+
+public class BloggingContextFactory : IDesignTimeDbContextFactory<ContractsPersistence>
+{
+    public ContractsPersistence CreateDbContext(string[] args)
+    {
+        var optionsBuilder = new DbContextOptionsBuilder<ContractsPersistence>();
+        optionsBuilder.UseNpgsql("Host=localhost:5432;Database=fitnet;Username=postgres;Password=mysecretpassword");
+
+        return new ContractsPersistence(optionsBuilder.Options);
     }
 }