Merge pull request #247 from CommunityToolkit/dev/remove-attributes-conditional

Sergio0694 · web-flow · commit df07309b5000 · 2022-05-09T16:24:59.000+02:00
Remove [Conditional] from MVVM Toolkit attributes
diff --git a/CommunityToolkit.Mvvm/ComponentModel/Attributes/AlsoBroadcastChangeAttribute.cs b/CommunityToolkit.Mvvm/ComponentModel/Attributes/AlsoBroadcastChangeAttribute.cs
@@ -3,7 +3,6 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
-using System.Diagnostics;
 
 namespace CommunityToolkit.Mvvm.ComponentModel;
 
@@ -36,7 +35,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;
 /// </code>
 /// </summary>
 [AttributeUsage(AttributeTargets.Field, AllowMultiple = false, Inherited = false)]
-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]
 public sealed class AlsoBroadcastChangeAttribute : Attribute
 {
 }
diff --git a/CommunityToolkit.Mvvm/ComponentModel/Attributes/AlsoNotifyCanExecuteForAttribute.cs b/CommunityToolkit.Mvvm/ComponentModel/Attributes/AlsoNotifyCanExecuteForAttribute.cs
@@ -3,7 +3,6 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
-using System.Diagnostics;
 using System.Linq;
 using CommunityToolkit.Mvvm.Input;
 
@@ -50,7 +49,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;
 /// </code>
 /// </summary>
 [AttributeUsage(AttributeTargets.Field, AllowMultiple = true, Inherited = false)]
-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]
 public sealed class AlsoNotifyCanExecuteForAttribute : Attribute
 {
     /// <summary>
diff --git a/CommunityToolkit.Mvvm/ComponentModel/Attributes/AlsoNotifyChangeForAttribute.cs b/CommunityToolkit.Mvvm/ComponentModel/Attributes/AlsoNotifyChangeForAttribute.cs
@@ -4,7 +4,6 @@
 
 using System;
 using System.ComponentModel;
-using System.Diagnostics;
 using System.Linq;
 
 namespace CommunityToolkit.Mvvm.ComponentModel;
@@ -69,7 +68,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;
 /// </code>
 /// </summary>
 [AttributeUsage(AttributeTargets.Field, AllowMultiple = true, Inherited = false)]
-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]
 public sealed class AlsoNotifyChangeForAttribute : Attribute
 {
     /// <summary>
diff --git a/CommunityToolkit.Mvvm/ComponentModel/Attributes/INotifyPropertyChangedAttribute.cs b/CommunityToolkit.Mvvm/ComponentModel/Attributes/INotifyPropertyChangedAttribute.cs
@@ -4,7 +4,6 @@
 
 using System;
 using System.ComponentModel;
-using System.Diagnostics;
 
 namespace CommunityToolkit.Mvvm.ComponentModel;
 
@@ -25,7 +24,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;
 /// </para>
 /// </summary>
 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]
 public sealed class INotifyPropertyChangedAttribute : Attribute
 {
     /// <summary>
diff --git a/CommunityToolkit.Mvvm/ComponentModel/Attributes/ObservableObjectAttribute.cs b/CommunityToolkit.Mvvm/ComponentModel/Attributes/ObservableObjectAttribute.cs
@@ -4,7 +4,6 @@
 
 using System;
 using System.ComponentModel;
-using System.Diagnostics;
 
 namespace CommunityToolkit.Mvvm.ComponentModel;
 
@@ -27,7 +26,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;
 /// And with this, the same APIs from <see cref="ObservableObject"/> will be available on this type as well.
 /// </summary>
 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]
 public sealed class ObservableObjectAttribute : Attribute
 {
 }
diff --git a/CommunityToolkit.Mvvm/ComponentModel/Attributes/ObservablePropertyAttribute.cs b/CommunityToolkit.Mvvm/ComponentModel/Attributes/ObservablePropertyAttribute.cs
@@ -4,7 +4,6 @@
 
 using System;
 using System.ComponentModel;
-using System.Diagnostics;
 
 namespace CommunityToolkit.Mvvm.ComponentModel;
 
@@ -53,7 +52,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;
 /// source field name will be converted to uppercase (eg. <c>isEnabled</c> to <c>IsEnabled</c>).
 /// </remarks>
 [AttributeUsage(AttributeTargets.Field, AllowMultiple = false, Inherited = false)]
-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]
 public sealed class ObservablePropertyAttribute : Attribute
 {
 }
diff --git a/CommunityToolkit.Mvvm/ComponentModel/Attributes/ObservableRecipientAttribute.cs b/CommunityToolkit.Mvvm/ComponentModel/Attributes/ObservableRecipientAttribute.cs
@@ -3,7 +3,6 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
-using System.Diagnostics;
 
 namespace CommunityToolkit.Mvvm.ComponentModel;
 
@@ -41,7 +40,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;
 /// If this condition is not met, the code will fail to build.
 /// </remarks>
 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]
 public sealed class ObservableRecipientAttribute : Attribute
 {
 }
diff --git a/CommunityToolkit.Mvvm/Input/Attributes/ICommandAttribute.cs b/CommunityToolkit.Mvvm/Input/Attributes/ICommandAttribute.cs
@@ -3,7 +3,6 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
-using System.Diagnostics;
 using System.Windows.Input;
 
 namespace CommunityToolkit.Mvvm.Input;
@@ -65,7 +64,6 @@ namespace CommunityToolkit.Mvvm.Input;
 /// </para>
 /// </summary>
 [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]
 public sealed class ICommandAttribute : Attribute
 {
     /// <summary>
diff --git a/dotnet Community Toolkit.sln b/dotnet Community Toolkit.sln
@@ -63,9 +63,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Configuration", "Configurat
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CommunityToolkit.Mvvm.DisableINotifyPropertyChanging.UnitTests", "tests\CommunityToolkit.Mvvm.DisableINotifyPropertyChanging.UnitTests\CommunityToolkit.Mvvm.DisableINotifyPropertyChanging.UnitTests.csproj", "{9E09DA49-4389-4ECE-8B68-EBDB1221DA90}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Mvvm.Internals.UnitTests", "tests\CommunityToolkit.Mvvm.Internals.UnitTests\CommunityToolkit.Mvvm.Internals.UnitTests.csproj", "{743D74BA-12AE-4639-AD77-B9DDA9C03255}"
-EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Mvvm.KeepSourceGeneratorAttributes.UnitTests", "tests\CommunityToolkit.Mvvm.KeepSourceGeneratorAttributes.UnitTests\CommunityToolkit.Mvvm.KeepSourceGeneratorAttributes.UnitTests.csproj", "{AFB55517-3B50-47E3-B9CA-F1C2770479B6}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CommunityToolkit.Mvvm.Internals.UnitTests", "tests\CommunityToolkit.Mvvm.Internals.UnitTests\CommunityToolkit.Mvvm.Internals.UnitTests.csproj", "{743D74BA-12AE-4639-AD77-B9DDA9C03255}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -341,26 +339,6 @@ Global
 		{743D74BA-12AE-4639-AD77-B9DDA9C03255}.Release|x64.Build.0 = Release|Any CPU
 		{743D74BA-12AE-4639-AD77-B9DDA9C03255}.Release|x86.ActiveCfg = Release|Any CPU
 		{743D74BA-12AE-4639-AD77-B9DDA9C03255}.Release|x86.Build.0 = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|ARM.ActiveCfg = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|ARM.Build.0 = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|ARM64.ActiveCfg = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|ARM64.Build.0 = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|x64.ActiveCfg = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|x64.Build.0 = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Debug|x86.Build.0 = Debug|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|Any CPU.Build.0 = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|ARM.ActiveCfg = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|ARM.Build.0 = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|ARM64.ActiveCfg = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|ARM64.Build.0 = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|x64.ActiveCfg = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|x64.Build.0 = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|x86.ActiveCfg = Release|Any CPU
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -377,7 +355,6 @@ Global
 		{6640D447-C28D-4DBB-91F4-3ADCE0CA64AD} = {B30036C4-D514-4E5B-A323-587A061772CE}
 		{9E09DA49-4389-4ECE-8B68-EBDB1221DA90} = {6640D447-C28D-4DBB-91F4-3ADCE0CA64AD}
 		{743D74BA-12AE-4639-AD77-B9DDA9C03255} = {B30036C4-D514-4E5B-A323-587A061772CE}
-		{AFB55517-3B50-47E3-B9CA-F1C2770479B6} = {6640D447-C28D-4DBB-91F4-3ADCE0CA64AD}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {5403B0C4-F244-4F73-A35C-FE664D0F4345}
diff --git a/tests/CommunityToolkit.Mvvm.ExternalAssembly/ModelWithObservableObjectAttribute.cs b/tests/CommunityToolkit.Mvvm.ExternalAssembly/ModelWithObservableObjectAttribute.cs
@@ -0,0 +1,17 @@
+// 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 more information.
+
+using CommunityToolkit.Mvvm.ComponentModel;
+
+namespace CommunityToolkit.Mvvm.ExternalAssembly;
+
+/// <summary>
+/// Test viewmodel for https://github.com/CommunityToolkit/dotnet/issues/222.
+/// </summary>
+[ObservableObject]
+public partial class ModelWithObservableObjectAttribute
+{
+    [ObservableProperty]
+    private string? _myProperty;
+}
diff --git a/tests/CommunityToolkit.Mvvm.KeepSourceGeneratorAttributes.UnitTests/CommunityToolkit.Mvvm.KeepSourceGeneratorAttributes.UnitTests.csproj b/tests/CommunityToolkit.Mvvm.KeepSourceGeneratorAttributes.UnitTests/CommunityToolkit.Mvvm.KeepSourceGeneratorAttributes.UnitTests.csproj
diff --git a/tests/CommunityToolkit.Mvvm.KeepSourceGeneratorAttributes.UnitTests/Test_SourceGeneratorAttributes.cs b/tests/CommunityToolkit.Mvvm.KeepSourceGeneratorAttributes.UnitTests/Test_SourceGeneratorAttributes.cs
diff --git a/tests/CommunityToolkit.Mvvm.UnitTests/Test_ObservablePropertyAttribute.cs b/tests/CommunityToolkit.Mvvm.UnitTests/Test_ObservablePropertyAttribute.cs
@@ -11,6 +11,7 @@
 using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
 using CommunityToolkit.Mvvm.ComponentModel;
+using CommunityToolkit.Mvvm.ExternalAssembly;
 using CommunityToolkit.Mvvm.Input;
 using CommunityToolkit.Mvvm.Messaging;
 using CommunityToolkit.Mvvm.Messaging.Messages;
@@ -569,6 +570,27 @@ public void Test_ObservableProperty_WithinGenericTypeWithMultipleTypeParameters(
         CollectionAssert.AreEqual(new[] { nameof(model.Value), nameof(model.TValue), nameof(model.UValue), nameof(model.List) }, propertyNames);
     }
 
+    // See https://github.com/CommunityToolkit/dotnet/issues/222
+    [TestMethod]
+    public void Test_ObservableProperty_WithBaseViewModelWithObservableObjectAttributeInAnotherAssembly()
+    {
+        ModelWithObservablePropertyAndBaseClassInAnotherAssembly model = new();
+
+        List<string?> propertyNames = new();
+
+        model.PropertyChanged += (s, e) => propertyNames.Add(e.PropertyName);
+
+        Assert.AreEqual(model.OtherProperty, "Ok");
+
+        model.MyProperty = "A";
+        model.OtherProperty = "B";
+
+        Assert.AreEqual(model.MyProperty, "A");
+        Assert.AreEqual(model.OtherProperty, "B");
+
+        CollectionAssert.AreEqual(new[] { nameof(model.MyProperty), nameof(model.OtherProperty) }, propertyNames);
+    }
+
     public abstract partial class BaseViewModel : ObservableObject
     {
         public string? Content { get; set; }
@@ -913,6 +935,17 @@ public class Bar<T>
     }
 #endif
 
+    partial class ModelWithObservablePropertyAndBaseClassInAnotherAssembly : ModelWithObservableObjectAttribute
+    {
+        [ObservableProperty]
+        private string? _otherProperty;
+
+        public ModelWithObservablePropertyAndBaseClassInAnotherAssembly()
+        {
+            OtherProperty = "Ok";
+        }
+    }
+
     interface IValueHolder
     {
         public bool Value { get; }
diff --git a/tests/CommunityToolkit.Mvvm.UnitTests/Test_SourceGeneratorAttributes.cs b/tests/CommunityToolkit.Mvvm.UnitTests/Test_SourceGeneratorAttributes.cs

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@`
`3`	`3`	`// See the LICENSE file in the project root for more information.`
`4`	`4`
`5`	`5`	`using System;`
`6`		`-using System.Diagnostics;`
`7`	`6`
`8`	`7`	`namespace CommunityToolkit.Mvvm.ComponentModel;`
`9`	`8`
`@@ -36,7 +35,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;`
`36`	`35`	`/// </code>`
`37`	`36`	`/// </summary>`
`38`	`37`	`[AttributeUsage(AttributeTargets.Field, AllowMultiple = false, Inherited = false)]`
`39`		`-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]`
`40`	`38`	`public sealed class AlsoBroadcastChangeAttribute : Attribute`
`41`	`39`	`{`
`42`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`
`5`	`5`	`using System;`
`6`	`6`	`using System.ComponentModel;`
`7`		`-using System.Diagnostics;`
`8`	`7`
`9`	`8`	`namespace CommunityToolkit.Mvvm.ComponentModel;`
`10`	`9`
`@@ -27,7 +26,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;`
`27`	`26`	`/// And with this, the same APIs from <see cref="ObservableObject"/> will be available on this type as well.`
`28`	`27`	`/// </summary>`
`29`	`28`	`[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]`
`30`		`-[Conditional("MVVMTOOLKIT_KEEP_SOURCE_GENERATOR_ATTRIBUTES")]`
`31`	`29`	`public sealed class ObservableObjectAttribute : Attribute`
`32`	`30`	`{`
`33`	`31`	`}`