Merge pull request #141 from filip26/feat/diagnose

Debug Mode

Author: filip26

README.md

@@ -68,7 +68,7 @@ document = decoder.decode(encoded);
 
 ### Dictionary
 
-It’s highly recommended to use dictionaries to maximize the compression ratio. A dictionary consists of terms and the codes they are encoded to. The dictionary code is preserved in the encoded CBOR-LD, but the decoder must have the same dictionary enabled. See the [W3C CBOR-LD Registry for examples](https://json-ld.github.io/cbor-ld-spec/#registry).
+Use dictionaries to maximize the compression ratio. A dictionary consists of terms and the codes they are encoded to. The dictionary code is preserved in the encoded CBOR-LD, but the decoder must have the same dictionary enabled. See the [W3C CBOR-LD Registry for examples](https://json-ld.github.io/cbor-ld-spec/#registry).
 
 A dictionary should contain terms that are not present in contexts, such as the context URIs themselves, custom common values bound to types, and custom common URIs.
 
@@ -94,18 +94,39 @@ var dictionary = DocumentDictionaryBuilder
 var encoder = CborLd.createEncoder()
                 .dictionary(dictionary)
                 .loader(...)
-                // customize
+                // ... customize
                 .build();
 
 // use with decoder, please note you can register multiple dictionaries
 var decoder = CborLd.createDecoder()
                 .dictionary(dictionary)
                 .loader(...)
-                // customize
+                // ... customize
                 .build();
 
 ```
 
+### Diagnose / Debug
+
+```javascript
+var debug = CborLd.create[Decoder|Encoder]()
+                // ... customize
+                .debug();
+
+debug.[encode|decode](...);
+
+debug.isCborLd();      // true if the encoded document is in CBOR-LD format
+debug.version();       // CBOR-LD encoding version
+debug.dictionary();    // static terms
+debug.terms();         // dynamic term map
+
+debug.isError();       // true if an exception has been thrown
+debug.error();         // an exception or null
+
+debug.dump();          // dump as JSON
+
+```
+
 ### Backward Compatibility
 
 ```javascript

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

@@ -13,14 +13,10 @@ public class CborLd {
 
     public static final byte LEADING_BYTE = (byte) 0xD9; // tag
 
-    public static final byte[] VERSION_10_BYTES = new byte[] { (byte) 0xCB, 0x1D };
+    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;
 
-    public static final byte UNCOMPRESSED_BYTE = 0x00;
-
-    public static final byte COMPRESSED_BYTE = 0x01;
-
     protected CborLd() {
         /* protected */ }
 
@@ -84,7 +80,7 @@ public static EncoderBuilder createEncoder() {
     public static EncoderBuilder createEncoder(EncoderConfig config) {
         return EncoderBuilder.of(config);
     }
-    
+
     public static EncoderBuilder createEncoder(CborLdVersion version) {
         return EncoderBuilder.of(version);
     }

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

@@ -1,10 +1,11 @@
 package com.apicatalog.cborld;
 
 import java.util.Arrays;
+import java.util.Objects;
 
 public enum CborLdVersion {
 
-    V1(CborLd.VERSION_10_BYTES),
+    V1(CborLd.VERSION_1_BYTES),
 
     // legacy
     V06(new byte[] { CborLd.VERSION_06_BYTE }),
@@ -20,14 +21,24 @@ public byte[] bytes() {
         return bytes;
     }
 
+    /**
+     * Identifies the CborLdVersion from a given byte array and offset.
+     *
+     * @param bytes  The input byte array
+     * @param offset The offset to start checking from
+     * @return Matching CborLdVersion or {@code null} if not found
+     */
     public static CborLdVersion of(byte[] bytes, int offset) {
-        for (CborLdVersion version : CborLdVersion.values()) {
-            if (((offset + version.bytes.length) < bytes.length)
-                    && Arrays.equals(version.bytes, 0, version.bytes.length, bytes, offset, offset + version.bytes().length)) {
+        Objects.requireNonNull(bytes);
+
+        for (var version : values()) {
+            var versionBytes = version.bytes;
+            int end = offset + versionBytes.length;
+
+            if (end <= bytes.length && Arrays.mismatch(versionBytes, 0, versionBytes.length, bytes, offset, end) == -1) {
                 return version;
             }
         }
         return null;
     }
-
 }

src/main/java/com/apicatalog/cborld/config/BaseConfig.java

@@ -2,37 +2,9 @@
 
 import com.apicatalog.cborld.CborLdVersion;
 
-public class BaseConfig implements Config {
+public interface BaseConfig {
 
-//    protected DocumentLoader loader;
-//    protected boolean bundledContexts;
-//    protected URI base;
+    CborLdVersion version();
 
-    protected BaseConfig() {
-//        this.bundledContexts = bundledContexts;
-//        this.loader = null;
-//        this.base = null;
-    }
-
-//    @Override
-//    public DocumentLoader loader() {
-//        return loader;
-//    }
-//
-//    @Override
-//    public URI base() {
-//        return base;
-//    }
-
-    @Override
-    public CborLdVersion version() {
-        // TODO Auto-generated method stub
-        return null;
-    }
-
-    @Override
-    public boolean isCompactArrays() {
-        // TODO Auto-generated method stub
-        return false;
-    }
+    boolean isCompactArrays();    
 }

src/main/java/com/apicatalog/cborld/config/Config.java

@@ -37,7 +37,7 @@
 import com.apicatalog.cborld.registry.DefaultDocumentDictionary;
 import com.apicatalog.cborld.registry.DocumentDictionary;
 
-public class ConfigV1 extends BaseConfig implements EncoderConfig, DecoderConfig {
+public class ConfigV1 implements EncoderConfig, DecoderConfig {
 
     public static final ConfigV1 INSTANCE = new ConfigV1();
 

src/main/java/com/apicatalog/cborld/config/ConfigV1.java

@@ -1,6 +1,6 @@
 package com.apicatalog.cborld.config;
 
-public enum DictionaryAlgorithm {
+public enum ContextTermsAlgorithm {
 
     ProcessingOrderAppliedContexts,
 

src/main/java/com/apicatalog/cborld/config/DictionaryAlgorithm.java renamed to src/main/java/com/apicatalog/cborld/config/ContextTermsAlgorithm.java

@@ -31,7 +31,7 @@
 import com.apicatalog.cborld.registry.DocumentDictionary;
 import com.apicatalog.cborld.registry.LegacyDictionary;
 
-public class LegacyConfigV05 extends BaseConfig implements EncoderConfig, DecoderConfig {
+public class LegacyConfigV05 implements EncoderConfig, DecoderConfig {
 
     public static final LegacyConfigV05 INSTANCE = new LegacyConfigV05();
 

src/main/java/com/apicatalog/cborld/config/LegacyConfigV05.java

@@ -22,7 +22,6 @@
 import com.apicatalog.cborld.encoder.EncoderConfig;
 import com.apicatalog.cborld.encoder.value.ContextValueEncoder;
 import com.apicatalog.cborld.encoder.value.CustomTypeValueEncoder;
-import com.apicatalog.cborld.encoder.value.CustomUriValueEncoder;
 import com.apicatalog.cborld.encoder.value.DidKeyValueEncoder;
 import com.apicatalog.cborld.encoder.value.IdValueEncoder;
 import com.apicatalog.cborld.encoder.value.MultibaseValueEncoder;
@@ -37,7 +36,7 @@
 import com.apicatalog.cborld.registry.DocumentDictionary;
 import com.apicatalog.cborld.registry.LegacyDictionary;
 
-public class LegacyConfigV06 extends BaseConfig implements EncoderConfig, DecoderConfig {
+public class LegacyConfigV06 implements EncoderConfig, DecoderConfig {
 
     public static final LegacyConfigV06 INSTANCE = new LegacyConfigV06();
 
@@ -59,7 +58,6 @@ public class LegacyConfigV06 extends BaseConfig implements EncoderConfig, Decode
         VALUE_ENCODERS.add(new CustomTypeValueEncoder());
 
         // value driven
-        VALUE_ENCODERS.add(new CustomUriValueEncoder());
         VALUE_ENCODERS.add(new UuidValueEncoder());
         VALUE_ENCODERS.add(new DidKeyValueEncoder());
     }

src/main/java/com/apicatalog/cborld/config/LegacyConfigV06.java

@@ -47,7 +47,10 @@ public static Context from(Data document, URI base, DocumentLoader loader) throw
 
     }
 
-    public static Context from(Data document, URI base, DocumentLoader loader, Consumer<Collection<String>> appliedContexts,
+    public static Context from(Data document,
+            URI base,
+            DocumentLoader loader,
+            Consumer<Collection<String>> appliedContexts,
             TypeKeyNameMapper typeMapper) throws JsonLdError {
 
         final JsonLdOptions options = new JsonLdOptions();