-
Notifications
You must be signed in to change notification settings - Fork 1
Home
This library provides some interfaces, classes, Roslyn Source Generators, Roslyn Analyzers and Roslyn CodeFixes for implementation of Smart Enums and Value Objects.
- Smart Enums
- Immutable value objects
- Convenience (extension) methods and classes
- Compiler version: 4.2.0
- C# language version: 9 or higher
Verify the version by placing #error version
into any of your cs-files and build the project/solution.
The build output should display the compiler version:
MyFile.cs(15, 8): [CS1029] #error: 'version'
MyFile.cs(15, 8): [CS8304] Compiler version: '4.2.0-4.22220.2 (1e40aa11)'. Language version: 10.0.
Works/tested with:
- SDK: 6.0.300 / 6.0.301 / 6.0.400
- Visual Studio: 17.2.4 / 17.3.0
- JetBrains Rider: 2022.1.2 / 2022.2.2
Please note: For developers having both, JetBrains Rider and Visual Studio, please update Visual Studio as well, because Rider is using the SDK of Visual Studio by default.
Install: Install-Package Thinktecture.Runtime.Extensions
Documentation: Smart Enums
Features:
- Roslyn Analyzers and CodeFixes help the developers to implement the Smart Enums correctly
- Allows iteration over all items
- Allows custom properties and methods
- Provides appropriate constructor based on the specified properties/fields
- Provides means for lookup, cast and type conversion from key-type to Smart Enum and vice versa
- Provides proper implementation of
Equals
,GetHashCode
,ToString
and equality comparison via==
and!=
- Choice between always-valid
IEnum<T>
and maybe-validIValidatableEnum<T>
- Allows custom validation of constructor arguments
- Allows changing the property name
Key
, which holds the underlying value - thanks to Roslyn Source Generator - Allows custom key comparer
- JSON support (
System.Text.Json
andNewtonsoft.Json
) - ASP.NET Core support (model binding and model validation)
- Entity Framework Core support (
ValueConverter
) - MessagePack support (
IMessagePackFormatter
)
Definition of a new Smart Enum without any custom properties and methods. All other features mentioned above are generated by the Roslyn Source Generators in the background.
public partial class ProductType : IEnum<string>
{
public static readonly ProductType Groceries = new("Groceries");
public static readonly ProductType Housewares = new("Housewares");
}
Definition of a new Smart Enum with 1 custom property RequiresFoodVendorLicense
and 1 method Do
with different behaviors for different enum items.
public partial class ProductType : IEnum<string>
{
public static readonly ProductType Groceries = new("Groceries", requiresFoodVendorLicense: true);
public static readonly ProductType Housewares = new HousewaresProductType();
public bool RequiresFoodVendorLicense { get; }
public virtual void Do()
{
// do default stuff
}
private class HousewaresProductType : ProductType
{
public HousewaresProductType()
: base("Housewares", requiresFoodVendorLicense: false)
{
}
public override void Do()
{
// do special stuff
}
}
}
Install: Install-Package Thinktecture.Runtime.Extensions
Documentation: Immutable Value Objects
Features:
- Roslyn Analyzers and CodeFixes help the developers to implement the Value Objects correctly
- Allows custom properties and methods
- Provides appropriate factory methods for creation of new value objects based on the specified properties/fields
- Allows custom validation of constructor and factory method arguments
- Additional features for simple Value Objects (1 "key"-property/field) and complex Value Objects (2 properties/fields or more)
- Simple Value Objects: allows cast and type conversion from key-type to Value Object and vice versa
- Simple Value Objects: provides an implementation of
IComparable<T>
if the key-property/field is anIComparable<T>
or has anIComparer<T>
- Simple Value Objects: provides an implementation of
IFormattable
if the key-property/field is anIFormattable
- Provides proper implementation of
Equals
,GetHashCode
,ToString
and equality comparison via==
and!=
- Allows custom equality comparison
- JSON support (
System.Text.Json
andNewtonsoft.Json
) - ASP.NET Core support (model binding and model validation)
- Entity Framework Core support (
ValueConverter
) - MessagePack support (
IMessagePackFormatter
)
Definition of a value object with 1 custom property Value
. All other features mentioned above are generated by the Roslyn Source Generators in the background.
[ValueObject]
public partial class ProductName
{
public string Value { get; }
// The member can be a private readoly field as well
//private readonly string _value;
}
Definition of a complex value object with 2 properties and a custom validation of the arguments.
[ValueObject]
public partial class Boundary
{
public decimal Lower { get; }
public decimal Upper { get; }
static partial void ValidateFactoryArguments(ref ValidationResult? validationResult, ref decimal lower, ref decimal upper)
{
if (lower <= upper)
return;
validationResult = new ValidationResult($"Lower boundary '{lower}' must be less than upper boundary '{upper}'");
}
}