json-ld 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33d72fb295b05e075532454ade144d79cf15458946492639f9a941a62668c510
-  data.tar.gz: a382b3bdf08bc1b377d5d01f8d2bae93631e7f9077161fd6bbddfd7477a4c775
+  metadata.gz: e6f16239f3f6fc54a6a0e1e6a68d097ba97bb268893f3160df3fe86b4ac6170e
+  data.tar.gz: f21243bfcf58a41dd1a091ac9a92664be80e4e8a813ed9630285f1f96ead4f4e
 SHA512:
-  metadata.gz: fea935d4ce21a779b4d6eb2bd38eaf8f0859b4e312b8baa509e3325663597cffcef934e3210dda62e339b08d86dc689458fc331b5edf86e500b28ffbe4679548
-  data.tar.gz: 1d589f193efd2725ac4ac4d200de04fea6d13296fa7ad3989cf40cfed30424dd91dfb27ced0eda4ce88d0f5676e90b36e5b4cff8185afac9644fd3cc7edd7c0a
+  metadata.gz: 9890153889067a1d87707aac9b52cc6b914dcf0372253d51ba3e496b97f87f5b0bfaa07091513c1f3e3e8b23852151f7b221ef21e5d83e94f59cff3079120fd9
+  data.tar.gz: 0e6240f1d3e02b145a7a786a14770c181700e777d99bf7af924d50af221074ccf2e0fb20659cfc5c061ef9c5550acb397c433b029f115f1eba89dd25aa60378e

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.0.1

data/lib/json/ld/api.rb

@@ -71,6 +71,8 @@ module JSON::LD
     #   A context that is used to initialize the active context when expanding a document.
     # @option options [Boolean, String, RDF::URI] :flatten
     #   If set to a value that is not `false`, the JSON-LD processor must modify the output of the Compaction Algorithm or the Expansion Algorithm by coalescing all properties associated with each subject via the Flattening Algorithm. The value of `flatten must` be either an _IRI_ value representing the name of the graph to flatten, or `true`. If the value is `true`, then the first graph encountered in the input document is selected and flattened.
+    # @option options [String] :language
+    #   When set, this has the effect of inserting a context definition with `@language` set to the associated value, creating a default language for interpreting string values.
     # @option options [String] :processingMode
     #   Processing mode, json-ld-1.0 or json-ld-1.1.
     #   If `processingMode` is not specified, a mode of `json-ld-1.0` or `json-ld-1.1` is set, the context used for `expansion` or `compaction`.
@@ -80,12 +82,15 @@ module JSON::LD
     #   Use unique bnode identifiers, defaults to using the identifier which the node was originally initialized with (if any).
     # @option options [Symbol] :adapter used with MultiJson
     # @option options [Boolean] :validate Validate input, if a string or readable object.
+    # @option options [Boolean] :ordered (true)
+    #   Order traversal of dictionary members by key when performing algorithms.
     # @yield [api]
     # @yieldparam [API]
     # @raise [JsonLdError]
     def initialize(input, context, rename_bnodes: true, unique_bnodes: false, **options, &block)
       @options = {
         compactArrays:      true,
+        ordered:            false,
         documentLoader:     self.class.method(:documentLoader)
       }.merge(options)
       @namer = unique_bnodes ? BlankNodeUniqer.new : (rename_bnodes ? BlankNodeNamer.new("b") : BlankNodeMapper.new)
@@ -161,11 +166,11 @@ module JSON::LD
     # @return [Object, Array<Hash>]
     #   If a block is given, the result of evaluating the block is returned, otherwise, the expanded JSON-LD document
     # @see http://json-ld.org/spec/latest/json-ld-api/#expansion-algorithm
-    def self.expand(input, ordered: true, framing: false, **options, &block)
+    def self.expand(input, framing: false, **options, &block)
       result, doc_base = nil
       API.new(input, options[:expandContext], options) do
         result = self.expand(self.value, nil, self.context,
-          ordered: ordered,
+          ordered: @options[:ordered],
           framing: framing)
         doc_base = @options[:base]
       end
@@ -216,14 +221,14 @@ module JSON::LD
 
       # 1) Perform the Expansion Algorithm on the JSON-LD input.
       #    This removes any existing context to allow the given context to be cleanly applied.
-      expanded_input = expanded ? input : API.expand(input, options) do |res, base_iri|
+      expanded_input = expanded ? input : API.expand(input, options.merge(ordered: false)) do |res, base_iri|
         options[:base] ||= base_iri if options[:compactToRelative]
         res
       end
 
       API.new(expanded_input, context, no_default_base: true, **options) do
         log_debug(".compact") {"expanded input: #{expanded_input.to_json(JSON_STATE) rescue 'malformed json'}"}
-        result = compact(value)
+        result = compact(value, ordered: @options[:ordered])
 
         # xxx) Add the given context to the output
         ctx = self.context.serialize
@@ -274,23 +279,23 @@ module JSON::LD
         create_node_map(value, graph_maps)
 
         default_graph = graph_maps['@default']
-        graph_maps.keys.sort.each do |graph_name|
+        graph_maps.keys.opt_sort(ordered: @options[:ordered]).each do |graph_name|
           next if graph_name == '@default'
 
           graph = graph_maps[graph_name]
           entry = default_graph[graph_name] ||= {'@id' => graph_name}
           nodes = entry['@graph'] ||= []
-          graph.keys.sort.each do |id|
+          graph.keys.opt_sort(ordered: @options[:ordered]).each do |id|
             nodes << graph[id] unless node_reference?(graph[id])
           end
         end
-        default_graph.keys.sort.each do |id|
+        default_graph.keys.opt_sort(ordered: @options[:ordered]).each do |id|
           flattened << default_graph[id] unless node_reference?(default_graph[id])
         end
 
         if context && !flattened.empty?
           # Otherwise, return the result of compacting flattened according the Compaction algorithm passing context ensuring that the compaction result uses the @graph keyword (or its alias) at the top-level, even if the context is empty or if there is only one element to put in the @graph array. This ensures that the returned document has a deterministic structure.
-          compacted = as_array(compact(flattened))
+          compacted = as_array(compact(flattened, ordered: @options[:ordered]))
           kwgraph = self.context.compact_iri('@graph', quiet: true)
           flattened = self.context.serialize.merge(kwgraph => compacted)
         end
@@ -337,7 +342,6 @@ module JSON::LD
         explicit:                   false,
         requireAll:                 true,
         omitDefault:                false,
-        omitGraph:                  false,
         documentLoader:             method(:documentLoader)
       }.merge(options)
 
@@ -361,19 +365,24 @@ module JSON::LD
       end
 
       # Expand input to simplify processing
-      expanded_input = expanded ? input : API.expand(input, options) do |res, base_iri|
+      expanded_input = expanded ? input : API.expand(input, options.merge(ordered: false)) do |res, base_iri|
         options[:base] ||= base_iri if options[:compactToRelative]
         res
       end
 
       # Expand frame to simplify processing
-      expanded_frame = API.expand(frame, framing: true, **options)
+      expanded_frame = API.expand(frame, options.merge(framing: true, ordered: false))
 
       # Initialize input using frame as context
       API.new(expanded_input, frame['@context'], no_default_base: true, **options) do
         log_debug(".frame") {"expanded input: #{expanded_input.to_json(JSON_STATE) rescue 'malformed json'}"}
         log_debug(".frame") {"expanded frame: #{expanded_frame.to_json(JSON_STATE) rescue 'malformed json'}"}
 
+        # Set omitGraph option, if not present, based on processingMode
+        unless options.has_key?(:omitGraph)
+          options[:omitGraph] = @options[:processingMode] != 'json-ld-1.0'
+        end
+
         # Get framing nodes from expanded input, replacing Blank Node identifiers as necessary
         create_node_map(value, framing_state[:graphMap], active_graph: '@default')
 
@@ -391,7 +400,7 @@ module JSON::LD
         framing_state[:subjects] = framing_state[:graphMap][framing_state[:graph]]
 
         result = []
-        frame(framing_state, framing_state[:subjects].keys.sort, (expanded_frame.first || {}), parent: result, **options)
+        frame(framing_state, framing_state[:subjects].keys.opt_sort(ordered: @options[:ordered]), (expanded_frame.first || {}), parent: result, **options)
 
         # Count blank node identifiers used in the document, if pruning
         unless @options[:processingMode] == 'json-ld-1.0'
@@ -402,7 +411,7 @@ module JSON::LD
         # Initalize context from frame
         @context = @context.parse(frame['@context'])
         # Compact result
-        compacted = compact(result)
+        compacted = compact(result, ordered: @options[:ordered])
         compacted = [compacted] unless options[:omitGraph] || compacted.is_a?(Array)
 
         # Add the given context to the output
@@ -443,7 +452,7 @@ module JSON::LD
       end
 
       # Expand input to simplify processing
-      expanded_input = expanded ? input : API.expand(input, ordered: false, **options)
+      expanded_input = expanded ? input : API.expand(input, options.merge(ordered: false))
 
       API.new(expanded_input, nil, options) do
         # 1) Perform the Expansion Algorithm on the JSON-LD input.
@@ -487,8 +496,11 @@ module JSON::LD
     def self.fromRdf(input, useRdfType: false, useNativeTypes: false, **options, &block)
       result = nil
 
-      API.new(nil, nil, options) do |api|
-        result = api.from_statements(input, useRdfType: useRdfType, useNativeTypes: useNativeTypes)
+      API.new(nil, nil, options) do
+        result = from_statements(input,
+          useRdfType: useRdfType,
+          useNativeTypes: useNativeTypes,
+          ordered: @options[:ordered])
       end
 
       block_given? ? yield(result) : result

data/lib/json/ld/compact.rb

@@ -9,8 +9,10 @@ module JSON::LD
     #
     # @param [Array, Hash] element
     # @param [String] property (nil)
+    # @param [Boolean] ordered (true)
+    #   Ensure output objects have keys ordered properly
     # @return [Array, Hash]
-    def compact(element, property: nil)
+    def compact(element, property: nil, ordered: false)
       #if property.nil?
       #  log_debug("compact") {"element: #{element.inspect}, ec: #{context.inspect}"}
       #else
@@ -25,7 +27,7 @@ module JSON::LD
       case element
       when Array
         #log_debug("") {"Array #{element.inspect}"}
-        result = element.map {|item| compact(item, property: property)}.compact
+        result = element.map {|item| compact(item, property: property, ordered: ordered)}.compact
 
         # If element has a single member and the active property has no
         # @container mapping to @list or @set, the compacted value is that
@@ -54,7 +56,7 @@ module JSON::LD
 
         # If expanded property is @list and we're contained within a list container, recursively compact this item to an array
         if list?(element) && context.container(property) == %w(@list)
-          return compact(element['@list'], property: property)
+          return compact(element['@list'], property: property, ordered: ordered)
         end
 
 
@@ -71,7 +73,7 @@ module JSON::LD
           self.context = context.parse(term_context) if term_context
         end
 
-        element.keys.sort.each do |expanded_property|
+        element.keys.opt_sort(ordered: ordered).each do |expanded_property|
           expanded_value = element[expanded_property]
           #log_debug("") {"#{expanded_property}: #{expanded_value.inspect}"}
 
@@ -89,7 +91,7 @@ module JSON::LD
           end
 
           if expanded_property == '@reverse'
-            compacted_value = compact(expanded_value, property: '@reverse')
+            compacted_value = compact(expanded_value, property: '@reverse', ordered: ordered)
             #log_debug("@reverse") {"compacted_value: #{compacted_value.inspect}"}
             # handle double-reversed properties
             compacted_value.each do |prop, value|
@@ -110,7 +112,7 @@ module JSON::LD
 
           if expanded_property == '@preserve'
             # Compact using `property`
-            compacted_value = compact(expanded_value, property: property)
+            compacted_value = compact(expanded_value, property: property, ordered: ordered)
             #log_debug("@preserve") {"compacted_value: #{compacted_value.inspect}"}
 
             unless compacted_value.is_a?(Array) && compacted_value.empty?
@@ -176,7 +178,7 @@ module JSON::LD
             else expanded_item
             end
 
-            compacted_item = compact(value, property: item_active_property)
+            compacted_item = compact(value, property: item_active_property, ordered: ordered)
             #log_debug("") {" => compacted key: #{item_active_property.inspect} for #{compacted_item.inspect}"}
 
             # handle @list
@@ -267,8 +269,7 @@ module JSON::LD
           end
         end
 
-        # Re-order result keys
-        result.keys.sort.each_with_object({}) {|kk, memo| memo[kk] = result[kk]}
+        result
       else
         # For other types, the compacted value is the element value
         #log_debug("compact") {element.class.to_s}

data/lib/json/ld/context.rb

@@ -750,7 +750,7 @@ module JSON::LD
         ctx['@vocab'] = vocab.to_s if vocab
 
         # Term Definitions
-        term_definitions.keys.sort.each do |term|
+        term_definitions.keys.each do |term|
           defn = term_definitions[term].to_context_definition(self)
           ctx[term] = defn if defn
         end
@@ -1201,7 +1201,7 @@ module JSON::LD
         candidates << ciri unless value && term_definitions.has_key?(ciri)
       end
 
-      return candidates.term_sort.first if !candidates.empty?
+      return candidates.sort.first if !candidates.empty?
 
       # If we still don't have any terms and we're using standard_prefixes,
       # try those, and add to mapping
@@ -1214,7 +1214,7 @@ module JSON::LD
             iri.sub(v.to_uri.to_s, "#{prefix}:").sub(/:$/, '')
           end
 
-        return candidates.term_sort.first if !candidates.empty?
+        return candidates.sort.first if !candidates.empty?
       end
 
       if !vocab

data/lib/json/ld/expand.rb

@@ -19,7 +19,7 @@ module JSON::LD
     # @param [Boolean] framing (false)
     #   Special rules for expanding a frame
     # @return [Array<Hash{String => Object}>]
-    def expand(input, active_property, context, ordered: true, framing: false)
+    def expand(input, active_property, context, ordered: false, framing: false)
       #log_debug("expand") {"input: #{input.inspect}, active_property: #{active_property.inspect}, context: #{context.inspect}"}
       framing = false if active_property == '@default'
       result = case input

data/lib/json/ld/extensions.rb

@@ -43,11 +43,11 @@ module RDF
 end
 
 class Array
-  # Order terms, length first, then lexographically
-  def term_sort
-    self.sort do |a, b|
-      len_diff = a.length <=> b.length
-      len_diff == 0 ? a <=> b : len_diff
-    end
+  # Optionally order items
+  #
+  # @param [Boolean] ordered
+  # @return [Array]
+  def opt_sort(ordered: false)
+    ordered ? self.sort : self
   end
 end

data/lib/json/ld/flatten.rb

@@ -18,6 +18,8 @@ module JSON::LD
     #   Property within current node
     # @param [Array] list (nil)
     #   Used when property value is a list
+    # @param [Boolean] ordered (true)
+    #   Ensure output objects have keys ordered properly
     def create_node_map(element, graph_map,
                         active_graph: '@default',
                         active_subject: nil,
@@ -110,7 +112,7 @@ module JSON::LD
                             active_graph: id)
           end
 
-          element.keys.sort.each do |property|
+          element.keys.each do |property|
             value = element[property]
 
             property = namer.get_name(property) if blank_node?(property)

data/lib/json/ld/frame.rb

@@ -14,13 +14,15 @@ module JSON::LD
     # @param [Array<String>] subjects
     #   The subjects to filter
     # @param [Hash{String => Object}] frame
-    # @param [Hash{Symbol => Object}] options ({})
-    # @option options [Hash{String => Object}] :parent (nil)
-    #   Parent subject or top-level array
-    # @option options [String] :property (nil)
+    # @param [String] property (nil)
     #   The parent property.
+    # @param [Hash{String => Object}] parent (nil)
+    #   Parent subject or top-level array
+    # @param [Boolean] ordered (true)
+    #   Ensure output objects have keys ordered properly
+    # @param [Hash{Symbol => Object}] options ({})
     # @raise [JSON::LD::InvalidFrame]
-    def frame(state, subjects, frame, parent: nil, property: nil, **options)
+    def frame(state, subjects, frame, parent: nil, property: nil, ordered: false, **options)
       #log_depth do
       #log_debug("frame") {"subjects: #{subjects.inspect}"}
       #log_debug("frame") {"frame: #{frame.to_json(JSON_STATE)}"}
@@ -45,7 +47,7 @@ module JSON::LD
       matches = filter_subjects(state, subjects, frame, flags)
 
       # For each id and node from the set of matched subjects ordered by id
-      matches.keys.sort.each do |id|
+      matches.keys.opt_sort(ordered: ordered).each do |id|
         subject = matches[id]
 
         # Note: In order to treat each top-level match as a compartmentalized result, clear the unique embedded subjects map when the property is nil, which only occurs at the top-level.
@@ -110,7 +112,7 @@ module JSON::LD
         end
 
         # iterate over subject properties in order
-        subject.keys.sort.each do |prop|
+        subject.keys.opt_sort(ordered: ordered).each do |prop|
           objects = subject[prop]
 
           # copy keywords to output
@@ -153,7 +155,7 @@ module JSON::LD
         end
 
         # handle defaults in order
-        frame.keys.sort.each do |prop|
+        frame.keys.opt_sort(ordered: ordered).each do |prop|
           next if prop.start_with?('@')
 
           # if omit default is off, then include default values for properties that appear in the next frame but are not in the matching subject

data/lib/json/ld/from_rdf.rb

@@ -14,8 +14,10 @@ module JSON::LD
     # @param [Boolean] useRdfType (false)
     #   If set to `true`, the JSON-LD processor will treat `rdf:type` like a normal property instead of using `@type`.
     # @param [Boolean] useNativeTypes (false) use native representations
+    # @param [Boolean] ordered (true)
+    #   Ensure output objects have keys ordered properly
     # @return [Array<Hash>] the JSON-LD document in normalized form
-    def from_statements(dataset, useRdfType: false, useNativeTypes: false)
+    def from_statements(dataset, useRdfType: false, useNativeTypes: false, ordered: false)
       default_graph = {}
       graph_map = {'@default' => default_graph}
       referenced_once = {}
@@ -118,11 +120,11 @@ module JSON::LD
       end
 
       result = []
-      default_graph.keys.sort.each do |subject|
+      default_graph.keys.opt_sort(ordered: ordered).each do |subject|
         node = default_graph[subject]
         if graph_map.has_key?(subject)
           node['@graph'] = []
-          graph_map[subject].keys.sort.each do |s|
+          graph_map[subject].keys.opt_sort(ordered: ordered).each do |s|
             n = graph_map[subject][s]
             n.delete(:usages)
             node['@graph'] << n unless node_reference?(n)

data/lib/json/ld/reader.rb

@@ -21,7 +21,7 @@ module JSON::LD
           on: ["--expand-context CONTEXT"],
           description: "Context to use when expanding.") {|arg| RDF::URI(arg)},
         RDF::CLI::Option.new(
-          symbol: :processing_mode,
+          symbol: :processingMode,
           datatype: %w(json-ld-1.0 json-ld-1.1),
           control: :radio,
           on: ["--processingMode MODE", %w(json-ld-1.0 json-ld-1.1)],

data/lib/json/ld/writer.rb

@@ -75,15 +75,17 @@ module JSON::LD
         RDF::CLI::Option.new(
           symbol: :compactArrays,
           datatype: TrueClass,
+          default: true,
           control: :checkbox,
-          on: ["--compact-arrays"],
-          description: "Replaces arrays with just one element with that element during compaction.") {true},
+          on: ["--[no-]compact-arrays"],
+          description: "Replaces arrays with just one element with that element during compaction. Default is `true` use --no-compact-arrays to disable.") {|arg| arg},
         RDF::CLI::Option.new(
           symbol: :compactToRelative,
           datatype: TrueClass,
+          default: true,
           control: :checkbox,
-          on: ["--compact-to-relative"],
-          description: "Creates document relative IRIs when compacting, if `true`, otherwise leaves expanded. Default is `true` use --no-compact-to-relative to disable.") {true},
+          on: ["--[no-]compact-to-relative"],
+          description: "Creates document relative IRIs when compacting, if `true`, otherwise leaves expanded. Default is `true` use --no-compact-to-relative to disable.") {|arg| arg},
         RDF::CLI::Option.new(
           symbol: :context,
           datatype: RDF::URI,
@@ -93,6 +95,7 @@ module JSON::LD
         RDF::CLI::Option.new(
           symbol: :embed,
           datatype: %w(@always @last @never),
+          default: '@last',
           control: :select,
           on: ["--embed EMBED"],
           description: "How to embed matched objects (@last).") {|arg| RDF::URI(arg)},
@@ -100,16 +103,22 @@ module JSON::LD
           symbol: :explicit,
           datatype: TrueClass,
           control: :checkbox,
-          on: ["--explicit"],
-          description: "Only include explicitly declared properties in output (false)") {|arg| RDF::URI(arg)},
+          on: ["--[no-]explicit"],
+          description: "Only include explicitly declared properties in output (false)") {|arg| arg},
         RDF::CLI::Option.new(
           symbol: :omitDefault,
           datatype: TrueClass,
           control: :checkbox,
-          on: ["--omitDefault"],
-          description: "Omit missing properties from output (false)") {|arg| RDF::URI(arg)},
+          on: ["--[no-]omitDefault"],
+          description: "Omit missing properties from output (false)") {|arg| arg},
         RDF::CLI::Option.new(
-          symbol: :processing_mode,
+          symbol: :ordered,
+          datatype: TrueClass,
+          control: :checkbox,
+          on: ["--[no-]ordered"],
+          description: "Order object member processing lexographically.") {|arg| arg},
+        RDF::CLI::Option.new(
+          symbol: :processingMode,
           datatype: %w(json-ld-1.0 json-ld-1.1),
           control: :radio,
           on: ["--processingMode MODE", %w(json-ld-1.0 json-ld-1.1)],
@@ -117,21 +126,22 @@ module JSON::LD
         RDF::CLI::Option.new(
           symbol: :requireAll,
           datatype: TrueClass,
+          default: true,
           control: :checkbox,
-          on: ["--requireAll"],
-          description: "Require all properties to match (true)") {|arg| RDF::URI(arg)},
+          on: ["--[no-]requireAll"],
+          description: "Require all properties to match (true). Default is `true` use --no-compact-to-relative to disable.") {|arg| arg},
         RDF::CLI::Option.new(
           symbol: :stream,
           datatype: TrueClass,
           control: :checkbox,
-          on: ["--stream"],
-          description: "Do not attempt to optimize graph presentation, suitable for streaming large graphs.") {true},
+          on: ["--[no-]stream"],
+          description: "Do not attempt to optimize graph presentation, suitable for streaming large graphs.") {|arg| arg},
         RDF::CLI::Option.new(
           symbol: :useRdfType,
           datatype: TrueClass,
           control: :checkbox,
-          on: ["--use-rdf-type"],
-          description: "Treat `rdf:type` like a normal property instead of using `@type`.") {true},
+          on: ["--[no-]use-rdf-type"],
+          description: "Treat `rdf:type` like a normal property instead of using `@type`.") {|arg| arg},
       ]
     end