iq_rdf 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9b8113dea4da94252393b4f5d662fb83e20dd201b82f8d350d51ea13cf616a6
-  data.tar.gz: a3c5e7299288526e0e8c042b37cfb6b3d20a500e9e361b464fd6667e07ca94f8
+  metadata.gz: e76fe4fdce925931dc7ec6d5edbbb31c205713e92162fddb028548cf13784fc6
+  data.tar.gz: 691b0e21d7db159fad7f95d478edf1fadb1884e136a761dd0d25f5166f7a7b5a
 SHA512:
-  metadata.gz: aef36d79a240d34c0f3f35ce6dc431f02bfc84e836a5b6050714c86cbac1c5a4e138f43be74f3169a8750b4a730989a0c26fbeb1e53cad9520e80330360b7dcd
-  data.tar.gz: d6844c6e75ca177e5707eb8e87ce181a0a3232c754ad288cb086a2608f9feb13c45bcc2fe138be613c465b9c4f032bac50c10c8a543c82da16307a2bdee15c65
+  metadata.gz: 9f5ec87e657fda841765741e59e717e6864e019229901e07c957317e7da80514330264ee106821ec24e786ebc5cdc1d31557258e7594f4ba4dbcd68ac95bd53c
+  data.tar.gz: 36b99255272b484d44c8fd95546c4626c85df4813d057d7d0b6c5fe2afa287d0ce6b642e653b5226c82f722dbad8af1f9205912725adf12d6b5292bd79c18d53

data/iq_rdf.gemspec

@@ -32,6 +32,8 @@ Gem::Specification.new do |s|
   s.add_dependency "activesupport"
 
   s.add_development_dependency "minitest"
+  # parses generated output back, so that tests catch invalid serializations
+  s.add_development_dependency "rdf-turtle"
 
   s.files = %w(LICENSE README.md Rakefile iq_rdf.gemspec) + Dir.glob("{lib,rails,test}/**/*")
   s.test_files = Dir.glob("{test}/**/*")

data/lib/iq_rdf/document.rb

@@ -62,7 +62,9 @@ module IqRdf
       render_blank_node = lambda do |res|
         node_id = blank_nodes[res]
         unless node_id
-          node_id = blank_nodes.count + 1
+          # size, not count: Hash does not override Enumerable#count, which
+          # walks every entry - once per blank node that is quadratic
+          node_id = blank_nodes.size + 1
           blank_nodes[res] = node_id
         end
         return "_:b#{node_id}"
@@ -143,18 +145,18 @@ module IqRdf
     end
 
     def to_turtle
-      s = ""
+      s = +""
       @namespaces.values.sort{ |n1, n2| n1.turtle_token <=> n2.turtle_token }.each do |namespace|
-        s += "@prefix #{namespace.turtle_token}: <#{namespace.uri_prefix}>.\n"
+        s << "@prefix #{namespace.turtle_token}: <#{namespace.uri_prefix}>.\n"
       end
-      s += "\n"
+      s << "\n"
       @nodes.each do |subject|
         pref = subject.to_s(@document_language)
         indent = "".ljust(pref.length)
 
         # Render subject, if it is defined as a RDF-type.
         if subject.rdf_type
-          s += "#{pref} a #{subject.rdf_type}"
+          s << "#{pref} a #{subject.rdf_type}"
           pref = ";\n" + indent
         end
 
@@ -163,13 +165,13 @@ module IqRdf
           objects = predicate.nodes.map { |object| object.to_s(indent: indent, lang: predicate.lang || subject.lang || @document_language) }
                              .join(", ")
 
-          s += "#{pref} #{predicate.to_s} #{objects}"
+          s << "#{pref} #{predicate.to_s} #{objects}"
 
           pref = ";\n" + indent
         end
-        s += ".\n"
+        s << ".\n"
         if @config[:empty_line_between_triples]
-          s += "\n"
+          s << "\n"
         end
       end
       s

data/lib/iq_rdf/literal.rb

@@ -15,7 +15,8 @@
 module IqRdf
   class Literal
 
-    NTRIPLES_ESCAPE_MAP = {
+    # Turtle accepts the same escapes as N-Triples, so both formats share this
+    ESCAPE_MAP = {
       "\\" => "\\\\",
       '"'  => '\\"',
       "\n" => "\\n",
@@ -23,6 +24,12 @@ module IqRdf
       "\t" => "\\t"
     }.freeze
 
+    # Inside """...""" line breaks and tabs are legal as they are
+    LONG_ESCAPE_MAP = {
+      "\\" => "\\\\",
+      '"'  => '\\"'
+    }.freeze
+
     def initialize(obj, lang = nil, datatype = nil)
       raise "#{datatype.inspect} is not an URI" unless datatype.nil? || datatype.is_a?(::URI) || datatype.is_a?(IqRdf::Uri)
       @obj = obj
@@ -45,7 +52,6 @@ module IqRdf
     def to_s(options = {})
       lang = @lang || options[:lang] # Use the Literals lang when given
       lang = (lang && lang != :none) ? "@#{lang}" : ""
-      quote = @obj.to_s.include?("\n") ? '"""' : '"'
       datatype = if @datatype.is_a?(::URI)
         "^^<#{@datatype.to_s}>"
       elsif @datatype.is_a?(IqRdf::Uri)
@@ -54,7 +60,17 @@ module IqRdf
         ""
       end
 
-      "#{quote}#{@obj.to_s.gsub("\\", "\\\\\\\\").gsub(/"/, "\\\"")}#{quote}#{lang}#{datatype}"
+      value = @obj.to_s
+
+      if value.match?(/[\n\r]/)
+        # A long string keeps line breaks readable, which is the point of
+        # Turtle over N-Triples. Its grammar allows raw line breaks and tabs,
+        # so only backslashes and quotes need escaping - escaping every quote
+        # also rules out a run of three ending the string prematurely.
+        %("""#{value.gsub(/[\\"]/, LONG_ESCAPE_MAP)}"""#{lang}#{datatype})
+      else
+        %("#{value.gsub(/[\\"\n\r\t]/, ESCAPE_MAP)}"#{lang}#{datatype})
+      end
     end
 
     def to_ntriples(parent_lang = nil)
@@ -67,7 +83,7 @@ module IqRdf
         (lang && lang != :none) ? "@#{lang}" : ""
       end
 
-      "\"#{@obj.to_s.gsub(/[\\"\n\r\t]/, NTRIPLES_ESCAPE_MAP)}\"#{suffix}"
+      "\"#{@obj.to_s.gsub(/[\\"\n\r\t]/, ESCAPE_MAP)}\"#{suffix}"
     end
 
     def build_xml(xml, &block)

data/lib/iq_rdf/version.rb

@@ -13,5 +13,5 @@
 #   limitations under the License.
 
 module IqRdf
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/test/test_helper.rb

@@ -19,3 +19,5 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
 require 'iq_rdf'
 
 require 'minitest/autorun'
+
+require 'rdf/turtle'

data/test/turtle_test.rb

@@ -163,6 +163,63 @@ over two lines"""@de;
 rdf
   end
 
+  # A carriage return without a newline used to end up raw inside a short
+  # string, which is invalid Turtle and made parsers drop the statement.
+  def test_control_characters_in_literals
+    document = IqRdf::Document.new('http://www.test.de/', :lang => :none)
+
+    document << IqRdf::testemann do |t|
+      t.carriage_return("first\rsecond")
+      t.tab("left\tright")
+      t.long_with_quote("first\nends with \"")
+      t.long_with_three_quotes("first\nwith \"\"\" inside")
+      t.long_with_backslash("first\nC:\\temp")
+    end
+
+    assert_equal(<<rdf, document.to_turtle)
+@prefix : <http://www.test.de/>.
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
+
+:testemann :carriage_return """first\rsecond""";
+           :tab "left\\tright";
+           :long_with_quote """first
+ends with \\\"""";
+           :long_with_three_quotes """first
+with \\\"\\\"\\\" inside""";
+           :long_with_backslash """first
+C:\\\\temp""".
+rdf
+  end
+
+  # The assertions above compare against an expected string, which cements the
+  # current output but says nothing about whether it is valid Turtle. Parsing
+  # the output back does: it catches escaping that a parser rejects, or that
+  # silently changes the value.
+  def test_literals_survive_a_round_trip
+    {
+      "plain" => "just text",
+      "newline" => "first\nsecond",
+      "carriage return" => "first\rsecond",
+      "carriage return and newline" => "first\r\nsecond",
+      "tab" => "left\tright",
+      "quote" => 'said "hello"',
+      "trailing quote" => 'ends with "',
+      "three quotes" => 'a """ b',
+      "backslash" => 'C:\\temp',
+      "newline and quote" => "first\nends with \"",
+      "newline and three quotes" => "first\nwith \"\"\" inside",
+      "newline and backslash" => "first\nC:\\temp",
+    }.each do |name, value|
+      document = IqRdf::Document.new('http://www.test.de/', :lang => :none)
+      document << IqRdf::testemann.some_predicate(value)
+
+      statements = RDF::Turtle::Reader.new(document.to_turtle, validate: true).to_a
+      assert_equal 1, statements.size, "expected one statement for #{name}"
+      assert_equal value, statements.first.object.value,
+          "#{name} did not survive the round trip"
+    end
+  end
+
   def test_supress_if_empty_otpion
     document = IqRdf::Document.new('http://www.test.de/')
     document.namespaces :foaf => 'http://xmlns.com/foaf/0.1/'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iq_rdf
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Till Schulte-Coerne
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdf-turtle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: IqRdf - A builder like rdf library for ruby and rails
 email:
 - till.schulte-coerne@innoq.com