rdf-sesame 0.1.0 → 0.2.0

data/README

@@ -1,32 +1,59 @@
-RDF::Sesame: Sesame 2.0 Adapter for RDF.rb
-==========================================
+Sesame 2.0 Adapter for RDF.rb
+=============================
 
-This is an [RDF.rb](http://rdf.rubyforge.org/) plugin that adds support for
-Sesame 2.0-compatible RDF repositories accessed using Sesame's
-[HTTP API](http://www.openrdf.org/doc/sesame2/system/ch08.html).
+This is an [RDF.rb][] plugin that adds support for [Sesame 2.0][]-compatible
+RDF repositories accessed using Sesame's [HTTP API][Sesame API].
 
 * <http://github.com/bendiken/rdf-sesame>
 
-### About Sesame
-
-* <http://www.openrdf.org/>
-
 Documentation
 -------------
 
 * {RDF::Sesame}
+  * {RDF::Sesame::Connection}
+  * {RDF::Sesame::Repository}
+  * {RDF::Sesame::Server}
+
+This adapter implements the [`RDF::Repository`][RDF::Repository] interface;
+refer to the relevant RDF.rb API documentation for further usage instructions.
+
+Limitations
+-----------
+
+* This adapter does not contain any SPARQL support. To use a Sesame endpoint
+  with SPARQL, see the [`SPARQL::Client`](http://sparql.rubyforge.org/client/)
+  gem.
+* This adapter is not yet optimized for RDF.rb 0.2.x's bulk-operation APIs,
+  meaning that statement insertions and deletions are currently performed
+  one by one; this may affect the performance of loading large datasets into
+  Sesame. This will be addressed in an upcoming version.
+* This adapter is not yet optimized for RDF.rb 0.2.x's enhanced query APIs;
+  this may adversely affect triple pattern query performance. This
+  will be addressed in an upcoming version.
+
+Caveats
+-------
+
+* Sesame rewrites blank node identifiers on inserted statements. For
+  example, if you supply a `_:foobar` identifier, it becomes something like
+  `_:node156oo6equx12769` as soon as you insert it into a Sesame repository. 
+  This means that you can't construct and insert a statement containing a
+  blank node term and then expect to successfully be able check for its
+  existence using the `Repository#has_statement?` method. This is also the
+  reason that 7 specs for `RDF::Repository` currently fail with this
+  adapter.
 
 Dependencies
 ------------
 
-* [RDF.rb](http://gemcutter.org/gems/rdf) (>= 0.0.9)
-* [JSON](http://gemcutter.org/gems/json_pure) (>= 1.2.0)
+* [RDF.rb](http://rubygems.org/gems/rdf) (>= 0.2.2)
+* [JSON](http://rubygems.org/gems/json_pure) (>= 1.4.3)
 
 Installation
 ------------
 
-The recommended installation method is via RubyGems. To install the latest
-official release from Gemcutter, do:
+The recommended installation method is via [RubyGems](http://rubygems.org/).
+To install the latest official release of the `RDF::Sesame` gem, do:
 
     % [sudo] gem install rdf-sesame
 
@@ -52,3 +79,8 @@ License
 
 `RDF::Sesame` is free and unencumbered public domain software. For more
 information, see <http://unlicense.org/> or the accompanying UNLICENSE file.
+
+[RDF.rb]:          http://rdf.rubyforge.org/
+[RDF::Repository]: http://rdf.rubyforge.org/RDF/Repository.html
+[Sesame 2.0]:      http://www.openrdf.org/
+[Sesame API]:      http://www.openrdf.org/doc/sesame2/system/ch08.html

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/rdf/sesame.rb

@@ -4,27 +4,6 @@ module RDF
   ##
   # **`RDF::Sesame`** is a Sesame 2.0 adapter for RDF.rb.
   #
-  # Dependencies
-  # ------------
-  #
-  # * [RDF.rb](http://gemcutter.org/gems/rdf) (>= 0.0.9)
-  # * [JSON](http://gemcutter.org/gems/json_pure) (>= 1.2.0)
-  #
-  # Installation
-  # ------------
-  #
-  # The recommended installation method is via RubyGems. To install the latest
-  # official release from Gemcutter, do:
-  #
-  #     % [sudo] gem install rdf-sesame
-  #
-  # Documentation
-  # -------------
-  #
-  # * {RDF::Sesame::Connection}
-  # * {RDF::Sesame::Repository}
-  # * {RDF::Sesame::Server}
-  #
   # @example Requiring the `RDF::Sesame` module
   #   require 'rdf/sesame'
   #

data/lib/rdf/sesame/connection.rb

@@ -21,17 +21,19 @@ module RDF::Sesame
   # call {#close} explicitly.
   #
   # @example Opening a connection to a Sesame server (1)
-  #   url  = RDF::URI.new("http://localhost:8080/openrdf-sesame")
+  #   url  = RDF::URI("http://localhost:8080/openrdf-sesame")
   #   conn = RDF::Sesame::Connection.open(url)
   #   ...
   #   conn.close
   #
   # @example Opening a connection to a Sesame server (2)
+  #   url = RDF::URI("http://localhost:8080/openrdf-sesame")
   #   RDF::Sesame::Connection.open(url) do |conn|
   #     ...
   #   end
   #
   # @example Performing an HTTP GET on a Sesame server
+  #   url = RDF::URI("http://localhost:8080/openrdf-sesame")
   #   RDF::Sesame::Connection.open(url) do |conn|
   #     conn.get("/openrdf-sesame/protocol") do |response|
   #       version = response.body.to_i
@@ -332,7 +334,7 @@ module RDF::Sesame
     # @yieldparam [Net::HTTPResponse] response
     # @return [Net::HTTPResponse]
     def put(path, headers = {}, &block)
-      # TODO
+      raise NotImplementedError, "#{self.class}#put" # TODO
     end
 
     ##
@@ -353,5 +355,5 @@ module RDF::Sesame
         end
       end
     end
-  end
-end
+  end # class Connection
+end # module RDF::Sesame

data/lib/rdf/sesame/repository.rb

@@ -18,10 +18,11 @@ module RDF::Sesame
   #   repository = server.repository(:SYSTEM)
   #
   # @see RDF::Sesame
+  # @see http://rdf.rubyforge.org/RDF/Repository.html
   # @see http://www.openrdf.org/doc/sesame2/system/ch08.html
   class Repository < RDF::Repository
     # @return [RDF::URI]
-    attr_reader :url
+    attr_reader  :url
     alias_method :uri, :url
 
     # @return [String]
@@ -67,8 +68,8 @@ module RDF::Sesame
           @options = {}
 
         when Hash
-          raise ArgumentError.new("missing options[:server]") unless url_or_options.has_key?(:server)
-          raise ArgumentError.new("missing options[:id]")     unless url_or_options.has_key?(:id)
+          raise ArgumentError, "missing options[:server]" unless url_or_options.has_key?(:server)
+          raise ArgumentError, "missing options[:id]"     unless url_or_options.has_key?(:id)
           @options = url_or_options.dup
           @server  = @options.delete(:server)
           @id      = @options.delete(:id)
@@ -76,7 +77,7 @@ module RDF::Sesame
           @title   = @options.delete(:title)
 
         else
-          raise ArgumentError.new("wrong argument type #{url_or_options.class} (expected String, RDF::URI or Hash)")
+          raise ArgumentError, "expected String, RDF::URI or Hash, but got #{url_or_options.inspect}"
       end
 
       if block_given?
@@ -100,12 +101,13 @@ module RDF::Sesame
           when RDF::Statement
             writer = RDF::NTriples::Writer.new
             query  = {
-              :subj => writer.format_value(query.subject),
-              :pred => writer.format_value(query.predicate),
-              :obj  => writer.format_value(query.object),
+              :subj    => writer.format_value(query.subject),
+              :pred    => writer.format_value(query.predicate),
+              :obj     => writer.format_value(query.object),
+              :context => query.has_context? ? writer.format_value(query.context) : 'null',
             }
             url.query_values = query
-          when Hash then query
+          when Hash
             url.query_values = query unless query.empty?
         end
       end
@@ -115,80 +117,135 @@ module RDF::Sesame
     alias_method :uri, :url
 
     ##
-    # Returns `true` to indicate that this repository is durable.
-    #
-    # @return [Boolean]
+    # @private
+    # @see RDF::Repository#supports?
+    def supports?(feature)
+      case feature.to_sym
+        when :context then true # statement contexts / named graphs
+        else super
+      end
+    end
+
+    ##
+    # @private
+    # @see RDF::Durable#durable?
     def durable?
-      true # FIXME
+      true # TODO: would need to query the SYSTEM repository for this information
     end
 
     ##
-    # Returns `true` if this repository contains no RDF statements.
-    #
-    # @return [Boolean]
+    # @private
+    # @see RDF::Countable#empty?
     def empty?
       count.zero?
     end
 
     ##
-    # Returns the number of RDF statements in this repository.
-    #
-    # @return [Integer] 
-    # @see    http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e569
+    # @private
+    # @see RDF::Countable#count
+    # @see http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e569
     def count
       server.get(url(:size)) do |response|
         case response
           when Net::HTTPSuccess
             size = response.body
             size.to_i rescue 0
-          else 0
+          else -1 # FIXME: raise error
         end
       end
     end
 
     ##
-    # Returns `true` if this repository contains the given RDF statement.
-    #
-    # @param  [RDF::Statement] statement
-    # @return [Boolean]
-    # @see    http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
+    # @private
+    # @see RDF::Enumerable#has_triple?
+    def has_triple?(triple)
+      has_statement?(RDF::Statement.from(triple))
+    end
+
+    ##
+    # @private
+    # @see RDF::Enumerable#has_quad?
+    def has_quad?(quad)
+      has_statement?(RDF::Statement.new(quad[0], quad[1], quad[2], :context => quad[3]))
+    end
+
+    ##
+    # @private
+    # @see RDF::Enumerable#has_statement?
+    # @see http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
     def has_statement?(statement)
       server.get(url(:statements, statement), 'Accept' => 'text/plain') do |response|
         case response
           when Net::HTTPSuccess
-            reader = RDF::NTriples::Reader.new(response.body)
-            reader.include?(statement)
+            !response.body.empty?
           else false
         end
       end
     end
 
     ##
-    # Enumerates each RDF statement in this repository.
-    #
-    # @yield  [statement]
-    # @yieldparam [RDF::Statement] statement
-    # @return [Enumerator]
-    # @see    http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
-    def each(&block)
-      server.get(url(:statements), 'Accept' => 'text/plain') do |response|
+    # @private
+    # @see RDF::Enumerable#each_statement
+    # @see http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
+    def each_statement(&block)
+      return enum_statement unless block_given?
+
+      [nil, *enum_context].uniq.each do |context|
+        ctxt = context ? RDF::NTriples.serialize(context) : 'null'
+        server.get(url(:statements, :context => ctxt), 'Accept' => 'text/plain') do |response|
+          case response
+            when Net::HTTPSuccess
+              reader = RDF::NTriples::Reader.new(response.body)
+              reader.each_statement do |statement|
+                statement.context = context
+                block.call(statement)
+              end
+          end
+        end
+      end
+    end
+
+    alias_method :each, :each_statement
+
+    ##
+    # @private
+    # @see RDF::Enumerable#each_context
+    def each_context(&block)
+      return enum_context unless block_given?
+
+      require 'json' unless defined?(::JSON)
+      server.get(url(:contexts), Server::ACCEPT_JSON) do |response|
         case response
           when Net::HTTPSuccess
-            reader = RDF::NTriples::Reader.new(response.body)
-            reader.each_statement(&block)
+            json = ::JSON.parse(response.body)
+            json['results']['bindings'].map { |binding| binding['contextID'] }.each do |context_id|
+              context = case context_id['type'].to_s.to_sym
+                when :bnode then RDF::Node.new(context_id['value'])
+                when :uri   then RDF::URI.new(context_id['value'])
+              end
+              block.call(context) if context
+            end
         end
       end
     end
 
+  protected
+
     ##
-    # Inserts the given RDF statement into this repository.
-    #
-    # @param  [RDF::Statement] statement
-    # @return [Boolean]
-    # @see    http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
+    # @private
+    # @see RDF::Queryable#query
+    def query_pattern(pattern, &block)
+      super # TODO
+    end
+
+    ##
+    # @private
+    # @see RDF::Mutable#insert
+    # @see http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
     def insert_statement(statement)
-      data = RDF::NTriples::Writer.buffer { |writer| writer << statement } # FIXME for RDF.rb 0.1.0
-      server.post(url(:statements), data, 'Content-Type' => 'text/plain') do |response|
+      ctxt = statement.has_context? ? RDF::NTriples.serialize(statement.context) : 'null'
+      data = RDF::NTriples.serialize(statement)
+      server.post(url(:statements, :context => ctxt), data, 'Content-Type' => 'text/plain') do |response|
         case response
           when Net::HTTPSuccess then true
           else false
@@ -197,11 +254,9 @@ module RDF::Sesame
     end
 
     ##
-    # Deletes the given RDF statement from this repository.
-    #
-    # @param  [RDF::Statement] statement
-    # @return [Boolean]
-    # @see    http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
+    # @private
+    # @see RDF::Mutable#delete
+    # @see http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
     def delete_statement(statement)
       server.delete(url(:statements, statement)) do |response|
         case response
@@ -212,10 +267,9 @@ module RDF::Sesame
     end
 
     ##
-    # Deletes all RDF statements from this repository.
-    #
-    # @return [Boolean]
-    # @see    http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
+    # @private
+    # @see RDF::Mutable#clear
+    # @see http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e304
     def clear_statements
       server.delete(url(:statements)) do |response|
         case response
@@ -224,5 +278,5 @@ module RDF::Sesame
         end
       end
     end
-  end
-end
+  end # class Repository
+end # module RDF::Sesame

data/lib/rdf/sesame/server.rb

@@ -6,7 +6,7 @@ module RDF::Sesame
   # one or more readable and/or writable RDF {Repository repositories}.
   #
   # @example Connecting to a Sesame server
-  #   url    = RDF::URI.new("http://localhost:8080/openrdf-sesame")
+  #   url    = RDF::URI("http://localhost:8080/openrdf-sesame")
   #   server = RDF::Sesame::Server.new(url)
   #
   # @example Retrieving the server's protocol version
@@ -145,7 +145,7 @@ module RDF::Sesame
     #
     # @yield  [repository]
     # @yieldparam [Repository] repository
-    # @return [Enumerable]
+    # @return [Enumerator]
     # @see    #repository
     # @see    #repositories
     def each_repository(&block)
@@ -155,9 +155,9 @@ module RDF::Sesame
     alias_method :each, :each_repository
 
     ##
-    # Returns `true` if 
+    # Returns `true` if this server has a repository identified by `id`.
     #
-    # @param  [id] String
+    # @param  [String] id
     # @return [Boolean]
     def has_repository?(id)
       repositories.has_key?(id.to_s)
@@ -184,20 +184,20 @@ module RDF::Sesame
     # @see    #each_repository
     # @see    http://www.openrdf.org/doc/sesame2/system/ch08.html#d0e204
     def repositories
-      require 'json' unless defined?(JSON)
+      require 'json' unless defined?(::JSON)
 
       get(url(:repositories), ACCEPT_JSON) do |response|
         case response
           when Net::HTTPSuccess
-            json = JSON.parse(response.body)
+            json = ::JSON.parse(response.body)
             json['results']['bindings'].inject({}) do |repositories, binding|
               repository = Repository.new({
                 :server   => self,
                 :uri      => (uri   = RDF::URI.new(binding['uri']['value'])),
                 :id       => (id    = binding['id']['value']),
                 :title    => (title = binding['title']['value']),
-                :readable => binding['readable']['value'] == 'true',
-                :writable => binding['writable']['value'] == 'true',
+                :readable => binding['readable']['value'].to_s == 'true',
+                :writable => binding['writable']['value'].to_s == 'true',
               })
               repositories.merge({id => repository})
             end
@@ -223,5 +223,5 @@ module RDF::Sesame
         self.connection.delete(path, headers, &block)
       end
     end
-  end
-end
+  end # class Server
+end # module RDF::Sesame

data/lib/rdf/sesame/version.rb

@@ -1,19 +1,22 @@
-module RDF module Sesame
+module RDF; module Sesame
   module VERSION
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
     EXTRA = nil
 
-    STRING = [MAJOR, MINOR, TINY].join('.')
-    STRING << "-#{EXTRA}" if EXTRA
+    STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')
 
     ##
     # @return [String]
-    def self.to_s()   STRING end
+    def self.to_s() STRING end
 
     ##
     # @return [String]
     def self.to_str() STRING end
+
+    ##
+    # @return [Array(Integer, Integer, Integer)]
+    def self.to_a() [MAJOR, MINOR, TINY] end
   end
-end end
+end; end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdf-sesame
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Arto Bendiken
@@ -9,51 +14,81 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-02 00:00:00 +01:00
+date: 2010-07-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: json_pure
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 3
+        version: 1.4.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdf
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.2.9
-    version: 
+        segments: 
+        - 0
+        - 2
+        - 2
+        version: 0.2.2
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.5.2
-    version: 
+        segments: 
+        - 0
+        - 5
+        - 8
+        version: 0.5.8
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rdf
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.9
-    version: 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: json_pure
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: rdf-spec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.2.0
-    version: 
+        segments: 
+        - 0
+        - 2
+        - 2
+        version: 0.2.2
+  type: :development
+  version_requirements: *id005
 description: RDF.rb plugin providing a Sesame 2.0 storage adapter.
-email: arto.bendiken@gmail.com
+email: public-rdf-ruby@w3.org
 executables: []
 
 extensions: []
@@ -71,7 +106,7 @@ files:
 - lib/rdf/sesame/version.rb
 - lib/rdf/sesame.rb
 has_rdoc: false
-homepage: http://rdf.rubyforge.org/
+homepage: http://rdf.rubyforge.org/sesame/
 licenses: 
 - Public Domain
 post_install_message: 
@@ -83,18 +118,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.8.2
-  version: 
+      segments: 
+      - 1
+      - 8
+      - 1
+      version: 1.8.1
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: rdf
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Sesame 2.0 adapter for RDF.rb.