EgaSoftware.Adapter 1.0.2

Read-only interface adapter

This repository contains a library which allows you to adapt any object to a POCO read-only interface.

Installation

Add EgaSoftware.Adapter NuGet package to your project:

dotnet add package EgaSoftware.Adapter

Usage

Here is an example of generation and usage of an adapter.

using EgaSoftware.Adapter;

interface IInterface
{
    int Amount { get; }
}

public class Adapted
{
    public int Amount { get; set; }
}

public void AdaptExample()
{
    var adapterFactory = AdapterFactoryBuilder.For<IInterface, Adapted>().Build();
	
    var adaptedObject = new Adapted() { Amount = 12 };
	
    var adapter = adapterFactory.Adapt(adaptedObject);
	
    System.Console.WriteLine(adapter.Amount); // 12
}

Mappings

You are able to map interface properties using any logic.

using EgaSoftware.Adapter;

interface IInterface
{
    string Title { get; }
}

public class Adapted
{
    public string GetTitle() => "Read-only interface adapter";
}

public void AdaptExample()
{
    var adapterFactory = AdapterFactoryBuilder.For<IInterface, Adapted>()
        .Map(i => i.Title, obj => obj.GetTitle())
        .Build();
	
    var adaptedObject = new Adapted();
	
    var adapter = adapterFactory.Adapt(adaptedObject);
	
    System.Console.WriteLine(adapter.Title); // "Read-only interface adapter"
}

Default properties implementation

An adapter maps interface properties on object properties using name and type. If an interface property does not have matching object property then it is generated with default value.

using EgaSoftware.Adapter;

interface IInterface
{
    int Amount { get; }
}

public class Adapted
{
    public int TotalCount { get; set; }
}

public void AdaptExample()
{
    var adapterFactory = AdapterFactoryBuilder.For<IInterface, Adapted>().Build();
	
    var adaptedObject = new Adapted() { TotalCount = 12 };
	
    var adapter = adapterFactory.Adapt(adaptedObject);
	
    System.Console.WriteLine(adapter.Amount); // 0
}

Collections

An adapter does support IEnumerable<> and IAsyncEnumerable<> collections. Bear in mind in that case methods Adapt()/AdaptAsync() return an enumerator so you should use ToList(), ToArray() or any other similar method in order to get a collection object.

using EgaSoftware.Adapter;

interface IInterface
{
    int Amount { get; }
}

public class Adapted
{
    public int Amount { get; set; }
}

public void AdaptExample()
{
    var adapterFactory = AdapterFactoryBuilder.For<IInterface, Adapted>().Build();

    var adaptedObjects = Enumerable.Range(1, 3).Select(x => new Adapted() { Amount = x }).ToArray();

    var adapter = adapterFactory.Adapt(adaptedObjects);

    System.Console.WriteLine(string.Join(", ", adapter.Select(x => x.Amount))); // 1, 2, 3
}

Dependency injection

You may use adapter with standard .Net IoC container.

using EgaSoftware.Adapter.DependencyInjection;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddAdapter(config =>
    {
        config.AddFor<IInterface, Adapted>().Map(x => x.Amount, _ => 100);
    });

public class DependentClass
{
    private readonly IAdapterFactory<IInterface, Addapted> _adapterFactory;
	
    public DependentClass(IAdapterFactory<IInterface, Addapted> adapterFactory)
    {
        _adapterFactory = adapterFactory;
    }
}