json-ld 3.1.7 → 3.1.8

data/lib/json/ld/expand.rb

@@ -11,9 +11,9 @@ module JSON::LD
     # 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
+    KEYS_INCLUDED_TYPE_REVERSE = %w(@included @type @reverse).freeze
 
     ##
     # Expand an Array or Object given an active context and performing local context expansion.
@@ -49,7 +49,13 @@ module JSON::LD
             log_depth: log_depth.to_i + 1)
 
           # If the active property is @list or its container mapping is set to @list and v is an array, change it to a list object
-          v = {"@list" => v} if is_list && v.is_a?(Array)
+          if is_list && v.is_a?(Array)
+            # Make sure that no member of v contains an annotation object
+            raise JsonLdError::InvalidAnnotation,
+              "A list element must not contain @annotation." if
+              v.any? {|n| n.is_a?(Hash) && n.key?('@annotation')}
+            v = {"@list" => v}
+          end
 
           case v
           when nil then nil
@@ -81,7 +87,7 @@ module JSON::LD
         log_debug("expand", depth: log_depth.to_i) {"after property_scoped_context: #{context.inspect}"} unless property_scoped_context.nil?
 
         # If element contains the key @context, set active context to the result of the Context Processing algorithm, passing active context and the value of the @context key as local context.
-        if input.has_key?('@context')
+        if input.key?('@context')
           context = context.parse(input.delete('@context'), base: @options[:base])
           log_debug("expand", depth: log_depth.to_i) {"context: #{context.inspect}"}
         end
@@ -142,7 +148,7 @@ module JSON::LD
 
           if output_object['@type'] == '@json' && context.processingMode('json-ld-1.1')
             # Any value of @value is okay if @type: @json
-          elsif !ary.all? {|v| v.is_a?(String) || v.is_a?(Hash) && v.empty?} && output_object.has_key?('@language')
+          elsif !ary.all? {|v| v.is_a?(String) || v.is_a?(Hash) && v.empty?} && output_object.key?('@language')
             # Otherwise, if the value of result's @value member is not a string and result contains the key @language, an invalid language-tagged value error has been detected (only strings can be language-tagged) and processing is aborted.
             raise JsonLdError::InvalidLanguageTaggedValue,
                   "when @language is used, @value must be a string: #{output_object.inspect}"
@@ -172,6 +178,18 @@ module JSON::LD
 
           # 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.
@@ -254,10 +272,15 @@ module JSON::LD
 
           # If result has already an expanded property member (other than @type), an colliding keywords error has been detected and processing is aborted.
           raise JsonLdError::CollidingKeywords,
-                "#{expanded_property} already exists in result" if output_object.has_key?(expanded_property) && !KEYS_INCLUDED_TYPE.include?(expanded_property)
+                "#{expanded_property} already exists in result" if output_object.key?(expanded_property) && !KEYS_INCLUDED_TYPE_REVERSE.include?(expanded_property)
 
           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
@@ -280,7 +303,11 @@ module JSON::LD
                 [{}]
               elsif @options[:rdfstar]
                 # Result must have just a single statement
-                rei_node = expand(value, active_property, context, log_depth: log_depth.to_i + 1)
+                rei_node = expand(value, nil, context, log_depth: log_depth.to_i + 1)
+
+                # Node must not contain @reverse
+                raise JsonLdError::InvalidEmbeddedNode,
+                      "Embedded node with @reverse" if rei_node && rei_node.key?('@reverse')
                 statements = to_enum(:item_to_rdf, rei_node)
                 raise JsonLdError::InvalidEmbeddedNode,
                       "Embedded node with #{statements.size} statements" unless
@@ -465,6 +492,11 @@ module JSON::LD
             # Spec FIXME: need to be sure that result is an array
             value = as_array(value)
 
+            # Make sure that no member of value contains an annotation object
+            raise JsonLdError::InvalidAnnotation,
+              "A list element must not contain @annotation." if
+              value.any? {|n| n.is_a?(Hash) && n.key?('@annotation')}
+
             value
           when '@set'
             # If expanded property is @set, set expanded value to the result of using this algorithm recursively, passing active context, active property, and value for element.
@@ -483,7 +515,7 @@ module JSON::LD
               log_depth: log_depth.to_i + 1)
 
             # If expanded value contains an @reverse member, i.e., properties that are reversed twice, execute for each of its property and item the following steps:
-            if value.has_key?('@reverse')
+            if value.key?('@reverse')
               #log_debug("@reverse", depth: log_depth.to_i) {"double reverse: #{value.inspect}"}
               value['@reverse'].each do |property, item|
                 # If result does not have a property member, create one and set its value to an empty array.
@@ -522,6 +554,12 @@ module JSON::LD
             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

data/lib/json/ld/extensions.rb

@@ -11,10 +11,10 @@ module RDF
   class Statement
     # Validate extended RDF
     def valid_extended?
-      has_subject?    && subject.resource? && subject.valid_extended? &&
-      has_predicate?  && predicate.resource? && predicate.valid_extended? &&
-      has_object?     && object.term? && object.valid_extended? &&
-      (has_graph?      ? (graph_name.resource? && graph_name.valid_extended?) : true)
+      subject?    && subject.resource? && subject.valid_extended? &&
+      predicate?  && predicate.resource? && predicate.valid_extended? &&
+      object?     && object.term? && object.valid_extended? &&
+      (graph?      ? (graph_name.resource? && graph_name.valid_extended?) : true)
     end
   end
 

data/lib/json/ld/flatten.rb

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
 # frozen_string_literal: true
+require 'json/canonicalization'
+
 module JSON::LD
   module Flatten
     include Utils
@@ -7,6 +9,10 @@ module JSON::LD
     ##
     # This algorithm creates a JSON object node map holding an indexed representation of the graphs and nodes represented in the passed expanded document. All nodes that are not uniquely identified by an IRI get assigned a (new) blank node identifier. The resulting node map will have a member for every graph in the document whose value is another object with a member for every node represented in the document. The default graph is stored under the @default member, all other graphs are stored under their graph name.
     #
+    # For RDF*/JSON-LD*:
+    #   * Values of `@id` can be an object (embedded node); when these are used as keys in a Node Map, they are serialized as canonical JSON, and de-serialized when flattening.
+    #   * The presence of `@annotation` implies an embedded node and the annotation object is removed from the node/value object in which it appears.
+    #
     # @param [Array, Hash] element
     #   Expanded JSON-LD input
     # @param [Hash] graph_map A map of graph name to subjects
@@ -16,12 +22,15 @@ module JSON::LD
     #   Node identifier
     # @param [String] active_property (nil)
     #   Property within current node
+    # @param [Boolean] reverse (false)
+    #   Processing a reverse relationship
     # @param [Array] list (nil)
     #   Used when property value is a list
     def create_node_map(element, graph_map,
                         active_graph: '@default',
                         active_subject: nil,
                         active_property: nil,
+                        reverse: false,
                         list: nil)
       if element.is_a?(Array)
         # If element is an array, process each entry in element recursively by passing item for element, node map, active graph, active subject, active property, and list.
@@ -30,21 +39,45 @@ module JSON::LD
                           active_graph: active_graph,
                           active_subject: active_subject,
                           active_property: active_property,
+                          reverse: false,
                           list: list)
         end
       elsif !element.is_a?(Hash)
         raise "Expected hash or array to create_node_map, got #{element.inspect}"
       else
         graph = (graph_map[active_graph] ||= {})
-        subject_node = graph[active_subject]
+        subject_node = !reverse && graph[active_subject.is_a?(Hash) ? active_subject.to_json_c14n : active_subject]
 
         # Transform BNode types
-        if element.has_key?('@type')
+        if element.key?('@type')
           element['@type'] = Array(element['@type']).map {|t| blank_node?(t) ? namer.get_name(t) : t}
         end
 
         if value?(element)
           element['@type'] = element['@type'].first if element ['@type']
+
+          # For rdfstar, if value contains an `@annotation` member ...
+          # note: active_subject will not be nil, and may be an object itself.
+          if element.key?('@annotation')
+            # rdfstar being true is implicit, as it is checked in expansion
+            as = node_reference?(active_subject) ?
+              active_subject['@id'] :
+              active_subject
+            star_subject = {
+              "@id" => as,
+              active_property => [element]
+            }
+
+            # Note that annotation is an array, make the reified subject the id of each member of that array.
+            annotation = element.delete('@annotation').map do |a|
+              a.merge('@id' => star_subject)
+            end
+
+            # Invoke recursively using annotation.
+            create_node_map(annotation, graph_map,
+                            active_graph: active_graph)
+          end
+
           if list.nil?
             add_value(subject_node, active_property, element, property_is_array: true, allow_duplicate: false)
           else
@@ -64,13 +97,19 @@ module JSON::LD
           end
         else
           # Element is a node object
-          id = element.delete('@id')
-          id = namer.get_name(id) if blank_node?(id)
+          ser_id = id = element.delete('@id')
+          if id.is_a?(Hash)
+            # Index graph using serialized id
+            ser_id = id.to_json_c14n
+          elsif id.nil?
+            ser_id = id = namer.get_name
+          end
 
-          node = graph[id] ||= {'@id' => id}
+          node = graph[ser_id] ||= {'@id' => id}
 
-          if active_subject.is_a?(Hash)
-            # If subject is a hash, then we're processing a reverse-property relationship.
+          if reverse
+            # Note: active_subject is a Hash
+            # We're processing a reverse-property relationship.
             add_value(node, active_property, active_subject, property_is_array: true, allow_duplicate: false)
           elsif active_property
             reference = {'@id' => id}
@@ -81,7 +120,30 @@ module JSON::LD
             end
           end
 
-          if element.has_key?('@type')
+          # For rdfstar, if node contains an `@annotation` member ...
+          # note: active_subject will not be nil, and may be an object itself.
+          # XXX: what if we're reversing an annotation?
+          if element.key?('@annotation')
+            # rdfstar being true is implicit, as it is checked in expansion
+            as = node_reference?(active_subject) ?
+              active_subject['@id'] :
+              active_subject
+            star_subject = reverse ? 
+              {"@id" => node['@id'], active_property => [{'@id' => as}]} :
+              {"@id" => as, active_property => [{'@id' => node['@id']}]}
+
+            # Note that annotation is an array, make the reified subject the id of each member of that array.
+            annotation = element.delete('@annotation').map do |a|
+              a.merge('@id' => star_subject)
+            end
+
+            # Invoke recursively using annotation.
+            create_node_map(annotation, graph_map,
+                            active_graph: active_graph,
+                            active_subject: star_subject)
+          end
+
+          if element.key?('@type')
             add_value(node, '@type', element.delete('@type'), property_is_array: true, allow_duplicate: false)
           end
 
@@ -99,7 +161,8 @@ module JSON::LD
                 create_node_map(value, graph_map,
                                 active_graph: active_graph,
                                 active_subject: referenced_node,
-                                active_property: property)
+                                active_property: property,
+                                reverse: true)
               end
             end
           end
@@ -128,7 +191,27 @@ module JSON::LD
       end
     end
 
+    ##
+    # Rename blank nodes recursively within an embedded object
+    #
+    # @param [Object] node
+    # @return [Hash]
+    def rename_bnodes(node)
+      case node
+      when Array
+        node.map {|n| rename_bnodes(n)}
+      when Hash
+        node.inject({}) do |memo, (k, v)|
+          v = namer.get_name(v) if k == '@id' && v.is_a?(String) && blank_node?(v)
+          memo.merge(k => rename_bnodes(v))
+        end
+      else
+        node
+      end
+    end
+
   private
+
     ##
     # Merge nodes from all graphs in the graph_map into a new node map
     #

data/lib/json/ld/format.rb

@@ -57,7 +57,7 @@ module JSON::LD
           lambda: ->(files, **options) do
             out = options[:output] || $stdout
             out.set_encoding(Encoding::UTF_8) if RUBY_PLATFORM == "java"
-            options = options.merge(expandContext: options.delete(:context)) if options.has_key?(:context)
+            options = options.merge(expandContext: options.delete(:context)) if options.key?(:context)
             options[:base] ||= options[:base_uri]
             if options[:format] == :jsonld
               if files.empty?

data/lib/json/ld/frame.rb

@@ -52,7 +52,7 @@ module JSON::LD
           state[:uniqueEmbeds][state[:graph]] ||= {}
         end
 
-        if flags[:embed] == '@link' && link.has_key?(id)
+        if flags[:embed] == '@link' && link.key?(id)
           # add existing linked subject
           add_frame_output(parent, property, link[id])
           next
@@ -66,7 +66,7 @@ module JSON::LD
           warn "[DEPRECATION] #{flags[:embed]}  is not a valid value of @embed in 1.1 mode.\n"
         end
 
-        if !state[:embedded] && state[:uniqueEmbeds][state[:graph]].has_key?(id)
+        if !state[:embedded] && state[:uniqueEmbeds][state[:graph]].key?(id)
           # Skip adding this node object to the top-level, as it was included in another node object
           next
         elsif state[:embedded] &&
@@ -76,7 +76,7 @@ module JSON::LD
           next
         elsif state[:embedded] &&
           %w(@first @once).include?(flags[:embed]) &&
-          state[:uniqueEmbeds][state[:graph]].has_key?(id)
+          state[:uniqueEmbeds][state[:graph]].key?(id)
 
           # if only the first match should be embedded
           # Embed unless already embedded
@@ -97,7 +97,7 @@ module JSON::LD
         state[:subjectStack] << {subject: subject, graph: state[:graph]}
 
         # Subject is also the name of a graph
-        if state[:graphMap].has_key?(id)
+        if state[:graphMap].key?(id)
           # check frame's "@graph" to see what to do next
           # 1. if it doesn't exist and state.graph === "@merged", don't recurse
           # 2. if it doesn't exist and state.graph !== "@merged", recurse
@@ -105,7 +105,7 @@ module JSON::LD
           # 4. if "@default" then don't recurse
           # 5. recurse
           recurse, subframe = false, nil
-          if !frame.has_key?('@graph')
+          if !frame.key?('@graph')
             recurse, subframe = (state[:graph] != '@merged'), {}
           else
             subframe = frame['@graph'].first
@@ -134,7 +134,7 @@ module JSON::LD
           end
 
           # explicit is on and property isn't in frame, skip processing
-          next if flags[:explicit] && !frame.has_key?(prop)
+          next if flags[:explicit] && !frame.key?(prop)
 
           # add objects
           objects.each do |o|
@@ -267,7 +267,7 @@ module JSON::LD
         # If, after replacement, an array contains only the value null remove the value, leaving an empty array.
         input.map {|o| cleanup_preserve(o)}
       when Hash
-        if input.has_key?('@preserve')
+        if input.key?('@preserve')
           # Replace with the content of `@preserve`
           cleanup_preserve(input['@preserve'].first)
         else
@@ -388,7 +388,7 @@ module JSON::LD
           is_empty = v.empty?
           if v = v.first
             validate_frame(v)
-            has_default = v.has_key?('@default')
+            has_default = v.key?('@default')
           end
 
           # No longer a wildcard pattern if frame has any non-keyword properties

data/lib/json/ld/from_rdf.rb

@@ -75,7 +75,7 @@ module JSON::LD
             property: statement.predicate.to_s,
             value:    value
           })
-        elsif referenced_once.has_key?(statement.object.to_s)
+        elsif referenced_once.key?(statement.object.to_s)
           referenced_once[statement.object.to_s] = false
         elsif statement.object.node?
           referenced_once[statement.object.to_s] = {
@@ -146,7 +146,7 @@ module JSON::LD
       result = []
       default_graph.keys.opt_sort(ordered: @options[:ordered]).each do |subject|
         node = default_graph[subject]
-        if graph_map.has_key?(subject)
+        if graph_map.key?(subject)
           node['@graph'] = []
           graph_map[subject].keys.opt_sort(ordered: @options[:ordered]).each do |s|
             n = graph_map[subject][s]

data/lib/json/ld/reader.rb

@@ -68,6 +68,7 @@ module JSON::LD
     # @raise [RDF::ReaderError] if the JSON document cannot be loaded
     def initialize(input = $stdin, **options, &block)
       options[:base_uri] ||= options[:base]
+      options[:rename_bnodes] = false unless options.key?(:rename_bnodes)
       super do
         @options[:base] ||= base_uri.to_s if base_uri
         # Trim non-JSON stuff in script.

data/lib/json/ld/streaming_reader.rb

@@ -136,7 +136,7 @@ module JSON::LD
         when '@type'
           # Set the type-scoped context to the context on input, for use later
           raise JsonLdError::InvalidStreamingKeyOrder,
-                "found #{key} in state #{state}" unless [:await_context, :await_type].include?(state)
+                "found #{key} in state #{state}" unless %i(await_context await_type).include?(state)
 
           type_scoped_context = context
           as_array(value).sort.each do |term|
@@ -159,7 +159,7 @@ module JSON::LD
           raise JsonLdError::InvalidSetOrListObject,
                 "found #{key} in state #{state}" if is_list_or_set
           raise JsonLdError::CollidingKeywords,
-                "found #{key} in state #{state}" unless [:await_context, :await_type, :await_id].include?(state)
+                "found #{key} in state #{state}" unless %i(await_context await_type await_id).include?(state)
 
           # Set our actual id, and use for replacing any provisional statements using our existing node_id, which is provisional
           raise JsonLdError::InvalidIdValue,
@@ -209,7 +209,7 @@ module JSON::LD
           # Expanded values must be node objects
           have_statements = false
           parse_object(value, active_property, context) do |st|
-            have_statements ||= st.has_subject?
+            have_statements ||= st.subject?
             block.call(st)
           end
           raise JsonLdError::InvalidIncludedValue, "values of @included must expand to node objects" unless have_statements
@@ -232,7 +232,7 @@ module JSON::LD
         when '@list'
           raise JsonLdError::InvalidSetOrListObject,
                 "found #{key} in state #{state}" if
-            ![:await_context, :await_type, :await_id].include?(state)
+            !%i(await_context await_type await_id).include?(state)
           is_list_or_set = true
           if subject
             node_id = parse_list(value, active_property, context, &block)
@@ -277,7 +277,7 @@ module JSON::LD
         when '@set'
           raise JsonLdError::InvalidSetOrListObject,
                 "found #{key} in state #{state}" if
-                ![:await_context, :await_type, :await_id].include?(state)
+                !%i(await_context await_type await_id).include?(state)
           is_list_or_set = true
           value = as_array(value).compact
           parse_object(value, active_property, context, subject: subject, predicate: predicate, &block)