Enum.Ext.EFCore 1.0.3

Enum.Ext

Enum.Ext provides a TypeSafeEnum that has a bunch of advantages compared to the normal .NET Enum value type.

For example is it possible to store additional information directly with the enum. Furthermore you are able to query an enum based on the information stored with it.

There is also a Json-Serializer implemented, so you dont have to cast from DTOs manually.

Installation

https://www.nuget.org/packages/Enum.Ext/

Enum.Ext can be installed using the following command via the NuGet package manager console:

PM> Install-Package Enum.Ext

If you are planning to use Enum.Ext with Entity Framework Core, you should also install Enum.Ext.EFCore

https://www.nuget.org/packages/Enum.Ext.EFCore/

PM> Install-Package Enum.Ext.EFCore

How to use

Simply inherit your class from TypeSafeEnum or TypeSafeNameEnum and adjust everything to your needs.

Want a weekday enum with a special string representation for each day?

public sealed class Weekday : TypeSafeNameEnum<Weekday, int>
{
    public static readonly Weekday Monday = new Weekday(1, "--Monday--");
    public static readonly Weekday Tuesday = new Weekday(2, "--Tuesday--");
    public static readonly Weekday Wednesday = new Weekday(3, "--Wednesday--");
    ....

    private Weekday(int id, string name) : base(id, name)
    {
    }
}

Initialize the enum at program start

Initialize.InitEnumExt<Weekday>();

then use it just like the native one

var day = Weekday.Monday;

// Assigns Tuesday
day = (Weekday)2;

and access the additional information easily

var day = Weekday.Monday;

// Prints out '--Monday--'
Console.WriteLine(day.Name);

EF Core configuration

Just add the following line at the end of the OnModelCreating method in your DbContext class and you are ready to go

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    ...
    
    modelBuilder.ConfigureEnumExt();
}

Enum.Ext in action

Here you find some examples how you could use the extension.

A fixed price that is valid for a certain time period

public sealed class YearlyPrice : TypeSafeEnum<YearlyPrice, int>
{
    public decimal Price { get; private set; }

    public DateTime ValidFrom { get; private set; }

    public DateTime ValidTo { get; private set; }

    public static readonly YearlyPrice Price_2018 =
        new YearlyPrice(1, 15.99m, new DateTime(2018, 1, 1), new DateTime(2018, 12, 31));

    public static readonly YearlyPrice Price_2019 =
        new YearlyPrice(2, 16.99m, new DateTime(2019, 1, 1), new DateTime(2019, 12, 31));

    private YearlyPrice(int id, decimal price, DateTime validFrom, DateTime validTo) : base(id)
    {
        ValidFrom = validFrom;
        ValidTo = validTo;
        Price = price;
    }

    public static YearlyPrice GetPriceByDate(DateTime date)
    {
        // The List property holds all elements declared above
        return List.FirstOrDefault(x => x.ValidFrom <= date && date <= x.ValidTo);
    }
}

Get the according enum for a given date

DateTime date = new DateTime(2018, 5, 3);

// Returns YearlyPrice.Price_2018
var price = YearlyPrice.GetPriceByDate(date);