Merge pull request #143 from filip26/feat/v07-prerelease

v0.7.0

Author: filip26

.github/workflows/java17-publish.yml

@@ -8,22 +8,25 @@ on:
 jobs:
   publish:
     runs-on: ubuntu-latest
-    environment: RELEASE
+    environment: maven-central
     steps:
       - uses: actions/checkout@v4
       - name: Set up JDK 17
         uses: actions/setup-java@v4
         with:
           java-version: '17'
           distribution: 'temurin'
-          server-id: ossrh
-      - name: Import GPG Key
-        uses: crazy-max/ghaction-import-gpg@v6
-        with:
-          gpg_private_key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
-          passphrase: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+          cache: 'maven'
+          server-id: central
+          server-username: CENTRAL_TOKEN_ID
+          server-password: CENTRAL_TOKEN_SECRET
+          gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
+          gpg-passphrase: MAVEN_GPG_PASSPHRASE
       - name: Publish package
-        run: mvn -B -Pmaven-central -Dgpg.passphrase=${{secrets.MAVEN_GPG_PASSPHRASE}} -s maven-settings.xml deploy
+        run: mvn -B -Pmaven-central deploy
         env:
-          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
-          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+          CENTRAL_TOKEN_ID: ${{ secrets.CENTRAL_TOKEN_ID }}
+          CENTRAL_TOKEN_SECRET: ${{ secrets.CENTRAL_TOKEN_SECRET }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+          MAVEN_GPG_KEY: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
+          

README.md

@@ -87,10 +87,9 @@ var dictionary = DocumentDictionaryBuilder
                             .set("ecdsa-sd-2023", 2)
                             .set("eddsa-rdfc-2022", 3)
                             .set("ecdsa-xi-2023", 4))
-            .uri("did:key:zDnaeWjKfs1ob9QcgasjYSPEMkwq31hmvSAWPVAgnrt1e9GKj", 1)
-            .uri("did:key:zDnaeWjKfs1ob9QcgasjYSPEMkwq31hmvSAWPVAgnrt1e9GKj#zDnaeWjKfs1ob9QcgasjYSPEMkwq31hmvSAWPVAgnrt1e9GKj", 2)            
-            .uri("https://sandbox.platform.veres.dev/statuses/z19rJ4oGrbFCqf3cNTVDHSbNd/status-lists", 3)
-            .uri("did:key:zDnaeZSD9XcuULaS8qmgDUa6TMg2QjF9xABnZK42awDH3BEzj", 4)
+            .uri("did:key:zD...", 1)
+            .uri("did:key:zD...", 2)            
+            .uri("https://example.../status-lists", 3)
             .build();
 
 // use with encoder
@@ -167,8 +166,6 @@ Java 17+
 
 ```
 
-Iridium CBOR-LD for Android is distributed under a commercial license. [Contact](mailto:filip26@gmail.com)
-
 #### JSON-P Provider
 
 Add JSON-P provider, if it is not on the classpath already.

pom.xml

@@ -7,7 +7,7 @@
 
     <groupId>com.apicatalog</groupId>
     <artifactId>iridium-cbor-ld</artifactId>
-    <version>0.7.0-SNAPSHOT</version>
+    <version>0.7.0</version>
 
     <packaging>jar</packaging>
     <name>Iridium CBOR-LD</name>

src/main/java/com/apicatalog/cbor/CborComparison.java

@@ -12,6 +12,10 @@
 
 public class CborComparison {
 
+    protected CborComparison() {
+        // protected
+    }
+    
     public static final boolean equals(byte[] value1, byte[] value2) throws CborException {
 
         if (value1 == null || value2 == null) {

src/main/java/com/apicatalog/cborld/CborLd.java

@@ -1,29 +1,40 @@
 package com.apicatalog.cborld;
 
 import com.apicatalog.cborld.config.ConfigV1;
+import com.apicatalog.cborld.decoder.Decoder;
 import com.apicatalog.cborld.decoder.DecoderBuilder;
 import com.apicatalog.cborld.decoder.DecoderConfig;
+import com.apicatalog.cborld.encoder.Encoder;
 import com.apicatalog.cborld.encoder.EncoderBuilder;
 import com.apicatalog.cborld.encoder.EncoderConfig;
 
 /**
- * High level API to process CBOR-LD.
+ * High-level entry point for working with CBOR-LD.
+ * <p>
+ * Provides static factory methods to configure and create CBOR-LD
+ * {@link Encoder} and {@link Decoder} instances.
  */
 public class CborLd {
 
-    public static final byte LEADING_BYTE = (byte) 0xD9; // tag
+    /** CBOR tag leading byte. */
+    public static final byte LEADING_BYTE = (byte) 0xD9;
 
-    public static final byte[] VERSION_1_BYTES = new byte[] { (byte) 0xCB, 0x1D };
-    public static final byte VERSION_06_BYTE = (byte) 0x06;
-    public static final byte VERSION_05_BYTE = (byte) 0x05;
+    /** CBOR-LD version 1 identifier. */
+    static final byte[] VERSION_1_BYTES = new byte[] { (byte) 0xCB, 0x1D };
+    /** CBOR-LD legacy version 0.6 identifier. */
+    static final byte VERSION_06_BYTE = (byte) 0x06;
+    /** CBOR-LD legacy version 0.5 identifier. */
+    static final byte VERSION_05_BYTE = (byte) 0x05;
 
+    /** Utility class — not meant to be instantiated. */
     protected CborLd() {
         /* protected */ }
 
     /**
      * Creates a new {@link DecoderBuilder} instance with default configuration.
      * <p>
-     * The builder is initialized with all available format version decoders.
+     * The builder is initialized with default settings provided by
+     * {@link ConfigV1}.
      *
      * @return a new {@link DecoderBuilder} instance
      */
@@ -32,13 +43,13 @@ public static DecoderBuilder createDecoder() {
     }
 
     /**
-     * Creates a new {@link DecoderBuilder} instance with the specified decoder
-     * configurations.
+     * Creates a new {@link DecoderBuilder} instance using the provided decoder
+     * configuration(s).
      * <p>
-     * This method allows initializing the builder with one or more custom
-     * {@link DecoderConfig} options to control decoding behavior.
+     * This allows customization of decoding behavior by specifying one or more
+     * {@link DecoderConfig} options.
      *
-     * @param config one or more initial decoder configurations
+     * @param config one or more decoder configurations
      * @return a new {@link DecoderBuilder} instance
      */
     public static DecoderBuilder createDecoder(DecoderConfig... config) {
@@ -49,8 +60,8 @@ public static DecoderBuilder createDecoder(DecoderConfig... config) {
      * Creates a new {@link DecoderBuilder} instance for the specified CBOR-LD
      * format version(s).
      * <p>
-     * This method allows initializing the builder with support for specific
-     * {@link CborLdVersion}s only.
+     * Use this method to explicitly support only certain {@link CborLdVersion}s
+     * during decoding.
      *
      * @param version one or more supported CBOR-LD format versions
      * @return a new {@link DecoderBuilder} instance
@@ -60,27 +71,35 @@ public static DecoderBuilder createDecoder(CborLdVersion... version) {
     }
 
     /**
-     * Create a new {@link EncoderBuilder} allowing to configure an encoder. The
-     * builder is initialized by {@link ConfigV1}.
-     * 
+     * Creates a new {@link EncoderBuilder} instance using the default
+     * configuration.
+     * <p>
+     * The builder is initialized with default settings provided by
+     * {@link ConfigV1}.
+     *
      * @return a new {@link EncoderBuilder} instance
-     * 
      */
     public static EncoderBuilder createEncoder() {
         return createEncoder(ConfigV1.INSTANCE);
     }
 
     /**
-     * Create a new {@link EncoderBuilder} allowing to configure an encoder.
-     * 
-     * @param config an initial configuration
+     * Creates a new {@link EncoderBuilder} instance with a custom configuration.
+     *
+     * @param config the encoder configuration to apply
      * @return a new {@link EncoderBuilder} instance
-     * 
      */
     public static EncoderBuilder createEncoder(EncoderConfig config) {
         return EncoderBuilder.of(config);
     }
 
+    /**
+     * Creates a new {@link EncoderBuilder} instance for the specified CBOR-LD
+     * format version.
+     *
+     * @param version the CBOR-LD version to use
+     * @return a new {@link EncoderBuilder} instance
+     */
     public static EncoderBuilder createEncoder(CborLdVersion version) {
         return EncoderBuilder.of(version);
     }

src/main/java/com/apicatalog/cborld/CborLdVersion.java

@@ -3,12 +3,21 @@
 import java.util.Arrays;
 import java.util.Objects;
 
+/**
+ * Supported CBOR-LD format versions.
+ * <p>
+ * Each version is represented by a unique byte signature that can be used to
+ * identify the encoded format.
+ */
 public enum CborLdVersion {
 
+    /** CBOR-LD version 1.0 */
     V1(CborLd.VERSION_1_BYTES),
 
-    // legacy
+    /** Legacy version 0.6 */
     V06(new byte[] { CborLd.VERSION_06_BYTE }),
+
+    /** Legacy version 0.5 */
     V05(new byte[] { CborLd.VERSION_05_BYTE });
 
     private final byte[] bytes;
@@ -17,16 +26,26 @@ public enum CborLdVersion {
         this.bytes = bytes;
     }
 
+    /**
+     * Returns the version signature bytes associated with this CBOR-LD version.
+     *
+     * @return the version identifier bytes
+     */
     public byte[] bytes() {
         return bytes;
     }
 
     /**
-     * Identifies the CborLdVersion from a given byte array and offset.
+     * Determines the {@link CborLdVersion} based on the content of a byte array
+     * starting at the given offset.
+     * <p>
+     * This method compares the input bytes against all known version identifiers.
      *
-     * @param bytes  The input byte array
-     * @param offset The offset to start checking from
-     * @return Matching CborLdVersion or {@code null} if not found
+     * @param bytes  the byte array containing the encoded CBOR-LD data
+     * @param offset the starting offset to compare the version bytes
+     * @return the matching {@code CborLdVersion}, or {@code null} if no match is
+     *         found
+     * @throws NullPointerException if {@code bytes} is {@code null}
      */
     public static CborLdVersion of(byte[] bytes, int offset) {
         Objects.requireNonNull(bytes);
@@ -35,10 +54,12 @@ public static CborLdVersion of(byte[] bytes, int offset) {
             var versionBytes = version.bytes;
             int end = offset + versionBytes.length;
 
-            if (end <= bytes.length && Arrays.mismatch(versionBytes, 0, versionBytes.length, bytes, offset, end) == -1) {
+            if (end <= bytes.length &&
+                    Arrays.mismatch(versionBytes, 0, versionBytes.length, bytes, offset, end) == -1) {
                 return version;
             }
         }
+
         return null;
     }
 }

src/main/java/com/apicatalog/cborld/context/ObjectExpansion.java

@@ -223,15 +223,6 @@ private String processTypeScoped(final ActiveContext typeContext) throws JsonLdE
                     .map(JsonString::getString)
                     .sorted()
                     .collect(Collectors.toList());
-//            entry.save();
-//            final List<String> terms = ValueCursor
-//                                            .toStream(entry.mapKey(key))
-//                                            .filter(ValueCursor::isString)
-//                                            .map(ValueCursor::stringValue)
-//                                            .sorted()
-//                                            .collect(Collectors.toList());
-
-//            entry.restore();
 
             for (final String term : terms) {
 

src/main/java/com/apicatalog/cborld/context/mapping/DecoderContextMapping.java

@@ -41,13 +41,13 @@ class DecoderContextMapping implements Mapping {
 
     final DataItem decodeValue(final DataItem value, String term) {
 
-        Collection<String> TYPE = Arrays.asList(Keywords.TYPE);
+        var type = Arrays.asList(Keywords.TYPE);
 
         for (final ValueDecoder decoder : valueDecoders) {
             try {
                 final JsonValue decoded = decoder.decode(this, value, term,
                         typeKeyNameMap.isTypeKey(term)
-                                ? TYPE
+                                ? type
                                 : Collections.emptySet());
 
                 if (decoded == null) {