Implement UpdatedAt, ArchivedAt and DeletedAt

dotClique · Feb 16, 2022 · a6f99d4 · a6f99d4
1 parent 315c11f
commit a6f99d4
Show file tree

Hide file tree

Showing 12 changed files with 114 additions and 17 deletions.
diff --git a/SpeiderappAPI/Controllers/BadgeController.cs b/SpeiderappAPI/Controllers/BadgeController.cs
@@ -1,10 +1,15 @@
 using System.Collections.Generic;
+using System.Linq;
 using System.Threading.Tasks;
 using AutoMapper;
+using AutoMapper.QueryableExtensions;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;
+using NuGet.Versioning;
 using SpeiderappAPI.Database;
 using SpeiderappAPI.DataTransferObjects;
+using SpeiderappAPI.Models;
+using SpeiderappAPI.Models.Interfaces;
 
 namespace SpeiderappAPI.Controllers
 {
@@ -25,16 +30,18 @@ public BadgeController(ApiContext context, IMapper mapper)
         [HttpGet]
         public async Task<ActionResult<IEnumerable<BadgeDto>>> GetBadges()
         {
-            return _mapper.Map<List<BadgeDto>>(
-                await _context.Badges.ToListAsync()
-            );
+            return await _context.Badges
+                .ExcludeDeleted().ExcludeArchived()
+                .ProjectTo<BadgeDto>(_mapper.ConfigurationProvider).ToListAsync();
         }
 
         // GET: api/Badge/<id>
         [HttpGet("{id:long}")]
         public async Task<ActionResult<BadgeDto>> GetBadge(long id)
         {
-            var badge = await _context.Badges.FindAsync(id);
+            var badge = await _context.Badges
+                .ExcludeDeleted().ExcludeArchived()
+                .Where(e => e.RequirementID == id).FirstOrDefaultAsync();
 
             if (badge == null)
             {

diff --git a/SpeiderappAPI/Controllers/RequirementController.cs b/SpeiderappAPI/Controllers/RequirementController.cs
@@ -8,6 +8,7 @@
 using SpeiderappAPI.Database;
 using SpeiderappAPI.DataTransferObjects;
 using SpeiderappAPI.Models;
+using SpeiderappAPI.Models.Interfaces;
 
 namespace SpeiderappAPI.Controllers
 {
@@ -28,22 +29,28 @@ public RequirementController(ApiContext context, IMapper mapper)
         [HttpGet]
         public async Task<ActionResult<IEnumerable<RequirementDto>>> GetRequirements()
         {
-            return await _context.Requirements.Where(requirement => requirement.RequirementType == nameof(Requirement))
+            return await _context.Requirements
+                .ExcludeDeleted().ExcludeArchived()
+                .Where(requirement => requirement.RequirementType == nameof(Requirement))
                 .ProjectTo<RequirementDto>(_mapper.ConfigurationProvider).ToListAsync();
         }
 
         // GET: api/Requirement/all
         [HttpGet("all")]
         public async Task<ActionResult<IEnumerable<RequirementDto>>> GetRequirementsAll()
         {
-            return await _context.Requirements.ProjectTo<RequirementDto>(_mapper.ConfigurationProvider).ToListAsync();
+            return await _context.Requirements
+                .ExcludeDeleted().ExcludeArchived()
+                .ProjectTo<RequirementDto>(_mapper.ConfigurationProvider).ToListAsync();
         }
 
         // Get: api/Requirement/<id>
         [HttpGet("{id:long}")]
         public async Task<ActionResult<RequirementDto>> GetRequirement(long id)
         {
-            var requirement = await _context.Requirements.FindAsync(id);
+            var requirement = await _context.Requirements
+                .ExcludeDeleted().ExcludeArchived()
+                .Where(e => e.RequirementID == id).FirstOrDefaultAsync();
 
             if (requirement == null)
             {

diff --git a/SpeiderappAPI/Controllers/ResourceController.cs b/SpeiderappAPI/Controllers/ResourceController.cs
@@ -1,11 +1,13 @@
 using System.Collections.Generic;
+using System.Linq;
 using System.Threading.Tasks;
 using AutoMapper;
 using AutoMapper.QueryableExtensions;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;
 using SpeiderappAPI.Database;
 using SpeiderappAPI.DataTransferObjects;
+using SpeiderappAPI.Models.Interfaces;
 
 namespace SpeiderappAPI.Controllers
 {
@@ -26,14 +28,18 @@ public ResourceController(ApiContext context, IMapper mapper)
         [HttpGet]
         public async Task<ActionResult<IEnumerable<ResourceDto>>> GetResource()
         {
-            return await _context.Resources.ProjectTo<ResourceDto>(_mapper.ConfigurationProvider).ToListAsync();
+            return await _context.Resources
+                .ExcludeDeleted()
+                .ProjectTo<ResourceDto>(_mapper.ConfigurationProvider).ToListAsync();
         }
 
         // GET: api/Resource/<id>
         [HttpGet("{id:long}")]
         public async Task<ActionResult<ResourceDto>> GetResource(long id)
         {
-            var resource = await _context.Resources.FindAsync(id);
+            var resource = await _context.Resources
+                .ExcludeDeleted()
+                .Where(e => e.ResourceID == id).FirstOrDefaultAsync();
 
             if (resource == null)
             {

diff --git a/SpeiderappAPI/Models/Interfaces/IArchivable.cs b/SpeiderappAPI/Models/Interfaces/IArchivable.cs
@@ -0,0 +1,10 @@
+using System;
+using System.Linq;
+
+namespace SpeiderappAPI.Models.Interfaces
+{
+    public interface IArchivable
+    {
+        public DateTime? ArchivedAt { get; set; }
+    }
+}
diff --git a/SpeiderappAPI/Models/Interfaces/IArchivableExtensions.cs b/SpeiderappAPI/Models/Interfaces/IArchivableExtensions.cs
@@ -0,0 +1,19 @@
+using System.Linq;
+
+namespace SpeiderappAPI.Models.Interfaces
+{
+    public static class IArchivableExtensions
+    {
+        public static IQueryable<TArchivable> ExcludeArchived<TArchivable>(this IQueryable<TArchivable> queryable)
+            where TArchivable : IArchivable
+        {
+            return queryable.Where(e => e.ArchivedAt == null);
+        }
+
+        public static IQueryable<TArchivable> OnlyArchived<TArchivable>(IQueryable<TArchivable> queryable)
+            where TArchivable : IArchivable
+        {
+            return queryable.Where(e => e.ArchivedAt != null);
+        }
+    }
+}
diff --git a/SpeiderappAPI/Models/Interfaces/ISoftDeletable.cs b/SpeiderappAPI/Models/Interfaces/ISoftDeletable.cs
@@ -0,0 +1,9 @@
+using System;
+
+namespace SpeiderappAPI.Models.Interfaces
+{
+    public interface ISoftDeletable
+    {
+        public DateTime? DeletedAt { get; set; }
+    }
+}
diff --git a/SpeiderappAPI/Models/Interfaces/ISoftDeleteExtensions.cs b/SpeiderappAPI/Models/Interfaces/ISoftDeleteExtensions.cs
@@ -0,0 +1,19 @@
+using System.Linq;
+
+namespace SpeiderappAPI.Models.Interfaces
+{
+    public static class ISoftDeleteExtensions
+    {
+        public static IQueryable<TSoftDeletable> ExcludeDeleted<TSoftDeletable>(
+            this IQueryable<TSoftDeletable> queryable) where TSoftDeletable : ISoftDeletable
+        {
+            return queryable.Where(e => e.DeletedAt == null);
+        }
+
+        public static IQueryable<TSoftDeletable> OnlyDeleted<TSoftDeletable>(this IQueryable<TSoftDeletable> queryable)
+            where TSoftDeletable : ISoftDeletable
+        {
+            return queryable.Where(e => e.DeletedAt != null);
+        }
+    }
+}
diff --git a/SpeiderappAPI/Models/Interfaces/IUpdatable.cs b/SpeiderappAPI/Models/Interfaces/IUpdatable.cs
@@ -0,0 +1,9 @@
+using System;
+
+namespace SpeiderappAPI.Models.Interfaces
+{
+    public interface IUpdatable
+    {
+        public DateTime UpdatedAt { get; set; }
+    }
+}
diff --git a/SpeiderappAPI/Models/Requirement.cs b/SpeiderappAPI/Models/Requirement.cs
@@ -1,9 +1,10 @@
 using System;
 using System.Collections.Generic;
+using SpeiderappAPI.Models.Interfaces;
 
 namespace SpeiderappAPI.Models
 {
-    public class Requirement
+    public class Requirement : IUpdatable, IArchivable, ISoftDeletable
     {
         public Requirement(string description, DateTime publishTime)
         {
@@ -21,6 +22,9 @@ public Requirement(string description, DateTime publishTime)
         public virtual ICollection<Resource> Resources { get; set; } = null!;
         public virtual ICollection<RequirementPrerequisite> RequiredBy { get; set; } = null!;
         public virtual ICollection<RequirementPrerequisite> Requiring { get; set; } = null!;
+        public DateTime UpdatedAt { get; set; }
+        public DateTime? ArchivedAt { get; set; }
+        public DateTime? DeletedAt { get; set; }
 
         public override string ToString()
         {

diff --git a/SpeiderappAPI/Models/Resource.cs b/SpeiderappAPI/Models/Resource.cs
@@ -1,6 +1,9 @@
-namespace SpeiderappAPI.Models
+using System;
+using SpeiderappAPI.Models.Interfaces;
+
+namespace SpeiderappAPI.Models
 {
-    public class Resource
+    public class Resource : IUpdatable, ISoftDeletable
     {
         public Resource(long requirementID, string name, string description, string location)
         {
@@ -16,5 +19,7 @@ public Resource(long requirementID, string name, string description, string loca
         public string Location { get; set; }
         public long RequirementID { get; set; }
         public virtual Requirement Requirement { get; set; } = null!;
+        public DateTime UpdatedAt { get; set; }
+        public DateTime? DeletedAt { get; set; }
     }
 }
diff --git a/SpeiderappAPI/Models/Tag.cs b/SpeiderappAPI/Models/Tag.cs
@@ -1,8 +1,10 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
+using SpeiderappAPI.Models.Interfaces;
 
 namespace SpeiderappAPI.Models
 {
-    public class Tag
+    public class Tag : IUpdatable, ISoftDeletable
     {
         public Tag(long tagID, string value, long categoryID)
         {
@@ -16,5 +18,7 @@ public Tag(long tagID, string value, long categoryID)
         public long CategoryID { get; set; }
         public virtual Category Category { get; set; } = null!;
         public virtual ICollection<TaggedWith> TaggedWiths { get; set; } = null!;
+        public DateTime UpdatedAt { get; set; }
+        public DateTime? DeletedAt { get; set; }
     }
 }
diff --git a/SpeiderappAPI/Models/User.cs b/SpeiderappAPI/Models/User.cs
@@ -1,6 +1,4 @@
-using System.Collections.Generic;
-
-namespace SpeiderappAPI.Models
+namespace SpeiderappAPI.Models
 {
     public class User
     {