MapTo/README.md

94 lines
2.2 KiB
Markdown
Raw Normal View History

2020-12-21 19:34:53 +03:00
# MapTo
2020-12-24 15:42:28 +03:00
![Nuget](https://img.shields.io/nuget/v/mapto?logo=nuget)
![Publish Packages](https://github.com/mrtaikandi/MapTo/workflows/Publish%20Packages/badge.svg)
2020-12-22 11:20:49 +03:00
An object to object mapping generator using using [Roslyn source generator](https://github.com/dotnet/roslyn/blob/master/docs/features/source-generators.md).
## Installation
```
2020-12-24 15:42:28 +03:00
dotnet add package MapTo --prerelease
2020-12-22 11:20:49 +03:00
```
## Usage
MapTo creates mappings during compile-time. To indicate which objects it needs to generate the mappings for, simply declare the class as `partial` and annotate it with `MapFrom` attribute.
```c#
[MapFrom(sourceType: typeof(App.Data.Models.User))]
public partial class UserViewModel
{
public string FirstName { get; }
public string LastName { get; }
2020-12-24 15:45:31 +03:00
[IgnoreProperty]
public string FullName { get; set; }
2020-12-22 11:20:49 +03:00
}
```
If `Data.Models.User` class is defined as follow:
```c#
namespace App.Data.Models
{
public class User
{
public User(int id) => Id = id;
public int Id { get; }
public string FirstName { get; set; }
public string LastName { get; set; }
public string FullName => $"{FirstName} {LastName}";
}
}
```
It will generate the following code:
```c#
// <auto-generated />
using System;
namespace App.ViewModels
{
public partial class UserViewModel
{
public UserViewModel(App.Data.Models.User user)
{
if (user == null) throw new ArgumentNullException(nameof(user));
2020-12-22 11:20:49 +03:00
FirstName = user.FirstName;
LastName = user.LastName;
}
public static UserViewModel From(App.Data.Models.User user)
{
return user == null ? null : new UserViewModel(user);
}
}
public static partial class UserToUserViewModelExtensions
2020-12-22 11:20:49 +03:00
{
public static UserViewModel ToUserViewModel(this App.Data.Models.User user)
{
return user == null ? null : new UserViewModel(user);
}
}
}
```
Which makes it possible to get an instance of `UserViewModel` from one of the following ways:
```c#
var user = new User(id: 10) { FirstName = "John", LastName = "Doe" };
var vm = user.ToUserViewModel();
// OR
vm = new UserViewModel(user);
// OR
vm = UserViewModel.From(user);
```