Separating project into different assemblies

.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:

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.slnx

@@ -0,0 +1,31 @@
+<Solution>
+  <Folder Name="/benchmarks/">
+    <Project Path="benchmarks\MiniExcel.Benchmarks\MiniExcel.Benchmarks.csproj" Type="Classic C#" />
+  </Folder>
+  <Folder Name="/Docs and setting/">
+    <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="docs\core_logic_diagram.drawio" />
+  </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.Csv\MiniExcel.Csv.csproj" Type="Classic C#" />
+    <Project Path="src\MiniExcel\MiniExcel.csproj" Type="Classic C#" />
+  </Folder>
+  <Folder Name="/tests/">
+    <Project Path="tests\MiniExcelTests\MiniExcelTests.csproj" Type="Classic C#" />
+  </Folder>
+</Solution>

benchmarks/MiniExcel.Benchmarks/BenchmarkBase.cs

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

benchmarks/MiniExcel.Benchmarks/Config.cs → benchmarks/MiniExcel.Benchmarks/BenchmarkConfig.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/BenchmarkSections/CreateXlsxBenchmark.cs

@@ -4,26 +4,29 @@
 using DocumentFormat.OpenXml;
 using DocumentFormat.OpenXml.Packaging;
 using DocumentFormat.OpenXml.Spreadsheet;
-using MiniExcelLibs.Benchmarks.Utils;
+using MiniExcelLib.Benchmarks.Utils;
 using NPOI.XSSF.UserModel;
 using OfficeOpenXml;
 
-namespace MiniExcelLibs.Benchmarks.BenchmarkSections;
+namespace MiniExcelLib.Benchmarks.BenchmarkSections;
 
 public class CreateXlsxBenchmark : BenchmarkBase
 {
+    private MiniExcelExporter _exporter;
+
     [GlobalSetup]
     public void SetUp()
     {
         ExcelPackage.LicenseContext = LicenseContext.NonCommercial;
         Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
+        _exporter = new MiniExcelExporter();
     }
 
     [Benchmark(Description = "MiniExcel Create Xlsx")]
     public void MiniExcelCreateTest()
     {
         using var path = AutoDeletingPath.Create();
-        MiniExcel.SaveAs(path.FilePath, GetValue());
+        _exporter.ExportXlsx(path.FilePath, GetValue());
     }
 
     [Benchmark(Description = "ClosedXml Create Xlsx")]
@@ -72,10 +75,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")]

benchmarks/MiniExcel.Benchmarks/BenchmarkSections/QueryXlsxBenchmark.cs

@@ -7,27 +7,30 @@
 using NPOI.XSSF.UserModel;
 using OfficeOpenXml;
 
-namespace MiniExcelLibs.Benchmarks.BenchmarkSections;
+namespace MiniExcelLib.Benchmarks.BenchmarkSections;
 
 public class QueryXlsxBenchmark : BenchmarkBase
 {
+    private MiniExcelImporter _importer;
+
     [GlobalSetup]
     public void SetUp()
     {
         ExcelPackage.LicenseContext = LicenseContext.NonCommercial;
         Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
+        _importer = new MiniExcelImporter();
     }
 
     [Benchmark(Description = "MiniExcel QueryFirst")]
     public void MiniExcel_QueryFirst_Test()
     {
-        _ = MiniExcel.Query(FilePath).First();
+        _ = _importer.QueryXlsx(FilePath).First();
     }
 
     [Benchmark(Description = "MiniExcel Query")]
     public void MiniExcel_Query()
     {
-        foreach (var _ in MiniExcel.Query(FilePath)) { }
+        foreach (var _ in _importer.QueryXlsx(FilePath)) { }
     }
 
     [Benchmark(Description = "ExcelDataReader QueryFirst")]

benchmarks/MiniExcel.Benchmarks/BenchmarkSections/TemplateXlsxBenchmark.cs

@@ -1,11 +1,19 @@
 using BenchmarkDotNet.Attributes;
 using ClosedXML.Report;
-using MiniExcelLibs.Benchmarks.Utils;
+using MiniExcelLib.Benchmarks.Utils;
 
-namespace MiniExcelLibs.Benchmarks.BenchmarkSections;
+namespace MiniExcelLib.Benchmarks.BenchmarkSections;
 
 public class TemplateXlsxBenchmark : BenchmarkBase
 {
+    private MiniExcelTemplater _templater;
+
+    [GlobalSetup]
+    public void Setup()
+    {
+        _templater = new MiniExcelTemplater();
+    }
+
     [Benchmark(Description = "MiniExcel Template Generate")]
     public void MiniExcel_Template_Generate_Test()
     {
@@ -22,7 +30,7 @@ public void MiniExcel_Template_Generate_Test()
                 })
         };
 
-        MiniExcel.SaveAsByTemplate(path.FilePath, templatePath, value);
+        _templater.ApplyXlsxTemplate(path.FilePath, templatePath, value);
     }
 
     [Benchmark(Description = "ClosedXml.Report Template Generate")]

benchmarks/MiniExcel.Benchmarks/BenchmarkSections/XlsxAsyncBenchmark.cs

@@ -1,17 +1,27 @@
 using BenchmarkDotNet.Attributes;
-using MiniExcelLibs.Benchmarks.Utils;
+using MiniExcelLib.Benchmarks.Utils;
 
-namespace MiniExcelLibs.Benchmarks.BenchmarkSections;
+namespace MiniExcelLib.Benchmarks.BenchmarkSections;
 
 public class XlsxAsyncBenchmark : BenchmarkBase
 {
+    private MiniExcelExporter _exporter;
+    private MiniExcelTemplater _templater;
+
+    [GlobalSetup]
+    public void Setup()
+    {
+        _exporter = new MiniExcelExporter();
+        _templater = new MiniExcelTemplater();
+    }
+
     [Benchmark(Description = "MiniExcel Create Xlsx Async")]
     public async Task MiniExcelCreateAsyncTest()
     {
         using var path = AutoDeletingPath.Create();
-        using var stream = File.Create(path.FilePath);
+        await using var stream = File.Create(path.FilePath);
 
-        await stream.SaveAsAsync(GetValue());
+        await _exporter.ExportXlsxAsync(stream, GetValue());
     }
 
     [Benchmark(Description = "MiniExcel Generate Template Async")]
@@ -30,6 +40,6 @@ public async Task MiniExcel_Template_Generate_Async_Test()
                 })
         };
 
-        await MiniExcel.SaveAsByTemplateAsync(path.FilePath, templatePath, value);
+        await _templater.ApplyXlsxTemplateAsync(path.FilePath, templatePath, value);
     }
 }

benchmarks/MiniExcel.Benchmarks/MiniExcel.Benchmarks.csproj

@@ -6,7 +6,7 @@
 		<Nullable>enable</Nullable>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<LangVersion>latest</LangVersion>
-		<RootNamespace>MiniExcelLibs.Benchmarks</RootNamespace>
+		<RootNamespace>MiniExcelLib.Benchmarks</RootNamespace>
 		<NoWarn>$(NoWarn);CA2000;CA2007</NoWarn>
 	</PropertyGroup>
 
@@ -35,7 +35,7 @@
 	</ItemGroup>
 
 	<ItemGroup>
-	  <ProjectReference Include="..\..\src\MiniExcel\MiniExcelLibs.csproj" />
+	  <ProjectReference Include="..\..\src\MiniExcel\MiniExcel.csproj" />
 	</ItemGroup>
 
 </Project>