Merge pull request #438 from filip26/feat/v2-m2

2.0.0-M2

Author: filip26

README.md

@@ -1,17 +1,25 @@
 # Titanium JSON-LD 1.1 Processor & API
 
-An implementation of the [JSON-LD 1.1](https://www.w3.org/TR/json-ld/) (JSON-based Serialization for Linked Data) specification in Java, utilizing [Jakarta JSON Processing](https://github.com/eclipse-ee4j/jsonp).
+An implementation of the [JSON-LD 1.1](https://www.w3.org/TR/json-ld/) (JSON-based Serialization for Linked Data) specification in Java.
 
-### 🎯 Goals
-- Full conformance to the specification
-- Secure, stable, fast, high-quality code (**~2900 tests**)
-- Minimal external dependencies
-- Simple and easy-to-use
+### ✨ Features
 
-### 🚦 Status
+- Full conformance with the JSON-LD 1.1 specification  
+- Secure, stable, high-performance implementation with ~3000 tests
+- Minimal external dependencies
+- Simple, easy-to-use API
+- Extensions (since v2.0):
+  - JSON-LD-star expansion (experimental)
+  - Processing policies: undefined terms, time/space constraints
+  - Generated TypeMap / TermMap (experimental)
+  - Built-in loaders: HTTPS, file, classpath, scheme router, URI rewriter
+  - Generalized processing with [tree-io](https://github.com/filip26/tree-io) (Jakarta JSON, Jackson, or anything else)
+    
+### 🎯 Status
 
 [![Java 17 CI](https://github.com/filip26/titanium-json-ld/actions/workflows/java17-build.yml/badge.svg)](https://github.com/filip26/titanium-json-ld/actions/workflows/java17-build.yml)
 [![CodeQL](https://github.com/filip26/titanium-json-ld/actions/workflows/codeql.yml/badge.svg)](https://github.com/filip26/titanium-json-ld/actions/workflows/codeql.yml)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c530c6b43b0243c08ce81521c5b4cf6a)](https://app.codacy.com/gh/filip26/titanium-json-ld/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/c530c6b43b0243c08ce81521c5b4cf6a)](https://app.codacy.com/gh/filip26/titanium-json-ld/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 [![Javadoc](https://javadoc.io/badge2/com.apicatalog/titanium-json-ld/javadoc.svg)](https://javadoc.io/doc/com.apicatalog/titanium-json-ld)
 [![Maven Central](https://img.shields.io/maven-central/v/com.apicatalog/titanium-json-ld.svg?label=Maven%20Central)](https://mvnrepository.com/artifact/com.apicatalog/titanium-json-ld)
@@ -185,7 +193,7 @@ implementation("com.apicatalog:titanium-json-ld-jre8:1.7.0")
 
 ### JSON-P Provider
 
-Titanium relies on a **JSON-P (Jakarta JSON Processing)** provider. Ensure that one is available on your classpath.
+Titanium v1.x.x relies on a **JSON-P (Jakarta JSON Processing)** provider. Ensure that one is available on your classpath.
 
 #### Maven
 

pom.xml

@@ -4,7 +4,7 @@
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.apicatalog</groupId>
-    <version>2.0.0-M1</version>
+    <version>2.0.0-M2</version>
     <artifactId>titanium-json-ld</artifactId>
     <packaging>jar</packaging>
 
@@ -51,16 +51,16 @@
 
         <maven.compiler.release>17</maven.compiler.release>
 
-        <titanium.rdf.api.version>1.0.0</titanium.rdf.api.version>
-        <titanium.rdf.nquads.version>1.0.2</titanium.rdf.nquads.version>        
-
+        <rdf-api.version>1.0.0</rdf-api.version>
         <jcs.version>3.0.0-M1</jcs.version>
         <tree-io.version>0.11.0</tree-io.version>
-        <jakarta.json.version>2.0.1</jakarta.json.version>
 
         <!-- test resources -->
         <junit.version>6.0.1</junit.version>
-        <wiremock.version>2.35.2</wiremock.version>
+        <jakarta.json.version>2.0.1</jakarta.json.version>
+        <nquads.version>1.0.2</nquads.version>
+        <rdf-primitives.version>1.0.3</rdf-primitives.version>
+        <rdfc.version>2.0.0</rdfc.version>        
 
         <sonar.projectKey>filip26_titanium-json-ld</sonar.projectKey>
         <sonar.organization>apicatalog</sonar.organization>
@@ -81,7 +81,7 @@
         <dependency>
           <groupId>com.apicatalog</groupId>
           <artifactId>titanium-rdf-api</artifactId>
-          <version>${titanium.rdf.api.version}</version>
+          <version>${rdf-api.version}</version>
         </dependency>        
         <!-- Tests-->
         <dependency>
@@ -99,19 +99,19 @@
         <dependency>
           <groupId>com.apicatalog</groupId>
           <artifactId>titanium-rdf-n-quads</artifactId>
-          <version>${titanium.rdf.nquads.version}</version>
+          <version>${nquads.version}</version>
           <scope>test</scope>
         </dependency>
         <dependency>
           <groupId>com.apicatalog</groupId>
           <artifactId>titanium-rdf-primitives</artifactId>
-          <version>1.0.3</version>
+          <version>${rdf-primitives.version}</version>
           <scope>test</scope>
         </dependency>   
         <dependency>
           <groupId>com.apicatalog</groupId>
           <artifactId>titanium-rdfc</artifactId>
-          <version>2.0.0</version>
+          <version>${rdfc.version}</version>
           <scope>test</scope>       
         </dependency>   
         <dependency>
@@ -190,9 +190,6 @@
             <artifactId>maven-surefire-plugin</artifactId>
             <version>3.5.4</version>
             <configuration>
-<!--                <excludes>
-                    <exclude>**Test.java</exclude>
-                </excludes> -->
                 <includes>                
                     <include>**Suite.java</include>
                     <include>**Test.java</include>

src/main/java/com/apicatalog/jsonld/JsonLd.java

@@ -24,7 +24,7 @@
 import com.apicatalog.jsonld.framing.Frame;
 import com.apicatalog.jsonld.fromrdf.QuadsToJsonLd;
 import com.apicatalog.jsonld.processor.Compactor;
-import com.apicatalog.jsonld.processor.Execution;
+import com.apicatalog.jsonld.processor.ExecutionEvents;
 import com.apicatalog.jsonld.processor.Expander;
 import com.apicatalog.jsonld.processor.Flattener;
 import com.apicatalog.jsonld.processor.Framer;
@@ -74,7 +74,7 @@ public static final Collection<?> expand(
                         options.loader(),
                         options.isExtractAllScripts()),
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -92,7 +92,7 @@ public static final Collection<?> expand(
         return Expander.expand(
                 document,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -127,7 +127,7 @@ public static final Collection<?> expand(
         return Expander.expand(
                 document,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /* --- COMPACT -- */
@@ -209,7 +209,7 @@ public static final Collection<?> expand(
                 document,
                 context,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -227,7 +227,7 @@ public static final Collection<?> expand(
             final TreeIO context,
             final Options options) throws JsonLdException {
 
-        final Execution runtime = Execution.of(options).start();
+        final ExecutionEvents runtime = ExecutionEvents.of(options).start();
 
         return Compactor.compact(
                 Compactor.expand(document, options, runtime),
@@ -280,7 +280,7 @@ public static final Object flatten(
                         options.isExtractAllScripts()),
                 null,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -306,7 +306,7 @@ public static final Object flatten(
                         ? Context.load(context, options.loader()).content()
                         : null,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -326,7 +326,7 @@ public static final Object flatten(
                 document,
                 null,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -346,7 +346,7 @@ public static final Object flatten(
                         ? context.content()
                         : null,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -452,7 +452,7 @@ public static final Object flatten(
                 document,
                 null,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -475,7 +475,7 @@ public static final Object flatten(
                 document,
                 context,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /* --- FRAME -- */
@@ -558,7 +558,7 @@ public static final Object flatten(
                 document,
                 frame,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -596,7 +596,7 @@ public static final Object flatten(
             final TreeIO frame,
             final Options options) throws JsonLdException {
 
-        final Execution runtime = Execution.of(options).start();
+        final ExecutionEvents runtime = ExecutionEvents.of(options).start();
 
         final var contextNode = Context.extract(frame);
 
@@ -655,7 +655,7 @@ public static final void toRdf(
                 document,
                 consumer,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -677,7 +677,7 @@ public static final void toRdf(
                 document,
                 consumer,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /**
@@ -698,7 +698,7 @@ public static final void toRdf(
                 new TreeIO(document, NativeAdapter.instance()),
                 consumer,
                 options,
-                Execution.of(options).start());
+                ExecutionEvents.of(options).start());
     }
 
     /* --- FROM RDF -- */

src/main/java/com/apicatalog/jsonld/JsonLdException.java

@@ -19,6 +19,8 @@
 import java.util.Objects;
 import java.util.Optional;
 
+import com.apicatalog.tree.io.TreeIO;
+
 /**
  * Represents a JSON-LD processing error.
  *
@@ -30,6 +32,9 @@ public final class JsonLdException extends Exception {
     private static final long serialVersionUID = -7548366490116267200L;
 
     private final ErrorCode code;
+    
+    // a node that caused the exception, if any
+    //TODO private final TreeIO value;
 
     /**
      * Creates a new {@code JsonLdException} with the specified error code.
@@ -420,7 +425,13 @@ public enum ErrorCode {
          */
         UNDEFINED_TERM("An undefined term has been found. Set policy to ignore to pass"),
 
-        UNSPECIFIED("An unspecified processing error");
+        INLINE_CONTEXT_IS_NOT_ALLOWED("Inline contexts are not allowed"),
+
+        UNSPECIFIED("An unspecified processing error"),
+
+        MISSING_DOCUMENT_LOADER("A document loader is not present")
+
+        ;
 
         private final String description;
 

src/main/java/com/apicatalog/jsonld/Options.java

@@ -86,6 +86,7 @@ public enum ProcessingPolicy {
     /** Default settings. */
     public static final boolean DEFAULT_RDF_STAR = false;
     public static final boolean DEFAULT_NUMERIC_ID = false;
+    public static final boolean DEFAULT_INLINE_CONTEXTS = true;
     public static final UriValidationPolicy DEFAULT_URI_VALIDATION = UriValidationPolicy.Full;
 
     /**
@@ -154,9 +155,12 @@ public enum ProcessingPolicy {
 
     // custom
 
-    // allow numeric @id
+    // allows numeric @id
     private boolean useNumericId;
 
+    // allows inline contexts
+    private boolean useInlineContexts;
+
     // context cache
 //    private Cache<String, JsonValue> contextCache;
 
@@ -198,6 +202,7 @@ private Options() {
 
         // custom
         this.useNumericId = DEFAULT_NUMERIC_ID;
+        this.useInlineContexts = DEFAULT_INLINE_CONTEXTS;
 //        this.contextCache = new LruCache<>(256);
         this.documentCache = null;
         this.uriValidation = DEFAULT_URI_VALIDATION;
@@ -232,6 +237,7 @@ private Options(Options options) {
 
         // custom
         this.useNumericId = options.useNumericId;
+        this.useInlineContexts = options.useInlineContexts;
 //        this.contextCache = options.contextCache;
         this.documentCache = options.documentCache;
         this.uriValidation = options.uriValidation;
@@ -931,4 +937,13 @@ public Options undefinedTermsPolicy(ProcessingPolicy undefinedTerms) {
         this.undefinedTerms = undefinedTerms;
         return this;
     }
+
+    public boolean useInlineContexts() {
+        return useInlineContexts;
+    }
+
+    public Options useInlineContexts(boolean useInlineContext) {
+        this.useInlineContexts = useInlineContext;
+        return this;
+    }
 }