Munge

A Gradle plugin for transforming XML files by applying XSL stylesheets and FreeMarker templates.

Munge (and its related term mung) has long been jargon for manipulating data in some way, see for instance the Jargon file or Wikipedia. The plugin's name is however foremost a nod to the old Macintosh Toolbox function Munger:

Munger (which rhymes with "plunger") lets you manipulate bytes [...] (Inside Macintosh Volume I, page 468)

The Munger function searches for a sequence of bytes and replaces it with another sequence of bytes [...] (Inside Macintosh: Text, page 5-21)

Release Notes
Usage
The transform task
Transformation sets
Saxon transformations
FreeMarker transformations

Release Notes

version 1.0

Initial release.

Usage

The Munge plugin requires Gradle version 5.0 or newer. It is applied using the plugins DSL:

plugins {
  id 'org.myire.munge' version '1.0'
}

The transform task

The plugin adds a transform task to the project. This task is configured with one or more transformation sets. When the task is executed it processes all transformation sets in the order they are declared in the configuration.

There are two types of transformation sets; saxon and freemarker. A saxon transformation set applies XSL style sheets to XML files using the Saxon library. A freemarker transformation set applies Apache FreeMarker templates to XML files.

Example: a task that first should perform the transformations in a saxon transformation set and then the transformations in a freemarker transformation set is configured as follows:

transform {
    saxon {
        ...
    }
    freemarker {
        ...
    }
}

A task that first should perform the transformations in a freemarker transformation set, then the transformations in a saxon set, and finally the transformations in another freemarker set is configured like this:

transform {
    freemarker {
        ...
    }
    saxon {
        ...
    }
    freemarker {
        ...
    }
}

By default the task doesn't fail the build if any errors occur in the transformations. This can be changed by setting the failOnError property to true:

transform {
    failOnError = true // Fail the build if there is an error in a transformation
    ...
}

Transformation sets

A transformation set specifies one or more source files that should be transformed by applying one or more template files to them. The result of each transformation is written to an output file.

Source and template files can be configured in several ways:

with the path to a file.
with the path to a directory (to include all files in that directory and in any subdirectories).
with the path to a directory together with a closure that specifies which of the directory's files to include. The closure operates on a standard Gradle PatternFilterable, like e.g. the Copy task.

Relative paths are resolved relative to the project directory in all of the above cases.

Source files

To configure a transformation set with a single source file you specify its path:

source 'path/to/file'

If the path specifies a directory, all files in that directory, including files in any subdirectories, will be added as source files to the transformation set:

source 'path/to/directory'

Multiple files and/or directories can be added with the sources method:

sources 'path/to/file1', 'path/to/file2', 'path/to/directory'

When adding a directory, the files to include can be controlled with a configuration closure:

sources ('path/to/directory') {
    include '*.xml'
}

Template files

Template files are added to a transformation set in the same way as source files:

template 'path/to/file1'
templates 'path/to/file2', 'path/to/directory1'
templates ('path/to/directory2') {
    exclude 'common.xsl'
}

Output files

When a transformation set is processed it will apply each of its template files to each of its source files, producing an output file for each transformation. The output file for a transformation can be specified in several ways:

All output can be directed to a single file, specified in the outputFile property. If the transformation set contains several transformations, the output from each transformation is appended to the file.
The output files can be created in a specific directory, specified in the outputDir property. The name of the output file will then be the same as the name of the transformation's source file.
The output file can be specified by a closure applied to the transformation's source and template files (as java.io.File instances). The closure either returns an object specifying the output file of the transformation or null if there should be no explicit output file. In the former case the returned object is resolved with the project method file(). Output file closures are added with the outputMapping method.

The above variants can be combined. Multiple closures can be added to the output file specification, and they will be called in the order they were added until one returns a non-null value. If all closures return null (or there are no closures configured), the directory or file variant will be used. Should both an output directory and an output file be specified, the former takes precedence.

Example of output file configuration:

outputDir = 'directory1'
outputMapping {
    s, t ->
        if (t.name.startsWith('xyz'))
            'directory2/' + s.name + '-' + t.name
        else
            null
}

The above configuration would create all output files in the directory directory1 except for transformations where the template file's name starts with "xyz", in which case the output file will be written to the directory directory2 and have the template file's name appended to the source file's name.

Assuming we have a transformation set with two source files, sourceFile1 and sourceFile2, and two template files, abcTemplateFile and xyzTemplateFile, the four transformations in the set would produce the following output files:

sourceFile1 x abcTemplateFile -> directory1/sourceFile1
sourceFile1 x xyzTemplateFile -> directory2/sourceFile1-xyzTemplateFile
sourceFile2 x abcTemplateFile -> directory1/sourceFile2
sourceFile2 x xyzTemplateFile -> directory2/sourceFile2-xyzTemplateFile

Dynamic output directories

In some cases the output files are not specified in the transformation set configuration. Instead they are created from the templates by using e.g. <xsl:result-document> or the FreeMarker directive <@outputfile> installed by the plugin (see below).

Since the task doesn't know about these output files, the Gradle up-to-date check of the task will not be able to detect modifications to them. To remedy this the directories where the templates create files can be specified as dynamic output directories in the transformation set's configuration:

dynamicOutputDirectory "${buildDir}/generated-sources"

Any directory added as a dynamic output directory will be included in the up-to-date check of the transform task.

Transformation parameters

The transformation set property parameter is used to specify parameters that should be passed to each transformation in the set:

 parameter('baseDirectory', "${buildDir}/generated-sources")

Parameters can also be specified as a map:

parameters(
    'stringParam': 'value',
    'intParam': 17
)

Saxon transformations

In Saxon transformations the source files are XML files and the template files are XSL style sheets. The transformations are configured in a saxon transformation set configuration block within the transform task.

The saxon configuration block adds one property to the common transformation set properties; the configurationFile property. This property lets you specify a Saxon configuration file that will be used in all transformations in that transformation set.

Example:

saxon {
    configurationFile 'src/config/saxon.xml'
    sources ('resources/xml') {
        exclude '*.xsd'
    }
    template 'resources/xsl'
    outputDir = 'generated-resources'
}

If no configuration file is specified the default configuration will be used.

FreeMarker transformations

In FreeMarker transformations the source files are XML files and the template files are Apache FreeMarker template files. FreeMarker transformations are configured in a freemarker transformation set configuration block within the transform task.

The freemarker configuration block adds two properties to the common transformation set properties:

configurationFile lets you specify a FreeMarker configuration file that will be used in all transformations in that transformation set. A FreeMarker configuration file is a standard properties file, the valid properties are documented here. If no configuration file is specified the default configuration will be used.
charset lets you specify the character set to encode the output files with. The default is UTF-8. Note that this property does not affect the character set of files created with the <@outputfile> directive (see below).

Example:

freemarker {
    configurationFile 'src/config/freemarker.properties'
    source 'resources/xml'
    templates ('resources/templates') {
        include '*.ftl', '*.fm'
    }
    outputDir = 'generated-sources'
    charset = 'iso-8859-1'
}

Outputfile directive

In some cases it is desirable for a FreeMarker template to generate multiple output files for one source file. This can however not be configured in the freemarker transformation set, since the logic for which output files to create is stored in the template files.

To accommodate for this the plugin adds an <@outputfile> directive to the FreeMarker configuration used by the transformations. A FreeMarker template can redirect some of its output to a specific file using this directive:

This text is written to the transformation's normal output file
<@outputfile path='path/to/outputfile'>
    This text is written to the specified output file
</@outputfile>
This text is written to the transformation's normal output file

The directive requires the file path to be specified in the path parameter. The character set of the file can be specified in the optional parameter charset, default is UTF-8.

This makes it possible for a freemarker transformation set to not specify any output file, directory or output mapping closures, and let the templates create all output files with the <@outputfile> directive.

cah-nathan-zender/munge