chore: Merge pull request #861 from MapsterMapper/development

Merge Development to Master - Release v10.0.0

Author: DocSvartz

README.md

@@ -26,7 +26,6 @@ Writing mapping methods is a machine job. Do not waste your time, let Mapster do
 |------|--------|-------------|
 | **Mapster.Tool** | [![Mapster.Tool](https://img.shields.io/nuget/v/Mapster.Tool.svg?label=Mapster.Tool&color=informational)](https://www.nuget.org/packages/Mapster.Tool/latest) | [![Mapster.Tool](https://img.shields.io/nuget/vpre/Mapster.Tool.svg?label=Mapster.Tool&color=orange)](https://www.nuget.org/packages/Mapster.Tool) |
 
-_Badges zeigen die jeweils aktuellste Stable-Version und die aktuellste Pre-Release-Version._
 
 ## Installation
 
@@ -105,7 +104,7 @@ using (MyDbContext context = new MyDbContext())
 
 ### Generating models & mappers
 
-No need to write your own DTO classes. Mapster provides [Mapster.Tool](https://github.com/MapsterMapper/Mapster/wiki/Mapster.Tool) to help you generating models. And if you would like to have explicit mapping, Mapster also generates mapper class for you.
+No need to write your own DTO classes. Mapster provides [Mapster.Tool](https://mapstermapper.github.io/Mapster/articles/tools/mapster-tool/Mapster-Tool-Overview.html) to help you generating models. And if you would like to have explicit mapping, Mapster also generates mapper class for you.
 
 ```csharp
 [AdaptTo("[name]Dto"), GenerateMapper]
@@ -129,14 +128,14 @@ public static class StudentMapper {
 
 ## What's new
 
-- [Fluent API for code generation](https://github.com/MapsterMapper/Mapster/wiki/Fluent-API-Code-generation)
-- [Automatically generate mapping code on build](https://github.com/MapsterMapper/Mapster/wiki/Mapster.Tool)
-- [Define setting to nested mapping](https://github.com/MapsterMapper/Mapster/wiki/Config-for-nested-mapping)
-- [`ISet`, `IDictionary`, `IReadOnlyDictionary` support](https://github.com/MapsterMapper/Mapster/wiki/Data-types#collections)
-- [`EmptyCollectionIfNull`, `CreateNewIfNull` DestinationTransform](https://github.com/MapsterMapper/Mapster/wiki/Setting-values#transform-value)
+- [Fluent API for code generation](https://mapstermapper.github.io/Mapster/articles/tools/mapster-tool/Fluent-API-Code-generation.html)
+- [Automatically generate mapping code on build](https://mapstermapper.github.io/Mapster/articles/tools/mapster-tool/Mapster-Tool-Overview.html)
+- [Define setting to nested mapping](https://mapstermapper.github.io/Mapster/articles/configuration/Config-for-nested-mapping.html)
+- [`ISet`, `IDictionary`, `IReadOnlyDictionary` support](https://mapstermapper.github.io/Mapster/articles/mapping/Data-types.html#collections)
+- [`EmptyCollectionIfNull`, `CreateNewIfNull` DestinationTransform](https://mapstermapper.github.io/Mapster/articles/settings/Setting-values.html#transform-value)
 - [Several fixes](https://github.com/MapsterMapper/Mapster/releases/)
 - New plugins
-  - [Immutable collection support](https://github.com/MapsterMapper/Mapster/wiki/Immutable)
+  - [Immutable collection support](https://mapstermapper.github.io/Mapster/articles/packages/Immutable.html)
 
 ## Why Mapster?
 
@@ -145,8 +144,8 @@ public static class StudentMapper {
 Mapster was designed to be efficient on both speed and memory. You could gain a 4x performance improvement whilst using only 1/3 of memory.
 And you could gain up to 12x faster performance with:
 
-- [Roslyn Compiler](https://github.com/MapsterMapper/Mapster/wiki/Debugging)
-- [FEC](https://github.com/MapsterMapper/Mapster/wiki/FastExpressionCompiler)
+- [Roslyn Compiler](https://mapstermapper.github.io/Mapster/articles/packages/ExpressionDebugging.html)
+- [FEC](https://mapstermapper.github.io/Mapster/articles/packages/FastExpressionCompiler.html)
 - Code generation
 
 |                    Method |      Mean |    StdDev |     Error |      Gen 0 | Gen 1 | Gen 2 | Allocated |
@@ -175,8 +174,8 @@ Code generation allows you to
 
 There are currently two tools which you can choose based on your preferences.
 
-- [Mapster.Tool](https://github.com/MapsterMapper/Mapster/wiki/Mapster.Tool) _**NEW!**_
-- [TextTemplate](https://github.com/MapsterMapper/Mapster/wiki/TextTemplate)
+- [Mapster.Tool](https://mapstermapper.github.io/Mapster/articles/tools/mapster-tool/Mapster-Tool-Overview.html) _**NEW!**_
+- [TextTemplate](https://mapstermapper.github.io/Mapster/articles/tools/TextTemplate.html)
 
 ## Change logs
 

docs/Clean-and-Build-Docs.ps1

@@ -30,7 +30,7 @@ Write-Information "Cleaning obsolete API documentation..." -InformationAction Co
 # Step 3: Build documentation
 Write-Information "Building documentation..." -InformationAction Continue
 
-& .\Build-Docs.ps1 -LogLevel $LogLevel -serve $true -open-browser $true
+& .\Build-Docs.ps1 -LogLevel $LogLevel -serve $true -openbrowser $true
 
 if ($LASTEXITCODE -ne 0) {
     Write-Error "Documentation build failed"

docs/articles/mapping/Data-types.md

@@ -94,6 +94,77 @@ var dict = point.Adapt<Dictionary<string, int>>();
 dict["Y"].ShouldBe(3);
 ```
 
+## Record types
+
+>[!IMPORTANT]
+> Mapster treats Record type as an immutable type.
+> Only a Nondestructive mutation - creating a new object with modified properties.
+>
+> ```csharp
+> var result = source.adapt(data) 
+>//equal var result = data with { X = source.X.Adapt(), ...}
+>```
+
+### Features and Limitations:
+
+# [v10.0](#tab/Records-v10)
+
+>[!NOTE]
+> By default, all [C# Records](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/record) are defined as a record type.
+> Limitations by count of constructors and constructor parameters used in Mapster version 7.4.0 do not apply.
+
+
+#### Using default value in constuctor param
+
+If the source type does not contain members that can be used as constructor parameters, then will be used the default values ​​for the parameter type.
+
+Example: 
+
+```csharp
+
+class SourceData
+{
+   public string MyString {get; set;}
+}
+
+record RecordDestination(int myInt, string myString);
+
+var result = source.Adapt<RecordDestination>()
+
+// equal var result = new RecordDestination (default(int),source.myString)
+
+```
+
+#### MultyConsturctor Record types
+
+If there is more than one constructor, by default, mapping will be performed on the constructor with the largest number of parameters.
+
+Example: 
+
+```csharp
+record MultiCtorRecord
+{
+    public MultiCtorRecord(int myInt)
+    {
+        MyInt = myInt;
+    }
+
+    public MultiCtorRecord(int myInt, string myString) // This constructor will be used
+        : this(myInt) 
+    {
+        MyString = myString; 
+    }
+
+}
+```
+
+# [v7.4.0](#tab/Records-v7-4-0)
+
+>[!NOTE]
+>Record type must not have a setter and have only one non-empty constructor, and all parameter names must match with properties.
+
+Otherwise you need to add [`MapToConstructor` configuration](xref:Mapster.Settings.ConstructorMapping#map-to-constructor).
+
 Example for record types:
 
 ```csharp
@@ -110,5 +181,12 @@ class Person {
 var src = new { Name = "Mapster", Age = 3 };
 var target = src.Adapt<Person>();
 ```
+---
+
+### Support additional mapping features:
 
-There are limitations to map Record type automatically. Record type must not have a setter and have only one non-empty constructor, and all parameter names must match with properties. Otherwise you need to add [`MapToConstructor` configuration](xref:Mapster.Settings.ConstructorMapping#map-to-constructor).
+| Mapping features | v7.4.0 | v10.0 |
+|:-----------------|:------:|:-----:|
+|[Custom constructor mapping](xref:Mapster.Settings.ConstructorMapping)| - | ✅ |
+|[Ignore](xref:Mapster.Settings.Custom.IgnoringMembers#ignore-extension-method)| - | ✅ |
+|[IgnoreNullValues](xref:Mapster.Settings.Custom.IgnoringMembers#ignorenullvalues-extension-method)| - | ✅ |

src/Benchmark/Benchmark.csproj

@@ -19,11 +19,10 @@
       </Compile>
     </ItemGroup>
     <ItemGroup>
-        <PackageReference Include="BenchmarkDotNet" Version="0.14.0" />
+        <PackageReference Include="BenchmarkDotNet" Version="0.15.8" />
         <PackageReference Include="ExpressionDebugger" Version="2.2.1" />
         <PackageReference Include="ExpressionTranslator" Version="2.5.0" />
-        <PackageReference Include="AutoMapper" Version="13.0.1" />
-        <PackageReference Include="FastExpressionCompiler" Version="5.0.0" />
+        <PackageReference Include="FastExpressionCompiler" Version="5.3.0" />
     </ItemGroup>
     <ItemGroup>
         <ProjectReference Include="..\ExpressionDebugger\ExpressionDebugger.csproj" />

src/Benchmark/Benchmarks/TestAll.cs

@@ -11,47 +11,47 @@ public class TestAll
         [Params(100_000)]//, 1_000_000)]
         public int Iterations { get; set; }
 
-        [Benchmark(Description = "Mapster 7.2.0")]
+        [Benchmark(Description = $"Mapster {TestAdaptHelper.MapsterVersion}")]
         public void MapsterTest()
         {
             TestAdaptHelper.TestMapsterAdapter<Foo, Foo>(_fooInstance, Iterations);
             TestAdaptHelper.TestMapsterAdapter<Customer, CustomerDTO>(_customerInstance, Iterations);
         }
 
-        [Benchmark(Description = "Mapster 7.2.0 (Roslyn)")]
+        [Benchmark(Description = $"Mapster {TestAdaptHelper.MapsterVersion} (Roslyn)")]
         public void RoslynTest()
         {
             TestAdaptHelper.TestMapsterAdapter<Foo, Foo>(_fooInstance, Iterations);
             TestAdaptHelper.TestMapsterAdapter<Customer, CustomerDTO>(_customerInstance, Iterations);
         }
 
-        [Benchmark(Description = "Mapster 7.2.0 (FEC)")]
+        [Benchmark(Description = $"Mapster {TestAdaptHelper.MapsterVersion} (FEC)")]
         public void FecTest()
         {
             TestAdaptHelper.TestMapsterAdapter<Foo, Foo>(_fooInstance, Iterations);
             TestAdaptHelper.TestMapsterAdapter<Customer, CustomerDTO>(_customerInstance, Iterations);
         }
 
-        [Benchmark(Description = "Mapster 7.2.0 (Codegen)")]
+        [Benchmark(Description = $"Mapster {TestAdaptHelper.MapsterVersion} (Codegen)")]
         public void CodegenTest()
         {
             TestAdaptHelper.TestCodeGen(_fooInstance, Iterations);
             TestAdaptHelper.TestCodeGen(_customerInstance, Iterations);
         }
 
-        [Benchmark(Description = "ExpressMapper 1.9.1")]
+        [Benchmark(Description = $"ExpressMapper {TestAdaptHelper.ExpressionMapperVersion}")]
         public void ExpressMapperTest()
         {
             TestAdaptHelper.TestExpressMapper<Foo, Foo>(_fooInstance, Iterations);
             TestAdaptHelper.TestExpressMapper<Customer, CustomerDTO>(_customerInstance, Iterations);
         }
 
-        [Benchmark(Description = "AutoMapper 10.1.1")]
-        public void AutoMapperTest()
-        {
-            TestAdaptHelper.TestAutoMapper<Foo, Foo>(_fooInstance, Iterations);
-            TestAdaptHelper.TestAutoMapper<Customer, CustomerDTO>(_customerInstance, Iterations);
-        }
+        //[Benchmark(Description = $"AutoMapper {TestAdaptHelper.AutoMapperVersion}")]
+        //public void AutoMapperTest()
+        //{
+        //    TestAdaptHelper.TestAutoMapper<Foo, Foo>(_fooInstance, Iterations);
+        //    TestAdaptHelper.TestAutoMapper<Customer, CustomerDTO>(_customerInstance, Iterations);
+        //}
 
         [GlobalSetup(Target = nameof(MapsterTest))]
         public void SetupMapster()
@@ -98,14 +98,14 @@ public void SetupExpressMapper()
             TestAdaptHelper.ConfigureExpressMapper(_customerInstance);
         }
 
-        [GlobalSetup(Target = nameof(AutoMapperTest))]
-        public void SetupAutoMapper()
-        {
-            _fooInstance = TestAdaptHelper.SetupFooInstance();
-            _customerInstance = TestAdaptHelper.SetupCustomerInstance();
-            TestAdaptHelper.ConfigureAutoMapper(_fooInstance);
-            TestAdaptHelper.ConfigureAutoMapper(_customerInstance);
-        }
+        //[GlobalSetup(Target = nameof(AutoMapperTest))]
+        //public void SetupAutoMapper()
+        //{
+        //    _fooInstance = TestAdaptHelper.SetupFooInstance();
+        //    _customerInstance = TestAdaptHelper.SetupCustomerInstance();
+        //    TestAdaptHelper.ConfigureAutoMapper(_fooInstance);
+        //    TestAdaptHelper.ConfigureAutoMapper(_customerInstance);
+        //}
 
     }
 }

src/Benchmark/Benchmarks/TestComplexTypes.cs

@@ -16,13 +16,13 @@ public void MapsterTest()
             TestAdaptHelper.TestMapsterAdapter<Customer, CustomerDTO>(_customerInstance, Iterations);
         }
 
-        [Benchmark(Description = "Mapster 6.0.0 (Roslyn)")]
+        [Benchmark(Description = $"Mapster {TestAdaptHelper.MapsterVersion} (Roslyn)")]
         public void RoslynTest()
         {
             TestAdaptHelper.TestMapsterAdapter<Customer, CustomerDTO>(_customerInstance, Iterations);
         }
 
-        [Benchmark(Description = "Mapster 6.0.0 (FEC)")]
+        [Benchmark(Description = $"Mapster {TestAdaptHelper.MapsterVersion} (FEC)")]
         public void FecTest()
         {
             TestAdaptHelper.TestMapsterAdapter<Customer, CustomerDTO>(_customerInstance, Iterations);
@@ -40,11 +40,11 @@ public void ExpressMapperTest()
             TestAdaptHelper.TestExpressMapper<Customer, CustomerDTO>(_customerInstance, Iterations);
         }
 
-        [Benchmark]
-        public void AutoMapperTest()
-        {
-            TestAdaptHelper.TestAutoMapper<Customer, CustomerDTO>(_customerInstance, Iterations);
-        }
+        //[Benchmark]
+        //public void AutoMapperTest()
+        //{
+        //    TestAdaptHelper.TestAutoMapper<Customer, CustomerDTO>(_customerInstance, Iterations);
+        //}
 
         [GlobalSetup(Target = nameof(MapsterTest))]
         public void SetupMapster()
@@ -81,11 +81,11 @@ public void SetupExpressMapper()
             TestAdaptHelper.ConfigureExpressMapper(_customerInstance);
         }
 
-        [GlobalSetup(Target = nameof(AutoMapperTest))]
-        public void SetupAutoMapper()
-        {
-            _customerInstance = TestAdaptHelper.SetupCustomerInstance();
-            TestAdaptHelper.ConfigureAutoMapper(_customerInstance);
-        }
+        //[GlobalSetup(Target = nameof(AutoMapperTest))]
+        //public void SetupAutoMapper()
+        //{
+        //    _customerInstance = TestAdaptHelper.SetupCustomerInstance();
+        //    TestAdaptHelper.ConfigureAutoMapper(_customerInstance);
+        //}
     }
 }

src/Benchmark/Benchmarks/TestSimpleTypes.cs

@@ -16,13 +16,13 @@ public void MapsterTest()
             TestAdaptHelper.TestMapsterAdapter<Foo, Foo>(_fooInstance, Iterations);
         }
 
-        [Benchmark(Description = "Mapster 6.0.0 (Roslyn)")]
+        [Benchmark(Description = $"Mapster {TestAdaptHelper.MapsterVersion} (Roslyn)")]
         public void RoslynTest()
         {
             TestAdaptHelper.TestMapsterAdapter<Foo, Foo>(_fooInstance, Iterations);
         }
 
-        [Benchmark(Description = "Mapster 6.0.0 (FEC)")]
+        [Benchmark(Description = $"Mapster {TestAdaptHelper.MapsterVersion} (FEC)")]
         public void FecTest()
         {
             TestAdaptHelper.TestMapsterAdapter<Foo, Foo>(_fooInstance, Iterations);
@@ -40,11 +40,11 @@ public void ExpressMapperTest()
             TestAdaptHelper.TestExpressMapper<Foo, Foo>(_fooInstance, Iterations);
         }
 
-        [Benchmark]
-        public void AutoMapperTest()
-        {
-            TestAdaptHelper.TestAutoMapper<Foo, Foo>(_fooInstance, Iterations);
-        }
+        //[Benchmark]
+        //public void AutoMapperTest()
+        //{
+        //    TestAdaptHelper.TestAutoMapper<Foo, Foo>(_fooInstance, Iterations);
+        //}
 
 
         [GlobalSetup(Target = nameof(MapsterTest))]
@@ -82,11 +82,11 @@ public void SetupExpressMapper()
             TestAdaptHelper.ConfigureExpressMapper(_fooInstance);
         }
 
-        [GlobalSetup(Target = nameof(AutoMapperTest))]
-        public void SetupAutoMapper()
-        {
-            _fooInstance = TestAdaptHelper.SetupFooInstance();
-            TestAdaptHelper.ConfigureAutoMapper(_fooInstance);
-        }
+        //[GlobalSetup(Target = nameof(AutoMapperTest))]
+        //public void SetupAutoMapper()
+        //{
+        //    _fooInstance = TestAdaptHelper.SetupFooInstance();
+        //    TestAdaptHelper.ConfigureAutoMapper(_fooInstance);
+        //}
     }
 }