Improve Enum

NimaAra · Feb 4, 2024 · 53084c0 · 53084c0
1 parent 7edf93f
commit 53084c0
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 7 deletions.
diff --git a/Easy.Common.Tests.Unit/Enum/EnumTests.cs b/Easy.Common.Tests.Unit/Enum/EnumTests.cs
@@ -1,6 +1,7 @@
 namespace Easy.Common.Tests.Unit.Enum;
 
 using System.Collections.Generic;
+using System.Runtime.CompilerServices;
 using Easy.Common.Interfaces;
 using NUnit.Framework;
 using Shouldly;
@@ -31,11 +32,17 @@ public void When_getting_enum_values()
         values.ShouldBe(new[] { MyEnum.OptionA, MyEnum.OptionB }, ignoreOrder: true);
     }
 
+    [Test]
+    public void When_calling_toString()
+    {
+        MyEnum.OptionB.ToString().ShouldBe("[1] OptionB");
+    }
+
     sealed record class MyEnum : Enum<MyEnum>
     {
-        public static readonly MyEnum OptionA = new(0, nameof(OptionA));
-        public static readonly MyEnum OptionB = new(1, nameof(OptionB));
+        public static readonly MyEnum OptionA = new(0);
+        public static readonly MyEnum OptionB = new(1);
 
-        private MyEnum(int id, string name) : base(id, name) { }
+        private MyEnum(int id, [CallerMemberName] string name = default!) : base(id, name!) { }
     }
 }
diff --git a/Easy.Common/Easy.Common.csproj b/Easy.Common/Easy.Common.csproj
@@ -3,7 +3,7 @@
         <PackageId>Easy.Common</PackageId>
         <Description>A set of useful methods used across Easy.* projects.</Description>
         <Authors>Nima Ara</Authors>
-        <Copyright>2023 Nima Ara</Copyright>
+        <Copyright>2024 Nima Ara</Copyright>
         <Title>Easy Common</Title>
         <PackageTags>Easy;Common</PackageTags>
         <PackageProjectUrl>https://github.com/NimaAra/Easy.Common</PackageProjectUrl>

diff --git a/Easy.Common/Enum.cs b/Easy.Common/Enum.cs
@@ -1,14 +1,15 @@
 namespace Easy.Common;
 
+using Easy.Common.Interfaces;
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
-using Easy.Common.Interfaces;
+using System.Runtime.CompilerServices;
 
 /// <summary>
 /// An abstraction for representing a class based enum.
 /// </summary>
-public abstract record class Enum<T>(int Id, string Name) : IEnum where T : IEnum
+public abstract record class Enum<T>(int Id, [CallerMemberName] string Name = default!) : IEnum where T : IEnum
 {
     /// <summary>
     /// Retrieves a list of the values of the constants in a specified enumeration of type <typeparamref name="T"/>.
@@ -18,4 +19,9 @@ public abstract record class Enum<T>(int Id, string Name) : IEnum where T : IEnu
             .Select(f => f.GetValue(null))
             .Cast<T>()
             .ToList();
+
+    /// <summary>
+    /// Returns the textual representation of the enum.
+    /// </summary>
+    public sealed override string ToString() => $"[{Id}] {Name}";
 }
diff --git a/Easy.Common/Interfaces/IEnum.cs b/Easy.Common/Interfaces/IEnum.cs
@@ -11,7 +11,7 @@ public interface IEnum
     int Id { get; }
 
     /// <summary>
-    /// Gets the name.
+    /// Gets the Name.
     /// </summary>
     string Name { get; }
 }