Generative.Composition 1.0.0

Introduction

Generative.Composition combines code generation and attributes to help you effectively leverage composition to follow SOLID principles.

Getting Started

Project Structure

You will need the following project types in your solution to use this library:

• Source projects (code that will be read by the package)

  • An attributes class library
  • A model class library (decorated with attributes from your attributes class library)
  • An implementation class library (decorated with attributes from your attributes class library)

• An empty target class library (code will be generated and written to this project)

• A console application that uses the package, reads from the source libraries and writes to the target library

Project Structure Example

Attributes

For your attributes class library, you might have a project called GenerativeWorkflow.Attributes with classes like this:

• Create

  [AttributeUsage(AttributeTargets.All)]
  public class Create : Attribute
  {
  
  }
  

• Delete

  [AttributeUsage(AttributeTargets.All)]
  public class Delete : Attribute
  {
  
  }
  

Models

For your model class library, you might have a project called GenerativeWorkflow.Models with classes like this:

[Create]
[Delete]
public class Car
{
    public string Model { get; set; }
    public string Make { get; set; }
}

Implementation

For your implementation class library, you might have a project called GenerativeWorkflow.SourceRepository with classes like this:

• RepositoryBase

  public class RepositoryBase<TEntity>
  {
      protected List<TEntity> entities = new();
  }
  

• Create

  [Create]
  public class Create<TEntity> : RepositoryBase<TEntity>
  {
      public void Add(TEntity entity)
      {
          entities.Add(entity);
      }
  }
  

• Delete

  [Delete]
  public class Delete<TEntity> : RepositoryBase<TEntity>
  {
      public void Remove(TEntity entity)
      {
          entities.Remove(entity);
      }
  }
  

Target Project

You might have an empty target class library called GenerativeWorkflow.Repository. When you generate code using the AnalyserService, the generated code will combine your implementation details into an interface and class per model based on the attributes and implementation details specified. E.g.:

//Auto-generated code
namespace GenerativeWorkflow.Repository
{
    public interface ICarRepository
    {
        public void Add(GenerativeWorkflow.Models.Car entity);
        public void Remove(GenerativeWorkflow.Models.Car entity);
    }
}

//Auto-generated code
namespace GenerativeWorkflow.Repository
{
    public class CarRepository : ICarRepository
    {
        protected List<GenerativeWorkflow.Models.Car> entities = new();

        public void Add(GenerativeWorkflow.Models.Car entity)
        {
            entities.Add(entity);
        }

        public void Remove(GenerativeWorkflow.Models.Car entity)
        {
            entities.Remove(entity);
        }
    }
}

Configuration

To get started:

1. Create your console application
2. Add Generative.Composition as a dependency to your project
3. Instantiate the AnalyserService using a CodeGenerationConfig. E.g.:

var analyserService = new AnalyserService(new Generative.Composition.CodeGenerationConfig
{
    SolutionPath = @"D:\Code\GenerativeWorkflow\GenerativeWorkflow\GenerativeWorkflow.sln",
    SourceModelProjectName = "GenerativeWorkflow.Models",
    SourceImplementationProjectName = "GenerativeWorkflow.SourceRepository",
    SourceBaseClassName = "RepositoryBase",
    SourceTypeParameterName = "TEntity",
    TargetClassSuffix = "Repository",
    TargetNamespace = "GenerativeWorkflow.Repository",
    TargetInterfaceFolder = @"D:\Code\Generative Workflow\GenerativeWorkflow.Repository\Interfaces",
    TargetClassFolder = @"D:\Code\Generative Workflow\GenerativeWorkflow.Repository\DataAccess"
});

Configuration Breakdown

Code Generation

With your configuration set up, you can generate code in your console application by calling:

await analyserService.AnalyseSolutionAsync();

Limitations

• Regarding the base class defined in your implementation class library:
  • The library will only copy properties to the target classes, nothing else
  • The library expects the root of the class to be a namespace. E.g.:
    • This will work:

      namespace GenerativeWorkflow.SourceRepository
      {
          public class RepositoryBase<TEntity>
          {
              protected List<TEntity> entities = new();
          }
      }
      

    • This will not work:

      namespace GenerativeWorkflow.SourceRepository;
      
      public class RepositoryBase<TEntity>
      {
          protected List<TEntity> entities = new();
      }