json-ld 3.2.4 → 3.3.0

data/lib/json/ld/reader.rb

@@ -1,116 +1,123 @@
-# -*- encoding: utf-8 -*-
-
-module JSON::LD
-  ##
-  # A JSON-LD parser in Ruby.
-  #
-  # @see https://www.w3.org/TR/json-ld11-api
-  # @author [Gregg Kellogg](http://greggkellogg.net/)
-  class Reader < RDF::Reader
-    include StreamingReader
-    format Format
+# frozen_string_literal: true
 
+module JSON
+  module LD
     ##
-    # JSON-LD Reader options
-    # @see https://ruby-rdf.github.io/rdf/RDF/Reader#options-class_method
-    def self.options
-      super + [
-        RDF::CLI::Option.new(
-          symbol: :expandContext,
-          control: :url2,
-          datatype: RDF::URI,
-          on: ["--expand-context CONTEXT"],
-          description: "Context to use when expanding.") {|arg| RDF::URI(arg).absolute? ? RDF::URI(arg) : StringIO.new(File.read(arg))},
-        RDF::CLI::Option.new(
-          symbol: :extractAllScripts,
-          datatype: TrueClass,
-          default: false,
-          control: :checkbox,
-          on: ["--[no-]extract-all-scripts"],
-          description: "If set to true, when extracting JSON-LD script elements from HTML, unless a specific fragment identifier is targeted, extracts all encountered JSON-LD script elements using an array form, if necessary.") {|arg| RDF::URI(arg)},
-        RDF::CLI::Option.new(
-          symbol: :lowercaseLanguage,
-          datatype: TrueClass,
-          control: :checkbox,
-          on: ["--[no-]lowercase-language"],
-          description: "By default, language tags are left as is. To normalize to lowercase, set this option to `true`."),
-        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)],
-          description: "Set Processing Mode (json-ld-1.0 or json-ld-1.1)"),
-        RDF::CLI::Option.new(
-          symbol: :rdfDirection,
-          datatype: %w(i18n-datatype compound-literal),
-          default: 'null',
-          control: :select,
-          on: ["--rdf-direction DIR", %w(i18n-datatype compound-literal)],
-          description: "How to serialize literal direction (i18n-datatype compound-literal)") {|arg| RDF::URI(arg)},
-        RDF::CLI::Option.new(
-          symbol: :stream,
-          datatype: TrueClass,
-          control: :checkbox,
-          on: ["--[no-]stream"],
-          description: "Optimize for streaming JSON-LD to RDF.") {|arg| arg},
-      ]
-    end
-
-    ##
-    # Initializes the JSON-LD reader instance.
+    # A JSON-LD parser in Ruby.
     #
-    # @param  [IO, File, String]       input
-    # @param  [Hash{Symbol => Object}] options
-    #   any additional options (see `RDF::Reader#initialize` and {JSON::LD::API.initialize})
-    # @yield  [reader] `self`
-    # @yieldparam  [RDF::Reader] reader
-    # @yieldreturn [void] ignored
-    # @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.
-        @doc = if input.respond_to?(:read)
-          input
-        else
-          StringIO.new(input.to_s.sub(%r(\A[^{\[]*)m, '').sub(%r([^}\]]*\Z)m, ''))
-        end
+    # @see https://www.w3.org/TR/json-ld11-api
+    # @author [Gregg Kellogg](http://greggkellogg.net/)
+    class Reader < RDF::Reader
+      include StreamingReader
+      format Format
 
-        if block_given?
-          case block.arity
+      ##
+      # JSON-LD Reader options
+      # @see https://ruby-rdf.github.io/rdf/RDF/Reader#options-class_method
+      def self.options
+        super + [
+          RDF::CLI::Option.new(
+            symbol: :expandContext,
+            control: :url2,
+            datatype: RDF::URI,
+            on: ["--expand-context CONTEXT"],
+            description: "Context to use when expanding."
+          ) { |arg| RDF::URI(arg).absolute? ? RDF::URI(arg) : StringIO.new(File.read(arg)) },
+          RDF::CLI::Option.new(
+            symbol: :extractAllScripts,
+            datatype: TrueClass,
+            default: false,
+            control: :checkbox,
+            on: ["--[no-]extract-all-scripts"],
+            description: "If set to true, when extracting JSON-LD script elements from HTML, unless a specific fragment identifier is targeted, extracts all encountered JSON-LD script elements using an array form, if necessary."
+          ) { |arg| RDF::URI(arg) },
+          RDF::CLI::Option.new(
+            symbol: :lowercaseLanguage,
+            datatype: TrueClass,
+            control: :checkbox,
+            on: ["--[no-]lowercase-language"],
+            description: "By default, language tags are left as is. To normalize to lowercase, set this option to `true`."
+          ),
+          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]],
+            description: "Set Processing Mode (json-ld-1.0 or json-ld-1.1)"
+          ),
+          RDF::CLI::Option.new(
+            symbol: :rdfDirection,
+            datatype: %w[i18n-datatype compound-literal],
+            default: 'null',
+            control: :select,
+            on: ["--rdf-direction DIR", %w[i18n-datatype compound-literal]],
+            description: "How to serialize literal direction (i18n-datatype compound-literal)"
+          ) { |arg| RDF::URI(arg) },
+          RDF::CLI::Option.new(
+            symbol: :stream,
+            datatype: TrueClass,
+            control: :checkbox,
+            on: ["--[no-]stream"],
+            description: "Optimize for streaming JSON-LD to RDF."
+          ) { |arg| arg }
+        ]
+      end
+
+      ##
+      # Initializes the JSON-LD reader instance.
+      #
+      # @param  [IO, File, String]       input
+      # @param  [Hash{Symbol => Object}] options
+      #   any additional options (see `RDF::Reader#initialize` and {JSON::LD::API.initialize})
+      # @yield  [reader] `self`
+      # @yieldparam  [RDF::Reader] reader
+      # @yieldreturn [void] ignored
+      # @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.
+          @doc = if input.respond_to?(:read)
+            input
+          else
+            StringIO.new(input.to_s.sub(/\A[^{\[]*/m, '').sub(/[^}\]]*\Z/m, ''))
+          end
+
+          if block
+            case block.arity
             when 0 then instance_eval(&block)
-            else block.call(self)
+            else yield(self)
+            end
           end
         end
       end
-    end
 
-    ##
-    # @private
-    # @see   RDF::Reader#each_statement
-    def each_statement(&block)
-      if @options[:stream]
-        stream_statement(&block)
-      else
-        API.toRdf(@doc, **@options, &block)
+      ##
+      # @private
+      # @see   RDF::Reader#each_statement
+      def each_statement(&block)
+        if @options[:stream]
+          stream_statement(&block)
+        else
+          API.toRdf(@doc, **@options, &block)
+        end
+      rescue ::JSON::ParserError, ::JSON::LD::JsonLdError => e
+        log_fatal("Failed to parse input document: #{e.message}", exception: RDF::ReaderError)
       end
-    rescue ::JSON::ParserError, ::JSON::LD::JsonLdError => e
-      log_fatal("Failed to parse input document: #{e.message}", exception: RDF::ReaderError)
-    end
 
-    ##
-    # @private
-    # @see   RDF::Reader#each_triple
-    def each_triple(&block)
-      if block_given?
-        each_statement do |statement|
-          yield(*statement.to_triple)
+      ##
+      # @private
+      # @see   RDF::Reader#each_triple
+      def each_triple
+        if block_given?
+          each_statement do |statement|
+            yield(*statement.to_triple)
+          end
         end
+        enum_for(:each_triple)
       end
-      enum_for(:each_triple)
     end
   end
 end
-

data/lib/json/ld/resource.rb

@@ -1,230 +1,249 @@
-# -*- encoding: utf-8 -*-
 # frozen_string_literal: true
-module JSON::LD
-  # Simple Ruby reflector class to provide native
-  # access to JSON-LD objects
-  class Resource
-    include RDF::Enumerable
-
-    # @return [Hash<String => Object] Object representation of resource
-    attr_reader :attributes
-
-    # @return [String] ID of this resource
-    attr_reader :id
-
-    # @return [JSON::LD::Context] Context associated with this resource
-    attr_reader :context
-
-    ##
-    # Is this resource clean (i.e., saved to mongo?)
-    #
-    # @return [Boolean]
-    def clean?; @clean; end
-
-    ##
-    # Is this resource dirty (i.e., not yet saved to mongo?)
-    #
-    # @return [Boolean]
-    def dirty?; !clean?; end
-
-    ##
-    # Has this resource been reconciled against a mongo ID?
-    #
-    # @return [Boolean]
-    def reconciled?; @reconciled; end
-
-    ##
-    # Has this resource been resolved so that
-    # all references are to other Resources?
-    #
-    # @return [Boolean]
-    def resolved?; @resolved; end
-
-    ##
-    # Anonymous resources have BNode ids or no schema:url
-    #
-    # @return [Boolean]
-    def anonymous?; @anon; end
-
-    ##
-    # Is this a stub resource, which has not yet been
-    # synched or created within the DB?
-    def stub?; !!@stub; end
-
-    ##
-    # Is this a new resource, which has not yet been
-    # synched or created within the DB?
-    def new?; !!@new; end
-
-    ##
-    # A new resource from the parsed graph
-    # @param [Hash{String => Object}] node_definition
-    # @param [Hash{Symbol => Object}] options
-    # @option options [String] :context
-    #   Resource context, used for finding
-    #   appropriate collection and JSON-LD context.
-    # @option options [Boolean] :clean (false)
-    # @option options [Boolean] :compact (false)
-    #   Assume `node_definition` is in expanded form
-    #   and compact using `context`.
-    # @option options [Boolean] :reconciled (!new)
-    #   node_definition is not based on Mongo IDs
-    #   and must be reconciled against Mongo, or merged
-    #   into another resource.
-    # @option options [Boolean] :new (true)
-    #   This is a new resource, not yet saved to Mongo
-    # @option options [Boolean] :stub (false)
-    #   This is a stand-in for another resource that has
-    #   not yet been retrieved (or created) from Mongo
-    def initialize(node_definition, **options)
-      @context = options[:context]
-      @clean = options.fetch(:clean, false)
-      @new = options.fetch(:new, true)
-      @reconciled = options.fetch(:reconciled, !@new)
-      @resolved = false
-      @attributes = if options[:compact]
-        JSON::LD::API.compact(node_definition, @context)
-      else
-        node_definition
-      end
-      @id = @attributes['@id']
-      @anon = @id.nil? || @id.to_s.start_with?('_:')
-    end
 
-    ##
-    # Return a hash of this object, suitable for use by for ETag
-    # @return [Integer]
-    def hash
-      self.deresolve.hash
-    end
+module JSON
+  module LD
+    # Simple Ruby reflector class to provide native
+    # access to JSON-LD objects
+    class Resource
+      include RDF::Enumerable
+
+      # @return [Hash<String => Object] Object representation of resource
+      attr_reader :attributes
+
+      # @return [String] ID of this resource
+      attr_reader :id
+
+      # @return [JSON::LD::Context] Context associated with this resource
+      attr_reader :context
+
+      ##
+      # Is this resource clean (i.e., saved to mongo?)
+      #
+      # @return [Boolean]
+      def clean?
+        @clean
+      end
+
+      ##
+      # Is this resource dirty (i.e., not yet saved to mongo?)
+      #
+      # @return [Boolean]
+      def dirty?
+        !clean?
+      end
+
+      ##
+      # Has this resource been reconciled against a mongo ID?
+      #
+      # @return [Boolean]
+      def reconciled?
+        @reconciled
+      end
+
+      ##
+      # Has this resource been resolved so that
+      # all references are to other Resources?
+      #
+      # @return [Boolean]
+      def resolved?
+        @resolved
+      end
+
+      ##
+      # Anonymous resources have BNode ids or no schema:url
+      #
+      # @return [Boolean]
+      def anonymous?
+        @anon
+      end
+
+      ##
+      # Is this a stub resource, which has not yet been
+      # synched or created within the DB?
+      def stub?
+        !!@stub
+      end
+
+      ##
+      # Is this a new resource, which has not yet been
+      # synched or created within the DB?
+      def new?
+        !!@new
+      end
+
+      ##
+      # A new resource from the parsed graph
+      # @param [Hash{String => Object}] node_definition
+      # @param [Hash{Symbol => Object}] options
+      # @option options [String] :context
+      #   Resource context, used for finding
+      #   appropriate collection and JSON-LD context.
+      # @option options [Boolean] :clean (false)
+      # @option options [Boolean] :compact (false)
+      #   Assume `node_definition` is in expanded form
+      #   and compact using `context`.
+      # @option options [Boolean] :reconciled (!new)
+      #   node_definition is not based on Mongo IDs
+      #   and must be reconciled against Mongo, or merged
+      #   into another resource.
+      # @option options [Boolean] :new (true)
+      #   This is a new resource, not yet saved to Mongo
+      # @option options [Boolean] :stub (false)
+      #   This is a stand-in for another resource that has
+      #   not yet been retrieved (or created) from Mongo
+      def initialize(node_definition, **options)
+        @context = options[:context]
+        @clean = options.fetch(:clean, false)
+        @new = options.fetch(:new, true)
+        @reconciled = options.fetch(:reconciled, !@new)
+        @resolved = false
+        @attributes = if options[:compact]
+          JSON::LD::API.compact(node_definition, @context)
+        else
+          node_definition
+        end
+        @id = @attributes['@id']
+        @anon = @id.nil? || @id.to_s.start_with?('_:')
+      end
+
+      ##
+      # Return a hash of this object, suitable for use by for ETag
+      # @return [Integer]
+      def hash
+        deresolve.hash
+      end
 
-    ##
-    # Reverse resolution of resource attributes.
-    # Just returns `attributes` if
-    # resource is unresolved. Otherwise, replaces `Resource`
-    # values with node references.
-    #
-    # Result is expanded and re-compacted to get to normalized
-    # representation.
-    #
-    # @return [Hash] deresolved attribute hash
-    def deresolve
-      node_definition = if resolved?
-        deresolved = [].tap do |memo|
-          attributes.each_pair do |prop, value|
-            memo[prop] = case value
-            when Resource
-              {'id' => value.id}
-            when Array
-              value.map do |v|
-                v.is_a?(Resource) ? {'id' => v.id} : v
+      ##
+      # Reverse resolution of resource attributes.
+      # Just returns `attributes` if
+      # resource is unresolved. Otherwise, replaces `Resource`
+      # values with node references.
+      #
+      # Result is expanded and re-compacted to get to normalized
+      # representation.
+      #
+      # @return [Hash] deresolved attribute hash
+      def deresolve
+        node_definition = if resolved?
+          deresolved = [].tap do |memo|
+            attributes.each_pair do |prop, value|
+              memo[prop] = case value
+              when Resource
+                { 'id' => value.id }
+              when Array
+                value.map do |v|
+                  v.is_a?(Resource) ? { 'id' => v.id } : v
+                end
+              else
+                value
               end
-            else
-              value
             end
           end
+          deresolved
+        else
+          attributes
         end
-        deresolved
-      else
-        attributes
-      end
 
-      compacted = nil
-      JSON::LD::API.expand(node_definition, expandContext: @context) do |expanded|
-        compacted = JSON::LD::API.compact(expanded, @context)
+        compacted = nil
+        JSON::LD::API.expand(node_definition, expandContext: @context) do |expanded|
+          compacted = JSON::LD::API.compact(expanded, @context)
+        end
+        compacted.delete_if { |k, _v| k == '@context' }
       end
-      compacted.delete_if {|k, v| k == '@context'}
-    end
 
-    ##
-    # Serialize to JSON-LD, minus `@context` using
-    # a deresolved version of the attributes
-    #
-    # @param [Hash] options
-    # @return [String] serizlied JSON representation of resource
-    def to_json(**options)
-      deresolve.to_json(**options)
-    end
+      ##
+      # Serialize to JSON-LD, minus `@context` using
+      # a deresolved version of the attributes
+      #
+      # @param [Hash] options
+      # @return [String] serizlied JSON representation of resource
+      def to_json(**options)
+        deresolve.to_json(**options)
+      end
 
-    ##
-    # Enumerate over statements associated with this resource
-    def each(&block)
-      JSON::LD::API.toRdf(attributes, expandContext: context, &block)
-    end
+      ##
+      # Enumerate over statements associated with this resource
+      def each(&block)
+        JSON::LD::API.toRdf(attributes, expandContext: context, &block)
+      end
 
-    ##
-    # Update node references using the provided map.
-    # This replaces node references with Resources,
-    # either stub or instantiated.
-    #
-    # Node references with ids not in the reference_map
-    # will cause stub resources to be added to the map.
-    #
-    # @param [Hash{String => Resource}] reference_map
-    # @return [Resource] self
-    def resolve(reference_map)
-      return if resolved?
-      def update_obj(obj, reference_map)
-        case obj
-        when Array
-          obj.map {|o| update_obj(o, reference_map)}
-        when Hash
-          if node_reference?(obj)
-            reference_map[obj['id']] ||= Resource.new(obj,
-              context: @context_name,
-              clean: false,
-              stub: true
-              )
-          else
-            obj.each_key do |k|
-              obj[k] = update_obj(obj[k], reference_map)
+      ##
+      # Update node references using the provided map.
+      # This replaces node references with Resources,
+      # either stub or instantiated.
+      #
+      # Node references with ids not in the reference_map
+      # will cause stub resources to be added to the map.
+      #
+      # @param [Hash{String => Resource}] reference_map
+      # @return [Resource] self
+      def resolve(reference_map)
+        return if resolved?
+
+        def update_obj(obj, reference_map)
+          case obj
+          when Array
+            obj.map { |o| update_obj(o, reference_map) }
+          when Hash
+            if node_reference?(obj)
+              reference_map[obj['id']] ||= Resource.new(obj,
+                context: @context_name,
+                clean: false,
+                stub: true)
+            else
+              obj.each_key do |k|
+                obj[k] = update_obj(obj[k], reference_map)
+              end
+              obj
             end
+          else
             obj
           end
-        else
-          obj
         end
-      end
 
-      #$logger.debug "resolve(0): #{attributes.inspect}"
-      @attributes.each do |k, v|
-        next if k == 'id' || k == 'type'
-        @attributes[k] = update_obj(@attributes[k], reference_map)
+        # $logger.debug "resolve(0): #{attributes.inspect}"
+        @attributes.each do |k, _v|
+          next if %w[id type].include?(k)
+
+          @attributes[k] = update_obj(@attributes[k], reference_map)
+        end
+        # $logger.debug "resolve(1): #{attributes.inspect}"
+        @resolved = true
+        self
       end
-      #$logger.debug "resolve(1): #{attributes.inspect}"
-      @resolved = true
-      self
-    end
 
-    ##
-    # Override this method to implement save using
-    # an appropriate storage mechanism.
-    #
-    # Save the object to the Mongo collection
-    # use Upsert to create things that don't exist.
-    # First makes sure that the resource is valid.
-    #
-    # @return [Boolean] true or false if resource not saved
-    def save
-      raise NotImplementedError
-    end
+      ##
+      # Override this method to implement save using
+      # an appropriate storage mechanism.
+      #
+      # Save the object to the Mongo collection
+      # use Upsert to create things that don't exist.
+      # First makes sure that the resource is valid.
+      #
+      # @return [Boolean] true or false if resource not saved
+      def save
+        raise NotImplementedError
+      end
 
-    ##
-    # Access individual fields, from subject definition
-    def property(prop_name); @attributes.fetch(prop_name, nil); end
+      ##
+      # Access individual fields, from subject definition
+      def property(prop_name)
+        @attributes.fetch(prop_name, nil)
+      end
 
-    ##
-    # Access individual fields, from subject definition
-    def method_missing(method, *args)
-      property(method.to_s)
-    end
+      ##
+      # Access individual fields, from subject definition
+      def method_missing(method, *_args)
+        property(method.to_s)
+      end
 
-    def inspect
-      "<Resource" +
-      attributes.map do |k, v|
-        "\n  #{k}: #{v.inspect}"
-      end.join(" ") +
-      ">"
+      def inspect
+        "<Resource" +
+          attributes.map do |k, v|
+            "\n  #{k}: #{v.inspect}"
+          end.join(" ") +
+          ">"
+      end
     end
   end
 end