ardalis/SmartEnum

Doesn't seem to have support for Flags Enums

Open

#59 opened on Nov 27, 2019

View on GitHub
 (8 comments) (3 reactions) (0 assignees)C# (185 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (2,420 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

My team really likes this project and would like to use it for our codebase! Unfortunately, we have several flags enums and they don't seem to be compatible with this project. :(

The FromValue method throws a SmartEnumNotFoundException when given a flags enum value as well as casting a flags value.

// Given SomeEnum.A is 1 and SomeEnum.B is 2, all three throw the exception
SomeEnum.FromValue(SomeEnum.A | SomeEnum.B);
SomeEnum.FromValue(3); 
(SomeEnum)3

Also, there's no way to get the Name of multiple values with the logical OR operator like we get when the Flags attribute is placed on an enum (i.e. SomeEnum.B | SomeEnum.C => B, C).

Will this project include this support in the near future?

Contributor guide

Research direction
Study the SmartEnum source code to understand how single value enums are parsed and validated. Then design an approach to support bitwise OR combinations of values (Flags). Consider adding a new method like 'FromFlags' or modifying 'FromValue' to handle combined values. Look at how the Flags attribute works in .NET and implement similar logic for SmartEnum.
Tech stack
csharp
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#familiarity with enum flags
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70