object-binder 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package object-binder --version 1.0.0                
NuGet\Install-Package object-binder -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="object-binder" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add object-binder --version 1.0.0                
#r "nuget: object-binder, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install object-binder as a Cake Addin
#addin nuget:?package=object-binder&version=1.0.0

// Install object-binder as a Cake Tool
#tool nuget:?package=object-binder&version=1.0.0                

object-binder

Nuget

Description

Given a type X (maybe an interface or class) and type Y (may to be an interface or class with virtual properties), this library will generate a type Z where it implements (or extend) Y and take an instance of X in the constructor where for all properties:

  • getter will return value of bound property of X
  • setter will apply value change back to Y

This library uses Lamar Code Weaving for runtime IL generation, InfoViaLinq to extract PropertyInfo from MemberExpression and Guard for validation.

How to use:

Given class:

public class Entity
{
    public string Name { get; set; }
    
    public int Age { get; set; }
    
    public bool Alive { get; set; }
    
    public Guid Id { get; set; }
}

And interface:

public interface ICommon
{
    string NameC { get; set; }

    bool AliveC { get; set; }
}

We can generate a bound type:

var boundType = ObjectBinderBuilder.New<Entity, ICommon>()
    .Bind(x => x.Name, x => x.NameC)
    .Bind(x => x.Alive, x => x.AliveC)
    .Build()
    .BoundType;
    
var sourceObj = new Entity { ... };
var proxy = (ICommon) Activator.CreateInstance(boundType, sourceObj);

proxy.NameC = "Something else...";

// Assert property change in `sourceObj`
Assert.Equals(sourceObj.Name, proxy.NameC);

Runtime generated class:

public class ICommon_proxy_0 : ICommon {
    
    private readonly Entity _source = source;
    
    public ICommon_proxy_0(Entity source) { _source = source; }
    
    public string NameC { get { return _source.Name; } set { _source.Name = value; } }
    
    public bool AliveC { get { return _source.Alive; } set { _source.Alice = value; } }
}

Note:

This library is useful when we are dealing with a class with many many properties and we want to map it to another class with smaller set of properties where changes to simplified object properties will be applied back to original object properties.

Credit:

Special thanks to @alexsniffin who came up with the original idea.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 is compatible.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 641 3/2/2019
1.0.0 548 3/2/2019

Working state