Run JSON-LD star test suite.

gkellogg · gkellogg · commit 15adacacdc01 · 2021-01-18T13:46:15.000-08:00
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@ The [MultiJson](https://rubygems.org/gems/multi_json) gem is used for parsing JS
 
 ### JSON-LD* (RDFStar)
 
-The {JSON::LD::API.toRdf} and {JSON::LD::API.fromRdf} API methods, along with the {JSON::LD::Reader} and {JSON::LD::Writer}, include provisional support for [JSON-LD*][JSON-LD*].
+The {JSON::LD::API.expand}, {JSON::LD::API.compact}, {JSON::LD::API.toRdf}, and {JSON::LD::API.fromRdf} API methods, along with the {JSON::LD::Reader} and {JSON::LD::Writer}, include provisional support for [JSON-LD*][JSON-LD*].
 
 Internally, an `RDF::Statement` is treated as another resource, along with `RDF::URI` and `RDF::Node`, which allows an `RDF::Statement` to have a `#subject` or `#object` which is also an `RDF::Statement`.
 
@@ -55,6 +55,19 @@ In JSON-LD, with the `rdfstar` option set, the value of `@id`, in addition to an
       "ex:certainty": 0.9
     }
 
+Additionally, the `@annotation` property (or alias) may be used on a node object or value object to annotate the statement for which the associated node is the object of a triple.
+
+    {
+      "@context": {"foaf": "http://xmlns.com/foaf/0.1/"},
+      "@id": "bob",
+      "foaf:age" 23,
+      "@annotation": {
+        "ex:certainty": 0.9
+      }
+    }
+
+In the first case, the embedded node is not asserted, and only appears as the subject of a triple. In the second case, the triple is asserted and used as the subject in another statement which annotates it.
+
 **Note: This feature is subject to change or elimination as the standards process progresses.**
 
 #### Serializing a Graph containing embedded statements
diff --git a/lib/json/ld.rb b/lib/json/ld.rb
@@ -47,6 +47,7 @@ module LD
     DEFAULT_CONTEXT = "http://schema.org"
 
     KEYWORDS = Set.new(%w(
+      @annotation
       @base
       @container
       @context
@@ -116,6 +117,7 @@ def code
       class CollidingKeywords < JsonLdError; @code = "colliding keywords"; end
       class ConflictingIndexes < JsonLdError; @code = "conflicting indexes"; end
       class CyclicIRIMapping < JsonLdError; @code = "cyclic IRI mapping"; end
+      class InvalidAnnotation < JsonLdError; @code = "invalid annotation"; end
       class InvalidBaseIRI < JsonLdError; @code = "invalid base IRI"; end
       class InvalidContainerMapping < JsonLdError; @code = "invalid container mapping"; end
       class InvalidContextEntry < JsonLdError; @code = "invalid context entry"; end
@@ -137,7 +139,7 @@ class InvalidLocalContext < JsonLdError; @code = "invalid local context"; end
       class InvalidNestValue < JsonLdError; @code = "invalid @nest value"; end
       class InvalidPrefixValue < JsonLdError; @code = "invalid @prefix value"; end
       class InvalidPropagateValue < JsonLdError; @code = "invalid @propagate value"; end
-      class InvalidEmbeddedNode < JsonLdError; @code = "invalid reified node"; end
+      class InvalidEmbeddedNode < JsonLdError; @code = "invalid embedded node"; end
       class InvalidRemoteContext < JsonLdError; @code = "invalid remote context"; end
       class InvalidReverseProperty < JsonLdError; @code = "invalid reverse property"; end
       class InvalidReversePropertyMap < JsonLdError; @code = "invalid reverse property map"; end
diff --git a/lib/json/ld/expand.rb b/lib/json/ld/expand.rb
@@ -11,7 +11,7 @@ module Expand
     # The following constant is used to reduce object allocations
     CONTAINER_INDEX_ID_TYPE = Set['@index', '@id', '@type'].freeze
     KEY_ID = %w(@id).freeze
-    KEYS_VALUE_LANGUAGE_TYPE_INDEX_DIRECTION = %w(@value @language @type @index @direction).freeze
+    KEYS_VALUE_LANGUAGE_TYPE_INDEX_DIRECTION = %w(@value @language @type @index @direction @annotation).freeze
     KEYS_SET_LIST_INDEX = %w(@set @list @index).freeze
     KEYS_INCLUDED_TYPE = %w(@included @type).freeze
 
@@ -172,6 +172,18 @@ def expand(input, active_property, context,
 
           # If result contains the key @set, then set result to the key's associated value.
           return output_object['@set'] if output_object.key?('@set')
+        elsif output_object['@annotation']
+          # Otherwise, if result contains the key @annotation,
+          # the array value must all be node objects without an @id property, otherwise, an invalid annotation error has been detected and processing is aborted.
+          raise JsonLdError::InvalidAnnotation,
+            "@annotation must reference node objects without @id." unless
+            output_object['@annotation'].all? {|o| node?(o) && !o.key?('@id')}
+
+          # Additionally, the property must not be used if there is no active property, or the expanded active property is @graph.
+          raise JsonLdError::InvalidAnnotation,
+            "@annotation must not be used on a top-level object." if
+            %w(@graph @included).include?(expanded_active_property || '@graph')
+          
         end
 
         # If result contains only the key @language, set result to null.
@@ -258,6 +270,11 @@ def expand_object(input, active_property, context, output_object,
 
           expanded_value = case expanded_property
           when '@id'
+            # If expanded active property is `@annotation`, an invalid annotation error has been found and processing is aborted.
+            raise JsonLdError::InvalidAnnotation,
+              "an annotation must not contain a property expanding to @id" if
+              expanded_active_property == '@annotation' && @options[:rdfstar]
+
             # If expanded property is @id and value is not a string, an invalid @id value error has been detected and processing is aborted
             e_id = case value
             when String
@@ -522,6 +539,12 @@ def expand_object(input, active_property, context, output_object,
             nests << key
             # Continue with the next key from element
             next
+          when '@annotation'
+            # Skip unless rdfstar option is set
+            next unless @options[:rdfstar]
+            as_array(expand(value, '@annotation', context,
+              framing: framing,
+              log_depth: log_depth.to_i + 1))
           else
             # Skip unknown keyword
             next
diff --git a/spec/.gitignore b/spec/.gitignore
@@ -2,4 +2,5 @@
 /uri-cache/
 /json-ld-api
 /json-ld-framing
+/json-ld-star
 /json-ld-streaming
diff --git a/spec/expand_spec.rb b/spec/expand_spec.rb
@@ -3388,6 +3388,36 @@
           }),
           exception: JSON::LD::JsonLdError::InvalidIdValue
         },
+        "node object with @annotation property is ignored without rdfstar option": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:knows": {
+              "@id": "ex:fred",
+              "@annotation": {
+                "ex:certainty": 0.8
+              }
+            }
+          }),
+          output: %([{
+            "@id": "ex:bob",
+            "ex:knows": [{"@id": "ex:fred"}]
+          }])
+        },
+        "value object with @annotation property is ignored without rdfstar option": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:age": {
+              "@value": 23,
+              "@annotation": {
+                "ex:certainty": 0.8
+              }
+            }
+          }),
+          output: %([{
+            "@id": "ex:bob",
+            "ex:age": [{"@value": 23}]
+          }])
+        },
       }.each do |title, params|
         it(title) {run_expand params}
       end
@@ -3569,7 +3599,7 @@
             }]
           }])
         },
-        "illegal node with embedded object having properties": {
+        "node with embedded object having properties": {
           input: %({
             "@id": "ex:subj",
             "ex:value": {
@@ -3619,6 +3649,197 @@
             }]
           }])
         },
+        "node with @annotation property on value object": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:age": {
+              "@value": 23,
+              "@annotation": {"ex:certainty": 0.8}
+            }
+          }),
+          output: %([{
+            "@id": "ex:bob",
+            "ex:age": [{
+              "@value": 23,
+              "@annotation": [{"ex:certainty": [{"@value": 0.8}]}]
+            }]
+          }])
+        },
+        "node with @annotation property on node object": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:name": "Bob",
+            "ex:knows": {
+              "@id": "ex:fred",
+              "ex:name": "Fred",
+              "@annotation": {"ex:certainty": 0.8}
+            }
+          }),
+          output: %([{
+            "@id": "ex:bob",
+            "ex:name": [{"@value": "Bob"}],
+            "ex:knows": [{
+              "@id": "ex:fred",
+              "ex:name": [{"@value": "Fred"}],
+              "@annotation": [{"ex:certainty": [{"@value": 0.8}]}]
+            }]
+          }])
+        },
+        "node with @annotation property multiple values": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:name": "Bob",
+            "ex:knows": {
+              "@id": "ex:fred",
+              "ex:name": "Fred",
+              "@annotation": [{
+                "ex:certainty": 0.8
+              }, {
+                "ex:source": {"@id": "http://example.org/"}
+              }]
+            }
+          }),
+          output: %([{
+            "@id": "ex:bob",
+            "ex:name": [{"@value": "Bob"}],
+            "ex:knows": [{
+              "@id": "ex:fred",
+              "ex:name": [{"@value": "Fred"}],
+              "@annotation": [{
+                "ex:certainty": [{"@value": 0.8}]
+              }, {
+                "ex:source": [{"@id": "http://example.org/"}]
+              }]
+            }]
+          }])
+        },
+        "node with @annotation property that is on the top-level is invalid": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:name": "Bob",
+            "@annotation": {"ex:prop": "value2"}
+          }),
+          exception: JSON::LD::JsonLdError::InvalidAnnotation
+        },
+        "node with @annotation property on a top-level graph node is invalid": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:name": "Bob",
+            "@graph": {
+              "@id": "ex:fred",
+              "ex:name": "Fred",
+              "@annotation": {"ex:prop": "value2"}
+            }
+          }),
+          exception: JSON::LD::JsonLdError::InvalidAnnotation
+        },
+        "node with @annotation property having @id is invalid": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:knows": {
+              "@id": "ex:fred",
+              "@annotation": {
+                "@id": "ex:invalid-ann-id",
+                "ex:prop": "value2"
+              }
+            }
+          }),
+          exception: JSON::LD::JsonLdError::InvalidAnnotation
+        },
+        "node with @annotation property with value object value is invalid": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:knows": {
+              "@id": "fred",
+              "@annotation": "value2"
+            }
+          }),
+          exception: JSON::LD::JsonLdError::InvalidAnnotation
+        },
+        "node with @annotation on a list": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:knows": {
+              "@list": [{"@id": "ex:fred"}],
+              "@annotation": "value2"
+            }
+          }),
+          exception: JSON::LD::JsonLdError::InvalidSetOrListObject
+        },
+        "node with @annotation on a list value": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:knows": {
+              "@list": [
+                {
+                  "@id": "ex:fred",
+                  "@annotation": "value2"
+                }
+              ]
+            }
+          }),
+          exception: JSON::LD::JsonLdError::InvalidAnnotation
+        },
+        "node with @annotation property on a top-level @included node is invalid": {
+          input: %({
+            "@id": "ex:bob",
+            "ex:name": "Bob",
+            "@included": [{
+              "@id": "ex:fred",
+              "ex:name": "Fred",
+              "@annotation": {"ex:prop": "value2"}
+            }]
+          }),
+          exception: JSON::LD::JsonLdError::InvalidAnnotation
+        },
+        "node with @annotation property on embedded subject": {
+          input: %({
+            "@id": {
+              "@id": "ex:rei",
+              "ex:prop": {"@id": "_:value"}
+            },
+            "ex:prop": {
+              "@value": "value2",
+              "@annotation": {"ex:certainty": 0.8}
+            }
+          }),
+          output: %([{
+            "@id": {
+              "@id": "ex:rei",
+              "ex:prop": [{"@id": "_:value"}]
+            },
+            "ex:prop": [{
+              "@value": "value2",
+              "@annotation": [{
+                "ex:certainty": [{"@value": 0.8}]
+              }]
+            }]
+          }])
+        },
+        "node with @annotation property on embedded object": {
+          input: %({
+            "@id": "ex:subj",
+            "ex:value": {
+              "@id": {
+                "@id": "ex:rei",
+                "ex:prop": "value"
+              },
+              "@annotation": {"ex:certainty": 0.8}
+            }
+          }),
+          output: %([{
+            "@id": "ex:subj",
+            "ex:value": [{
+              "@id": {
+                "@id": "ex:rei",
+                "ex:prop": [{"@value": "value"}]
+              },
+              "@annotation": [{
+                "ex:certainty": [{"@value": 0.8}]
+              }]
+            }]
+          }])
+        },
       }.each do |title, params|
         it(title) {run_expand params.merge(rdfstar: true)}
       end
diff --git a/spec/rdfstar_spec.rb b/spec/rdfstar_spec.rb
@@ -0,0 +1,24 @@
+# coding: utf-8
+require_relative 'spec_helper'
+
+describe JSON::LD do
+  describe "test suite" do
+    require_relative 'suite_helper'
+    %w{
+      expand
+      compact
+      fromRdf
+      toRdf
+    }.each do |partial|
+      m = Fixtures::SuiteTest::Manifest.open("#{Fixtures::SuiteTest::STAR_SUITE}#{partial}-manifest.jsonld")
+      describe m.name do
+        m.entries.each do |t|
+          specify "#{t.property('@id')}: #{t.name} unordered#{' (negative test)' unless t.positiveTest?}" do
+            t.options[:ordered] = false
+            expect {t.run self}.not_to write.to(:error)
+          end
+        end
+      end
+    end
+  end
+end unless ENV['CI']
diff --git a/spec/suite_helper.rb b/spec/suite_helper.rb
@@ -7,6 +7,7 @@ module File
       "https://w3c.github.io/json-ld-api/tests/" => ::File.expand_path("../json-ld-api/tests", __FILE__) + '/',
       "https://w3c.github.io/json-ld-framing/tests/" => ::File.expand_path("../json-ld-framing/tests", __FILE__) + '/',
       "https://w3c.github.io/json-ld-streaming/tests/" => ::File.expand_path("../json-ld-streaming/tests", __FILE__) + '/',
+      "https://json-ld.github.io/json-ld-star/tests/" => ::File.expand_path("../json-ld-star/tests", __FILE__) + '/',
       "file:" => ""
     }
 
@@ -76,6 +77,7 @@ module SuiteTest
     SUITE = RDF::URI("https://w3c.github.io/json-ld-api/tests/")
     FRAME_SUITE = RDF::URI("https://w3c.github.io/json-ld-framing/tests/")
     STREAM_SUITE = RDF::URI("https://w3c.github.io/json-ld-streaming/tests/")
+    STAR_SUITE = RDF::URI("https://json-ld.github.io/json-ld-star/tests/")
 
     class Manifest < JSON::LD::Resource
       attr_accessor :manifest_url
