merged tests

Author: simonmau

Enum.Ext/Enum.Ext.Tests/Enum.Ext.Tests.csproj

@@ -7,7 +7,7 @@
  </PropertyGroup>
 
  <ItemGroup>
- <PackageReference Include="Newtonsoft.Json" Version="12.0.2" />
+ <PackageReference Include="FluentAssertions" Version="5.7.0" />
  <PackageReference Include="nunit" Version="3.12.0" />
  <PackageReference Include="NUnit3TestAdapter" Version="3.13.0" />
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.1.1" />

Enum.Ext/Enum.Ext.Tests/BasicTests.cs renamed to Enum.Ext/Enum.Ext.Tests/WeekdayTests.cs

@@ -1,9 +1,10 @@
-using NUnit.Framework;
+using FluentAssertions;
+using NUnit.Framework;
 using System;
 
 namespace Enum.Ext.Tests
 {
- public class BasicTests
+ public class WeekdayTests
  {
  [SetUp]
  public void InitWeekday()
@@ -16,21 +17,23 @@ public void Test_ConvertToInt()
  {
  int value = Weekday.Monday;
 
- Assert.AreEqual(1, value);
+ value.Should().Be(1);
  }
 
  [Test]
  public void Test_ConvertFromInt()
  {
  Weekday value = (Weekday)1;
 
- Assert.AreEqual(Weekday.Monday, value);
+ value.Should().Be(Weekday.Monday);
  }
 
  [Test]
  public void Test_ThrowsWhenSameId()
  {
- Assert.Throws<TypeInitializationException>(() => Initialize.InitStaticFields<WrongEnum>());
+ Action secondInitialize = () => Initialize.InitStaticFields<WrongEnum>();
+
+ secondInitialize.Should().Throw<TypeInitializationException>();
  }
  }
 }

Enum.Ext/Enum.Ext.Tests/YearlyPrice.cs

@@ -0,0 +1,34 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace Enum.Ext.Tests
+{
+ 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));
+
+ public YearlyPrice(int id, decimal price, DateTime validFrom, DateTime validTo) : base(id)
+ {
+ ValidFrom = validFrom;
+ ValidTo = validTo;
+ Price = price;
+ }
+
+ public static YearlyPrice GetPriceByDate(DateTime date)
+ {
+ return List.FirstOrDefault(x => x.ValidFrom <= date && date <= x.ValidTo);
+ }
+ }
+}

Enum.Ext/Enum.Ext.Tests/YearlyPriceTests.cs

@@ -0,0 +1,34 @@
+using FluentAssertions;
+using NUnit.Framework;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Enum.Ext.Tests
+{
+ [TestFixture]
+ public class YearlyPriceTests
+ {
+ [SetUp]
+ public void InitYearlyPrice()
+ {
+ Initialize.InitStaticFields<YearlyPrice>();
+ }
+
+ [Test]
+ public void QueryByDate_ShouldReturnCorrectEnum()
+ {
+ DateTime year_2018 = new DateTime(2018, 5, 3);
+
+ YearlyPrice.GetPriceByDate(year_2018).Should().Be(YearlyPrice.Price_2018);
+ }
+
+ [Test]
+ public void Enum_ShouldHoldCorrectAdditionalInformation()
+ {
+ var priceEnum = YearlyPrice.Price_2018;
+
+ priceEnum.Price.Should().Be(15.99m);
+ }
+ }
+}

README.md

@@ -1,8 +1,13 @@
 # Enum.Ext
 
-[![Build Status](https://mauracher.visualstudio.com/enum_ext/_apis/build/status/simonmau.enum_ext?branchName=master)](https://mauracher.visualstudio.com/enum_ext/_build/latest?definitionId=20&branchName=master)
+[![Build Status](https://mauracher.visualstudio.com/enum_ext/_apis/build/status/simonmau.enum_ext?branchName=master)](https://mauracher.visualstudio.com/enum_ext/_build/latest?definitionId=20&branchName=master) [![Version](https://img.shields.io/nuget/v/Enum.Ext.svg)](https://www.nuget.org/packages/Enum.Ext) 
 
-Enum.Ext provides a TypeSafeEnum that has many advantages compared to the normal .NET Enum value type
+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. You are also 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/
@@ -13,3 +18,73 @@ Enum.Ext can be installed using the following command via the NuGet package mana
 
 
 ### 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?
+```C#
+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--");
+ ....
+
+ public Weekday(int id, string name) : base(id, name)
+ {
+ }
+}
+```
+
+Use the enum just like the native one 
+
+```C#
+var day = Weekday.Monday;
+
+// Assigns Tuesday
+day = (Weekday)2;
+```
+
+and access the additional information easily
+
+```C#
+var day = Weekday.Monday;
+
+// Prints out '--Monday--'
+Console.WriteLine(day.Name);
+```
+
+#### A fixed price that is valid for a certain time period
+```C#
+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));
+
+ public YearlyPrice(int id, decimal price, DateTime validFrom, DateTime validTo) : base(id)
+ {
+ ValidFrom = validFrom;
+ ValidTo = validTo;
+ Price = price;
+ }
+
+ public static YearlyPrice GetPriceByDate(DateTime date)
+ {
+ return List.FirstOrDefault(x => x.ValidFrom <= date && date <= x.ValidTo);
+ }
+}
+```
+