♻️Refactor(use-cases): separate project's queries and commands to follow CQRS pattern

sample/src/NimblePros.SampleToDo.Core/ProjectAggregate/Project.cs

@@ -1,4 +1,5 @@
-using NimblePros.SampleToDo.Core.ProjectAggregate.Events;
+using NimblePros.SampleToDo.Core.ContributorAggregate.Events;
+using NimblePros.SampleToDo.Core.ProjectAggregate.Events;
 
 namespace NimblePros.SampleToDo.Core.ProjectAggregate;
 
@@ -27,6 +28,7 @@ public Project AddItem(ToDoItem newItem)
 
   public Project UpdateName(ProjectName newName)
   {
+    if (Name.Equals(newName)) return this;
     Name = newName;
     return this;
   }

sample/src/NimblePros.SampleToDo.Core/ProjectAggregate/Specifications/IncompleteItemsSearchSpec.cs

@@ -6,7 +6,7 @@ public IncompleteItemsSearchSpec(string searchString)
   {
     Query
         .Where(item => !item.IsDone &&
-        (item.Title.Contains(searchString) ||
-        item.Description.Contains(searchString)));
+        (item.Title.Value.Contains(searchString) ||
+        item.Description.Value.Contains(searchString)));
   }
 }

sample/src/NimblePros.SampleToDo.Core/ProjectAggregate/ToDoItem.cs

@@ -1,4 +1,5 @@
-using NimblePros.SampleToDo.Core.ContributorAggregate;
+using System.Xml.Linq;
+using NimblePros.SampleToDo.Core.ContributorAggregate;
 using NimblePros.SampleToDo.Core.ProjectAggregate.Events;
 
 namespace NimblePros.SampleToDo.Core.ProjectAggregate;
@@ -8,14 +9,19 @@ public class ToDoItem : EntityBase<ToDoItem, ToDoItemId>
   public ToDoItem() : this(Priority.Backlog)
   {
   }
+  public ToDoItem(ToDoItemTitle title, ToDoItemDescription description) : this(Priority.Backlog)
+  {
+    Title = title;
+    Description = description;
+  }
 
   public ToDoItem(Priority priority)
   {
     Priority = priority;
   }
 
-  public string Title { get; set; } = string.Empty; // TODO: Use Value Object
-  public string Description { get; set; } = string.Empty; // TODO: Use Value Object
+  public ToDoItemTitle Title { get; private set; }
+  public ToDoItemDescription Description { get; private set; }
   public ContributorId? ContributorId { get; private set; } // tasks don't have anyone assigned when first created
   public bool IsDone { get; private set; }
 
@@ -48,9 +54,23 @@ public ToDoItem RemoveContributor()
     return this;
   }
 
+  public ToDoItem UpdateTitle(ToDoItemTitle newTitle)
+  {
+    if (Title.Equals(newTitle)) return this;
+    Title = newTitle;
+    return this;
+  }
+
+  public ToDoItem UpdateDescription(ToDoItemDescription newDescription)
+  {
+    if (Description.Equals(newDescription)) return this;
+    Description = newDescription;
+    return this;
+  }
+
   public override string ToString()
   {
     string status = IsDone ? "Done!" : "Not done.";
-    return $"{Id}: Status: {status} - {Title} - Priority: {Priority}";
+    return $"{Id}: Status: {status} - {Title.Value} - Priority: {Priority}";
   }
 }

sample/src/NimblePros.SampleToDo.Core/ProjectAggregate/ToDoItemDescription.cs

@@ -0,0 +1,15 @@
+using Vogen;
+
+namespace NimblePros.SampleToDo.Core.ProjectAggregate;
+
+[ValueObject<string>(conversions: Conversions.SystemTextJson)]
+public partial struct ToDoItemDescription
+{
+  public const int MaxLength = 200;
+  private static Validation Validate(in string description) =>
+    string.IsNullOrEmpty(description)
+      ? Validation.Invalid("Description cannot be empty")
+      : description.Length > MaxLength
+        ? Validation.Invalid($"Description cannot be longer than {MaxLength} characters")
+        : Validation.Ok;
+}

sample/src/NimblePros.SampleToDo.Core/ProjectAggregate/ToDoItemTitle.cs

@@ -0,0 +1,15 @@
+using Vogen;
+
+namespace NimblePros.SampleToDo.Core.ProjectAggregate;
+
+[ValueObject<string>(conversions: Conversions.SystemTextJson)]
+public partial struct ToDoItemTitle
+{
+  public const int MaxLength = 100;
+  private static Validation Validate(in string title) =>
+    string.IsNullOrEmpty(title)
+      ? Validation.Invalid("Title cannot be empty")
+      : title.Length > MaxLength
+        ? Validation.Invalid($"Title cannot be longer than {MaxLength} characters")
+        : Validation.Ok;
+}

sample/src/NimblePros.SampleToDo.Infrastructure/Data/Config/ToDoItemConfiguration.cs

@@ -11,11 +11,17 @@ public void Configure(EntityTypeBuilder<ToDoItem> builder)
       .HasValueGenerator<VogenIdValueGenerator<AppDbContext, ToDoItem, ToDoItemId>>()
       .HasVogenConversion()
       .IsRequired();
-    builder.Property(t => t.Title)
-      .HasMaxLength(DataSchemaConstants.DEFAULT_NAME_LENGTH)
+
+    builder.Property(p => p.Title)
+      .HasVogenConversion()
+      .HasMaxLength(ToDoItemTitle.MaxLength)
+      .IsRequired();
+
+    builder.Property(p => p.Description)
+      .HasVogenConversion()
+      .HasMaxLength(ToDoItemDescription.MaxLength)
       .IsRequired();
-    builder.Property(t => t.Description)
-      .HasMaxLength(200);
+
     builder.Property(t => t.ContributorId)
       .HasConversion(
           v => v.HasValue ? v.Value.Value : (int?)null, // to db

sample/src/NimblePros.SampleToDo.Infrastructure/Data/Config/VogenEfCoreConverters.cs

@@ -9,4 +9,6 @@ namespace NimblePros.SampleToDo.Infrastructure.Data.Config;
 [EfCoreConverter<ContributorName>]
 [EfCoreConverter<ProjectName>]
 [EfCoreConverter<ProjectId>]
+[EfCoreConverter<ToDoItemTitle>]
+[EfCoreConverter<ToDoItemDescription>]
 internal partial class VogenEfCoreConverters;

sample/src/NimblePros.SampleToDo.Infrastructure/Data/Queries/FakeListIncompleteItemsQueryService.cs

@@ -1,6 +1,6 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 using NimblePros.SampleToDo.UseCases.Projects;
-using NimblePros.SampleToDo.UseCases.Projects.ListIncompleteItems;
+using NimblePros.SampleToDo.UseCases.Projects.Queries.ListIncompleteItems;
 
 namespace NimblePros.SampleToDo.Infrastructure.Data.Queries;
 

sample/src/NimblePros.SampleToDo.Infrastructure/Data/Queries/FakeListProjectsShallowQueryService.cs

@@ -1,5 +1,5 @@
 using NimblePros.SampleToDo.UseCases.Projects;
-using NimblePros.SampleToDo.UseCases.Projects.ListShallow;
+using NimblePros.SampleToDo.UseCases.Projects.Queries.ListShallow;
 
 namespace NimblePros.SampleToDo.Infrastructure.Data.Queries;
 

sample/src/NimblePros.SampleToDo.Infrastructure/Data/Queries/ListIncompleteItemsQueryService.cs

@@ -1,5 +1,5 @@
 using NimblePros.SampleToDo.UseCases.Projects;
-using NimblePros.SampleToDo.UseCases.Projects.ListIncompleteItems;
+using NimblePros.SampleToDo.UseCases.Projects.Queries.ListIncompleteItems;
 
 namespace NimblePros.SampleToDo.Infrastructure.Data.Queries;
 
@@ -17,7 +17,7 @@ public async Task<IEnumerable<ToDoItemDto>> ListAsync(int projectId)
     var projectParameter = new SqlParameter("@projectId", System.Data.SqlDbType.Int);
     var result = await _db.ToDoItems.FromSqlRaw("SELECT Id, Title, Description, IsDone, ContributorId FROM ToDoItems WHERE ProjectId = @ProjectId",
       projectParameter) // don't fetch other big columns
-      .Select(x => new ToDoItemDto(x.Id, x.Title, x.Description, x.IsDone, x.ContributorId))
+      .Select(x => new ToDoItemDto(x.Id, x.Title.Value, x.Description.Value, x.IsDone, x.ContributorId))
       .ToListAsync();
 
     return result;

sample/src/NimblePros.SampleToDo.Infrastructure/Data/Queries/ListProjectsShallowQueryService.cs

@@ -1,5 +1,5 @@
 using NimblePros.SampleToDo.UseCases.Projects;
-using NimblePros.SampleToDo.UseCases.Projects.ListShallow;
+using NimblePros.SampleToDo.UseCases.Projects.Queries.ListShallow;
 
 namespace NimblePros.SampleToDo.Infrastructure.Data.Queries;
 

sample/src/NimblePros.SampleToDo.Infrastructure/InfrastructureServiceExtensions.cs

@@ -5,8 +5,8 @@
 using NimblePros.SampleToDo.Infrastructure.Data.Queries;
 using NimblePros.SampleToDo.Infrastructure.Email;
 using NimblePros.SampleToDo.UseCases.Contributors.Queries.List;
-using NimblePros.SampleToDo.UseCases.Projects.ListIncompleteItems;
-using NimblePros.SampleToDo.UseCases.Projects.ListShallow;
+using NimblePros.SampleToDo.UseCases.Projects.Queries.ListIncompleteItems;
+using NimblePros.SampleToDo.UseCases.Projects.Queries.ListShallow;
 using NimblePros.SharedKernel;
 
 namespace NimblePros.SampleToDo.Infrastructure;

sample/src/NimblePros.SampleToDo.UseCases/Projects/AddToDoItem/AddToDoItemCommand.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/AddToDoItem/AddToDoItemCommand.cs

@@ -1,7 +1,7 @@
 using NimblePros.SampleToDo.Core.ContributorAggregate;
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.AddToDoItem;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.AddToDoItem;
 
 /// <summary>
 /// Creates a new ToDoItem and adds it to a Project
@@ -12,5 +12,5 @@ namespace NimblePros.SampleToDo.UseCases.Projects.AddToDoItem;
 /// <param name="Description"></param>
 public record AddToDoItemCommand(ProjectId ProjectId,
                                  ContributorId? ContributorId,
-                                 string Title,
-                                 string Description) : ICommand<Result<ToDoItemId>>;
+                                 ToDoItemTitle Title,
+                                 ToDoItemDescription Description) : ICommand<Result<ToDoItemId>>;

sample/src/NimblePros.SampleToDo.UseCases/Projects/AddToDoItem/AddToDoItemHandler.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/AddToDoItem/AddToDoItemHandler.cs

@@ -1,7 +1,7 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 using NimblePros.SampleToDo.Core.ProjectAggregate.Specifications;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.AddToDoItem;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.AddToDoItem;
 
 public class AddToDoItemHandler : ICommandHandler<AddToDoItemCommand, Result<ToDoItemId>>
 {
@@ -22,13 +22,9 @@ public async ValueTask<Result<ToDoItemId>> Handle(AddToDoItemCommand request,
       return Result.NotFound();
     }
 
-    var newItem = new ToDoItem()
-    {
-      Title = request.Title!,
-      Description = request.Description!
-    };
+    var newItem = new ToDoItem(title: request.Title!, description: request.Description!);
 
-    if(request.ContributorId.HasValue)
+    if (request.ContributorId.HasValue)
     {
       newItem.AddContributor(request.ContributorId.Value);
     }

sample/src/NimblePros.SampleToDo.UseCases/Projects/Create/CreateProjectCommand.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/Create/CreateProjectCommand.cs

@@ -1,6 +1,6 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.Create;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.Create;
 
 /// <summary>
 /// Create a new Project.

sample/src/NimblePros.SampleToDo.UseCases/Projects/Create/CreateProjectHandler.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/Create/CreateProjectHandler.cs

@@ -1,6 +1,6 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.Create;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.Create;
 
 public class CreateProjectHandler(IRepository<Project> repository) : ICommandHandler<CreateProjectCommand, Result<ProjectId>>
 {

sample/src/NimblePros.SampleToDo.UseCases/Projects/Delete/DeleteProjectCommand.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/Delete/DeleteProjectCommand.cs

@@ -1,5 +1,5 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.Delete;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.Delete;
 
 public record DeleteProjectCommand(ProjectId ProjectId) : ICommand<Result>;

sample/src/NimblePros.SampleToDo.UseCases/Projects/Delete/DeleteProjectHandler.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/Delete/DeleteProjectHandler.cs

@@ -1,6 +1,6 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.Delete;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.Delete;
 
 public class DeleteProjectHandler : ICommandHandler<DeleteProjectCommand, Result>
 {

sample/src/NimblePros.SampleToDo.UseCases/Projects/MarkToDoItemComplete/MarkToDoItemCompleteCommand.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/MarkToDoItemComplete/MarkToDoItemCompleteCommand.cs

@@ -1,6 +1,6 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.MarkToDoItemComplete;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.MarkToDoItemComplete;
 
 /// <summary>
 /// Create a new Project.

sample/src/NimblePros.SampleToDo.UseCases/Projects/MarkToDoItemComplete/MarkToDoItemCompleteHandler.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/MarkToDoItemComplete/MarkToDoItemCompleteHandler.cs

@@ -1,7 +1,7 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 using NimblePros.SampleToDo.Core.ProjectAggregate.Specifications;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.MarkToDoItemComplete;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.MarkToDoItemComplete;
 
 public class MarkToDoItemCompleteHandler : ICommandHandler<MarkToDoItemCompleteCommand, Result>
 {

sample/src/NimblePros.SampleToDo.UseCases/Projects/Update/UpdateProjectCommand.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/Update/UpdateProjectCommand.cs

@@ -1,5 +1,5 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.Update;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.Update;
 
 public record UpdateProjectCommand(ProjectId ProjectId, ProjectName NewName) : ICommand<Result<ProjectDto>>;

sample/src/NimblePros.SampleToDo.UseCases/Projects/Update/UpdateProjectHandler.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Commands/Update/UpdateProjectHandler.cs

@@ -1,6 +1,6 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.Update;
+namespace NimblePros.SampleToDo.UseCases.Projects.Commands.Update;
 
 public class UpdateProjectHandler : ICommandHandler<UpdateProjectCommand, Result<ProjectDto>>
 {

sample/src/NimblePros.SampleToDo.UseCases/Projects/GetWithAllItems/GetProjectWithAllItemsHandler.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Queries/GetWithAllItems/GetProjectWithAllItemsHandler.cs

@@ -1,7 +1,7 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 using NimblePros.SampleToDo.Core.ProjectAggregate.Specifications;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.GetWithAllItems;
+namespace NimblePros.SampleToDo.UseCases.Projects.Queries.GetWithAllItems;
 
 /// <summary>
 /// Queries don't necessarily need to use repository methods, but they can if it's convenient
@@ -22,7 +22,7 @@ public async ValueTask<Result<ProjectWithAllItemsDto>> Handle(GetProjectWithAllI
     if (project == null) return Result.NotFound();
 
     var items = project.Items
-              .Select(i => new ToDoItemDto(i.Id, i.Title, i.Description, i.IsDone, i.ContributorId)).ToList();
+              .Select(i => new ToDoItemDto(i.Id, i.Title.Value, i.Description.Value, i.IsDone, i.ContributorId)).ToList();
     return new ProjectWithAllItemsDto(project.Id, project.Name, items, project.Status.ToString())
       ;
   }

sample/src/NimblePros.SampleToDo.UseCases/Projects/GetWithAllItems/GetProjectWithAllItemsQuery.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Queries/GetWithAllItems/GetProjectWithAllItemsQuery.cs

@@ -1,6 +1,6 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 
-namespace NimblePros.SampleToDo.UseCases.Projects.GetWithAllItems;
+namespace NimblePros.SampleToDo.UseCases.Projects.Queries.GetWithAllItems;
 
 public record GetProjectWithAllItemsQuery(ProjectId ProjectId) : 
   IQuery<Result<ProjectWithAllItemsDto>>, ICacheable

sample/src/NimblePros.SampleToDo.UseCases/Projects/ListIncompleteItems/IListIncompleteItemsQueryService.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Queries/ListIncompleteItems/IListIncompleteItemsQueryService.cs

@@ -1,4 +1,4 @@
-namespace NimblePros.SampleToDo.UseCases.Projects.ListIncompleteItems;
+namespace NimblePros.SampleToDo.UseCases.Projects.Queries.ListIncompleteItems;
 
 /// <summary>
 /// Represents a service that will actually fetch the necessary data

sample/src/NimblePros.SampleToDo.UseCases/Projects/ListIncompleteItems/ListIncompleteItemsByProjectHandler.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Queries/ListIncompleteItems/ListIncompleteItemsByProjectHandler.cs

@@ -1,4 +1,4 @@
-namespace NimblePros.SampleToDo.UseCases.Projects.ListIncompleteItems;
+namespace NimblePros.SampleToDo.UseCases.Projects.Queries.ListIncompleteItems;
 
 public class ListIncompleteItemsByProjectHandler : IQueryHandler<ListIncompleteItemsByProjectQuery, Result<IEnumerable<ToDoItemDto>>>
 {

sample/src/NimblePros.SampleToDo.UseCases/Projects/ListIncompleteItems/ListIncompleteItemsByProjectQuery.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Queries/ListIncompleteItems/ListIncompleteItemsByProjectQuery.cs

@@ -1,4 +1,4 @@
-namespace NimblePros.SampleToDo.UseCases.Projects.ListIncompleteItems;
+namespace NimblePros.SampleToDo.UseCases.Projects.Queries.ListIncompleteItems;
 
 public record ListIncompleteItemsByProjectQuery(int ProjectId) : 
   IQuery<Result<IEnumerable<ToDoItemDto>>>, ICacheable

sample/src/NimblePros.SampleToDo.UseCases/Projects/ListShallow/IListProjectsShallowQueryService.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Queries/ListShallow/IListProjectsShallowQueryService.cs

@@ -1,4 +1,4 @@
-namespace NimblePros.SampleToDo.UseCases.Projects.ListShallow;
+namespace NimblePros.SampleToDo.UseCases.Projects.Queries.ListShallow;
 
 /// <summary>
 /// Represents a service that will actually fetch the necessary data

sample/src/NimblePros.SampleToDo.UseCases/Projects/ListShallow/ListProjectsShallowHandler.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Queries/ListShallow/ListProjectsShallowHandler.cs

@@ -1,4 +1,4 @@
-namespace NimblePros.SampleToDo.UseCases.Projects.ListShallow;
+namespace NimblePros.SampleToDo.UseCases.Projects.Queries.ListShallow;
 
 public class ListProjectsShallowHandler(IListProjectsShallowQueryService query)
   : IQueryHandler<ListProjectsShallowQuery, Result<IEnumerable<ProjectDto>>>

sample/src/NimblePros.SampleToDo.UseCases/Projects/ListShallow/ListProjectsShallowQuery.cs → sample/src/NimblePros.SampleToDo.UseCases/Projects/Queries/ListShallow/ListProjectsShallowQuery.cs

@@ -1,4 +1,4 @@
-namespace NimblePros.SampleToDo.UseCases.Projects.ListShallow;
+namespace NimblePros.SampleToDo.UseCases.Projects.Queries.ListShallow;
 
 public record ListProjectsShallowQuery(int? Skip, int? Take) :
   IQuery<Result<IEnumerable<ProjectDto>>>, ICacheable

sample/src/NimblePros.SampleToDo.Web/CachingBehavior.cs

@@ -6,11 +6,10 @@
 
 namespace NimblePros.SampleToDo.Web;
 
-public class CachingBehavior<TRequest, TResponse>(IMemoryCache cache,
-                                                  ILogger<CachingBehavior<TRequest, TResponse>> logger,
-                                                  IOptions<CachingOptions> cachingOptions) :
-    IPipelineBehavior<TRequest, TResponse?>
-    where TRequest : notnull, IMessage
+public class CachingBehavior<TRequest, TResponse>(
+  IMemoryCache cache,ILogger<CachingBehavior<TRequest, TResponse>> logger,
+  IOptions<CachingOptions> cachingOptions) :
+  IPipelineBehavior<TRequest, TResponse?> where TRequest : notnull, IMessage
 {
   private readonly IMemoryCache _cache = cache;
   private readonly ILogger<CachingBehavior<TRequest, TResponse>> _logger = logger;

sample/src/NimblePros.SampleToDo.Web/Projects/Create.cs

@@ -1,5 +1,5 @@
 using NimblePros.SampleToDo.Core.ProjectAggregate;
-using NimblePros.SampleToDo.UseCases.Projects.Create;
+using NimblePros.SampleToDo.UseCases.Projects.Commands.Create;
 using NimblePros.SampleToDo.Web.Extensions;
 
 namespace NimblePros.SampleToDo.Web.Projects;