Add Access Modifier To OAPH backing property

ChrisPulman · ChrisPulman · commit e0f6466f3772 · 2025-01-08T20:40:22.000Z
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservableMethods#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservableMethods#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservableMethodsWithName#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservableMethodsWithName#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservableProp#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservableProp#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropNestedClasses#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropNestedClasses#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropertiesWithAttribute#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropertiesWithAttribute#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropertiesWithAttributeNullableRef#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropertiesWithAttributeNullableRef#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropertiesWithAttributeRef#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropertiesWithAttributeRef#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropertiesWithName#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPFromObservableGeneratorTests.FromObservablePropertiesWithName#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.FromField#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.FromField#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.FromFieldNestedClass#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.FromFieldNestedClass#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.FromFieldNestedClass#TestNs.TestVM.ObservableAsProperties.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.FromFieldNestedClass#TestNs.TestVM.ObservableAsProperties.g.verified.cs
@@ -9,12 +9,12 @@ namespace TestNs
     /// </summary>
     public partial class TestVM
     {
-        /// <inheritdoc cref="_test1Helper"/>
-        private readonly ReactiveUI.ObservableAsPropertyHelper<int> _test1Helper;
+        /// <inheritdoc cref="_test2Helper"/>
+        private readonly ReactiveUI.ObservableAsPropertyHelper<int> _test2Helper;
 
-        /// <inheritdoc cref="_test1"/>
+        /// <inheritdoc cref="_test2"/>
         [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
-        public int Test1 { get => _test1 = _test1Helper?.Value ?? _test1; }
+        public int Test2 { get => _test2 = _test2Helper?.Value ?? _test2; }
     }
 }
 #nullable restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NamedFromField#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NamedFromField#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NamedFromField#TestNs.TestVM.ObservableAsProperties.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NamedFromField#TestNs.TestVM.ObservableAsProperties.g.verified.cs
@@ -9,12 +9,12 @@ namespace TestNs
     /// </summary>
     public partial class TestVM
     {
-        /// <inheritdoc cref="_test2Helper"/>
-        private readonly ReactiveUI.ObservableAsPropertyHelper<int> _test2Helper;
+        /// <inheritdoc cref="_test4Helper"/>
+        private readonly ReactiveUI.ObservableAsPropertyHelper<int> _test4Helper;
 
-        /// <inheritdoc cref="_test2"/>
+        /// <inheritdoc cref="_test4"/>
         [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
-        public int Test2 { get => _test2 = _test2Helper?.Value ?? _test2; }
+        public int Test4 { get => _test4 = _test4Helper?.Value ?? _test4; }
     }
 }
 #nullable restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NonReadOnlyFromField#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NonReadOnlyFromField#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -33,6 +33,14 @@ internal sealed class ObservableAsPropertyAttribute : Attribute
     /// The is read only of the OAPH property.
     /// </value>
     public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NonReadOnlyFromField#TestNs.TestVM.ObservableAsProperties.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NonReadOnlyFromField#TestNs.TestVM.ObservableAsProperties.g.verified.cs
@@ -9,12 +9,12 @@ namespace TestNs
     /// </summary>
     public partial class TestVM
     {
-        /// <inheritdoc cref="_test2Helper"/>
-        private readonly ReactiveUI.ObservableAsPropertyHelper<int> _test2Helper;
+        /// <inheritdoc cref="_test3Helper"/>
+        private readonly ReactiveUI.ObservableAsPropertyHelper<int> _test3Helper;
 
-        /// <inheritdoc cref="_test2"/>
+        /// <inheritdoc cref="_test3"/>
         [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
-        public int Test2 { get => _test2 = _test2Helper?.Value ?? _test2; }
+        public int Test3 { get => _test3 = _test3Helper?.Value ?? _test3; }
     }
 }
 #nullable restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NonReadOnlyFromFieldProtected#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NonReadOnlyFromFieldProtected#ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.verified.cs
@@ -0,0 +1,46 @@
+﻿//HintName: ReactiveUI.SourceGenerators.ObservableAsPropertyAttribute.g.cs
+// Copyright (c) 2025 .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>
+/// ObservableAsPropertyAttribute.
+/// </summary>
+/// <seealso cref="Attribute" />
+[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property | AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
+internal sealed class ObservableAsPropertyAttribute : Attribute
+{
+    /// <summary>
+    /// Gets the name of the property.
+    /// </summary>
+    /// <value>
+    /// The name of the property.
+    /// </value>
+    public string? PropertyName { get; init; }
+
+    /// <summary>
+    /// Gets the Readonly state of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The is read only of the OAPH property.
+    /// </value>
+    public bool ReadOnly { get; init; } = true;
+
+    /// <summary>
+    /// Gets the AccessModifier of the OAPH property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the OAPH property, protected if true.
+    /// </value>
+    public bool UseProtected { get; init; } = false;
+}
+#nullable restore
+#pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NonReadOnlyFromFieldProtected#TestNs.TestVM.ObservableAsProperties.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/OAPH/OAPGeneratorTests.NonReadOnlyFromFieldProtected#TestNs.TestVM.ObservableAsProperties.g.verified.cs
@@ -0,0 +1,21 @@
+﻿//HintName: TestNs.TestVM.ObservableAsProperties.g.cs
+// <auto-generated/>
+#pragma warning disable
+#nullable enable
+namespace TestNs
+{
+    /// <summary>
+    /// Partial class for the TestVM which contains ReactiveUI Observable As Property initialization.
+    /// </summary>
+    public partial class TestVM
+    {
+        /// <inheritdoc cref="_test5Helper"/>
+        private readonly ReactiveUI.ObservableAsPropertyHelper<int> _test5Helper;
+
+        /// <inheritdoc cref="_test5"/>
+        [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+        public int Test5 { get => _test5 = _test5Helper?.Value ?? _test5; }
+    }
+}
+#nullable restore
+#pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/UnitTests/OAPGeneratorTests.cs b/src/ReactiveUI.SourceGenerator.Tests/UnitTests/OAPGeneratorTests.cs
@@ -60,7 +60,7 @@ namespace TestNs;
                 public partial class TestVM : ReactiveObject
                 {
                     [ObservableAsProperty]
-                    private int _test1 = 10;
+                    private int _test2 = 10;
 
                     public partial class TestVMInner1 : ReactiveObject
                     {
@@ -105,7 +105,7 @@ namespace TestNs;
                 public partial class TestVM : ReactiveObject
                 {
                     [ObservableAsProperty(ReadOnly = false)]
-                    private int _test2 = 10;
+                    private int _test3 = 10;
                 }
             """;
 
@@ -132,11 +132,38 @@ namespace TestNs;
             public partial class TestVM : ReactiveObject
             {
                 [ObservableAsProperty(PropertyName = "MyNamedProperty")]
-                private int _test2 = 10;
+                private int _test4 = 10;
             }
             """;
 
         // Act: Initialize the helper and run the generator. Assert: Verify the generated code.
         return TestHelper.TestPass(sourceCode);
     }
+
+    /// <summary>
+    /// Tests that the source generator correctly generates observable properties.
+    /// </summary>
+    /// <returns>A task to monitor the async.</returns>
+    [Fact]
+    public Task NonReadOnlyFromFieldProtected()
+    {
+        // Arrange: Setup the source code that matches the generator input expectations.
+        const string sourceCode = """
+                using System;
+                using ReactiveUI;
+                using ReactiveUI.SourceGenerators;
+                using System.Reactive.Linq;
+
+                namespace TestNs;
+
+                public partial class TestVM : ReactiveObject
+                {
+                    [ObservableAsProperty(UseProtected = true)]
+                    private int _test5 = 10;
+                }
+            """;
+
+        // Act: Initialize the helper and run the generator. Assert: Verify the generated code.
+        return TestHelper.TestPass(sourceCode);
+    }
 }
diff --git a/src/ReactiveUI.SourceGenerators.Execute/TestViewModel.cs b/src/ReactiveUI.SourceGenerators.Execute/TestViewModel.cs
@@ -39,6 +39,9 @@ public partial class TestViewModel : ReactiveObject, IActivatableViewModel, IDis
     [ObservableAsProperty(ReadOnly = false)]
     private double _test13Property = 11.1d;
 
+    [ObservableAsProperty(UseProtected = true)]
+    private double _observableAsPropertyTest3Property;
+
     [property: Test(AParameter = "Test Input")]
     [Reactive]
     private double? _test12Property = 12.1d;
@@ -117,6 +120,7 @@ public TestViewModel()
 
         Console.Out.WriteLine($"Test2Property default Value: {Test2Property}");
         _test2PropertyHelper = Test8ObservableCommand!.ToProperty(this, x => x.Test2Property);
+        _observableAsPropertyTest3PropertyHelper = this.WhenAnyValue(x => x.Test13Property)!.ToProperty(this, x => x.ObservableAsPropertyTest3Property);
 
         Test8ObservableCommand?.Execute(100).Subscribe(d => Console.Out.WriteLine(d));
         Console.Out.WriteLine($"Test2Property Value: {Test2Property}");
diff --git a/src/ReactiveUI.SourceGenerators/AttributeDefinitions.cs b/src/ReactiveUI.SourceGenerators/AttributeDefinitions.cs
diff --git a/src/ReactiveUI.SourceGenerators/ObservableAsProperty/Models/ObservableFieldInfo.cs b/src/ReactiveUI.SourceGenerators/ObservableAsProperty/Models/ObservableFieldInfo.cs
diff --git a/src/ReactiveUI.SourceGenerators/ObservableAsProperty/Models/ObservableMethodInfo.cs b/src/ReactiveUI.SourceGenerators/ObservableAsProperty/Models/ObservableMethodInfo.cs
diff --git a/src/ReactiveUI.SourceGenerators/ObservableAsProperty/ObservableAsPropertyGenerator{FromField}.Execute.cs b/src/ReactiveUI.SourceGenerators/ObservableAsProperty/ObservableAsPropertyGenerator{FromField}.Execute.cs
diff --git a/src/ReactiveUI.SourceGenerators/ObservableAsProperty/ObservableAsPropertyGenerator{FromObservable}.Execute.cs b/src/ReactiveUI.SourceGenerators/ObservableAsProperty/ObservableAsPropertyGenerator{FromObservable}.Execute.cs
