Release 2.0.0 (#24)

* Bump version

* Update GitHub Actions (#13)

* Update Github Actions

* Change compiler source and target on JDK higher than 17 for tests

* Delegate source parameter for javadoc to maven.compiler.source

* Add tests as JDK 11, 17 and 21

* Update Maven plugins. Update junit version. Fix wrong <scm> values.

* Add devcontainer

* Update Github Actions

* Remove jdk25-ea

* Fix javadoc warnings

* Revert "Fix javadoc warnings"

This reverts commit b20a5d9.

* Add jmh benchmark

* Set release version

* Fix echo on bench.yml

* Fix multiline commands on bench.yml

* Reduce warmup time

* Escape backticks on bench.yml

* Bump version

* Feature: Implement immutable sortable ULID instance.
Breaking change: Random default instance use a lazily instantiated SecureRandom.
Breaking change: generate, generateBinary, toBinary, fromBinary now checks for ULID validity.
Fix: Prevent monotonic ULID increment entropy on invalid timestamp.
Fix: First 8 bit of timestamp may be converted wrongly.
Feature: Add JaCoCo report.
Feature: More tests and benchmarks.

* Fix: Fix surefire-report

* Fix: Remove test that changes private constructor to public.

* Fix: Wrong job name for site.yml

* Fix: Remove mocks (JDK incompatibility, offline JDK instrumentation is brittle)
Fix: Remove private constructor for ULID.
Fix: Update Javadoc plugin.
Feature: Add source cross reference plugin.

* Update license

* Feature: Add Monotonic.random static methods
Fix: Documentation

* Update Github actions

* Add parseULID benchmark

* Update devcontainer.json

* Set release version

* Remove dependabot.yml

* Bump version

* Bump version

* Update to Java 11

* Change to Junit 5

* Fix version on module-info.java

* Implement generating timestamp from java.time.Clock

* Tests for generating timestamp from java.time.Clock

* Update readme and javadoc

* Add benchmarks for clock parameter

* Set release version

Author: azam

.devcontainer/devcontainer.json

@@ -4,8 +4,8 @@
     "features": {
         "ghcr.io/devcontainers/features/java:1": {
             "jdkDistro": "tem",
-            "version": "8.0.442",
-            "mavenVersion": "3.8.8",
+            "version": "11.0.26",
+            "mavenVersion": "3.9.9",
             "installMaven": true
         }
     },

.github/workflows/bench.yml

@@ -16,22 +16,12 @@ jobs:
       matrix:
         include:
           # Oldest LTS
-          - name: temurin-jdk8-target-jdk7
-            version: 8
+          - name: temurin-jdk11-target-jdk11
+            version: 11
             distribution: temurin
-            target: 7
-            targetStr: '1.7'
-          - name: temurin-jdk8-target-jdk8
-            version: 8
-            distribution: temurin
-            target: 8
-            targetStr: '1.8'
+            target: 11
+            targetStr: '11'
           # Latest LTS
-          - name: temurin-jdk21-target-jdk8
-            version: 21
-            distribution: temurin
-            target: 8
-            targetStr: '1.8'
           - name: temurin-jdk21-target-jdk11
             version: 21
             distribution: temurin
@@ -67,7 +57,7 @@ jobs:
           cat ./bench-${{matrix.name}}.json >> $GITHUB_STEP_SUMMARY
           echo -e "\n\`\`\`\n" >> $GITHUB_STEP_SUMMARY
       - name: bench-pages-branch-${{matrix.name}}
-        if: ${{github.ref_type == 'branch'}}
+        if: ${{github.ref_type == 'branch' && matrix.version >= matrix.target}}
         uses: benchmark-action/github-action-benchmark@v1
         with:
           name: branch-${{github.ref_name}}-${{matrix.name}}
@@ -78,7 +68,7 @@ jobs:
           summary-always: true
           benchmark-data-dir-path: 'benchmark/branch/${{github.ref_name}}'
       - name: bench-pages-tag-${{matrix.name}}
-        if: ${{github.ref_type == 'tag'}}
+        if: ${{github.ref_type == 'tag' && matrix.version >= matrix.target}}
         uses: benchmark-action/github-action-benchmark@v1
         with:
           name: tag-${{github.ref_name}}-${{matrix.name}}

.github/workflows/build.yml

@@ -26,9 +26,6 @@ jobs:
       matrix:
         include:
           # LTS versions
-          - name: temurin-jdk8
-            version: 8
-            distribution: temurin
           - name: temurin-jdk11
             version: 11
             distribution: temurin
@@ -68,12 +65,7 @@ jobs:
           distribution: ${{matrix.distribution}}
           cache: maven
       - name: verify-${{matrix.name}}
-        # Java 1.7 is source compatible only up to JDK 17
-        if: ${{matrix.version<=17}}
         run: mvn clean verify --settings .settings.xml -Dgpg.skip -B -V
-      - name: verify-as-jdk8-${{matrix.name}}
-        if: ${{matrix.version>=8}}
-        run: mvn clean verify -Dmaven.compiler.source=1.8 -Dmaven.compiler.target=1.8 --settings .settings.xml -Dgpg.skip -B -V
       - name: verify-as-jdk11-${{matrix.name}}
         if: ${{matrix.version>=11}}
         run: mvn clean verify -Dmaven.compiler.source=11 -Dmaven.compiler.target=11 --settings .settings.xml -Dgpg.skip -B -V

.github/workflows/package.yml

@@ -31,7 +31,7 @@ jobs:
       - name: setup-toolchain
         uses: actions/setup-java@v4
         with:
-          java-version: 8
+          java-version: 11
           distribution: temurin
           cache: maven
       - name: setup-gpg

.github/workflows/site.yml

@@ -24,7 +24,7 @@ jobs:
       - name: setup-toolchain
         uses: actions/setup-java@v4
         with:
-          java-version: 8
+          java-version: 11
           distribution: temurin
           cache: maven
       - name: site

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>io.azam.ulidj</groupId>
   <artifactId>ulidj</artifactId>
-  <version>1.1.0</version>
+  <version>2.0.0</version>
   <name>ulidj</name>
   <description>ULID (Universally Unique Lexicographically Sortable Identifier) generator and parser for Java.</description>
   <url>https://github.com/azam/ulidj</url>
@@ -44,8 +44,8 @@
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.build.lineEnding>LF</project.build.lineEnding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-    <maven.compiler.source>1.7</maven.compiler.source>
-    <maven.compiler.target>1.7</maven.compiler.target>
+    <maven.compiler.source>11</maven.compiler.source>
+    <maven.compiler.target>11</maven.compiler.target>
     <!-- Benchmark properties -->
     <jmh.version>1.37</jmh.version>
     <jmh.benchmarks>Benchmark</jmh.benchmarks>
@@ -60,9 +60,15 @@
   </properties>
   <dependencies>
     <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <version>4.13.2</version>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <version>5.12.2</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <version>5.12.2</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -90,7 +96,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
-        <version>3.8.1</version>
+        <version>3.14.0</version>
         <configuration>
           <annotationProcessorPaths>
             <path>
@@ -207,7 +213,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.4.1</version>
+        <version>3.11.2</version>
         <configuration>
           <!-- Setting this to 7 removes unnamed modules found warnings -->
           <!-- Defaults to ${maven.compiler.source} -->
@@ -225,7 +231,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-help-plugin</artifactId>
-        <version>3.2.0</version>
+        <version>3.5.1</version>
       </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -236,7 +242,7 @@
         <groupId>net.revelc.code.formatter</groupId>
         <artifactId>formatter-maven-plugin</artifactId>
         <!-- Sticking to this version as it is the latest that supports JDK8 -->
-        <version>2.16.0</version>
+        <version>2.23.0</version>
         <configuration>
           <configFile>${project.basedir}/eclipse-java-google-style.xml</configFile>
           <encoding>${project.build.sourceEncoding}</encoding>
@@ -259,7 +265,7 @@
       <plugin>
         <groupId>au.com.acegi</groupId>
         <artifactId>xml-format-maven-plugin</artifactId>
-        <version>3.2.2</version>
+        <version>4.1.0</version>
         <configuration>
           <includes>pom.xml</includes>
           <includes>.settings.xml</includes>
@@ -312,7 +318,15 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.4.1</version>
+        <version>3.11.2</version>
+        <reportSets>
+          <reportSet>
+            <reports>
+              <report>javadoc</report>
+              <report>test-javadoc</report>
+            </reports>
+          </reportSet>
+        </reportSets>
       </plugin>
     </plugins>
   </reporting>
@@ -341,7 +355,7 @@
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-gpg-plugin</artifactId>
-            <version>1.6</version>
+            <version>3.2.7</version>
             <executions>
               <execution>
                 <id>sign-artifacts</id>
@@ -363,7 +377,7 @@
           <plugin>
             <groupId>org.sonatype.plugins</groupId>
             <artifactId>nexus-staging-maven-plugin</artifactId>
-            <version>1.6.14</version>
+            <version>1.7.0</version>
             <extensions>true</extensions>
             <configuration>
               <serverId>ossrh</serverId>

readme.md

@@ -57,7 +57,7 @@ Add the following tag to `dependencies` tag in your `pom.xml` file. Change the v
 <dependency>
   <groupId>io.azam.ulidj</groupId>
   <artifactId>ulidj</artifactId>
-  <version>1.1.0</version>
+  <version>2.0.0</version>
 </dependency>
 ```
 
@@ -71,14 +71,18 @@ ULID ulid1 = ULID.randomULID();
 // Using provided Random instance
 ULID ulid2 = ULID.randomULID(ThreadLocalRandom.current());
 // Using provided SecureRandom instance
-ULID ulid3 = ULID.parseULID("003JZ9J6G80123456789abcdef");
+ULID ulid3 = ULID.randomULID(SecureRandom.newInstance("SHA1PRNG"));
+// Using provided Clock instance
+ULID ulid4 = ULID.randomULID(Clock.systemUTC());
+// Using provided Clock and Random instance
+ULID ulid5 = ULID.randomULID(Clock.systemUTC(), SecureRandom.newInstance("SHA1PRNG"));
 // Convert ULID string to ULID instance
-ULID ulid4 = ULID.parseULID("003JZ9J6G80123456789abcdef");
+ULID ulid6 = ULID.parseULID("003JZ9J6G80123456789abcdef");
 // Convert ULID binary to ULID instance
-ULID ulid5 = ULID.parseULID(
+ULID ulid7 = ULID.parseULID(
         new byte[] {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf});
 // Instantiate a ULID instance from current time and provided entropy bytes
-ULID ulid6 = ULID.generateULID(System.currentTimeMillis(), entropy);
+ULID ulid8 = ULID.generateULID(System.currentTimeMillis(), entropy);
 // Sort ULID instances lexicographically
 List<ULID> ulids = Arrays.asList(ulid1, ulid2, ulid3, ulid4, ulid5, ulid6);
 Collections.sort(ulids);
@@ -93,11 +97,15 @@ String ulid1 = ULID.random();
 String ulid2 = ULID.random(ThreadLocalRandom.current());
 // Using provided SecureRandom instance
 String ulid3 = ULID.random(SecureRandom.newInstance("SHA1PRNG"));
+// Using provided Clock instance
+String ulid4 = ULID.random(Clock.systemUTC());
+// Using provided Clock and Random instance
+String ulid5 = ULID.random(Clock.systemUTC(), SecureRandom.newInstance("SHA1PRNG"));
 // Generate ULID string from current time and provided entropy bytes
 byte[] entropy = new byte[] {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9};
-String ulid4 = ULID.generate(System.currentTimeMillis(), entropy);
+String ulid6 = ULID.generate(System.currentTimeMillis(), entropy);
 // Convert ULID binary to ULID string
-String ulid5 = ULID.fromBinary(
+String ulid7 = ULID.fromBinary(
         new byte[] {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf});
 ```
 
@@ -110,11 +118,15 @@ byte[] ulid1 = ULID.randomBinary();
 byte[] ulid2 = ULID.randomBinary(ThreadLocalRandom.current());
 // Using provided SecureRandom instance
 byte[] ulid3 = ULID.randomBinary(SecureRandom.newInstance("SHA1PRNG"));
+// Using provided Clock instance
+byte[] ulid4 = ULID.randomBinary(Clock.systemUTC());
+// Using provided Clock and Random instance
+byte[] ulid5 = ULID.randomBinary(Clock.systemUTC(), SecureRandom.newInstance("SHA1PRNG"));
 // Generate ULID string from current time and provided entropy bytes
 byte[] entropy = new byte[] {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9};
-byte[] ulid4 = ULID.generateBinary(System.currentTimeMillis(), entropy);
+byte[] ulid6 = ULID.generateBinary(System.currentTimeMillis(), entropy);
 // Convert ULID string to ULID binary
-byte[] ulid5 = ULID.toBinary("003JZ9J6G80123456789abcdef");
+byte[] ulid7 = ULID.toBinary("003JZ9J6G80123456789abcdef");
 ```
 
 ULID utilities examples:
@@ -166,6 +178,23 @@ String ulid9 = monotonicUlid2.generate();
 String ulid10 = monotonicUlid2.generate();
 byte[] ulid11 = monotonicUlid2.generateBinary();
 ULID ulid12 = monotonicUlid2.generateULID();
+
+// Create a new independent instance of MonotonicULID using provided Clock instance
+MonotonicULID monotonicUlid3 = new MonotonicULID(Clock.systemUTC());
+String ulid13 = monotonicUlid3.generate();
+// Subsequent calls generates monotonic ULID
+String ulid14 = monotonicUlid3.generate();
+byte[] ulid15 = monotonicUlid3.generateBinary();
+ULID ulid16 = monotonicUlid3.generateULID();
+
+// Create a new independent instance of MonotonicULID using provided Clock and Random instance
+MonotonicULID monotonicUlid4 =
+        new MonotonicULID(Clock.systemUTC(), SecureRandom.newInstance("SHA1PRNG"));
+String ulid17 = monotonicUlid4.generate();
+// Subsequent calls generates monotonic ULID
+String ulid18 = monotonicUlid4.generate();
+byte[] ulid19 = monotonicUlid4.generateBinary();
+ULID ulid20 = monotonicUlid4.generateULID();
 ```
 
 ## Develop