Task Description

Add a performance benchmark project based on BenchmarkDotNet.

Motivation

This is so that people can evaluate how well it performs in situ.

Additional Context

Performance benchmarks let people evaluate if the code is fast enough for their purposes.

Request Summary

Add support for rich enumerations that are flags. (e.g. bit position 1 set means one thing, bit position 2 another...etc. With only a need to define the meaning of the bit positions, not the entire set of all possible flags)

Proposed Resolution

For both record and class based RichEnum hierarchies add a base typ that can support code similar to as follows:

public class MyFlags(uint flags, string name) : FlagsEnum<MyFlags>(flags)
{
    public static readonly MyFlags Flag1 = new(0b00001,"Flag1");
    public static readonly MyFlags Flag2 = new(0b00010,"Flag2");
    public static readonly MyFlags Flag3 = new(0b00100,"Flag3");
    public static readonly MyFlags SpecialCase = new(0b00101,"SpecialCase");
}

Console.WriteLine(((MyFlags)0b00001).ToString()); // outputs: Flag1
Console.WriteLine(((MyFlags)0b00010).ToString()); // outputs: Flag2
Console.WriteLine(((MyFlags)0b00011).ToString()); // outputs: [Flag1, Flag2]
Console.WriteLine(((MyFlags)0b00100).ToString()); // outputs: Flag3
Console.WriteLine(((MyFlags)0b00101).ToString()); // outputs: SpecialCase
Console.WriteLine(((MyFlags)0b00111).ToString()); // outputs: [Flag1, Flag2, Flag3]

Alternatives

Put a thin wrapper over Ardalis.SmartEnum's FlagsEnum. Downsides - No control, poorly documented. Upside - already implemented.

Additional context

Flags are often used with enums to allow for packing data into a single value.

Request Summary

Add support for record class based rich enumerations. Since C# 10 record classes have gained popularity. Not providing this feature for more modern approaches seems a gross oversight.

Proposed Resolution

Create a parallel set of classes, either in a new namespace w/ same names or with a slightly different naming convention. (e.g. Jcd.RichEnumerations.Records or RichEnumRec...etc.)

Alternatives

Don't provide a mechanism for record classes. After all, public class MyRichEnum : RichEnum<MyRichEnum> ... is very concise.

Additional context

Doing this will require documentation informing users on how to use record types in .net standard libraries.

Task Description

Create end user documentation in addition to the auto-generated API documentation.

Motivation

DDD Concepts such as Rich Enumerations are often misunderstood and misapplied. End user documentation should strive to keep the usage of a library clear, including recapping fundamental theory and providing concrete examples.

Task Description

Add initial unit tests

Acceptance Criteria

100% or nearly 100% coverage with ReSharper/Rider.

Motivation

Comprehensive unit tests help ensure correct functionality and instill confidence in consumers.

Task Description

Do a POC nuget package build and push to MyGet. Then consume the package from MyGet to ensure it works in the intended target environments. (Ubuntu, Windows 11)

Motivation

Ensuring the build product and pipeline function as expected is essential to keeping a library up to date with minimal fuss.

Task Description

Assess the appropriateness of the current namespaces and convenience types (e.g. NamedRichEnum).

Motivation

A good naming strategy for both components and namespaces is necessary for a successful library. As well too many convenience types can obscure the purpose of the types a library provider intends to make their focus.