Supporting Obsolete properties (#19)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: bsundsbo

Source/FluentApi.Generator/FluentCodeGenerator/FluentExtensionCodeGenerator.cs

@@ -94,6 +94,11 @@ private void GenerateExtensionMethods(List<IExtensionTemplateModel> propertyTemp
                 continue;
             }
 
+            if (propertyModel is IExtensionPropertyTemplateModel propertyTemplate && propertyTemplate.IsObsolete)
+            {
+                sourceBuilder.AppendLineWithIndent(1, $"[Obsolete(\"{propertyTemplate.PropertyName} is obsolete. See reason and workaround on the property itself.\")]");
+            }
+
             var output = template.Render(propertyModel, MemberRenamer);
             sourceBuilder.AppendLine(output);
         }

Source/FluentApi.Generator/FluentCodeGenerator/TemplateModels/IExtensionPropertyTemplateModel.cs

@@ -0,0 +1,17 @@
+namespace Bars.Mvvm.FluentApi.Generator.Extensions.Models;
+
+/// <summary>
+/// Interface for property template models that have an obsolete attribute.
+/// </summary>
+internal interface IExtensionPropertyTemplateModel : IExtensionTemplateModel
+{
+    /// <summary>
+    /// Indicates whether the property is obsolete and should be marked as such in the generated code.
+    /// </summary>
+    bool IsObsolete { get; }
+
+    /// <summary>
+    /// Get the name of the property.
+    /// </summary>
+    string PropertyName { get; }
+}

Source/FluentApi.Generator/FluentCodeGenerator/TemplateModels/PropertyTemplateModel.cs

@@ -1,11 +1,12 @@
 using Microsoft.CodeAnalysis;
+using System.Linq;
 
 namespace Bars.Mvvm.FluentApi.Generator.Extensions.Models;
 
 /// <summary>
 /// Base model for specific property template models. All these properties are used in various templates when generating code.
 /// </summary>
-internal record PropertyTemplateModel : IExtensionTemplateModel
+internal record PropertyTemplateModel : IExtensionPropertyTemplateModel
 {
     public PropertyTemplateModel(INamedTypeSymbol classSymbol, IPropertySymbol propertySymbol)
     {
@@ -14,35 +15,41 @@ public PropertyTemplateModel(INamedTypeSymbol classSymbol, IPropertySymbol prope
         ParameterName = char.ToLowerInvariant(this.PropertyName[0]) + this.PropertyName.Substring(1);
         ClassName = classSymbol.Name;
         NamespaceName = classSymbol.ContainingNamespace.ToDisplayString();
+        var obsoleteAttribute = propertySymbol.GetAttributes()
+            .FirstOrDefault(a => a.AttributeClass?.ToDisplayString() == "System.ObsoleteAttribute");
+        IsObsolete = obsoleteAttribute != null;
     }
 
+    /// <inheritdoc />
+    public bool IsObsolete { get; }
+
     /// <summary>
     /// Namespace name of the class that contains the class where the property is declared.
     /// </summary>
-    public object NamespaceName { get; init; }
+    public string NamespaceName { get; }
 
     /// <summary>
     /// Class declaring the property.
     /// </summary>
-    public object ClassName { get; init; }
+    public string ClassName { get; }
 
     /// <summary>
     /// Formatted parameter name for the property, which is <see cref="PropertyName"/> in camel case.
     /// </summary>
-    public string ParameterName { get; init; }
+    public string ParameterName { get; }
 
     /// <summary>
     /// Type of the property.
     /// </summary>
-    public string PropertyType { get; init; }
+    public string PropertyType { get; }
 
     /// <summary>
     /// Name of the property generating extension method for.
     /// </summary>
-    public string PropertyName { get; init; }
+    public string PropertyName { get; }
 
     public override string ToString()
     {
-        return $"{nameof(NamespaceName)}: {NamespaceName}, {nameof(ClassName)}: {ClassName}, {nameof(ParameterName)}: {ParameterName}, {nameof(PropertyType)}: {PropertyType}, {nameof(PropertyName)}: {PropertyName}";
+        return $"{nameof(NamespaceName)}: {NamespaceName}, {nameof(ClassName)}: {ClassName}, {nameof(ParameterName)}: {ParameterName}, {nameof(PropertyType)}: {PropertyType}, {nameof(PropertyName)}: {PropertyName}, {nameof(IsObsolete)}: {IsObsolete}";
     }
 }

Source/FluentApi.Generator/Package-README.md

@@ -17,6 +17,8 @@ new BarToggleButtonViewModel(key)
 ```
 Release Notes:
 
+* 0.3.1
+  * Extension methods marked as [Obsolete] will also be marked as obsolete. Projects treating obsolete warnings as errors will no longer fail, and consumer will be informed about the obsolete properties.
 * 0.3.0
   * Renamed package to `Bars.Mvvm.FluentApi.Generator` to better reflect terminology, rather than `Bars.Mvvm.FluidApi.Generator`. No changes to functionality.
   * Continuing existing version history to maintain consistency with previous releases.

Version.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "nuGetPackageVersion": {
     "semVer": 2.0
   },