Merge pull request #18 from OP-TED/release/1.0.5

Release/1.0.5

Author: rousso

CHANGELOG.md

@@ -1,9 +1,11 @@
-# eForms Core Library 1.0.4 Release Notes
+# eForms Core Library 1.0.5 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._
 
 ## In this release:
-This patch includes code optimizations and bug fixes.
+This patch 
+- improves performance by lazy-loading codelists,
+- improves handling of SemVer 2.0 version numbers.
 
 ## Download
 

pom.xml

@@ -3,7 +3,7 @@
 
   <groupId>eu.europa.ted.eforms</groupId>
   <artifactId>eforms-core-java</artifactId>
-  <version>1.0.4</version>
+  <version>1.0.5</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:13:30Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2023-05-10T15:47:46Z</project.build.outputTimestamp>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
     <sonatype.server.url>s01.oss.sonatype.org</sonatype.server.url>
@@ -58,8 +58,7 @@
     <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>
-    <version.jackson>2.13.4</version.jackson>
-    <version.jackson-databind>2.13.4.2</version.jackson-databind>
+    <version.jackson>2.15.1</version.jackson>
     <version.jool>0.9.15</version.jool>
     <version.jsr305>3.0.2</version.jsr305>
     <version.junit>5.7.2</version.junit>
@@ -69,6 +68,7 @@
     <version.ph-genericode>6.2.0</version.ph-genericode>
     <version.reflections>0.10.2</version.reflections>
     <version.resolver>1.8.2</version.resolver>
+    <version.semver4j>3.1.0</version.semver4j>
     <version.slf4j>2.0.3</version.slf4j>
 
     <!-- Versions - Plugins -->
@@ -103,7 +103,7 @@
       <dependency>
         <groupId>com.fasterxml.jackson.core</groupId>
         <artifactId>jackson-databind</artifactId>
-        <version>${version.jackson-databind}</version>
+        <version>${version.jackson}</version>
       </dependency>
 
       <!-- Apache Commons -->
@@ -221,6 +221,11 @@
         <artifactId>junit-jupiter-api</artifactId>
         <version>${version.junit}</version>
       </dependency>
+      <dependency>
+        <groupId>com.vdurmont</groupId>
+        <artifactId>semver4j</artifactId>
+        <version>${version.semver4j}</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 
@@ -342,6 +347,10 @@
       <artifactId>junit-jupiter-api</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.vdurmont</groupId>
+      <artifactId>semver4j</artifactId>
+    </dependency>
   </dependencies>
 
   <build>

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

@@ -1,79 +1,60 @@
 package eu.europa.ted.eforms.sdk;
 
-import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
-import java.util.Optional;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.Validate;
 
-public class SdkVersion implements Comparable<SdkVersion> {
-  private static final String FORMAT_PATTERN = "{0}.{1}.{2}";
-
-  private String major = "0";
-
-  private String minor = "0";
+import com.vdurmont.semver4j.Semver;
+import com.vdurmont.semver4j.Semver.SemverType;
 
-  private String patch = "0";
-
-  private boolean isPatch = false;
+public class SdkVersion implements Comparable<SdkVersion> {
 
-  @SuppressWarnings("unused")
-  private SdkVersion() {}
+  private final Semver version;
 
   public SdkVersion(final String version) {
     Validate.notBlank(version, "Undefined version");
-    Validate.matchesPattern(version, "[0-9]+(\\.[0-9]+)*(-SNAPSHOT)?", "Invalid version format");
-
-    String[] versionParts = version.split("\\.");
 
-    this.major = versionParts[0];
+    // LOOSE because we need to accept MAJOR.MINOR
+    this.version = new Semver(version, SemverType.LOOSE);
 
-    if (versionParts.length > 1) {
-      this.minor = versionParts[1];
-    }
-
-    if (versionParts.length > 2) {
-      this.isPatch = true;
-      this.patch = versionParts[2];
-    }
+    // Check that we did get a MINOR part
+    Validate.notNull(this.version.getMinor());
   }
 
   public String getMajor() {
-    return major;
+    return version.getMajor().toString();
   }
 
   public String getMinor() {
-    return minor;
+    return version.getMinor().toString();
   }
 
   public String getPatch() {
-    return patch;
+    return version.getPatch() == null ? "0" : version.getPatch().toString();
   }
 
   public String getNextMajor() {
-    return new SdkVersion(MessageFormat.format(FORMAT_PATTERN, getAsInt(major) + 1, minor, patch))
-        .toString();
+    return version.withIncMajor().toString();
   }
 
   public String getNextMinor() {
-    return new SdkVersion(MessageFormat.format(FORMAT_PATTERN, major, getAsInt(minor) + 1, patch))
-        .toString();
+    return version.withIncMinor().toString();
   }
 
   public boolean isPatch() {
-    return isPatch;
+    return version.getPatch() != null;
   }
 
   public String toNormalisedString(boolean withPatch) {
     List<String> parts = new ArrayList<>();
 
-    parts.add(major);
-    parts.add(minor);
+    parts.add(getMajor());
+    parts.add(getMinor());
 
     if (withPatch) {
-      parts.add(patch);
+      parts.add(getPatch());
     }
 
     return StringUtils.join(parts, ".");
@@ -85,7 +66,7 @@ public String toStringWithoutPatch() {
 
   @Override
   public String toString() {
-    return toNormalisedString(true);
+    return version.toString();
   }
 
   @Override
@@ -98,24 +79,12 @@ public int compareTo(SdkVersion that) {
       return 0;
     }
 
-    if (getAsInt(this.getMajor()) == getAsInt(that.getMajor())) {
-      if (getAsInt(this.getMinor()) == getAsInt(that.getMinor())) {
-        return getAsInt(this.getPatch()) < getAsInt(that.getPatch()) ? -1 : 1;
-      } else {
-        return getAsInt(this.getMinor()) < getAsInt(that.getMinor()) ? -1 : 1;
-      }
-    } else {
-      return getAsInt(this.getMajor()) < getAsInt(that.getMajor()) ? -1 : 1;
-    }
-  }
-
-  private int getAsInt(String versionPart) {
-    return Integer.parseInt(Optional.ofNullable(versionPart).orElse("0").replace("-SNAPSHOT", ""));
+    return version.compareTo(that.version);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(major, minor, patch);
+    return Objects.hash(version);
   }
 
   @Override
@@ -127,7 +96,6 @@ public boolean equals(Object obj) {
     if (getClass() != obj.getClass())
       return false;
     SdkVersion other = (SdkVersion) obj;
-    return Objects.equals(major, other.major) && Objects.equals(minor, other.minor)
-        && Objects.equals(patch, other.patch);
+    return Objects.equals(version, other.version);
   }
 }

src/main/java/eu/europa/ted/eforms/sdk/domain/codelist/CodelistForIndex.java

@@ -0,0 +1,37 @@
+package eu.europa.ted.eforms.sdk.domain.codelist;
+
+import java.io.Serializable;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class CodelistForIndex implements Serializable {
+  private static final long serialVersionUID = 4221672498810948002L;
+
+  private String id;
+  private String parentId;
+  private String filename;
+  private String description;
+
+  @JsonProperty("_label")
+  private String labelId;
+
+  public String getId() {
+    return id;
+  }
+
+  public String getParentId() {
+    return parentId;
+  }
+
+  public String getFilename() {
+    return filename;
+  }
+
+  public String getDescription() {
+    return description;
+  }
+
+  @JsonProperty("_label")
+  public String getLabel() {
+    return labelId;
+  }
+}

src/main/java/eu/europa/ted/eforms/sdk/domain/codelist/CodelistsIndex.java

@@ -0,0 +1,14 @@
+package eu.europa.ted.eforms.sdk.domain.codelist;
+
+import java.io.Serializable;
+import java.util.List;
+
+public class CodelistsIndex implements Serializable {
+  private static final long serialVersionUID = -6549217565224309697L;
+
+  private List<CodelistForIndex> codelists;
+
+  public List<CodelistForIndex> getCodelists() {
+    return codelists;
+  }
+}