Moved WithObject to generated code, added FromTemplate (#43)

* Releasing v2.4-alpha
* Refactored template storage
* Refactores DTO mechanism
* Moved license file
* Added Directory.Build.props file

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+This project welcomes issues and pull requests, although it is an opinionated project. There are many ways to approach this particular problem, and I (Mel Grubb) captured my own preferences when I started this project.
+
+# Building
+
+# Testing
+
+There are currently five test projects.
+- BuilderGenerator.Tests.Core: Defines the domain objects used by other test projects.
+- BuilderGenerator.Tests.Unit: Directly exercises the builder mechanism to provide fast feedback and verification.
+- BuilderGenerator.Tests.Integration.Net60: Uses the builder generator in a more real-world way to create builders for a sample Net 6 library project.
+- BuilderGenerator.Tests.Integration.Net70: Same thing, but targeting .Net 7
+- BuilderGenerator.Tests.Integration.Net80: Same thing, but targeting .Net 8

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2023 Mel Grubb
+Copyright (c) 2021-2024 Mel Grubb
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -27,6 +27,11 @@ Install-Package BuilderGenerator
 After installation, create a partial class to define your builder in. Decorate it with the ```BuilderFor``` attribute, specifying the type of class that the builder is meant to build (e.g. ```[BuilderFor(typeof(Foo))]```. Define any factory and helper methods in this partial class. Meanwhile, another partial class definition will be auto-generated which contains all the "boring" parts such as the backing fields and "with" methods.
 
 ## Version History ##
+- v2.4.0
+    - Test code reorganization
+    - Moved WithObject from the base class to the generated builder class
+    - Added WithValuesFrom method to shallow clone an example object.
+
 - v2.3.0
     - Major caching and performance improvements
     - Internal code cleanup

src/BuilderGenerator.IntegrationTests.Core/BuilderGenerator.IntegrationTests.Core.csproj → src/BuilderGenerator.Tests.Core/BuilderGenerator.Tests.Core.csproj

@@ -5,12 +5,16 @@
     <IsPackable>false</IsPackable>
     <LangVersion>latest</LangVersion>
   </PropertyGroup>
+
   <ItemGroup>
     <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
-      <_Parameter1>BuilderGenerator.IntegrationTests.Net60</_Parameter1>
+      <_Parameter1>BuilderGenerator.Tests.Integration.Net60</_Parameter1>
+    </AssemblyAttribute>
+    <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
+      <_Parameter1>BuilderGenerator.Tests.Integration.Net70</_Parameter1>
     </AssemblyAttribute>
     <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
-      <_Parameter1>BuilderGenerator.IntegrationTests.Net60</_Parameter1>
+      <_Parameter1>BuilderGenerator.Tests.Integration.Net80</_Parameter1>
     </AssemblyAttribute>
   </ItemGroup>
-</Project>
+</Project>

src/BuilderGenerator.IntegrationTests.Core/Models/Entities/AuditableEntity.cs → src/BuilderGenerator.Tests.Core/Models/Entities/AuditableEntity.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace BuilderGenerator.IntegrationTests.Core.Models.Entities;
+namespace BuilderGenerator.Tests.Core.Models.Entities;
 
 public abstract class AuditableEntity : Entity
 {

src/BuilderGenerator.IntegrationTests.Core/Models/Entities/CollectionTypesSample.cs → src/BuilderGenerator.Tests.Core/Models/Entities/CollectionTypesSample.cs

@@ -1,7 +1,7 @@
 using System;
 using System.Collections.Generic;
 
-namespace BuilderGenerator.IntegrationTests.Core.Models.Entities;
+namespace BuilderGenerator.Tests.Core.Models.Entities;
 
 public class CollectionTypesSample
 {

src/BuilderGenerator.IntegrationTests.Core/Models/Entities/Entity.cs → src/BuilderGenerator.Tests.Core/Models/Entities/Entity.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace BuilderGenerator.IntegrationTests.Core.Models.Entities;
+namespace BuilderGenerator.Tests.Core.Models.Entities;
 
 public abstract class Entity
 {

src/BuilderGenerator.IntegrationTests.Core/Models/Entities/Order.cs → src/BuilderGenerator.Tests.Core/Models/Entities/Order.cs

@@ -1,8 +1,8 @@
 using System;
 using System.Collections.Generic;
-using BuilderGenerator.IntegrationTests.Core.Models.Enums;
+using BuilderGenerator.Tests.Core.Models.Enums;
 
-namespace BuilderGenerator.IntegrationTests.Core.Models.Entities;
+namespace BuilderGenerator.Tests.Core.Models.Entities;
 
 public class Order : AuditableEntity
 {

src/BuilderGenerator.IntegrationTests.Core/Models/Entities/OrderItem.cs → src/BuilderGenerator.Tests.Core/Models/Entities/OrderItem.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace BuilderGenerator.IntegrationTests.Core.Models.Entities;
+namespace BuilderGenerator.Tests.Core.Models.Entities;
 
 public class OrderItem : AuditableEntity
 {

src/BuilderGenerator.IntegrationTests.Core/Models/Entities/User.cs → src/BuilderGenerator.Tests.Core/Models/Entities/User.cs

@@ -1,17 +1,11 @@
-#nullable enable
-
 using System.Collections.Generic;
 
-namespace BuilderGenerator.IntegrationTests.Core.Models.Entities;
+namespace BuilderGenerator.Tests.Core.Models.Entities;
 
-public partial class User : AuditableEntity
+public class User : AuditableEntity
 {
     public string FirstName { get; set; }
     public string LastName { get; set; }
     public string? MiddleName { get; set; }
-}
-
-public partial class User
-{
     public ICollection<Order> Orders { get; set; } = new List<Order>();
 }

src/BuilderGenerator.IntegrationTests.Core/Models/Enums/OrderStatus.cs → src/BuilderGenerator.Tests.Core/Models/Enums/OrderStatus.cs

@@ -1,4 +1,4 @@
-namespace BuilderGenerator.IntegrationTests.Core.Models.Enums;
+namespace BuilderGenerator.Tests.Core.Models.Enums;
 
 public enum OrderStatus
 {

src/BuilderGenerator.IntegrationTests.Core/README.md → src/BuilderGenerator.Tests.Core/README.md

@@ -1,3 +1,3 @@
-# BuilderGenerator.Core #
+# BuilderGenerator.Tests.Core
 
 This project defines the object model used in the other framework-specific tests. It is defined as a netstandard2.0 library so that it can be used with the widest variety of consuming projects.

src/BuilderGenerator.IntegrationTests.Net60/BuilderGenerator.IntegrationTests.Net60.csproj → src/BuilderGenerator.Tests.Integration.Net60/BuilderGenerator.Tests.Integration.Net60.csproj

@@ -7,15 +7,13 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\BuilderGenerator.Tests.Core\BuilderGenerator.Tests.Core.csproj" />
+    <ProjectReference Include="..\BuilderGenerator.Tests.Unit\BuilderGenerator.Tests.Unit.csproj" />
     <ProjectReference Include="..\BuilderGenerator\BuilderGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
     <PackageReference Include="NUnit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.4.2" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
     <PackageReference Include="Shouldly" Version="4.2.0" />
   </ItemGroup>
 
-  <ItemGroup>
-    <ProjectReference Include="..\BuilderGenerator.IntegrationTests.Core\BuilderGenerator.IntegrationTests.Core.csproj" />
-  </ItemGroup>
-
 </Project>

src/BuilderGenerator.Tests.Integration.Net60/Builders/CollectionTypeSampleBuilder.cs

@@ -0,0 +1,8 @@
+using BuilderGenerator.Tests.Core.Models.Entities;
+
+namespace BuilderGenerator.Tests.Integration.Net60.Builders;
+
+[BuilderFor(typeof(CollectionTypesSample))]
+public partial class CollectionTypeSampleBuilder
+{
+}

src/BuilderGenerator.IntegrationTests.Net60/Builders/OrderBuilder.cs → src/BuilderGenerator.Tests.Integration.Net60/Builders/OrderBuilder.cs

@@ -1,8 +1,8 @@
 using System;
 using System.Collections.Generic;
-using BuilderGenerator.IntegrationTests.Core.Models.Entities;
+using BuilderGenerator.Tests.Core.Models.Entities;
 
-namespace BuilderGenerator.IntegrationTests.Net60.Builders;
+namespace BuilderGenerator.Tests.Integration.Net60.Builders;
 
 [BuilderFor(typeof(Order), true)]
 public partial class OrderBuilder

src/BuilderGenerator.IntegrationTests.Net60/Builders/OrderItemBuilder.cs → src/BuilderGenerator.Tests.Integration.Net60/Builders/OrderItemBuilder.cs

@@ -1,7 +1,7 @@
 using System;
-using BuilderGenerator.IntegrationTests.Core.Models.Entities;
+using BuilderGenerator.Tests.Core.Models.Entities;
 
-namespace BuilderGenerator.IntegrationTests.Net60.Builders;
+namespace BuilderGenerator.Tests.Integration.Net60.Builders;
 
 [BuilderFor(typeof(OrderItem))]
 public partial class OrderItemBuilder

src/BuilderGenerator.IntegrationTests.Net60/Builders/UserBuilder.cs → src/BuilderGenerator.Tests.Integration.Net60/Builders/UserBuilder.cs

@@ -1,8 +1,8 @@
 using System;
 using System.Collections.Generic;
-using BuilderGenerator.IntegrationTests.Core.Models.Entities;
+using BuilderGenerator.Tests.Core.Models.Entities;
 
-namespace BuilderGenerator.IntegrationTests.Net60.Builders;
+namespace BuilderGenerator.Tests.Integration.Net60.Builders;
 
 [BuilderFor(typeof(User))]
 public partial class UserBuilder

src/BuilderGenerator.IntegrationTests.Net60/README.md → src/BuilderGenerator.Tests.Integration.Net60/README.md

@@ -1,5 +1,5 @@
-# BuilderGenerator.Sample.Net60.FromProject
+# BuilderGenerator.Sample.Net70.FromProject
 
-This project provides tests the BuilderGenerator package being used in a .Net 6.0 project using a simple series of inter-related classes defined in the BuiderGenerator.Test.Core project.
+This project provides tests the BuilderGenerator package being used in a .Net 7.0 project using a simple series of inter-related classes defined in the BuiderGenerator.Test.Core project.
 
 The reference to the BuilderGenerator is a direct project reference, so it can be used to rapidly check the results of changes, but does not represent the real-world usage of the generator. It tests the functionality of the builder, but not the deployment mechanism.

src/BuilderGenerator.IntegrationTests.Net60/Tests/BuilderTests.cs → src/BuilderGenerator.Tests.Integration.Net60/Tests/BuilderTests.cs

@@ -1,10 +1,10 @@
 using System;
-using BuilderGenerator.IntegrationTests.Core.Models.Entities;
-using BuilderGenerator.IntegrationTests.Net60.Builders;
+using BuilderGenerator.Tests.Core.Models.Entities;
+using BuilderGenerator.Tests.Integration.Net60.Builders;
 using NUnit.Framework;
 using Shouldly;
 
-namespace BuilderGenerator.IntegrationTests.Net60.Tests;
+namespace BuilderGenerator.Tests.Integration.Net60.Tests;
 
 [TestFixture]
 public class BuilderTests

src/BuilderGenerator.IntegrationTests.Net60/Tests/OrderBuilderTests.cs → src/BuilderGenerator.Tests.Integration.Net60/Tests/OrderBuilderTests.cs

@@ -1,11 +1,11 @@
 using System;
-using BuilderGenerator.IntegrationTests.Core.Models.Entities;
-using BuilderGenerator.IntegrationTests.Core.Models.Enums;
-using BuilderGenerator.IntegrationTests.Net60.Builders;
+using BuilderGenerator.Tests.Core.Models.Entities;
+using BuilderGenerator.Tests.Core.Models.Enums;
+using BuilderGenerator.Tests.Integration.Net60.Builders;
 using NUnit.Framework;
 using Shouldly;
 
-namespace BuilderGenerator.IntegrationTests.Net60.Tests;
+namespace BuilderGenerator.Tests.Integration.Net60.Tests;
 
 [TestFixture]
 public class OrderBuilderTests

src/BuilderGenerator.IntegrationTests.Net60/Tests/UserBuilderTests.cs → src/BuilderGenerator.Tests.Integration.Net60/Tests/UserBuilderTests.cs

@@ -1,10 +1,10 @@
 using System;
-using BuilderGenerator.IntegrationTests.Core.Models.Entities;
-using BuilderGenerator.IntegrationTests.Net60.Builders;
+using BuilderGenerator.Tests.Core.Models.Entities;
+using BuilderGenerator.Tests.Integration.Net60.Builders;
 using NUnit.Framework;
 using Shouldly;
 
-namespace BuilderGenerator.IntegrationTests.Net60.Tests;
+namespace BuilderGenerator.Tests.Integration.Net60.Tests;
 
 [TestFixture]
 public class UserBuilderTests

src/BuilderGenerator.Tests.Integration.Net70/BuilderGenerator.Tests.Integration.Net70.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <IsPackable>false</IsPackable>
+    <LangVersion>latest</LangVersion>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\BuilderGenerator.Tests.Core\BuilderGenerator.Tests.Core.csproj" />
+    <ProjectReference Include="..\BuilderGenerator.Tests.Unit\BuilderGenerator.Tests.Unit.csproj" />
+    <ProjectReference Include="..\BuilderGenerator\BuilderGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
+    <PackageReference Include="NUnit" Version="3.13.3" />
+    <PackageReference Include="NUnit3TestAdapter" Version="4.4.2" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
+    <PackageReference Include="Shouldly" Version="4.2.0" />
+  </ItemGroup>
+
+</Project>

src/BuilderGenerator.Tests.Integration.Net70/Builders/CollectionTypeSampleBuilder.cs

@@ -0,0 +1,8 @@
+using BuilderGenerator.Tests.Core.Models.Entities;
+
+namespace BuilderGenerator.Tests.Integration.Net70.Builders;
+
+[BuilderFor(typeof(CollectionTypesSample))]
+public partial class CollectionTypeSampleBuilder
+{
+}

src/BuilderGenerator.Tests.Integration.Net70/Builders/OrderBuilder.cs

@@ -0,0 +1,29 @@
+using System;
+using System.Collections.Generic;
+using BuilderGenerator.Tests.Core.Models.Entities;
+
+namespace BuilderGenerator.Tests.Integration.Net70.Builders;
+
+[BuilderFor(typeof(Order), true)]
+public partial class OrderBuilder
+{
+    public static OrderBuilder Simple()
+    {
+        var builder = new OrderBuilder()
+            .WithId(Guid.NewGuid);
+
+        return builder;
+    }
+
+    public static OrderBuilder Typical()
+    {
+        var builder = Simple()
+            .WithItems(
+                () => new List<OrderItem>
+                {
+                    OrderItemBuilder.Simple().Build(),
+                });
+
+        return builder;
+    }
+}

src/BuilderGenerator.Tests.Integration.Net70/Builders/OrderItemBuilder.cs

@@ -0,0 +1,16 @@
+using System;
+using BuilderGenerator.Tests.Core.Models.Entities;
+
+namespace BuilderGenerator.Tests.Integration.Net70.Builders;
+
+[BuilderFor(typeof(OrderItem))]
+public partial class OrderItemBuilder
+{
+    public static OrderItemBuilder Simple()
+    {
+        var builder = new OrderItemBuilder()
+            .WithId(Guid.NewGuid);
+
+        return builder;
+    }
+}

src/BuilderGenerator.Tests.Integration.Net70/Builders/README.md

@@ -0,0 +1,15 @@
+# Partial Builders #
+
+This folder contains the hand-written half of any builders. Create static factory methods for each well-known or named object instance you want to create.
+
+## Suggestions ##
+
+In addition to specific factory methods, you should define some general-purpose methods such as:
+
+### Simple/Minimal ###
+
+Creates the simplest, most minimal instance that will pass validation. Only fill in the required fields, and leave everything else at their default values. This can serve as the starting point for other, more specific factory methods. For instance, a minimal Customer may be missing address information, and would have no orders.
+
+### Typical ###
+
+This method should return a "typical" example of the class. For a Customer entity, this might mean that the shipping and billing addresses are filled in, and the Customer has multiple orders in various states.