Added support for EnumOrder attribute.

Author: cabal95

src/SparkDevNetwork.Rock.CodeGenerator.Tests/Snapshots/TypeScriptViewModelGeneratorTests.GenerateEnumViewModel_SupportsOrderAttribute.verified.txt

@@ -0,0 +1,18 @@
+export const TestSet = {
+    No: 0,
+
+    Yes: 1
+} as const;
+
+export const TestSetDescription: Record<number, string> = {
+    0: "No",
+
+    1: "Yes"
+};
+
+// Add the __order property hidden so it doesn't get enumerated.
+Object.defineProperty(TestSetDescription, "__order", {
+    value: [1, 0],
+});
+
+export type TestSet = typeof TestSet[keyof typeof TestSet];

src/SparkDevNetwork.Rock.CodeGenerator.Tests/TypeScriptViewModelGeneratorTests.cs

@@ -269,6 +269,22 @@ public Task GenerateEnumViewModel_UsesFieldDescription()
         return Verify( code, Settings );
     }
 
+    [Fact]
+    public Task GenerateEnumViewModel_SupportsOrderAttribute()
+    {
+        var generator = new TypeScriptViewModelGenerator();
+        var typeMock = GetEnumMock( "Rock.Enums", "TestSet" );
+
+        typeMock.Setup( m => m.GetFields( It.IsAny<BindingFlags>() ) ).Returns( () => [
+            GetEnumFieldMock( typeMock, "No", 0, order: 1 ).Object,
+            GetEnumFieldMock( typeMock, "Yes", 1, order: 0 ).Object
+        ] );
+
+        var code = generator.GenerateEnumViewModel( typeMock.Object );
+
+        return Verify( code, Settings );
+    }
+
     #endregion
 
     #region GenerateEnumsViewModel
@@ -838,7 +854,7 @@ internal static Mock<Type> GetEnumMock( string @namespace, string typeName )
         return typeMock;
     }
 
-    internal static Mock<FieldInfo> GetEnumFieldMock( Mock<Type> mockType, string fieldName, int fieldValue, bool obsolete = false, string? obsoleteMessage = null, string? description = null )
+    internal static Mock<FieldInfo> GetEnumFieldMock( Mock<Type> mockType, string fieldName, int fieldValue, bool obsolete = false, string? obsoleteMessage = null, string? description = null, int? order = null )
     {
         var fieldMock = GetFieldMock( mockType, fieldName, typeof( int ) );
 
@@ -854,6 +870,11 @@ internal static Mock<FieldInfo> GetEnumFieldMock( Mock<Type> mockType, string fi
             attributes.Add( GetDescriptionAttributeData( description ).Object );
         }
 
+        if ( order != null )
+        {
+            attributes.Add( GetOrderAttributeData( order.Value ).Object );
+        }
+
         fieldMock.Setup( m => m.GetRawConstantValue() ).Returns( fieldValue );
         fieldMock.Setup( m => m.GetCustomAttributesData() ).Returns( () => attributes );
 
@@ -915,6 +936,18 @@ internal static Mock<CustomAttributeData> GetDescriptionAttributeData( string te
         return attributeDataMock;
     }
 
+    internal static Mock<CustomAttributeData> GetOrderAttributeData( int order )
+    {
+        var attributeDataMock = new Mock<CustomAttributeData>( MockBehavior.Strict );
+        var enumOrderTypeMock = XmlDocIdTests.GetTypeMock( "Rock.Enums", "EnumOrderAttribute" );
+
+        attributeDataMock.Setup( m => m.AttributeType ).Returns( enumOrderTypeMock.Object );
+        attributeDataMock.Setup( m => m.ConstructorArguments )
+            .Returns( [new CustomAttributeTypedArgument( order )] );
+
+        return attributeDataMock;
+    }
+
     internal static Mock<CustomAttributeData> GetEnumDomainAttributeData( string domain )
     {
         var attributeDataMock = new Mock<CustomAttributeData>( MockBehavior.Strict );

src/SparkDevNetwork.Rock.CodeGenerator/TypeScriptViewModelGenerator.cs

@@ -169,6 +169,7 @@ private string GenerateEnumViewModelContent( Type type )
             sb.AppendLine();
             sb.Append( GenerateEnumViewModelContent( type, true ) );
             sb.AppendLine();
+            sb.Append( GenerateOrderForEnumIfRequired( type ) );
 
             AppendCommentBlock( sb, typeComment, 0 );
 
@@ -220,11 +221,8 @@ private string GenerateEnumViewModelContent( Type type, bool isDescription )
                 sb.AppendLine( $"export const {typeName}Description: Record<number, string> = {{" );
             }
 
-            //var sortedFields = fields.OrderBy( f => f.GetRawConstantValue() ).ToList();
-            var sortedFields = fields.ToList();
-
             // Loop through each sorted field and emit the declaration.
-            for ( int i = 0; i < sortedFields.Count; i++ )
+            for ( int i = 0; i < fields.Count; i++ )
             {
                 var field = fields[i];
                 var obsoleteFieldAttribute = field.GetCustomAttributeData( "System.ObsoleteAttribute" );
@@ -234,7 +232,7 @@ private string GenerateEnumViewModelContent( Type type, bool isDescription )
                     // If this enum value is obsolete and there is another
                     // enum that is not obsolete with the same integer
                     // value then skip this one.
-                    var hasOtherField = sortedFields
+                    var hasOtherField = fields
                         .Any( f => ( int ) f.GetRawConstantValue() == ( int ) field.GetRawConstantValue()
                             && f.GetCustomAttributeData( "System.ObsoleteAttribute" ) == null );
 
@@ -297,7 +295,7 @@ private string GenerateEnumViewModelContent( Type type, bool isDescription )
                     }
                 }
 
-                if ( i + 1 < sortedFields.Count )
+                if ( i + 1 < fields.Count )
                 {
                     sb.AppendLine( "," );
                 }
@@ -319,6 +317,47 @@ private string GenerateEnumViewModelContent( Type type, bool isDescription )
             return sb.ToString();
         }
 
+        /// <summary>
+        /// Generate the additional order field on the enum if any of the enum
+        /// values have an EnumOrder attribute defined on them.
+        /// </summary>
+        /// <param name="type">The type that represents the enumeration.</param>
+        /// <returns>A string of text to append to the enum file.</returns>
+        private string GenerateOrderForEnumIfRequired( Type type )
+        {
+            var typeName = GetClassNameForType( type );
+            var fields = type.GetFields( BindingFlags.Static | BindingFlags.Public )
+                 .Where( f => f.GetCustomAttributeData( "System.ObsoleteAttribute" ) == null )
+                 .Select( f => new
+                 {
+                     Order = ( int? ) f.GetCustomAttributeData( "Rock.Enums.EnumOrderAttribute" )
+                         ?.ConstructorArguments[0].Value,
+                     Value = f.GetRawConstantValue()
+                 } )
+                 .ToList();
+
+            // If no fields have an EnumOrderAttribute, then we don't need to
+            // generate anything.
+            if ( !fields.Any( f => f.Order.HasValue ) )
+            {
+                return string.Empty;
+            }
+
+            var sb = new StringBuilder();
+            var orderedValues = fields.OrderBy( f => f.Order ?? 0 )
+                .ThenBy( f => f.Value )
+                .Select( f => f.Value )
+                .Distinct();
+
+            sb.AppendLine( "// Add the __order property hidden so it doesn't get enumerated." );
+            sb.AppendLine( $"Object.defineProperty({typeName}Description, \"__order\", {{" );
+            sb.AppendLine( $"    value: [{string.Join( ", ", orderedValues )}]," );
+            sb.AppendLine( "});" );
+            sb.AppendLine();
+
+            return sb.ToString();
+        }
+
         /// <summary>
         /// Generates the file for a SystemGuid declaration.
         /// </summary>