1.0.2 Upgrade Project Keeper

This release fixes sonar warnings and updates dependencies.

Dependency Updates

Test Dependency Updates

• Updated org.hamcrest:hamcrest:2.2 to 3.0
• Removed org.junit.jupiter:junit-jupiter-engine:5.9.2
• Updated org.junit.jupiter:junit-jupiter-params:5.9.2 to 5.13.4

Plugin Dependency Updates

• Updated com.exasol:error-code-crawler-maven-plugin:1.2.2 to 2.0.5
• Updated com.exasol:project-keeper-maven-plugin:2.9.3 to 5.4.3
• Added com.exasol:quality-summarizer-maven-plugin:0.2.1
• Added io.github.git-commit-id:git-commit-id-maven-plugin:9.0.2
• Removed io.github.zlika:reproducible-build-maven-plugin:0.16
• Added org.apache.maven.plugins:maven-artifact-plugin:3.6.1
• Updated org.apache.maven.plugins:maven-clean-plugin:3.2.0 to 3.5.0
• Updated org.apache.maven.plugins:maven-compiler-plugin:3.10.1 to 3.14.1
• Updated org.apache.maven.plugins:maven-deploy-plugin:3.0.0 to 3.1.4
• Updated org.apache.maven.plugins:maven-enforcer-plugin:3.1.0 to 3.6.2
• Updated org.apache.maven.plugins:maven-gpg-plugin:3.0.1 to 3.2.8
• Updated org.apache.maven.plugins:maven-install-plugin:3.1.2 to 3.1.4
• Updated org.apache.maven.plugins:maven-javadoc-plugin:3.4.1 to 3.12.0
• Updated org.apache.maven.plugins:maven-site-plugin:3.12.1 to 3.21.0
• Updated org.apache.maven.plugins:maven-surefire-plugin:3.0.0-M8 to 3.5.4
• Added org.apache.maven.plugins:maven-toolchains-plugin:3.2.0
• Added org.basepom.maven:duplicate-finder-maven-plugin:2.0.1
• Updated org.codehaus.mojo:flatten-maven-plugin:1.3.0 to 1.7.3
• Updated org.codehaus.mojo:versions-maven-plugin:2.14.2 to 2.19.1
• Updated org.jacoco:jacoco-maven-plugin:0.8.8 to 0.8.14
• Updated org.sonarsource.scanner.maven:sonar-maven-plugin:3.9.1.2184 to 5.2.0.4988
• Added org.sonatype.central:central-publishing-maven-plugin:0.9.0
• Removed org.sonatype.plugins:nexus-staging-maven-plugin:1.6.13

1.0.1: Convert to Java Module

Summary

This release adds a module-info.java file to allow using this library in other Java modules.

Features

• #40: Added a module-info.java file

Dependency Updates

Test Dependency Updates

• Updated org.junit.jupiter:junit-jupiter-engine:5.9.0 to 5.9.2
• Updated org.junit.jupiter:junit-jupiter-params:5.9.0 to 5.9.2

Plugin Dependency Updates

• Updated com.exasol:error-code-crawler-maven-plugin:1.1.2 to 1.2.2
• Updated com.exasol:project-keeper-maven-plugin:2.6.2 to 2.9.3
• Updated io.github.zlika:reproducible-build-maven-plugin:0.15 to 0.16
• Updated org.apache.maven.plugins:maven-deploy-plugin:3.0.0-M1 to 3.0.0
• Updated org.apache.maven.plugins:maven-javadoc-plugin:3.4.0 to 3.4.1
• Updated org.apache.maven.plugins:maven-surefire-plugin:3.0.0-M5 to 3.0.0-M8
• Updated org.codehaus.mojo:flatten-maven-plugin:1.2.7 to 1.3.0
• Updated org.codehaus.mojo:versions-maven-plugin:2.10.0 to 2.14.2

1.0.0: Quoting enhancements

Summary

In this release we added a guideline for deleting error codes and migrated the project to Project Keeper 2.When you use Java types Path, File, URL or URI as parameter in a message, it now automatically gets quoted. Note that this can break existing unit tests in you code or client code that parses error messages.

We also now support quoting with double quotes.Note that we removed the deprecated unquotedParameter methods.

Quoting is now exclusively controlled by the following single-character switches:

u
: unquoted

q
: forced single quoted

d
: forced double quotes

none
: automatic quoting depending on the type.

If multiple conflicting switches are given, the one with the highest precedence (see list above) is taken.That means the previous uq switch still works because the q is ignored in this case.Quoting now supports all collections, not only lists.

Documentation

• #30: Improved documentation

Dependency Updates

Test Dependency Updates

• Updated org.junit.jupiter:junit-jupiter-engine:5.8.1 to 5.9.0
• Updated org.junit.jupiter:junit-jupiter-params:5.8.1 to 5.9.0

Plugin Dependency Updates

• Added com.exasol:error-code-crawler-maven-plugin:1.1.2
• Updated com.exasol:project-keeper-maven-plugin:1.3.2 to 2.6.2
• Updated io.github.zlika:reproducible-build-maven-plugin:0.14 to 0.15
• Updated org.apache.maven.plugins:maven-clean-plugin:3.1.0 to 2.5
• Updated org.apache.maven.plugins:maven-compiler-plugin:3.8.1 to 3.10.1
• Updated org.apache.maven.plugins:maven-deploy-plugin:2.8.2 to 3.0.0-M1
• Updated org.apache.maven.plugins:maven-enforcer-plugin:3.0.0 to 3.1.0
• Updated org.apache.maven.plugins:maven-install-plugin:2.5.2 to 2.4
• Updated org.apache.maven.plugins:maven-jar-plugin:3.2.0 to 2.4
• Updated org.apache.maven.plugins:maven-javadoc-plugin:3.3.1 to 3.4.0
• Updated org.apache.maven.plugins:maven-resources-plugin:3.2.0 to 2.6
• Updated org.apache.maven.plugins:maven-site-plugin:3.9.1 to 3.3
• Updated org.apache.maven.plugins:maven-surefire-plugin:3.0.0-M3 to 3.0.0-M5
• Added org.codehaus.mojo:flatten-maven-plugin:1.2.7
• Updated org.codehaus.mojo:versions-maven-plugin:2.8.1 to 2.10.0
• Updated org.jacoco:jacoco-maven-plugin:0.8.7 to 0.8.8
• Added org.sonarsource.scanner.maven:sonar-maven-plugin:3.9.1.2184
• Updated org.sonatype.ossindex.maven:ossindex-maven-plugin:3.1.0 to 3.2.0
• Updated org.sonatype.plugins:nexus-staging-maven-plugin:1.6.8 to 1.6.13

0.4.1: Migrated Travis CI to Github Actions

Summary

In this release, we changed the Continuous Integration (CI) environment from Travis CI to Github Actions.

Features

• #31: Migrated from Travis CI to Github Actions

Dependency Updates

Test Dependency Updates

• Updated org.junit.jupiter:junit-jupiter-engine:5.6.2 to 5.8.1
• Updated org.junit.jupiter:junit-jupiter-params:5.6.2 to 5.8.1

Plugin Dependency Updates

• Updated com.exasol:project-keeper-maven-plugin:0.4.2 to 1.3.2
• Added io.github.zlika:reproducible-build-maven-plugin:0.14
• Updated org.apache.maven.plugins:maven-clean-plugin:2.5 to 3.1.0
• Updated org.apache.maven.plugins:maven-deploy-plugin:2.7 to 2.8.2
• Updated org.apache.maven.plugins:maven-enforcer-plugin:3.0.0-M3 to 3.0.0
• Updated org.apache.maven.plugins:maven-gpg-plugin:1.6 to 3.0.1
• Updated org.apache.maven.plugins:maven-install-plugin:2.4 to 2.5.2
• Updated org.apache.maven.plugins:maven-jar-plugin:2.4 to 3.2.0
• Updated org.apache.maven.plugins:maven-javadoc-plugin:3.2.0 to 3.3.1
• Updated org.apache.maven.plugins:maven-resources-plugin:2.6 to 3.2.0
• Updated org.apache.maven.plugins:maven-site-plugin:3.3 to 3.9.1
• Updated org.codehaus.mojo:versions-maven-plugin:2.7 to 2.8.1
• Updated org.jacoco:jacoco-maven-plugin:0.8.5 to 0.8.7

Added `PlaceholderMatcher` to public API

Summary

In this release we made the PlaceholderMatcher public so that it can be used in other projects.

Features

• #25: Made ParametersMapper public

New API for simpler formatting

Summary

In this release we add the possibility to define parameters for place holders directly in the ErrorMessageBuilder.message and ErrorMessageBuilder.mitigation methods.

When calling ErrorMessageBuilder.message place holders are defined in the message pattern by using double curly brackets {{}}.
By default, arguments are formatted with simple quotes unless specified other wise with {{|uq}}.

You should always define names in the place holders. This name will be shown in case the argument is missing, by
{{argumentName}} or {{argumentName|uq}}.

Below you can find examples on how to use this new feature.

Example for quoted arguments:

ErrorMessageBuilder("ERROR_CODE").message("Message with {{namedQuotedArgument}}, {{}} and {{missingQuotedArgument}}, "named", "unnamed")
returns "ERROR_CODE: Message with 'named', 'unnamed' and UNKNOWN PLACEHOLDER('anotherQuotedArgument')".

Example for unquoted arguments:

ErrorMessageBuilder("ERROR_CODE").message("Message with {{namedUnquotedArgument|uq}}, {{|uq}} and {{missingUnquotedArgument|uq}}, "named", "unnamed")
returns "ERROR_CODE: Message with named, unnamed and UNKNOWN PLACEHOLDER('anotherQuotedArgument')".

The same examples apply for the ErrorMessageBuilder.mitigation method.

The ErrorMessageBuilder.unquotedParameter API method is also deprecated. To define that a parameter is unquoted you should use the |uq suffix in the correspondent placeholder as described above.

Features

• #20: Make the API less verbose.
• #23: Deprecate ErrorMessageBuilder.unquotedParameter API method.

Fixed null value for parameters

Bugfixes

• #15: Fixed null value for parameters

'Please open a ticket' message builder

Features / Enhancements

• #5: Added convenience builder for 'Please open a ticket' messages

Fixed transitive CVE-2020-15250

Bugfixes

• #12: Fixed CVE-2020-15250 by removing dependency

Dependency Updates

• Removed org.junit.platform:junit-platform-runner

Fixed placeholders in mitigations

Bugfixes

• #6: Placeholder in mitigations were not replaced
• #10: NullPointerException cause by $ in parameter