Merge pull request #81 from sveinungf/dev/srcgen-columnignore

Source generator - ColumnIgnore
sveinungf · Nov 2, 2024 · ea47e2f · ea47e2f
2 parents 623064d + 4d00924
commit ea47e2f
Show file tree

Hide file tree

Showing 16 changed files with 160 additions and 3 deletions.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -5,7 +5,7 @@
   </PropertyGroup>
   <ItemGroup>
     <GlobalPackageReference Include="ErrorProne.NET.CoreAnalyzers" Version="0.4.0-beta.1" />
-    <GlobalPackageReference Include="Meziantou.Analyzer" Version="2.0.176" />
+    <GlobalPackageReference Include="Meziantou.Analyzer" Version="2.0.177" />
     <GlobalPackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="3.3.4" />
     <GlobalPackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.11.20" />
     <GlobalPackageReference Include="PrimaryConstructorAnalyzer" Version="1.0.6" />
@@ -35,7 +35,7 @@
     <PackageVersion Include="System.Reflection.Metadata" Version="8.0.1" />
     <PackageVersion Include="TngTech.ArchUnitNET.xUnit" Version="0.11.1" />
     <PackageVersion Include="Verify.SourceGenerators" Version="2.5.0" />
-    <PackageVersion Include="Verify.Xunit" Version="27.1.0" />
+    <PackageVersion Include="Verify.Xunit" Version="28.1.3" />
     <PackageVersion Include="xunit" Version="2.9.2" />
     <PackageVersion Include="xunit.assert" Version="2.9.2" />
     <PackageVersion Include="Xunit.Combinatorial" Version="1.6.24" />

diff --git a/SpreadCheetah.SourceGenerator.SnapshotTest/Tests/ColumnIgnoreTests.cs b/SpreadCheetah.SourceGenerator.SnapshotTest/Tests/ColumnIgnoreTests.cs
@@ -0,0 +1,58 @@
+using SpreadCheetah.SourceGenerator.SnapshotTest.Helpers;
+
+namespace SpreadCheetah.SourceGenerator.SnapshotTest.Tests;
+
+public class ColumnIgnoreTests
+{
+    [Fact]
+    public Task ColumnIgnore_ClassPropertyWithAnotherSpreadCheetahAttribute()
+    {
+        // Arrange
+        var context = AnalyzerTest.CreateContext();
+        context.TestCode = """
+            using SpreadCheetah.SourceGeneration;
+
+            namespace MyNamespace;
+
+            public class ClassWithColumnIgnore
+            {
+                [{|SPCH1008:CellFormat("#.0#")|}]
+                [ColumnIgnore]
+                [{|SPCH1008:ColumnWidth(10)|}]
+                public decimal Value { get; set; }
+            }
+
+            [WorksheetRow(typeof(ClassWithColumnIgnore))]
+            public partial class MyGenRowContext : WorksheetRowContext;
+            """;
+
+        // Act & Assert
+        return context.RunAsync();
+    }
+
+    [Fact]
+    public Task ColumnIgnore_ClassPropertyWithAnotherUnrelatedAttribute()
+    {
+        // Arrange
+        var context = AnalyzerTest.CreateContext();
+        context.TestCode = """
+            using SpreadCheetah.SourceGeneration;
+            using System.ComponentModel.DataAnnotations;
+
+            namespace MyNamespace;
+
+            public class ClassWithColumnIgnore
+            {
+                [Required]
+                [ColumnIgnore]
+                public decimal Value { get; set; }
+            }
+
+            [WorksheetRow(typeof(ClassWithColumnIgnore))]
+            public partial class MyGenRowContext : WorksheetRowContext;
+            """;
+
+        // Act & Assert
+        return context.RunAsync();
+    }
+}
diff --git a/SpreadCheetah.SourceGenerator.Test/Models/ColumnIgnore/ClassWithMultipleProperties.cs b/SpreadCheetah.SourceGenerator.Test/Models/ColumnIgnore/ClassWithMultipleProperties.cs
@@ -0,0 +1,14 @@
+using SpreadCheetah.SourceGeneration;
+
+namespace SpreadCheetah.SourceGenerator.Test.Models.ColumnIgnore;
+
+public class ClassWithMultipleProperties
+{
+    [ColumnIgnore]
+    public int Id { get; set; }
+
+    public string? Name { get; set; }
+
+    [ColumnIgnore]
+    public decimal Price { get; set; }
+}
diff --git a/SpreadCheetah.SourceGenerator.Test/Models/ColumnIgnore/ColumnIgnoreContext.cs b/SpreadCheetah.SourceGenerator.Test/Models/ColumnIgnore/ColumnIgnoreContext.cs
@@ -0,0 +1,6 @@
+using SpreadCheetah.SourceGeneration;
+
+namespace SpreadCheetah.SourceGenerator.Test.Models.ColumnIgnore;
+
+[WorksheetRow(typeof(ClassWithMultipleProperties))]
+public partial class ColumnIgnoreContext : WorksheetRowContext;
diff --git a/SpreadCheetah.SourceGenerator.Test/Tests/ColumnIgnoreTests.cs b/SpreadCheetah.SourceGenerator.Test/Tests/ColumnIgnoreTests.cs
@@ -0,0 +1,32 @@
+using SpreadCheetah.SourceGenerator.Test.Models.ColumnIgnore;
+using SpreadCheetah.TestHelpers.Assertions;
+using Xunit;
+
+namespace SpreadCheetah.SourceGenerator.Test.Tests;
+
+public class ColumnIgnoreTests
+{
+    [Fact]
+    public async Task ColumnIgnore_ClassWithMultipleProperties()
+    {
+        // Arrange
+        using var stream = new MemoryStream();
+        await using var spreadsheet = await Spreadsheet.CreateNewAsync(stream);
+        await spreadsheet.StartWorksheetAsync("Sheet");
+        var obj = new ClassWithMultipleProperties
+        {
+            Id = 1,
+            Name = "Foo",
+            Price = 199.90m
+        };
+
+        // Act
+        await spreadsheet.AddAsRowAsync(obj, ColumnIgnoreContext.Default.ClassWithMultipleProperties);
+        await spreadsheet.FinishAsync();
+
+        // Assert
+        using var sheet = SpreadsheetAssert.SingleSheet(stream);
+        Assert.Equal(obj.Name, sheet["A1"].StringValue);
+        Assert.Single(sheet.Columns);
+    }
+}
diff --git a/SpreadCheetah.SourceGenerator/Helpers/AttributeDataComparer.cs b/SpreadCheetah.SourceGenerator/Helpers/AttributeDataComparer.cs
@@ -18,6 +18,7 @@ private static int GetOrder(string? metadataName)
     {
         return metadataName switch
         {
+            Attributes.ColumnIgnore => -2,
             Attributes.CellValueConverter => -1,
             Attributes.CellStyle => 1,
             _ => 0

diff --git a/SpreadCheetah.SourceGenerator/Helpers/Attributes.cs b/SpreadCheetah.SourceGenerator/Helpers/Attributes.cs
@@ -7,6 +7,7 @@ internal static class Attributes
     public const string CellValueConverter = "CellValueConverterAttribute";
     public const string CellValueTruncate = "CellValueTruncateAttribute";
     public const string ColumnHeader = "ColumnHeaderAttribute";
+    public const string ColumnIgnore = "ColumnIgnoreAttribute";
     public const string ColumnOrder = "ColumnOrderAttribute";
     public const string ColumnWidth = "ColumnWidthAttribute";
     public const string GenerationOptions = "WorksheetRowGenerationOptionsAttribute";

diff --git a/SpreadCheetah.SourceGenerator/Helpers/PropertyAnalyzer.cs b/SpreadCheetah.SourceGenerator/Helpers/PropertyAnalyzer.cs
@@ -24,13 +24,20 @@ public PropertyAttributeData Analyze(IPropertySymbol property, CancellationToken
 
         foreach (var attribute in attributes)
         {
+            if (_result.ColumnIgnore is not null)
+            {
+                diagnostics.ReportAttributeCombinationNotSupported(attribute, Attributes.ColumnIgnore, token);
+                continue;
+            }
+
             _ = attribute.AttributeClass?.MetadataName switch
             {
                 Attributes.CellFormat => TryGetCellFormatAttribute(attribute, token),
                 Attributes.CellStyle => TryGetCellStyleAttribute(attribute, token),
                 Attributes.CellValueConverter => TryGetCellValueConverterAttribute(attribute, property.Type, token),
                 Attributes.CellValueTruncate => TryGetCellValueTruncateAttribute(attribute, property.Type, token),
                 Attributes.ColumnHeader => TryGetColumnHeaderAttribute(attribute, token),
+                Attributes.ColumnIgnore => TryGetColumnIgnoreAttribute(),
                 Attributes.ColumnOrder => TryGetColumnOrderAttribute(attribute),
                 Attributes.ColumnWidth => TryGetColumnWidthAttribute(attribute, token),
                 _ => false
@@ -204,6 +211,12 @@ private bool TryGetColumnHeaderAttribute(
         return null;
     }
 
+    private bool TryGetColumnIgnoreAttribute()
+    {
+        _result.ColumnIgnore = new ColumnIgnore();
+        return true;
+    }
+
     private bool TryGetColumnOrderAttribute(AttributeData attribute)
     {
         var args = attribute.ConstructorArguments;

diff --git a/SpreadCheetah.SourceGenerator/Models/ColumnIgnore.cs b/SpreadCheetah.SourceGenerator/Models/ColumnIgnore.cs
@@ -0,0 +1,3 @@
+namespace SpreadCheetah.SourceGenerator.Models;
+
+internal readonly record struct ColumnIgnore;
diff --git a/SpreadCheetah.SourceGenerator/Models/PropertyAttributeData.cs b/SpreadCheetah.SourceGenerator/Models/PropertyAttributeData.cs
@@ -10,6 +10,7 @@ internal record struct PropertyAttributeData
     public CellValueConverter? CellValueConverter { get; set; }
     public CellValueTruncate? CellValueTruncate { get; set; }
     public ColumnHeader? ColumnHeader { get; set; }
+    public ColumnIgnore? ColumnIgnore { get; set; }
     public ColumnOrder? ColumnOrder { get; set; }
     public ColumnWidth? ColumnWidth { get; set; }
 }
diff --git a/SpreadCheetah.SourceGenerator/WorksheetRowGenerator.cs b/SpreadCheetah.SourceGenerator/WorksheetRowGenerator.cs
@@ -81,7 +81,8 @@ private static RowType AnalyzeTypeProperties(ITypeSymbol rowType, CancellationTo
         foreach (var property in properties)
         {
             var data = analyzer.Analyze(property, token);
-
+            if (data.ColumnIgnore is not null)
+                continue;
             if (data.CellValueConverter is null && !property.Type.IsSupportedType())
                 continue;
 

diff --git a/SpreadCheetah.Test/Tests/PublicApiTests.PublicApi_Generate.DotNet6_0.verified.txt b/SpreadCheetah.Test/Tests/PublicApiTests.PublicApi_Generate.DotNet6_0.verified.txt
@@ -218,6 +218,11 @@ namespace SpreadCheetah.SourceGeneration
         public ColumnHeaderAttribute(System.Type type, string propertyName) { }
     }
     [System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
+    public sealed class ColumnIgnoreAttribute : System.Attribute
+    {
+        public ColumnIgnoreAttribute() { }
+    }
+    [System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
     public sealed class ColumnOrderAttribute : System.Attribute
     {
         public ColumnOrderAttribute(int order) { }

diff --git a/SpreadCheetah.Test/Tests/PublicApiTests.PublicApi_Generate.DotNet7_0.verified.txt b/SpreadCheetah.Test/Tests/PublicApiTests.PublicApi_Generate.DotNet7_0.verified.txt
@@ -218,6 +218,11 @@ namespace SpreadCheetah.SourceGeneration
         public ColumnHeaderAttribute(System.Type type, string propertyName) { }
     }
     [System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
+    public sealed class ColumnIgnoreAttribute : System.Attribute
+    {
+        public ColumnIgnoreAttribute() { }
+    }
+    [System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
     public sealed class ColumnOrderAttribute : System.Attribute
     {
         public ColumnOrderAttribute(int order) { }

diff --git a/SpreadCheetah.Test/Tests/PublicApiTests.PublicApi_Generate.DotNet8_0.verified.txt b/SpreadCheetah.Test/Tests/PublicApiTests.PublicApi_Generate.DotNet8_0.verified.txt
@@ -218,6 +218,11 @@ namespace SpreadCheetah.SourceGeneration
         public ColumnHeaderAttribute(System.Type type, string propertyName) { }
     }
     [System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
+    public sealed class ColumnIgnoreAttribute : System.Attribute
+    {
+        public ColumnIgnoreAttribute() { }
+    }
+    [System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
     public sealed class ColumnOrderAttribute : System.Attribute
     {
         public ColumnOrderAttribute(int order) { }

diff --git a/SpreadCheetah.Test/Tests/PublicApiTests.PublicApi_Generate.Net4_7.verified.txt b/SpreadCheetah.Test/Tests/PublicApiTests.PublicApi_Generate.Net4_7.verified.txt
@@ -217,6 +217,11 @@ namespace SpreadCheetah.SourceGeneration
         public ColumnHeaderAttribute(System.Type type, string propertyName) { }
     }
     [System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
+    public sealed class ColumnIgnoreAttribute : System.Attribute
+    {
+        public ColumnIgnoreAttribute() { }
+    }
+    [System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
     public sealed class ColumnOrderAttribute : System.Attribute
     {
         public ColumnOrderAttribute(int order) { }

diff --git a/SpreadCheetah/SourceGeneration/ColumnIgnoreAttribute.cs b/SpreadCheetah/SourceGeneration/ColumnIgnoreAttribute.cs
@@ -0,0 +1,7 @@
+namespace SpreadCheetah.SourceGeneration;
+
+/// <summary>
+/// Instructs the SpreadCheetah source generator to ignore a property.
+/// </summary>
+[AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
+public sealed class ColumnIgnoreAttribute : Attribute;