Merge pull request #27 from OP-TED/release/1.3.0

Merge release/1.3.0 into main

Author: bertrand-lorentz

CHANGELOG.md

@@ -1,12 +1,10 @@
-# eForms Core Library 1.2.0 Release Notes
+# eForms Core Library 1.3.0 Release Notes
 
 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 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.
+This release improves XPathProcessor contextualisation by fixing an issue that caused unnecessary back-steps to be inserted in the contextualised output when both XPaths contain predicates.
 
 ## Download
 

pom.xml

@@ -3,7 +3,7 @@
 
   <groupId>eu.europa.ted.eforms</groupId>
   <artifactId>eforms-core-java</artifactId>
-  <version>1.2.0</version>
+  <version>1.3.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-11-17T14:42:39Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2023-11-17T15:30:31Z</project.build.outputTimestamp>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
     <sonatype.server.url>s01.oss.sonatype.org</sonatype.server.url>

src/main/java/eu/europa/ted/eforms/xpath/XPathProcessor.java

@@ -72,10 +72,10 @@ private static String getContextualizedXpath(Queue<XPathStep> contextQueue,
       // At this point there are no more matching nodes in the two queues.
 
       // We look at the first of the remaining steps in both queues and look if
-      // the context is more restrictive than the path. In this case we want to use a dot step
-      // with the predicate of the path.
+      // the context is the same as or less restrictive than the path. In this case
+      // we want to use a dot step with the predicate of the path.
       if (!contextQueue.isEmpty() && !pathQueue.isEmpty()
-          && pathQueue.peek().isSimilarTo(contextQueue.peek())) {
+          && pathQueue.peek().isSameAsOrNarrowerThan(contextQueue.peek())) {
         contextQueue.poll();  // consume the same step from the contextQueue
         if (contextQueue.isEmpty()) {
           // Since there are no more steps in the contextQueue, the relative xpath should 

src/main/java/eu/europa/ted/eforms/xpath/XPathStep.java

@@ -116,7 +116,20 @@ public boolean isTheSameAs(final XPathStep other) {
     return pathPredicates.equals(contextPredicates);
   }
 
+  /*
+   * @deprecated Use {@link #isSameAsOrNarrowerThan(XPathStep)} instead.
+   *
+   * This method was renamed for clarity. It is marked as deprecated so that the
+   * library interface does not change. It will be removed in the next major
+   * version of the library.
+   * 
+   */
+  @Deprecated(since = "1.3.0", forRemoval = true)
   public boolean isSimilarTo(final XPathStep other) {
+    return isSameAsOrNarrowerThan(other);
+  }
+
+  public boolean isSameAsOrNarrowerThan(final XPathStep other) {
 
     // First check the step texts are different.
     if (!Objects.equals(other.stepText, this.stepText)) {
@@ -125,13 +138,15 @@ public boolean isSimilarTo(final XPathStep other) {
 
     // If one of the two steps has more predicates that the other,
     if (this.predicates.size() != other.predicates.size()) {
-      // then the steps are similar if either of them has no predicates
-      // or all the predicates of this step are also found in the specific step.
-      return this.predicates.isEmpty() || other.predicates.isEmpty()
-          || other.predicates.containsAll(this.predicates);
+      // then this step is same as or narrower that the other, if either of them has
+      // no predicates or all the predicates of the other step are also found in this
+      // step. In this case this step has the same predicates as the other one, plus
+      // some more, which means it selects a subset of the nodes selected by the other
+      // step and therefore it is "narrower".
+      return other.predicates.isEmpty() || this.predicates.containsAll(other.predicates);
     }
 
-    assert !this.isTheSameAs(other) : "You should not be calling isSimilarTo() without first checking isTheSameAs()";
+    assert !this.isTheSameAs(other) : "You should not be calling isSameAsOrNarrowerThan() without first checking isTheSameAs()";
     return false;
   }
 

src/test/java/eu/europa/ted/eforms/xpath/XPathProcessorTest.java

@@ -63,6 +63,11 @@ void testIdentical() {
     assertEquals(".", contextualize("/a/b/c", "/a/b/c"));
   }
 
+  @Test
+  void testIdentical_WithPredicates() {
+    assertEquals(".[d = e][f = g]", contextualize("/a/b/c[d = e]", "/a/b/c[d = e][f = g]"));
+  }
+
   @Test
   void testContextEmpty() {
     assertEquals("/a/b/c", contextualize("", "/a/b/c"));
@@ -176,7 +181,7 @@ void testPredicateDifferent() {
 
   @Test
   void testPredicateMoreInXpath() {
-    assertEquals("../../b[e][f]/c/d", contextualize("/a/b[e]/c", "/a/b[e][f]/c/d"));
+    assertEquals("..[e][f]/c/d", contextualize("/a/b[e]/c", "/a/b[e][f]/c/d"));
   }
 
   @Test

src/test/java/eu/europa/ted/eforms/xpath/XPathStepTest.java

@@ -33,7 +33,7 @@ void testComparison_DifferentElement() {
 
     assertFalse(a.isTheSameAs(b));
 
-    assertFalse(a.isSimilarTo(b));
+    assertFalse(a.isSameAsOrNarrowerThan(b));
   }
 
   @Test
@@ -43,7 +43,7 @@ void testComparison_MorePredicates() {
 
     assertTrue(a.isTheSameAs(b));
 
-    assertTrue(a.isSimilarTo(b));
+    assertTrue(b.isSameAsOrNarrowerThan(a));
   }
 
   @Test
@@ -53,7 +53,7 @@ void testComparison_LessPredicates() {
 
     assertFalse(a.isTheSameAs(b));
 
-    assertFalse(a.isSimilarTo(b));
+    assertFalse(b.isSameAsOrNarrowerThan(a));
   }
 
   @Test
@@ -63,7 +63,7 @@ void testComparison_DifferentPredicate() {
 
     assertFalse(a.isTheSameAs(b));
 
-    assertFalse(a.isSimilarTo(b));
+    assertFalse(a.isSameAsOrNarrowerThan(b));
   }
 
   @Test
@@ -73,7 +73,7 @@ void testComparison_NoPredicates() {
 
     assertFalse(a.isTheSameAs(b));
 
-    assertTrue(a.isSimilarTo(b));
+    assertTrue(a.isSameAsOrNarrowerThan(b));
   }
 
   @Test
@@ -83,7 +83,7 @@ void testComparison_AddPredicates() {
 
     assertTrue(a.isTheSameAs(b));
 
-    assertTrue(a.isSimilarTo(b));
+    assertTrue(b.isSameAsOrNarrowerThan(a));
   }
 
   private XPathStep buildStep(String elt, String... predicates) {