Morphiq 0.1.0

dotnet add package Morphiq --version 0.1.0
                    
NuGet\Install-Package Morphiq -Version 0.1.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="Morphiq" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Morphiq" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="Morphiq" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Morphiq --version 0.1.0
                    
#r "nuget: Morphiq, 0.1.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.
#addin nuget:?package=Morphiq&version=0.1.0
                    
Install Morphiq as a Cake Addin
#tool nuget:?package=Morphiq&version=0.1.0
                    
Install Morphiq as a Cake Tool

Morphiq

Build & Test

Premise

Morphiq is a versatile tool that enhances object mapping and transformation in C# using attribute-based configurations. It simplifies the process of converting objects between different types, making it ideal for scenarios such as data transfer objects (DTOs), view models, and response objects in web APIs.

Features

  • Attribute-Based Mapping: Use attributes to define custom mappings, default values, and properties to ignore.
  • Custom Mapping Methods: Define custom mapping logic using methods specified by attributes.
  • Default Value Handling: Automatically set default values for properties when the source property is null.
  • Property Ignoring: Exclude specific properties from the mapping process using ignore attributes.
  • Flexible Configuration: Apply additional configuration to the target object during the mapping proces

Example

Basic Usage

using Morphiq;

public class Entity
{
    public string Name { get; set; } = "John Doe";
    public int Age { get; set; } = 30;
}

public class DTO
{
    public string Name { get; set; } = string.Empty;
    public int Age { get; set; }
}

var entity = new Entity();

var dto = entity.MorphTo<DTO>();

Console.WriteLine(dto.Name); // Output: John Doe
Console.WriteLine(dto.Age);  // Output: 30

Attributes

Some attributes are available to control the behavior of the mapping.

IgnoreProperty
using Morphiq;
using Morphiq.Attributes;

public class Entity
{
    public string Name { get; set; } = "John Doe";
    [IgnoreProperty]
    public int Age { get; set; } = 30;
}

public class DTO
{
    public string Name { get; set; }
    public int Age { get; set; }
}

var entity = new Entity();
var dto = entity.MorphTo<DTO>();

Console.WriteLine(dto.Name); // Output: John Doe
Console.WriteLine(dto.Age);  // Output: 0 (default value)
Default Value
using Morphiq;
using Morphiq.Attributes;

public class Entity
{
    [MorphToDefaultValue("Unknown")]
    public string Name { get; set; }
    public int Age { get; set; } = 30;
}

public class DTO
{
    public string Name { get; set; }
    public int Age { get; set; }
}

var entity = new Entity();
var dto = entity.MorphTo<DTO>();

Console.WriteLine(dto.Name); // Output: Unknown
Console.WriteLine(dto.Age);  // Output: 30
Custom Mapping
using Morphiq;
using Morphiq.Attributes;

public class Entity
{
    public string Name { get; set; } = "John Doe";
    public int Age { get; set; } = 30;

    [MorphToCustomMapping(nameof(MapName))]
    public string FullName { get; set; } = "John Doe";

    private string MapName(object value)
    {
        return $"Mapped: {value}";
    }
}

public class DTO
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string FullName { get; set; }
}

var entity = new Entity();
var dto = entity.MorphTo<DTO>();

Console.WriteLine(dto.Name);     // Output: John Doe
Console.WriteLine(dto.Age);      // Output: 30
Console.WriteLine(dto.FullName); // Output: Mapped: John Doe
Configuration
using Morphiq;

public class Entity
{
    public string Name { get; set; } = "John Doe";
    public int Age { get; set; } = 30;
}

public class DTO
{
    public string Name { get; set; }
    public int Age { get; set; }
}

var entity = new Entity();
var dto = entity.MorphTo<DTO>(x => x.Name = "Jane Doe");

Console.WriteLine(dto.Name); // Output: Jane Doe
Console.WriteLine(dto.Age);  // Output: 30

Installation

License

This project is licensed under the MIT License - see the LICENSE file for details.

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 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.
  • net8.0

    • No dependencies.

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
0.1.0 139 7 days ago