json-ld 1.1.8 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f6790b14a0a5f9c477e63ad9b8788b03be1eabe
-  data.tar.gz: 8fc23868782eb98f4c375607ff6bf01813a5aa78
+  metadata.gz: 3404c8ed3ac6a383038d1db06f3c2ad1a8d58135
+  data.tar.gz: 9818ef47ffd7b6d08eb3f387fc9be333b11aca1e
 SHA512:
-  metadata.gz: 7134666ce6f5e0c47148c6a032e1fb13be5c272abd5db50b1a84b7925857b7a86e3f3444718cb2b0d7717eed49a4d24f70bb6a3beaa3da6b394ad68aab1c6140
-  data.tar.gz: 88f96434d3c7b342e7be136c3b9b20ded52c93f4d8234af446e164336decc7a6b9dbd99f59d362619a8fe6f95a7855adbc8feacb929c99601e41a415a7739ded
+  metadata.gz: 09e34ee5537cb9c5004765c735a1fbfcc33b08b89a6d1f9386912ca006459b3582e33f90236d73074eeb1eafcba7fc87e2acb44c14ebbdeeccac50547f3bf117
+  data.tar.gz: 0bda2990643c9f5c4cd4c89a74f6594cc7abd6c4b6e55d8d24ece746dc3980a1b7401714aeb490c1882f214a92a81c6baf6128f92a21825c9da28d6d4a1dcf4e

data/README.md

@@ -4,6 +4,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/json-ld.png)](http://badge.fury.io/rb/json-ld)
 [![Build Status](https://secure.travis-ci.org/ruby-rdf/json-ld.png?branch=master)](http://travis-ci.org/ruby-rdf/json-ld)
+[![Coverage Status](https://coveralls.io/repos/ruby-rdf/json-ld/badge.svg)](https://coveralls.io/r/ruby-rdf/json-ld)
 
 ## Features
 
@@ -11,6 +12,8 @@ JSON::LD parses and serializes [JSON-LD][] into [RDF][] and implements expansion
 
 JSON::LD can now be used to create a _context_ from an RDFS/OWL definition, and optionally include a JSON-LD representation of the ontology itself. This is currently accessed through the `script/gen_context` script.
 
+If the [jsonlint][] gem is installed, it will be used when validating an input document.
+
 Install with `gem install json-ld`
 
 ### JSON-LD Streaming Profile
@@ -301,3 +304,4 @@ see <http://unlicense.org/> or the accompanying {file:UNLICENSE} file.
 [JSON-LD API]:      http://www.w3.org/TR/json-ld-api/ "JSON-LD 1.0 Processing Algorithms and API"
 [JSON-LD Framing]:  http://json-ld.org/spec/latest/json-ld-framing/ "JSON-LD Framing 1.0"
 [Promises]:         http://dom.spec.whatwg.org/#promises
+[jsonlint]:         https://rubygems.org/gems/jsonlint

data/VERSION

@@ -1 +1 @@
-1.1.8
+1.1.9

data/lib/json/ld/api.rb

@@ -6,6 +6,11 @@ require 'json/ld/frame'
 require 'json/ld/to_rdf'
 require 'json/ld/from_rdf'
 
+begin
+  require 'jsonlint'
+rescue LoadError
+end
+
 module JSON::LD
   ##
   # A JSON-LD processor based on the JsonLdProcessor interface.
@@ -76,8 +81,10 @@ module JSON::LD
     #   Use unique bnode identifiers, defaults to using the identifier which the node was originall initialized with (if any).
     # @option options [Boolean]  :simple_compact_iris   (false)
     #   When compacting IRIs, do not use terms with expanded term definitions
+    # @option options [Boolean] :validate Validate input, if a string or readable object.
     # @yield [api]
     # @yieldparam [API]
+    # @raise [JsonLdError]
     def initialize(input, context, options = {}, &block)
       @options = {compactArrays: true, rename_bnodes: true}.merge(options)
       @options[:validate] = true if @options[:processingMode] == "json-ld-1.0"
@@ -99,6 +106,8 @@ module JSON::LD
           link.href if link
         end
 
+        validate_input(input) if options[:validate]
+
         JSON.parse(input.read)
       when String
         remote_doc = @options[:documentLoader].call(input, @options)
@@ -107,8 +116,11 @@ module JSON::LD
         context_ref = remote_doc.contextUrl
 
         case remote_doc.document
-        when String then JSON.parse(remote_doc.document)
-        else remote_doc.document
+        when String
+          validate_input(remote_doc.document) if options[:validate]
+          JSON.parse(remote_doc.document)
+        else
+          remote_doc.document
         end
       end
 
@@ -142,8 +154,9 @@ module JSON::LD
     # @yield jsonld
     # @yieldparam [Array<Hash>] jsonld
     #   The expanded JSON-LD document
-    # @return [Array<Hash>]
-    #   The expanded JSON-LD document
+    # @yieldreturn [Object] returned object
+    # @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, options = {})
       result = nil
@@ -157,8 +170,7 @@ module JSON::LD
 
       # Finally, if element is a JSON object, it is wrapped into an array.
       result = [result].compact unless result.is_a?(Array)
-      yield result if block_given?
-      result
+      block_given? ? yield(result) : result
     end
 
     ##
@@ -176,11 +188,13 @@ module JSON::LD
     # @param  [Hash{Symbol => Object}] options
     #   See options in {JSON::LD::API#initialize}
     #   Other options passed to {JSON::LD::API.expand}
+    # @option options [Boolean] :expanded Input is already expanded
     # @yield jsonld
     # @yieldparam [Hash] jsonld
     #   The compacted JSON-LD document
-    # @return [Hash]
-    #   The compacted JSON-LD document
+    # @yieldreturn [Object] returned object
+    # @return [Object, Hash]
+    #   If a block is given, the result of evaluating the block is returned, otherwise, the compacted JSON-LD document
     # @raise [JsonLdError]
     # @see http://json-ld.org/spec/latest/json-ld-api/#compaction-algorithm
     def self.compact(input, context, options = {})
@@ -188,7 +202,7 @@ 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 = API.expand(input, options)
+      expanded = options[:expanded] ? input : API.expand(input, options)
 
       API.new(expanded, context, options) do
         debug(".compact") {"expanded input: #{expanded.to_json(JSON_STATE) rescue 'malformed json'}"}
@@ -202,8 +216,7 @@ module JSON::LD
         end
         result = ctx.merge(result) unless ctx.empty?
       end
-      yield result if block_given?
-      result
+      block_given? ? yield(result) : result
     end
 
     ##
@@ -218,30 +231,31 @@ module JSON::LD
     # @param  [Hash{Symbol => Object}] options
     #   See options in {JSON::LD::API#initialize}
     #   Other options passed to {JSON::LD::API.expand}
+    # @option options [Boolean] :expanded Input is already expanded
     # @yield jsonld
     # @yieldparam [Hash] jsonld
-    #   The framed JSON-LD document
-    # @return [Array<Hash>]
-    #   The framed JSON-LD document
-    # @raise [InvalidFrame]
+    #   The flattened JSON-LD document
+    # @yieldreturn [Object] returned object
+    # @return [Object, Hash]
+    #   If a block is given, the result of evaluating the block is returned, otherwise, the flattened JSON-LD document
     # @see http://json-ld.org/spec/latest/json-ld-api/#framing-algorithm
     def self.flatten(input, context, options = {})
       flattened = []
 
       # Expand input to simplify processing
-      expanded_input = API.expand(input, options)
+      expanded_input = options[:expanded] ? input : API.expand(input, options)
 
-      # Initialize input using frame as context
+      # Initialize input using
       API.new(expanded_input, context, options) do
         debug(".flatten") {"expanded input: #{value.to_json(JSON_STATE) rescue 'malformed json'}"}
 
         # Initialize node map to a JSON object consisting of a single member whose key is @default and whose value is an empty JSON object.
-        node_map = {'@default' => {}}
-        self.generate_node_map(value, node_map)
+        graphs = {'@default' => {}}
+        create_node_map(value, graphs)
 
-        default_graph = node_map['@default']
-        node_map.keys.kw_sort.reject {|k| k == '@default'}.each do |graph_name|
-          graph = node_map[graph_name]
+        default_graph = graphs['@default']
+        graphs.keys.kw_sort.reject {|k| k == '@default'}.each do |graph_name|
+          graph = graphs[graph_name]
           entry = default_graph[graph_name] ||= {'@id' => graph_name}
           nodes = entry['@graph'] ||= []
           graph.keys.kw_sort.each do |id|
@@ -261,8 +275,7 @@ module JSON::LD
         end
       end
 
-      yield flattened if block_given?
-      flattened
+      block_given? ? yield(flattened) : flattened
     end
 
     ##
@@ -279,34 +292,42 @@ module JSON::LD
     # @param  [Hash{Symbol => Object}] options
     #   See options in {JSON::LD::API#initialize}
     #   Other options passed to {JSON::LD::API.expand}
-    # @option options [Boolean] :embed (true)
+    # @option options ['@last', '@always', '@never', '@link'] :embed ('@link')
     #   a flag specifying that objects should be directly embedded in the output,
     #   instead of being referred to by their IRI.
     # @option options [Boolean] :explicit (false)
     #   a flag specifying that for properties to be included in the output,
     #   they must be explicitly declared in the framing context.
+    # @option options [Boolean] :requireAll (true)
     # @option options [Boolean] :omitDefault (false)
     #   a flag specifying that properties that are missing from the JSON-LD
     #   input should be omitted from the output.
+    # @option options [Boolean] :expanded Input is already expanded
     # @yield jsonld
     # @yieldparam [Hash] jsonld
     #   The framed JSON-LD document
-    # @return [Array<Hash>]
-    #   The framed JSON-LD document
+    # @yieldreturn [Object] returned object
+    # @return [Object, Hash]
+    #   If a block is given, the result of evaluating the block is returned, otherwise, the framed JSON-LD document
     # @raise [InvalidFrame]
     # @see http://json-ld.org/spec/latest/json-ld-api/#framing-algorithm
     def self.frame(input, frame, options = {})
       result = nil
+      options = {
+        base:           input.is_a?(String) ? input : '',
+        compactArrays:  true,
+        embed:          '@last',
+        explicit:       false,
+        requireAll:     true,
+        omitDefault:    false,
+        documentLoader: method(:documentLoader)
+      }.merge(options)
+
       framing_state = {
-        embed:       true,
-        explicit:    false,
-        omitDefault: false,
-        embeds:      nil,
+        graphs:       {'@default' => {}, '@merged' => {}},
+        subjectStack: [],
+        link:         {},
       }
-      framing_state[:embed] = options[:embed] if options.has_key?(:embed)
-      framing_state[:explicit] = options[:explicit] if options.has_key?(:explicit)
-      framing_state[:omitDefault] = options[:omitDefault] if options.has_key?(:omitDefault)
-      options[:documentLoader] ||= method(:documentLoader)
 
       # de-reference frame to create the framing object
       frame = case frame
@@ -321,7 +342,7 @@ module JSON::LD
       end
 
       # Expand input to simplify processing
-      expanded_input = API.expand(input, options)
+      expanded_input = options[:expanded] ? input : API.expand(input, options)
 
       # Expand frame to simplify processing
       expanded_frame = API.expand(frame, options)
@@ -329,22 +350,17 @@ module JSON::LD
       # Initialize input using frame as context
       API.new(expanded_input, nil, options) do
         #debug(".frame") {"context from frame: #{context.inspect}"}
-        debug(".frame") {"raw frame: #{frame.to_json(JSON_STATE) rescue 'malformed json'}"}
         debug(".frame") {"expanded frame: #{expanded_frame.to_json(JSON_STATE) rescue 'malformed json'}"}
-        debug(".frame") {"expanded input: #{value.to_json(JSON_STATE) rescue 'malformed json'}"}
 
         # Get framing nodes from expanded input, replacing Blank Node identifiers as necessary
-        all_nodes = {}
         old_dbg, @options[:debug] = @options[:debug], nil
-        depth do
-          generate_node_map(value, all_nodes)
-        end
+        create_node_map(value, framing_state[:graphs], '@merged')
         @options[:debug] = old_dbg
-        @node_map = all_nodes['@default']
-        debug(".frame") {"node_map: #{@node_map.to_json(JSON_STATE) rescue 'malformed json'}"}
+        framing_state[:subjects] = framing_state[:graphs]['@merged']
+        debug(".frame") {"subjects: #{framing_state[:subjects].to_json(JSON_STATE) rescue 'malformed json'}"}
 
         result = []
-        frame(framing_state, @node_map, (expanded_frame.first || {}), parent: result)
+        frame(framing_state, framing_state[:subjects].keys.sort, (expanded_frame.first || {}), options.merge(parent: result))
         debug(".frame") {"after frame: #{result.to_json(JSON_STATE) rescue 'malformed json'}"}
         
         # Initalize context from frame
@@ -360,8 +376,7 @@ module JSON::LD
         result = cleanup_preserve(result)
       end
 
-      yield result if block_given?
-      result
+      block_given? ? yield(result) : result
     end
 
     ##
@@ -374,9 +389,11 @@ module JSON::LD
     #   Options passed to {JSON::LD::API.expand}
     # @option options [Boolean] :produceGeneralizedRdf (false)
     #   If true, output will include statements having blank node predicates, otherwise they are dropped.
+    # @option options [Boolean] :expanded Input is already expanded
     # @raise [JsonLdError]
     # @yield statement
     # @yieldparam [RDF::Statement] statement
+    # @return [RDF::Enumerable] set of statements, unless a block is given.
     def self.toRdf(input, options = {}, &block)
       unless block_given?
         results = []
@@ -388,7 +405,7 @@ module JSON::LD
       end
 
       # Expand input to simplify processing
-      expanded_input = API.expand(input, options.merge(ordered: false))
+      expanded_input = options[: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.
@@ -396,12 +413,12 @@ module JSON::LD
         debug(".toRdf") {"expanded input: #{expanded_input.to_json(JSON_STATE) rescue 'malformed json'}"}
 
         # Generate _nodeMap_
-        node_map = {'@default' => {}}
-        generate_node_map(expanded_input, node_map)
-        debug(".toRdf") {"node map: #{node_map.to_json(JSON_STATE) rescue 'malformed json'}"}
+        graphs = {'@default' => {}}
+        create_node_map(expanded_input, graphs)
+        debug(".toRdf") {"node map: #{graphs.to_json(JSON_STATE) rescue 'malformed json'}"}
 
         # Start generating statements
-        node_map.each do |graph_name, graph|
+        graphs.each do |graph_name, graph|
           context = as_resource(graph_name) unless graph_name == '@default'
           debug(".toRdf") {"context: #{context ? context.to_ntriples : 'null'}"}
           # Drop results for graphs which are named with relative IRIs
@@ -436,7 +453,6 @@ module JSON::LD
           end
         end
       end
-      results
     end
     
     ##
@@ -450,8 +466,9 @@ module JSON::LD
     # @yield jsonld
     # @yieldparam [Hash] jsonld
     #   The JSON-LD document in expanded form
-    # @return [Array<Hash>]
-    #   The JSON-LD document in expanded form
+    # @yieldreturn [Object] returned object
+    # @return [Object, Hash]
+    #   If a block is given, the result of evaluating the block is returned, otherwise, the expanded JSON-LD document
     def self.fromRdf(input, options = {}, &block)
       options = {useNativeTypes: false}.merge(options)
       result = nil
@@ -460,8 +477,7 @@ module JSON::LD
         result = api.from_statements(input)
       end
 
-      yield result if block_given?
-      result
+      block_given? ? yield(result) : result
     end
 
     ##
@@ -470,9 +486,11 @@ module JSON::LD
     # @param [Hash<Symbol => Object>] options
     # @option options [Boolean] :validate
     #   Allow only appropriate content types
-    # @return [RemoteDocument] retrieved remote document and context information unless block given
     # @yield remote_document
     # @yieldparam [RemoteDocument] remote_document
+    # @yieldreturn [Object] returned object
+    # @return [Object, RemoteDocument]
+    #   If a block is given, the result of evaluating the block is returned, otherwise, the retrieved remote document and context information unless block given
     # @raise [JsonLdError]
     def self.documentLoader(url, options = {})
       options = OPEN_OPTS.merge(options)
@@ -500,11 +518,7 @@ module JSON::LD
 
         doc_uri = remote_doc.base_uri rescue url
         doc = RemoteDocument.new(doc_uri, remote_doc.read, contextUrl)
-        if block_given?
-          yield(doc)
-        else
-          doc
-        end
+        block_given? ? yield(doc) : doc
       end
     rescue IOError => e
       raise JSON::LD::JsonLdError::LoadingDocumentFailed, e.message
@@ -516,6 +530,21 @@ module JSON::LD
       alias :fromRDF :fromRdf
     end
 
+    private
+    def validate_input(input)
+      return unless defined?(JsonLint)
+      jsonlint = JsonLint::Linter.new
+      unless jsonlint.respond_to?(:check_stream)
+        warn "Skipping jsonlint, use latest version from GiHub until 0.1.1 released"
+        return
+      end
+      input = StringIO.new(input) unless input.respond_to?(:read)
+      unless jsonlint.check_stream(input)
+        raise JsonLdError::LoadingDocumentFailed, jsonlint.errors[''].join("\n")
+      end
+      input.rewind
+    end
+
     ##
     # A {RemoteDocument} is returned from a {documentLoader}.
     class RemoteDocument

data/lib/json/ld/context.rb

@@ -155,7 +155,7 @@ module JSON::LD
     # @return [Context]
     def initialize(options = {})
       if options[:base]
-        @base = @doc_base = RDF::URI(options[:base])
+        @base = @doc_base = RDF::URI(options[:base]).dup
         @doc_base.canonicalize!
         @doc_base.fragment = nil
         @doc_base.query = nil
@@ -198,7 +198,7 @@ module JSON::LD
     def base=(value)
       if value
         raise JsonLdError::InvalidBaseIRI, "@base must be a string: #{value.inspect}" unless value.is_a?(String) || value.is_a?(RDF::URI)
-        @base = RDF::URI(value)
+        @base = RDF::URI(value).dup
         @base.canonicalize!
         @base.fragment = nil
         @base.query = nil

data/lib/json/ld/expand.rb

@@ -182,7 +182,7 @@ module JSON::LD
 
                 # Continue with the next key from element
                 next
-              when '@explicit', '@default', '@embed', '@embedChildren', '@omitDefault'
+              when '@explicit', '@default', '@embed', '@explicit', '@omitDefault', '@preserve', '@requireAll'
                 # Framing keywords
                 depth { [expand(value, expanded_property, context, options)].flatten }
               else

data/lib/json/ld/extensions.rb

@@ -1,37 +1,4 @@
 module RDF
-  class Graph
-    # Resource properties
-    #
-    # Properties arranged as a hash with the predicate Term as index to an array of resources or literals
-    #
-    # Example:
-    #     graph.load(':foo a :bar; rdfs:label "An example" .', "http://example.com/")
-    #     graph.resources(URI.new("http://example.com/subject")) =>
-    #     {
-    #       "http://www.w3.org/1999/02/22-rdf-syntax-ns#type" => \[<http://example.com/#bar>\],
-    #       "http://example.com/#label"                       => \["An example"\]
-    #     }
-    def properties(subject, recalc = false)
-      @properties ||= {}
-      @properties.delete(subject.to_s) if recalc
-      @properties[subject.to_s] ||= begin
-        hash = Hash.new
-        self.query(subject: subject) do |statement|
-          pred = statement.predicate.to_s
-
-          hash[pred] ||= []
-          hash[pred] << statement.object
-        end
-        hash
-      end
-    end
-
-    # Get type(s) of subject, returns a list of symbols
-    def type_of(subject)
-      query(subject: subject, predicate: RDF.type).map {|st| st.object}
-    end
-  end
-  
   class Node
     # Odd case of appending to a BNode identifier
     def +(value)