Merge pull request #25 from OP-TED/release/1.2.0

Release version 1.2.0

Author: bertrand-lorentz

.gitignore

@@ -1,4 +1,5 @@
 /target/
+.antlr
 .settings
 .project
 .classpath

CHANGELOG.md

@@ -1,9 +1,12 @@
-# eForms Core Library 1.1.0 Release Notes
+# eForms Core Library 1.2.0 Release Notes
 
-_The library is a collection of utilities that are used by our sample applications as well as the EFX Toolkit for Java Developers._
+The eForms Core Library is a collection of utilities that are used by our sample applications as well as the EFX Toolkit for Java Developers.
 
 ## In this release
-This release updates the SdkDownloader to simplify its logic and make sure it resolves pre-release versions of the SDK correctly. 
+
+This release adds some XPath processing capabilities, via the new XPathProcessor class. Those capabilities are available in the EFX Toolkit version 1.x, but as they are also useful if you are not using EFX, we are moving them to the eForms Core Library. The corresponding API will be removed from the EFX Toolkit in its next major version (2.0.0).
+
+The SdkResource enum now has a value corresponding to the index file in the `translations` folder, named `translations.json`. This file is added in SDK 1.10.0.
 
 ## Download
 

README.md

@@ -4,17 +4,17 @@
 
 This library provides a set of classes that can be used to solve some common "problems" in eForms Applications:
 
- * Automatically discovering and downloading new versions of the eForms SDK.
- * Maintaining and instantiating at runtime the correct application component versions for different major versions of the SDK.  
-
+* Automatically discovering and downloading new versions of the eForms SDK.
+* Maintaining and instantiating at runtime the correct application component versions for different major versions of the SDK.
+* Basic parsing and processing of XPath expressions.
 
 ## Using the eForms Core Library
 
 The eForms Core library requires Java 11 or later.
 
 It is available as a Maven package on Maven Central and can be used by adding the following to the project's `pom.xml`.
 
-```
+```xml
 <dependencies>
   ...
   <dependency>
@@ -37,11 +37,19 @@ Requirements:
 
 Execute the following on the root folder of this project:
 
+```text
     mvn clean install
+```
+
+## Testing
+
+Unit tests are available under `src/test/java/`.
 
+After running the unit tests with `mvn test`, you can generate a coverage report with `mvn jacoco:report`.
+The report is available under `target/site/jacoco/`, in HTML, CSV, and XML format.
 
 [^1]: _Copyright 2022 European Union_  
 _Licensed under the EUPL, Version 1.2 or – as soon they will be approved by the European Commission –
 subsequent versions of the EUPL (the "Licence");_
 _You may not use this work except in compliance with the Licence. You may obtain [a copy of the Licence here](LICENSE)._  
-_Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence._
+_Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence._

pom.xml

@@ -3,7 +3,7 @@
 
   <groupId>eu.europa.ted.eforms</groupId>
   <artifactId>eforms-core-java</artifactId>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
 
   <name>eForms Core Library</name>
   <description>API and tools for eForms applications.</description>
@@ -44,7 +44,7 @@
   </distributionManagement>
 
   <properties>
-    <project.build.outputTimestamp>2023-05-10T15:47:46Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2023-11-17T14:42:39Z</project.build.outputTimestamp>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
     <sonatype.server.url>s01.oss.sonatype.org</sonatype.server.url>
@@ -55,6 +55,7 @@
     <maven.compiler.target>${java.version}</maven.compiler.target>
 
     <!-- Versions - Third-party libraries -->
+    <version.antlr4>4.9.3</version.antlr4>
     <version.commons-collections>3.2.2</version.commons-collections>
     <version.commons-io>2.11.0</version.commons-io>
     <version.commons-lang3>3.12.0</version.commons-lang3>
@@ -72,9 +73,11 @@
     <version.slf4j>2.0.3</version.slf4j>
 
     <!-- Versions - Plugins -->
+    <version.build-helper.plugin>3.3.0</version.build-helper.plugin>
     <version.compiler.plugin>3.10.1</version.compiler.plugin>
     <version.gpg.plugin>1.5</version.gpg.plugin>
     <version.install.plugin>2.5.2</version.install.plugin>
+    <version.jacoco.plugin>0.8.10</version.jacoco.plugin>
     <version.javadoc.plugin>3.4.0</version.javadoc.plugin>
     <version.source.plugin>3.2.1</version.source.plugin>
     <version.jar.plugin>3.3.0</version.jar.plugin>
@@ -211,6 +214,11 @@
         <artifactId>jsr305</artifactId>
         <version>${version.jsr305}</version>
       </dependency>
+      <dependency>
+        <groupId>org.antlr</groupId>
+        <artifactId>antlr4-runtime</artifactId>
+        <version>${version.antlr4}</version>
+      </dependency>
       <dependency>
         <groupId>org.jooq</groupId>
         <artifactId>jool</artifactId>
@@ -338,6 +346,10 @@
       <artifactId>jsr305</artifactId>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.antlr</groupId>
+      <artifactId>antlr4-runtime</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.jooq</groupId>
       <artifactId>jool</artifactId>
@@ -367,6 +379,16 @@
             <createChecksum>true</createChecksum>
           </configuration>
         </plugin>
+        <plugin>
+          <groupId>org.antlr</groupId>
+          <artifactId>antlr4-maven-plugin</artifactId>
+          <version>${version.antlr4}</version>
+        </plugin>
+        <plugin>
+          <groupId>org.codehaus.mojo</groupId>
+          <artifactId>build-helper-maven-plugin</artifactId>
+          <version>${version.build-helper.plugin}</version>
+        </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-jar-plugin</artifactId>
@@ -387,13 +409,76 @@
           <artifactId>maven-gpg-plugin</artifactId>
           <version>${version.gpg.plugin}</version>
         </plugin>
+        <plugin>
+          <groupId>org.jacoco</groupId>
+          <artifactId>jacoco-maven-plugin</artifactId>
+          <version>${version.jacoco.plugin}</version>
+        </plugin>
         <plugin>
           <groupId>org.sonatype.plugins</groupId>
           <artifactId>nexus-staging-maven-plugin</artifactId>
           <version>${version.nexus-staging.plugin}</version>
         </plugin>
       </plugins>
     </pluginManagement>
+
+    <plugins>
+      <plugin>
+        <groupId>org.antlr</groupId>
+        <artifactId>antlr4-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>antlr</id>
+            <goals>
+              <goal>antlr4</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>add-source</id>
+            <phase>generate-sources</phase>
+            <goals>
+              <goal>add-source</goal>
+            </goals>
+            <configuration>
+              <sources>
+                <source>${project.build.directory}/generated-sources/antlr4/</source>
+              </sources>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+
+      <plugin>
+        <groupId>org.jacoco</groupId>
+        <artifactId>jacoco-maven-plugin</artifactId>
+        <configuration>
+          <excludes>
+            <exclude>**/XPath20*.class</exclude>
+          </excludes>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>prepare-agent</goal>
+            </goals>
+          </execution>
+          <execution>
+            <id>report</id>
+            <phase>prepare-package</phase>
+            <goals>
+              <goal>report</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
   </build>
 
   <profiles>