Merge branch 'develop' into localizable_columns

Author: mitchelsellers

.github/workflows/ci-build.yml

@@ -19,7 +19,7 @@ jobs:
         fetch-depth: 0
 
     - name: Ensure .NET Installed
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 6.0.x
 
@@ -46,10 +46,10 @@ jobs:
     env:
       solution-path: './src/NetCore.Utilities.Spreadsheet.sln'
     steps:
-      - name: Set up JDK 11
+      - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
-          java-version: 11
+          java-version: 17
           distribution: zulu
       - uses: actions/checkout@v4
         with:
@@ -89,7 +89,7 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         shell: powershell
         run: |
-          .\.sonar\scanner\dotnet-sonarscanner begin /k:"IowaComputerGurus_netcore.utilities.spreadsheet" /o:"iowacomputergurus-github" /d:sonar.login="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io"
+          .\.sonar\scanner\dotnet-sonarscanner begin /k:"IowaComputerGurus_netcore.utilities.spreadsheet" /o:"iowacomputergurus-github" /d:sonar.token="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io"
           dotnet restore "${{ env.solution-path }}"
           dotnet build "${{ env.solution-path }}" --no-restore --configuration Release -p:version=${{ steps.gitversion.outputs.majorMinorPatch }}
           dotnet test "${{ env.solution-path }}" --no-build --configuration Release --collect "XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=opencover --logger "trx;LogFileName=unittests.trx"

.github/workflows/codeql.yml

@@ -18,7 +18,7 @@ jobs:
         fetch-depth: 0
 
     - name: Ensure .NET Installed
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 6.0.x
 

.github/workflows/release-build.yml

@@ -45,7 +45,8 @@ var exportDefinition = new SpreadsheetConfiguration<SimpleExportData>
     DocumentSubTitle = "Showing the full options",
     ExportData = GetSampleExportData(100),
     WorksheetName = "Sample",
-    FreezePanes = true
+    FreezePanes = true,
+    AutoFilterDataRows = true
 };
 var fileContent = exportGenerator.CreateSingleSheetSpreadsheet(exportDefinition);
 System.IO.File.WriteAllBytes("Sample.xlsx", fileContent);
@@ -76,4 +77,6 @@ This package is primarily geared towards the exporting of lists of objects into
 * Data type formatting for Date & Currency fields
 * Auto-fit of all columns for display
 * The ability to freeze the header columns into a freeze pane for single sheet, or multi-sheet exports
-* Support for Curreny, Date, F0, F1, and F2 fixed date formats
+* The ability to add "Auto Filter" behavior to the data table portion of a sheet, while still supporting all other items
+* The ability to automatically add "simple formula" totals to columsn. (SUM, AVG, etc)
+* Support for Curreny, Date, F0, F1, F2, and F3 fixed data formats

README.md

@@ -1,10 +1,6 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
+namespace NetCore.Utilities.SpreadsheetExample.Models;
 
-namespace NetCore.Utilities.SpreadsheetExample.Models
+internal class SecondExportData
 {
-    class SecondExportData
-    {
-    }
-}
+
+}

samples/NetCore.Utilities.SpreadsheetExample/Models/SecondExportData.cs

@@ -1,19 +1,20 @@
 using System;
-using System.ComponentModel;
 using ICG.NetCore.Utilities.Spreadsheet;
 
-namespace NetCore.Utilities.SpreadsheetExample.Models
+namespace NetCore.Utilities.SpreadsheetExample.Models;
+
+public class SimpleExportData
 {
-    public class SimpleExportData
-    {
-        public string Title { get; set; }
+    public string Title { get; set; }
+
+    [SpreadsheetColumn("Due Date", format: "D")]
+    public DateTime DueDate { get; set; }
+
+    [SpreadsheetColumn("Total Cost", format: "C", formula: "SUM")]
+    public decimal TotalCost { get; set; }
 
-        [SpreadsheetColumn("Due Date", format:"D")]
-        public DateTime DueDate { get; set; }
-        
-        [SpreadsheetColumn("Total Cost", format:"C")]
-        public decimal TotalCost { get; set; }
+    [SpreadsheetColumn("Testing Numbers", format: "F3")]
+    public decimal TestingNumbers { get; set; }
 
-        public string Notes { get; set; }
-    }
+    public string Notes { get; set; }
 }

samples/NetCore.Utilities.SpreadsheetExample/Models/SimpleExportData.cs

@@ -1,61 +1,64 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
 using ICG.NetCore.Utilities.Spreadsheet;
 using Microsoft.Extensions.DependencyInjection;
 using NetCore.Utilities.SpreadsheetExample.Models;
 
-namespace NetCore.Utilities.SpreadsheetExample
+namespace NetCore.Utilities.SpreadsheetExample;
+
+internal class Program
 {
-    class Program
+    private static void Main(string[] args)
     {
-        static void Main(string[] args)
+        //Setup our DI Container
+        var services = new ServiceCollection();
+        services.UseIcgNetCoreUtilitiesSpreadsheet();
+        var provider = services.BuildServiceProvider();
+
+        //Get our generator and export
+        var exportGenerator = provider.GetRequiredService<ISpreadsheetGenerator>();
+        var exportDefinition = new SpreadsheetConfiguration<SimpleExportData>
         {
-            //Setup our DI Container
-            var services = new ServiceCollection();
-            services.UseIcgNetCoreUtilitiesSpreadsheet();
-            var provider = services.BuildServiceProvider();
+            RenderTitle = true,
+            DocumentTitle = "Sample Export of 100 Records",
+            RenderSubTitle = true,
+            DocumentSubTitle = "Showing the full options",
+            ExportData = GetSampleExportData(100),
+            WorksheetName = "Sample",
+            FreezeHeaders = true,
+            AutoFilterDataRows = true
+        };
+        var fileContent = exportGenerator.CreateSingleSheetSpreadsheet(exportDefinition);
+        File.WriteAllBytes("Sample.xlsx", fileContent);
 
-            //Get our generator and export
-            var exportGenerator = provider.GetRequiredService<ISpreadsheetGenerator>();
-            var exportDefinition = new SpreadsheetConfiguration<SimpleExportData>
+        //Sample 2 sheet export
+        var multiSheetDefinition = new MultisheetConfiguration()
+            .WithSheet("Sheet 1", GetSampleExportData(100))
+            .WithSheet("Additional Sheet", GetSampleExportData(500), config =>
             {
-                RenderTitle = true,
-                DocumentTitle = "Sample Export of 100 Records",
-                RenderSubTitle = true,
-                DocumentSubTitle = "Showing the full options",
-                ExportData = GetSampleExportData(100),
-                WorksheetName = "Sample",
-                FreezeHeaders = true
-            };
-            var fileContent = exportGenerator.CreateSingleSheetSpreadsheet(exportDefinition);
-            System.IO.File.WriteAllBytes("Sample.xlsx", fileContent);
-
-            //Sample 2 sheet export
-            var multiSheetDefinition = new MultisheetConfiguration()
-                .WithSheet("Sheet 1", GetSampleExportData(100))
-                .WithSheet("Additional Sheet", GetSampleExportData(500), config =>
-                {
-                    config.DocumentTitle = "Lots of data";
-                    config.RenderTitle = true;
-                    config.FreezeHeaders = true;
-                });
+                config.DocumentTitle = "Lots of data";
+                config.RenderTitle = true;
+                config.FreezeHeaders = true;
+                config.AutoFilterDataRows = true;
+            });
 
-            var multiFileContent = exportGenerator.CreateMultiSheetSpreadsheet(multiSheetDefinition);
-            System.IO.File.WriteAllBytes("Sample-Multi.xlsx", multiFileContent);
-            Console.WriteLine("Files Created");
-            Console.ReadLine();
-        }
+        var multiFileContent = exportGenerator.CreateMultiSheetSpreadsheet(multiSheetDefinition);
+        File.WriteAllBytes("Sample-Multi.xlsx", multiFileContent);
+        Console.WriteLine("Files Created");
+        Console.ReadLine();
+    }
 
-        private static List<SimpleExportData> GetSampleExportData(int numberOfRecords)
-        {
-            var listData = new List<SimpleExportData>();
-            for (var i = 0; i < numberOfRecords; i++)
+    private static List<SimpleExportData> GetSampleExportData(int numberOfRecords)
+    {
+        var listData = new List<SimpleExportData>();
+        for (var i = 0; i < numberOfRecords; i++)
+            listData.Add(new SimpleExportData
             {
-                listData.Add(new SimpleExportData
-                    {DueDate = DateTime.Now.AddDays(i), Notes = $"Record {i} notes", TotalCost = 15m, Title = $"Sample Data Row #{i}"});
-            }
+                DueDate = DateTime.Now.AddDays(i), Notes = $"Record {i} notes", TotalCost = 15m,
+                TestingNumbers = 1234.4567289m, Title = $"Sample Data Row #{i}"
+            });
 
-            return listData;
-        }
+        return listData;
     }
-}
+}

samples/NetCore.Utilities.SpreadsheetExample/Program.cs

@@ -160,6 +160,7 @@ private static Faker<TestExportRecord> GetTestExportRecordFaker() =>
             .RuleFor(i => i.Fixed0, f => f.Random.Decimal(0, 100))
             .RuleFor(i => i.Fixed1, f => f.Random.Decimal(0, 100))
             .RuleFor(i => i.Fixed2, f => f.Random.Decimal(0, 100))
+            .RuleFor(i => i.Fixed3, f=> f.Random.Decimal(0, 100))
     ;
 
     private static Faker<DifferentTestExportRecord> GetDifferentTestExportRecordFaker() =>
@@ -265,6 +266,29 @@ public void CreateSingleWorksheet_Returning_Bytes_Should_Work()
         File.WriteAllBytes(sheetPath, result);
         ValidateExportedSheet(ms, 1, testData);
     }
+    
+    [Fact]
+    public void CreateSingleWorksheet_With_Formula()
+    {
+        using var ms = new MemoryStream();
+        var testData = new List<SampleExportRecordWithFormula>()
+        {
+            new() { RecordTitle = "test record 1", RecordAmount = 10, RecordSize = 444 },
+            new() { RecordTitle = "test record 2", RecordAmount = 20, RecordSize = 5 },
+            new() { RecordTitle = "test record 3", RecordAmount = 30, RecordSize = 67 },
+            new() { RecordTitle = "test record 4", RecordAmount = 3, RecordSize = 477 },
+        };
+
+        _spreadsheetGenerator.CreateSingleSheetSpreadsheet(ms, new SpreadsheetConfiguration<SampleExportRecordWithFormula>
+        {
+            WorksheetName = "Test Sheet",
+            AutoSizeColumns = true,
+            ExportData = testData
+        });
+        
+        ms.Seek(0, SeekOrigin.Begin);
+        ms.Should().NotHaveLength(0);
+    }
 
     /*
      * This uses the OpenXmlSpreadsheetParser to attempt to pull the data out of the spreadsheet we just

src/NetCore.Utilities.Spreadsheet.Tests/OpenXmlSpreadsheetGeneratorTests.cs

@@ -92,6 +92,10 @@ public class TestExportRecord
     [SpreadsheetColumn(displayName: "Fixed2", format: ColumnFormats.Fixed2)]
     [SpreadsheetImportColumn(19)]
     public decimal Fixed2 { get; set; }
+
+    [SpreadsheetColumn(displayName: "Fixed3", format: ColumnFormats.Fixed3)]
+    [SpreadsheetImportColumn(20)]
+    public decimal Fixed3 { get; set; }
 }
 
 public class DifferentTestExportRecord
@@ -118,4 +122,16 @@ public class LocalizedSampleExportRecord
 {
     [SpreadsheetColumn(ResourceFileType = typeof(TestResources), ResourceKey = nameof(TestResources.LocalizedColumn))]
     public string? RecordTitle { get; set; }
+}
+
+public class SampleExportRecordWithFormula
+{
+    [DisplayName("Title")]
+    public string? RecordTitle { get; set; }
+
+    [SpreadsheetColumn("Amount", Formula = "SUM")]
+    public decimal RecordAmount { get; set; }
+    
+    [SpreadsheetColumn("Size", Formula = "MAX")]
+    public decimal RecordSize { get; set; }
 }