rdf 0.0.7 → 0.0.8

data/AUTHORS

@@ -1 +1,2 @@
 * Arto Bendiken <arto.bendiken@gmail.com>
+* Ben Lavender <blavender@gmail.com>

data/README

@@ -134,10 +134,12 @@ Resources
 * <http://gemcutter.org/gems/rdf>
 * <http://rubyforge.org/projects/rdf/>
 * <http://raa.ruby-lang.org/project/rdf/>
+* <http://www.ohloh.net/p/rdf>
 
-See also
+See Also
 --------
 
+* [DataMapper RDF.rb Adapter](http://dm-rdf.rubyforge.org/)
 * [RDFS.rb](http://rdfs.rubyforge.org/)
 * [RDFize](http://rdfize.rubyforge.org/)
 * [RDFbus](http://rdfbus.rubyforge.org/)
@@ -147,6 +149,7 @@ Author
 ------
 
 * [Arto Bendiken](mailto:arto.bendiken@gmail.com) - <http://ar.to/>
+* [Ben Lavender](mailto:blavender@gmail.com) - <http://bhuga.net/>
 
 License
 -------

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/etc/doap.nt

@@ -0,0 +1,24 @@
+<http://ar.to/#self> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://xmlns.com/foaf/0.1/Person> .
+<http://ar.to/#self> <http://xmlns.com/foaf/0.1/made> <http://gemcutter.org/gems/rdf> .
+<http://ar.to/#self> <http://xmlns.com/foaf/0.1/mbox> <mailto:arto.bendiken@gmail.com> .
+<http://ar.to/#self> <http://xmlns.com/foaf/0.1/name> "Arto Bendiken" .
+<http://bhuga.net/#ben> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://xmlns.com/foaf/0.1/Person> .
+<http://bhuga.net/#ben> <http://xmlns.com/foaf/0.1/mbox> <mailto:blavender@gmail.com> .
+<http://bhuga.net/#ben> <http://xmlns.com/foaf/0.1/name> "Ben Lavender" .
+<http://gemcutter.org/gems/rdf> <http://purl.org/dc/terms/creator> <http://ar.to/#self> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#blog> <http://ar.to/> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#bug-database> <http://github.com/bendiken/rdf/issues> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#created> "2007-10-23" .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#description> "RDF.rb is a pure-Ruby library for working with Resource Description Framework (RDF) data."@en .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#developer> <http://ar.to/#self> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#developer> <http://bhuga.net/#ben> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#documenter> <http://ar.to/#self> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#download-page> <http://rubyforge.org/projects/rdf/> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#homepage> <http://rdf.rubyforge.org/> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#license> <http://creativecommons.org/licenses/publicdomain/> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#maintainer> <http://ar.to/#self> .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#name> "RDF.rb" .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#platform> "Ruby" .
+<http://gemcutter.org/gems/rdf> <http://usefulinc.com/ns/doap#shortdesc> "A Ruby library for working with Resource Description Framework (RDF) data."@en .
+<http://gemcutter.org/gems/rdf> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://usefulinc.com/ns/doap#Project> .
+<http://gemcutter.org/gems/rdf> <http://xmlns.com/foaf/0.1/maker> <http://ar.to/#self> .

data/lib/rdf.rb

@@ -2,7 +2,12 @@ require 'rdf/version'
 
 module RDF
   # RDF mixins
-  autoload :Enumerable, 'rdf/enumerable'
+  autoload :Durable,    'rdf/mixin/durable'
+  autoload :Enumerable, 'rdf/mixin/enumerable'
+  autoload :Mutable,    'rdf/mixin/mutable'
+  autoload :Queryable,  'rdf/mixin/queryable'
+  autoload :Readable,   'rdf/mixin/readable'
+  autoload :Writable,   'rdf/mixin/writable'
 
   # RDF objects
   autoload :Graph,      'rdf/model/graph'

data/lib/rdf/mixin/durable.rb

@@ -0,0 +1,29 @@
+module RDF
+  ##
+  module Durable
+    ##
+    # Returns `true` if `self` is durable.
+    #
+    # @return [Boolean]
+    # @see    #nondurable?
+    def durable?
+      true
+    end
+
+    alias_method :persistent?, :durable?
+
+    ##
+    # Returns `true` if `self` is nondurable.
+    #
+    # @return [Boolean]
+    # @see    #durable?
+    def nondurable?
+      !durable?
+    end
+
+    alias_method :ephemeral?,     :nondurable?
+    alias_method :nonpersistent?, :nondurable?
+    alias_method :transient?,     :nondurable?
+    alias_method :volatile?,      :nondurable?
+  end
+end

data/lib/rdf/mixin/mutable.rb

@@ -0,0 +1,193 @@
+module RDF
+  ##
+  # Classes that include this module must implement the methods
+  # {#insert_statement}, {#delete_statement} and {#each_statement}.
+  #
+  # @see RDF::Graph
+  # @see RDF::Repository
+  module Mutable
+    include RDF::Readable
+    include RDF::Writable
+
+    ##
+    # Returns `true` if `self` is mutable.
+    #
+    # @return [Boolean]
+    # @see    #immutable?
+    def mutable?
+      writable?
+    end
+
+    ##
+    # Returns `true` if `self` is immutable.
+    #
+    # @return [Boolean]
+    # @see    #mutable?
+    def immutable?
+      !mutable?
+    end
+
+    ##
+    # Loads RDF statements from the given file into `self`.
+    #
+    # @param  [String, #to_s]          filename
+    # @param  [Hash{Symbol => Object}] options
+    # @return [Integer] the number of inserted RDF statements
+    def load(filename, options = {})
+      raise TypeError.new("#{self} is immutable") if immutable?
+
+      count = 0
+      Reader.open(filename, options) do |reader|
+        reader.each_statement do |statement|
+          insert_statement(statement)
+          count += 1
+        end
+      end
+      count
+    end
+
+    alias_method :load!, :load
+
+    ##
+    # Inserts an RDF statement into `self`.
+    #
+    # @param  [RDF::Statement, Array<RDF::Value>, #to_a] statement
+    # @return [Mutable]
+    def <<(statement)
+      raise TypeError.new("#{self} is immutable") if immutable?
+
+      insert_statement(create_statement(statement))
+      self
+    end
+
+    ##
+    # Inserts RDF statements into `self`.
+    #
+    # @param  [Enumerable<RDF::Statement>] statements
+    # @raise  [TypeError] if `self` is immutable
+    # @return [Mutable]
+    def insert(*statements)
+      raise TypeError.new("#{self} is immutable") if immutable?
+
+      statements.each do |statement|
+        if (statement = create_statement(statement)).valid?
+          insert_statement(statement)
+        else
+          raise ArgumentError.new # FIXME
+        end
+      end
+      self
+    end
+
+    alias_method :insert!, :insert
+
+    ##
+    # Deletes RDF statements from `self`.
+    #
+    # @param  [Enumerable<Statement>] statements
+    # @raise  [TypeError] if `self` is immutable
+    # @return [Mutable]
+    def delete(*statements)
+      raise TypeError.new("#{self} is immutable") if immutable?
+
+      statements.each do |statement|
+        if (statement = create_statement(statement)).valid?
+          delete_statement(statement)
+        else
+          query(statement) do |statement|
+            delete_statement(statement)
+          end
+        end
+      end
+      self
+    end
+
+    alias_method :delete!, :delete
+
+    ##
+    # Updates RDF statements in `self`.
+    #
+    # `#update([subject, predicate, object])` is equivalent to
+    # `#delete([subject, predicate, nil])` followed by
+    # `#insert([subject, predicate, object])` unless `object` is `nil`.
+    #
+    # @param  [Enumerable<RDF::Statement>] statements
+    # @raise  [TypeError] if `self` is immutable
+    # @return [Mutable]
+    def update(*statements)
+      raise TypeError.new("#{self} is immutable") if immutable?
+
+      statements.each do |statement|
+        if (statement = create_statement(statement))
+          delete([statement.subject, statement.predicate, nil])
+          insert(statement) if statement.has_object?
+        end
+      end
+    end
+
+    alias_method :update!, :update
+
+    ##
+    # Deletes all RDF statements from `self`.
+    #
+    # @return [Mutable]
+    def clear
+      raise TypeError.new("#{self} is immutable") if immutable?
+
+      if respond_to?(:clear_statements)
+        clear_statements
+      else
+        each_statement do |statement|
+          delete_statement(statement)
+        end
+      end
+      self
+    end
+
+    alias_method :clear!, :clear
+
+    ##
+    # Transforms various input into an `RDF::Statement` instance.
+    #
+    # @param  [RDF::Statement, Hash, Array, #to_a] statement
+    # @return [RDF::Statement]
+    def create_statement(statement)
+      case statement
+        when Statement then statement
+        when Hash      then Statement.new(statement)
+        when Array     then Statement.new(*statement)
+        else raise ArgumentError.new # FIXME
+      end
+    end
+
+    ##
+    # Inserts an RDF statement into the underlying storage.
+    #
+    # Subclasses of {RDF::Repository} must implement this method (except in
+    # case they are immutable).
+    #
+    # @param  [RDF::Statement] statement
+    # @return [void]
+    # @abstract
+    def insert_statement(statement)
+      raise NotImplementedError
+    end
+
+    ##
+    # Deletes an RDF statement from the underlying storage.
+    #
+    # Subclasses of {RDF::Repository} must implement this method (except in
+    # case they are immutable).
+    #
+    # @param  [RDF::Statement] statement
+    # @return [void]
+    # @abstract
+    def delete_statement(statement)
+      raise NotImplementedError
+    end
+
+    protected :create_statement
+    protected :insert_statement
+    protected :delete_statement
+  end
+end

data/lib/rdf/mixin/queryable.rb

@@ -0,0 +1,39 @@
+module RDF
+  ##
+  # An RDF query mixin.
+  #
+  # Classes that include this module must implement an `#each` method that
+  # yields {RDF::Statement RDF statements}.
+  #
+  # @see RDF::Graph
+  # @see RDF::Repository
+  module Queryable
+    include ::Enumerable
+
+    ##
+    # Queries `self` for RDF statements matching the given pattern.
+    #
+    # @param  [Query, Statement, Array(Value)] pattern
+    # @yield  [statement]
+    # @yieldparam [Statement]
+    # @return [Array<Statement>, nil]
+    def query(pattern, &block)
+      raise TypeError.new("#{self} is not readable") if respond_to?(:readable) && !readable?
+
+      case pattern
+        when Query
+          pattern.execute(self, &block)
+        when Array
+          query(Statement.new(*pattern), &block)
+        when Statement
+          if block_given?
+            find_all { |statement| pattern === statement }.each(&block)
+          else
+            find_all { |statement| pattern === statement }
+          end
+        else
+          raise ArgumentError.new("expected RDF::Query or RDF::Pattern, got #{pattern.inspect}")
+      end
+    end
+  end
+end

data/lib/rdf/mixin/readable.rb

@@ -0,0 +1,13 @@
+module RDF
+  ##
+  module Readable
+    ##
+    # Returns `true` if `self` is readable.
+    #
+    # @return [Boolean]
+    # @see    RDF::Writable#writable?
+    def readable?
+      true
+    end
+  end
+end

data/lib/rdf/mixin/writable.rb

@@ -0,0 +1,13 @@
+module RDF
+  ##
+  module Writable
+    ##
+    # Returns `true` if `self` is writable.
+    #
+    # @return [Boolean]
+    # @see    RDF::Readable#readable?
+    def writable?
+      true
+    end
+  end
+end

data/lib/rdf/model/graph.rb

@@ -3,6 +3,7 @@ module RDF
   # An RDF graph.
   class Graph < Resource
     include RDF::Enumerable
+    include RDF::Queryable
 
     # @return [URI]
     attr_accessor :uri
@@ -16,6 +17,7 @@ module RDF
     # @yieldparam [Graph]
     def initialize(uri = nil, options = {}, &block)
       @uri, @options = uri, options
+      @data = []
 
       if block_given?
         case block.arity
@@ -55,7 +57,15 @@ module RDF
 
     ##
     # @return [Resource]
-    def context() uri end
+    def context
+      uri
+    end
+
+    ##
+    # @return [Array<Resource>]
+    def contexts
+      named? ? [uri] : []
+    end
 
     ##
     # @param  [Statement, Array(Value)]

data/lib/rdf/repository.rb

@@ -42,15 +42,24 @@ module RDF
   #
   class Repository
     include RDF::Enumerable
+    include RDF::Durable
+    include RDF::Mutable
+    include RDF::Queryable
 
+    ##
+    # Returns the {URI} of this repository.
+    #
     # @return [URI]
     attr_reader :uri
 
+    ##
+    # Returns the title of this repository.
+    #
     # @return [String]
     attr_reader :title
 
     ##
-    # Loads an N-Triples file as a transient in-memory repository.
+    # Loads an RDF file as a transient in-memory repository.
     #
     # @param  [String] filename
     # @yield  [repository]
@@ -70,12 +79,23 @@ module RDF
     end
 
     ##
+    # Initializes this repository instance.
+    #
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [URI, #to_s]    :uri (nil)
+    # @option options [String, #to_s] :title (nil)
     # @yield  [repository]
-    # @yieldparam [Repository]
+    # @yieldparam [Repository] repository
     def initialize(options = {}, &block)
-      @uri   = options.delete(:uri)
-      @title = options.delete(:title)
-      @data, @options = [], options
+      @uri     = options.delete(:uri)
+      @title   = options.delete(:title)
+      @options = options
+
+      # Provide a default in-memory implementation:
+      if self.class.equal?(RDF::Repository)
+        @data = []
+        send(:extend, Implementation)
+      end
 
       if block_given?
         case block.arity
@@ -86,251 +106,96 @@ module RDF
     end
 
     ##
-    # Returns `true` if the repository is transient.
-    #
-    # @return [Boolean]
-    # @see    #persistent?
-    def transient?
-      !persistent?
-    end
-
-    ##
-    # Returns `true` if the repository is persistent.
-    #
-    # @return [Boolean]
-    # @see    #transient?
-    # @abstract
-    def persistent?
-      false # NOTE: override this in any persistent subclasses
-    end
-
-    ##
-    # Returns `true` if the repository is readable.
-    #
-    # @return [Boolean]
-    def readable?
-      true
-    end
-
-    ##
-    # Returns `true` if the repository is mutable.
-    #
-    # @return [Boolean]
-    # @see    #immutable?
-    # @see    #immutable!
-    def mutable?
-      !immutable?
-    end
-
-    alias_method :writable?, :mutable?
-
-    ##
-    # Returns `true` if the repository is immutable.
-    #
-    # @return [Boolean]
-    # @see    #mutable?
-    # @see    #immutable!
-    def immutable?
-      @options[:mutable] == false
-    end
-
-    ##
-    # Makes the repository contents immutable.
+    # Outputs a developer-friendly representation of this repository to
+    # `stderr`.
     #
     # @return [void]
-    # @see    #mutable?
-    # @see    #immutable?
-    def immutable!
-      @options[:mutable] = true
-    end
-
-    ##
-    # Returns `true` if the repository contains no RDF statements.
-    #
-    # @return [Boolean]
-    def empty?
-      @data.empty?
-    end
-
-    ##
-    # Returns the number of RDF statements in the repository.
-    #
-    # @return [Integer]
-    def size
-      @data.size
-    end
-
-    alias_method :count, :size
-
-    ##
-    # Returns `true` if this repository contains the given RDF `statement`.
-    #
-    # @param  [Statement] statement
-    # @return [Boolean]
-    def has_statement?(statement)
-      @data.include?(statement)
-    end
-
-    alias_method :include?, :has_statement?
-
-    ##
-    # Enumerates each RDF statement in the repository.
-    #
-    # @yield  [statement]
-    # @yieldparam [Statement]
-    # @return [Enumerator]
-    def each(&block)
-      @data.each(&block)
+    def inspect!
+      each_statement { |statement| statement.inspect! }
+      nil
     end
 
     ##
-    # Queries the repository for RDF statements matching the given pattern.
-    #
-    # @param  [Query, Statement, Array(Value)] pattern
-    # @yield  [statement]
-    # @yieldparam [Statement]
-    # @return [Array<Statement>, nil]
-    def query(pattern, &block)
-      raise TypeError.new("repository is not readable") unless readable?
-      case pattern
-        when Query
-          pattern.execute(self, &block)
-        when Array
-          query(Statement.new(*pattern), &block)
-        when Statement
-          if block_given?
-            # TODO: yield any found statements
-            nil
-          else
-            find_all { |statement| pattern === statement }
-          end
+    # @see RDF::Repository
+    module Implementation
+      ##
+      # Returns `false` to indicate that this repository is nondurable.
+      #
+      # @return [Boolean]
+      # @see    RDF::Durable#durable?
+      def durable?
+        false
       end
-    end
 
-    ##
-    # Loads RDF statements from the given N-Triples file into the repository.
-    #
-    # @param  [String]  filename
-    # @return [Integer] the number of inserted RDF statements
-    def load(filename, options = {})
-      raise TypeError.new("repository is immutable") if immutable?
-      count = 0
-      Reader.open(filename, options) do |reader|
-        reader.each_statement do |statement|
-          insert_statement(statement)
-          count += 1
-        end
+      ##
+      # Enumerates each RDF statement in this repository.
+      #
+      # @yield  [statement]
+      # @yieldparam [Statement]
+      # @return [Enumerator]
+      # @see    RDF::Enumerable#each_statement
+      def each(&block)
+        @data.each(&block)
       end
-      count
-    end
 
-    ##
-    # Inserts an RDF statement into the repository.
-    #
-    # @param  [Statement, Array(Value), #to_a] statement
-    # @return [Repository]
-    def <<(statement)
-      raise TypeError.new("repository is immutable") if immutable?
-      case statement
-        when Statement then insert_statement(statement)
-        else insert_statement(Statement.new(*statement.to_a))
+      ##
+      # Returns `true` if this repository contains no RDF statements.
+      #
+      # @return [Boolean]
+      # @see    RDF::Enumerable#empty?
+      def empty?
+        @data.empty?
       end
-      self
-    end
 
-    ##
-    # Updates RDF statements in the repository.
-    #
-    # @param  [Array<Statement>] statements
-    # @raise  [TypeError] if the repository is immutable
-    # @return [Repository]
-    def update(*statements)
-      raise TypeError.new("repository is immutable") if immutable?
-      statements.each do |statement|
-        if (statement = create_statement(statement))
-          delete([statement.subject, statement.predicate, nil])
-          insert(statement) if statement.has_object?
-        end
-      end
-    end
-
-    ##
-    # Inserts RDF statements into the repository.
-    #
-    # @param  [Array<Statement>] statements
-    # @raise  [TypeError] if the repository is immutable
-    # @return [Repository]
-    def insert(*statements)
-      raise TypeError.new("repository is immutable") if immutable?
-      statements.each do |statement|
-        if (statement = create_statement(statement)).valid?
-          insert_statement(statement)
-        else
-          raise ArgumentError.new # FIXME
-        end
+      ##
+      # Returns the number of RDF statements in this repository.
+      #
+      # @return [Integer]
+      # @see    RDF::Enumerable#count
+      def count
+        @data.size
       end
-      self
-    end
 
-    ##
-    # Deletes RDF statements from the repository.
-    #
-    # @param  [Array<Statement>] statements
-    # @raise  [TypeError] if the repository is immutable
-    # @return [Repository]
-    def delete(*statements)
-      raise TypeError.new("repository is immutable") if immutable?
-      statements.each do |statement|
-        if (statement = create_statement(statement)).valid?
-          delete_statement(statement)
-        else
-          query(statement).each do |statement|
-            delete_statement(statement)
-          end
-        end
+      ##
+      # Returns `true` if this repository contains the given RDF statement.
+      #
+      # @param  [Statement] statement
+      # @return [Boolean]
+      # @see    RDF::Enumerable#has_statement?
+      def has_statement?(statement)
+        @data.include?(statement)
       end
-      self
-    end
-
-    ##
-    # Deletes all RDF statements from this repository.
-    #
-    # @return [Repository]
-    def clear
-      @data.clear
-      self
-    end
-
-    alias_method :clear!, :clear
-
-    ##
-    # Outputs a developer-friendly representation of this repository to
-    # `stderr`.
-    #
-    # @return [void]
-    def inspect!
-      each_statement { |statement| statement.inspect! }
-      nil
-    end
-
-    protected
 
+      ##
+      # Inserts an RDF statement into the underlying storage.
+      #
+      # @param  [RDF::Statement] statement
+      # @return [void]
       def insert_statement(statement)
         @data.push(statement) unless @data.include?(statement)
       end
 
+      ##
+      # Deletes an RDF statement from the underlying storage.
+      #
+      # @param  [RDF::Statement] statement
+      # @return [void]
       def delete_statement(statement)
         @data.delete(statement)
       end
 
-      def create_statement(statement)
-        case statement
-          when Statement then statement
-          when Hash      then Statement.new(statement)
-          when Array     then Statement.new(*statement)
-          else raise ArgumentError.new # FIXME
-        end
+      ##
+      # Deletes all RDF statements from this repository.
+      #
+      # @return [Repository]
+      # @see    RDF::Mutable#clear
+      def clear_statements
+        @data.clear
       end
 
-  end
-end
+      protected :insert_statement
+      protected :delete_statement
+      protected :clear_statements
+    end # module Implementation
+  end # class Repository
+end # module RDF