rdf-n3 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+/.DS_Store
+/pkg

data/.yardopts

@@ -0,0 +1,10 @@
+--title "RDF::RDFa - RDFa Support for RDF.rb"
+--output-dir doc/yard
+--protected
+--no-private
+--hide-void-return
+--markup rdoc
+--readme README.rdoc
+-
+AUTHORS
+VERSION

data/AUTHORS

@@ -0,0 +1 @@
+* Gregg Kellogg <gregg@kellogg-assoc.com>

data/History.txt

@@ -0,0 +1,2 @@
+=== 0.0.1
+* First port from RdfContext version 0.5.4

data/README.rdoc

@@ -0,0 +1,72 @@
+= RDF::N3 reader/writer
+
+Notation-3 (n3-rdf) and Turtle reader/writer for RDF.rb.
+
+== DESCRIPTION:
+
+RDF::N3 is an Notation-3 (n3-rdf) parser for Ruby using the RDF.rb library suite.
+
+== FEATURES:
+RDF::N3 parses Notation-3, Turtle and N-Triples into statements or triples. It also serializes to Turtle.
+
+* Fully compliant N3-rdf parser (N3-rdf level)
+
+Install with 'gem install rdf-n3'
+
+Based on original parser by Patrick Sinclair (metade)
+
+== Usage:
+Instantiate a parser and parse source, specifying type and base-URL
+
+  RDF::N3::Reader.open("etc/foaf.n3") do |reader|
+    reader.each_statement do |statement|
+      puts statement.inspect
+    end
+  end
+
+== Dependencies
+  * [RDF.rb](http://rubygems.org/gems/rdf) (>= 0.1.6)
+  * [Treetop](http://rubygems.org/gems/treetop) (>= 1.4.0) -- For generating parser only, not necessary for runtime
+
+== Resources:
+* Distiller[http://kellogg-assoc/distiller]
+* RDoc[http://rdoc.info/projects/gkellogg/rdf-n3]
+* History[http://github.com/gkellogg/rdf-n3/blob/master/History.txt]
+* "N3 Specification"[http://www.w3.org/DesignIssues/Notation3.html]
+* "N3 Primer"[http://www.w3.org/2000/10/swap/Primer.html]
+* Turtle[http://www.w3.org/TeamSubmission/turtle/]
+* "RDF Tests"[http://www.w3.org/2000/10/rdf-tests/rdfcore/allTestCases.html]
+* "W3C Turtle Test suite"[http://www.w3.org/2000/10/swap/test/regression.n3]
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009-2010 Gregg Kellogg
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+== FEEDBACK
+
+* gregg@kellogg-assoc.com
+* rubygems.org/rdf-n3
+* github.com/gkellogg/rdf-n3
+* gkellogg.lighthouseapp.com for bug reports
+* public-rdf-ruby mailing list on w3.org

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+
+begin
+  gem 'jeweler'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "rdf-n3"
+    gemspec.summary = "Notation-3 (n3-rdf) and Turtle reader/writer for RDF.rb."
+    gemspec.description = <<-DESCRIPTION
+    RDF::N3 is an Notation-3 (n3-rdf) parser for Ruby using the RDF.rb library suite.
+    DESCRIPTION
+    gemspec.email = "gregg@kellogg-assoc.com"
+    gemspec.homepage = "http://github.com/gkellogg/rdf-rdfa"
+    gemspec.authors = ["Gregg Kellogg"]
+    gemspec.add_dependency('rdf', '>= 0.1.6')
+    gemspec.add_development_dependency('rspec')
+    gemspec.add_development_dependency('rdf-spec')
+    gemspec.add_development_dependency('treetop',  '>= 1.4.0')
+    gemspec.extra_rdoc_files     = %w(README.rdoc History.txt AUTHORS)
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Run specs through RCov"
+Spec::Rake::SpecTask.new("spec:rcov") do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rcov = true
+end
+
+desc "Generate HTML report specs"
+Spec::Rake::SpecTask.new("doc:spec") do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/*_spec.rb']
+  spec.spec_opts = ["--format", "html:doc/spec.html"]
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/example.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rubygems'
+require 'rdf/rdfa'
+
+data = <<-EOF;
+  @prefix dc: <http://purl.org/dc/elements/1.1/>.
+  @prefix po: <http://purl.org/ontology/po/>.
+  @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
+  _:broadcast
+   a po:Broadcast;
+   po:schedule_date """2008-06-24T12:00:00Z""";
+   po:broadcast_of _:version;
+   po:broadcast_on <http://www.bbc.co.uk/programmes/service/6music>;
+  .
+  _:version
+   a po:Version;
+  .
+  <http://www.bbc.co.uk/programmes/b0072l93>
+   dc:title """Nemone""";
+   a po:Brand;
+  .
+  <http://www.bbc.co.uk/programmes/b00c735d>
+   a po:Episode;
+   po:episode <http://www.bbc.co.uk/programmes/b0072l93>;
+   po:version _:version;
+   po:long_synopsis """Actor and comedian Rhys Darby chats to Nemone.""";
+   dc:title """Nemone""";
+   po:synopsis """Actor and comedian Rhys Darby chats to Nemone.""";
+  .
+  <http://www.bbc.co.uk/programmes/service/6music>
+   a po:Service;
+   dc:title """BBC 6 Music""";
+  .
+
+  #_:abcd a po:Episode.
+EOF
+
+RDF::N3::Reader.new(data, :base_uri => 'http://www.bbc.co.uk/programmes/on-now.n3') do |reader|
+  reader.each_statement do |statement|
+    statement.inspect!
+  end
+end

data/lib/rdf/n3.rb

@@ -0,0 +1,30 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'rdf'
+
+module RDF
+  ##
+  # **`RDF::N3`** is an Notation-3 plugin for RDF.rb.
+  #
+  # @example Requiring the `RDF::N3` module
+  #   require 'rdf/rdfxml'
+  #
+  # @example Parsing RDF statements from an N3 file
+  #   RDF::N3::Reader.open("etc/foaf.n3") do |reader|
+  #     reader.each_statement do |statement|
+  #       puts statement.inspect
+  #     end
+  #   end
+  #
+  # @see http://rdf.rubyforge.org/
+  # @see http://www.w3.org/TR/REC-rdf-syntax/
+  #
+  # @author [Gregg Kellogg](http://kellogg-assoc.com/)
+  module N3
+    require 'n3/format'
+    require 'n3/vocab'
+    require 'n3/patches/array_hacks'
+    require 'n3/patches/rdf_escape'
+    autoload :Reader,  'rdf/n3/reader'
+    autoload :VERSION, 'rdf/n3/version'
+  end
+end

data/lib/rdf/n3/format.rb

@@ -0,0 +1,34 @@
+module RDF::N3
+  ##
+  # RDFa format specification.
+  #
+  # @example Obtaining an RDFa format class
+  #   RDF::Format.for(:n3)            #=> RDF::N3::Format
+  #   RDF::Format.for(:ttl)            #=> RDF::N3::Format
+  #   RDF::Format.for("etc/foaf.ttl")
+  #   RDF::Format.for("etc/foaf.n3")
+  #   RDF::Format.for(:file_name      => "etc/foaf.ttl")
+  #   RDF::Format.for(:file_name      => "etc/foaf.n3")
+  #   RDF::Format.for(:file_extension => "ttl")
+  #   RDF::Format.for(:file_extension => "n3")
+  #   RDF::Format.for(:content_type   => "text/turtle")
+  #   RDF::Format.for(:content_type   => "text/n3")
+  #
+  # @example Obtaining serialization format MIME types
+  #   RDF::Format.content_types      #=> {"text/turtle" => [RDF::N3::Format]}
+  #   RDF::Format.content_types      #=> {"text/n3")" => [RDF::N3::Format]}
+  #
+  # @example Obtaining serialization format file extension mappings
+  #   RDF::Format.file_extensions    #=> {:ttl => "text/turtle"}
+  #   RDF::Format.file_extensions    #=> {:n3 => "text/n3"}
+  #
+  # @see http://www.w3.org/TR/rdf-testcases/#ntriples
+  class Format < RDF::Format
+    content_type     'text/turtle', :extension => :ttl
+    content_type     'text/n3', :extension => :n3
+    content_encoding 'utf-8'
+
+    reader { RDF::N3::Reader }
+    writer { RDF::N3::Writer }
+  end
+end

data/lib/rdf/n3/patches/array_hacks.rb

@@ -0,0 +1,131 @@
+# coding: utf-8
+require 'iconv'
+
+class String
+  #private
+  # "Borrowed" from JSON utf8_to_json
+  RDF_MAP = {
+    "\x0" => '\u0000',
+    "\x1" => '\u0001',
+    "\x2" => '\u0002',
+    "\x3" => '\u0003',
+    "\x4" => '\u0004',
+    "\x5" => '\u0005',
+    "\x6" => '\u0006',
+    "\x7" => '\u0007',
+    "\b"  =>  '\b',
+    "\t"  =>  '\t',
+    "\n"  =>  '\n',
+    "\xb" => '\u000B',
+    "\f"  =>  '\f',
+    "\r"  =>  '\r',
+    "\xe" => '\u000E',
+    "\xf" => '\u000F',
+    "\x10" => '\u0010',
+    "\x11" => '\u0011',
+    "\x12" => '\u0012',
+    "\x13" => '\u0013',
+    "\x14" => '\u0014',
+    "\x15" => '\u0015',
+    "\x16" => '\u0016',
+    "\x17" => '\u0017',
+    "\x18" => '\u0018',
+    "\x19" => '\u0019',
+    "\x1a" => '\u001A',
+    "\x1b" => '\u001B',
+    "\x1c" => '\u001C',
+    "\x1d" => '\u001D',
+    "\x1e" => '\u001E',
+    "\x1f" => '\u001F',
+    '"'   =>  '\"',
+    '\\'  =>  '\\\\',
+    '/'   =>  '/',
+  } # :nodoc:
+
+  if defined?(::Encoding)
+    # Funky way to define constant, but if parsed in 1.8 it generates an 'invalid regular expression' error otherwise
+    eval %(ESCAPE_RE = %r([\u{80}-\u{10ffff}]))
+  else
+    ESCAPE_RE = %r(
+                    [\xc2-\xdf][\x80-\xbf]    |
+                    [\xe0-\xef][\x80-\xbf]{2} |
+                    [\xf0-\xf4][\x80-\xbf]{3}
+                  )nx
+  end
+  
+  # Convert a UTF8 encoded Ruby string _string_ to an escaped string, encoded with
+  # UTF16 big endian characters as \U????, and return it.
+  #
+  # \\:: Backslash
+  # \':: Single quote
+  # \":: Double quot
+  # \n:: ASCII Linefeed
+  # \r:: ASCII Carriage Return
+  # \t:: ASCCII Horizontal Tab
+  # \uhhhh:: character in BMP with Unicode value U+hhhh
+  # \U00hhhhhh:: character in plane 1-16 with Unicode value U+hhhhhh
+  def rdf_escape
+    string = self + '' # XXX workaround: avoid buffer sharing
+    string.gsub!(/["\\\/\x0-\x1f]/) { RDF_MAP[$&] }
+    if defined?(::Encoding)
+      string.force_encoding(Encoding::UTF_8)
+      string.gsub!(ESCAPE_RE) { |c|
+                      s = c.dump.sub(/\"\\u\{(.+)\}\"/, '\1').upcase
+                      (s.length <= 4 ? "\\u0000"[0,6-s.length] : "\\U00000000"[0,10-s.length]) + s
+                    }
+      string.force_encoding(Encoding::ASCII_8BIT)
+    else
+      string.gsub!(ESCAPE_RE) { |c|
+                      s = Iconv.new('utf-16be', 'utf-8').iconv(c).unpack('H*').first.upcase
+                      "\\u" + s
+                    }
+    end
+    string
+  end
+  
+  # Unescape characters in strings.
+  RDF_UNESCAPE_MAP = Hash.new { |h, k| h[k] = k.chr }
+  RDF_UNESCAPE_MAP.update({
+    ?"  => '"',
+    ?\\ => '\\',
+    ?/  => '/',
+    ?b  => "\b",
+    ?f  => "\f",
+    ?n  => "\n",
+    ?r  => "\r",
+    ?t  => "\t",
+    ?u  => nil, 
+  })
+
+  if defined?(::Encoding)
+    UNESCAPE_RE = %r(
+      (?:\\[\\bfnrt"/])   # Escaped control characters, " and /
+      |(?:\\U00\h{6})     # 6 byte escaped Unicode
+      |(?:\\u\h{4})       # 4 byte escaped Unicode
+    )x
+  else
+    UNESCAPE_RE = %r((?:\\[\\bfnrt"/]|(?:\\u(?:[A-Fa-f\d]{4}))+|\\[\x20-\xff]))n
+  end
+  
+  # Reverse operation of escape
+  # From JSON parser
+  def rdf_unescape
+    return '' if self.empty?
+    string = self.gsub(UNESCAPE_RE) do |c|
+      case c[1,1]
+      when 'U'
+        raise RdfException, "Long Unicode escapes no supported in Ruby 1.8" unless defined?(::Encoding)
+        eval(c.sub(/\\U00(\h+)/, '"\u{\1}"'))
+      when 'u'
+        bytes = [c[2, 2].to_i(16), c[4, 2].to_i(16)]
+        Iconv.new('utf-8', 'utf-16').iconv(bytes.pack("C*"))
+      else
+        RDF_UNESCAPE_MAP[c[1]]
+      end
+    end
+    string.force_encoding(Encoding::UTF_8) if defined?(::Encoding)
+    string
+  rescue Iconv::Failure => e
+    raise RdfException, "Caught #{e.class}: #{e}"
+  end
+end unless String.method_defined?(:rdf_escape)

data/lib/rdf/n3/patches/rdf_escape.rb

@@ -0,0 +1,131 @@
+# coding: utf-8
+require 'iconv'
+
+class String
+  #private
+  # "Borrowed" from JSON utf8_to_json
+  RDF_MAP = {
+    "\x0" => '\u0000',
+    "\x1" => '\u0001',
+    "\x2" => '\u0002',
+    "\x3" => '\u0003',
+    "\x4" => '\u0004',
+    "\x5" => '\u0005',
+    "\x6" => '\u0006',
+    "\x7" => '\u0007',
+    "\b"  =>  '\b',
+    "\t"  =>  '\t',
+    "\n"  =>  '\n',
+    "\xb" => '\u000B',
+    "\f"  =>  '\f',
+    "\r"  =>  '\r',
+    "\xe" => '\u000E',
+    "\xf" => '\u000F',
+    "\x10" => '\u0010',
+    "\x11" => '\u0011',
+    "\x12" => '\u0012',
+    "\x13" => '\u0013',
+    "\x14" => '\u0014',
+    "\x15" => '\u0015',
+    "\x16" => '\u0016',
+    "\x17" => '\u0017',
+    "\x18" => '\u0018',
+    "\x19" => '\u0019',
+    "\x1a" => '\u001A',
+    "\x1b" => '\u001B',
+    "\x1c" => '\u001C',
+    "\x1d" => '\u001D',
+    "\x1e" => '\u001E',
+    "\x1f" => '\u001F',
+    '"'   =>  '\"',
+    '\\'  =>  '\\\\',
+    '/'   =>  '/',
+  } # :nodoc:
+
+  if defined?(::Encoding)
+    # Funky way to define constant, but if parsed in 1.8 it generates an 'invalid regular expression' error otherwise
+    eval %(ESCAPE_RE = %r([\u{80}-\u{10ffff}]))
+  else
+    ESCAPE_RE = %r(
+                    [\xc2-\xdf][\x80-\xbf]    |
+                    [\xe0-\xef][\x80-\xbf]{2} |
+                    [\xf0-\xf4][\x80-\xbf]{3}
+                  )nx
+  end
+  
+  # Convert a UTF8 encoded Ruby string _string_ to an escaped string, encoded with
+  # UTF16 big endian characters as \U????, and return it.
+  #
+  # \\:: Backslash
+  # \':: Single quote
+  # \":: Double quot
+  # \n:: ASCII Linefeed
+  # \r:: ASCII Carriage Return
+  # \t:: ASCCII Horizontal Tab
+  # \uhhhh:: character in BMP with Unicode value U+hhhh
+  # \U00hhhhhh:: character in plane 1-16 with Unicode value U+hhhhhh
+  def rdf_escape
+    string = self + '' # XXX workaround: avoid buffer sharing
+    string.gsub!(/["\\\/\x0-\x1f]/) { RDF_MAP[$&] }
+    if defined?(::Encoding)
+      string.force_encoding(Encoding::UTF_8)
+      string.gsub!(ESCAPE_RE) { |c|
+                      s = c.dump.sub(/\"\\u\{(.+)\}\"/, '\1').upcase
+                      (s.length <= 4 ? "\\u0000"[0,6-s.length] : "\\U00000000"[0,10-s.length]) + s
+                    }
+      string.force_encoding(Encoding::ASCII_8BIT)
+    else
+      string.gsub!(ESCAPE_RE) { |c|
+                      s = Iconv.new('utf-16be', 'utf-8').iconv(c).unpack('H*').first.upcase
+                      "\\u" + s
+                    }
+    end
+    string
+  end
+  
+  # Unescape characters in strings.
+  RDF_UNESCAPE_MAP = Hash.new { |h, k| h[k] = k.chr }
+  RDF_UNESCAPE_MAP.update({
+    ?"  => '"',
+    ?\\ => '\\',
+    ?/  => '/',
+    ?b  => "\b",
+    ?f  => "\f",
+    ?n  => "\n",
+    ?r  => "\r",
+    ?t  => "\t",
+    ?u  => nil, 
+  })
+
+  if defined?(::Encoding)
+    UNESCAPE_RE = %r(
+      (?:\\[\\bfnrt"/])   # Escaped control characters, " and /
+      |(?:\\U00\h{6})     # 6 byte escaped Unicode
+      |(?:\\u\h{4})       # 4 byte escaped Unicode
+    )x
+  else
+    UNESCAPE_RE = %r((?:\\[\\bfnrt"/]|(?:\\u(?:[A-Fa-f\d]{4}))+|\\[\x20-\xff]))n
+  end
+  
+  # Reverse operation of escape
+  # From JSON parser
+  def rdf_unescape
+    return '' if self.empty?
+    string = self.gsub(UNESCAPE_RE) do |c|
+      case c[1,1]
+      when 'U'
+        raise RdfException, "Long Unicode escapes no supported in Ruby 1.8" unless defined?(::Encoding)
+        eval(c.sub(/\\U00(\h+)/, '"\u{\1}"'))
+      when 'u'
+        bytes = [c[2, 2].to_i(16), c[4, 2].to_i(16)]
+        Iconv.new('utf-8', 'utf-16').iconv(bytes.pack("C*"))
+      else
+        RDF_UNESCAPE_MAP[c[1]]
+      end
+    end
+    string.force_encoding(Encoding::UTF_8) if defined?(::Encoding)
+    string
+  rescue Iconv::Failure => e
+    raise RdfException, "Caught #{e.class}: #{e}"
+  end
+end