Separating project into different assemblies (#828)

* Separating into 3 assemblies, changing namespaces, renaming main APIs, adding Directory.Build.props, and general refactoring

* Rebasing, fixing merge conflicts and updating workflows

* Made core and csv projects fully independent

Moving importer, exporter and templater classes into core project and making them extensible, changing project names, fixing directory.build.props dependency warnings, turning solution file to slnx format, adding (basic) async implementation of MiniExcelDataReader

* Reverting to standard .sln solution file to fix CodeQL analysis

* Codeql workflow fixes for new slnx solution format

* Added global usings

* Updating directory.build.props target framework after rebasing

* Removing facade assembly, renaming MiniExcel.Core project to MiniExcel

* Added some more global usings

* Separate CSV test cases

* Changing MiniExcelTests project name to MiniExcel.Tests

* Fixing commit mistake

* Adjusted csv test namespaces

* Introduced extensible providers for exporter, importer and templater

* Added public api for applying a template from a template stream

* Added assembly for legacy methods

* Fixing build errors

* Moved the public api under relevant namespace, changed version from beta to preview

* Removing warning suppressions and adding a check on seekable stream template for SaveAsByTemplate method

* Renamed API methods deleting Excel and Csv suffixes for simplicity

Also moved a few tests and test sections from the main testing assembly to the csv testing assembly

* Changed namespaces .Api to .Providers in both main and csv assemblies

* Added Directory.Packages.props file and moved package metadata content to Directory.Build.props

* Reintroduced facade assembly containing legacy code

- Renamed MiniExcel to MiniExcel.Core again
- Added different packages titles and ids for the assemblies
- Renamed the providers back to Api but simplified namespaces

* Fixed accidentally adding old tests not part of the solution

* Adjusting legacy namespaces and adding old attributes signatures

* Renamed some methods and properties

---------

Co-authored-by: Victor Irzak <[email protected]>

Author: michelebastione

.github/workflows/benchmark.yml

@@ -3,6 +3,7 @@ name: MiniExcel Benchmarks
 on:
   workflow_dispatch:
   release:
+    branches: [master, v1.x-maintenance]
     types: [published]
 
 permissions:
@@ -31,7 +32,7 @@ jobs:
           BenchmarkMode: Automatic
           BenchmarkSection: query
       - name: Renaming result file
-        run: mv MiniExcelLibs.Benchmarks.BenchmarkSections.QueryXlsxBenchmark-report-github.md query-benchmark.md
+        run: mv MiniExcelLib.Benchmarks.BenchmarkSections.QueryXlsxBenchmark-report-github.md query-benchmark.md
         working-directory: ./benchmarks/MiniExcel.Benchmarks/BenchmarkDotNet.Artifacts/results
       - name: Save benchmark results
         uses: actions/upload-artifact@v4
@@ -61,7 +62,7 @@ jobs:
           BenchmarkMode: Automatic
           BenchmarkSection: create
       - name: Renaming result file
-        run: mv MiniExcelLibs.Benchmarks.BenchmarkSections.CreateXlsxBenchmark-report-github.md create-benchmark.md
+        run: mv MiniExcelLib.Benchmarks.BenchmarkSections.CreateXlsxBenchmark-report-github.md create-benchmark.md
         working-directory: ./benchmarks/MiniExcel.Benchmarks/BenchmarkDotNet.Artifacts/results
       - name: Save benchmark results
         uses: actions/upload-artifact@v4
@@ -91,7 +92,7 @@ jobs:
           BenchmarkMode: Automatic
           BenchmarkSection: template
       - name: Renaming result file
-        run: mv MiniExcelLibs.Benchmarks.BenchmarkSections.TemplateXlsxBenchmark-report-github.md template-benchmark.md
+        run: mv MiniExcelLib.Benchmarks.BenchmarkSections.TemplateXlsxBenchmark-report-github.md template-benchmark.md
         working-directory: ./benchmarks/MiniExcel.Benchmarks/BenchmarkDotNet.Artifacts/results
       - name: Save benchmark results
         uses: actions/upload-artifact@v4

.github/workflows/codeql-analysis.yml

@@ -59,8 +59,9 @@ jobs:
 
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+    
+#    - name: Autobuild
+#      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -69,9 +70,8 @@ jobs:
     #    and modify them (or add more) to build your code if your project
     #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+    - name: Manual build
+      run: dotnet build
 
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v3

.github/workflows/dotnet.yml

@@ -3,8 +3,7 @@ name: .NET
 on:
   pull_request:
   push:
-    branches:
-    - master
+    branches: [master, v1.x-maintenance]
 
 jobs:
   build:

.gitignore

@@ -401,5 +401,6 @@ FodyWeavers.xsd
 /BenchmarkDotNet.Artifacts
 /tests/MiniExcel.Tests.AspNetMvc/packages
 /TestTemplate
-/tests/MiniExcelTests/TemplateOptimization
-/samples/xlsx/Test_EnableWriteFilePath.xlsx
+/tests/MiniExcel.Tests/TemplateOptimization
+/samples/xlsx/Test_EnableWriteFilePath.xlsx
+/tests/MiniExcel.Core.Tests/TemplateOptimization/

LICENSE

@@ -175,18 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2021 Wei Lin
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

MiniExcel.sln

@@ -0,0 +1,37 @@
+<Solution>
+  <Folder Name="/benchmarks/">
+    <Project Path="benchmarks\MiniExcel.Benchmarks\MiniExcel.Benchmarks.csproj" />
+  </Folder>
+  <Folder Name="/Docs and settings/">
+    <File Path=".gitattributes" />
+    <File Path=".gitignore" />
+    <File Path="appveyor.yml" />
+    <File Path=".github\workflows\dotnet.yml" />
+    <File Path="LICENSE" />
+    <File Path="README-NuGet.md" />
+    <File Path="README.md" />
+    <File Path="README.zh-CN.md" />
+    <File Path="README.zh-Hant.md" />
+    <File Path=".github\workflows\benchmark.yml" />
+    <File Path=".github\workflows\codeql-analysis.yml" />
+    <File Path="src\Directory.Build.props" />
+    <File Path="src\Directory.Packages.props" />
+    <File Path="miniexcel.publickey" />
+    <File Path="src\icon.png" />
+  </Folder>
+  <Folder Name="/Releases/">
+    <File Path="docs\README.md" />
+    <File Path="docs\README.zh-CN.md" />
+    <File Path="docs\README.zh-Hant.md" />
+  </Folder>
+  <Folder Name="/src/">
+    <Project Path="src\MiniExcel.Core\MiniExcel.Core.csproj" />
+    <Project Path="src\MiniExcel.Csv\MiniExcel.Csv.csproj" />
+    <Project Path="src\MiniExcel\MiniExcel.csproj" Type="Classic C#" />
+  </Folder>
+  <Folder Name="/tests/">
+    <Project Path="tests/MiniExcel.Csv.Tests/MiniExcel.Csv.Tests.csproj" />
+    <Project Path="tests/MiniExcel.Tests.Common/MiniExcel.Tests.Common.csproj" />
+    <Project Path="tests\MiniExcel.Core.Tests\MiniExcel.Core.Tests.csproj" />
+  </Folder>
+</Solution>

MiniExcel.slnx

@@ -1,4 +1,4 @@
-namespace MiniExcelLibs.Benchmarks;
+namespace MiniExcelLib.Benchmarks;
 
 public abstract class BenchmarkBase
 {

benchmarks/MiniExcel.Benchmarks/BenchmarkBase.cs

@@ -7,16 +7,18 @@
 using BenchmarkDotNet.Loggers;
 using BenchmarkDotNet.Order;
 
-namespace MiniExcelLibs.Benchmarks;
+namespace MiniExcelLib.Benchmarks;
 
-public class Config : ManualConfig
+internal class BenchmarkConfig : ManualConfig
 {
     private const int Launches = 1;
     private const int Warmups = 3;
     private const int Unrolls = 3;
     private const int Iterations = 3;
 
-    public Config()
+    public static BenchmarkConfig Default => new();
+    
+    private BenchmarkConfig()
     {
         AddLogger(ConsoleLogger.Default);
 

benchmarks/MiniExcel.Benchmarks/Config.cs …/MiniExcel.Benchmarks/BenchmarkConfig.csbenchmarks/MiniExcel.Benchmarks/Config.cs renamed to benchmarks/MiniExcel.Benchmarks/BenchmarkConfig.cs benchmarks/MiniExcel.Benchmarks/Config.cs renamed to benchmarks/MiniExcel.Benchmarks/BenchmarkConfig.cs

@@ -4,26 +4,31 @@
 using DocumentFormat.OpenXml;
 using DocumentFormat.OpenXml.Packaging;
 using DocumentFormat.OpenXml.Spreadsheet;
-using MiniExcelLibs.Benchmarks.Utils;
+using MiniExcelLib.Benchmarks.Utils;
+using MiniExcelLib.Core;
 using NPOI.XSSF.UserModel;
 using OfficeOpenXml;
 
-namespace MiniExcelLibs.Benchmarks.BenchmarkSections;
+namespace MiniExcelLib.Benchmarks.BenchmarkSections;
 
-public class CreateXlsxBenchmark : BenchmarkBase
+public class CreateExcelBenchmark : BenchmarkBase
 {
+    private OpenXmlExporter _exporter;
+        
     [GlobalSetup]
     public void SetUp()
     {
         ExcelPackage.LicenseContext = LicenseContext.NonCommercial;
         Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
+        
+        _exporter = MiniExcel.Exporters.GetOpenXmlExporter();
     }
 
     [Benchmark(Description = "MiniExcel Create Xlsx")]
     public void MiniExcelCreateTest()
     {
         using var path = AutoDeletingPath.Create();
-        MiniExcel.SaveAs(path.FilePath, GetValue());
+        _exporter.Export(path.FilePath, GetValue());
     }
 
     [Benchmark(Description = "ClosedXml Create Xlsx")]
@@ -72,10 +77,9 @@ public void NPOICreateTest()
             row.CreateCell(9).SetCellValue(item.Column10);
             i++;
         }
-        using (var fs = File.Create(path.FilePath))
-        {
-            wb.Write(fs);
-        }
+
+        using var fs = File.Create(path.FilePath);
+        wb.Write(fs);
     }
 
     [Benchmark(Description = "OpenXmlSdk Create Xlsx by DOM mode")]