FREEMARKER-153 FreeMarker Generator release preparations (#21)
diff --git a/.travis.yml b/.travis.yml
index b3680d5..ab9907e 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -6,9 +6,10 @@
- openjdk11
- openjdk12
- openjdk13
+ - openjdk14
script:
- mvn clean install
- - cd ./freemarker-generator-cli
+ - cd ./freemarker-generator-cli/target/appassembler/
- sh ./run-examples.sh
- - cd ../freemarker-generator-maven-plugin-sample
+ - cd ../../../freemarker-generator-maven-plugin-sample
- mvn clean package
\ No newline at end of file
diff --git a/README.md b/README.md
index d0c6e3d..f104070 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@
Currently it can be invoked as a
-* Command-line interface `freemarker-generator-cli`
+* Command-line interface `freemarker-generator`
* Maven plug-in `freemarker-generator-maven-plugin`
Building Apache FreeMarker Generator
diff --git a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/FreeMarkerConstants.java b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/FreeMarkerConstants.java
index 239c80e..86a69ab 100644
--- a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/FreeMarkerConstants.java
+++ b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/FreeMarkerConstants.java
@@ -47,13 +47,19 @@
private Configuration() {
}
- /** Prefix to extract tools from 'freemarker-cli.properties' */
+ // The default config file for freemarker generator
+ public static final String CONFIG_FILE_NAME = "config/freemarker-generator.properties";
+
+ /** The user's optional ".freemarker-generator" directory in the user's home directory */
+ public static final String USER_CONFIGURATION_DIR_NAME = ".freemarker-generator";
+
+ /** Prefix to extract tools from 'freemarker-generator.properties' */
public static final String TOOLS_PREFIX = "freemarker.tools.";
- /** Key for reading the configured locale from 'freemarker-cli.properties' */
+ /** Key for reading the configured locale from 'freemarker-generator.properties' */
public static final String LOCALE_KEY = "freemarker.configuration.setting.locale";
- /** Prefix to extract FreeMarker configuration settings from 'freemarker-cli.properties' */
+ /** Prefix to extract FreeMarker configuration settings from 'freemarker-generator.properties' */
public static final String SETTING_PREFIX = "freemarker.configuration.setting.";
}
@@ -69,7 +75,6 @@
public static final String STDIN = "stdin";
public static final String SYSTEM = "system";
public static final String STRING = "string";
- public static final String URL = "url";
}
public static class Model {
@@ -87,4 +92,16 @@
public static final String FREEMARKER_USER_SYSTEM_PROPERTIES = "freemarker.user.system.properties";
public static final String FREEMARKER_USER_PARAMETERS = "freemarker.user.parameters";
}
+
+ public static class SystemProperties {
+
+ private SystemProperties() {
+ }
+
+ /** Installation directory of "freemarker-generator" when invoked with shell wrapper */
+ public static final String APP_HOME = "app.home";
+
+ /** Home directory of the user */
+ public static final String USER_HOME = "user.home";
+ }
}
diff --git a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/template/TemplateTransformationsBuilder.java b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/template/TemplateTransformationsBuilder.java
index c738670..bdef609 100644
--- a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/template/TemplateTransformationsBuilder.java
+++ b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/template/TemplateTransformationsBuilder.java
@@ -16,6 +16,7 @@
*/
package org.apache.freemarker.generator.base.template;
+import org.apache.freemarker.generator.base.FreeMarkerConstants.Location;
import org.apache.freemarker.generator.base.file.RecursiveFileSupplier;
import org.apache.freemarker.generator.base.util.NonClosableWriterWrapper;
import org.apache.freemarker.generator.base.util.StringUtils;
@@ -217,7 +218,7 @@
}
private List<TemplateTransformation> resolveTemplateCode(String source, File out) {
- final TemplateSource templateSource = TemplateSource.fromCode("interactive", source);
+ final TemplateSource templateSource = TemplateSource.fromCode(Location.INTERACTIVE, source);
final TemplateOutput templateOutput = templateOutput(out);
return singletonList(new TemplateTransformation(templateSource, templateOutput));
}
diff --git a/freemarker-generator-base/src/site/markdown/index.md b/freemarker-generator-base/src/site/markdown/index.md
index 212345d..0980fe0 100644
--- a/freemarker-generator-base/src/site/markdown/index.md
+++ b/freemarker-generator-base/src/site/markdown/index.md
@@ -1,3 +1,3 @@
-# Apache FreeMarker CLI Base
+# Apache FreeMarker Generator Base
This package contains infrastructure code not depending on `Apache FreeMarker` directly since `DataSources` and their creation might be useful for un-related command-line tools.
diff --git a/freemarker-generator-base/src/test/java/org/apache/freemarker/generator/template/TemplateTransformationsBuilderTest.java b/freemarker-generator-base/src/test/java/org/apache/freemarker/generator/template/TemplateTransformationsBuilderTest.java
index 3cc0545..0c082a0 100644
--- a/freemarker-generator-base/src/test/java/org/apache/freemarker/generator/template/TemplateTransformationsBuilderTest.java
+++ b/freemarker-generator-base/src/test/java/org/apache/freemarker/generator/template/TemplateTransformationsBuilderTest.java
@@ -16,6 +16,7 @@
*/
package org.apache.freemarker.generator.template;
+import org.apache.freemarker.generator.base.FreeMarkerConstants.Location;
import org.apache.freemarker.generator.base.template.TemplateOutput;
import org.apache.freemarker.generator.base.template.TemplateSource;
import org.apache.freemarker.generator.base.template.TemplateSource.Origin;
@@ -42,7 +43,7 @@
@Test
public void shouldCreateFromInteractiveTemplate() {
final TemplateTransformations transformations = builder()
- .setTemplate("interactive", "Hello World")
+ .setTemplate(Location.INTERACTIVE, "Hello World")
.setStdOut()
.build();
@@ -51,7 +52,7 @@
final TemplateSource templateSource = transformations.get(0).getTemplateSource();
final TemplateOutput templateOutput = transformations.get(0).getTemplateOutput();
- assertEquals("interactive", templateSource.getName());
+ assertEquals(Location.INTERACTIVE, templateSource.getName());
assertEquals(Origin.CODE, templateSource.getOrigin());
assertEquals("Hello World", templateSource.getCode());
assertNull(templateSource.getPath());
@@ -64,7 +65,7 @@
@Test(expected = IllegalArgumentException.class)
public void shouldThrowIllegalArgumentExceptionWheMixingInteractiveTemplateWithSources() {
builder()
- .setTemplate("interactive", "Hello World")
+ .setTemplate(Location.INTERACTIVE, "Hello World")
.addSource(ANY_TEMPLATE_FILE_NAME)
.setStdOut()
.build();
diff --git a/freemarker-generator-cli/CHANGELOG.md b/freemarker-generator-cli/CHANGELOG.md
index e0165ed..6fca548 100644
--- a/freemarker-generator-cli/CHANGELOG.md
+++ b/freemarker-generator-cli/CHANGELOG.md
@@ -17,6 +17,9 @@
* [FREEMARKER-129] Migrate `freemarker-cli` into `freemarker-generator` project (see [https://github.com/sgoeschl/freemarker-cli](https://github.com/sgoeschl/freemarker-cli))
### Changed
+* [FREEMARKER-153] Packaged templates are now prefixed with `freemarker-generator`, e.g. `freemarker-generator/info.ftl`
+* [FREEMARKER-153] Renamed `--basedir` command line option to `--template-dir`
+* [FREEMARKER-153] Renamed `freemarker-cli` to `freemarker-generator`
* Removing `DataSources.first` and use `dataSources.get(0)` instead
* [FREEMARKER-146] Cleanly separate example templates and data from user-supplied content
* `DataSource` use `uri` instead of `location`
@@ -27,11 +30,15 @@
* [FREEMARKER-129] Provide a `toString()` method for all tools
* [FREEMARKER-129] Use version "0.X.Y" to cater for API changes according to [Semantic Versioning](https://semver.org)
-### Fixed
+### Fixed
+* [FREEMARKER-153] Configuration files are bootstrapped from "app.home" system property
* [FREEMARKER-151] Ensure that build and and examples are running on Windows
* [FREEMARKER-147] Complete Maven site documentation
* [FREEMARKER-127] Site build fails with missing "org/apache/maven/doxia/siterenderer/DocumentContent"
+### Internal
+* [FREEMARKER-153] FreeMarker Generator release preparations
+
[FREEMARKER-127]: https://issues.apache.org/jira/browse/FREEMARKER-127
[FREEMARKER-128]: https://issues.apache.org/jira/browse/FREEMARKER-128
[FREEMARKER-129]: https://issues.apache.org/jira/browse/FREEMARKER-129
@@ -46,4 +53,5 @@
[FREEMARKER-147]: https://issues.apache.org/jira/browse/FREEMARKER-147
[FREEMARKER-148]: https://issues.apache.org/jira/browse/FREEMARKER-148
[FREEMARKER-149]: https://issues.apache.org/jira/browse/FREEMARKER-149
-[FREEMARKER-151]: https://issues.apache.org/jira/browse/FREEMARKER-151
\ No newline at end of file
+[FREEMARKER-151]: https://issues.apache.org/jira/browse/FREEMARKER-151
+[FREEMARKER-153]: https://issues.apache.org/jira/browse/FREEMARKER-151
\ No newline at end of file
diff --git a/freemarker-generator-cli/LICENSE b/freemarker-generator-cli/LICENSE
index 1121eba..caca01c 100644
--- a/freemarker-generator-cli/LICENSE
+++ b/freemarker-generator-cli/LICENSE
@@ -201,23 +201,182 @@
See the License for the specific language governing permissions and
limitations under the License.
-=========================================================================
+==============================================================================
-The source code contains the following binaries,
-which were created at the Apache FreeMarker project, and hence are
-covered by the same license as the other source files of it:
+Binary distributions of this product bundles picocli which
+is available under The Apache Software License version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
- src/main/misc/overloadedNumberRules/prices.ods
- src/manual/en_US/docgen-originals/figures/overview.odg
- src/manual/en_US/docgen-originals/figures/model2sketch_with_alpha.png
- src/manual/en_US/docgen-originals/figures/tree_with_alpha.png
- src/manual/en_US/favicon.png
- src/manual/en_US/figures/model2sketch.png
- src/manual/en_US/figures/overview.png
- src/manual/en_US/figures/tree.png
- src/manual/en_US/logo.png
- src/manual/zh_CN/favicon.png
- src/manual/zh_CN/figures/model2sketch.png
- src/manual/zh_CN/figures/overview.png
- src/manual/zh_CN/figures/tree.png
- src/manual/zh_CN/logo.png
+==============================================================================
+
+Binary distributions of this product bundles freemarker-generator-tools which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles slf4j-api which
+is available under MIT License.
+See licences/LICENCE_MIT.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles slf4j-nop which
+is available under MIT License.
+See licences/LICENCE_MIT.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles curvesapi which
+is available under BSD License.
+See licences/LICENCE_curvesapi.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles gson which
+is available under Apache 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles json-path which
+is available under The Apache Software License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles commons-codec which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles commons-io which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles dataframe which
+is available under MIT License.
+See licences/LICENCE_MIT.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles java-grok which
+is available under The Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles activation which
+is available under COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0.
+See licences/LICENCE_CDDL-1.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles accessors-smart which
+is available under The Apache Software License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles json-smart which
+is available under The Apache Software License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles antlr4-runtime which
+is available under The BSD License.
+See licences/LICENCE_antlr4-runtime.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles commons-collections4 which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles commons-compress which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles commons-csv which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles commons-exec which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles commons-lang3 which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles commons-math3 which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles freemarker-generator-base which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles poi which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles poi-ooxml which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles poi-ooxml-schemas which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles xmlbeans which
+is available under The Apache Software License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles freemarker which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles jsoup which
+is available under The MIT License.
+See licences/LICENCE_MIT.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles asm which
+is available under BSD.
+See licences/LICENCE_asm.txt for more information ...
+
+==============================================================================
+
+Binary distributions of this product bundles snakeyaml which
+is available under Apache License Version 2.0.
+See licencens/LICENSE_ASL-2.0.txt for more information ...
diff --git a/freemarker-generator-cli/README.md b/freemarker-generator-cli/README.md
index acfcc67..373b9e4 100644
--- a/freemarker-generator-cli/README.md
+++ b/freemarker-generator-cli/README.md
@@ -4,58 +4,61 @@
This module provides provides the CLI for `Apache FreeMarker`.
* Requires JDK 1.8+ on Linux, Mac OSX and Windows
-* Add the bin/freemarker-cli or bin/freemarker-cli.bat to your PATH variable
+* Add the bin/freemarker-generator or bin/freemarker-generator.bat to your PATH variable
Now you can have a look at the command line options
```text
-freemarker-cli -h
-Usage: freemarker-cli (-t=<templates> [-t=<templates>]... |
- -i=<interactiveTemplate>) [-hV] [--stdin] [-b=<baseDir>]
- [--config=<configFile>]
- [--data-source-exclude=<dataSourceExcludePattern>]
- [--data-source-include=<dataSourceIncludePattern>]
- [-e=<inputEncoding>] [-l=<locale>]
- [--output-encoding=<outputEncoding>] [--times=<times>]
- [-D=<String=String>]... [-m=<dataModels>]...
- [-o=<outputs>]... [-P=<String=String>]...
- [-s=<dataSources>]... [<sources>...]
-Apache FreeMarker CLI
- [<sources>...] data source files and/or directories
- -b, --basedir=<baseDir> additional template base directory
- --config=<configFile> FreeMarker CLI configuration file
- -D, --system-property=<String=String>
+freemarker-generator -h
+UUsage: freemarker-generator (-t=<templates> [-t=<templates>]... |
+ -i=<interactiveTemplate>) [-hV] [--stdin]
+ [--config=<configFile>]
+ [--data-source-exclude=<dataSourceExcludePattern>]
+ [--data-source-include=<dataSourceIncludePattern>]
+ [-e=<inputEncoding>] [-l=<locale>]
+ [--output-encoding=<outputEncoding>]
+ [--template-dir=<templateDir>] [--times=<times>]
+ [-D=<String=String>]... [-m=<dataModels>]...
+ [-o=<outputs>]... [-P=<String=String>]...
+ [-s=<dataSources>]... [<sources>...]
+ Apache FreeMarker Generator
+ [<sources>...] data source files and/or directories
+ --config=<configFile>
+ FreeMarker Generator configuration file
+ -D, --system-property=<String=String>
set system property
- --data-source-exclude=<dataSourceExcludePattern>
+ --data-source-exclude=<dataSourceExcludePattern>
file exclude pattern for data sources
- --data-source-include=<dataSourceIncludePattern>
+ --data-source-include=<dataSourceIncludePattern>
file include pattern for data sources
- -e, --input-encoding=<inputEncoding>
+ -e, --input-encoding=<inputEncoding>
encoding of data source
- -h, --help Show this help message and exit.
- -i, --interactive=<interactiveTemplate>
+ -h, --help Show this help message and exit.
+ -i, --interactive=<interactiveTemplate>
interactive template to process
- -l, --locale=<locale> locale being used for the output, e.g. 'en_US'
- -m, --data-model=<dataModels>
+ -l, --locale=<locale> locale being used for the output, e.g. 'en_US'
+ -m, --data-model=<dataModels>
data model used for rendering
- -o, --output=<outputs> output files or directories
- --output-encoding=<outputEncoding>
+ -o, --output=<outputs> output files or directories
+ --output-encoding=<outputEncoding>
encoding of output, e.g. UTF-8
- -P, --param=<String=String>
+ -P, --param=<String=String>
set parameter
- -s, --data-source=<dataSources>
+ -s, --data-source=<dataSources>
data source used for rendering
- --stdin read data source from stdin
- -t, --template=<templates>
+ --stdin read data source from stdin
+ -t, --template=<templates>
templates to process
- --times=<times> re-run X times for profiling
- -V, --version Print version information and exit.
+ --template-dir=<templateDir>
+ additional template directory
+ --times=<times> re-run X times for profiling
+ -V, --version Print version information and exit.
```
-Check the version of the `Apache FreeMarker CLI`
+Check the version of the `Apache FreeMarker Generator`
```text
-freemarker-cli -V
+freemarker-generator -V
version=0.1.0-SNAPSHOT, time=2020-06-25T21:48:02+0200, commit=b320d00094be8789086ad6153d9d3fcaf4b8c75f
```
diff --git a/freemarker-generator-cli/pom.xml b/freemarker-generator-cli/pom.xml
index ff7c4b0..da3494b 100644
--- a/freemarker-generator-cli/pom.xml
+++ b/freemarker-generator-cli/pom.xml
@@ -49,7 +49,6 @@
<extraJvmArguments>-Xms64m -Xmx512m</extraJvmArguments>
<endorsedDir>endorsed</endorsedDir>
<useWildcardClassPath>true</useWildcardClassPath>
- <copyConfigurationDirectory>true</copyConfigurationDirectory>
<configurationDirectory>config</configurationDirectory>
<programs>
<program>
@@ -58,7 +57,7 @@
<platform>unix</platform>
</platforms>
<mainClass>org.apache.freemarker.generator.cli.Main</mainClass>
- <id>freemarker-cli</id>
+ <id>freemarker-generator</id>
</program>
</programs>
</configuration>
@@ -75,13 +74,16 @@
<copy file="README.md" todir="./target/appassembler" />
<copy file="LICENSE" todir="./target/appassembler" />
<copy file="NOTICE" todir="./target/appassembler" />
- <copy file="./src/main/scripts/run-examples.bat" todir="./target/appassembler" />
- <copy file="./src/main/scripts/run-examples.sh" todir="./target/appassembler" />
+ <copy file="./src/app/scripts/run-examples.bat" todir="./target/appassembler" />
+ <copy file="./src/app/scripts/run-examples.sh" todir="./target/appassembler" />
+ <copy todir="./target/appassembler/config">
+ <fileset dir="src/app/config" />
+ </copy>
<copy todir="./target/appassembler/templates">
- <fileset dir="templates" />
+ <fileset dir="src/app/templates" />
</copy>
<copy todir="./target/appassembler/examples">
- <fileset dir="examples" />
+ <fileset dir="src/app/examples" />
</copy>
<chmod file="./target/appassembler/run-examples.sh" perm="a+x" />
</target>
diff --git a/freemarker-generator-cli/src/main/config/freemarker-cli.properties b/freemarker-generator-cli/src/app/config/freemarker-generator.properties
similarity index 100%
rename from freemarker-generator-cli/src/main/config/freemarker-cli.properties
rename to freemarker-generator-cli/src/app/config/freemarker-generator.properties
diff --git a/freemarker-generator-cli/examples/data/accesslog/combined-access.log b/freemarker-generator-cli/src/app/examples/data/accesslog/combined-access.log
similarity index 100%
rename from freemarker-generator-cli/examples/data/accesslog/combined-access.log
rename to freemarker-generator-cli/src/app/examples/data/accesslog/combined-access.log
diff --git a/freemarker-generator-cli/examples/data/csv/contract.csv b/freemarker-generator-cli/src/app/examples/data/csv/contract.csv
similarity index 100%
rename from freemarker-generator-cli/examples/data/csv/contract.csv
rename to freemarker-generator-cli/src/app/examples/data/csv/contract.csv
diff --git a/freemarker-generator-cli/examples/data/csv/dataframe.csv b/freemarker-generator-cli/src/app/examples/data/csv/dataframe.csv
similarity index 100%
rename from freemarker-generator-cli/examples/data/csv/dataframe.csv
rename to freemarker-generator-cli/src/app/examples/data/csv/dataframe.csv
diff --git a/freemarker-generator-cli/examples/data/csv/excel-export-utf8.csv b/freemarker-generator-cli/src/app/examples/data/csv/excel-export-utf8.csv
similarity index 100%
rename from freemarker-generator-cli/examples/data/csv/excel-export-utf8.csv
rename to freemarker-generator-cli/src/app/examples/data/csv/excel-export-utf8.csv
diff --git a/freemarker-generator-cli/examples/data/csv/locker-test-users.csv b/freemarker-generator-cli/src/app/examples/data/csv/locker-test-users.csv
similarity index 100%
rename from freemarker-generator-cli/examples/data/csv/locker-test-users.csv
rename to freemarker-generator-cli/src/app/examples/data/csv/locker-test-users.csv
diff --git a/freemarker-generator-cli/examples/data/csv/sales-records.csv b/freemarker-generator-cli/src/app/examples/data/csv/sales-records.csv
similarity index 100%
rename from freemarker-generator-cli/examples/data/csv/sales-records.csv
rename to freemarker-generator-cli/src/app/examples/data/csv/sales-records.csv
diff --git a/freemarker-generator-cli/examples/data/csv/transactions.csv b/freemarker-generator-cli/src/app/examples/data/csv/transactions.csv
similarity index 100%
rename from freemarker-generator-cli/examples/data/csv/transactions.csv
rename to freemarker-generator-cli/src/app/examples/data/csv/transactions.csv
diff --git a/freemarker-generator-cli/examples/data/csv/user.csv b/freemarker-generator-cli/src/app/examples/data/csv/user.csv
similarity index 100%
rename from freemarker-generator-cli/examples/data/csv/user.csv
rename to freemarker-generator-cli/src/app/examples/data/csv/user.csv
diff --git a/freemarker-generator-cli/examples/data/excel/test-multiple-sheets.xlsx b/freemarker-generator-cli/src/app/examples/data/excel/test-multiple-sheets.xlsx
similarity index 100%
rename from freemarker-generator-cli/examples/data/excel/test-multiple-sheets.xlsx
rename to freemarker-generator-cli/src/app/examples/data/excel/test-multiple-sheets.xlsx
Binary files differ
diff --git a/freemarker-generator-cli/examples/data/excel/test.xls b/freemarker-generator-cli/src/app/examples/data/excel/test.xls
similarity index 100%
rename from freemarker-generator-cli/examples/data/excel/test.xls
rename to freemarker-generator-cli/src/app/examples/data/excel/test.xls
Binary files differ
diff --git a/freemarker-generator-cli/examples/data/excel/test.xlsx b/freemarker-generator-cli/src/app/examples/data/excel/test.xlsx
similarity index 100%
rename from freemarker-generator-cli/examples/data/excel/test.xlsx
rename to freemarker-generator-cli/src/app/examples/data/excel/test.xlsx
Binary files differ
diff --git a/freemarker-generator-cli/examples/data/ftl/nginx/nginx.conf.ftl b/freemarker-generator-cli/src/app/examples/data/ftl/nginx/nginx.conf.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/data/ftl/nginx/nginx.conf.ftl
rename to freemarker-generator-cli/src/app/examples/data/ftl/nginx/nginx.conf.ftl
diff --git a/freemarker-generator-cli/examples/data/ftl/nginx/nginx.env b/freemarker-generator-cli/src/app/examples/data/ftl/nginx/nginx.env
similarity index 100%
rename from freemarker-generator-cli/examples/data/ftl/nginx/nginx.env
rename to freemarker-generator-cli/src/app/examples/data/ftl/nginx/nginx.env
diff --git a/freemarker-generator-cli/examples/data/html/dependencies.html b/freemarker-generator-cli/src/app/examples/data/html/dependencies.html
similarity index 99%
rename from freemarker-generator-cli/examples/data/html/dependencies.html
rename to freemarker-generator-cli/src/app/examples/data/html/dependencies.html
index c67940f..4e969bd 100644
--- a/freemarker-generator-cli/examples/data/html/dependencies.html
+++ b/freemarker-generator-cli/src/app/examples/data/html/dependencies.html
@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- <title>FreeMarker CLI – Project Dependencies</title>
+ <title>FreeMarker Generator – Project Dependencies</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@@ -16,7 +16,7 @@
<body class="composite">
<div id="banner">
<div id="bannerLeft">
-FreeMarker CLI
+FreeMarker Generator
</div>
<div class="clear">
<hr/>
@@ -27,7 +27,7 @@
<span id="publishDate">Last Published: 2019-02-07</span>
| <span id="projectVersion">Version: 1.0.2-SNAPSHOT</span>
</div>
- <div class="xright"><a href="${project.url}" title="FreeMarker CLI">FreeMarker CLI</a> </div>
+ <div class="xright"><a href="${project.url}" title="FreeMarker Generator">FreeMarker Generator</a> </div>
<div class="clear">
<hr/>
</div>
@@ -227,7 +227,7 @@
<li>org.github.sgoeschl:freemarker-cli:jar:1.0.2-SNAPSHOT <img id="_img1" src="./images/icon_info_sml.gif" alt="[Information]" onclick="toggleDependencyDetails( '_dep0', '_img1' );" style="cursor: pointer; vertical-align: text-bottom;"></img><div id="_dep0" style="display:none">
<table border="0" class="bodyTable">
<tr class="a">
-<th>FreeMarker CLI</th></tr>
+<th>FreeMarker Generator</th></tr>
<tr class="b">
<td>
<p><b>Description: </b>There is currently no description associated with this project.</p>
@@ -428,7 +428,7 @@
<div class="section">
<h2><a name="Licenses"></a>Licenses</h2>
<p><b>BSD: </b>ASM Core</p>
-<p><b>Unknown: </b>FreeMarker CLI</p>
+<p><b>Unknown: </b>FreeMarker Generator</p>
<p><b>BSD License: </b>curvesapi</p>
<p><b>The MIT License: </b>jsoup Java HTML Parser</p>
<p><b>MIT License: </b>SLF4J API Module, SLF4J LOG4J-12 Binding</p>
diff --git a/freemarker-generator-cli/examples/data/json/github-users.json b/freemarker-generator-cli/src/app/examples/data/json/github-users.json
similarity index 100%
rename from freemarker-generator-cli/examples/data/json/github-users.json
rename to freemarker-generator-cli/src/app/examples/data/json/github-users.json
diff --git a/freemarker-generator-cli/examples/data/json/swagger-spec.json b/freemarker-generator-cli/src/app/examples/data/json/swagger-spec.json
similarity index 100%
rename from freemarker-generator-cli/examples/data/json/swagger-spec.json
rename to freemarker-generator-cli/src/app/examples/data/json/swagger-spec.json
diff --git a/freemarker-generator-cli/examples/data/properties/user_0001/user.properties b/freemarker-generator-cli/src/app/examples/data/properties/user_0001/user.properties
similarity index 100%
rename from freemarker-generator-cli/examples/data/properties/user_0001/user.properties
rename to freemarker-generator-cli/src/app/examples/data/properties/user_0001/user.properties
diff --git a/freemarker-generator-cli/examples/data/properties/user_0002/user.properties b/freemarker-generator-cli/src/app/examples/data/properties/user_0002/user.properties
similarity index 100%
rename from freemarker-generator-cli/examples/data/properties/user_0002/user.properties
rename to freemarker-generator-cli/src/app/examples/data/properties/user_0002/user.properties
diff --git a/freemarker-generator-cli/examples/data/properties/user_0003/user.properties b/freemarker-generator-cli/src/app/examples/data/properties/user_0003/user.properties
similarity index 100%
rename from freemarker-generator-cli/examples/data/properties/user_0003/user.properties
rename to freemarker-generator-cli/src/app/examples/data/properties/user_0003/user.properties
diff --git a/freemarker-generator-cli/examples/data/properties/user_0004/user.properties b/freemarker-generator-cli/src/app/examples/data/properties/user_0004/user.properties
similarity index 100%
rename from freemarker-generator-cli/examples/data/properties/user_0004/user.properties
rename to freemarker-generator-cli/src/app/examples/data/properties/user_0004/user.properties
diff --git a/freemarker-generator-cli/examples/data/template/application.properties b/freemarker-generator-cli/src/app/examples/data/template/application.properties
similarity index 100%
rename from freemarker-generator-cli/examples/data/template/application.properties
rename to freemarker-generator-cli/src/app/examples/data/template/application.properties
diff --git a/freemarker-generator-cli/examples/data/template/nginx/nginx.conf.ftl b/freemarker-generator-cli/src/app/examples/data/template/nginx/nginx.conf.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/data/template/nginx/nginx.conf.ftl
rename to freemarker-generator-cli/src/app/examples/data/template/nginx/nginx.conf.ftl
diff --git a/freemarker-generator-cli/examples/data/xml/recipients.xml b/freemarker-generator-cli/src/app/examples/data/xml/recipients.xml
similarity index 100%
rename from freemarker-generator-cli/examples/data/xml/recipients.xml
rename to freemarker-generator-cli/src/app/examples/data/xml/recipients.xml
diff --git a/freemarker-generator-cli/examples/data/yaml/customer.yaml b/freemarker-generator-cli/src/app/examples/data/yaml/customer.yaml
similarity index 100%
rename from freemarker-generator-cli/examples/data/yaml/customer.yaml
rename to freemarker-generator-cli/src/app/examples/data/yaml/customer.yaml
diff --git a/freemarker-generator-cli/examples/data/yaml/swagger-spec.yaml b/freemarker-generator-cli/src/app/examples/data/yaml/swagger-spec.yaml
similarity index 100%
rename from freemarker-generator-cli/examples/data/yaml/swagger-spec.yaml
rename to freemarker-generator-cli/src/app/examples/data/yaml/swagger-spec.yaml
diff --git a/freemarker-generator-cli/examples/templates/accesslog/combined-access.ftl b/freemarker-generator-cli/src/app/examples/templates/accesslog/combined-access.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/accesslog/combined-access.ftl
rename to freemarker-generator-cli/src/app/examples/templates/accesslog/combined-access.ftl
diff --git a/freemarker-generator-cli/examples/templates/csv/csv/gatling-user-credentials.ftl b/freemarker-generator-cli/src/app/examples/templates/csv/csv/gatling-user-credentials.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/csv/csv/gatling-user-credentials.ftl
rename to freemarker-generator-cli/src/app/examples/templates/csv/csv/gatling-user-credentials.ftl
diff --git a/freemarker-generator-cli/examples/templates/csv/fo/transactions.ftl b/freemarker-generator-cli/src/app/examples/templates/csv/fo/transactions.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/csv/fo/transactions.ftl
rename to freemarker-generator-cli/src/app/examples/templates/csv/fo/transactions.ftl
diff --git a/freemarker-generator-cli/examples/templates/csv/fo/transform.ftl b/freemarker-generator-cli/src/app/examples/templates/csv/fo/transform.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/csv/fo/transform.ftl
rename to freemarker-generator-cli/src/app/examples/templates/csv/fo/transform.ftl
diff --git a/freemarker-generator-cli/examples/templates/csv/html/transactions.ftl b/freemarker-generator-cli/src/app/examples/templates/csv/html/transactions.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/csv/html/transactions.ftl
rename to freemarker-generator-cli/src/app/examples/templates/csv/html/transactions.ftl
diff --git a/freemarker-generator-cli/examples/templates/csv/md/filter.ftl b/freemarker-generator-cli/src/app/examples/templates/csv/md/filter.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/csv/md/filter.ftl
rename to freemarker-generator-cli/src/app/examples/templates/csv/md/filter.ftl
diff --git a/freemarker-generator-cli/examples/templates/csv/shell/curl.ftl b/freemarker-generator-cli/src/app/examples/templates/csv/shell/curl.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/csv/shell/curl.ftl
rename to freemarker-generator-cli/src/app/examples/templates/csv/shell/curl.ftl
diff --git a/freemarker-generator-cli/examples/templates/dataframe/example.ftl b/freemarker-generator-cli/src/app/examples/templates/dataframe/example.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/dataframe/example.ftl
rename to freemarker-generator-cli/src/app/examples/templates/dataframe/example.ftl
diff --git a/freemarker-generator-cli/examples/templates/dataframe/html/print.ftl b/freemarker-generator-cli/src/app/examples/templates/dataframe/html/print.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/dataframe/html/print.ftl
rename to freemarker-generator-cli/src/app/examples/templates/dataframe/html/print.ftl
diff --git a/freemarker-generator-cli/examples/templates/demo.ftl b/freemarker-generator-cli/src/app/examples/templates/demo.ftl
similarity index 99%
rename from freemarker-generator-cli/examples/templates/demo.ftl
rename to freemarker-generator-cli/src/app/examples/templates/demo.ftl
index da3a61d..f6d52af 100644
--- a/freemarker-generator-cli/examples/templates/demo.ftl
+++ b/freemarker-generator-cli/src/app/examples/templates/demo.ftl
@@ -114,7 +114,7 @@
- ${key}<#lt>
</#list>
-13) FreeMarker CLI Tools
+13) FreeMarker Generator Tools
---------------------------------------------------------------------------
<#list .data_model.tools?keys?sort as key>
- ${key?right_pad(20)} : ${.data_model.tools[key]}
diff --git a/freemarker-generator-cli/examples/templates/excel/csv/custom.ftl b/freemarker-generator-cli/src/app/examples/templates/excel/csv/custom.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/excel/csv/custom.ftl
rename to freemarker-generator-cli/src/app/examples/templates/excel/csv/custom.ftl
diff --git a/freemarker-generator-cli/examples/templates/excel/dataframe/transform.ftl b/freemarker-generator-cli/src/app/examples/templates/excel/dataframe/transform.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/excel/dataframe/transform.ftl
rename to freemarker-generator-cli/src/app/examples/templates/excel/dataframe/transform.ftl
diff --git a/freemarker-generator-cli/examples/templates/html/csv/dependencies.ftl b/freemarker-generator-cli/src/app/examples/templates/html/csv/dependencies.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/html/csv/dependencies.ftl
rename to freemarker-generator-cli/src/app/examples/templates/html/csv/dependencies.ftl
diff --git a/freemarker-generator-cli/src/app/examples/templates/html/txt/licence.ftl b/freemarker-generator-cli/src/app/examples/templates/html/txt/licence.ftl
new file mode 100644
index 0000000..2807493
--- /dev/null
+++ b/freemarker-generator-cli/src/app/examples/templates/html/txt/licence.ftl
@@ -0,0 +1,285 @@
+<#--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<#--
+FreeMarker template to create a LICENCE file.
+-->
+<#assign dataSource = dataSources?values[0]>
+<#assign html = tools.jsoup.parse(dataSource)>
+<#assign dataframe = tools.dataframe.create()
+ .addStringColumn("GroupId")
+ .addStringColumn("ArtifactId")
+ .addStringColumn("Version")
+ .addStringColumn("Type")
+ .addStringColumn("License")
+>
+<@parseDependencies dataframe "Project_Dependencies_compile"/>
+<@parseDependencies dataframe "Project_Transitive_Dependencies_compile"/>
+<@parseDependencies dataframe "Project_Transitive_Dependencies_runtime"/>
+<@parseDependencies dataframe "Project_Transitive_Dependencies_provided"/>
+<@writeApacheLicence/>
+<#list dataframe.iterator() as dependency>
+<#assign artifactId = dependency.get("ArtifactId")>
+<#assign licence = dependency.get("License")>
+<#assign file = getLicenceFile(licence, artifactId)>
+==============================================================================
+
+Binary distributions of this product bundles ${dependency.get("ArtifactId")} which
+is available under ${licence}.
+See ${file} for more information ...
+
+</#list>
+
+<#macro parseDependencies dataframe section>
+ <#assign selection = html.select("a[name=${section}]")>
+ <#if selection?has_content>
+ <#assign table = selection[0].nextElementSibling().child(2).child(0)>
+ <#assign rows = table.children()>
+ <#list rows as row>
+ <#if !row?is_first>
+ <#assign groupId = row.child(0).text()>
+ <#assign artifactId = row.child(1).text()>
+ <#assign version = row.child(2).text()>
+ <#assign type = row.child(3).text()>
+ <#assign licence = row.child(4).text()?replace(",", "")>
+ <#assign temp = dataframe.append(groupId, artifactId, version, type, licence)>
+ </#if>
+ </#list>
+ </#if>
+</#macro>
+
+<#function getLicenceFile licence artifactId>
+ <#assign bsdArtifactId=["antlr4-runtime", "asm", "curvesapi", "hamcrest"]>
+ <#if licence?contains("BSD")>
+ <#if bsdArtifactId?seq_contains(artifactId)>
+ <#return "licences/LICENCE_${artifactId}.txt">
+ </#if>
+ <#elseif licence?contains("Apache")>
+ <#return "licencens/LICENSE_ASL-2.0.txt">
+ <#elseif licence?contains("COMMON DEVELOPMENT AND DISTRIBUTION")>
+ <#return "licences/LICENCE_CDDL-1.0.txt">
+ <#elseif licence?contains("MIT")>
+ <#return "licences/LICENCE_MIT.txt">
+ <#elseif licence?contains("Eclipse Public License 1.0")>
+ <#return "licences/LICENCE_EPL-1.0.txt">
+ </#if>
+</#function>
+
+<#macro writeApacheLicence>
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ 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]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+</#macro>
\ No newline at end of file
diff --git a/freemarker-generator-cli/examples/templates/json/csv/swagger-endpoints.ftl b/freemarker-generator-cli/src/app/examples/templates/json/csv/swagger-endpoints.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/json/csv/swagger-endpoints.ftl
rename to freemarker-generator-cli/src/app/examples/templates/json/csv/swagger-endpoints.ftl
diff --git a/freemarker-generator-cli/examples/templates/json/dataframe/github-users.ftl b/freemarker-generator-cli/src/app/examples/templates/json/dataframe/github-users.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/json/dataframe/github-users.ftl
rename to freemarker-generator-cli/src/app/examples/templates/json/dataframe/github-users.ftl
diff --git a/freemarker-generator-cli/examples/templates/json/md/github-users.ftl b/freemarker-generator-cli/src/app/examples/templates/json/md/github-users.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/json/md/github-users.ftl
rename to freemarker-generator-cli/src/app/examples/templates/json/md/github-users.ftl
diff --git a/freemarker-generator-cli/examples/templates/properties/csv/locker-test-users.ftl b/freemarker-generator-cli/src/app/examples/templates/properties/csv/locker-test-users.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/properties/csv/locker-test-users.ftl
rename to freemarker-generator-cli/src/app/examples/templates/properties/csv/locker-test-users.ftl
diff --git a/freemarker-generator-cli/examples/templates/tsv/fo/transactions.ftl b/freemarker-generator-cli/src/app/examples/templates/tsv/fo/transactions.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/tsv/fo/transactions.ftl
rename to freemarker-generator-cli/src/app/examples/templates/tsv/fo/transactions.ftl
diff --git a/freemarker-generator-cli/examples/templates/xml/txt/recipients.ftl b/freemarker-generator-cli/src/app/examples/templates/xml/txt/recipients.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/xml/txt/recipients.ftl
rename to freemarker-generator-cli/src/app/examples/templates/xml/txt/recipients.ftl
diff --git a/freemarker-generator-cli/examples/templates/yaml/txt/transform.ftl b/freemarker-generator-cli/src/app/examples/templates/yaml/txt/transform.ftl
similarity index 100%
rename from freemarker-generator-cli/examples/templates/yaml/txt/transform.ftl
rename to freemarker-generator-cli/src/app/examples/templates/yaml/txt/transform.ftl
diff --git a/freemarker-generator-cli/run-examples.bat b/freemarker-generator-cli/src/app/scripts/run-examples.bat
similarity index 77%
rename from freemarker-generator-cli/run-examples.bat
rename to freemarker-generator-cli/src/app/scripts/run-examples.bat
index 95bbfd9..c472333 100644
--- a/freemarker-generator-cli/run-examples.bat
+++ b/freemarker-generator-cli/src/app/scripts/run-examples.bat
@@ -21,14 +21,14 @@
mkdir target 2>NULL
mkdir target\out 2>NULL
-SET FREEMARKER_CMD=CALL target\appassembler\bin\freemarker-cli.bat
+SET FREEMARKER_CMD=CALL .\bin\freemarker-generator.bat
REM =========================================================================
REM Info
REM =========================================================================
-echo "templates\info.ftl"
-%FREEMARKER_CMD% -t templates\info.ftl README.md > target\out\info.txt
+echo "templates\freemarker-generator\info.ftl"
+%FREEMARKER_CMD% -t freemarker-generator\info.ftl README.md > target\out\info.txt
REM =========================================================================
REM Demo
@@ -52,11 +52,11 @@
REM CSV
REM =========================================================================
-echo "templates\csv\html\transform.ftl"
-%FREEMARKER_CMD% -t templates\csv\html\transform.ftl examples\data\csv\contract.csv > target\out\contract.html
+echo "templates\freemarker-generator\csv\html\transform.ftl"
+%FREEMARKER_CMD% -t freemarker-generator\csv\html\transform.ftl examples\data\csv\contract.csv > target\out\contract.html
-echo "templates\csv\md\transform.ftl"
-%FREEMARKER_CMD% -t templates\csv\md\transform.ftl examples\data\csv\contract.csv > target\out\contract.md
+echo "templates\freemarker-generator\csv\md\transform.ftl"
+%FREEMARKER_CMD% -t freemarker-generator\csv\md\transform.ftl examples\data\csv\contract.csv > target\out\contract.md
echo "examples\templates\csv\shell\curl.ftl"
%FREEMARKER_CMD% -t .\examples\templates\csv\shell\curl.ftl examples\data\csv\user.csv > target\out\curl.sh
@@ -78,7 +78,7 @@
REM CSV to HTML & PDF
REM =========================================================================
-echo "templates\csv\html\transform.ftl"
+echo "examples\templates\csv\html\transform.ftl"
%FREEMARKER_CMD% -t examples\templates\csv\html\transactions.ftl examples\data\csv\transactions.csv > target\out\transactions.html
REM =========================================================================
@@ -102,16 +102,16 @@
echo "examples\templates\excel\dataframe\transform.ftl"
%FREEMARKER_CMD% -t examples\templates\excel\dataframe\transform.ftl examples\data\excel\test.xls > target\out\test.xls.dataframe.txt
-echo "templates\excel\html\transform.ftl"
-%FREEMARKER_CMD% -t templates\excel\html\transform.ftl examples\data\excel\test.xls > target\out\test.xls.html
-%FREEMARKER_CMD% -t templates\excel\html\transform.ftl examples\data\excel\test.xlsx > target\out\test.xslx.html
-%FREEMARKER_CMD% -t templates\excel\html\transform.ftl examples\data\excel\test-multiple-sheets.xlsx > target\out\test-multiple-sheets.xlsx.html
+echo "templates\freemarker-generator\excel\html\transform.ftl"
+%FREEMARKER_CMD% -t freemarker-generator\excel\html\transform.ftl examples\data\excel\test.xls > target\out\test.xls.html
+%FREEMARKER_CMD% -t freemarker-generator\excel\html\transform.ftl examples\data\excel\test.xlsx > target\out\test.xslx.html
+%FREEMARKER_CMD% -t freemarker-generator\excel\html\transform.ftl examples\data\excel\test-multiple-sheets.xlsx > target\out\test-multiple-sheets.xlsx.html
-echo "templates\excel\md\transform.ftl"
-%FREEMARKER_CMD% -t templates\excel\md\transform.ftl examples\data\excel\test-multiple-sheets.xlsx > target\out\test-multiple-sheets.xlsx.md
+echo "templates\freemarker-generator\excel\md\transform.ftl"
+%FREEMARKER_CMD% -t freemarker-generator\excel\md\transform.ftl examples\data\excel\test-multiple-sheets.xlsx > target\out\test-multiple-sheets.xlsx.md
-echo "templates\excel\csv\transform.ftl"
-%FREEMARKER_CMD% -t templates\excel\csv\transform.ftl examples\data\excel\test-multiple-sheets.xlsx > target\out\test-multiple-sheets.xlsx.csv
+echo "templates\freemarker-generator\excel\csv\transform.ftl"
+%FREEMARKER_CMD% -t freemarker-generator\excel\csv\transform.ftl examples\data\excel\test-multiple-sheets.xlsx > target\out\test-multiple-sheets.xlsx.csv
echo "examples\templates\excel\csv\custom.ftl"
%FREEMARKER_CMD% -t examples\templates\excel\csv\custom.ftl -Pcsv.format=MYSQL examples\data\excel\test.xls > target\out\test-transform-xls.csv
@@ -123,6 +123,9 @@
echo "examples\templates\html\csv\dependencies.ftl"
%FREEMARKER_CMD% -t examples\templates\html\csv\dependencies.ftl examples\data\html\dependencies.html > target\out\dependencies.csv
+echo "examples\templates\html\txt\licence.ftl"
+%FREEMARKER_CMD% -t examples\templates\html\txt\licence.ftl examples\data\html\dependencies.html > target\out\licence.txt
+
REM =========================================================================
REM JSON
REM =========================================================================
@@ -130,8 +133,8 @@
echo "examples\templates\json\csv\swagger-endpoints.ftl"
%FREEMARKER_CMD% -t examples\templates\json\csv\swagger-endpoints.ftl examples\data\json\swagger-spec.json > target\out\swagger-spec.csv
-echo "templates\json\yaml\transform.ftl"
-%FREEMARKER_CMD% -t templates\json\yaml\transform.ftl examples\data\json\swagger-spec.json > target\out\swagger-spec.yaml
+echo "templates\freemarker-generator\json\yaml\transform.ftl"
+%FREEMARKER_CMD% -t freemarker-generator\json\yaml\transform.ftl examples\data\json\swagger-spec.json > target\out\swagger-spec.yaml
echo "examples\templates\json\md\github-users.ftl"
%FREEMARKER_CMD% -t examples\templates\json\md\github-users.ftl examples\data\json\github-users.json > target\out\github-users.md
@@ -151,21 +154,21 @@
%FREEMARKER_CMD% -t examples\data\template -PNGINX_HOSTNAME=localhost -o target\out\template
REM =========================================================================
+REM XML
+REM =========================================================================
+
+echo "examples\templates\xml\txt\recipients.ftl"
+%FREEMARKER_CMD% -t examples\templates\xml\txt\recipients.ftl examples\data\xml\recipients.xml > target\out\recipients.txt
+
+REM =========================================================================
REM YAML
REM =========================================================================
echo "examples\templates\yaml\txt\transform.ftl"
%FREEMARKER_CMD% -t examples\templates\yaml\txt\transform.ftl examples\data\yaml\customer.yaml > target\out\customer.txt
-echo "templates\yaml\json\transform.ftl"
-%FREEMARKER_CMD% -t templates\yaml\json\transform.ftl examples\data\yaml\swagger-spec.yaml > target\out\swagger-spec.json
-
-REM =========================================================================
-REM XML
-REM =========================================================================
-
-echo "examples\templates\xml\txt\recipients.ftl"
-%FREEMARKER_CMD% -t .\examples\templates\xml\txt\recipients.ftl examples\data\xml\recipients.xml > target\out\recipients.txt
+echo "templates\freemarker-generator\yaml\json\transform.ftl"
+%FREEMARKER_CMD% -t freemarker-generator\yaml\json\transform.ftl examples\data\yaml\swagger-spec.yaml > target\out\swagger-spec.json
echo "Created the following sample files in .\target\out"
dir .\target\out
\ No newline at end of file
diff --git a/freemarker-generator-cli/run-examples.sh b/freemarker-generator-cli/src/app/scripts/run-examples.sh
similarity index 77%
rename from freemarker-generator-cli/run-examples.sh
rename to freemarker-generator-cli/src/app/scripts/run-examples.sh
index 719c199..89f86e7 100755
--- a/freemarker-generator-cli/run-examples.sh
+++ b/freemarker-generator-cli/src/app/scripts/run-examples.sh
@@ -1,4 +1,5 @@
#!/bin/sh
+
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
@@ -14,26 +15,25 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
+#
# Check that java is on the path
hash java 2>/dev/null || { echo >&2 "I require JDK but it's not installed. Aborting."; exit 1; }
-hash mvn 2>/dev/null || { echo >&2 "I require Maven but it's not installed. Aborting."; exit 1; }
# Run all the samples being documented
mkdir target 2>/dev/null
mkdir target/out 2>/dev/null
-FREEMARKER_CMD="target/appassembler/bin/freemarker-cli"
-# FREEMARKER_CMD="java -jar target/freemarker-cli-2.0.0-BETA-4-SNAPSHOT-jar-with-dependencies.jar"
+FREEMARKER_CMD=./bin/freemarker-generator
#############################################################################
# Info
#############################################################################
-echo "templates/info.ftl"
-$FREEMARKER_CMD -t templates/info.ftl README.md > target/out/info.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
+echo "templates/freemarker-generator/info.ftl"
+$FREEMARKER_CMD -t freemarker-generator/info.ftl README.md > target/out/info.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
#############################################################################
# Demo
@@ -57,11 +57,11 @@
# CSV
#############################################################################
-echo "templates/csv/html/transform.ftl"
-$FREEMARKER_CMD -t templates/csv/html/transform.ftl examples/data/csv/contract.csv > target/out/contract.html || { echo >&2 "Test failed. Aborting."; exit 1; }
+echo "templates/freemarker-generator/csv/html/transform.ftl"
+$FREEMARKER_CMD -t freemarker-generator/csv/html/transform.ftl examples/data/csv/contract.csv > target/out/contract.html || { echo >&2 "Test failed. Aborting."; exit 1; }
-echo "templates/csv/md/transform.ftl"
-$FREEMARKER_CMD -t templates/csv/md/transform.ftl examples/data/csv/contract.csv > target/out/contract.md || { echo >&2 "Test failed. Aborting."; exit 1; }
+echo "templates/freemarker-generator/csv/md/transform.ftl"
+$FREEMARKER_CMD -t freemarker-generator/csv/md/transform.ftl examples/data/csv/contract.csv > target/out/contract.md || { echo >&2 "Test failed. Aborting."; exit 1; }
echo "examples/templates/csv/shell/curl.ftl"
$FREEMARKER_CMD -t ./examples/templates/csv/shell/curl.ftl examples/data/csv/user.csv > target/out/curl.sh || { echo >&2 "Test failed. Aborting."; exit 1; }
@@ -93,7 +93,7 @@
# CSV to HTML & PDF
#############################################################################
-echo "templates/csv/html/transform.ftl"
+echo "examples/templates/csv/html/transform.ftl"
$FREEMARKER_CMD -t examples/templates/csv/html/transactions.ftl examples/data/csv/transactions.csv > target/out/transactions.html || { echo >&2 "Test failed. Aborting."; exit 1; }
if hash wkhtmltopdf 2>/dev/null; then
@@ -122,16 +122,16 @@
echo "examples/templates/excel/dataframe/transform.ftl"
$FREEMARKER_CMD -t examples/templates/excel/dataframe/transform.ftl examples/data/excel/test.xls > target/out/test.xls.dataframe.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-echo "templates/excel/html/transform.ftl"
-$FREEMARKER_CMD -t templates/excel/html/transform.ftl examples/data/excel/test.xls > target/out/test.xls.html || { echo >&2 "Test failed. Aborting."; exit 1; }
-$FREEMARKER_CMD -t templates/excel/html/transform.ftl examples/data/excel/test.xlsx > target/out/test.xslx.html || { echo >&2 "Test failed. Aborting."; exit 1; }
-$FREEMARKER_CMD -t templates/excel/html/transform.ftl examples/data/excel/test-multiple-sheets.xlsx > target/out/test-multiple-sheets.xlsx.html || { echo >&2 "Test failed. Aborting."; exit 1; }
+echo "templates/freemarker-generator/excel/html/transform.ftl"
+$FREEMARKER_CMD -t freemarker-generator/excel/html/transform.ftl examples/data/excel/test.xls > target/out/test.xls.html || { echo >&2 "Test failed. Aborting."; exit 1; }
+$FREEMARKER_CMD -t freemarker-generator/excel/html/transform.ftl examples/data/excel/test.xlsx > target/out/test.xslx.html || { echo >&2 "Test failed. Aborting."; exit 1; }
+$FREEMARKER_CMD -t freemarker-generator/excel/html/transform.ftl examples/data/excel/test-multiple-sheets.xlsx > target/out/test-multiple-sheets.xlsx.html || { echo >&2 "Test failed. Aborting."; exit 1; }
-echo "templates/excel/md/transform.ftl"
-$FREEMARKER_CMD -t templates/excel/md/transform.ftl examples/data/excel/test-multiple-sheets.xlsx > target/out/test-multiple-sheets.xlsx.md || { echo >&2 "Test failed. Aborting."; exit 1; }
+echo "templates/freemarker-generator/excel/md/transform.ftl"
+$FREEMARKER_CMD -t freemarker-generator/excel/md/transform.ftl examples/data/excel/test-multiple-sheets.xlsx > target/out/test-multiple-sheets.xlsx.md || { echo >&2 "Test failed. Aborting."; exit 1; }
-echo "templates/excel/csv/transform.ftl"
-$FREEMARKER_CMD -t templates/excel/csv/transform.ftl examples/data/excel/test-multiple-sheets.xlsx > target/out/test-multiple-sheets.xlsx.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
+echo "templates/freemarker-generator/excel/csv/transform.ftl"
+$FREEMARKER_CMD -t freemarker-generator/excel/csv/transform.ftl examples/data/excel/test-multiple-sheets.xlsx > target/out/test-multiple-sheets.xlsx.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
echo "examples/templates/excel/csv/custom.ftl"
$FREEMARKER_CMD -t examples/templates/excel/csv/custom.ftl -Pcsv.format=MYSQL examples/data/excel/test.xls > target/out/test-transform-xls.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
@@ -143,6 +143,9 @@
echo "examples/templates/html/csv/dependencies.ftl"
$FREEMARKER_CMD -t examples/templates/html/csv/dependencies.ftl examples/data/html/dependencies.html > target/out/dependencies.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
+echo "examples/templates/html/txt/licence.ftl"
+$FREEMARKER_CMD -t examples/templates/html/txt/licence.ftl examples/data/html/dependencies.html > target/out/licence.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
+
#############################################################################
# JSON
#############################################################################
@@ -150,13 +153,11 @@
echo "examples/templates/json/csv/swagger-endpoints.ftl"
$FREEMARKER_CMD -t examples/templates/json/csv/swagger-endpoints.ftl examples/data/json/swagger-spec.json > target/out/swagger-spec.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
-echo "templates/json/yaml/transform.ftl"
-$FREEMARKER_CMD -t templates/json/yaml/transform.ftl examples/data/json/swagger-spec.json > target/out/swagger-spec.yaml || { echo >&2 "Test failed. Aborting."; exit 1; }
+echo "templates/freemarker-generator/json/yaml/transform.ftl"
+$FREEMARKER_CMD -t freemarker-generator/json/yaml/transform.ftl examples/data/json/swagger-spec.json > target/out/swagger-spec.yaml || { echo >&2 "Test failed. Aborting."; exit 1; }
-if hash curl 2>/dev/null; then
echo "examples/templates/json/md/github-users.ftl"
-$FREEMARKER_CMD -t examples/templates/json/md/github-users.ftl examples/data/json/github-users.json > target/out/github-users-curl.md || { echo >&2 "Test failed. Aborting."; exit 1; }
-fi
+$FREEMARKER_CMD -t examples/templates/json/md/github-users.ftl examples/data/json/github-users.json > target/out/github-users.md || { echo >&2 "Test failed. Aborting."; exit 1; }
#############################################################################
# Properties
@@ -173,21 +174,21 @@
$FREEMARKER_CMD -t examples/data/template -PNGINX_HOSTNAME=localhost -o target/out/template || { echo >&2 "Test failed. Aborting."; exit 1; }
#############################################################################
+# XML
+#############################################################################
+
+echo "examples/templates/xml/txt/recipients.ftl"
+$FREEMARKER_CMD -t examples/templates/xml/txt/recipients.ftl examples/data/xml/recipients.xml > target/out/recipients.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
+
+#############################################################################
# YAML
#############################################################################
echo "examples/templates/yaml/txt/transform.ftl"
$FREEMARKER_CMD -t examples/templates/yaml/txt/transform.ftl examples/data/yaml/customer.yaml > target/out/customer.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-echo "templates/yaml/json/transform.ftl"
-$FREEMARKER_CMD -t templates/yaml/json/transform.ftl examples/data/yaml/swagger-spec.yaml > target/out/swagger-spec.json || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# XML
-#############################################################################
-
-echo "examples/templates/xml/txt/recipients.ftl"
-$FREEMARKER_CMD -t ./examples/templates/xml/txt/recipients.ftl examples/data/xml/recipients.xml > target/out/recipients.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
+echo "templates/freemarker-generator/yaml/json/transform.ftl"
+$FREEMARKER_CMD -t freemarker-generator/yaml/json/transform.ftl examples/data/yaml/swagger-spec.yaml > target/out/swagger-spec.json || { echo >&2 "Test failed. Aborting."; exit 1; }
echo "Created the following sample files in ./target/out"
ls -l ./target/out
\ No newline at end of file
diff --git a/freemarker-generator-cli/templates/cat.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/cat.ftl
similarity index 100%
rename from freemarker-generator-cli/templates/cat.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/cat.ftl
diff --git a/freemarker-generator-cli/templates/csv/csv/transform.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/csv/csv/transform.ftl
similarity index 95%
rename from freemarker-generator-cli/templates/csv/csv/transform.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/csv/csv/transform.ftl
index b02082d..3941c4c 100644
--- a/freemarker-generator-cli/templates/csv/csv/transform.ftl
+++ b/freemarker-generator-cli/src/app/templates/freemarker-generator/csv/csv/transform.ftl
@@ -15,7 +15,7 @@
specific language governing permissions and limitations
under the License.
-->
-<#import "/templates/lib/commons-csv.ftl" as csv />
+<#import "/freemarker-generator/lib/commons-csv.ftl" as csv />
<#assign dataSource = dataSources?values[0]>
<#assign csvParser = tools.csv.parse(dataSource, csv.sourceFormat())>
<#assign csvTargetFormat = csv.targetFormat()>
diff --git a/freemarker-generator-cli/templates/csv/html/transform.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/csv/html/transform.ftl
similarity index 96%
rename from freemarker-generator-cli/templates/csv/html/transform.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/csv/html/transform.ftl
index 7c52f73..d027672 100644
--- a/freemarker-generator-cli/templates/csv/html/transform.ftl
+++ b/freemarker-generator-cli/src/app/templates/freemarker-generator/csv/html/transform.ftl
@@ -15,7 +15,7 @@
specific language governing permissions and limitations
under the License.
-->
-<#import "/templates/lib/commons-csv.ftl" as csv />
+<#import "/freemarker-generator/lib/commons-csv.ftl" as csv />
<#assign dataSource = dataSources?values[0]>
<#assign csvParser = tools.csv.parse(dataSource, csv.sourceFormat())>
<#assign csvHeaders = csvParser.getHeaderNames()>
diff --git a/freemarker-generator-cli/templates/csv/md/transform.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/csv/md/transform.ftl
similarity index 96%
rename from freemarker-generator-cli/templates/csv/md/transform.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/csv/md/transform.ftl
index ec50a98..6929b31 100644
--- a/freemarker-generator-cli/templates/csv/md/transform.ftl
+++ b/freemarker-generator-cli/src/app/templates/freemarker-generator/csv/md/transform.ftl
@@ -14,7 +14,7 @@
specific language governing permissions and limitations
under the License.
-->
-<#import "/templates/lib/commons-csv.ftl" as csv />
+<#import "/freemarker-generator/lib/commons-csv.ftl" as csv />
<#assign dataSource = dataSources?values[0]>
<#assign csvParser = tools.csv.parse(dataSource, csv.sourceFormat())>
<#assign headers = (csvParser.getHeaderMap()!{})?keys>
diff --git a/freemarker-generator-cli/templates/excel/csv/transform.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/excel/csv/transform.ftl
similarity index 96%
rename from freemarker-generator-cli/templates/excel/csv/transform.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/excel/csv/transform.ftl
index 0138bf5..18179f4 100644
--- a/freemarker-generator-cli/templates/excel/csv/transform.ftl
+++ b/freemarker-generator-cli/src/app/templates/freemarker-generator/excel/csv/transform.ftl
@@ -16,7 +16,7 @@
under the License.
-->
<#-- Parse the first data source & sheet of the Excel document -->
-<#import "/templates/lib/commons-csv.ftl" as csv />
+<#import "/freemarker-generator/lib/commons-csv.ftl" as csv />
<#assign workbook = tools.excel.parse(dataSources?values[0])>
<#assign sheet = tools.excel.getSheets(workbook)[0]>
<#assign records = tools.excel.toTable(sheet)>
diff --git a/freemarker-generator-cli/templates/excel/html/transform.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/excel/html/transform.ftl
similarity index 100%
rename from freemarker-generator-cli/templates/excel/html/transform.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/excel/html/transform.ftl
diff --git a/freemarker-generator-cli/templates/excel/md/transform.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/excel/md/transform.ftl
similarity index 100%
rename from freemarker-generator-cli/templates/excel/md/transform.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/excel/md/transform.ftl
diff --git a/freemarker-generator-cli/templates/info.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/info.ftl
similarity index 91%
rename from freemarker-generator-cli/templates/info.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/info.ftl
index 10b692c..1a34880 100644
--- a/freemarker-generator-cli/templates/info.ftl
+++ b/freemarker-generator-cli/src/app/templates/freemarker-generator/info.ftl
@@ -15,7 +15,7 @@
specific language governing permissions and limitations
under the License.
-->
-FreeMarker CLI Information
+FreeMarker Generator Information
------------------------------------------------------------------------------
FreeMarker version : ${.version}
Template name : ${.current_template_name}
@@ -25,26 +25,26 @@
Output encoding : ${.output_encoding}
Output format : ${.output_format}
-FreeMarker CLI Template Loader Directories
+FreeMarker Generator Template Loader Directories
------------------------------------------------------------------------------
<#list tools.system.getTemplateDirectories() as directory>
[#${directory?counter}] ${directory}
</#list>
-FreeMarker CLI Data Model
+FreeMarker Generator Data Model
---------------------------------------------------------------------------
<#list .data_model?keys?sort as key>
- ${key}<#lt>
</#list>
-FreeMarker CLI Tools
+FreeMarker Generator Tools
------------------------------------------------------------------------------
<#list tools?keys?sort as name>
- ${name?right_pad(20)} : ${tools[name]}
</#list>
<#if dataSources?has_content>
-FreeMarker CLI DataSources
+FreeMarker Generator DataSources
------------------------------------------------------------------------------
<#list dataSources?values as ds>
[#${ds?counter}]: name=${ds.name}, group=${ds.group}, fileName=${ds.fileName} mimeType=${ds.mimeType}, charset=${ds.charset}, length=${ds.length} Bytes
@@ -53,7 +53,7 @@
</#if>
<#if tools.system.parameters?has_content>
-FreeMarker CLI Parameters
+FreeMarker Generator Parameters
------------------------------------------------------------------------------
<#list tools.system.parameters as key,value>
<#if value?is_hash>
diff --git a/freemarker-generator-cli/templates/json/yaml/transform.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/json/yaml/transform.ftl
similarity index 100%
rename from freemarker-generator-cli/templates/json/yaml/transform.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/json/yaml/transform.ftl
diff --git a/freemarker-generator-cli/templates/lib/commons-csv.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/lib/commons-csv.ftl
similarity index 100%
rename from freemarker-generator-cli/templates/lib/commons-csv.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/lib/commons-csv.ftl
diff --git a/freemarker-generator-cli/templates/yaml/json/transform.ftl b/freemarker-generator-cli/src/app/templates/freemarker-generator/yaml/json/transform.ftl
similarity index 100%
rename from freemarker-generator-cli/templates/yaml/json/transform.ftl
rename to freemarker-generator-cli/src/app/templates/freemarker-generator/yaml/json/transform.ftl
diff --git a/freemarker-generator-cli/src/main/assembly/app.xml b/freemarker-generator-cli/src/main/assembly/app.xml
index 41c987c..20eed47 100644
--- a/freemarker-generator-cli/src/main/assembly/app.xml
+++ b/freemarker-generator-cli/src/main/assembly/app.xml
@@ -28,7 +28,7 @@
<fileSet>
<directory>${project.basedir}/target/appassembler</directory>
<excludes>
- <exclude>bin/freemarker-cli</exclude>
+ <exclude>bin/freemarker-generator</exclude>
<exclude>*.sh</exclude>
</excludes>
<outputDirectory>${file.separator}</outputDirectory>
@@ -37,7 +37,7 @@
<fileSet>
<directory>${project.basedir}/target/appassembler</directory>
<includes>
- <include>bin/freemarker-cli</include>
+ <include>bin/freemarker-generator</include>
<include>*.sh</include>
</includes>
<outputDirectory>${file.separator}</outputDirectory>
diff --git a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/Main.java b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/Main.java
index 8b3b853..4869909 100644
--- a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/Main.java
+++ b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/Main.java
@@ -16,6 +16,8 @@
*/
package org.apache.freemarker.generator.cli;
+import org.apache.freemarker.generator.base.FreeMarkerConstants.Configuration;
+import org.apache.freemarker.generator.base.FreeMarkerConstants.SystemProperties;
import org.apache.freemarker.generator.base.parameter.ParameterModelSupplier;
import org.apache.freemarker.generator.base.util.ClosableUtils;
import org.apache.freemarker.generator.base.util.ListUtils;
@@ -47,14 +49,14 @@
import java.util.stream.Stream;
import static java.util.Objects.requireNonNull;
+import static org.apache.freemarker.generator.base.util.StringUtils.isEmpty;
+import static org.apache.freemarker.generator.base.util.StringUtils.isNotEmpty;
import static org.apache.freemarker.generator.cli.config.Suppliers.propertiesSupplier;
import static org.apache.freemarker.generator.cli.config.Suppliers.templateDirectorySupplier;
-@Command(description = "Apache FreeMarker CLI", name = "freemarker-cli", mixinStandardHelpOptions = true, versionProvider = GitVersionProvider.class)
+@Command(description = "Apache FreeMarker Generator", name = "freemarker-generator", mixinStandardHelpOptions = true, versionProvider = GitVersionProvider.class)
public class Main implements Callable<Integer> {
- private static final String FREEMARKER_CLI_PROPERTY_FILE = "freemarker-cli.properties";
-
@ArgGroup(multiplicity = "1")
TemplateSourceOptions templateSourceOptions;
@@ -66,9 +68,6 @@
public String interactiveTemplate;
}
- @Option(names = { "-b", "--basedir" }, description = "additional template base directory")
- String baseDir;
-
@Option(names = { "-D", "--system-property" }, description = "set system property")
Properties systemProperties;
@@ -90,7 +89,7 @@
@Option(names = { "-s", "--data-source" }, description = "data source used for rendering")
List<String> dataSources;
- @Option(names = { "--config" }, defaultValue = FREEMARKER_CLI_PROPERTY_FILE, description = "FreeMarker CLI configuration file")
+ @Option(names = { "--config" }, description = "FreeMarker Generator configuration file")
String configFile;
@Option(names = { "--data-source-include" }, description = "file include pattern for data sources")
@@ -105,6 +104,9 @@
@Option(names = { "--stdin" }, description = "read data source from stdin")
boolean readFromStdin;
+ @Option(names = { "--template-dir" }, description = "additional template directory")
+ String templateDir;
+
@Option(names = { "--times" }, defaultValue = "1", description = "re-run X times for profiling")
int times;
@@ -166,8 +168,9 @@
private Integer onCall() {
updateSystemProperties();
- final Properties configuration = loadFreeMarkerCliConfiguration(configFile);
- final List<File> templateDirectories = getTemplateDirectories(baseDir);
+ final String currentConfigFile = isNotEmpty(configFile) ? configFile : getDefaultConfigFileName();
+ final Properties configuration = loadFreeMarkerCliConfiguration(currentConfigFile);
+ final List<File> templateDirectories = getTemplateDirectories(templateDir);
final Settings settings = settings(configuration, templateDirectories);
try {
@@ -258,16 +261,31 @@
.collect(Collectors.toList());
}
- private static List<File> getTemplateDirectories(String baseDir) {
- return templateDirectorySupplier(baseDir).get();
+ private static List<File> getTemplateDirectories(String additionalTemplateDir) {
+ return templateDirectorySupplier(additionalTemplateDir).get();
+ }
+
+ /**
+ * Get the default configuration file based on the "app.home" system property
+ * provided by the shell wrapper.
+ *
+ * @return default configuration file name or null
+ */
+ private static String getDefaultConfigFileName() {
+ final String appHome = System.getProperty(SystemProperties.APP_HOME);
+ return isNotEmpty(appHome) ? new File(appHome, Configuration.CONFIG_FILE_NAME).getAbsolutePath() : null;
}
private static Properties loadFreeMarkerCliConfiguration(String fileName) {
+ if (isEmpty(fileName)) {
+ return new Properties();
+ }
+
final Properties properties = propertiesSupplier(fileName).get();
if (properties != null) {
return properties;
} else {
- throw new RuntimeException("FreeMarker CLI configuration file not found: " + fileName);
+ return new Properties();
}
}
diff --git a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/Settings.java b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/Settings.java
index 245a2a8..427fd93 100644
--- a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/Settings.java
+++ b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/Settings.java
@@ -45,7 +45,7 @@
*/
public class Settings {
- /** FreeMarker CLI configuration containing tool mappings, etc. */
+ /** FreeMarker Generator configuration containing tool mappings, etc. */
private final Properties configuration;
/** Command line arguments */
diff --git a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/Suppliers.java b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/Suppliers.java
index 6412b4d..b6e6fd0 100644
--- a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/Suppliers.java
+++ b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/Suppliers.java
@@ -17,6 +17,7 @@
package org.apache.freemarker.generator.cli.config;
import freemarker.cache.TemplateLoader;
+import org.apache.freemarker.generator.base.FreeMarkerConstants.Location;
import org.apache.freemarker.generator.base.datasource.DataSourcesSupplier;
import org.apache.freemarker.generator.base.file.PropertiesClassPathSupplier;
import org.apache.freemarker.generator.base.file.PropertiesFileSystemSupplier;
@@ -40,8 +41,8 @@
return new ConfigurationSupplier(settings, templateLoader);
}
- public static TemplateDirectorySupplier templateDirectorySupplier(String userDefinedTemplateDir) {
- return new TemplateDirectorySupplier(userDefinedTemplateDir);
+ public static TemplateDirectorySupplier templateDirectorySupplier(String additionalTemplateDirName) {
+ return new TemplateDirectorySupplier(additionalTemplateDirName);
}
public static TemplateLoaderSupplier templateLoaderSupplier(Settings settings) {
@@ -69,7 +70,7 @@
public static TemplateTransformationsSupplier templateTransformationsSupplier(Settings settings) {
return () -> TemplateTransformationsBuilder.builder()
- .setTemplate("interactive", settings.getInteractiveTemplate())
+ .setTemplate(Location.INTERACTIVE, settings.getInteractiveTemplate())
.addSources(settings.getTemplates())
.addInclude(settings.getTemplateFileIncludePattern())
.addExclude(settings.getTemplateFileExcludePattern())
diff --git a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplier.java b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplier.java
index 976c4d4..c92c680 100644
--- a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplier.java
+++ b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplier.java
@@ -17,50 +17,40 @@
package org.apache.freemarker.generator.cli.config;
import org.apache.commons.io.FilenameUtils;
+import org.apache.freemarker.generator.base.FreeMarkerConstants.Configuration;
+import org.apache.freemarker.generator.base.FreeMarkerConstants.SystemProperties;
+import org.apache.freemarker.generator.base.util.StringUtils;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
-import java.util.Objects;
import java.util.function.Supplier;
import static java.util.Arrays.asList;
import static java.util.stream.Collectors.toList;
+import static org.apache.freemarker.generator.base.util.StringUtils.isNotEmpty;
/**
* Determine a list of directories to load a relative template file in the following order
* <ol>
* <li>User-defined template directory</li>
- * <li>Current working directory</li>
- * <li>~/.freemarker-cli</li>
+ * <li>~/.freemarker-generator</li>
* <li>Application installation directory</li>
* </ol>
*/
public class TemplateDirectorySupplier implements Supplier<List<File>> {
- /** Installation directory of "freemarker-cli" when invoked with shell wrapper */
- private static final String APP_HOME = "app.home";
+ /** Additional template directory, e.g. provided as command line parameter */
+ private final String additionalTemplateDirName;
- /** Current working directory when invoked with shell wrapper */
- private static final String USER_DIR = "user.dir";
-
- /** Home directory of the user */
- private static final String USER_HOME = "user.home";
-
- /** The user's optional "freemarker-cli" directory */
- private static final String USER_CONFIGURATION_DIR_NAME = ".freemarker-cli";
-
- /** User-defined template directory */
- private final String userDefinedTemplateDir;
-
- public TemplateDirectorySupplier(String userDefinedTemplateDir) {
- this.userDefinedTemplateDir = userDefinedTemplateDir;
+ public TemplateDirectorySupplier(String additionalTemplateDirName) {
+ this.additionalTemplateDirName = additionalTemplateDirName;
}
@Override
public List<File> get() {
return templateLoaderDirectories().stream()
- .filter(Objects::nonNull)
+ .filter(StringUtils::isNotEmpty)
.map(FilenameUtils::normalize)
.map(File::new)
.distinct()
@@ -70,28 +60,40 @@
private List<String> templateLoaderDirectories() {
return new ArrayList<>(asList(
- userTemplateDirName(),
- currentWorkingDirName(),
- userConfigDirName(),
- applicationDirName()
+ additionalTemplatesDirectory(),
+ userConfigTemplatesDirectory(),
+ applicationTemplatesDirectory()
));
}
- private String userTemplateDirName() {
- return userDefinedTemplateDir != null ? new File(userDefinedTemplateDir).getAbsolutePath() : null;
+ private String additionalTemplatesDirectory() {
+ return isNotEmpty(additionalTemplateDirName) ? new File(additionalTemplateDirName).getAbsolutePath() : null;
}
- private String userConfigDirName() {
- final String userHomeDir = System.getProperty(USER_HOME);
- return new File(userHomeDir, USER_CONFIGURATION_DIR_NAME).getAbsolutePath();
+ private String userConfigDirectory() {
+ final String userHomeDir = System.getProperty(SystemProperties.USER_HOME);
+ if (isNotEmpty(userHomeDir)) {
+ return new File(userHomeDir, Configuration.USER_CONFIGURATION_DIR_NAME).getAbsolutePath();
+ } else {
+ return null;
+ }
}
- private static String applicationDirName() {
- return System.getProperty(APP_HOME);
+ private String userConfigTemplatesDirectory() {
+ return templatesDirectory(userConfigDirectory());
}
- private static String currentWorkingDirName() {
- return System.getProperty(USER_DIR);
+ private static String applicationTemplatesDirectory() {
+ final String appHomeDir = System.getProperty(SystemProperties.APP_HOME);
+ return templatesDirectory(appHomeDir);
+ }
+
+ private static String templatesDirectory(String baseDirName) {
+ if (isNotEmpty(baseDirName)) {
+ return new File(baseDirName, "templates").getAbsolutePath();
+ } else {
+ return null;
+ }
}
private static boolean isDirectory(File directory) {
diff --git a/freemarker-generator-cli/src/main/resources/freemarker-cli.properties b/freemarker-generator-cli/src/main/resources/freemarker-cli.properties
deleted file mode 100644
index fd4a8f9..0000000
--- a/freemarker-generator-cli/src/main/resources/freemarker-cli.properties
+++ /dev/null
@@ -1,40 +0,0 @@
-## ---------------------------------------------------------------------------
-## Licensed to the Apache Software Foundation (ASF) under one or more
-## contributor license agreements. See the NOTICE file distributed with
-## this work for additional information regarding copyright ownership.
-## The ASF licenses this file to You under the Apache License, Version 2.0
-## (the "License"); you may not use this file except in compliance with
-## the License. You may obtain a copy of the License at
-##
-## http://www.apache.org/licenses/LICENSE-2.0
-##
-## Unless required by applicable law or agreed to in writing, software
-## distributed under the License is distributed on an "AS IS" BASIS,
-## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-## See the License for the specific language governing permissions and
-## limitations under the License.
-## ---------------------------------------------------------------------------
-
-#############################################################################
-# General FreeMarker Configuration
-# See https://freemarker.apache.org/docs/api/freemarker/template/Configuration.html#setSetting-java.lang.String-java.lang.String-
-#############################################################################
-# freemarker.configuration.setting.locale=JVM default
-
-#############################################################################
-# Configure FreeMarker Tools (name -> implementation class)
-#############################################################################
-freemarker.tools.csv=org.apache.freemarker.generator.tools.commonscsv.CommonsCSVTool
-freemarker.tools.dataframe=org.apache.freemarker.generator.tools.dataframe.DataFrameTool
-freemarker.tools.excel=org.apache.freemarker.generator.tools.excel.ExcelTool
-freemarker.tools.exec=org.apache.freemarker.generator.tools.commonsexec.CommonsExecTool
-freemarker.tools.freemarker=org.apache.freemarker.generator.tools.freemarker.FreeMarkerTool
-freemarker.tools.grok=org.apache.freemarker.generator.tools.grok.GrokTool
-freemarker.tools.gson=org.apache.freemarker.generator.tools.gson.GsonTool
-freemarker.tools.jsonpath=org.apache.freemarker.generator.tools.jsonpath.JsonPathTool
-freemarker.tools.jsoup=org.apache.freemarker.generator.tools.jsoup.JsoupTool
-freemarker.tools.properties=org.apache.freemarker.generator.tools.properties.PropertiesTool
-freemarker.tools.system=org.apache.freemarker.generator.tools.system.SystemTool
-freemarker.tools.uuid=org.apache.freemarker.generator.tools.uuid.UUIDTool
-freemarker.tools.xml=org.apache.freemarker.generator.tools.xml.XmlTool
-freemarker.tools.yaml=org.apache.freemarker.generator.tools.snakeyaml.SnakeYamlTool
diff --git a/freemarker-generator-cli/src/main/scripts/run-examples.bat b/freemarker-generator-cli/src/main/scripts/run-examples.bat
deleted file mode 100644
index 98d6654..0000000
--- a/freemarker-generator-cli/src/main/scripts/run-examples.bat
+++ /dev/null
@@ -1,171 +0,0 @@
-@ECHO OFF
-REM
-REM Licensed to the Apache Software Foundation (ASF) under one or more
-REM contributor license agreements. See the NOTICE file distributed with
-REM this work for additional information regarding copyright ownership.
-REM The ASF licenses this file to You under the Apache License, Version 2.0
-REM (the "License"); you may not use this file except in compliance with
-REM the License. You may obtain a copy of the License at
-REM
-REM http:\\www.apache.org\licenses\LICENSE-2.0
-REM
-REM Unless required by applicable law or agreed to in writing, software
-REM distributed under the License is distributed on an "AS IS" BASIS,
-REM WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-REM See the License for the specific language governing permissions and
-REM limitations under the License.
-REM
-
-REM Run all the samples being documented
-
-mkdir target 2>NULL
-mkdir target\out 2>NULL
-
-SET FREEMARKER_CMD=CALL .\bin\freemarker-cli.bat
-
-REM =========================================================================
-REM Info
-REM =========================================================================
-
-echo "templates\info.ftl"
-%FREEMARKER_CMD% -t templates\info.ftl README.md > target\out\info.txt
-
-REM =========================================================================
-REM Demo
-REM =========================================================================
-
-echo "examples\templates\demo.ftl"
-%FREEMARKER_CMD% -t examples\templates\demo.ftl README.md --output-encoding CP1252 > target\out\demo.txt
-
-REM =========================================================================
-REM Interactive Mode
-REM =========================================================================
-
-%FREEMARKER_CMD% -i '${tools.jsonpath.parse(dataSources.get(0)).read("""$.info.title""")}' examples\data\json\swagger-spec.json > target\out\interactive-json.txt
-%FREEMARKER_CMD% -i '${tools.xml.parse(dataSources.get(0))["""recipients/person[1]/name"""]}' examples\data\xml\recipients.xml > target\out\interactive-xml.txt
-%FREEMARKER_CMD% -i '${tools.jsoup.parse(dataSources.get(0)).select("""a""")[0]}' examples\data\html\dependencies.html > target\out\interactive-html.txt
-%FREEMARKER_CMD% -i '${tools.gson.toJson(tools.yaml.parse(dataSources.get(0)))}' examples\data\yaml\swagger-spec.yaml > target\out\interactive-swagger.json
-%FREEMARKER_CMD% -i '${tools.yaml.toYaml(tools.gson.parse(dataSources.get(0)))}' examples\data\json\swagger-spec.json > target\out\interactive-swagger.yaml
-%FREEMARKER_CMD% -i '${tools.dataframe.print(tools.dataframe.fromMaps(tools.gson.parse(dataSources.get(0))))}' examples\data\json\github-users.json > target\out\interactive-dataframe.txt
-
-REM =========================================================================
-REM CSV
-REM =========================================================================
-
-echo "templates\csv\html\transform.ftl"
-%FREEMARKER_CMD% -t templates\csv\html\transform.ftl examples\data\csv\contract.csv > target\out\contract.html
-
-echo "templates\csv\md\transform.ftl"
-%FREEMARKER_CMD% -t templates\csv\md\transform.ftl examples\data\csv\contract.csv > target\out\contract.md
-
-echo "examples\templates\csv\shell\curl.ftl"
-%FREEMARKER_CMD% -t .\examples\templates\csv\shell\curl.ftl examples\data\csv\user.csv > target\out\curl.sh
-
-echo "examples\templates\csv\md\filter.ftl"
-%FREEMARKER_CMD% -e UTF-8 -l de_AT -Pcolumn="Order ID" -Pvalues=226939189,957081544 -Pformat=DEFAULT -Pdelimiter=COMMA -t examples\templates\csv\md\filter.ftl examples\data\csv\sales-records.csv > target\out\sales-records.md
-
-REM =========================================================================
-REM CSV To XML-FO & PDF
-REM =========================================================================
-
-echo "examples\templates\csv\fo\transform.ftl"
-%FREEMARKER_CMD% -t examples\templates\csv\fo\transform.ftl examples\data\csv\locker-test-users.csv > target\out\locker-test-users.fo
-
-echo "examples\templates\csv\fo\transactions.ftl"
-%FREEMARKER_CMD% -t examples\templates\csv\fo\transactions.ftl examples\data\csv\transactions.csv > target\out\transactions.fo
-
-REM =========================================================================
-REM CSV to HTML & PDF
-REM =========================================================================
-
-echo "templates\csv\html\transform.ftl"
-%FREEMARKER_CMD% -t examples\templates\csv\html\transactions.ftl examples\data\csv\transactions.csv > target\out\transactions.html
-
-REM =========================================================================
-REM DataFrame
-REM =========================================================================
-
-echo "examples\templates\dataframe\example.ftl"
-%FREEMARKER_CMD% -PCSV_SOURCE_DELIMITER=SEMICOLON -PCSV_SOURCE_WITH_HEADER=true -t examples\templates\dataframe\example.ftl examples\data\csv\dataframe.csv > target\out\dataframe.txt
-
-REM =========================================================================
-REM Grok
-REM =========================================================================
-
-echo "examples\templates\accesslog\combined-access.ftl"
-%FREEMARKER_CMD% -t examples\templates\accesslog\combined-access.ftl examples\data\accesslog\combined-access.log > target\out\combined-access.log.txt
-
-REM =========================================================================
-REM Excel
-REM =========================================================================
-
-echo "examples\templates\excel\dataframe\transform.ftl"
-%FREEMARKER_CMD% -t examples\templates\excel\dataframe\transform.ftl examples\data\excel\test.xls > target\out\test.xls.dataframe.txt
-
-echo "templates\excel\html\transform.ftl"
-%FREEMARKER_CMD% -t templates\excel\html\transform.ftl examples\data\excel\test.xls > target\out\test.xls.html
-%FREEMARKER_CMD% -t templates\excel\html\transform.ftl examples\data\excel\test.xlsx > target\out\test.xslx.html
-%FREEMARKER_CMD% -t templates\excel\html\transform.ftl examples\data\excel\test-multiple-sheets.xlsx > target\out\test-multiple-sheets.xlsx.html
-
-echo "templates\excel\md\transform.ftl"
-%FREEMARKER_CMD% -t templates\excel\md\transform.ftl examples\data\excel\test-multiple-sheets.xlsx > target\out\test-multiple-sheets.xlsx.md
-
-echo "templates\excel\csv\transform.ftl"
-%FREEMARKER_CMD% -t templates\excel\csv\transform.ftl examples\data\excel\test-multiple-sheets.xlsx > target\out\test-multiple-sheets.xlsx.csv
-
-echo "examples\templates\excel\csv\custom.ftl"
-%FREEMARKER_CMD% -t examples\templates\excel\csv\custom.ftl -Pcsv.format=MYSQL examples\data\excel\test.xls > target\out\test-transform-xls.csv
-
-REM =========================================================================
-REM HTML
-REM =========================================================================
-
-echo "examples\templates\html\csv\dependencies.ftl"
-%FREEMARKER_CMD% -t examples\templates\html\csv\dependencies.ftl examples\data\html\dependencies.html > target\out\dependencies.csv
-
-REM =========================================================================
-REM JSON
-REM =========================================================================
-
-echo "examples\templates\json\csv\swagger-endpoints.ftl"
-%FREEMARKER_CMD% -t examples\templates\json\csv\swagger-endpoints.ftl examples\data\json\swagger-spec.json > target\out\swagger-spec.csv
-
-echo "templates\json\yaml\transform.ftl"
-%FREEMARKER_CMD% -t templates\json\yaml\transform.ftl examples\data\json\swagger-spec.json > target\out\swagger-spec.yaml
-
-echo "examples\templates\json\md\github-users.ftl"
-%FREEMARKER_CMD% -t examples\templates\json\md\github-users.ftl examples\data\json\github-users.json > target\out\github-users.md
-
-REM =========================================================================
-REM Properties
-REM =========================================================================
-
-echo "examples\templates\properties\csv\locker-test-users.ftl"
-%FREEMARKER_CMD% -t examples\templates\properties\csv\locker-test-users.ftl examples\data\properties > target\out\locker-test-users.csv
-
-REM =========================================================================
-REM Template Directory
-REM =========================================================================
-
-echo "examples\data\template"
-%FREEMARKER_CMD% -t examples\data\template -PNGINX_HOSTNAME=localhost -o target\out\template
-
-REM =========================================================================
-REM YAML
-REM =========================================================================
-
-echo "examples\templates\yaml\txt\transform.ftl"
-%FREEMARKER_CMD% -t examples\templates\yaml\txt\transform.ftl examples\data\yaml\customer.yaml > target\out\customer.txt
-
-echo "templates\yaml\json\transform.ftl"
-%FREEMARKER_CMD% -t templates\yaml\json\transform.ftl examples\data\yaml\swagger-spec.yaml > target\out\swagger-spec.json
-
-REM =========================================================================
-REM XML
-REM =========================================================================
-
-echo "examples\templates\xml\txt\recipients.ftl"
-%FREEMARKER_CMD% -t .\examples\templates\xml\txt\recipients.ftl examples\data\xml\recipients.xml > target\out\recipients.txt
-
-echo "Created the following sample files in .\target\out"
-dir .\target\out
\ No newline at end of file
diff --git a/freemarker-generator-cli/src/main/scripts/run-examples.sh b/freemarker-generator-cli/src/main/scripts/run-examples.sh
deleted file mode 100755
index f18c9e2..0000000
--- a/freemarker-generator-cli/src/main/scripts/run-examples.sh
+++ /dev/null
@@ -1,191 +0,0 @@
-#!/bin/sh
-
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-# Check that java is on the path
-
-hash java 2>/dev/null || { echo >&2 "I require JDK but it's not installed. Aborting."; exit 1; }
-
-# Run all the samples being documented
-
-mkdir target 2>/dev/null
-mkdir target/out 2>/dev/null
-
-FREEMARKER_CMD=./bin/freemarker-cli
-
-#############################################################################
-# Info
-#############################################################################
-
-echo "templates/info.ftl"
-$FREEMARKER_CMD -t templates/info.ftl README.md > target/out/info.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# Demo
-#############################################################################
-
-echo "examples/templates/demo.ftl"
-$FREEMARKER_CMD -t examples/templates/demo.ftl README.md > target/out/demo.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# Interactive Mode
-#############################################################################
-
-$FREEMARKER_CMD -i '${tools.jsonpath.parse(dataSources.get(0)).read("$.info.title")}' examples/data/json/swagger-spec.json > target/out/interactive-json.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-$FREEMARKER_CMD -i '${tools.xml.parse(dataSources.get(0))["recipients/person[1]/name"]}' examples/data/xml/recipients.xml > target/out/interactive-xml.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-$FREEMARKER_CMD -i '${tools.jsoup.parse(dataSources.get(0)).select("a")[0]}' examples/data/html/dependencies.html > target/out/interactive-html.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-$FREEMARKER_CMD -i '${tools.gson.toJson(tools.yaml.parse(dataSources.get(0)))}' examples/data/yaml/swagger-spec.yaml > target/out/interactive-swagger.json || { echo >&2 "Test failed. Aborting."; exit 1; }
-$FREEMARKER_CMD -i '${tools.yaml.toYaml(tools.gson.parse(dataSources.get(0)))}' examples/data/json/swagger-spec.json > target/out/interactive-swagger.yaml || { echo >&2 "Test failed. Aborting."; exit 1; }
-$FREEMARKER_CMD -i '${tools.dataframe.print(tools.dataframe.fromMaps(tools.gson.parse(dataSources.get(0))))}' examples/data/json/github-users.json > target/out/interactive-dataframe.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# CSV
-#############################################################################
-
-echo "templates/csv/html/transform.ftl"
-$FREEMARKER_CMD -t templates/csv/html/transform.ftl examples/data/csv/contract.csv > target/out/contract.html || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "templates/csv/md/transform.ftl"
-$FREEMARKER_CMD -t templates/csv/md/transform.ftl examples/data/csv/contract.csv > target/out/contract.md || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "examples/templates/csv/shell/curl.ftl"
-$FREEMARKER_CMD -t ./examples/templates/csv/shell/curl.ftl examples/data/csv/user.csv > target/out/curl.sh || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "examples/templates/csv/md/filter.ftl"
-$FREEMARKER_CMD -e UTF-8 -l de_AT -Pcolumn="Order ID" -Pvalues=226939189,957081544 -Pformat=DEFAULT -Pdelimiter=COMMA -t examples/templates/csv/md/filter.ftl examples/data/csv/sales-records.csv > target/out/sales-records.md || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# CSV To XML-FO & PDF
-#############################################################################
-
-echo "examples/templates/csv/fo/transform.ftl"
-$FREEMARKER_CMD -t examples/templates/csv/fo/transform.ftl examples/data/csv/locker-test-users.csv > target/out/locker-test-users.fo || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-if hash fop 2>/dev/null; then
- echo "fop -fo target/out/locker-test-users.fo target/out/locker-test-users.pdf"
- fop -fo target/out/locker-test-users.fo target/out/locker-test-users.pdf 2>/dev/null || { echo >&2 "Test failed. Aborting."; exit 1; }
-fi
-
-echo "examples/templates/csv/fo/transactions.ftl"
-$FREEMARKER_CMD -t examples/templates/csv/fo/transactions.ftl examples/data/csv/transactions.csv > target/out/transactions.fo || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-if hash fop 2>/dev/null; then
- echo "fop -fo target/out/transactions.fo target/out/transactions-fo.pdf"
- fop -fo target/out/transactions.fo target/out/transactions-fo.pdf 2>/dev/null || { echo >&2 "Test failed. Aborting."; exit 1; }
-fi
-
-#############################################################################
-# CSV to HTML & PDF
-#############################################################################
-
-echo "templates/csv/html/transform.ftl"
-$FREEMARKER_CMD -t examples/templates/csv/html/transactions.ftl examples/data/csv/transactions.csv > target/out/transactions.html || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-if hash wkhtmltopdf 2>/dev/null; then
- echo "wkhtmltopdf -O landscape target/out/transactions.html target/out/transactions-html.pdf"
- wkhtmltopdf -O landscape target/out/transactions.html target/out/transactions-html.pdf 2>/dev/null || { echo >&2 "Test failed. Aborting."; exit 1; }
-fi
-
-#############################################################################
-# DataFrame
-#############################################################################
-
-echo "examples/templates/dataframe/example.ftl"
-$FREEMARKER_CMD -PCSV_SOURCE_DELIMITER=SEMICOLON -PCSV_SOURCE_WITH_HEADER=true -t examples/templates/dataframe/example.ftl examples/data/csv/dataframe.csv > target/out/dataframe.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# Grok
-#############################################################################
-
-echo "examples/templates/accesslog/combined-access.ftl"
-$FREEMARKER_CMD -t examples/templates/accesslog/combined-access.ftl examples/data/accesslog/combined-access.log > target/out/combined-access.log.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# Excel
-#############################################################################
-
-echo "examples/templates/excel/dataframe/transform.ftl"
-$FREEMARKER_CMD -t examples/templates/excel/dataframe/transform.ftl examples/data/excel/test.xls > target/out/test.xls.dataframe.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "templates/excel/html/transform.ftl"
-$FREEMARKER_CMD -t templates/excel/html/transform.ftl examples/data/excel/test.xls > target/out/test.xls.html || { echo >&2 "Test failed. Aborting."; exit 1; }
-$FREEMARKER_CMD -t templates/excel/html/transform.ftl examples/data/excel/test.xlsx > target/out/test.xslx.html || { echo >&2 "Test failed. Aborting."; exit 1; }
-$FREEMARKER_CMD -t templates/excel/html/transform.ftl examples/data/excel/test-multiple-sheets.xlsx > target/out/test-multiple-sheets.xlsx.html || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "templates/excel/md/transform.ftl"
-$FREEMARKER_CMD -t templates/excel/md/transform.ftl examples/data/excel/test-multiple-sheets.xlsx > target/out/test-multiple-sheets.xlsx.md || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "templates/excel/csv/transform.ftl"
-$FREEMARKER_CMD -t templates/excel/csv/transform.ftl examples/data/excel/test-multiple-sheets.xlsx > target/out/test-multiple-sheets.xlsx.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "examples/templates/excel/csv/custom.ftl"
-$FREEMARKER_CMD -t examples/templates/excel/csv/custom.ftl -Pcsv.format=MYSQL examples/data/excel/test.xls > target/out/test-transform-xls.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# HTML
-#############################################################################
-
-echo "examples/templates/html/csv/dependencies.ftl"
-$FREEMARKER_CMD -t examples/templates/html/csv/dependencies.ftl examples/data/html/dependencies.html > target/out/dependencies.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# JSON
-#############################################################################
-
-echo "examples/templates/json/csv/swagger-endpoints.ftl"
-$FREEMARKER_CMD -t examples/templates/json/csv/swagger-endpoints.ftl examples/data/json/swagger-spec.json > target/out/swagger-spec.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "templates/json/yaml/transform.ftl"
-$FREEMARKER_CMD -t templates/json/yaml/transform.ftl examples/data/json/swagger-spec.json > target/out/swagger-spec.yaml || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "examples/templates/json/md/github-users.ftl"
-$FREEMARKER_CMD -t examples/templates/json/md/github-users.ftl examples/data/json/github-users.json > target/out/github-users.md || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# Properties
-#############################################################################
-
-echo "examples/templates/properties/csv/locker-test-users.ftl"
-$FREEMARKER_CMD -t examples/templates/properties/csv/locker-test-users.ftl examples/data/properties > target/out/locker-test-users.csv || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# Template Directory
-#############################################################################
-
-echo "examples/data/template"
-$FREEMARKER_CMD -t examples/data/template -PNGINX_HOSTNAME=localhost -o target/out/template || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# YAML
-#############################################################################
-
-echo "examples/templates/yaml/txt/transform.ftl"
-$FREEMARKER_CMD -t examples/templates/yaml/txt/transform.ftl examples/data/yaml/customer.yaml > target/out/customer.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "templates/yaml/json/transform.ftl"
-$FREEMARKER_CMD -t templates/yaml/json/transform.ftl examples/data/yaml/swagger-spec.yaml > target/out/swagger-spec.json || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-#############################################################################
-# XML
-#############################################################################
-
-echo "examples/templates/xml/txt/recipients.ftl"
-$FREEMARKER_CMD -t ./examples/templates/xml/txt/recipients.ftl examples/data/xml/recipients.xml > target/out/recipients.txt || { echo >&2 "Test failed. Aborting."; exit 1; }
-
-echo "Created the following sample files in ./target/out"
-ls -l ./target/out
\ No newline at end of file
diff --git a/freemarker-generator-cli/src/site/markdown/cli/advanced/cli-configuration.md b/freemarker-generator-cli/src/site/markdown/cli/advanced/cli-configuration.md
index 96353fd..bb8b8ca 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/advanced/cli-configuration.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/advanced/cli-configuration.md
@@ -1,14 +1,14 @@
## CLI Configuration
-The `Apache FreeMarker CLI` configuration can be tweaked to
+The `Apache FreeMarker Generator` configuration can be tweaked to
* Change the underlying `Apache FreeMarker Configuration`
* Instantiate custom tools
* Storing user-specific templates
-### Apache FreeMarker CLI Properties File
+### Apache FreeMarker Generator Properties File
-`Apache FreeMarker CLI` reads the `conf/freemarker-cli.properties`
+`Apache FreeMarker Generator` reads the `conf/freemarker-generator.properties`
```
#############################################################################
@@ -42,11 +42,11 @@
Over the time you will accumulate more and more `Apache FreeMarker` templates - some of them are stored within a project but some of the more general might be free-floating and you don't want to store them in the installation directory.
-To give those free-floating templates a home `Apache FreeMarker CLI` tries to read templates from `~/freemarker-cli`, e.g.
+To give those free-floating templates a home `Apache FreeMarker Generator CLI` tries to read templates from `~/freemarker-generator`, e.g.
```
-tree ~/.freemarker-cli/
-/Users/sgoeschl/.freemarker-cli/
+tree ~/.freemarker-generator/
+/Users/sgoeschl/.freemarker-generator/
`-- templates
`-- json
|-- confluence
@@ -62,16 +62,16 @@
`-- customer-user-products.ftl
```
-If a `~/freemarker-cli` is found it will be automatically added to the `FreeMarker Template Loader` (for more information see https://freemarker.apache.org/docs/pgui_config_templateloading.html)
+If a `~/freemarker-generator` is found it will be automatically added to the `FreeMarker Template Loader` (for more information see https://freemarker.apache.org/docs/pgui_config_templateloading.html)
You can easily check this, e.g.
```
-> freemarker-cli -t templates/info.ftl
+> freemarker-generator -t freemarker-generator/info.ftl
-FreeMarker CLI Template Loader Directories
+FreeMarker Generator Template Loader Directories
------------------------------------------------------------------------------
[#1] /Users/sgoeschl
-[#2] /Users/sgoeschl/.freemarker-cli
-[#3] /Applications/Java/freemarker-cli-2.0.0
+[#2] /Users/sgoeschl/.freemarker-generator
+[#3] /Applications/Java/freemarker-generator-2.0.0
```
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md
index 65aac2a..bd56d76 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md
@@ -24,7 +24,7 @@
"year": "2020"
}
-> freemarker-cli --data-model https://xkcd.com/info.0.json -i '<a href="${img}">${title}</a>'; echo
+> freemarker-generator --data-model https://xkcd.com/info.0.json -i '<a href="${img}">${title}</a>'; echo
<a href="https://imgs.xkcd.com/comics/old_days_2.png">Old Days 2</a>
```
@@ -39,14 +39,14 @@
"userId": 1
}
-> freemarker-cli --data-model post=https://jsonplaceholder.typicode.com/posts/2 -i 'post title is: ${post.title}'; echo
+> freemarker-generator --data-model post=https://jsonplaceholder.typicode.com/posts/2 -i 'post title is: ${post.title}'; echo
post title is: qui est esse
```
Expose all environment variables as `env` in theFreeMarker model
```
-> freemarker-cli --data-model env=env:/// -i '<#list env as name,value>${name}=${value}${"\n"}</#list>'
+> freemarker-generator --data-model env=env:/// -i '<#list env as name,value>${name}=${value}${"\n"}</#list>'
HOME=/Users/sgoeschl
USER=sgoeschl
```
@@ -54,14 +54,14 @@
Expose a single environment variable in theFreeMarker model
```
-> freemarker-cli --data-model NAME=env:///USER -i 'Hello ${NAME}'; echo
+> freemarker-generator --data-model NAME=env:///USER -i 'Hello ${NAME}'; echo
Hello sgoeschl
```
Alternatively use the short command line options, e.g.
```
-> freemarker-cli -m NAME=env:///USER -i 'Hello ${NAME}!'; echo
+> freemarker-generator -m NAME=env:///USER -i 'Hello ${NAME}!'; echo
Hello sgoeschl!
```
@@ -74,7 +74,7 @@
> export DB_CONFIG='{"db_default_user":"scott","db_default_password":"tiger"}'
> echo $DB_CONFIG
{"db_default_user":"scott","db_default_password":"tiger"}
-> freemarker-cli -m config=env:///DB_CONFIG#mimeType=application/json -i '<#list config as name,value>${name}=${value}${"\n"}</#list>'
+> freemarker-generator -m config=env:///DB_CONFIG#mimeType=application/json -i '<#list config as name,value>${name}=${value}${"\n"}</#list>'
db_default_user=scott
db_default_password=tiger
```
\ No newline at end of file
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-sources.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-sources.md
index 6d048ab..d0cdef7 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-sources.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-sources.md
@@ -13,9 +13,9 @@
A `DataSource` can be loaded from the file system, e.g. as positional command line argument
```
-freemarker-cli -t templates/info.ftl README.md
+freemarker-cli -t freemarker-generator/info.ftl README.md
-FreeMarker CLI DataSources
+FreeMarker Generator DataSources
------------------------------------------------------------------------------
[#1], name=README.md, group=default, contentType=text/markdown, charset=UTF-8, length=57,188 Bytes
URI : file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/README.md
@@ -24,9 +24,9 @@
from an URL
```
-freemarker-cli --data-source xkcd=https://xkcd.com/info.0.json -t templates/info.ftl
+freemarker-cli --data-source xkcd=https://xkcd.com/info.0.json -t freemarker-generator/info.ftl
-FreeMarker CLI DataSources
+FreeMarker Generator DataSources
------------------------------------------------------------------------------
[#1], name=xkcd, group=default, contentType=application/json, charset=UTF-8, length=-1 Bytes
URI : https://xkcd.com/info.0.json
@@ -36,9 +36,9 @@
```
export NGINX_CONF='{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}'
-freemarker-cli -t templates/info.ftl -s conf=env:///NGINX_CONF#mimeType=application/json
+freemarker-cli -t freemarker-generator/info.ftl -s conf=env:///NGINX_CONF#mimeType=application/json
-FreeMarker CLI DataSources
+FreeMarker Generator DataSources
------------------------------------------------------------------------------
[#1], name=conf, group=default, contentType=application/json, charset=UTF-8, length=50 Bytes
URI : env:///NGINX_CONF
@@ -47,9 +47,9 @@
Of course you can load multiple `DataSources` directly
```
-freemarker-cli -t templates/info.ftl README.md xkcd=https://xkcd.com/info.0.json
+freemarker-cli -t freemarker-generator/info.ftl README.md xkcd=https://xkcd.com/info.0.json
-FreeMarker CLI DataSources
+FreeMarker Generator DataSources
------------------------------------------------------------------------------
[#1], name=README.md, group=default, contentType=text/markdown, charset=UTF-8, length=57,188 Bytes
URI : file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/README.md
@@ -60,8 +60,8 @@
or load them from a directory
```
-freemarker-cli -t templates/info.ftl -s examples/data
-FreeMarker CLI DataSources
+freemarker-cli -t freemarker-generator/info.ftl -s examples/data
+FreeMarker Generator DataSources
------------------------------------------------------------------------------
[#1], name=combined-access.log, group=default, contentType=text/plain, charset=UTF-8, length=2,068 Bytes
URI : file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/accesslog/combined-access.log
@@ -74,9 +74,9 @@
which can be combined with `include` and `exclude` filters
```
-freemarker-cli -t templates/info.ftl -s examples/data --data-source-include=*.json
+freemarker-cli -t freemarker-generator/info.ftl -s examples/data --data-source-include=*.json
-FreeMarker CLI DataSources
+FreeMarker Generator DataSources
------------------------------------------------------------------------------
[#1], name=github-users.json, group=default, contentType=application/json, charset=UTF-8, length=7,168 Bytes
URI : file:/Users/sgoeschl/work/github/apache/freemarker-generator/freemarker-generator-cli/target/appassembler/examples/data/json/github-users.json
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/named-uris.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/named-uris.md
index 0e833d1..b2c2fe3 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/named-uris.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/named-uris.md
@@ -29,7 +29,7 @@
The following Named URI loads a "user.csv" and the data source is available as `my_users`
```
-freemarker-cli -t templates/info.ftl my_users=examples/data/csv/user.csv
+freemarker-cli -t freemarker-generator/info.ftl my_users=examples/data/csv/user.csv
[#1], name=my_users, group=default, contentType=text/csv, charset=UTF-8, length=376 Bytes
URI : file:examples/data/csv/user.csv
```
@@ -37,7 +37,7 @@
A Named URI allows to pass additional information as part of the fragment, e.g. the charset of the text file
```
-freemarker-cli -t templates/info.ftl my_users=examples/data/csv/user.csv#charset=UTF-16
+freemarker-cli -t freemarker-generator/info.ftl my_users=examples/data/csv/user.csv#charset=UTF-16
[#1], name=my_users, group=default, contentType=text/csv, charset=UTF-16, length=376 Bytes
URI : file:examples/data/csv/user.csv
```
@@ -45,7 +45,7 @@
In addition to the simplified file syntax full URIs can be used
```
-freemarker-cli -t templates/info.ftl http://google.com?foo=bar
+freemarker-cli -t freemarker-generator/info.ftl http://google.com?foo=bar
[#1], name=google.com, group=default, contentType=text/html, charset=ISO-8859-1, length=-1 Bytes
URI : http://google.com?foo=bar
```
@@ -53,7 +53,7 @@
and also combined with a name
```
-freemarker-cli -t templates/info.ftl page=http://google.com?foo=bar
+freemarker-cli -t freemarker-generator/info.ftl page=http://google.com?foo=bar
[#1], name=page, group=default, contentType=text/html, charset=ISO-8859-1, length=-1 Bytes
URI : http://google.com?foo=bar
```
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md
index eb6110e..d181c01 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md
@@ -1,6 +1,6 @@
## Passing Configuration Data
-`Apache FreeMarker CLI` provides multiple ways to pass configuration data used in in templates
+`Apache FreeMarker Generator CLI` provides multiple ways to pass configuration data used in in templates
* System properties
* Parameters
@@ -10,7 +10,7 @@
User-supplied system properties are added to the JVM's system properties
```
-> freemarker-cli -Dfoo1=foo1 -D foo2=foo2 -t templates/info.ftl
+> freemarker-generator -Dfoo1=foo1 -D foo2=foo2 -t freemarker-generator/info.ftl
```
### User-Supplied Parameters
@@ -23,7 +23,7 @@
Pass a simple name/value pair on the command line
```
-> freemarker-cli -t templates/info.ftl -P key=value
+> freemarker-generator -t freemarker-generator/info.ftl -P key=value
User Supplied Parameters
------------------------------------------------------------------------------
@@ -33,7 +33,7 @@
By providing a `group` you can create nested maps
```
-> freemarker-cli -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2
+> freemarker-generator -t freemarker-generator/info.ftl -P foo1:group=bar1 -P foo2:group=bar2
User Supplied Parameters
------------------------------------------------------------------------------
@@ -43,7 +43,7 @@
It is also possible to mix and match the two approaches
```
-> freemarker-cli -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2 -P key=value
+> freemarker-generator -t freemarker-generator/info.ftl -P foo1:group=bar1 -P foo2:group=bar2 -P key=value
User Supplied Parameters
------------------------------------------------------------------------------
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/template-loading.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/template-loading.md
index 30e9404..9de70b6 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/template-loading.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/template-loading.md
@@ -8,34 +8,34 @@
### FreeMarker MultiTemplateLoader
-`Apache FreeMarker CLI` uses a `MultiTemplateLoader` searching for templates in the following directories
+`Apache FreeMarker Generator CLI` uses a `MultiTemplateLoader` searching for templates in the following directories
* Current working directory
-* Optional `~/.freemarker-cli` directory
-* `Apache FreeMarker CLI` installation directory
+* Optional `~/.freemarker-generator` directory
+* `Apache FreeMarker Generator` installation directory
You can check the currently used template loader directories easily on the command line, e.g.
```
-freemarker-cli -t templates/info.ftl
+freemarker-generator -t freemarker-generator/info.ftl
-FreeMarker CLI Template Loader Directories
+FreeMarker Generator Template Loader Directories
------------------------------------------------------------------------------
[#1] /Users/sgoeschl/work/github/apache/freemarker-generator
-[#2] /Users/sgoeschl/.freemarker-cli
-[#3] /Applications/Java/freemarker-cli-2.0.0
+[#2] /Users/sgoeschl/.freemarker-generator
+[#3] /Applications/Java/freemarker-generator-2.0.0
```
The main benefit of `MultiTemplateLoader` is the use of abstract template paths finding a template in the template loader directories
```
-freemarker-cli -t templates/info.ftl
+freemarker-generator -t freemarker-generator/info.ftl
```
and [Template Includes](https://freemarker.apache.org/docs/ref_directive_include.html)
```
-<#import "/templates/lib/commons-csv.ftl" as csv />
+<#import "/lib/commons-csv.ftl" as csv />
```
### Free-Style Template Loading
@@ -47,7 +47,7 @@
This example loads the `info.ftl` directly from a GitHub URL
```
-freemarker-cli -t https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/templates/info.ftl
+freemarker-generator -t https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/templates/info.ftl
```
### Interactive Template Loading
@@ -55,6 +55,6 @@
The template can be defined directly on the command line in case of trivial transformations
```
-freemarker-cli -i '${tools.gson.toJson(yaml)}' -m yaml=examples/data/yaml/swagger-spec.yaml
+freemarker-generator -i '${tools.gson.toJson(yaml)}' -m yaml=examples/data/yaml/swagger-spec.yaml
```
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/tools.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/tools.md
index c07a01a..c5bb4da 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/tools.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/tools.md
@@ -1,6 +1,6 @@
## Tools
-A `Apache FreeMarker CLI Tool` is just a POJO (plain old Java object) that is "useful" in a template and is not meant to be rendered in the output.
+A `Apache FreeMarker Generator Tool` is just a POJO (plain old Java object) that is "useful" in a template and is not meant to be rendered in the output.
The following tools are currently implemented
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/transformation.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/transformation.md
index 73477eb..03a9b3a 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/transformation.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/transformation.md
@@ -1,6 +1,6 @@
## Transformation
-The `freemarker-cli` generates text output based on processing FreeMarker templates and data
+The `freemarker-generator` generates text output based on processing FreeMarker templates and data
* A command line invocation requires 1..n `templates` and 0..n `data sources` / `data models`
* A command line invocation is mapped to a series of `template transformations`
@@ -18,17 +18,17 @@
Transforming a single template to a single output file
```
-freemarker-cli \
--t templates/csv/md/transform.ftl examples/data/csv/contract.csv \
+freemarker-generator \
+-t freemarker-generator/csv/md/transform.ftl examples/data/csv/contract.csv \
-o target/contract.md
```
Transforming multiple templates to multiple output files (1:1 mapping between templates and outputs)
```
-> freemarker-cli \
--t templates/csv/md/transform.ftl -o target/contract.md \
--t templates/csv/html/transform.ftl -o target/contract.html \
+> freemarker-generator \
+-t freemarker-generator/csv/md/transform.ftl -o target/contract.md \
+-t freemarker-generator/csv/html/transform.ftl -o target/contract.html \
examples/data/csv/contract.csv
> tree target
@@ -40,7 +40,7 @@
Transforming single template directory to single output directory
```
-> freemarker-cli \
+> freemarker-generator \
-t examples/data/template -o target/template1
> tree target
@@ -56,7 +56,7 @@
Transforming multiple template directories to multiple output directories
```
-freemarker-cli \
+freemarker-generator \
-t examples/data/template -o target/template1 \
-t examples/data/template -o target/template2
diff --git a/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md b/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
index e2f0de4..74deace 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
@@ -5,87 +5,90 @@
* Requires JDK 1.8+ on Linux, Mac OSX and Windows
* Download [freemarker-generator-cli-0.1.0-SNAPSHOT-app.tar.gz] or [freemarker-generator-cli-0.1.0-SNAPSHOT-app.zip]
* Unpack the archive in a directory of your choice
-* Add the `bin/freemarker-cli` or `bin/freemarker-cli.bat` to your `PATH` variable
+* Add the `bin/freemarker-generator` or `bin/freemarker-generator.bat` to your `PATH` variable
### Verify Installation
On my local box (Mac OS 10.15.5) I use the following setup
```
-export FREEMARKER_CLI_HOME=/Applications/Java/freemarker-cli-2.0.0
+export FREEMARKER_CLI_HOME=/Applications/Java/freemarker-generator-2.0.0
export PATH=$PATH:$FREEMARKER_CLI_HOME/bin
```
-Afterwards `Apache FreeMarker CLI` can be executed from the command line
+Afterwards `Apache FreeMarker Generator` can be executed from the command line
```
-> which freemarker-cli
-/Applications/Java/freemarker-cli-2.0.0/bin/freemarker-cli
+> which freemarker-generator
+/Applications/Java/freemarker-generator-2.0.0/bin/freemarker-generator
```
-and check the version of `Apache FreeMarker CLI`
+and check the version of `Apache FreeMarker Generator`
```
-> freemarker-cli -V
+> freemarker-generator -V
version=0.1.0-SNAPSHOT, time=2020-06-25T21:48:02+0200, commit=b320d00094be8789086ad6153d9d3fcaf4b8c75f
```
### Command Line Options
-`Apache FreeMarker CLI` provides command line help as shown below
+`Apache FreeMarker Generator` provides command line help as shown below
```
-> freemarker-cli -h
- Usage: freemarker-cli (-t=<templates> [-t=<templates>]... |
- -i=<interactiveTemplate>) [-hV] [--stdin] [-b=<baseDir>]
- [--config=<configFile>]
- [--data-source-exclude=<dataSourceExcludePattern>]
- [--data-source-include=<dataSourceIncludePattern>]
- [-e=<inputEncoding>] [-l=<locale>]
- [--output-encoding=<outputEncoding>] [--times=<times>]
- [-D=<String=String>]... [-m=<dataModels>]...
- [-o=<outputs>]... [-P=<String=String>]...
- [-s=<dataSources>]... [<sources>...]
- Apache FreeMarker CLI
- [<sources>...] data source files and/or directories
- -b, --basedir=<baseDir> additional template base directory
- --config=<configFile> FreeMarker CLI configuration file
- -D, --system-property=<String=String>
- set system property
- --data-source-exclude=<dataSourceExcludePattern>
- file exclude pattern for data sources
- --data-source-include=<dataSourceIncludePattern>
- file include pattern for data sources
- -e, --input-encoding=<inputEncoding>
- encoding of data source
- -h, --help Show this help message and exit.
- -i, --interactive=<interactiveTemplate>
- interactive template to process
- -l, --locale=<locale> locale being used for the output, e.g. 'en_US'
- -m, --data-model=<dataModels>
- data model used for rendering
- -o, --output=<outputs> output files or directories
- --output-encoding=<outputEncoding>
- encoding of output, e.g. UTF-8
- -P, --param=<String=String>
- set parameter
- -s, --data-source=<dataSources>
- data source used for rendering
- --stdin read data source from stdin
- -t, --template=<templates>
- templates to process
- --times=<times> re-run X times for profiling
- -V, --version Print version information and exit.
+> freemarker-generator -h
+Usage: freemarker-generator (-t=<templates> [-t=<templates>]... |
+ -i=<interactiveTemplate>) [-hV] [--stdin]
+ [--config=<configFile>]
+ [--data-source-exclude=<dataSourceExcludePattern>]
+ [--data-source-include=<dataSourceIncludePattern>]
+ [-e=<inputEncoding>] [-l=<locale>]
+ [--output-encoding=<outputEncoding>]
+ [--template-dir=<templateDir>] [--times=<times>]
+ [-D=<String=String>]... [-m=<dataModels>]...
+ [-o=<outputs>]... [-P=<String=String>]...
+ [-s=<dataSources>]... [<sources>...]
+Apache FreeMarker Generator
+ [<sources>...] data source files and/or directories
+ --config=<configFile>
+ FreeMarker Generator configuration file
+ -D, --system-property=<String=String>
+ set system property
+ --data-source-exclude=<dataSourceExcludePattern>
+ file exclude pattern for data sources
+ --data-source-include=<dataSourceIncludePattern>
+ file include pattern for data sources
+ -e, --input-encoding=<inputEncoding>
+ encoding of data source
+ -h, --help Show this help message and exit.
+ -i, --interactive=<interactiveTemplate>
+ interactive template to process
+ -l, --locale=<locale> locale being used for the output, e.g. 'en_US'
+ -m, --data-model=<dataModels>
+ data model used for rendering
+ -o, --output=<outputs> output files or directories
+ --output-encoding=<outputEncoding>
+ encoding of output, e.g. UTF-8
+ -P, --param=<String=String>
+ set parameter
+ -s, --data-source=<dataSources>
+ data source used for rendering
+ --stdin read data source from stdin
+ -t, --template=<templates>
+ templates to process
+ --template-dir=<templateDir>
+ additional template directory
+ --times=<times> re-run X times for profiling
+ -V, --version Print version information and exit.
```
### The Info Template
The distribution ships with a couple of FreeMarker templates and the `templates/info.ftl` is particularly helpful
-to better understand `Apache FreeMarker CLI`
+to better understand `Apache FreeMarker Generator`
```
-> freemarker-cli -t templates/info.ftl
-FreeMarker CLI Information
+> freemarker-generator -t freemarker-generator/info.ftl
+FreeMarker Generator Information
------------------------------------------------------------------------------
FreeMarker version : 2.3.30
Template name : templates/info.ftl
@@ -95,13 +98,13 @@
Output encoding : UTF-8
Output format : plainText
-FreeMarker CLI Template Loader Directories
+FreeMarker Generator Template Loader Directories
------------------------------------------------------------------------------
[#1] /Users/sgoeschl/work/github/apache/freemarker-generator
-[#2] /Users/sgoeschl/.freemarker-cli
-[#3] /Applications/Java/freemarker-cli-2.0.0
+[#2] /Users/sgoeschl/.freemarker-generator
+[#3] /Applications/Java/freemarker-generator-2.0.0
-FreeMarker CLI Tools
+FreeMarker Generator Tools
------------------------------------------------------------------------------
- CSVTool : Process CSV files using Apache Commons CSV (see https://commons.apache.org/proper/commons-csv/)
- DataFrameTool : Bridge to [nRo/DataFrame](https://github.com/nRo/DataFrame)
@@ -118,7 +121,7 @@
- XmlTool : Process XML files using Apache FreeMarker (see https://freemarker.apache.org/docs/xgui.html)
- YamlTool : Process YAML files using SnakeYAML(see https://bitbucket.org/asomov/snakeyaml/wiki/Home)
-FreeMarker CLI Data Model
+FreeMarker Generator Data Model
---------------------------------------------------------------------------
- CSVTool
- DataFrameTool
@@ -137,7 +140,7 @@
- YamlTool
```
-* The "FreeMarker CLI Information" section provides insights into configuration and currently processed template.
-* The "FreeMarker CLI Template Loader Directories" shows the template directories being searched to resolve a template path
-* The "FreeMarker CLI Tools" section list the available tools
-* The "FreeMarker CLI Data Model" section shows all available entries in the current FreeMarker context
+* The "FreeMarker Generator Information" section provides insights into configuration and currently processed template.
+* The "FreeMarker Generator Template Loader Directories" shows the template directories being searched to resolve a template path
+* The "FreeMarker Generator Tools" section list the available tools
+* The "FreeMarker Generator Data Model" section shows all available entries in the current FreeMarker context
diff --git a/freemarker-generator-cli/src/site/markdown/cli/usage/running-examples.md b/freemarker-generator-cli/src/site/markdown/cli/usage/running-examples.md
index ec19b06..d13b2f2 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/usage/running-examples.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/usage/running-examples.md
@@ -2,7 +2,7 @@
There a many examples (see below) available you can execute - The examples were tested with JDK 1.8 on Mac OS X.
-Run `run-examples.sh` in the `Apache Freemarker CLI` installation directory and have a look at the generated output.
+Run `run-examples.sh` in the `Apache FreeMarker Generator` installation directory and have a look at the generated output.
```text
./run-examples.sh
@@ -82,11 +82,11 @@
You can either use the existing JSON sample
-> freemarker-cli -t examples/templates/json/md/github-users.ftl examples/data/json/github-users.json
+> freemarker-generator -t examples/templates/json/md/github-users.ftl examples/data/json/github-users.json
or pipe a cURL response
-> curl -s https://api.github.com/users | freemarker-cli -t examples/templates/json/md/github-users.ftl --stdin
+> curl -s https://api.github.com/users | freemarker-generator -t examples/templates/json/md/github-users.ftl --stdin
Below you see the Apache FreeMarker Template
@@ -121,8 +121,8 @@
Sometimes you have a CSV file which needs to be translated in Markdown or HTML - there are on-line solutions available such as [CSV To Markdown Table Generator](https://donatstudios.com/CsvToMarkdownTable) but having a local solution gives you more flexibility.
```text
-> freemarker-cli -t templates/csv/md/transform.ftl examples/data/csv/contract.csv
-> freemarker-cli -t templates/csv/html/transform.ftl examples/data/csv/contract.csv
+> freemarker-generator -t freemarker-generator/csv/md/transform.ftl examples/data/csv/contract.csv
+> freemarker-generator -t freemarker-generator/csv/html/transform.ftl examples/data/csv/contract.csv
```
The FreeMarker template is shown below
@@ -160,7 +160,7 @@
Of course you can also transform a XML document
```text
-> freemarker-cli -t examples/templates/xml/txt/recipients.ftl examples/data/xml/recipients.xml
+> freemarker-generator -t examples/templates/xml/txt/recipients.ftl examples/data/xml/recipients.xml
```
using the following template
@@ -249,7 +249,7 @@
Invoking the FTL template
-> freemarker-cli -t examples/templates/json/csv/swagger-endpoints.ftl examples/data/json/swagger-spec.json
+> freemarker-generator -t examples/templates/json/csv/swagger-endpoints.ftl examples/data/json/swagger-spec.json
gives you
@@ -266,10 +266,10 @@
Another day my project management asked me to create a CSV configuration file based on an Excel documents - as usual manual copying was not an option due to required data cleanup and data transformation. So I thought about Apache POI which support XLS and XLSX documents - integration of Apache POI was a breeze but the resulting code was not particularly useful example. So a more generic transformation was provided to show the transformation of Excel documents ...
```text
-> freemarker-cli -t templates/excel/html/transform.ftl examples/data/excel/test.xls
-> freemarker-cli -t templates/excel/html/transform.ftl examples/data/excel/test.xlsx
-> freemarker-cli -t templates/excel/html/transform.ftl examples/data/excel/test-multiple-sheets.xlsx
-> freemarker-cli -t templates/excel/md/transform.ftl examples/data/excel/test-multiple-sheets.xlsx
+> freemarker-generator -t freemarker-generator/excel/html/transform.ftl examples/data/excel/test.xls
+> freemarker-generator -t freemarker-generator/excel/html/transform.ftl examples/data/excel/test.xlsx
+> freemarker-generator -t freemarker-generator/excel/html/transform.ftl examples/data/excel/test-multiple-sheets.xlsx
+> freemarker-generator -t freemarker-generator/excel/md/transform.ftl examples/data/excel/test-multiple-sheets.xlsx
```
The provided FTL transforms an Excel into a HTML document supporting multiple Excel sheets
@@ -353,7 +353,7 @@
In this sample we transform all property files found in a directory (recursive search using include pattern) to a CSV file
```text
-> freemarker-cli --data-source-include *.properties -t examples/templates/properties/csv/locker-test-users.ftl examples/data/properties
+> freemarker-generator --data-source-include *.properties -t examples/templates/properties/csv/locker-test-users.ftl examples/data/properties
TENANT,SITE,USER_ID,DISPOSER_ID,PASSWORD,SMS_OTP,NAME,DESCRIPTION
TENANT_A,fat,user_0004,user_0004,password_0004,,,
TENANT_B,fat,user_0001,user_0001,password_0001,,,
@@ -484,7 +484,7 @@
In order to create the PDF you need to execute the following commands (assuming that you have Apache FOP installed)
```text
-> freemarker-cli -t examples/templates/csv/fo/transform.ftl examples/data/csv/locker-test-users.csv > sample.fo
+> freemarker-generator -t examples/templates/csv/fo/transform.ftl examples/data/csv/locker-test-users.csv > sample.fo
> fop -fo sample.fo sample.pdf
Dec 29, 2018 10:24:30 PM org.apache.fop.events.LoggingEventListener processEvent
WARNING: Font "Symbol,normal,700" not found. Substituting with "Symbol,normal,400".
@@ -501,7 +501,7 @@
Further along the line of the POC we converted a transaction export from CSV to PDF using Apache FOP
```text
-> freemarker-cli -t examples/templates/csv/fo/transactions.ftl examples/data/csv/transactions.csv > transactions.fo
+> freemarker-generator -t examples/templates/csv/fo/transactions.ftl examples/data/csv/transactions.csv > transactions.fo
> fop -fo transactions.fo transactions.pdf
Jan 16, 2019 11:15:21 PM org.apache.fop.events.LoggingEventListener processEvent
WARNING: Font "Symbol,normal,700" not found. Substituting with "Symbol,normal,400".
@@ -562,7 +562,7 @@
Your dependencies as CSV can be generated as shown below
```text
-> freemarker-cli -t examples/templates/html/csv/dependencies.ftl examples/data/html/dependencies.html
+> freemarker-generator -t examples/templates/html/csv/dependencies.ftl examples/data/html/dependencies.html
GroupId,ArtifactId,Version,Type,Licenses
com.jayway.jsonpath,json-path,2.4.0,jar,The Apache Software License Version 2.0
commons-cli,commons-cli,1.4,jar,Apache License Version 2.0
@@ -617,7 +617,7 @@
Rendering the FreeMarker template
```
-> freemarker-cli -t ./examples/templates/csv/shell/curl.ftl examples/data/csv/user.csv
+> freemarker-generator -t examples/templates/csv/shell/curl.ftl examples/data/csv/user.csv
```
generates the following shell script
@@ -659,7 +659,7 @@
And with `Grok` the `QUOTEDSTRING` is just a building block for an even more complex regular expression such as `COMBINEDAPACHELOG`
-> bin/freemarker-cli -t examples/templates/accesslog/combined-access.ftl examples/data/accesslog/combined-access.log
+> bin/freemarker-generator -t examples/templates/accesslog/combined-access.ftl examples/data/accesslog/combined-access.log
which gives you the following output
@@ -765,22 +765,22 @@
Sometime you need to apply a CSS, JSON or XPath query in ad ad-hoc way without installing `xmllint`, `jq` or `pup` - in this case you can pass a FreeMarker template in an interactive fashion
```text
-> bin/freemarker-cli -i 'Hello ${tools.system.envs["USER"]}'; echo
+> bin/freemarker-generator -i 'Hello ${tools.system.envs["USER"]}'; echo
Hello sgoeschl
-> bin/freemarker-cli -i '${tools.jsonpath.parse(dataSources?values[0]).read("$.info.title")}' examples/data/json/swagger-spec.json; echo
+> bin/freemarker-generator -i '${tools.jsonpath.parse(dataSources?values[0]).read("$.info.title")}' examples/data/json/swagger-spec.json; echo
Swagger Petstore
-> bin/freemarker-cli -i 'Post Title : ${tools.jsonpath.parse(dataSources?values[0]).read("$.title")}' https://jsonplaceholder.typicode.com/posts/2; echo
+> bin/freemarker-generator -i 'Post Title : ${tools.jsonpath.parse(dataSources?values[0]).read("$.title")}' https://jsonplaceholder.typicode.com/posts/2; echo
Post Title : qui est esse
-> bin/freemarker-cli -i '${tools.xml.parse(dataSources?values[0])["recipients/person[1]/name"]}' examples/data/xml/recipients.xml; echo
+> bin/freemarker-generator -i '${tools.xml.parse(dataSources?values[0])["recipients/person[1]/name"]}' examples/data/xml/recipients.xml; echo
John Smith
-> bin/freemarker-cli -i '${tools.jsoup.parse(dataSources?values[0]).select("a")[0]}' examples/data/html/dependencies.html; echo
-<a href="${project.url}" title="FreeMarker CLI">FreeMarker CLI</a>
+> bin/freemarker-generator -i '${tools.jsoup.parse(dataSources?values[0]).select("a")[0]}' examples/data/html/dependencies.html; echo
+<a href="${project.url}" title="FreeMarker Generator">FreeMarker Generator</a>
-> freemarker-cli -i '<#list tools.system.envs as name,value>${name} ==> ${value}${"\n"}</#list>'
+> freemarker-generator -i '<#list tools.system.envs as name,value>${name} ==> ${value}${"\n"}</#list>'
TERM ==> xterm-256color
LANG ==> en_US
DISPLAY ==> :0.0
@@ -795,7 +795,7 @@
So lets start the filtering & transformation using the following command line
```text
-> bin/freemarker-cli -e UTF-8 -l de_AT -Pcolumn="Order ID" \
+> bin/freemarker-generator -e UTF-8 -l de_AT -Pcolumn="Order ID" \
-Pvalues=226939189,957081544 \
-t examples/templates/csv/md/filter.ftl examples/data/csv/sales-records.csv
```
@@ -889,13 +889,13 @@
Sometimes we simply need to transform a JSON into an equivalent YAML or the other way around
```
-> freemarker-cli -t templates/yaml/json/transform.ftl examples/data/yaml/swagger-spec.yaml
-> freemarker-cli -i '${tools.gson.toJson(tools.yaml.parse(dataSources?values[0]))}' examples/data/yaml/swagger-spec.yaml
-> freemarker-cli -i '${tools.gson.toJson(yaml)}' -m yaml=examples/data/yaml/swagger-spec.yaml
+> freemarker-generator -t freemarker-generator/yaml/json/transform.ftl examples/data/yaml/swagger-spec.yaml
+> freemarker-generator -i '${tools.gson.toJson(tools.yaml.parse(dataSources?values[0]))}' examples/data/yaml/swagger-spec.yaml
+> freemarker-generator -i '${tools.gson.toJson(yaml)}' -m yaml=examples/data/yaml/swagger-spec.yaml
-> freemarker-cli -t templates/json/yaml/transform.ftl examples/data/json/swagger-spec.json
-> freemarker-cli -i '${tools.yaml.toYaml(tools.gson.parse(dataSources?values[0]))}' examples/data/json/swagger-spec.json
-> freemarker-cli -i '${tools.yaml.toYaml(json)}' -m json=examples/data/json/swagger-spec.json
+> freemarker-generator -t freemarker-generator/json/yaml/transform.ftl examples/data/json/swagger-spec.json
+> freemarker-generator -i '${tools.yaml.toYaml(tools.gson.parse(dataSources?values[0]))}' examples/data/json/swagger-spec.json
+> freemarker-generator -i '${tools.yaml.toYaml(json)}' -m json=examples/data/json/swagger-spec.json
```
### 15. Using Advanced FreeMarker Features
@@ -910,7 +910,7 @@
Running
-> freemarker-cli -t examples/templates/demo.ftl
+> freemarker-generator -t examples/templates/demo.ftl
gives you
@@ -974,7 +974,7 @@
9) List Environment Variables
---------------------------------------------------------------------------
-- PATH ==> /Users/sgoeschl/bin:/Library/Java/JavaVirtualMachines/jdk1.8.0_192.jdk/Contents/Home/bin:/usr/local/opt/ruby/bin:HOME/.gem/ruby/2.7.0/bin:/usr/local/Cellar/git/2.19.1/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Library/Apple/usr/bin:/Applications/Java/apache-fop-2.3:/Applications/Java/freemarker-cli-2.0.0-BETA-2/bin:
+- PATH ==> /Users/sgoeschl/bin:/Library/Java/JavaVirtualMachines/jdk1.8.0_192.jdk/Contents/Home/bin:/usr/local/opt/ruby/bin:HOME/.gem/ruby/2.7.0/bin:/usr/local/Cellar/git/2.19.1/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Library/Apple/usr/bin:/Applications/Java/apache-fop-2.3:/Applications/Java/freemarker-generator-2.0.0-BETA-2/bin:
- GIT_HOME ==> /usr/local/Cellar/git/2.19.1
- JAVA_8_HOME ==> /Library/Java/JavaVirtualMachines/jdk1.8.0_192.jdk/Contents/Home
- JAVA_HOME ==> /Library/Java/JavaVirtualMachines/jdk1.8.0_192.jdk/Contents/Home
@@ -1006,7 +1006,7 @@
- SSH_AUTH_SOCK ==> /private/tmp/com.apple.launchd.DTdlBj20Ka/Listeners
- EDITOR ==> vi
- XPC_FLAGS ==> 0x0
-- FREEMARKER_CLI_HOME ==> /Applications/Java/freemarker-cli-2.0.0-BETA-2
+- FREEMARKER_CLI_HOME ==> /Applications/Java/freemarker-generator-2.0.0-BETA-2
- TERM_SESSION_ID ==> 2745D6A3-543A-4DE3-830B-945678460311
- LC_ALL ==> en_US.utf-8
- __CF_USER_TEXT_ENCODING ==> 0x1F5:0x0:0x0
@@ -1038,7 +1038,7 @@
- dataSources
- tools
-13) FreeMarker CLI Tools
+13) FreeMarker Generator Tools
---------------------------------------------------------------------------
- csv : Process CSV files using Apache Commons CSV (see https://commons.apache.org/proper/commons-csv/)
- dataframe : Bridge to [nRo/DataFrame](https://github.com/nRo/DataFrame)
diff --git a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
index a891c38..d87fa6c 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
@@ -1,6 +1,6 @@
## Transforming CSV
-A common task is changing the output format of a CSV file therefore `Apache FreeMarker CLI` ships with a ready-to-use
+A common task is changing the output format of a CSV file therefore `Apache FreeMarker Generator` ships with a ready-to-use
templates to convert CSVs
* Convert a CSV into a different format
@@ -15,11 +15,11 @@
The following command line prints the converted CSV to `stdout`
```
-freemarker-cli \
+freemarker-generator \
-PCSV_SOURCE_FORMAT=DEFAULT \
-PCSV_TARGET_FORMAT=EXCEL \
-PCSV_TARGET_DELIMITER=SEMICOLON \
- -t templates/csv/csv/transform.ftl \
+ -t freemarker-generator/csv/csv/transform.ftl \
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/examples/data/csv/contract.csv
```
@@ -37,9 +37,9 @@
The following command line prints the resulting MarkDown to `stdout`
```
-freemarker-cli \
+freemarker-generator \
-PCSV_SOURCE_FORMAT=DEFAULT \
- -t templates/csv/md/transform.ftl \
+ -t freemarker-generator/csv/md/transform.ftl \
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/examples/data/csv/contract.csv
```
@@ -50,9 +50,9 @@
Of course it is possible to convert a CSV to HTML as well
```
-freemarker-cli \
+freemarker-generator \
-PCSV_SOURCE_FORMAT=DEFAULT \
- -t templates/csv/html/transform.ftl \
+ -t freemarker-generator/csv/html/transform.ftl \
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/examples/data/csv/contract.csv
```
diff --git a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
index 073a7e9..4eec217 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
@@ -1,6 +1,6 @@
## Transforming Directories
-`Apache FreeMarker CLI` supports the transformation of directories
+`Apache FreeMarker Generator` supports the transformation of directories
* Transform an input directory recursively into an output directory
* If a template has a ".ftl" extension this extension will be removed after processing
@@ -39,7 +39,7 @@
If no output directory is provided all output is written to `stdout`
```
-freemarker-cli -t examples/data/template/
+freemarker-generator -t examples/data/template/
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -60,7 +60,7 @@
* `nginx.conf.ftl` was changed to `nginx.conf" during the transformation
```
-freemarker-cli -t examples/data/template/ -o out; tree out
+freemarker-generator -t examples/data/template/ -o out; tree out
out
|-- application.properties
`-- nginx
@@ -74,7 +74,7 @@
A user-supplied parameter `NGINX_HOSTNAME` is used to render the templates
```
-freemarker-cli -t examples/data/template/ -P NGINX_HOSTNAME=localhost
+freemarker-generator -t examples/data/template/ -P NGINX_HOSTNAME=localhost
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -97,7 +97,7 @@
```
export NGINX_PORT=8080
-freemarker-cli -t examples/data/template/ -m env:///
+freemarker-generator -t examples/data/template/ -m env:///
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -117,7 +117,7 @@
```
echo "NGINX_PORT=8080" > nginx.env
-freemarker-cli -t examples/data/template/ -m nginx.env
+freemarker-generator -t examples/data/template/ -m nginx.env
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -137,7 +137,7 @@
```
echo '{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}' > nginx.json
-freemarker-cli -t examples/data/template/ -m nginx.json
+freemarker-generator -t examples/data/template/ -m nginx.json
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -157,7 +157,7 @@
```
echo -e "- NGINX_PORT": "\"8443\"\n- NGINX_HOSTNAME": "localhost" > nginx.yaml
-freemarker-cli -t examples/data/template/ -m nginx.yaml
+freemarker-generator -t examples/data/template/ -m nginx.yaml
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -180,7 +180,7 @@
```
export NGINX_CONF='{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}'
-freemarker-cli -t examples/data/template/ -m env:///NGINX_CONF#mimeType=application/json
+freemarker-generator -t examples/data/template/ -m env:///NGINX_CONF#mimeType=application/json
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -200,7 +200,7 @@
```
export NGINX_CONF='{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}'
-freemarker-cli -t examples/data/template/ -PNGINX_HOSTNAME=www.mydomain.com -m env:///NGINX_CONF#mimeType=application/json
+freemarker-generator -t examples/data/template/ -PNGINX_HOSTNAME=www.mydomain.com -m env:///NGINX_CONF#mimeType=application/json
# == application.properties ==================================================
server.name=www.mydomain.com
server.logs=/var/log/nginx
diff --git a/freemarker-generator-cli/src/site/markdown/index.md b/freemarker-generator-cli/src/site/markdown/index.md
index a3ecefa..1b33d5c 100644
--- a/freemarker-generator-cli/src/site/markdown/index.md
+++ b/freemarker-generator-cli/src/site/markdown/index.md
@@ -1,6 +1,6 @@
-## FreeMarker Generator CLI
+## FreeMarker Generator
-`Apache FreeMarker CLI` is a command-line interface for [Apache FreeMarker](https://freemarker.apache.org/)
+`Apache FreeMarker Generator` is a command-line interface for [Apache FreeMarker](https://freemarker.apache.org/)
* Requires JDK 1.8+ on Linux, Mac OSX and Windows
* Use stdin, files and URLs to load data and templates
@@ -33,4 +33,4 @@
### Advanced Topics
-* [FreeMarker CLI Configuration](cli/advanced/cli-configuration.html)
+* [FreeMarker Generator Configuration](cli/advanced/cli-configuration.html)
diff --git a/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/AbstractMainTest.java b/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/AbstractMainTest.java
index 2d3e101..640535c 100644
--- a/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/AbstractMainTest.java
+++ b/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/AbstractMainTest.java
@@ -21,18 +21,33 @@
import java.io.Writer;
import java.util.Arrays;
+/**
+ * Run unit tests with local templates directory and configuration file.
+ */
abstract class AbstractMainTest {
+ protected static final boolean WRITE_TO_STDOUT = false;
+ protected static final String TEST_TEMPLATES_DIRECTORY = "./src/app/templates";
+ protected static final String TEST_CONFIG_FILE = "./src/app/config/freemarker-generator.properties";
+
private static final String SPACE = " ";
String execute(String commandLine) throws IOException {
try (Writer writer = new StringWriter()) {
- final String[] args = commandLine.split(SPACE);
+ final String[] args = buildFinalCommandLine(commandLine).split(SPACE);
if (Main.execute(args, writer) == 0) {
- return writer.toString();
+ final String output = writer.toString();
+ if (WRITE_TO_STDOUT) {
+ System.out.println(output);
+ }
+ return output;
} else {
throw new RuntimeException("Executing freemarker-cli failed: " + Arrays.toString(args));
}
}
}
+
+ private String buildFinalCommandLine(String commandLine) {
+ return String.format("--config %s --template-dir %s %s", TEST_CONFIG_FILE, TEST_TEMPLATES_DIRECTORY, commandLine);
+ }
}
diff --git a/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/ExamplesTest.java b/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/ExamplesTest.java
index 3548b78..a2e7c79 100644
--- a/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/ExamplesTest.java
+++ b/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/ExamplesTest.java
@@ -31,72 +31,75 @@
@Test
public void shouldRunInfo() throws IOException {
- assertValid(execute("-t templates/info.ftl README.md"));
+ assertValid(execute("-t src/app/templates/freemarker-generator/info.ftl README.md"));
+ assertValid(execute("-t ./src/app/templates/freemarker-generator/info.ftl README.md"));
+ assertValid(execute("-t freemarker-generator/info.ftl README.md"));
+ assertValid(execute("-t /freemarker-generator/info.ftl README.md"));
}
@Test
public void shouldRunMultipleTimes() throws IOException {
- assertValid(execute("--times=2 -t templates/info.ftl README.md"));
+ assertValid(execute("--times=2 -t freemarker-generator/info.ftl README.md"));
}
@Test
public void shouldRunDemoExamples() throws IOException {
- assertValid(execute("-t examples/templates/demo.ftl README.md"));
+ assertValid(execute("-t src/app/examples/templates/demo.ftl README.md"));
}
@Test
public void shouldRunCsvExamples() throws IOException {
- assertValid(execute("-t templates/csv/html/transform.ftl examples/data/csv/contract.csv"));
- assertValid(execute("-t templates/csv/md/transform.ftl examples/data/csv/contract.csv"));
- assertValid(execute("-t examples/templates/csv/shell/curl.ftl examples/data/csv/user.csv"));
- assertValid(execute("-t examples/templates/csv/fo/transform.ftl examples/data/csv/locker-test-users.csv"));
- assertValid(execute("-t examples/templates/csv/fo/transactions.ftl examples/data/csv/transactions.csv"));
- assertValid(execute("-t examples/templates/csv/html/transactions.ftl examples/data/csv/transactions.csv"));
- assertValid(execute("-t templates/csv/csv/transform.ftl examples/data/csv/contract.csv"));
+ assertValid(execute("-t freemarker-generator/csv/html/transform.ftl src/app/examples/data/csv/contract.csv"));
+ assertValid(execute("-t freemarker-generator/csv/md/transform.ftl src/app/examples/data/csv/contract.csv"));
+ assertValid(execute("-t src/app/examples/templates/csv/shell/curl.ftl src/app/examples/data/csv/user.csv"));
+ assertValid(execute("-t src/app/examples/templates/csv/fo/transform.ftl src/app/examples/data/csv/locker-test-users.csv"));
+ assertValid(execute("-t src/app/examples/templates/csv/fo/transactions.ftl src/app/examples/data/csv/transactions.csv"));
+ assertValid(execute("-t src/app/examples/templates/csv/html/transactions.ftl src/app/examples/data/csv/transactions.csv"));
+ assertValid(execute("-t freemarker-generator/csv/csv/transform.ftl src/app/examples/data/csv/contract.csv"));
}
@Test
public void shouldRunExcelExamples() throws IOException {
- assertValid(execute("-t templates/excel/html/transform.ftl examples/data/excel/test.xls"));
- assertValid(execute("-t templates/excel/html/transform.ftl examples/data/excel/test.xlsx"));
- assertValid(execute("-t templates/excel/html/transform.ftl examples/data/excel/test-multiple-sheets.xlsx"));
- assertValid(execute("-t templates/excel/md/transform.ftl examples/data/excel/test-multiple-sheets.xlsx"));
- assertValid(execute("-t templates/excel/csv/transform.ftl examples/data/excel/test-multiple-sheets.xlsx"));
- assertValid(execute("-t examples/templates/excel/csv/custom.ftl -Pcsv.format=MYSQL examples/data/excel/test.xls"));
- assertValid(execute("-t examples/templates/excel/dataframe/transform.ftl examples/data/excel/test.xls"));
+ assertValid(execute("-t freemarker-generator/excel/html/transform.ftl src/app/examples/data/excel/test.xls"));
+ assertValid(execute("-t freemarker-generator/excel/html/transform.ftl src/app/examples/data/excel/test.xlsx"));
+ assertValid(execute("-t freemarker-generator/excel/html/transform.ftl src/app/examples/data/excel/test-multiple-sheets.xlsx"));
+ assertValid(execute("-t freemarker-generator/excel/md/transform.ftl src/app/examples/data/excel/test-multiple-sheets.xlsx"));
+ assertValid(execute("-t freemarker-generator/excel/csv/transform.ftl src/app/examples/data/excel/test-multiple-sheets.xlsx"));
+ assertValid(execute("-t src/app/examples/templates/excel/csv/custom.ftl -Pcsv.format=MYSQL src/app/examples/data/excel/test.xls"));
+ assertValid(execute("-t src/app/examples/templates/excel/dataframe/transform.ftl src/app/examples/data/excel/test.xls"));
}
@Test
public void shouldRunHtmlExamples() throws IOException {
- assertValid(execute("-t examples/templates/html/csv/dependencies.ftl examples/data/html/dependencies.html"));
+ assertValid(execute("-t src/app/examples/templates/html/csv/dependencies.ftl src/app/examples/data/html/dependencies.html"));
}
@Test
public void shouldRunJsonExamples() throws IOException {
- assertValid(execute("-t examples/templates/json/csv/swagger-endpoints.ftl examples/data/json/swagger-spec.json"));
- assertValid(execute("-t examples/templates/json/md/github-users.ftl examples/data/json/github-users.json"));
- assertValid(execute("-t templates/json/yaml/transform.ftl examples/data/json/swagger-spec.json"));
+ assertValid(execute("-t src/app/examples/templates/json/csv/swagger-endpoints.ftl src/app/examples/data/json/swagger-spec.json"));
+ assertValid(execute("-t src/app/examples/templates/json/md/github-users.ftl src/app/examples/data/json/github-users.json"));
+ assertValid(execute("-t freemarker-generator/json/yaml/transform.ftl src/app/examples/data/json/swagger-spec.json"));
}
@Test
public void shouldRunPropertiesExamples() throws IOException {
- assertValid(execute("-t examples/templates/properties/csv/locker-test-users.ftl examples/data/properties"));
+ assertValid(execute("-t src/app/examples/templates/properties/csv/locker-test-users.ftl src/app/examples/data/properties"));
}
@Test
public void shouldRunYamlExamples() throws IOException {
- assertValid(execute("-t examples/templates/yaml/txt/transform.ftl examples/data/yaml/customer.yaml"));
- assertValid(execute("-t templates/yaml/json/transform.ftl examples/data/yaml/swagger-spec.yaml"));
+ assertValid(execute("-t src/app/examples/templates/yaml/txt/transform.ftl src/app/examples/data/yaml/customer.yaml"));
+ assertValid(execute("-t freemarker-generator/yaml/json/transform.ftl src/app/examples/data/yaml/swagger-spec.yaml"));
}
@Test
public void shouldRunXmlExamples() throws IOException {
- assertValid(execute("-t examples/templates/xml/txt/recipients.ftl examples/data/xml/recipients.xml"));
+ assertValid(execute("-t src/app/examples/templates/xml/txt/recipients.ftl src/app/examples/data/xml/recipients.xml"));
}
@Test
public void shouldRunGrokExamples() throws IOException {
- assertValid(execute("-t examples/templates/accesslog/combined-access.ftl examples/data/accesslog/combined-access.log"));
+ assertValid(execute("-t src/app/examples/templates/accesslog/combined-access.ftl src/app/examples/data/accesslog/combined-access.log"));
}
@Test
@@ -106,42 +109,42 @@
@Test
public void shouldRunDataFrameExamples() throws IOException {
- assertValid(execute("-PCSV_SOURCE_DELIMITER=SEMICOLON -PCSV_SOURCE_WITH_HEADER=true -t examples/templates/dataframe/example.ftl examples/data/csv/dataframe.csv"));
+ assertValid(execute("-PCSV_SOURCE_DELIMITER=SEMICOLON -PCSV_SOURCE_WITH_HEADER=true -t src/app/examples/templates/dataframe/example.ftl src/app/examples/data/csv/dataframe.csv"));
}
@Test
public void shouldRunInteractiveTemplateExamples() throws IOException {
- assertValid(execute("-i ${tools.jsonpath.parse(dataSources?values[0]).read(\"$.info.title\")} examples/data/json/swagger-spec.json"));
- assertValid(execute("-i ${tools.xml.parse(dataSources?values[0])[\"recipients/person[1]/name\"]} examples/data/xml/recipients.xml"));
- assertValid(execute("-i ${tools.jsoup.parse(dataSources?values[0]).select(\"a\")[0]} examples/data/html/dependencies.html"));
- assertValid(execute("-i ${tools.gson.toJson(tools.yaml.parse(dataSources?values[0]))} examples/data/yaml/swagger-spec.yaml"));
- assertValid(execute("-i ${tools.gson.toJson(yaml)} -m yaml=examples/data/yaml/swagger-spec.yaml"));
- assertValid(execute("-i ${tools.yaml.toYaml(tools.gson.parse(dataSources?values[0]))} examples/data/json/swagger-spec.json"));
- assertValid(execute("-i ${tools.yaml.toYaml(json)} -m json=examples/data/json/swagger-spec.json"));
- assertValid(execute("-i ${tools.dataframe.print(tools.dataframe.fromMaps(tools.gson.parse(dataSources?values[0])))} examples/data/json/github-users.json"));
+ assertValid(execute("-i ${tools.jsonpath.parse(dataSources?values[0]).read(\"$.info.title\")} src/app/examples/data/json/swagger-spec.json"));
+ assertValid(execute("-i ${tools.xml.parse(dataSources?values[0])[\"recipients/person[1]/name\"]} src/app/examples/data/xml/recipients.xml"));
+ assertValid(execute("-i ${tools.jsoup.parse(dataSources?values[0]).select(\"a\")[0]} src/app/examples/data/html/dependencies.html"));
+ assertValid(execute("-i ${tools.gson.toJson(tools.yaml.parse(dataSources?values[0]))} src/app/examples/data/yaml/swagger-spec.yaml"));
+ assertValid(execute("-i ${tools.gson.toJson(yaml)} -m yaml=src/app/examples/data/yaml/swagger-spec.yaml"));
+ assertValid(execute("-i ${tools.yaml.toYaml(tools.gson.parse(dataSources?values[0]))} src/app/examples/data/json/swagger-spec.json"));
+ assertValid(execute("-i ${tools.yaml.toYaml(json)} -m json=src/app/examples/data/json/swagger-spec.json"));
+ assertValid(execute("-i ${tools.dataframe.print(tools.dataframe.fromMaps(tools.gson.parse(dataSources?values[0])))} src/app/examples/data/json/github-users.json"));
}
@Test
public void shouldTransformSingleTemplateDirectory() throws IOException {
- assertTrue(execute("-t examples/data/template").contains("server.name=127.0.0.1"));
- assertTrue(execute("-t examples/data/template -PNGINX_HOSTNAME=my.domain.com").contains("server.name=my.domain.com"));
+ assertTrue(execute("-t src/app/examples/data/template").contains("server.name=127.0.0.1"));
+ assertTrue(execute("-t src/app/examples/data/template -PNGINX_HOSTNAME=my.domain.com").contains("server.name=my.domain.com"));
}
@Test
public void shouldTransformMultipleTemplateDirectories() throws IOException {
- assertValid(execute("-t examples/data/template -t examples/data/template"));
- assertValid(execute("-t examples/data/template -o target/out/template1 -t examples/data/template -o target/out/template2"));
+ assertValid(execute("-t src/app/examples/data/template -t src/app/examples/data/template"));
+ assertValid(execute("-t src/app/examples/data/template -o target/out/template1 -t src/app/examples/data/template -o target/out/template2"));
}
@Test
public void shouldTransformMultipleTemplates() throws IOException {
- assertValid(execute("-t templates/csv/md/transform.ftl -t templates/csv/html/transform.ftl examples/data/csv/contract.csv"));
- assertValid(execute("-t templates/csv/md/transform.ftl -o target/contract.md -t templates/csv/html/transform.ftl -o target/contract.html examples/data/csv/contract.csv"));
+ assertValid(execute("-t freemarker-generator/csv/md/transform.ftl -t freemarker-generator/csv/html/transform.ftl src/app/examples/data/csv/contract.csv"));
+ assertValid(execute("-t freemarker-generator/csv/md/transform.ftl -o target/contract.md -t freemarker-generator/csv/html/transform.ftl -o target/contract.html src/app/examples/data/csv/contract.csv"));
}
@Test
public void shouldSupportDataSourcesAccessInFTL() throws IOException {
- final String args = "users=examples/data/json/github-users.json contract=examples/data/csv/contract.csv";
+ final String args = "users=src/app/examples/data/json/github-users.json contract=src/app/examples/data/csv/contract.csv";
// check FreeMarker directives
assertEquals("true", execute(args + " -i ${dataSources?has_content?c}"));
diff --git a/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/TemplateLoadingTest.java b/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/TemplateLoadingTest.java
index 723f4a8..d299167 100644
--- a/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/TemplateLoadingTest.java
+++ b/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/TemplateLoadingTest.java
@@ -26,21 +26,37 @@
public class TemplateLoadingTest extends AbstractMainTest {
private static final int SUCCESS = 0;
- private static final String ANY_TEMPLATE_NAME = "templates/info.ftl";
+ private static final String ANY_TEMPLATE_NAME = "freemarker-generator/cat.ftl";
+ private static final String ANY_TEMPLATE_FILE_NAME = "src/app/templates/" + ANY_TEMPLATE_NAME;
private static final String CURR_DIR = System.getProperty("user.dir", ".");
@Test
- public void shouldLoadRelativeTemplate() {
- final String[] args = new String[] { "-t", ANY_TEMPLATE_NAME };
+ public void shouldLoadTemplateFromRelativeFile() {
+ final String[] args = new String[] { "-t", ANY_TEMPLATE_FILE_NAME };
assertEquals(SUCCESS, Main.execute(args, new NullWriter()));
}
@Test
- public void shouldLoadAbsoluteTemplate() {
- final String absoluteFileName = new File(CURR_DIR, ANY_TEMPLATE_NAME).getAbsolutePath();
+ public void shouldLoadTemplateFromAbsoluteFile() {
+ final String absoluteFileName = new File(CURR_DIR, ANY_TEMPLATE_FILE_NAME).getAbsolutePath();
final String[] args = new String[] { "-t", absoluteFileName };
assertEquals(SUCCESS, Main.execute(args, new NullWriter()));
}
+
+ @Test
+ public void shouldLoadTemplateFromTemplateLoader() {
+ final String[] args = new String[] { "--template-dir", TEST_TEMPLATES_DIRECTORY, "-t", ANY_TEMPLATE_NAME };
+
+ assertEquals(SUCCESS, Main.execute(args, new NullWriter()));
+ }
+
+ @Test
+ public void shouldLoadTemplateWithLeadingSlachFromTemplateLoader() {
+ final String[] args = new String[] { "--template-dir", TEST_TEMPLATES_DIRECTORY, "-t", "/" + ANY_TEMPLATE_NAME };
+
+ assertEquals(SUCCESS, Main.execute(args, new NullWriter()));
+ }
+
}
diff --git a/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplierTest.java b/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplierTest.java
index 79c9ea4..2aeab10 100644
--- a/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplierTest.java
+++ b/freemarker-generator-cli/src/test/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplierTest.java
@@ -26,20 +26,13 @@
public class TemplateDirectorySupplierTest {
- // Depending on the local configuration the "~/.freemarker-cli" directory might be found.
+ // Depending on the local configuration the "~/.freemarker-generator" directory might be found.
private final int nrOfDefaultTemplateDirectories = templateDirectories(null).size();
@Test
- public void shouldRemoveDuplicateTemplateDirectorie() throws IOException {
- final List<File> directories = templateDirectories(".");
-
- assertEquals(nrOfDefaultTemplateDirectories, directories.size());
- }
-
- @Test
public void shouldAddTemplateDirectory() throws IOException {
- assertEquals(nrOfDefaultTemplateDirectories + 1, templateDirectories("templates").size());
- assertEquals(nrOfDefaultTemplateDirectories + 1, templateDirectories("./templates").size());
+ assertEquals(nrOfDefaultTemplateDirectories + 1, templateDirectories("src/app/templates").size());
+ assertEquals(nrOfDefaultTemplateDirectories + 1, templateDirectories("./src/app/templates").size());
}
@Test
diff --git a/freemarker-generator-maven-plugin/pom.xml b/freemarker-generator-maven-plugin/pom.xml
index 30442ec..0d7635c 100644
--- a/freemarker-generator-maven-plugin/pom.xml
+++ b/freemarker-generator-maven-plugin/pom.xml
@@ -151,6 +151,13 @@
</execution>
</executions>
</plugin>
+ <plugin>
+ <!-- Otherwise Maven plugin tests are failing -->
+ <artifactId>maven-surefire-plugin</artifactId>
+ <configuration>
+ <useSystemClassLoader>false</useSystemClassLoader>
+ </configuration>
+ </plugin>
</plugins>
</build>
diff --git a/freemarker-generator-tools/pom.xml b/freemarker-generator-tools/pom.xml
index 256987a..2d590a2 100644
--- a/freemarker-generator-tools/pom.xml
+++ b/freemarker-generator-tools/pom.xml
@@ -33,7 +33,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
- <apache.poi.version>4.1.1</apache.poi.version>
+ <apache.poi.version>4.1.2</apache.poi.version>
</properties>
<dependencies>
@@ -103,13 +103,13 @@
<dependency>
<groupId>org.jsoup</groupId>
<artifactId>jsoup</artifactId>
- <version>1.12.1</version>
+ <version>1.13.1</version>
</dependency>
<!-- SnakeYamlTool -->
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
- <version>1.25</version>
+ <version>1.26</version>
</dependency>
<!-- Testing -->
<dependency>
diff --git a/freemarker-generator-tools/src/site/markdown/index.md b/freemarker-generator-tools/src/site/markdown/index.md
index 19d0bb2..62fe847 100644
--- a/freemarker-generator-tools/src/site/markdown/index.md
+++ b/freemarker-generator-tools/src/site/markdown/index.md
@@ -1,12 +1,12 @@
-# Apache FreeMarker CLI Tools
+# Apache FreeMarker Generator Tools
## Overview
-The implementation of the `Apache FreeMarker CLI Tools` was inspired by [Apache Velocity Tools](https://velocity.apache.org/tools/devel/) - a `tool` is just a POJO (plain old Java object) that is "useful" in a template and is not meant to be rendered in the output.
+The implementation of the `Apache FreeMarker Generator Tools` was inspired by [Apache Velocity Tools](https://velocity.apache.org/tools/devel/) - a `tool` is just a POJO (plain old Java object) that is "useful" in a template and is not meant to be rendered in the output.
-Let's have a look at the anatomy and life-cycle of a `Apache FreeMarker CLI Tool`
+Let's have a look at the anatomy and life-cycle of a `Apache FreeMarker Generator Tool`
-* The meta-data, e.g. class name, is read from `freemarker-cli.properties`
+* The meta-data, e.g. class name, is read from `freemarker-generator.properties`
* It provides a default constructor
* Its `toString` methods prints a short description
* It exposes public methods being used directly by the template
diff --git a/licences/LICENCE_CDDL-1.0.txt b/licences/LICENCE_CDDL-1.0.txt
new file mode 100644
index 0000000..33e627c
--- /dev/null
+++ b/licences/LICENCE_CDDL-1.0.txt
@@ -0,0 +1,131 @@
+COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0
+
+1. Definitions.
+
+1.1. "Contributor" means each individual or entity that creates or contributes to the creation of Modifications.
+
+1.2. "Contributor Version" means the combination of the Original Software, prior Modifications used by a Contributor (if any), and the Modifications made by that particular Contributor.
+
+1.3. "Covered Software" means (a) the Original Software, or (b) Modifications, or (c) the combination of files containing Original Software with files containing Modifications, in each case including portions thereof.
+
+1.4. "Executable" means the Covered Software in any form other than Source Code.
+
+1.5. "Initial Developer" means the individual or entity that first makes Original Software available under this License.
+
+1.6. "Larger Work" means a work which combines Covered Software or portions thereof with code not governed by the terms of this License.
+
+1.7. "License" means this document.
+
+1.8. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently acquired, any and all of the rights conveyed herein.
+
+1.9. "Modifications" means the Source Code and Executable form of any of the following:
+
+A. Any file that results from an addition to, deletion from or modification of the contents of a file containing Original Software or previous Modifications;
+
+B. Any new file that contains any part of the Original Software or previous Modification; or
+
+C. Any new file that is contributed or otherwise made available under the terms of this License.
+
+1.10. "Original Software" means the Source Code and Executable form of computer software code that is originally released under this License.
+
+1.11. "Patent Claims" means any patent claim(s), now owned or hereafter acquired, including without limitation, method, process, and apparatus claims, in any patent Licensable by grantor.
+
+1.12. "Source Code" means (a) the common form of computer software code in which modifications are made and (b) associated documentation included in or with such code.
+
+1.13. "You" (or "Your") means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity which controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
+
+2. License Grants.
+
+2.1. The Initial Developer Grant.
+
+Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, the Initial Developer hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark) Licensable by Initial Developer, to use, reproduce, modify, display, perform, sublicense and distribute the Original Software (or portions thereof), with or without Modifications, and/or as part of a Larger Work; and
+
+(b) under Patent Claims infringed by the making, using or selling of Original Software, to make, have made, use, practice, sell, and offer for sale, and/or otherwise dispose of the Original Software (or portions thereof).
+
+(c) The licenses granted in Sections 2.1(a) and (b) are effective on the date Initial Developer first distributes or otherwise makes the Original Software available to a third party under the terms of this License.
+
+(d) Notwithstanding Section 2.1(b) above, no patent license is granted: (1) for code that You delete from the Original Software, or (2) for infringements caused by: (i) the modification of the Original Software, or (ii) the combination of the Original Software with other software or devices.
+
+2.2. Contributor Grant.
+
+Conditioned upon Your compliance with Section 3.1 below and
+subject to third party intellectual property claims, each
+Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark) Licensable by Contributor to use, reproduce, modify, display, perform, sublicense and distribute the Modifications created by such Contributor (or portions thereof), either on an unmodified basis, with other Modifications, as Covered Software and/or as part of a Larger Work; and
+
+(b) under Patent Claims infringed by the making, using, or selling of Modifications made by that Contributor either alone and/or in combination with its Contributor Version (or portions of such combination), to make, use, sell, offer for sale, have made, and/or otherwise dispose of: (1) Modifications made by that Contributor (or portions thereof); and (2) the combination of Modifications made by that Contributor with its Contributor Version (or portions of such combination).
+
+(c) The licenses granted in Sections 2.2(a) and 2.2(b) are effective on the date Contributor first distributes or otherwise makes the Modifications available to a third party.
+(d) Notwithstanding Section 2.2(b) above, no patent license is granted: (1) for any code that Contributor has deleted from the Contributor Version; (2) for infringements caused by: (i) third party modifications of Contributor Version, or (ii) the combination of Modifications made by that Contributor with other software (except as part of the Contributor Version) or other devices; or (3) under Patent Claims infringed by Covered Software in the absence of Modifications made by that Contributor.
+
+3. Distribution Obligations.
+
+3.1. Availability of Source Code.
+
+Any Covered Software that You distribute or otherwise make available in Executable form must also be made available in Source Code form and that Source Code form must be distributed only under the terms of this License. You must include a copy of this License with every copy of the Source Code form of the Covered Software You distribute or otherwise make available. You must inform recipients of any such Covered Software in Executable form as to how they can obtain such Covered Software in Source Code form in a reasonable manner on or through a medium customarily used for software exchange.
+
+3.2. Modifications.
+
+The Modifications that You create or to which You contribute are governed by the terms of this License. You represent that You believe Your Modifications are Your original creation(s) and/or You have sufficient rights to grant the rights conveyed by this License.
+
+3.3. Required Notices.
+
+You must include a notice in each of Your Modifications that identifies You as the Contributor of the Modification. You may not remove or alter any copyright, patent or trademark notices contained within the Covered Software, or any notices of licensing or any descriptive text giving attribution to any Contributor or the Initial Developer.
+
+3.4. Application of Additional Terms.
+
+You may not offer or impose any terms on any Covered Software in Source Code form that alters or restricts the applicable version of this License or the recipients' rights hereunder. You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, you may do so only on Your own behalf, and not on behalf of the Initial Developer or any Contributor. You must make it absolutely clear that any such warranty, support, indemnity or liability obligation is offered by You alone, and You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of warranty, support, indemnity or liability terms You offer.
+
+3.5. Distribution of Executable Versions.
+
+You may distribute the Executable form of the Covered Software under the terms of this License or under the terms of a license of Your choice, which may contain terms different from this License, provided that You are in compliance with the terms of this License and that the license for the Executable form does not attempt to limit or alter the recipient's rights in the Source Code form from the rights set forth in this License. If You distribute the Covered Software in Executable form under a different license, You must make it absolutely clear that any terms which differ from this License are offered by You alone, not by the Initial Developer or Contributor. You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of any such terms You offer.
+
+3.6. Larger Works.
+
+You may create a Larger Work by combining Covered Software with other code not governed by the terms of this License and distribute the Larger Work as a single product. In such a case, You must make sure the requirements of this License are fulfilled for the Covered Software.
+
+4. Versions of the License.
+
+4.1. New Versions.
+
+Sun Microsystems, Inc. is the initial license steward and may publish revised and/or new versions of this License from time to time. Each version will be given a distinguishing version number. Except as provided in Section 4.3, no one other than the license steward has the right to modify this License.
+
+4.2. Effect of New Versions.
+
+You may always continue to use, distribute or otherwise make the Covered Software available under the terms of the version of the License under which You originally received the Covered Software. If the Initial Developer includes a notice in the Original Software prohibiting it from being distributed or otherwise made available under any subsequent version of the License, You must distribute and make the Covered Software available under the terms of the version of the License under which You originally received the Covered Software. Otherwise, You may also choose to use, distribute or otherwise make the Covered Software available under the terms of any subsequent version of the License published by the license steward.
+
+4.3. Modified Versions.
+
+When You are an Initial Developer and You want to create a new license for Your Original Software, You may create and use a modified version of this License if You: (a) rename the license and remove any references to the name of the license steward (except to note that the license differs from this License); and (b) otherwise make it clear that the license contains terms which differ from this License.
+
+5. DISCLAIMER OF WARRANTY.
+
+COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED SOFTWARE IS WITH YOU. SHOULD ANY COVERED SOFTWARE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.
+
+6. TERMINATION.
+
+6.1. This License and the rights granted hereunder will terminate automatically if You fail to comply with terms herein and fail to cure such breach within 30 days of becoming aware of the breach. Provisions which, by their nature, must remain in effect beyond the termination of this License shall survive.
+
+6.2. If You assert a patent infringement claim (excluding declaratory judgment actions) against Initial Developer or a Contributor (the Initial Developer or Contributor against whom You assert such claim is referred to as "Participant") alleging that the Participant Software (meaning the Contributor Version where the Participant is a Contributor or the Original Software where the Participant is the Initial Developer) directly or indirectly infringes any patent, then any and all rights granted directly or indirectly to You by such Participant, the Initial Developer (if the Initial Developer is not the Participant) and all Contributors under Sections 2.1 and/or 2.2 of this License shall, upon 60 days notice from Participant terminate prospectively and automatically at the expiration of such 60 day notice period, unless if within such 60 day period You withdraw Your claim with respect to the Participant Software against such Participant either unilaterally or pursuant to a written agreement with Participant.
+
+6.3. In the event of termination under Sections 6.1 or 6.2 above, all end user licenses that have been validly granted by You or any distributor hereunder prior to termination (excluding licenses granted to You by any distributor) shall survive termination.
+
+7. LIMITATION OF LIABILITY.
+
+UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOST PROFITS, LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU.
+
+8. U.S. GOVERNMENT END USERS.
+
+The Covered Software is a "commercial item," as that term is defined in 48 C.F.R. 2.101 (Oct. 1995), consisting of "commercial computer software" (as that term is defined at 48 C.F.R. ¤ 252.227-7014(a)(1)) and "commercial computer software documentation" as such terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all U.S. Government End Users acquire Covered Software with only those rights set forth herein. This U.S. Government Rights clause is in lieu of, and supersedes, any other FAR, DFAR, or other clause or provision that addresses Government rights in computer software under this License.
+
+9. MISCELLANEOUS.
+
+This License represents the complete agreement concerning subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. This License shall be governed by the law of the jurisdiction specified in a notice contained within the Original Software (except to the extent applicable law, if any, provides otherwise), excluding such jurisdiction's conflict-of-law provisions. Any litigation relating to this License shall be subject to the jurisdiction of the courts located in the jurisdiction and venue specified in a notice contained within the Original Software, with the losing party responsible for costs, including, without limitation, court costs and reasonable attorneys' fees and expenses. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not apply to this License. You agree that You alone are responsible for compliance with the United States export administration regulations (and the export control laws and regulation of any other countries) when You use, distribute or otherwise make available any Covered Software.
+
+10. RESPONSIBILITY FOR CLAIMS.
+
+As between Initial Developer and the Contributors, each party is responsible for claims and damages arising, directly or indirectly, out of its utilization of rights under this License and You agree to work with Initial Developer and Contributors to distribute such responsibility on an equitable basis. Nothing herein is intended or shall be deemed to constitute any admission of liability.
\ No newline at end of file
diff --git a/licences/LICENCE_EPL-1.0.txt b/licences/LICENCE_EPL-1.0.txt
new file mode 100644
index 0000000..3d967ae
--- /dev/null
+++ b/licences/LICENCE_EPL-1.0.txt
@@ -0,0 +1,70 @@
+Eclipse Public License - v 1.0
+
+THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+
+"Contribution" means:
+
+a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and
+b) in the case of each subsequent Contributor:
+i) changes to the Program, and
+ii) additions to the Program;
+where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
+"Contributor" means any person or entity that distributes the Program.
+
+"Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
+
+"Program" means the Contributions distributed in accordance with this Agreement.
+
+"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
+
+2. GRANT OF RIGHTS
+
+a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
+b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
+c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
+d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
+3. REQUIREMENTS
+
+A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
+
+a) it complies with the terms and conditions of this Agreement; and
+b) its license agreement:
+i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
+ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
+iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
+iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
+When the Program is made available in source code form:
+
+a) it must be made available under this Agreement; and
+b) a copy of this Agreement must be included with each copy of the Program.
+Contributors may not remove or alter any copyright notices contained within the Program.
+
+Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
+
+For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement , including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
+
+If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
+
+Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
+
+This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.
\ No newline at end of file
diff --git a/licences/LICENCE_MIT.txt b/licences/LICENCE_MIT.txt
new file mode 100644
index 0000000..e662c78
--- /dev/null
+++ b/licences/LICENCE_MIT.txt
@@ -0,0 +1,5 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
diff --git a/licences/LICENCE_antlr4-runtime.txt b/licences/LICENCE_antlr4-runtime.txt
new file mode 100644
index 0000000..24a7133
--- /dev/null
+++ b/licences/LICENCE_antlr4-runtime.txt
@@ -0,0 +1,10 @@
+Copyright (c) 2012 Terence Parr and Sam Harwell
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/licences/LICENCE_asm.txt b/licences/LICENCE_asm.txt
new file mode 100644
index 0000000..631ee53
--- /dev/null
+++ b/licences/LICENCE_asm.txt
@@ -0,0 +1,27 @@
+ASM: a very small and fast Java bytecode manipulation framework
+Copyright (c) 2000-2011 INRIA, France Telecom
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holders nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/licences/LICENCE_curvesapi.txt b/licences/LICENCE_curvesapi.txt
new file mode 100644
index 0000000..22df7b1
--- /dev/null
+++ b/licences/LICENCE_curvesapi.txt
@@ -0,0 +1,28 @@
+Copyright (c) 2005, Graph Builder
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+-Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+-Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+-Neither the name of Graph Builder nor the names of its contributors may be
+used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/licences/LICENCE_hamcrest.txt b/licences/LICENCE_hamcrest.txt
new file mode 100644
index 0000000..0bf6264
--- /dev/null
+++ b/licences/LICENCE_hamcrest.txt
@@ -0,0 +1,27 @@
+BSD License
+
+Copyright (c) 2000-2015 www.hamcrest.org
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of
+conditions and the following disclaimer. Redistributions in binary form must reproduce
+the above copyright notice, this list of conditions and the following disclaimer in
+the documentation and/or other materials provided with the distribution.
+
+Neither the name of Hamcrest nor the names of its contributors may be used to endorse
+or promote products derived from this software without specific prior written
+permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
+WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.
\ No newline at end of file
diff --git a/licences/LICENSE_ASL-2.0.txt b/licences/LICENSE_ASL-2.0.txt
new file mode 100644
index 0000000..7a4a3ea
--- /dev/null
+++ b/licences/LICENSE_ASL-2.0.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ 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]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index 4e132e8..8512bf7 100644
--- a/pom.xml
+++ b/pom.xml
@@ -113,7 +113,7 @@
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
- <version>2.6</version>
+ <version>2.7</version>
</dependency>
<dependency>
<groupId>javax.activation</groupId>
@@ -147,73 +147,19 @@
<pluginManagement>
<plugins>
<plugin>
- <artifactId>maven-antrun-plugin</artifactId>
- <version>1.8</version>
- </plugin>
- <plugin>
- <artifactId>maven-assembly-plugin</artifactId>
- <version>3.2.0</version>
- </plugin>
- <plugin>
- <artifactId>maven-clean-plugin</artifactId>
- <version>3.1.0</version>
- </plugin>
- <plugin>
- <artifactId>maven-compiler-plugin</artifactId>
- <version>3.8.1</version>
- </plugin>
- <plugin>
- <artifactId>maven-gpg-plugin</artifactId>
- <version>1.6</version>
- </plugin>
- <plugin>
- <artifactId>maven-deploy-plugin</artifactId>
- <version>3.0.0-M1</version>
- </plugin>
- <plugin>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>3.2.0</version>
- </plugin>
- <plugin>
<artifactId>maven-jxr-plugin</artifactId>
<version>3.0.0</version>
</plugin>
<plugin>
- <artifactId>maven-plugin-plugin</artifactId>
- <version>3.6.0</version>
- </plugin>
- <plugin>
<artifactId>maven-pmd-plugin</artifactId>
<version>3.12.0</version>
</plugin>
<plugin>
- <artifactId>maven-project-info-reports-plugin</artifactId>
- <version>3.0.0</version>
- </plugin>
- <plugin>
- <artifactId>maven-release-plugin</artifactId>
- <version>2.5.3</version>
- </plugin>
- <plugin>
- <artifactId>maven-resources-plugin</artifactId>
- <version>3.1.0</version>
- </plugin>
- <plugin>
+ <!-- Required by custom Maven skin -->
<artifactId>maven-site-plugin</artifactId>
<version>3.8.2</version>
</plugin>
<plugin>
- <artifactId>maven-source-plugin</artifactId>
- <version>3.2.0</version>
- </plugin>
- <plugin>
- <artifactId>maven-surefire-plugin</artifactId>
- <version>2.19</version>
- <configuration>
- <useSystemClassLoader>false</useSystemClassLoader>
- </configuration>
- </plugin>
- <plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>appassembler-maven-plugin</artifactId>
<version>1.10</version>
@@ -228,11 +174,6 @@
<artifactId>git-commit-id-plugin</artifactId>
<version>4.0.0</version>
</plugin>
- <plugin>
- <groupId>org.apache.rat</groupId>
- <artifactId>apache-rat-plugin</artifactId>
- <version>0.13</version>
- </plugin>
</plugins>
</pluginManagement>
<plugins>
@@ -246,7 +187,6 @@
<plugin>
<artifactId>maven-release-plugin</artifactId>
<configuration>
- <arguments>-Dmaven.javadoc.skip=true</arguments>
<autoVersionSubmodules>true</autoVersionSubmodules>
<localCheckout>true</localCheckout>
<releaseProfiles>release</releaseProfiles>
diff --git a/travis.bat b/travis.bat
index eb3f41d..9e033a6 100755
--- a/travis.bat
+++ b/travis.bat
@@ -18,8 +18,8 @@
REM
REM Simulate the Travis build locally
CALL mvn clean install site site:stage
-cd .\freemarker-generator-cli
+cd .\freemarker-generator-cli\target\appassembler\
CALL .\run-examples.bat
-cd ..\freemarker-generator-maven-plugin-sample
+cd ..\..\..\freemarker-generator-maven-plugin-sample
mvn clean package
cd ..
\ No newline at end of file
diff --git a/travis.sh b/travis.sh
index cba6671..61d2161 100755
--- a/travis.sh
+++ b/travis.sh
@@ -18,8 +18,8 @@
#
# Simulate the Travis build locally
mvn clean install site site:stage
-cd ./freemarker-generator-cli
+cd ./freemarker-generator-cli/target/appassembler/
sh ./run-examples.sh
-cd ../freemarker-generator-maven-plugin-sample
+cd ../../../freemarker-generator-maven-plugin-sample
mvn clean package
cd ..
