Templater v5.0.0

Add navigation plugin example on various places (Limits and WordTables) Remove usage of .NET 3.5 as it is no longer supported Show example of sorting plugin in DepartmentReport Usage of content control and removal in Paragraphs
ngs-doo · Oct 22, 2020 · e413300 · e413300
1 parent 287d87d
commit e413300
Show file tree

Hide file tree

Showing 177 changed files with 764 additions and 455 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.4.6.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.5.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="4.6.0" targetFramework="net40-Client" />
+  <package id="Templater" version="5.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>4.6.0</version>
+    <version>5.0.0</version>
     <name>CSV streaming</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

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.4.6.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.5.0.0\lib\Net40\NGS.Templater.dll</HintPath>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />

diff --git a/Advanced/DepartmentReport/Readme.md b/Advanced/DepartmentReport/Readme.md
@@ -41,4 +41,18 @@ If data sheet was hidden and Summary was the first sheet report would be even ea
 ### Anonymous classes
 
 Templater can work with IEnumerable or Collection data sources in which case it will extract the signature from the provided data.
-This way anonymous objects can be used for easier development via C# LINQ or Java Streams
+This way anonymous objects can be used for easier development via C# LINQ or Java Streams
+
+
+### Navigation plugin
+
+This template has alias defined for `department.team.project:sort(name)` as `project`
+Since v5 there is a natural way to deal with data manipulation during navigation via navigation plugin.
+Navigation plugin can provide alternative object for further processing.
+This can be used for various purposes:
+
+ * returning same collection somewhat changed (limiting, sorting, filtering, ...)
+ * returning totally different object/collection
+ * calling methods with arguments (unlike only being able to use zero method navigation)
+ * various other complex logic
+
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="4.6.0" targetFramework="net40-Client" />
+  <package id="Templater" version="5.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>4.6.0</version>
+    <version>5.0.0</version>
     <name>DepartmentReportExample</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

diff --git a/Advanced/DepartmentReport/result.xlsx b/Advanced/DepartmentReport/result.xlsx
diff --git a/Advanced/DepartmentReport/src/Program.cs b/Advanced/DepartmentReport/src/Program.cs
@@ -66,12 +66,26 @@ public static void Main(string[] args)
 		{
 			using (var fis = File.OpenRead("template/departments.xlsx"))
 			using (var fos = File.OpenWrite("departments.xlsx"))
-			using (var doc = Configuration.Factory.Open(fis, fos, "xlsx"))
+			using (var doc = Configuration
+				.Builder
+				.NavigateSeparator(':')
+				.Include(SortExpression)
+				.Build()
+				.Open(fis, fos, "xlsx"))
 				doc.Process(GetCompany());
 
 			Process.Start(new ProcessStartInfo("departments.xlsx") { UseShellExecute = true });
 		}
 
+		static object SortExpression(object parent, object value, string member, string metadata)
+		{
+			var col = value as ICollection;
+			if (!metadata.StartsWith("sort(") || col == null || col.Count < 2) return value;
+			var property = metadata.Substring(5, metadata.Length - 6);
+			var f = col.OfType<object>().First().GetType().GetField(property);
+			return col.OfType<object>().OrderBy(it => f.GetValue(it)).ToList();
+		}
+
 		private static Company GetCompany()
 		{
 			var company = new Company

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
@@ -1,10 +1,12 @@
 package hr.ngs.templater.example;
 
 import hr.ngs.templater.Configuration;
+import hr.ngs.templater.IDocumentFactoryBuilder;
 import hr.ngs.templater.ITemplateDocument;
 
 import java.awt.Desktop;
 import java.io.*;
+import java.lang.reflect.Field;
 import java.util.*;
 import java.util.stream.Collectors;
 
@@ -89,13 +91,50 @@ public static void main(final String[] args) throws Exception {
         File tmp = File.createTempFile("department", ".xlsx");
 
         FileOutputStream fos = new FileOutputStream(tmp);
-        ITemplateDocument tpl = Configuration.factory().open(templateStream, "xlsx", fos);
+        ITemplateDocument tpl = Configuration
+                .builder()
+                .navigateSeparator(':')
+                .include(new SortExpression())
+                .build()
+                .open(templateStream, "xlsx", fos);
         tpl.process(getCompany());
         tpl.flush();
         fos.close();
         Desktop.getDesktop().open(tmp);
     }
 
+    //this is just a simplistic implementation
+    //a better implementation would take care of methods, dictionaries and various other types
+    static class SortExpression implements IDocumentFactoryBuilder.INavigate {
+        @Override
+        public Object navigate(Object parent, Object value, String member, String metadata) {
+            if (!metadata.startsWith("sort(") || value instanceof Object[] == false) return value;
+            Object[] elements = (Object[])value;
+            if (elements.length < 2 || elements[0] == null) return value;
+            String property = metadata.substring(5, metadata.length() - 1);
+            Field f;
+            try {
+                f = elements[0].getClass().getField(property);
+            } catch (NoSuchFieldException e) {
+                throw new RuntimeException(e);
+            }
+            //just a simplistic implementation
+            //it doesn't check for primitives and non Comparable objects
+            Comparator propertyComparator = (left, right) -> {
+                try {
+                    Comparable lv = (Comparable)f.get(left);
+                    Comparable rv = (Comparable)f.get(right);
+                    return lv.compareTo(rv);
+                } catch (IllegalAccessException e) {
+                    throw new RuntimeException(e);
+                }
+            };
+            Arrays.sort(elements, propertyComparator);
+
+            return value;
+        }
+    }
+
     private static Company getCompany() {
         Company company = new Company();
         company.name = "Sweat shop ltd.";

diff --git a/Advanced/DepartmentReport/template/departments.xlsx b/Advanced/DepartmentReport/template/departments.xlsx
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.4.6.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.5.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="4.6.0" targetFramework="net40-Client" />
+  <package id="Templater" version="5.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>4.6.0</version>
+    <version>5.0.0</version>
     <name>DoubleProcessingExample</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

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.4.6.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.5.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="4.6.0" targetFramework="net40-Client" />
+  <package id="Templater" version="5.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>4.6.0</version>
+    <version>5.0.0</version>
     <name>PowerQueryExample</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

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.4.6.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.5.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="4.6.0" targetFramework="net40-Client" />
+  <package id="Templater" version="5.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.4.6.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.5.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="4.6.0" targetFramework="net40-Client" />
+  <package id="Templater" version="5.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>4.6.0</version>
+    <version>5.0.0</version>
     <name>SheetReportExample</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

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="4.6.0" />
+    <PackageReference Include="Templater" Version="5.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>4.6.0</version>
+    <version>5.0.0</version>
     <name>TemplaterServer</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>
 

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

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

diff --git a/Beginner/AndroidExample/app/build.gradle b/Beginner/AndroidExample/app/build.gradle
@@ -38,7 +38,7 @@ dependencies {
     implementation 'com.android.support:appcompat-v7:28.0.0'
     implementation 'com.android.support.constraint:constraint-layout:1.1.3'
     implementation 'com.android.support:design:28.0.0'
-    implementation 'hr.ngs.templater:templater:4.3.0'
+    implementation 'hr.ngs.templater:templater:5.0.0'
     implementation 'xalan:xalan:2.7.2'
     implementation 'xerces:xercesImpl:2.12.0'
     testImplementation 'junit:junit:4.12'

diff --git a/Beginner/BeerList (Scala)/build.sbt b/Beginner/BeerList (Scala)/build.sbt
@@ -3,4 +3,4 @@ version := "1.0.0-SNAPSHOT"
 organization := "hr.ngs.templater.example"
 scalaVersion := "2.11.12"
 
-libraryDependencies += "hr.ngs.templater" %% "templater" % "4.6.0"
+libraryDependencies += "hr.ngs.templater" %% "templater" % "5.0.0"
diff --git a/Beginner/CsvExample/CsvExample.csproj b/Beginner/CsvExample/CsvExample.csproj
@@ -36,7 +36,7 @@
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="NGS.Templater">
-      <HintPath>..\..\packages\Templater.4.6.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.5.0.0\lib\Net40\NGS.Templater.dll</HintPath>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />

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

diff --git a/Beginner/DataSet (.NET)/DataSetExample.csproj b/Beginner/DataSet (.NET)/DataSetExample.csproj
@@ -37,7 +37,7 @@
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="NGS.Templater">
-      <HintPath>..\..\packages\Templater.4.6.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.5.0.0\lib\Net40\NGS.Templater.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System" />

diff --git a/Beginner/DataSet (.NET)/packages.config b/Beginner/DataSet (.NET)/packages.config
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Templater" version="4.6.0" targetFramework="net40-Client" />
+  <package id="Templater" version="5.0.0" targetFramework="net40-Client" />
 </packages>
diff --git a/Beginner/DynamicResize/DynamicResize.csproj b/Beginner/DynamicResize/DynamicResize.csproj
@@ -36,7 +36,7 @@
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="NGS.Templater">
-      <HintPath>..\..\packages\Templater.4.6.0\lib\Net40\NGS.Templater.dll</HintPath>
+      <HintPath>..\..\packages\Templater.5.0.0\lib\Net40\NGS.Templater.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System" />

diff --git a/Beginner/DynamicResize/packages.config b/Beginner/DynamicResize/packages.config
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Templater" version="4.6.0" targetFramework="net40-Client" />
+  <package id="Templater" version="5.0.0" targetFramework="net40-Client" />
 </packages>
diff --git a/Beginner/DynamicResize/pom.xml b/Beginner/DynamicResize/pom.xml
@@ -4,7 +4,7 @@
     <groupId>hr.ngs.templater.example</groupId>
     <artifactId>dynamic-resize</artifactId>
     <packaging>jar</packaging>
-    <version>4.6.0</version>
+    <version>5.0.0</version>
     <name>DynamicResize</name>
     <url>https://github.com/ngs-doo/TemplaterExamples</url>