Merge pull request #237 from EasyAbp/add-product-overview

Add the `Overview` property to the `Product` entity
EasyAbp · Mar 27, 2023 · cb2e466 · cb2e466
2 parents a5261a9 + ec29b29
commit cb2e466
Show file tree

Hide file tree

Showing 18 changed files with 6,476 additions and 32 deletions.
diff --git a/...ucts.Application.Contracts/EasyAbp/EShop/Products/Products/Dtos/CreateUpdateProductDto.cs b/...ucts.Application.Contracts/EasyAbp/EShop/Products/Products/Dtos/CreateUpdateProductDto.cs
@@ -30,6 +30,9 @@ public class CreateUpdateProductDto : ExtensibleObject, IMultiStore
         [DisplayName("ProductDisplayName")]
         public string DisplayName { get; set; }
 
+        [DisplayName("ProductOverview")]
+        public string Overview { get; set; }
+
         public ICollection<CreateUpdateProductAttributeDto> ProductAttributes { get; set; }
 
         [DisplayName("ProductInventoryStrategy")]

diff --git a/...p.EShop.Products.Application.Contracts/EasyAbp/EShop/Products/Products/Dtos/ProductDto.cs b/...p.EShop.Products.Application.Contracts/EasyAbp/EShop/Products/Products/Dtos/ProductDto.cs
@@ -9,48 +9,50 @@ namespace EasyAbp.EShop.Products.Products.Dtos
     public class ProductDto : ExtensibleFullAuditedEntityDto<Guid>
     {
         public Guid StoreId { get; set; }
-        
+
         public string ProductGroupName { get; set; }
-        
+
         public string ProductGroupDisplayName { get; set; }
 
         public Guid? ProductDetailId { get; set; }
 
         public string UniqueName { get; set; }
-        
+
         public string DisplayName { get; set; }
-
+
+        public string Overview { get; set; }
+
         public InventoryStrategy InventoryStrategy { get; set; }
-        
+
         public string InventoryProviderName { get; set; }
 
         public string MediaResources { get; set; }
-        
+
         public int DisplayOrder { get; set; }
 
         public bool IsPublished { get; set; }
-        
+
         public bool IsStatic { get; set; }
-        
+
         public bool IsHidden { get; set; }
-        
+
         public TimeSpan? PaymentExpireIn { get; set; }
 
         public long Sold { get; set; }
-        
+
         public decimal? MinimumPrice { get; set; }
-        
+
         public decimal? MaximumPrice { get; set; }
 
         public List<ProductAttributeDto> ProductAttributes { get; set; }
-        
+
         public List<ProductSkuDto> ProductSkus { get; set; }
 
         public ProductSkuDto GetSkuById(Guid skuId)
         {
             return ProductSkus.Single(x => x.Id == skuId);
         }
-        
+
         public ProductSkuDto FindSkuById(Guid skuId)
         {
             return ProductSkus.FirstOrDefault(x => x.Id == skuId);

diff --git a/...hop.Products.Application.Contracts/EasyAbp/EShop/Products/Products/Dtos/ProductViewDto.cs b/...hop.Products.Application.Contracts/EasyAbp/EShop/Products/Products/Dtos/ProductViewDto.cs
@@ -17,6 +17,8 @@ public class ProductViewDto : ExtensibleCreationAuditedEntityDto<Guid>
 
         public string DisplayName { get; set; }
 
+        public string Overview { get; set; }
+
         public InventoryStrategy InventoryStrategy { get; set; }
 
         public string InventoryProviderName { get; set; }
@@ -32,9 +34,9 @@ public class ProductViewDto : ExtensibleCreationAuditedEntityDto<Guid>
         public bool IsHidden { get; set; }
 
         public decimal? MinimumPrice { get; set; }
-        
+
         public decimal? MaximumPrice { get; set; }
-        
+
         public long Sold { get; set; }
 
         public string ProductGroupDisplayName { get; set; }

diff --git a/...c/EasyAbp.EShop.Products.Application/EasyAbp/EShop/Products/Products/ProductAppService.cs b/...c/EasyAbp.EShop.Products.Application/EasyAbp/EShop/Products/Products/ProductAppService.cs
@@ -490,6 +490,7 @@ protected override Task<Product> MapToEntityAsync(CreateUpdateProductDto createI
                 createInput.ProductDetailId,
                 createInput.UniqueName,
                 createInput.DisplayName,
+                createInput.Overview,
                 createInput.InventoryStrategy,
                 createInput.InventoryProviderName,
                 createInput.IsPublished,
@@ -512,6 +513,7 @@ protected override Task MapToEntityAsync(CreateUpdateProductDto updateInput, Pro
                 updateInput.ProductDetailId,
                 updateInput.UniqueName,
                 updateInput.DisplayName,
+                updateInput.Overview,
                 updateInput.InventoryStrategy,
                 updateInput.InventoryProviderName,
                 updateInput.IsPublished,

diff --git a/...EasyAbp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Localization/Products/en.json b/...EasyAbp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Localization/Products/en.json
@@ -12,6 +12,8 @@
     "ProductDetailId": "Product detail ID",
     "ProductUniqueName": "Unique name",
     "ProductDisplayName": "Display name",
+    "ProductOverview": "Overview text",
+    "ProductOverviewPlaceholder": "A one-sentence description of this product, usually displayed in the product list.",
     "ProductDisplayOrder": "Display order",
     "ProductSold": "Sold",
     "ProductDetailDescription": "Description",

diff --git a/...bp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Localization/Products/zh-Hans.json b/...bp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Localization/Products/zh-Hans.json
@@ -12,6 +12,8 @@
     "ProductDetailId": "商品详情 ID",
     "ProductUniqueName": "商品编号",
     "ProductDisplayName": "商品名称",
+    "ProductOverview": "商品文本概述",
+    "ProductOverviewPlaceholder": "用一句话描述此商品，通常显示于商品列表",
     "ProductDisplayOrder": "展示顺序",
     "ProductSold": "已售",
     "ProductDetailDescription": "详情介绍",

diff --git a/...bp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Localization/Products/zh-Hant.json b/...bp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Localization/Products/zh-Hant.json
@@ -12,6 +12,8 @@
     "ProductDetailId": "商品詳情 ID",
     "ProductUniqueName": "商品編號",
     "ProductDisplayName": "商品名稱",
+    "ProductOverview": "商品文本概述",
+    "ProductOverviewPlaceholder": "用一句话描述此商品，通常显示于商品列表",
     "ProductDisplayOrder": "展示順序",
     "ProductSold": "已售",
     "ProductDetailDescription": "詳情介紹",

diff --git a/...ucts/src/EasyAbp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Products/IProduct.cs b/...ucts/src/EasyAbp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Products/IProduct.cs
@@ -15,6 +15,8 @@ public interface IProduct : IHasExtraProperties, IMultiStore
 
         string DisplayName { get; }
 
+        string Overview { get; }
+
         InventoryStrategy InventoryStrategy { get; }
 
         [CanBeNull] string InventoryProviderName { get; }

diff --git a/...ts/src/EasyAbp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Products/ProductEto.cs b/...ts/src/EasyAbp.EShop.Products.Domain.Shared/EasyAbp/EShop/Products/Products/ProductEto.cs
@@ -21,6 +21,8 @@ public class ProductEto : ExtensibleObject, IProduct, IMultiTenant
 
         public string DisplayName { get; set; }
 
+        public string Overview { get; set; }
+
         public InventoryStrategy InventoryStrategy { get; set; }
 
         public string InventoryProviderName { get; set; }

diff --git a/...hop.Products/src/EasyAbp.EShop.Products.Domain/EasyAbp/EShop/Products/Products/Product.cs b/...hop.Products/src/EasyAbp.EShop.Products.Domain/EasyAbp/EShop/Products/Products/Product.cs
@@ -25,6 +25,12 @@ public class Product : FullAuditedAggregateRoot<Guid>, IProduct, IMultiTenant
         [NotNull]
         public virtual string DisplayName { get; protected set; }
 
+        /// <summary>
+        /// Tell your customer what the product is. It is usually shown in the product list.
+        /// </summary>
+        [CanBeNull]
+        public virtual string Overview { get; protected set; }
+
         public virtual InventoryStrategy InventoryStrategy { get; protected set; }
 
         /// <summary>
@@ -62,6 +68,7 @@ public Product(
             Guid? productDetailId,
             [CanBeNull] string uniqueName,
             [NotNull] string displayName,
+            [CanBeNull] string overview,
             InventoryStrategy inventoryStrategy,
             [CanBeNull] string inventoryProviderName,
             bool isPublished,
@@ -76,6 +83,7 @@ int displayOrder
             StoreId = storeId;
             ProductGroupName = Check.NotNullOrWhiteSpace(productGroupName, nameof(productGroupName));
             ProductDetailId = productDetailId;
+            Overview = overview;
             UniqueName = uniqueName?.Trim();
             DisplayName = Check.NotNullOrWhiteSpace(displayName, nameof(displayName));
             InventoryStrategy = inventoryStrategy;
@@ -97,6 +105,7 @@ public void Update(
             Guid? productDetailId,
             [CanBeNull] string uniqueName,
             [NotNull] string displayName,
+            [CanBeNull] string overview,
             InventoryStrategy inventoryStrategy,
             [CanBeNull] string inventoryProviderName,
             bool isPublished,
@@ -111,6 +120,7 @@ public void Update(
             ProductDetailId = productDetailId;
             UniqueName = uniqueName?.Trim();
             DisplayName = Check.NotNullOrWhiteSpace(displayName, nameof(displayName));
+            Overview = overview;
             InventoryStrategy = inventoryStrategy;
             InventoryProviderName = inventoryProviderName;
             IsPublished = isPublished;

diff --git a/...Products/src/EasyAbp.EShop.Products.Domain/EasyAbp/EShop/Products/Products/ProductView.cs b/...Products/src/EasyAbp.EShop.Products.Domain/EasyAbp/EShop/Products/Products/ProductView.cs
@@ -20,6 +20,8 @@ public class ProductView : CreationAuditedAggregateRoot<Guid>, IProduct, IMultiT
 
         public virtual string DisplayName { get; protected set; }
 
+        public virtual string Overview { get; protected set; }
+
         public virtual InventoryStrategy InventoryStrategy { get; protected set; }
 
         public string InventoryProviderName { get; protected set; }
@@ -56,6 +58,7 @@ public ProductView(
             Guid? productDetailId,
             string uniqueName,
             string displayName,
+            string overview,
             InventoryStrategy inventoryStrategy,
             string inventoryProviderName,
             bool isPublished,
@@ -75,6 +78,7 @@ long sold
             ProductDetailId = productDetailId;
             UniqueName = uniqueName?.Trim();
             DisplayName = displayName;
+            Overview = overview;
             InventoryStrategy = inventoryStrategy;
             InventoryProviderName = inventoryProviderName;
             IsPublished = isPublished;

diff --git a/...oducts.Web/Pages/EShop/Products/Products/Product/ViewModels/CreateEditProductViewModel.cs b/...oducts.Web/Pages/EShop/Products/Products/Product/ViewModels/CreateEditProductViewModel.cs
@@ -13,7 +13,7 @@ public class CreateEditProductViewModel : IValidatableObject
         [HiddenInput]
         [Display(Name = "ProductStoreId")]
         public Guid StoreId { get; set; }
-        
+
         [Required]
         [SelectItems("ProductGroups")]
         [Display(Name = "ProductProductGroupName")]
@@ -30,18 +30,22 @@ public class CreateEditProductViewModel : IValidatableObject
 
         [Display(Name = "ProductUniqueName")]
         public string UniqueName { get; set; }
-        
+
         [Required]
         [Display(Name = "ProductDisplayName")]
         public string DisplayName { get; set; }
 
+        [Placeholder("ProductOverviewPlaceholder")]
+        [Display(Name = "ProductOverview")]
+        public string Overview { get; set; }
+
         public CreateEditProductDetailViewModel ProductDetail { get; set; } = new();
 
         [Required]
         [Placeholder("ProductAttributeNamesPlaceholder")]
         [Display(Name = "ProductAttributeNames")]
         public string ProductAttributeNames { get; set; }
-        
+
         [Required]
         [TextArea(Rows = 4)]
         [Placeholder("ProductAttributeOptionNamesPlaceholder")]
@@ -60,13 +64,13 @@ public class CreateEditProductViewModel : IValidatableObject
 
         [Display(Name = "ProductMediaResources")]
         public string MediaResources { get; set; }
-        
+
         [Display(Name = "ProductIsPublished")]
         public bool IsPublished { get; set; }
-        
+
         [Display(Name = "ProductIsHidden")]
         public bool IsHidden { get; set; }
-        
+
         [Display(Name = "ProductPaymentExpireIn")]
         public TimeSpan? PaymentExpireIn { get; set; }
 
@@ -76,7 +80,7 @@ public IEnumerable<ValidationResult> Validate(ValidationContext validationContex
             {
                 yield return new ValidationResult(
                     "The StoreId should be same as the ProductDetail.StoreId.",
-                    new[] {"StoreId"}
+                    new[] { "StoreId" }
                 );
             }
         }

diff --git a/...bp.EShop.Products/test/EasyAbp.EShop.Products.Domain.Tests/Products/ProductDomainTests.cs b/...bp.EShop.Products/test/EasyAbp.EShop.Products.Domain.Tests/Products/ProductDomainTests.cs
@@ -25,8 +25,8 @@ public ProductDomainTests()
         public async Task Should_Set_ProductDetailId()
         {
             var product2 = new Product(ProductsTestData.Product2Id, null, ProductsTestData.Store1Id, "Default",
-                ProductsTestData.ProductDetails2Id, "Ball", "Ball", InventoryStrategy.NoNeed, null, true, false, false,
-                null, null, 0);
+                ProductsTestData.ProductDetails2Id, "Ball", "Ball", null, InventoryStrategy.NoNeed, null, true, false,
+                false, null, null, 0);
             await ProductManager.CreateAsync(product2);
 
             product2 = await ProductRepository.GetAsync(product2.Id);
@@ -64,8 +64,8 @@ public async Task Should_Reuse_ProductDetail()
             product1.ProductDetailId.ShouldBe(ProductsTestData.ProductDetails1Id);
 
             var product2 = new Product(ProductsTestData.Product2Id, null, ProductsTestData.Store1Id, "Default",
-                ProductsTestData.ProductDetails2Id, "Ball", "Ball", InventoryStrategy.NoNeed, null, true, false, false,
-                null, null, 0);
+                ProductsTestData.ProductDetails2Id, "Ball", "Ball", null, InventoryStrategy.NoNeed, null, true, false,
+                false, null, null, 0);
 
             await ProductManager.CreateAsync(product2);
 
@@ -181,7 +181,7 @@ await ProductManager.CreateSkuAsync(product1, await CreateTestSkuAsync(new[]
         public async Task Should_Use_Fake_Inventory_Provider()
         {
             var product2 = new Product(ProductsTestData.Product2Id, null, ProductsTestData.Store1Id, "Default",
-                ProductsTestData.ProductDetails2Id, "Ball", "Ball", InventoryStrategy.NoNeed, "Fake", true, false,
+                ProductsTestData.ProductDetails2Id, "Ball", "Ball", null, InventoryStrategy.NoNeed, "Fake", true, false,
                 false, null, null, 0);
 
             await ProductManager.CreateAsync(product2);

diff --git a/...es/EasyAbp.EShop.Products/test/EasyAbp.EShop.Products.TestBase/ProductsTestDataBuilder.cs b/...es/EasyAbp.EShop.Products/test/EasyAbp.EShop.Products.TestBase/ProductsTestDataBuilder.cs
@@ -35,17 +35,18 @@ public void Build()
         public async Task BuildAsync()
         {
             using var uow = _unitOfWorkManager.Begin();
-            
+
             var productDetail1 = await _productDetailRepository.InsertAsync(
                 new ProductDetail(ProductsTestData.ProductDetails1Id, null, ProductsTestData.Store1Id,
                     "Product details for store 1"), true);
-            
+
             var productDetail2 = await _productDetailRepository.InsertAsync(
                 new ProductDetail(ProductsTestData.ProductDetails2Id, null, ProductsTestData.Store1Id,
                     "Product details for store 1"), true);
 
             var product = new Product(ProductsTestData.Product1Id, null, ProductsTestData.Store1Id, "Default",
-                productDetail1.Id, "Cake", "Cake", InventoryStrategy.NoNeed, null, true, false, false, null, null, 0);
+                productDetail1.Id, "Cake", "Cake", "Delicious cakes", InventoryStrategy.NoNeed, null, true, false,
+                false, null, null, 0);
 
             var attribute1 = new ProductAttribute(ProductsTestData.Product1Attribute1Id, "Size", null, 1);
             var attribute2 = new ProductAttribute(ProductsTestData.Product1Attribute2Id, "Color", null, 2);
@@ -57,7 +58,7 @@ public async Task BuildAsync()
                 new ProductAttributeOption(ProductsTestData.Product1Attribute1Option1Id, "S", null, 1),
                 new ProductAttributeOption(ProductsTestData.Product1Attribute1Option3Id, "L", null, 3),
             });
-            
+
             attribute2.ProductAttributeOptions.AddRange(new[]
             {
                 new ProductAttributeOption(ProductsTestData.Product1Attribute2Option2Id, "Green", null, 2),
@@ -83,7 +84,7 @@ await _attributeOptionIdsSerializer.SerializeAsync(new[]
                 await _attributeOptionIdsSerializer.SerializeAsync(new[]
                     { ProductsTestData.Product1Attribute1Option3Id, ProductsTestData.Product1Attribute2Option2Id }),
                 null, "USD", null, 3m, 1, 10, null, null, null);
-            
+
             await _productManager.CreateSkuAsync(product, productSku1);
             await _productManager.CreateSkuAsync(product, productSku2);
             await _productManager.CreateSkuAsync(product, productSku3);

diff --git a/samples/EShopSample/aspnet-core/src/EShopSample.Domain/Data/SampleDataSeedContributor.cs b/samples/EShopSample/aspnet-core/src/EShopSample.Domain/Data/SampleDataSeedContributor.cs
@@ -123,6 +123,7 @@ public virtual async Task SeedProductsAsync()
             null,
             SampleDataConsts.CakeProductUniqueName,
             "Cake",
+            "Delicious cakes",
             InventoryStrategy.NoNeed,
             null,
             true,
-Original file line number
+Diff line change
@@ Expand Up / @@ -123,6 +123,7 @@ public virtual async Task SeedProductsAsync() @@
                 null,
                 SampleDataConsts.CakeProductUniqueName,
                 "Cake",
+                "Delicious cakes",
                 InventoryStrategy.NoNeed,
                 null,
                 true,
@@ Expand Down @@