rdf-mongo 0.1.9.1 → 1.0.3

data/README.md

@@ -15,7 +15,26 @@ It should also be noted that prior to 1.0, there are no guarantees of backwards
 You'll need the 'mongo', 'rdf', 'rdf-spec', and 'rspec' libraries.  The easiest way to install these is via RubyGems.
 
     $ sudo gem install mongo rdf rdf-spec rspec rdf-mongo
-    
+
+## Implementation Notes
+
+RDF Statements are stored as individual documents within MONGO using the following BSON:
+
+    {
+      "s":  RDF::Value
+      "st": one of :u or :n
+      "p":  RDF::URI
+      "pt": must be :n
+      "o"   RDF::Value
+      "ot"  one of :u, :n, :l, :ll, or :lt
+      "ol"  Language symbol or RDF::URI
+      "c"   RDF::Value or false
+      "ct": one of :u, :n, :l, :ll, :lt or :default
+    }
+
+An alternative that may be examined at a later point would be to use a representation based on RDF/JSON,
+or JSON-LD. This would save documents based on a common subject with 
+one more more predicates having one or more types.
 
 ### Support
 
@@ -23,6 +42,7 @@ Please post questions or feedback to the [W3C-ruby-rdf mailing list][].
 
 ### Authors
  * [Pius Uzamere][] | <pius@alum.mit.edu> | <http://github.com/pius> | <http://pius.me>
+ * [Gregg Kellogg][] | <gregg@greggkellogg.net> | <http://github.com/gkellogg> | <http://greggkellogg.net>
 
 ### Thank you
 
@@ -34,3 +54,4 @@ MIT License
 
 [W3C-ruby-rdf mailing list]:        http://lists.w3.org/Archives/Public/public-rdf-ruby/
 [Pius Uzamere]: http://pius.me
+[Gregg Kellogg]: http://greggkellogg.net/me

data/VERSION

@@ -1 +1 @@
-0.1.9.1
+1.0.3

data/lib/rdf/mongo/version.rb

@@ -0,0 +1,20 @@
+module RDF::Mongo
+  module VERSION
+    VERSION_FILE = File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "..", "VERSION")
+    MAJOR, MINOR, TINY, EXTRA = File.read(VERSION_FILE).chomp.split(".")
+
+    STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')
+
+    ##
+    # @return [String]
+    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

data/lib/rdf/mongo.rb

@@ -2,26 +2,23 @@ require 'rdf'
 require 'enumerator'
 require 'mongo'
 
-module Mongo
-  class Cursor
-    def rdf_each(&block)
-      if block_given?
-        each {|statement| block.call(RDF::Statement.from_mongo(statement)) }
-      else
-        self
-      end
-    end
-  end
-end
-      
 module RDF
   class Statement
+    ##
+    # Creates a BSON representation of the statement.
+    # @return [Hash]
     def to_mongo
-      self.to_hash.merge({:context => self.context}).inject({}) { |hash, (place_in_statement, entity)| 
+      self.to_hash.inject({}) do |hash, (place_in_statement, entity)| 
         hash.merge(RDF::Mongo::Conversion.to_mongo(entity, place_in_statement)) 
-        }
+      end
     end
     
+    ##
+    # Create BSON for a statement representation. Note that if the statement has no context,
+    # a value of `false` will be used to indicate the default context
+    #
+    # @param [RDF::Statement] statement
+    # @return [Hash] Generated BSON representation of statement.
     def self.from_mongo(statement)
       RDF::Statement.new(
         :subject   => RDF::Mongo::Conversion.from_mongo(statement['s'], statement['st'], statement['sl']),
@@ -31,21 +28,46 @@ module RDF
     end
   end
   
-  module Mongo    
+  module Mongo
+    autoload :VERSION, "rdf/mongo/version"
+
     class Conversion
-      #TODO: Add support for other types of entities
-      
+      ##
+      # Translate an RDF::Value type to BSON key/value pairs.
+      #
+      # @param [RDF::Value, Symbol, false, nil] value
+      #   URI, BNode or Literal. May also be a Variable or Symbol to indicate
+      #   a pattern for a named context, or `false` to indicate the default context.
+      #   A value of `nil` indicates a pattern that matches any value.
+      # @param [:subject, :predicate, :object, :context] place_in_statement
+      #   Position within statement.
+      # @return [Hash] BSON representation of the statement
       def self.to_mongo(value, place_in_statement)
         case value
         when RDF::URI
           v, k = value.to_s, :u
         when RDF::Literal
-          v, k, ll = value.value, :l, value.language
+          if value.has_language?
+            v, k, ll = value.value, :ll, value.language.to_s
+          elsif value.has_datatype?
+            v, k, ll = value.value, :lt, value.datatype.to_s
+          else
+            v, k, ll = value.value, :l, nil
+          end
+        when RDF::Node
+          v, k = value.id.to_s, :n
+        when RDF::Query::Variable, Symbol
+          # Returns anything other than the default context
+          v, k = nil, {"$ne" => :default}
+        when false
+          # Used for the default context
+          v, k = false, :default
         when nil
           v, k = nil, nil
         else
           v, k = value.to_s, :u
         end
+        v = nil if v == ''
         
         case place_in_statement
         when :subject
@@ -57,49 +79,60 @@ module RDF
         when :context
           t, k1, lt = :ct, :c, :cl
         end
-        h = {k1 => (v == '' ? nil : v), t => (k == '' ? nil : k), lt => ll}
+        h = {k1 => v, t => k, lt => ll}
         h.delete_if {|k,v| h[k].nil?}
       end
 
-      def self.from_mongo(value, value_type = :u, lang = nil)
+      ##
+      # Translate an BSON positional reference to an RDF Value.
+      #
+      # @return [RDF::Value]
+      def self.from_mongo(value, value_type = :u, literal_extra = nil)
         case value_type
         when :u
-          RDF::URI.new(value)
+          RDF::URI.intern(value)
+        when :ll
+          RDF::Literal.new(value, :language => literal_extra.to_sym)
+        when :lt
+          RDF::Literal.new(value, :datatype => RDF::URI.intern(literal_extra))
         when :l
-          RDF::Literal.new(value, :language => lang)
+          RDF::Literal.new(value)
+        when :n
+          @nodes ||= {}
+          @nodes[value] ||= RDF::Node.new(value)
+        when :default
+          nil # The default context returns as nil, although it's queried as false.
         end
       end
     end
-    
-    
+
     class Repository < ::RDF::Repository
-      
-      def self.load(filenames, options = {:host => 'localhost', :port => 27017, :db => 'quadb'}, &block)
-        self.new(options) do |repository|
-          [filenames].flatten.each do |filename|
-            repository.load(filename, options)
-          end
+      # The Mongo database instance
+      # @!attribute [r] db
+      # @return [Mongo::DB]
+      attr_reader :db
 
-          if block_given?
-            case block.arity
-              when 1 then block.call(repository)
-              else repository.instance_eval(&block)
-            end
-          end
-        end
-      end
-      
-      def db
-        @db
-      end
+      # The collection used for storing quads
+      # @!attribute [r] coll
+      # @return [Mongo::Collection]
+      attr_reader :coll
       
-      def coll
-        @coll
-      end
-
-      def initialize(options = {:host => 'localhost', :port => 27017, :db => 'quadb'})
+      ##
+      # Initializes this repository instance.
+      #
+      # @param  [Hash{Symbol => Object}] options
+      # @option options [URI, #to_s]    :uri (nil)
+      # @option options [String, #to_s] :title (nil)
+      # @option options [String] :host
+      # @option options [Integer] :port
+      # @option options [String] :db
+      # @option options [String] :collection ('quads')
+      # @yield  [repository]
+      # @yieldparam [Repository] repository
+      def initialize(options = {}, &block)
+        options = {:host => 'localhost', :port => 27017, :db => 'quadb', :collection => 'quads'}.merge(options)
         @db = ::Mongo::Connection.new(options[:host], options[:port]).db(options[:db])
-        @coll = @db['quads']
+        @coll = @db[options[:collection]]
         @coll.create_index("s")
         @coll.create_index("p")
         @coll.create_index("o")
@@ -107,71 +140,104 @@ module RDF
         @coll.create_index([["s", ::Mongo::ASCENDING], ["p", ::Mongo::ASCENDING]])
         @coll.create_index([["s", ::Mongo::ASCENDING], ["o", ::Mongo::ASCENDING]])
         @coll.create_index([["p", ::Mongo::ASCENDING], ["o", ::Mongo::ASCENDING]])
-      end
- 
-      # @see RDF::Enumerable#each.
-      def each(&block)
-        if block_given?
-          statements = @coll.find()
-          statements.each {|statement| block.call(RDF::Statement.from_mongo(statement)) }
-        else
-          statements = @coll.find()
-          enumerator!.new(statements,:rdf_each)
-        end
+        super(options, &block)
       end
 
       # @see RDF::Mutable#insert_statement
+      def supports?(feature)
+        case feature.to_sym
+          when :context then true
+          else false
+        end
+      end
+      
       def insert_statement(statement)
-        @coll.update(statement.to_mongo, statement.to_mongo, :upsert => true)
+        st_mongo = statement.to_mongo
+        st_mongo[:ct] ||= :default # Indicate statement is in the default context
+        #puts "insert statement: #{st_mongo.inspect}"
+        @coll.update(st_mongo, st_mongo, :upsert => true)
       end
 
       # @see RDF::Mutable#delete_statement
       def delete_statement(statement)
-        @coll.remove(statement.to_mongo)
+        case statement.context
+        when nil
+          @coll.remove(statement.to_mongo.merge('ct'=>:default))
+        else
+          @coll.remove(statement.to_mongo)
+        end
       end
-    
+
+      ##
+      # @private
+      # @see RDF::Durable#durable?
+      def durable?; true; end
+
+      ##
+      # @private
+      # @see RDF::Countable#empty?
+      def empty?; @coll.count == 0; end
+
+      ##
+      # @private
+      # @see RDF::Countable#count
       def count
         @coll.count
       end
-    
-      def query(pattern, &block)
-        case pattern
-          when RDF::Statement
-            query(pattern.to_hash)
-          when Array
-            query(RDF::Statement.new(*pattern))
-          when Hash 
-            statements = query_hash(pattern)
-            the_statements = statements || []            
-            case block_given?
-              when true
-                the_statements.each {|s| block.call(RDF::Statement.from_mongo(s))}
-              else
-                def the_statements.each(&block)
-                  if block_given?
-                    super {|statement| block.call(RDF::Statement.from_mongo(statement)) }
-                  else
-                    enumerator!.new(the_statements,:rdf_each)
-                  end
-                end
-                
-                def the_statements.size
-                  count
-                end
-                s = the_statements
+
+      def clear_statements
+        @coll.remove
+      end
+
+      ##
+      # @private
+      # @see RDF::Enumerable#has_statement?
+      def has_statement?(statement)
+        !!@coll.find_one(statement.to_mongo)
+      end
+      ##
+      # @private
+      # @see RDF::Enumerable#each_statement
+      def each_statement(&block)
+        @nodes = {} # reset cache. FIXME this should probably be in Node.intern
+        if block_given?
+          @coll.find() do |cursor|
+            cursor.each do |data|
+              block.call(RDF::Statement.from_mongo(data))
             end
-          else
-            super(pattern) 
+          end
         end
+        enum_statement
       end
-    
-      def query_hash(hash)
-        return @coll.find if hash.empty?
-        h = RDF::Statement.new(hash).to_mongo
-        @coll.find(h)
+      alias_method :each, :each_statement
+
+      ##
+      # @private
+      # @see RDF::Enumerable#has_context?
+      def has_context?(value)
+        !!@coll.find_one(RDF::Mongo::Conversion.to_mongo(value, :context))
       end
-      
-      
+
+      protected
+
+      ##
+      # @private
+      # @see RDF::Queryable#query_pattern
+      # @see RDF::Query::Pattern
+      def query_pattern(pattern, &block)
+        @nodes = {} # reset cache. FIXME this should probably be in Node.intern
+
+        # A pattern context of `false` is used to indicate the default context
+        pm = pattern.to_mongo
+        pm.merge!(:c => nil, :ct => :default) if pattern.context == false
+        #puts "query using #{pm.inspect}"
+        @coll.find(pm) do |cursor|
+          cursor.each do |data|
+            block.call(RDF::Statement.from_mongo(data))
+          end
+        end
+      end
+    
       private
 
         def enumerator! # @private

metadata

@@ -1,137 +1,149 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rdf-mongo
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 9
-  - 1
-  version: 0.1.9.1
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Pius Uzamere
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-04-27 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rdf
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 8
-        version: 0.1.8
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rdf-spec
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 8
-        version: 0.1.8
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: rdf-spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 3
-        version: 0.5.3
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: addressable
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 1
-        - 1
-        version: 2.1.1
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
   type: :runtime
-  version_requirements: *id005
-description: rdf-mongo is a storage adapter for integrating MongoDB and rdf.rb, a Ruby library for working with Resource Description Framework (RDF) data.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+description: rdf-mongo is a storage adapter for integrating MongoDB and rdf.rb, a
+  Ruby library for working with Resource Description Framework (RDF) data.
 email: pius@alum.mit.edu
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - LICENSE
 - VERSION
 - README.md
+- lib/rdf/mongo/version.rb
 - lib/rdf/mongo.rb
-has_rdoc: false
-homepage: http://github.com/pius/rdf-mongo
-licenses: 
+homepage: http://ruby-rdf.github.com/rdf-mongo
+licenses:
 - MIT License
 post_install_message: Have fun! :)
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 6
-      version: 1.8.6
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A storage adapter for integrating MongoDB and rdf.rb, a Ruby library for working with Resource Description Framework (RDF) data.
-test_files: 
-- spec/mongo_repository.spec
+summary: A storage adapter for integrating MongoDB and rdf.rb, a Ruby library for
+  working with Resource Description Framework (RDF) data.
+test_files: []
+has_rdoc: false

data/spec/mongo_repository.spec

@@ -1,24 +0,0 @@
-$:.unshift File.dirname(__FILE__) + "/../lib/"
-
-require 'rdf'
-require 'rdf/spec/repository'
-require 'rdf/mongo'
-require 'enumerator'
-
-describe RDF::Mongo::Repository do
-  context "Mongo RDF Repository" do
-    before :each do
-      @repository = RDF::Mongo::Repository.new() # TODO: Do you need constructor arguments?
-      @repository.coll.drop
-    end
-   
-    after :each do
-      @repository.coll.drop
-    end
-
-    # @see lib/rdf/spec/repository.rb in RDF-spec
-    it_should_behave_like RDF_Repository
-  end
-
-end
-