Templater v6.0.0

API changes so CancellationToken can be passed into processing. Java API change to support try-with-resource pattern (close() instead of flush() method). Sync .NET and Java API (argument order changes in .NET - legacy API currently available with extension methods) Show how to use CancellationToken in the TemplaterServer by using timeout argument. Minimal Java version is now 8.
ngs-doo · Aug 3, 2021 · 9202b20 · 9202b20
1 parent 6709e6c
commit 9202b20
Show file tree

Hide file tree

Showing 207 changed files with 399 additions and 370 deletions.
diff --git a/Advanced/CsvStreaming/CsvStreaming.csproj b/Advanced/CsvStreaming/CsvStreaming.csproj
@@ -40,7 +40,7 @@
       <Private>True</Private>
     </Reference>
 	<Reference Include="NGS.Templater">
-      <HintPath>..\..\packages\Templater.5.2.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.6.0.0\lib\Net40\NGS.Templater.dll</HintPath>
       <SpecificVersion>False</SpecificVersion>
     </Reference>
     <Reference Include="System" />

diff --git a/Advanced/CsvStreaming/packages.config b/Advanced/CsvStreaming/packages.config
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="DotNetZip" version="1.13.0" targetFramework="net40-Client" />
-  <package id="Templater" version="5.2.0" targetFramework="net40-Client" />
+  <package id="Templater" version="6.0.0" targetFramework="net40-Client" />
 </packages>
diff --git a/Advanced/CsvStreaming/pom.xml b/Advanced/CsvStreaming/pom.xml
@@ -4,7 +4,7 @@
     <groupId>hr.ngs.templater.example</groupId>
     <artifactId>csv-streaming-example</artifactId>
     <packaging>jar</packaging>
-    <version>5.2.0</version>
+    <version>6.0.0</version>
     <name>CSV streaming</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

diff --git a/Advanced/CsvStreaming/src/Program.cs b/Advanced/CsvStreaming/src/Program.cs
@@ -107,7 +107,7 @@ public static void Main(string[] args)
 			using (var zip = new ZipOutputStream("output.zip"))
 			{
 				zip.PutNextEntry("output.csv");
-				using (var doc = config.Build().Open(File.OpenRead("template/input.csv"), zip, "csv"))
+				using (var doc = config.Build().Open(File.OpenRead("template/input.csv"), "csv", zip))
 				{
 					//streaming processing assumes we have only a single collection, which means we first need to process all other tags
 					doc.Process(new { filter = new { date = "All", user = "All" } });

diff --git a/Advanced/CsvStreaming/src/main/java/hr/ngs/templater/example/CsvStreamingExample.java b/Advanced/CsvStreaming/src/main/java/hr/ngs/templater/example/CsvStreamingExample.java
@@ -145,7 +145,7 @@ public static void main(final String[] args) throws Exception {
         }
         //remove remaining rows
         doc.templater().resize(doc.templater().tags(), 0);
-        doc.flush();
+        doc.close();
         conn.close();
         zos.closeEntry();
         zos.close();

diff --git a/Advanced/DepartmentReport/DepartmentReport.csproj b/Advanced/DepartmentReport/DepartmentReport.csproj
@@ -36,7 +36,7 @@
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="NGS.Templater">
-      <HintPath>..\..\packages\Templater.5.2.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.6.0.0\lib\Net40\NGS.Templater.dll</HintPath>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />

diff --git a/Advanced/DepartmentReport/packages.config b/Advanced/DepartmentReport/packages.config
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Templater" version="5.2.0" targetFramework="net40-Client" />
+  <package id="Templater" version="6.0.0" targetFramework="net40-Client" />
 </packages>
diff --git a/Advanced/DepartmentReport/pom.xml b/Advanced/DepartmentReport/pom.xml
@@ -4,7 +4,7 @@
     <groupId>hr.ngs.templater.example</groupId>
     <artifactId>department-report-example</artifactId>
     <packaging>jar</packaging>
-    <version>5.2.0</version>
+    <version>6.0.0</version>
     <name>DepartmentReportExample</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

diff --git a/Advanced/DepartmentReport/src/Program.cs b/Advanced/DepartmentReport/src/Program.cs
@@ -71,7 +71,7 @@ public static void Main(string[] args)
 				.NavigateSeparator(':')
 				.Include(SortExpression)
 				.Build()
-				.Open(fis, fos, "xlsx"))
+				.Open(fis, "xlsx", fos))
 				doc.Process(GetCompany());
 
 			Process.Start(new ProcessStartInfo("departments.xlsx") { UseShellExecute = true });

diff --git a/...nced/DepartmentReport/src/main/java/hr/ngs/templater/example/DepartmentReportExample.java b/...nced/DepartmentReport/src/main/java/hr/ngs/templater/example/DepartmentReportExample.java
@@ -98,7 +98,7 @@ public static void main(final String[] args) throws Exception {
                 .build()
                 .open(templateStream, "xlsx", fos);
         tpl.process(getCompany());
-        tpl.flush();
+        tpl.close();
         fos.close();
         Desktop.getDesktop().open(tmp);
     }

diff --git a/Advanced/DoubleProcessing/DoubleProcessing.csproj b/Advanced/DoubleProcessing/DoubleProcessing.csproj
@@ -37,7 +37,7 @@
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="NGS.Templater">
-      <HintPath>..\..\packages\Templater.5.2.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.6.0.0\lib\Net40\NGS.Templater.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System" />

diff --git a/Advanced/DoubleProcessing/packages.config b/Advanced/DoubleProcessing/packages.config
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Templater" version="5.2.0" targetFramework="net40-Client" />
+  <package id="Templater" version="6.0.0" targetFramework="net40-Client" />
 </packages>
diff --git a/Advanced/DoubleProcessing/pom.xml b/Advanced/DoubleProcessing/pom.xml
@@ -4,7 +4,7 @@
     <groupId>hr.ngs.templater.example</groupId>
     <artifactId>double-processing-example</artifactId>
     <packaging>jar</packaging>
-    <version>5.2.0</version>
+    <version>6.0.0</version>
     <name>DoubleProcessingExample</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

diff --git a/...nced/DoubleProcessing/src/main/java/hr/ngs/templater/example/DoubleProcessingExample.java b/...nced/DoubleProcessing/src/main/java/hr/ngs/templater/example/DoubleProcessingExample.java
@@ -53,7 +53,7 @@ public static void main(final String[] args) throws Exception {
                 doc1.templater().resize(new String[] { t }, 0);//hide column from output
             }
         }
-        doc1.flush();
+        doc1.close();
 
         //now let's prepare our complex object for standard processing
         Map<String, Object> complex = buildComplexObject(totalPeople);
@@ -64,7 +64,7 @@ public static void main(final String[] args) throws Exception {
         ITemplateDocument doc2 = factory.open(is, "xlsx", fos);
         doc2.process(complex);
         doc2.process(new HashMap<String, Object>() {{ put("starcraft", units); }});
-        doc2.flush();
+        doc2.close();
         fos.close();
 
         Desktop.getDesktop().open(tmp);

diff --git a/Advanced/PowerQuery/PowerQuery.csproj b/Advanced/PowerQuery/PowerQuery.csproj
@@ -36,7 +36,7 @@
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="NGS.Templater">
-      <HintPath>..\..\packages\Templater.5.2.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.6.0.0\lib\Net40\NGS.Templater.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System" />

diff --git a/Advanced/PowerQuery/packages.config b/Advanced/PowerQuery/packages.config
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Templater" version="5.2.0" targetFramework="net40-Client" />
+  <package id="Templater" version="6.0.0" targetFramework="net40-Client" />
 </packages>
diff --git a/Advanced/PowerQuery/pom.xml b/Advanced/PowerQuery/pom.xml
@@ -4,7 +4,7 @@
     <groupId>hr.ngs.templater.example</groupId>
     <artifactId>power-query-example</artifactId>
     <packaging>jar</packaging>
-    <version>5.2.0</version>
+    <version>6.0.0</version>
     <name>PowerQueryExample</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

diff --git a/Advanced/PowerQuery/src/Program.cs b/Advanced/PowerQuery/src/Program.cs
@@ -16,8 +16,8 @@ public class Program
 
 		private static object ToIsoFormat(object value, string tag, string[] metadata)
 		{
-			//only apply iso format on CSV part of the processing
-			if (!tag.StartsWith("csv.")) return value;
+			//only apply iso format on CSV part of the processing (StartsWith using Ordinal is significantly faster)
+			if (!tag.StartsWith("csv.", StringComparison.Ordinal)) return value;
 			if (value is DateTime)
 			{
 				var dt = (DateTime)value;
@@ -101,11 +101,11 @@ public static void Main(string[] args)
 		{
 			var data = new InputData();
 			data.csv = GenerateData(100000);
-			data.sheet = GenerateData(25000);
+			data.sheet = GenerateData(50000);
 
 			using (var fis = File.OpenRead("template/PowerQuery.xlsx"))
 			using (var fos = File.OpenWrite("PowerQuery.xlsx"))
-			using (var doc = Factory.Open(fis, fos, "xlsx"))
+			using (var doc = Factory.Open(fis, "xlsx", fos))
 				doc.Process(data);
 
 			Process.Start(new ProcessStartInfo("PowerQuery.xlsx") { UseShellExecute = true });

diff --git a/Advanced/PowerQuery/src/main/java/hr/ngs/templater/example/PowerQueryExample.java b/Advanced/PowerQuery/src/main/java/hr/ngs/templater/example/PowerQueryExample.java
@@ -16,22 +16,9 @@
 public class PowerQueryExample {
 
     private static IDocumentFactory factory = Configuration.builder()
-            .include(new LocalDateToDate())
             //Excel will complain about corrupted file unless Templater is initialized with a valid license
             .build("Customer email", "Customer license");
 
-    static class LocalDateToDate implements IDocumentFactoryBuilder.ILowLevelReplacer {
-
-        @Override
-        public Object replace(Object value, String tag, String[] metadata) {
-            //Templater does not understand java8 types so we can convert local date into legacy date
-            if (value instanceof LocalDate) {
-                return java.sql.Date.valueOf((LocalDate)value);
-            }
-            return value;
-        }
-    }
-
     //class should be public Templater to reduce the overhead of reflection access
     public static class CsvData {
         public LocalDate date;
@@ -113,14 +100,13 @@ private static File fixStreamingZip(File file) throws IOException {
     public static void main(final String[] args) throws Exception {
         File tmp = File.createTempFile("power", ".xlsx");
         InputData data = new InputData();
-        data.csv = generateData(100000);
-        data.sheet = generateData(25000);
+        data.csv = generateData(100_000);
+        data.sheet = generateData(50_000);
 
         try(InputStream is = PowerQueryExample.class.getResourceAsStream("/PowerQuery.xlsx");
-            OutputStream os = Files.newOutputStream(tmp.toPath())) {
-            ITemplateDocument tpl = factory.open(is, "xlsx", os);
+            OutputStream os = Files.newOutputStream(tmp.toPath());
+            ITemplateDocument tpl = factory.open(is, "xlsx", os)) {
             tpl.process(data);
-            tpl.flush();
         }
 
         File result = fixStreamingZip(tmp);

diff --git a/Advanced/SalesOrderMVP (.NET)/SalesOrderMVP.csproj b/Advanced/SalesOrderMVP (.NET)/SalesOrderMVP.csproj
@@ -48,7 +48,7 @@
       <Private>True</Private>
     </Reference>
     <Reference Include="NGS.Templater">
-      <HintPath>..\..\packages\Templater.5.2.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.6.0.0\lib\Net40\NGS.Templater.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System" />

diff --git a/Advanced/SalesOrderMVP (.NET)/packages.config b/Advanced/SalesOrderMVP (.NET)/packages.config
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Fluent.Ribbon" version="3.6.1.236" targetFramework="net40-Client" />
-  <package id="Templater" version="5.2.0" targetFramework="net40-Client" />
+  <package id="Templater" version="6.0.0" targetFramework="net40-Client" />
 </packages>
diff --git a/Advanced/SheetReport/SheetReport.csproj b/Advanced/SheetReport/SheetReport.csproj
@@ -40,7 +40,7 @@
       <Private>True</Private>
     </Reference>
     <Reference Include="NGS.Templater">
-      <HintPath>..\..\packages\Templater.5.2.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.6.0.0\lib\Net40\NGS.Templater.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System" />

diff --git a/Advanced/SheetReport/packages.config b/Advanced/SheetReport/packages.config
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="SharpZipLib" version="0.86.0" targetFramework="net40-Client" />
-  <package id="Templater" version="5.2.0" targetFramework="net40-Client" />
+  <package id="Templater" version="6.0.0" targetFramework="net40-Client" />
 </packages>
diff --git a/Advanced/SheetReport/pom.xml b/Advanced/SheetReport/pom.xml
@@ -4,7 +4,7 @@
     <groupId>hr.ngs.templater.example</groupId>
     <artifactId>sheet-report-example</artifactId>
     <packaging>jar</packaging>
-    <version>5.2.0</version>
+    <version>6.0.0</version>
     <name>SheetReportExample</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

diff --git a/Advanced/SheetReport/src/main/java/hr/ngs/templater/example/SheetReportExample.java b/Advanced/SheetReport/src/main/java/hr/ngs/templater/example/SheetReportExample.java
@@ -98,7 +98,7 @@ public static void main(final String[] args) throws Exception {
 
         tpl.process(data);
 
-        tpl.flush();
+        tpl.close();
         fos.close();
         Desktop.getDesktop().open(tmp);
     }

diff --git a/Advanced/TemplaterServer/Dockerfile b/Advanced/TemplaterServer/Dockerfile
@@ -1,8 +1,8 @@
-FROM ubuntu:18.10
+FROM ubuntu:20.04
 
 RUN apt update && apt install openjdk-11-jre-headless libreoffice-common libreoffice-java-common libreoffice-writer libreoffice-calc wget -yq
 
-RUN wget -q https://github.com/ngs-doo/TemplaterExamples/releases/download/v4.0.0/templater-server.jar
+RUN wget -q https://github.com/ngs-doo/TemplaterExamples/releases/download/v6.0.0/templater-server.jar
 
 COPY templater.lic .
 

diff --git a/Advanced/TemplaterServer/Readme.md b/Advanced/TemplaterServer/Readme.md
@@ -34,7 +34,7 @@ Once the docker has started, REST API can be consumed by calling:
 
 with body for the actual document. PDF document will be returned as the response.
 
-Alternatively [portable version of LibreOffice](https://www.libreoffice.org/download/portable-versions/) can be used instead of Docker.
+Alternatively, on Windows [portable version of LibreOffice](https://www.libreoffice.org/download/portable-versions/) can be used instead of Docker.
 
 ### REST server for other languages
 
@@ -46,6 +46,8 @@ The workflow for using the server is:
   * PUT /document?template=file.ext - using JSON for request body will process the previously saved template with provided JSON. To create PDF `Accept: application/pdf` can be used
   * DELETE /document?template=file.ext - will remove previously saved template document
 
+Templater supports cancellation pattern via token interface. This example uses timeout based implementation to limit the execution duration of the request.
+
 ### PDF conversion libraries for docx
 
 Several libraries/applications are available for PDF output:
@@ -117,7 +119,7 @@ While :collapse will remove tags, processor will still continue trying to replac
 #### Dynamic resize
 
 Dynamic resize works on Object[][] or List<List<Object>> types as long as dimensions are the same.
-In .NET special two dimensional type: Array[,] is also supported.
+In .NET special two-dimensional type: Array[,] is also supported.
 
 When combined with **merge-nulls** and **span-nulls** multiple cells can be combined into one.  
 
@@ -163,7 +165,6 @@ Tags can be combined with static/dynamic pictures in each row/page.
 Row context can span multiple rows/columns.
 Since context can be nested, this allows for very complex document layouts.
 Text based watermark is supported.
-Currently it requires usage of :all metadata, since watermark is repeated multiple times in different document parts.
 
 #### Scorecard
 

diff --git a/Advanced/TemplaterServer/TemplaterServer.csproj b/Advanced/TemplaterServer/TemplaterServer.csproj
@@ -24,7 +24,7 @@
     <PackageReference Include="Microsoft.AspNetCore.Http" Version="2.2.2" />
     <PackageReference Include="Microsoft.AspNetCore.Mvc" Version="2.2.0" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
-    <PackageReference Include="Templater" Version="5.2.0" />
+    <PackageReference Include="Templater" Version="6.0.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Advanced/TemplaterServer/pom.xml b/Advanced/TemplaterServer/pom.xml
@@ -4,7 +4,7 @@
     <groupId>hr.ngs.templater.example</groupId>
     <artifactId>templater-server</artifactId>
     <packaging>jar</packaging>
-    <version>5.2.0</version>
+    <version>6.0.0</version>
     <name>TemplaterServer</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 
@@ -20,7 +20,7 @@
         <repository>
             <id>AsposeJavaAPI</id>
             <name>Aspose Java API</name>
-            <url>http://repository.aspose.com/repo</url>
+            <url>https://artifact.aspose.com/repo/</url>
         </repository>
     </repositories>
     <dependencies>
@@ -37,13 +37,13 @@
         <dependency>
             <groupId>e-iceblue</groupId>
             <artifactId>spire.doc.free</artifactId>
-            <version>2.7.3</version>
+            <version>3.9.0</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>com.aspose</groupId>
             <artifactId>aspose-words</artifactId>
-            <version>19.12</version>
+            <version>21.7</version>
             <classifier>jdk17</classifier>
             <scope>compile</scope>
         </dependency>

diff --git a/Advanced/TemplaterServer/src/SharedResource.cs b/Advanced/TemplaterServer/src/SharedResource.cs
@@ -13,6 +13,7 @@ public class SharedResource
 		internal readonly string[] TemplateFiles;
 		internal readonly string TemplateHtml;
 		internal readonly string DefaultHtml;
+		internal readonly int Timeout = 30;
 		internal readonly Dictionary<string, string> Jsons;
 		internal readonly Dictionary<string, PdfConverter> PdfConverters = new Dictionary<string, PdfConverter>();
 
@@ -25,6 +26,8 @@ public SharedResource(string[] args)
 			{
 				if (a.StartsWith("pdf="))
 					pdf = a.Substring("pdf=".Length).Split(',');
+				else if (a.StartsWith("timeout="))
+					Timeout = int.Parse(a.Substring("timeout=".Length));
 			}
 
 			foreach (var t in types)