Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HamedFathi/EnumerationClassGenerator
A C# source generator to create an enumeration class from an enum type.
https://github.com/HamedFathi/EnumerationClassGenerator
csharp csharp-sourcegenerator csharp9 dotnet enum enumeration sourcegenerator
Last synced: 3 months ago
JSON representation
A C# source generator to create an enumeration class from an enum type.
- Host: GitHub
- URL: https://github.com/HamedFathi/EnumerationClassGenerator
- Owner: HamedFathi
- License: mit
- Created: 2021-11-18T02:41:07.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-19T17:30:14.000Z (about 2 years ago)
- Last Synced: 2024-05-12T12:39:44.718Z (6 months ago)
- Topics: csharp, csharp-sourcegenerator, csharp9, dotnet, enum, enumeration, sourcegenerator
- Language: C#
- Homepage:
- Size: 24.4 KB
- Stars: 15
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - EnumerationClassGenerator
- csharp-source-generators - EnumerationClassGenerator -   - A C# source generator to create an enumeration class from an enum type. (Source Generators / Enums)
README
## Problem
> Enumeration or Enum types are an integral part of C# language. They have been around since the inception of language. Unfortunately, the Enum types also have some limitations. Enum types are not object-oriented. When we have to use Enums for control flow statements, behavior around Enums gets scattered across the application. We cannot inherit or extend the Enum types. These issues can especially be a deal-breaker in Domain-Driven Design (DDD).
Read more [here](https://ankitvijay.net/2020/05/21/introduction-enumeration-class/) and [here](https://docs.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/enumeration-classes-over-enum-types).
Regardless of the behaviors, there is a repetitive section where you have to write your class fields similar to what you have in a `enum` type.
```cs
// Enum
public enum CardType
{
Amex,
Visa,
MasterCard
}
// Converts to
// Enumeration Class
public class CardType : Enumeration
{
public static CardType Amex = new(1, nameof(Amex));
public static CardType Visa = new(2, nameof(Visa));
public static CardType MasterCard = new(3, nameof(MasterCard));
public CardType(int id, string name)
: base(id, name)
{
}
// Other behaviors
}
```
## Solution
This generator helps you to focus on your business, no need to know about this pattern or details of `Enumeration` base class.
Define your `enum` type` and put `EnumerationClass` attribute on top of it.
```cs
namespace MyLibrary
{
[EnumerationClass]
public enum CardType
{
Amex,
Visa,
MasterCard
}
}
```
Your enumeration class is ready and generated! before saying how to extend it, I should say how to find it!
If you use parameter-less `EnumerationClass` the default options are:
* Same `namespace` as you `enum` => `MyLibrary` for this sample.
* The class name will be combination of `enum` type name + "Enumeration" => `CardTypeEnumeration` for this sample.
But you can customize them:
```cs
namespace MyLibrary
{
[EnumerationClass("MyClass", "MyNamespace")]
public enum CardType
{
Amex,
Visa,
MasterCard
}
}
```
The generated class is `partial` to help you add your business rules, so you can find it as following based on above setting:
```cs
// How to extend it?
// Use same namespace name as you defined.
// Use same class name as you defined.
// Use 'partial' keyword for the class.
// To access the base class functionality you should inherit from 'Enumeration'.
namespace MyNamespace
public partial class MyClass /*: Enumeration*/
{
public void MyNewMethod()
{
// MasterCard
}
// ...
}
}
```
## `Enumeration` Base Class
As you can see there is a base class that provides some functionalities which includes the following:
```cs
// Returns 'Name' property.
override string ToString()
// Returns all fields
IEnumerable GetAll()
// Returns difference of two enumerations in integer.
int AbsoluteDifference(Enumeration firstValue, Enumeration secondValue)
// Returns value from an integer number.
T FromValue(int value)
// Returns value from a string name.
T FromDisplayName(string displayName)
// Parse a value based on a condition.
T Parse(K value, string description, Func predicate)
// Parse a value based on a condition with an result.
bool TryParse(K value, string description, Func predicate, out T result)
// Returns status of comparison in number.
int CompareTo(object other)
```
### [Nuget](https://www.nuget.org/packages/EnumerationClassGenerator)
[](https://opensource.org/licenses/MIT)
```
Install-Package EnumerationClassGenerator
dotnet add package EnumerationClassGenerator
```
