Merge pull request #166 from OP-TED/release/2.0.0-alpha.6

Release/2.0.0 alpha.6

Author: bertrand-lorentz

CHANGELOG.md

@@ -1,33 +1,65 @@
-# EFX Toolkit 2.0.0-alpha.5 Release Notes
+# EFX Toolkit 2.0.0-alpha.6 Release Notes
 
 _The EFX Toolkit for Java developers is a library that enables the transpilation of [EFX](https://docs.ted.europa.eu/eforms/latest/efx) expressions and templates to different target languages. It also includes an implementation of an EFX-to-XPath transpiler._
 
 ---
 
 ## In this release
 
-This release fixes an a bug that could result in incorrect context computation for EFX template lines when the same field or node was used as both the parent and child line's context using different predicates. The EFX template translator now correctly calculates the child context,  ignoring the predicate of the parent context.
+This is a major update that brings the toolkit in line with the complete EFX-2 grammar as released with SDK 2.0.0-alpha.2.
 
+### EFX-2 language support
 
-## EFX-1 Support
+- Implemented all new EFX-2 language features introduced in SDK 2.0.0-alpha.2. See the [SDK changelog](https://github.com/OP-TED/eForms-SDK/blob/release/2.0.0-alpha.2/CHANGELOG.md) for the full list.
 
-Although this is a pre-release version of the EFX Toolkit, it provides production-level support for EFX-1 transpilation. EFX-1 is the current version of EFX released with SDK 1.
+### EFX Rules translator
 
-NOTE: Transpilation of EFX-1 to XPath and XSL in this version of the EFX Toolkit is **better than** what is provided by **EFX Toolkit 1.3.0**.
+- Added a new EFX Rules to Schematron translator, enabling business rules authored in EFX to be transpiled into Schematron validation schemas.
+- Rules that apply to all notice subtypes are deduplicated into a shared Schematron pattern.
+- New `ValidatorGenerator` interface for Schematron output generation.
+
+### Dependency analysis
+
+- Added dependency extractors for EFX rules, producing dependency graphs that track field, codelist, and variable references.
+
+### Template translator
+
+- Dictionary lookups are now translated using XSL keys for better performance.
+- Profiling and timing support for template translation via new `TranslatorOptions` methods.
+
+### EFX autocomplete API
+
+- Added an autocomplete API for code editors, providing completion items for EFX keywords, built-in functions, and field properties.
 
+### New interfaces and classes
 
-## EFX-2 Support
+- `ValidatorGenerator`: Interface for generating validation output (Schematron).
+- `TranslatorContext`: Interface providing translation context to `MarkupGenerator` methods.
+- `TypeChecker`: Interface for SDK-specific type validation.
+- `IncludedFileResolver`: Interface for resolving `#include` directives in EFX files.
+- New typed exception hierarchy: `EfxCompilationException`, `InvalidArgumentException`, `InvalidIdentifierException`, `InvalidIndentationException`, `InvalidUsageException`, `SdkInconsistencyException`, `SymbolResolutionException`, `TranslatorConfigurationException`, `TypeMismatchException`.
 
-The new version of EFX is still under development and will be released with SDK 2.0.0. For more information of EFX-2 see the release notes of the eForms SDK 2.0.0-alpha.1.
+### Bug fixes
+
+- Fixed invalid XPath in typed uniqueness conditions.
+- Fixed quote escaping in string literals.
+
+## EFX-1 Support
+
+Although this is a pre-release version of the EFX Toolkit, it provides production-level support for EFX-1 transpilation. EFX-1 is the current version of EFX released with SDK 1.
+
+NOTE: Transpilation of EFX-1 to XPath and XSL in this version of the EFX Toolkit is **better than** what is provided by **EFX Toolkit 1.3.0**.
 
 ## Breaking changes
 
-For users of the Toolkit that have implemented custom transpilers, this release contains a few breaking changes from 1.3.0.
-More specifically:
+For users of the Toolkit that have implemented custom transpilers, this release contains breaking changes from 2.0.0-alpha.5:
 
-- Some additional methods have been added to the SymbolResolver, ScriptGenerator and MarkupGenerator API. As a guide for your implementations please look a the implementations included in the EFX Toolkit for use by the EFX-to-XPath transpilation.
-- Some deprecated methods were removed.
-- An extensive refactoring in the type management system has rearranged the package structure. As a result some import statements in your code will need to be updated.
+- The expression model has been refactored to separate scalar and sequence types. The `path` subpackage has been removed and path expression types have been moved and renamed (e.g. `BooleanPathExpression` → `BooleanPath` under `scalar`).
+- `MarkupGenerator.composeOutputFile` signature changed from 2 parameters to 5 (globals, main section, summary section, navigation section, fragments). The old signature is deprecated with a default implementation.
+- Several new methods have been added to the `SymbolResolver`, `ScriptGenerator`, and `MarkupGenerator` interfaces.
+- `TranslatorOptions` has three new methods without defaults: `getUserDefinedFunctionNamespace()`, `isProfilerEnabled()`, `getProfilerOutputPath()`.
+- New typed exception classes replace previously generic exceptions.
+- Axis support and cross-notice references have been removed from the V2 translator.
 
 Users of the Toolkit that only use the included EFX-to-XPath transpiler will not be affected by the above changes.
 
@@ -37,16 +69,18 @@ Further alpha and beta releases of SDK 2 and EFX Toolkit 2 will be issued. While
 
 ---
 
-You can download the latest EFX Toolkit from Maven Central.  
+You can download the latest EFX Toolkit from Maven Central.
 [![Maven Central](https://img.shields.io/maven-central/v/eu.europa.ted.eforms/efx-toolkit-java?label=Download%20&style=flat-square)](https://central.sonatype.com/artifact/eu.europa.ted.eforms/efx-toolkit-java)
 
 Documentation for the EFX Toolkit is available at: <https://docs.ted.europa.eu/eforms/latest/efx-toolkit>
 
 ---
 
-This version of the EFX Toolkit has a compile-time dependency on the following versions of eForms SDK versions and uses the EFX grammar that each version provides:
+This version of the EFX Toolkit has a compile-time dependency on the following eForms SDK versions and uses the EFX grammar that each version provides:
+
+- eForms SDK 1.x.x (SDK 1.13.0 grammar)
+- eForms SDK 2.0.0-alpha.2
 
-- eForms SDK 1.x.x
-- eForms SDK 2.0.0-alpha.1
+It also depends on the [eForms Core Java library](https://github.com/OP-TED/eforms-core-java) version 1.6.0.
 
-It also depends on the [eForms Core Java library](https://github.com/OP-TED/eforms-core-java) version 1.4.0.
+NOTE: The POM currently references SNAPSHOT versions for the SDK 2 and Core dependencies. These will be updated to released versions before publication.

pom.xml

@@ -3,7 +3,7 @@
 
   <groupId>eu.europa.ted.eforms</groupId>
   <artifactId>efx-toolkit-java</artifactId>
-  <version>2.0.0-alpha.5</version>
+  <version>2.0.0-alpha.6</version>
   <packaging>jar</packaging>
 
   <name>EFX Toolkit for Java</name>
@@ -46,22 +46,26 @@
     <sdk.antlr4.dir>${project.build.directory}/eforms-sdk/antlr4</sdk.antlr4.dir>
 
     <!-- Versions - eForms -->
-    <version.eforms-core>1.5.0</version.eforms-core>
+    <version.eforms-sdk-1>1.13.0</version.eforms-sdk-1>
+    <version.eforms-sdk-2>2.0.0-alpha.2</version.eforms-sdk-2>
+    <version.eforms-core>1.6.0</version.eforms-core>
 
     <!-- Versions - Third-party libraries -->
     <version.antlr4>4.13.1</version.antlr4>
-    <version.commons-lang3>3.12.0</version.commons-lang3>
-    <version.logback>1.2.11</version.logback>
-    <version.jackson>2.13.4</version.jackson>
-    <version.jackson-databind>2.13.4.2</version.jackson-databind>
+    <version.commons-lang3>3.18.0</version.commons-lang3>
+    <version.freemarker>2.3.34</version.freemarker>
+    <version.logback>1.5.18</version.logback>
+    <version.jackson>2.18.3</version.jackson>
+    <version.jackson-databind>2.18.3</version.jackson-databind>
     <version.junit-jupiter>5.7.2</version.junit-jupiter>
-    <version.slf4j>1.7.36</version.slf4j>
+    <version.saxon-he>11.3</version.saxon-he>
+    <version.slf4j>2.0.13</version.slf4j>
 
     <!-- Versions - Plugins -->
     <version.build-helper.plugin>3.3.0</version.build-helper.plugin>
     <version.dependency.plugin>3.3.0</version.dependency.plugin>
     <version.install.plugin>2.5.2</version.install.plugin>
-    <version.jacoco.plugin>0.8.8</version.jacoco.plugin>
+    <version.jacoco.plugin>0.8.12</version.jacoco.plugin>
     <version.jar.plugin>3.2.0</version.jar.plugin>
     <version.javadoc.plugin>3.4.0</version.javadoc.plugin>
     <version.pgp.plugin>1.5</version.pgp.plugin>
@@ -119,6 +123,16 @@
         <artifactId>antlr4-runtime</artifactId>
         <version>${version.antlr4}</version>
       </dependency>
+      <dependency>
+        <groupId>org.freemarker</groupId>
+        <artifactId>freemarker</artifactId>
+        <version>${version.freemarker}</version>
+      </dependency>
+      <dependency>
+        <groupId>net.sf.saxon</groupId>
+        <artifactId>Saxon-HE</artifactId>
+        <version>${version.saxon-he}</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 
@@ -139,11 +153,20 @@
       <artifactId>junit-jupiter-params</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>net.sf.saxon</groupId>
+      <artifactId>Saxon-HE</artifactId>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.antlr</groupId>
       <artifactId>antlr4-runtime</artifactId>
       <scope>compile</scope>
     </dependency>
+    <dependency>
+      <groupId>org.freemarker</groupId>
+      <artifactId>freemarker</artifactId>
+    </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-core</artifactId>
@@ -219,6 +242,15 @@
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
           <version>${version.javadoc.plugin}</version>
+          <configuration>
+            <doclint>all,-missing</doclint>
+            <sourceFileExcludes>
+              <exclude>**/EfxLexer.java</exclude>
+              <exclude>**/EfxParser.java</exclude>
+              <exclude>**/EfxListener.java</exclude>
+              <exclude>**/EfxBaseListener.java</exclude>
+            </sourceFileExcludes>
+          </configuration>
         </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
@@ -257,7 +289,7 @@
             <artifactItem>
               <groupId>eu.europa.ted.eforms</groupId>
               <artifactId>eforms-sdk</artifactId>
-              <version>2.0.0-alpha.1</version>
+              <version>${version.eforms-sdk-2}</version>
               <type>jar</type>
               <includes>eforms-sdk/efx-grammar/**/*.g4</includes>
               <outputDirectory>${sdk.antlr4.dir}/eu/europa/ted/efx/sdk2</outputDirectory>
@@ -269,7 +301,7 @@
             <artifactItem>
               <groupId>eu.europa.ted.eforms</groupId>
               <artifactId>eforms-sdk</artifactId>
-              <version>1.6.0</version>
+              <version>${version.eforms-sdk-1}</version>
               <type>jar</type>
               <includes>eforms-sdk/efx-grammar/**/*.g4</includes>
               <outputDirectory>${sdk.antlr4.dir}/eu/europa/ted/efx/sdk1</outputDirectory>

src/main/java/eu/europa/ted/eforms/sdk/ComponentFactory.java

@@ -1,7 +1,6 @@
 package eu.europa.ted.eforms.sdk;
 
 import java.nio.file.Path;
-import java.text.MessageFormat;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
@@ -12,6 +11,7 @@
 import eu.europa.ted.efx.interfaces.ScriptGenerator;
 import eu.europa.ted.efx.interfaces.SymbolResolver;
 import eu.europa.ted.efx.interfaces.TranslatorOptions;
+import eu.europa.ted.efx.interfaces.ValidatorGenerator;
 
 public class ComponentFactory extends SdkComponentFactory {
   public static final ComponentFactory INSTANCE = new ComponentFactory();
@@ -84,20 +84,23 @@ public static SymbolResolver getSymbolResolver(final String sdkVersion, final Pa
    *        SDK.
    * @throws InstantiationException If the SDK version is not supported.
    */
-  public static SymbolResolver getSymbolResolver(final String sdkVersion, final String qualifier,
+  public static synchronized SymbolResolver getSymbolResolver(final String sdkVersion, final String qualifier,
       final Path sdkRootPath) throws InstantiationException {
     VersionQualifier key = ComponentFactory.INSTANCE.new VersionQualifier(sdkVersion, qualifier);
 
-    return instances.computeIfAbsent(key, k -> {
-      try {
-        return ComponentFactory.INSTANCE.getComponentImpl(sdkVersion,
-            SdkComponentType.SYMBOL_RESOLVER, qualifier, SymbolResolver.class, sdkVersion,
-            sdkRootPath);
-      } catch (InstantiationException e) {
-        throw new RuntimeException(MessageFormat.format(
-            "Failed to instantiate SDK Symbol Resolver for SDK version [{0}]", sdkVersion), e);
-      }
-    });
+    // Check if already exists
+    SymbolResolver existing = instances.get(key);
+    if (existing != null) {
+      return existing;
+    }
+
+    // Create new instance (this can throw InstantiationException)
+    SymbolResolver newInstance = ComponentFactory.INSTANCE.getComponentImpl(sdkVersion,
+        SdkComponentType.SYMBOL_RESOLVER, qualifier, SymbolResolver.class, sdkVersion, sdkRootPath);
+
+    // Store and return
+    instances.put(key, newInstance);
+    return newInstance;
   }
 
   public static MarkupGenerator getMarkupGenerator(final String sdkVersion, TranslatorOptions options)
@@ -111,6 +114,18 @@ public static MarkupGenerator getMarkupGenerator(final String sdkVersion, final
         SdkComponentType.MARKUP_GENERATOR, qualifier, MarkupGenerator.class, options);
   }
 
+  public static ValidatorGenerator getValidatorGenerator(final String sdkVersion,
+      TranslatorOptions options) throws InstantiationException {
+    return getValidatorGenerator(sdkVersion, "", options);
+  }
+
+  public static ValidatorGenerator getValidatorGenerator(final String sdkVersion,
+      final String qualifier, TranslatorOptions options) throws InstantiationException {
+    return ComponentFactory.INSTANCE.getComponentImpl(sdkVersion,
+        SdkComponentType.VALIDATOR_GENERATOR, qualifier, ValidatorGenerator.class,
+        options);
+  }
+
   public static ScriptGenerator getScriptGenerator(final String sdkVersion, TranslatorOptions options)
       throws InstantiationException {
     return getScriptGenerator(sdkVersion, "", options);