rdf-turtle 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a25ff951065479aaa42feb25d8646ed7e87270556e759ea10d219e24b4ac72
-  data.tar.gz: ee4be6acf9c89792f5df29e018a3ab22c667477de4e95178517a4002da68707b
+  metadata.gz: 6a527c2357a49551b152847f83943ac2e215ac10b2c4c76d0727fd42a85026cd
+  data.tar.gz: 0d8fa400deaf2bbc4c8ea996b0a37d5ead4fbb00519cc95ac84dad58052125e9
 SHA512:
-  metadata.gz: 34c956ae30fbbe235344fc2ada8ed41539e912022b6ec0699afde1108d98d6b83a8c3008bc131535e0f96ef9b9f481079aa58dc5f8b384b250b20b4b33b72d90
-  data.tar.gz: 405cfd25f8899631bac219096670d36969602329c7f3ea4905f0a36a47835ee6ac8aac65c163c6b8d4cc4ce284d2e162cb00ff1e7db193c8bf072c00c84c77dd
+  metadata.gz: 2493ae5d441f97c947249a58a7fd8a49ce8aca6f675b08fc5b223a8f3bab2037d2004416ddca6f0ea78ad4dca9199b5c31c92f14b7068085222a7b191de44deb
+  data.tar.gz: c4db12c8fe5e8401f82ae472ee343474704bb19a1bf202b1e551f29be6b2a874697e046a0c6bd4a91fe0a29c3428a02fe2e7fd2dff249c44a783ee17bdc9481c

data/README.md

@@ -19,6 +19,7 @@ Install with `gem install rdf-turtle`
 * Implements a complete parser for [Turtle][].
 * Compatible with Ruby >= 2.2.2.
 * Optional streaming writer, to serialize large graphs
+* Provisional support for [Turtle*][RDF*].
 
 ## Usage
 Instantiate a reader from a local file:
@@ -35,6 +36,50 @@ Write a graph to a file:
        writer << graph
     end
 
+## Turtle* (RDFStar)
+
+Both reader and writer include provisional support for [Turtle*][RDF*].
+
+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`.
+
+**Note: This feature is subject to change or elimination as the standards process progresses.**
+
+### Serializing a Graph containing embedded statements
+
+    require 'rdf/turtle'
+    statement = RDF::Statement(RDF::URI('bob'), RDF::Vocab::FOAF.age, RDF::Literal(23))
+    graph = RDF::Graph.new << [statement, RDF::URI("ex:certainty"), RDF::Literal(0.9)]
+    graph.dump(:ttl, validate: false, standard_prefixes: true)
+    # => '<<<bob> foaf:age 23>> <ex:certainty> 9.0e-1 .'
+
+### Reading a Graph containing embedded statements
+
+By default, the Turtle reader will reject a document containing a subject resource.
+
+    ttl = %(
+      @prefix foaf: <http://xmlns.com/foaf/0.1/> .
+      @prefix ex: <http://example.com/> .
+      <<<bob> foaf:age 23>> ex:certainty 9.0e-1 .
+    )
+    graph = RDF::Graph.new do |graph|
+      RDF::Turtle::Reader.new(ttl) {|reader| graph << reader}
+    end
+    # => RDF::ReaderError
+
+Readers support a `rdfstar` option with either `:PG` (Property Graph) or `:SA` (Separate Assertions) modes. In `:PG` mode, statements that are used in the subject or object positions are also implicitly added to the graph:
+
+    graph = RDF::Graph.new do |graph|
+      RDF::Turtle::Reader.new(ttl, rdfstar: :PG) {|reader| graph << reader}
+    end
+    graph.count #=> 2
+
+When using the `:SA` mode, only one statement is asserted, although the reified statement is contained within the graph.
+
+    graph = RDF::Graph.new do |graph|
+      RDF::Turtle::Reader.new(ttl, rdfstar: :SA) {|reader| graph << reader}
+    end
+    graph.count #=> 1
+
 ## Documentation
 Full documentation available on [Rubydoc.info][Turtle doc]
 
@@ -133,6 +178,7 @@ A copy of the [Turtle EBNF][] and derived parser files are included in the repos
 [Backports]:    https://rubygems.org/gems/backports
 [N-Triples]:    https://www.w3.org/TR/rdf-testcases/#ntriples
 [Turtle]:       https://www.w3.org/TR/2012/WD-turtle-20120710/
+[RDF*]:         https://lists.w3.org/Archives/Public/public-rdf-star/
 [Turtle doc]:   https://rubydoc.info/github/ruby-rdf/rdf-turtle/master/file/README.md
 [Turtle EBNF]:  https://dvcs.w3.org/hg/rdf/file/default/rdf-turtle/turtle.bnf
 [Freebase Dumps]: https://developers.google.com/freebase/data

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.1.1

data/lib/rdf/turtle/reader.rb

@@ -25,7 +25,7 @@ module RDF::Turtle
     terminal(:STRING_LITERAL_SINGLE_QUOTE,      STRING_LITERAL_SINGLE_QUOTE,      unescape:  true)
     
     # String terminals
-    terminal(nil,                               %r([\(\),.;\[\]Aa]|\^\^|true|false))
+    terminal(nil,                               %r([\(\),.;\[\]Aa]|\^\^|true|false|<<|>>))
 
     terminal(:PREFIX,                           PREFIX)
     terminal(:BASE,                             BASE)
@@ -87,7 +87,7 @@ module RDF::Turtle
         @options = {
           anon_base:  "b0",
           whitespace:  WS,
-          log_depth: 0,
+          depth: 0,
         }.merge(@options)
         @prod_stack = []
 
@@ -185,7 +185,7 @@ module RDF::Turtle
     
     # Create a literal
     def literal(value, **options)
-      log_debug("literal") do
+      log_debug("literal", depth: @options[:depth]) do
         "value: #{value.inspect}, " +
         "options: #{options.inspect}, " +
         "validate: #{validate?.inspect}, " +
@@ -221,7 +221,7 @@ module RDF::Turtle
         ''
       end
       suffix = suffix.to_s.sub(/^\#/, "") if base.index("#")
-      log_debug("pname") {"base: '#{base}', suffix: '#{suffix}'"}
+      log_debug("pname", depth: options[:depth]) {"base: '#{base}', suffix: '#{suffix}'"}
       process_iri(base + suffix.to_s)
     end
     
@@ -283,7 +283,7 @@ module RDF::Turtle
             terminated = token.value == '@prefix'
             error("Expected PNAME_NS", production: :prefix, token: pfx) unless pfx === :PNAME_NS
             error("Expected IRIREF", production: :prefix, token: iri) unless iri === :IRIREF
-            log_debug("prefixID") {"Defined prefix #{pfx.inspect} mapping to #{iri.inspect}"}
+            log_debug("prefixID", depth: options[:depth]) {"Defined prefix #{pfx.inspect} mapping to #{iri.inspect}"}
             prefix(pfx.value[0..-2], process_iri(iri))
             error("prefixId", "#{token} should be downcased") if token.value.start_with?('@') && token.value != '@prefix'
 
@@ -362,6 +362,7 @@ module RDF::Turtle
         read_iri ||
         read_BlankNode ||
         read_collection ||
+        read_rdfstar ||
         error( "Expected subject", production: :subject, token: @lexer.first)
       end
     end
@@ -373,7 +374,8 @@ module RDF::Turtle
           read_BlankNode ||
           read_collection ||
           read_blankNodePropertyList ||
-          read_literal
+          read_literal ||
+          read_rdfstar
 
           add_statement(:object, RDF::Statement(subject, predicate, object)) if subject && predicate
           object
@@ -381,6 +383,28 @@ module RDF::Turtle
       end
     end
 
+    # Read an RDF* reified statement
+    # @return [RDF::Statement]
+    def read_rdfstar
+      return unless @options[:rdfstar]
+      if @lexer.first.value == '<<'
+        prod(:rdfstar) do
+          @lexer.shift # eat <<
+          subject = read_subject || error("Failed to parse subject", production: :rdfstar, token: @lexer.first)
+          predicate = read_verb || error("Failed to parse predicate", production: :rdfstar, token: @lexer.first)
+          object = read_object || error("Failed to parse object", production: :rdfstar, token: @lexer.first)
+          unless @lexer.first.value == '>>'
+            error("Failed to end of embedded triple", production: :rdfstar, token: @lexer.first)
+          end
+          @lexer.shift
+          statement = RDF::Statement(subject, predicate, object)
+          # Emit the statement if in Property Graph mode
+          add_statement(:rdfstar, statement) if @options[:rdfstar] == :PG
+          statement
+        end
+      end
+    end
+
     # @return [RDF::Literal]
     def read_literal
       error("Unexpected end of file", production: :literal) unless token = @lexer.first
@@ -431,7 +455,7 @@ module RDF::Turtle
       if token === '['
         prod(:blankNodePropertyList, %{]}) do
           @lexer.shift
-          log_info("blankNodePropertyList") {"token: #{token.inspect}"}
+          log_info("blankNodePropertyList", depth: options[:depth]) {"token: #{token.inspect}"}
           node = bnode
           read_predicateObjectList(node)
           error("blankNodePropertyList", "Expected closing ']'") unless @lexer.first === ']'
@@ -447,7 +471,7 @@ module RDF::Turtle
         prod(:collection, %{)}) do
           @lexer.shift
           token = @lexer.first
-          log_info("collection") {"token: #{token.inspect}"}
+          log_info("collection", depth: options[:depth]) {"token: #{token.inspect}"}
           objects = []
           while object = read_object
             objects << object
@@ -483,8 +507,8 @@ module RDF::Turtle
 
     def prod(production, recover_to = [])
       @prod_stack << {prod: production, recover_to: recover_to}
-      @options[:log_depth] += 1
-      log_recover("#{production}(start)") {"token: #{@lexer.first.inspect}"}
+      @options[:depth] += 1
+      log_recover("#{production}(start)", depth: options[:depth]) {"token: #{@lexer.first.inspect}"}
       yield
     rescue EBNF::LL1::Lexer::Error, SyntaxError, Recovery =>  e
       # Lexer encountered an illegal token or the parser encountered
@@ -504,13 +528,13 @@ module RDF::Turtle
         end
       end
       raise EOFError, "End of input found when recovering" if @lexer.first.nil?
-      log_debug("recovery", "current token: #{@lexer.first.inspect}")
+      log_debug("recovery", "current token: #{@lexer.first.inspect}", depth: options[:depth])
 
       unless e.is_a?(Recovery)
         # Get the list of follows for this sequence, this production and the stacked productions.
-        log_debug("recovery", "stack follows:")
+        log_debug("recovery", "stack follows:", depth: options[:depth])
         @prod_stack.reverse.each do |prod|
-          log_debug("recovery", level: 4) {"  #{prod[:prod]}: #{prod[:recover_to].inspect}"}
+          log_debug("recovery", level: 4, depth: options[:depth]) {"  #{prod[:prod]}: #{prod[:recover_to].inspect}"}
         end
       end
 
@@ -520,9 +544,9 @@ module RDF::Turtle
       # Skip tokens until one is found in follows
       while (token = (@lexer.first rescue @lexer.recover)) && follows.none? {|t| token === t}
         skipped = @lexer.shift
-        log_debug("recovery") {"skip #{skipped.inspect}"}
+        log_debug("recovery", depth: options[:depth]) {"skip #{skipped.inspect}"}
       end
-      log_debug("recovery") {"found #{token.inspect} in follows"}
+      log_debug("recovery", depth: options[:depth]) {"found #{token.inspect} in follows"}
 
       # Re-raise the error unless token is a follows of this production
       raise Recovery unless Array(recover_to).any? {|t| token === t}
@@ -530,8 +554,8 @@ module RDF::Turtle
       # Skip that token to get something reasonable to start the next production with
       @lexer.shift
     ensure
-      log_info("#{production}(finish)")
-      @options[:log_depth] -= 1
+      log_info("#{production}(finish)", depth: options[:depth])
+      @options[:depth] -= 1
       @prod_stack.pop
     end
 
@@ -554,7 +578,8 @@ module RDF::Turtle
         lineno:     lineno,
         token:      options[:token],
         production: options[:production],
-        exception:  SyntaxError)
+        depth:      options[:depth],
+        exception:  SyntaxError,)
     end
 
     # Used for internal error recovery

data/lib/rdf/turtle/writer.rb

@@ -313,6 +313,17 @@ module RDF::Turtle
       options[:unique_bnodes] ? node.to_unique_base : node.to_base
     end
 
+    ##
+    # Returns an embedded triples
+    #
+    # @param [RDF::Statement] statement
+    # @param [Hash{Symbol => Object}] options
+    # @return [String]
+    def format_rdfstar(statement, **options)
+      log_debug("rdfstar") {"#{statement.to_ntriples}"}
+      "<<%s %s %s>>" % statement.to_a.map { |value| format_term(value, **options) }
+    end
+
     protected
     # Output @base and @prefix definitions
     def start_document
@@ -457,7 +468,7 @@ module RDF::Turtle
 
     # Can subject be represented as a blankNodePropertyList?
     def blankNodePropertyList?(resource, position)
-      resource.node? &&
+      !resource.statement? && resource.node? &&
         !is_valid_list?(resource) &&
         (!is_done?(resource) || position == :subject) &&
         ref_count(resource) == (position == :object ? 1 : 0)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdf-turtle
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Gregg Kellogg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdf
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
 - !ruby/object:Gem::Dependency
   name: ebnf
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +175,7 @@ files:
 - lib/rdf/turtle/terminals.rb
 - lib/rdf/turtle/version.rb
 - lib/rdf/turtle/writer.rb
-homepage: https://ruby-rdf.github.com/rdf-turtle
+homepage: https://github.com/ruby-rdf/rdf-turtle
 licenses:
 - Unlicense
 metadata: {}
@@ -188,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Turtle reader/writer for Ruby.