Feature overridable Inheritance property (#123)

* support overridable property * Update to use enum, fix tests --------- Co-authored-by: Chris Pulman <[email protected]>
reactiveui · Nov 9, 2024 · 9c1feac · 9c1feac
1 parent 954ab78
commit 9c1feac
Show file tree

Hide file tree

Showing 15 changed files with 239 additions and 20 deletions.
diff --git a/...mReactiveProperiesWithAttributes#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/...mReactiveProperiesWithAttributes#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -21,5 +21,16 @@ internal enum AccessModifier
     InternalProtected,
     PrivateProtected,
 }
+
+/// <summary>
+/// InheritanceModifier.
+/// </summary>
+internal enum InheritanceModifier
+{
+    None,
+    Virtual,
+    Override,
+    New,
+}
 #nullable restore
 #pragma warning restore
diff --git a/...activeProperiesWithAttributes#ReactiveUI.SourceGenerators.ReactiveAttribute.g.verified.cs b/...activeProperiesWithAttributes#ReactiveUI.SourceGenerators.ReactiveAttribute.g.verified.cs
@@ -25,6 +25,11 @@ internal sealed class ReactiveAttribute : Attribute
     /// The AccessModifier of the set property.
     /// </value>
     public AccessModifier SetModifier { get; init; }
+
+    /// <summary>
+    /// Gets the InheritanceModifier of the property.
+    /// </sumary>
+    public InheritanceModifier Inheritance { get; init; }
 }
 #nullable restore
 #pragma warning restore
diff --git a/...atorTests.FromReactiveProperties#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/...atorTests.FromReactiveProperties#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -21,5 +21,16 @@ internal enum AccessModifier
     InternalProtected,
     PrivateProtected,
 }
+
+/// <summary>
+/// InheritanceModifier.
+/// </summary>
+internal enum InheritanceModifier
+{
+    None,
+    Virtual,
+    Override,
+    New,
+}
 #nullable restore
 #pragma warning restore
diff --git a/...rTests.FromReactiveProperties#ReactiveUI.SourceGenerators.ReactiveAttribute.g.verified.cs b/...rTests.FromReactiveProperties#ReactiveUI.SourceGenerators.ReactiveAttribute.g.verified.cs
@@ -25,6 +25,11 @@ internal sealed class ReactiveAttribute : Attribute
     /// The AccessModifier of the set property.
     /// </value>
     public AccessModifier SetModifier { get; init; }
+
+    /// <summary>
+    /// Gets the InheritanceModifier of the property.
+    /// </sumary>
+    public InheritanceModifier Inheritance { get; init; }
 }
 #nullable restore
 #pragma warning restore
diff --git a/...FromReactivePropertiesWithAccess#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/...FromReactivePropertiesWithAccess#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -21,5 +21,16 @@ internal enum AccessModifier
     InternalProtected,
     PrivateProtected,
 }
+
+/// <summary>
+/// InheritanceModifier.
+/// </summary>
+internal enum InheritanceModifier
+{
+    None,
+    Virtual,
+    Override,
+    New,
+}
 #nullable restore
 #pragma warning restore
diff --git a/...mReactivePropertiesWithAccess#ReactiveUI.SourceGenerators.ReactiveAttribute.g.verified.cs b/...mReactivePropertiesWithAccess#ReactiveUI.SourceGenerators.ReactiveAttribute.g.verified.cs
@@ -25,6 +25,11 @@ internal sealed class ReactiveAttribute : Attribute
     /// The AccessModifier of the set property.
     /// </value>
     public AccessModifier SetModifier { get; init; }
+
+    /// <summary>
+    /// Gets the InheritanceModifier of the property.
+    /// </sumary>
+    public InheritanceModifier Inheritance { get; init; }
 }
 #nullable restore
 #pragma warning restore
diff --git a/...thAttributesAccessAndInheritance#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/...thAttributesAccessAndInheritance#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -0,0 +1,36 @@
+//HintName: ReactiveUI.SourceGenerators.AccessModifier.g.cs
+// Copyright (c) 2024 .NET Foundation and Contributors. All rights reserved.
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+// <auto-generated/>
+#pragma warning disable
+#nullable enable
+namespace ReactiveUI.SourceGenerators;
+
+/// <summary>
+/// AccessModifier.
+/// </summary>
+internal enum AccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
+/// <summary>
+/// InheritanceModifier.
+/// </summary>
+internal enum InheritanceModifier
+{
+    None,
+    Virtual,
+    Override,
+    New,
+}
+#nullable restore
+#pragma warning restore
diff --git a/...ttributesAccessAndInheritance#ReactiveUI.SourceGenerators.ReactiveAttribute.g.verified.cs b/...ttributesAccessAndInheritance#ReactiveUI.SourceGenerators.ReactiveAttribute.g.verified.cs
@@ -0,0 +1,35 @@
+//HintName: ReactiveUI.SourceGenerators.ReactiveAttribute.g.cs
+// Copyright (c) 2024 .NET Foundation and Contributors. All rights reserved.
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+using System;
+
+// <auto-generated/>
+#pragma warning disable
+#nullable enable
+namespace ReactiveUI.SourceGenerators;
+
+/// <summary>
+/// ReactiveAttribute.
+/// </summary>
+/// <seealso cref="Attribute" />
+[AttributeUsage(AttributeTargets.Field, AllowMultiple = false, Inherited = false)]
+internal sealed class ReactiveAttribute : Attribute
+{
+    /// <summary>
+    /// Gets the AccessModifier of the set property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the set property.
+    /// </value>
+    public AccessModifier SetModifier { get; init; }
+
+    /// <summary>
+    /// Gets the InheritanceModifier of the property.
+    /// </sumary>
+    public InheritanceModifier Inheritance { get; init; }
+}
+#nullable restore
+#pragma warning restore
diff --git a/....FromReactivePropertiesWithAttributesAccessAndInheritance#TestVM.Properties.g.verified.cs b/....FromReactivePropertiesWithAttributesAccessAndInheritance#TestVM.Properties.g.verified.cs
@@ -0,0 +1,23 @@
+//HintName: TestVM.Properties.g.cs
+// <auto-generated/>
+using ReactiveUI;
+
+#pragma warning disable
+#nullable enable
+
+namespace TestNs
+{
+    /// <summary>
+    /// Partial class for the TestVM which contains ReactiveUI Reactive property initialization.
+    /// </summary>
+    public partial class TestVM
+    {
+        /// <inheritdoc cref="_name"/>
+        [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+        [global::System.Runtime.Serialization.DataMemberAttribute()]
+        [global::System.Text.Json.Serialization.JsonIncludeAttribute()]
+        public string? Name { get => _name; set => this.RaiseAndSetIfChanged(ref _name, value); }
+    }
+}
+#nullable restore
+#pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/UnitTests/ReactiveGeneratorTests.cs b/src/ReactiveUI.SourceGenerator.Tests/UnitTests/ReactiveGeneratorTests.cs
@@ -109,5 +109,39 @@ public partial class TestVM : ReactiveObject
         return VerifyGenerator(driver);
     }
 
+    /// <summary>
+    /// Froms the reactive properties with attributes and access and inheritance.
+    /// </summary>
+    /// <returns>A task to monitor the async.</returns>
+    [Fact]
+    public Task FromReactivePropertiesWithAttributesAccessAndInheritance()
+    {
+        // Arrange: Setup the source code that matches the generator input expectations.
+        const string sourceCode = @"
+                using System;
+                using System.Runtime.Serialization;
+                using System.Text.Json.Serialization;
+                using ReactiveUI;
+                using ReactiveUI.SourceGenerators;
+                using System.Reactive.Linq;
+
+                namespace TestNs;
+
+                public partial class TestVM : ReactiveObject
+                {
+                    [property: JsonInclude]
+                    [DataMember]
+                    [Reactive(Inheritance = InheritanceModifier.Virtual, SetModifier = AccessModifier.Protected)]
+                    private string? _name;
+                }
+            ";
+
+        // Act: Initialize the helper and run the generator.
+        var driver = TestHelper.TestPass(sourceCode);
+
+        // Assert: Verify the generated code.
+        return VerifyGenerator(driver);
+    }
+
     private SettingsTask VerifyGenerator(GeneratorDriver driver) => Verify(driver).UseDirectory(TestHelper.VerifiedFilePath()).ScrubLinesContaining("[global::System.CodeDom.Compiler.GeneratedCode(\"");
 }
diff --git a/src/ReactiveUI.SourceGenerators.Execute/TestViewModel.cs b/src/ReactiveUI.SourceGenerators.Execute/TestViewModel.cs
@@ -51,6 +51,11 @@ public partial class TestViewModel : ReactiveObject, IActivatableViewModel, IDis
     [Reactive]
     private string _myStringProperty = "test";
 
+    [property: JsonInclude]
+    [DataMember]
+    [Reactive(Inheritance = InheritanceModifier.Virtual, SetModifier = AccessModifier.Protected)]
+    private string? _name;
+
     /// <summary>
     /// Initializes a new instance of the <see cref="TestViewModel"/> class.
     /// </summary>

diff --git a/src/ReactiveUI.SourceGenerators/AttributeDefinitions.cs b/src/ReactiveUI.SourceGenerators/AttributeDefinitions.cs
@@ -40,6 +40,17 @@ internal enum AccessModifier
             InternalProtected,
             PrivateProtected,
         }
+
+        /// <summary>
+        /// InheritanceModifier.
+        /// </summary>
+        internal enum InheritanceModifier
+        {
+            None,
+            Virtual,
+            Override,
+            New,
+        }
         #nullable restore
         #pragma warning restore
         """;
@@ -105,6 +116,12 @@ internal sealed class ReactiveCommandAttribute : Attribute
 
     public const string ReactiveAttributeType = "ReactiveUI.SourceGenerators.ReactiveAttribute";
 
+    /// <summary>
+    /// Gets the reactive attribute.
+    /// </summary>
+    /// <value>
+    /// The reactive attribute.
+    /// </value>
     public static string ReactiveAttribute => $$"""
 // Copyright (c) {{DateTime.Now.Year}} .NET Foundation and Contributors. All rights reserved.
 // Licensed to the .NET Foundation under one or more agreements.
@@ -133,6 +150,11 @@ internal sealed class ReactiveAttribute : Attribute
     /// The AccessModifier of the set property.
     /// </value>
     public AccessModifier SetModifier { get; init; }
+
+    /// <summary>
+    /// Gets the InheritanceModifier of the property.
+    /// </sumary>
+    public InheritanceModifier Inheritance { get; init; }
 }
 #nullable restore
 #pragma warning restore

diff --git a/...SourceGenerators/ObservableAsProperty/ObservableAsPropertyGenerator{FromField}.Execute.cs b/...SourceGenerators/ObservableAsProperty/ObservableAsPropertyGenerator{FromField}.Execute.cs
@@ -55,6 +55,16 @@ public sealed partial class ObservableAsPropertyGenerator
         // Get the can PropertyName member, if any
         attributeData.TryGetNamedArgument("ReadOnly", out bool? isReadonly);
 
+        // Get Inheritance value from the attribute
+        attributeData.TryGetNamedArgument("Inheritance", out int? inheritanceArgument);
+        var inheritance = inheritanceArgument switch
+        {
+            1 => " virtual",
+            2 => " override",
+            3 => " new",
+            _ => string.Empty,
+        };
+
         token.ThrowIfCancellationRequested();
 
         // Get the property type and name
@@ -198,7 +208,8 @@ public sealed partial class ObservableAsPropertyGenerator
             isReferenceTypeOrUnconstraindTypeParameter,
             includeMemberNotNullOnSetAccessor,
             forwardedPropertyAttributes,
-            isReadonly == false ? string.Empty : "readonly"),
+            isReadonly == false ? string.Empty : "readonly",
+            inheritance),
             builder.ToImmutable());
     }
 

diff --git a/src/ReactiveUI.SourceGenerators/Reactive/Models/PropertyInfo.cs b/src/ReactiveUI.SourceGenerators/Reactive/Models/PropertyInfo.cs
@@ -24,4 +24,5 @@ internal sealed record PropertyInfo(
     bool IsReferenceTypeOrUnconstrainedTypeParameter,
     bool IncludeMemberNotNullOnSetAccessor,
     EquatableArray<string> ForwardedAttributes,
-    string AccessModifier);
+    string AccessModifier,
+    string Inheritance);