Refactoring and Adding Tests (dotnet-architecture#28)

* Introducing repository and refactoring services. Changing entities to use int keys everywhere. * Refactoring application services to live in web project and only reference repositories, not EF contexts. * Cleaning up implementations * Moving logic out of CatalogController Moving entity knowledge out of viewmodels. * Implementing specification includes better for catalogservice * Cleaning up and adding specification unit tests
vblain · Aug 7, 2017 · d7eb59c · d7eb59c
1 parent 084db74
commit d7eb59c
Show file tree

Hide file tree

Showing 41 changed files with 449 additions and 360 deletions.
diff --git a/src/ApplicationCore/Entities/BaseEntity.cs b/src/ApplicationCore/Entities/BaseEntity.cs
@@ -1,7 +1,7 @@
 namespace Microsoft.eShopWeb.ApplicationCore.Entities
 {
-    public class BaseEntity<T>
+    public class BaseEntity
     {
-        public T Id { get; set; }
+        public int Id { get; set; }
     }
 }
diff --git a/src/ApplicationCore/Entities/Basket.cs b/src/ApplicationCore/Entities/Basket.cs
@@ -3,25 +3,24 @@
 
 namespace Microsoft.eShopWeb.ApplicationCore.Entities
 {
-    public class Basket : BaseEntity<string>
+    public class Basket : BaseEntity
     {
         public string BuyerId { get; set; }
         public List<BasketItem> Items { get; set; } = new List<BasketItem>();
 
-        public void AddItem(CatalogItem item, decimal unitPrice, int quantity = 1)
+        public void AddItem(int catalogItemId, decimal unitPrice, int quantity = 1)
         {
-            if(!Items.Any(i => i.Item.Id == item.Id))
+            if (!Items.Any(i => i.CatalogItemId == catalogItemId))
             {
                 Items.Add(new BasketItem()
                 {
-                    Item = item,
-                    //ProductId = productId,
+                    CatalogItemId = catalogItemId,
                     Quantity = quantity,
                     UnitPrice = unitPrice
                 });
                 return;
             }
-            var existingItem = Items.FirstOrDefault(i => i.Item.Id == item.Id);
+            var existingItem = Items.FirstOrDefault(i => i.CatalogItemId == catalogItemId);
             existingItem.Quantity += quantity;
         }
     }

diff --git a/src/ApplicationCore/Entities/BasketItem.cs b/src/ApplicationCore/Entities/BasketItem.cs
@@ -1,10 +1,10 @@
 namespace Microsoft.eShopWeb.ApplicationCore.Entities
 {
-    public class BasketItem : BaseEntity<string>
+    public class BasketItem : BaseEntity
     {
-        //public int ProductId { get; set; }
         public decimal UnitPrice { get; set; }
         public int Quantity { get; set; }
-        public CatalogItem Item { get; set; }
+        public int CatalogItemId { get; set; }
+//        public CatalogItem Item { get; set; }
     }
 }
diff --git a/src/ApplicationCore/Entities/CatalogBrand.cs b/src/ApplicationCore/Entities/CatalogBrand.cs
@@ -2,7 +2,7 @@
 
 namespace Microsoft.eShopWeb.ApplicationCore.Entities
 {
-    public class CatalogBrand : BaseEntity<int>
+    public class CatalogBrand : BaseEntity
     {
         public string Brand { get; set; }
     }

diff --git a/src/ApplicationCore/Entities/CatalogItem.cs b/src/ApplicationCore/Entities/CatalogItem.cs
@@ -1,6 +1,6 @@
 namespace Microsoft.eShopWeb.ApplicationCore.Entities
 {
-    public class CatalogItem : BaseEntity<int>
+    public class CatalogItem : BaseEntity
     {
         public string Name { get; set; }
         public string Description { get; set; }

diff --git a/src/ApplicationCore/Entities/CatalogType.cs b/src/ApplicationCore/Entities/CatalogType.cs
@@ -1,6 +1,6 @@
 namespace Microsoft.eShopWeb.ApplicationCore.Entities
 {
-    public class CatalogType : BaseEntity<int>
+    public class CatalogType : BaseEntity
     {
         public string Type { get; set; }
     }

diff --git a/src/ApplicationCore/Exceptions/CatalogImageMissingException.cs b/src/ApplicationCore/Exceptions/CatalogImageMissingException.cs
@@ -2,6 +2,9 @@
 
 namespace ApplicationCore.Exceptions
 {
+    /// <summary>
+    /// Note: No longer required.
+    /// </summary>
     public class CatalogImageMissingException : Exception
     {
         public CatalogImageMissingException(string message,
@@ -14,5 +17,13 @@ public CatalogImageMissingException(Exception innerException)
                   innerException: innerException)
         {
         }
+
+        public CatalogImageMissingException() : base()
+        {
+        }
+
+        public CatalogImageMissingException(string message) : base(message)
+        {
+        }
     }
 }
diff --git a/src/ApplicationCore/Interfaces/IAppLogger.cs b/src/ApplicationCore/Interfaces/IAppLogger.cs
@@ -1,5 +1,9 @@
 namespace ApplicationCore.Interfaces
 {
+    /// <summary>
+    /// This type eliminates the need to depend directly on the ASP.NET Core logging types.
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
     public interface IAppLogger<T>
     {
         void LogWarning(string message, params object[] args);

diff --git a/src/ApplicationCore/Interfaces/IBasketService.cs b/src/ApplicationCore/Interfaces/IBasketService.cs
diff --git a/src/ApplicationCore/Interfaces/IRepository.cs b/src/ApplicationCore/Interfaces/IRepository.cs
@@ -0,0 +1,18 @@
+using Microsoft.eShopWeb.ApplicationCore.Entities;
+using System;
+using System.Collections.Generic;
+using System.Linq.Expressions;
+
+namespace ApplicationCore.Interfaces
+{
+
+    public interface IRepository<T> where T : BaseEntity
+    {
+        T GetById(int id);
+        List<T> List();
+        List<T> List(ISpecification<T> spec);
+        T Add(T entity);
+        void Update(T entity);
+        void Delete(T entity);
+    }
+}
diff --git a/src/ApplicationCore/Interfaces/ISpecification.cs b/src/ApplicationCore/Interfaces/ISpecification.cs
@@ -0,0 +1,13 @@
+using System;
+using System.Collections.Generic;
+using System.Linq.Expressions;
+
+namespace ApplicationCore.Interfaces
+{
+    public interface ISpecification<T>
+    {
+        Expression<Func<T, bool>> Criteria { get; }
+        List<Expression<Func<T, object>>> Includes { get; }
+        void AddInclude(Expression<Func<T, object>> includeExpression);
+    }
+}
diff --git a/src/ApplicationCore/Interfaces/IUriComposer.cs b/src/ApplicationCore/Interfaces/IUriComposer.cs
@@ -1,4 +1,7 @@
-namespace ApplicationCore.Interfaces
+using Microsoft.eShopWeb.ApplicationCore.Entities;
+using System.Collections.Generic;
+
+namespace ApplicationCore.Interfaces
 {
 
     public interface IUriComposer

diff --git a/src/ApplicationCore/Services/UriComposer.cs b/src/ApplicationCore/Services/UriComposer.cs
@@ -7,10 +7,8 @@ public class UriComposer : IUriComposer
     {
         private readonly CatalogSettings _catalogSettings;
 
-        public UriComposer(CatalogSettings catalogSettings)
-        {
-            _catalogSettings = catalogSettings;
-        }
+        public UriComposer(CatalogSettings catalogSettings) => _catalogSettings = catalogSettings;
+
         public string ComposePicUri(string uriTemplate)
         {
             return uriTemplate.Replace("http://catalogbaseurltobereplaced", _catalogSettings.CatalogBaseUrl);

diff --git a/src/ApplicationCore/Specifications/BasketWithItemsSpecification.cs b/src/ApplicationCore/Specifications/BasketWithItemsSpecification.cs
@@ -0,0 +1,28 @@
+using ApplicationCore.Interfaces;
+using Microsoft.eShopWeb.ApplicationCore.Entities;
+using System;
+using System.Linq.Expressions;
+using System.Collections.Generic;
+
+namespace ApplicationCore.Specifications
+{
+    public class BasketWithItemsSpecification : ISpecification<Basket>
+    {
+        public BasketWithItemsSpecification(int basketId)
+        {
+            BasketId = basketId;
+            AddInclude(b => b.Items);
+        }
+
+        public int BasketId { get; }
+
+        public Expression<Func<Basket, bool>> Criteria => b => b.Id == BasketId;
+
+        public List<Expression<Func<Basket, object>>> Includes { get; } = new List<Expression<Func<Basket, object>>>();
+
+        public void AddInclude(Expression<Func<Basket, object>> includeExpression)
+        {
+            Includes.Add(includeExpression);
+        }
+    }
+}
diff --git a/src/ApplicationCore/Specifications/CatalogFilterSpecification.cs b/src/ApplicationCore/Specifications/CatalogFilterSpecification.cs
@@ -0,0 +1,32 @@
+using ApplicationCore.Interfaces;
+using Microsoft.eShopWeb.ApplicationCore.Entities;
+using System;
+using System.Linq.Expressions;
+using System.Collections.Generic;
+
+namespace ApplicationCore.Specifications
+{
+
+    public class CatalogFilterSpecification : ISpecification<CatalogItem>
+    {
+        public CatalogFilterSpecification(int? brandId, int? typeId)
+        {
+            BrandId = brandId;
+            TypeId = typeId;
+        }
+
+        public int? BrandId { get; }
+        public int? TypeId { get; }
+
+        public Expression<Func<CatalogItem, bool>> Criteria => 
+            i => (!BrandId.HasValue || i.CatalogBrandId == BrandId) && 
+                (!TypeId.HasValue || i.CatalogTypeId == TypeId);
+
+        public List<Expression<Func<CatalogItem, object>>> Includes { get; }  = new List<Expression<Func<CatalogItem, object>>>();
+
+        public void AddInclude(Expression<Func<CatalogItem, object>> includeExpression)
+        {
+            Includes.Add(includeExpression);
+        }
+    }
+}
diff --git a/src/Infrastructure/Data/EfRepository.cs b/src/Infrastructure/Data/EfRepository.cs
@@ -0,0 +1,59 @@
+using ApplicationCore.Interfaces;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.eShopWeb.ApplicationCore.Entities;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Infrastructure.Data
+{
+    public class EfRepository<T> : IRepository<T> where T : BaseEntity
+    {
+        private readonly CatalogContext _dbContext;
+
+        public EfRepository(CatalogContext dbContext)
+        {
+            _dbContext = dbContext;
+        }
+
+        public T GetById(int id)
+        {
+            return _dbContext.Set<T>().SingleOrDefault(e => e.Id == id);
+        }
+
+        public List<T> List()
+        {
+            return _dbContext.Set<T>().ToList();
+        }
+
+        public List<T> List(ISpecification<T> spec)
+        {
+            var queryableResultWithIncludes = spec.Includes
+                .Aggregate(_dbContext.Set<T>().AsQueryable(), 
+                            (current, include) => current.Include(include));
+            return queryableResultWithIncludes
+                            .Where(spec.Criteria)
+                            .ToList();
+        }
+
+        public T Add(T entity)
+        {
+            _dbContext.Set<T>().Add(entity);
+            _dbContext.SaveChanges();
+
+            return entity;
+        }
+
+        public void Delete(T entity)
+        {
+            _dbContext.Set<T>().Remove(entity);
+            _dbContext.SaveChanges();
+        }
+
+        public void Update(T entity)
+        {
+            _dbContext.Entry(entity).State = EntityState.Modified;
+            _dbContext.SaveChanges();
+        }
+
+    }
+}
diff --git a/src/Infrastructure/Infrastructure.csproj b/src/Infrastructure/Infrastructure.csproj
@@ -22,5 +22,8 @@
     <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.DotNet" Version="1.0.1" />
     <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Design" Version="1.1.2" />
   </ItemGroup>
+  <ItemGroup>
+    <Folder Include="Services\" />
+  </ItemGroup>
 
 </Project>
diff --git a/src/Infrastructure/Services/BasketService.cs b/src/Infrastructure/Services/BasketService.cs