mongodb 0.0.9 → 0.0.10

data/Rakefile

@@ -4,8 +4,13 @@ project(
   name: "mongodb",
   # version: '0.1.0',
   gem: true,
-  summary: "Save any Ruby object to MongoDB",
+  summary: "Persistence for any Ruby Object & Driver enhancements for MongoDB.",
 
   author: "Alexey Petrushin",
-  homepage: "http://github.com/alexeypetrushin/mongodb"
-)
+  homepage: "http://alexeypetrushin.github.com/mongodb"
+)
+
+desc "Generate documentation"
+task :docs do
+  %x(cd docs && rocco -o site *.rb)
+end

data/lib/mongo/driver.rb

@@ -6,6 +6,7 @@ class Mongo::Error < StandardError; end
 class Mongo::NotFound < Mongo::Error; end
 
 %w(
+  connection
   database
   collection
   dynamic_finders
@@ -16,14 +17,23 @@ Mongo.class_eval do
   class << self
     def defaults; @defaults ||= {} end
     attr_writer :defaults
+
+    # Override this method to provide Your own custom database initialization.
+    def db name
+      @databases ||= {}
+      @databases[name] ||= begin
+        connection = Mongo::Connection.new
+        connection.db name
+      end
+    end
   end
 end
 Mongo.defaults[:convert_id_to_string] = true
 
-# database
+Mongo::Connection.send :include, Mongo::ConnectionExt
+
 Mongo::DB.send :include, Mongo::DBExt
 
-# collection
 Mongo::Collection.class_eval do
   include Mongo::CollectionExt, Mongo::DynamicFinders
 

data/lib/mongo/driver/collection.rb

@@ -90,6 +90,7 @@ module Mongo::CollectionExt
   end
 
   def count_with_ext selector = {}, options = {}
+    selector = convert_underscore_to_dollar_in_selector selector if selector.is_a? Hash
     find(selector, options).count()
   end
 

data/lib/mongo/driver/connection.rb

@@ -0,0 +1,6 @@
+module Mongo::ConnectionExt
+  protected
+    def method_missing db_name
+      self.db db_name.to_s
+    end
+end

data/lib/mongo/driver/spec.rb

@@ -1,5 +1,13 @@
 MONGO_TEST_DATABASE_NAME = 'default_test'
 
+Mongo.class_eval do
+  class << self
+    def db name
+      ($mongo || raise('Mongo not defined (use :with_mongo helper)!')).db
+    end
+  end
+end
+
 rspec do
   def mongo
     $mongo || raise('Mongo not defined (use :with_mongo helper)!')

data/lib/mongo/migration.rb

@@ -5,4 +5,5 @@ class Mongo::Migration; end
 %w(
   definition
   migration
+  dsl
 ).each{|f| require "mongo/migration/#{f}"}

data/lib/mongo/migration/dsl.rb

@@ -0,0 +1,26 @@
+Mongo.class_eval do
+  class << self
+    def migration *args, &block
+      if block
+        version, database_name = *args
+        version or raise("migration version not provided!")
+        database_name ||= :default
+        add_migration version, database_name, &block
+      elsif !block
+        database_name = args.first
+        database_name ||= :default
+        get_migration(database_name)
+      end
+    end
+
+    def add_migration version, database_name, &block
+      get_migration(database_name).add version, &block
+    end
+
+    def get_migration database_name
+      migrations[database_name] ||= Mongo::Migration.new
+    end
+
+    def migrations; @migrations ||= {} end
+  end
+end

data/lib/mongo/migration/migration.rb

@@ -1,6 +1,6 @@
 class Mongo::Migration
-  def initialize db
-    @db, @definitions = db, {}
+  def initialize
+    @definitions = {}
   end
 
   def add version, &block
@@ -12,6 +12,7 @@ class Mongo::Migration
 
   def update version = nil
     version ||= definitions.keys.max
+    version = version.to_i
 
     if current_version == version
       info "database '#{db.name}' already is of #{version} version, no migration needed"
@@ -33,17 +34,20 @@ class Mongo::Migration
     end
   end
 
-  protected
-    attr_accessor :db, :definitions
+  attr_writer :db
+  def db; @db || raise("Database for Migration not defined!") end
+
+  def update_version new_version
+    db.db_metadata.update({name: 'migration'}, {name: 'migration', version: new_version}, {upsert: true, safe: true})
+  end
+
+  attr_accessor :definitions
 
+  protected
     def info msg
       db.connection.logger and db.connection.logger.info(msg)
     end
 
-    def update_version new_version
-      db.db_metadata.update({name: 'migration'}, {name: 'migration', version: new_version}, {upsert: true, safe: true})
-    end
-
     def increase_db_version
       new_version = current_version + 1
       migration = definitions[new_version]

data/lib/mongo/migration/tasks.rb

@@ -1,19 +1,27 @@
-# namespace :db do
-#   desc "Migrate Database"
-#   task migrate: :migration_evnironment do
-#     require 'mongo_migration'
-#
-#     database_name = (ENV['d'] || ENV['database'] || :default).to_sym
-#     version = ENV['v'] || ENV['version']
-#
-#     if version.blank?
-#       size = Mongo.migration.definitions[database_name].size
-#       highest_defined_version = size == 0 ? 0 : size - 1
-#       version = highest_defined_version
-#     else
-#       version = version.to_i
-#     end
-#
-#     Mongo.migration.update version, database_name
-#   end
-# end
+namespace :db do
+  desc "Clear migration version for Database"
+  task clear_version: :migration_evnironment do
+    require 'mongo/migration'
+
+    database_name = (ENV['d'] || ENV['database'] || :default).to_sym
+
+    db = Mongo.db database_name
+    migration = Mongo::Migration.new
+    migration.db = db
+    migration.update_version 0
+  end
+
+  desc "Migrate Database"
+  task migrate: :migration_evnironment do
+    require 'mongo/migration'
+
+    database_name = (ENV['d'] || ENV['database'] || :default).to_sym
+    version = ENV['v'] || ENV['version']
+
+    if migration = Mongo.migrations[database_name]
+      db = Mongo.db database_name
+      migration.db = db
+      migration.update version
+    end
+  end
+end

data/lib/mongo/object/object.rb

@@ -75,16 +75,18 @@ module Mongo::Object
       options
     end
 
-    def each_object_instance_variable obj, &block
-      obj.instance_variables.each do |iv_name|
-        # skipping variables starting with _xx, usually they
-        # have specific meaning and used for example for cache
-        next if iv_name =~ SKIP_IV_REGEXP
-
+    def each_instance_variable obj, &block
+      instance_variables(obj).each do |iv_name|
         block.call iv_name, obj.instance_variable_get(iv_name)
       end
     end
 
+    def instance_variables obj
+      # skipping variables starting with _xx, usually they
+      # have specific meaning and used for example for cache
+      obj.instance_variables.select{|n| n !~ SKIP_IV_REGEXP}
+    end
+
     # converts object to document (also works with nested & arrays)
     def to_mongo obj
       return obj.to_mongo if obj.respond_to? :to_mongo
@@ -101,7 +103,7 @@ module Mongo::Object
         doc = {}
 
         # copying instance variables
-        each_object_instance_variable obj do |iv_name, v|
+        each_instance_variable obj do |iv_name, v|
           k = iv_name.to_s[1..-1]
           doc[k] = to_mongo v
         end
@@ -117,14 +119,30 @@ module Mongo::Object
       end
     end
 
-    def each_object obj, include_first = true, &block
+    def convert obj, method, options = {}
+      if obj.is_a? Hash
+        r = {}
+        obj.each do |k, v|
+          r[k] = convert v, method, options
+        end
+        r
+      elsif obj.is_a? Array
+        obj.collect{|v| convert v, method, options}
+      elsif obj.is_a? Mongo::Object
+        obj.send method, options
+      else # simple type
+        obj
+      end
+    end
+
+    def each_object obj, &block
       if obj.is_a? Hash
         obj.each{|k, v| each_object v, &block}
       elsif obj.is_a? Array
         obj.each{|v| each_object v, &block}
       elsif obj.is_a? ::Mongo::Object
-        block.call obj if include_first
-        each_object_instance_variable obj do |iv_name, v|
+        block.call obj
+        each_instance_variable obj do |iv_name, v|
           each_object v, &block
         end
       end
@@ -211,8 +229,8 @@ module Mongo::Object
       return unless ::Mongo.defaults[:callbacks]
 
       original_children.clear
-      ::Mongo::Object.each_object self, false do |obj|
-        original_children << obj
+      ::Mongo::Object.each_object self do |obj|
+        original_children << obj unless obj.equal?(self)
       end
     end
 
@@ -230,11 +248,13 @@ module Mongo::Object
         created_children, updated_children, destroyed_children = [], [], []
 
         original_children_ids = Set.new; original_children.each{|obj| original_children_ids << obj.object_id}
-        ::Mongo::Object.each_object self, false do |obj|
-          (original_children_ids.include?(obj.object_id) ? updated_children : created_children) << obj
+        ::Mongo::Object.each_object self do |obj|
+          (original_children_ids.include?(obj.object_id) ? updated_children : created_children) << obj unless obj.equal?(self)
         end
 
-        children_ids = Set.new; ::Mongo::Object.each_object(self, false){|obj| children_ids << obj.object_id}
+        children_ids = Set.new; ::Mongo::Object.each_object self do |obj|
+          children_ids << obj.object_id unless obj.equal?(self)
+        end
         destroyed_children = original_children.select{|obj| !children_ids.include?(obj.object_id)}
 
         @_child_objects = [created_children, updated_children, destroyed_children]

data/readme.md

@@ -1,6 +1,8 @@
-Ruby object persistence & driver enhancements for MongoDB.
+**Documentation:** http://alexeypetrushin.github.com/mongodb
 
-1. Driver enchancements.
+Persistence for any Ruby Object & Driver enhancements for MongoDB.
+
+1. Driver enhancements.
 2. Migrations.
 3. Persistence for any Ruby object.
 4. Object Model [mongodb_model][mongodb_model]
@@ -17,48 +19,53 @@ These enhancements alter the driver's API and made it more simple and intuitive.
 - 100% backward compatibility with original driver API (if not - it's a bug, report it please)
 
 ``` ruby
+# Requiring driver enhancements.
 require 'mongo/driver'
 
-# Changing some defaults.
+# Changing some defaults (optional, don't do it if You don't need it).
+#
+# By default they are set to false to provide maximum performance, but if You use MongoDB as
+# major application database (and not only for logging, andalytics and other minor tasks) it's
+# usually better to set it to true.
 Mongo.defaults.merge! multi: true, safe: true
 
-# Connection & db.
+# Connecting to test database and cleaning it before starting the sample.
 connection = Mongo::Connection.new
-db = connection.db 'default_test'
-db.units.drop
+db = connection.default_test
+db.drop
 
-# Collection shortcuts.
+# Collection shortcuts, access collection directly by typing it's name,
+# instead of `db.collection('some_collection')`.
 db.some_collection
 
-# Create.
-zeratul =  {name: 'Zeratul',  stats: {attack: 85, life: 300, shield: 100}}
-tassadar = {name: 'Tassadar', stats: {attack: 0,  life: 80,  shield: 300}}
-
-db.units.save zeratul
-db.units.save tassadar
+# Let's create two Heroes.
+db.units.save name: 'Zeratul'
+db.units.save name: 'Tassadar'
 
-# Udate (we made error - mistakenly set Tassadar's attack as zero, let's fix it).
-tassadar[:stats][:attack] = 20
-db.units.save tassadar
-
-# Querying first & all, there's also :each, the same as :all.
-db.units.first name: 'Zeratul'                     # => zeratul
-db.units.all name: 'Zeratul'                       # => [zeratul]
+# Querying first and all documents matching criteria (there's
+# also `:each` method, the same as `:all`).
+p db.units.first(name: 'Zeratul')                  # => zeratul
+p db.units.all(name: 'Zeratul')                    # => [zeratul]
 db.units.all name: 'Zeratul' do |unit|
-  unit                                             # => zeratul
+  p unit                                           # => zeratul
 end
 
-# Dynamic Finders (bang versions also availiable).
-db.units.by_name 'Zeratul'                         # => zeratul
-db.units.first_by_name 'Zeratul'                   # => zeratul
-db.units.all_by_name 'Zeratul'                     # => [zeratul]
+# Dynamic finders, handy way to do simple queries.
+p db.units.by_name('Zeratul')                      # => zeratul
+p db.units.first_by_name('Zeratul')                # => zeratul
+p db.units.all_by_name('Zeratul')                  # => [zeratul]
+
+# Bang versions, will raise error if nothing found.
+p db.units.first!(name: 'Zeratul')                 # => zeratul
+p db.units.by_name!('Zeratul')                     # => zeratul
 
-# Query sugar, use {name: {_gt: 'Z'}} instead of {name: {:$gt => 'Z'}}.
-Mongo.defaults.merge! convert_underscore_to_dollar: true
-db.units.all name: {_gt: 'Z'}                      # => [zeratul]
+# Query sugar, use `:_gt` instead of `:$gt`. It's more convinient to use new hash
+# syntax `{name: {_gt: 'Z'}}` instead of hashrockets `{name: {:$gt => 'Z'}}`.
+Mongo.defaults[:convert_underscore_to_dollar] = true
+p db.units.all(name: {_gt: 'Z'})                   # => [zeratul]
 ```
 
-Source: examples/driver.rb
+Source: docs/driver.rb
 
 More docs - there's no need for more docs, the whole point of this extension is to be small, intuitive, 100% compatible with the official driver, and require no extra knowledge.
 So, please use standard Ruby driver documentation.
@@ -68,52 +75,50 @@ So, please use standard Ruby driver documentation.
 Define migration steps, specify desired version and apply it (usually all this should be done via Rake task).
 
 ``` ruby
+# Requiring support for migration.
 require 'mongo/migration'
 
-# Connection & db.
-connection = Mongo::Connection.new
-db = connection.db 'default_test'
-db.units.drop
-
-# Initialize migration (usually all this should be done inside of :migrate
-# rake task).
-migration = Mongo::Migration.new db
-
-# Define migrations.
-# Usually they are defined as files in some folder and You loading it by
-# using something like this:
-#   Dir['<runtime_dir>/db/migrations/*.rb'].each{|fname| load fname}
-migration.add 1 do |m|
-  m.up{|db|   db.units.save   name: 'Zeratul'}
+# Defining first migration, creating Zeratul (and removing it in rollback).
+Mongo.migration 1 do |m|
+  m.up  {|db| db.units.save   name: 'Zeratul'}
   m.down{|db| db.units.remove name: 'Zeratul'}
 end
 
-# Let's add another one.
-migration.add 2 do |m|
-  m.up{|db|   db.units.save   name: 'Tassadar'}
+# Defining second migration, creating Tassadar (and removing it in rollback).
+Mongo.migration 2 do |m|
+  m.up  {|db| db.units.save   name: 'Tassadar'}
   m.down{|db| db.units.remove name: 'Tassadar'}
 end
 
-# Specify what version of database You need and apply migration.
-migration.update 2
+# Connecting to test database and cleaning it before starting the sample.
+connection = Mongo::Connection.new
+db = connection.default_test
+db.drop
+
+# Assigning database to migration.
+Mongo.migration.db = db
+
+# Let's migrate to the first version and create mighty Zeratul.
+Mongo.migration.update 1
 
-migration.current_version                        # => 2
-db.units.count                                   # => 2
+p Mongo.migration.current_version                # => 1
+p db.units.all                                   # => [Zeratul]
 
-# You can rollback it the same way.
-migration.update 0
+# Rolling it back.
+Mongo.migration.update 0
 
-migration.current_version                        # => 0
-db.units.count                                   # => 0
+p Mongo.migration.current_version                # => 0
+p db.units.all                                   # => []
 
-# To update to the highest version just call it without the version specified
-migration.update
+# Updating to the latest version (if there's no explicit version
+# then the highest available version will be chosen).
+Mongo.migration.update
 
-migration.current_version                        # => 2
-db.units.count                                   # => 2
+p Mongo.migration.current_version                # => 2
+p db.units.all                                   # => [Zeratul, Tassadar]
 ```
 
-Source: examples/migration.rb
+Source: docs/migration.rb
 
 # Persistence for any Ruby object
 
@@ -122,23 +127,25 @@ Save any Ruby object to MongoDB, as if it's a document. Objects can be any type,
 Note: the :initialize method should allow to create object without arguments.
 
 ``` ruby
-# Connecting to MongoDB.
+# Connecting to test database and cleaning it before starting the sample.
 require 'mongo/object'
-Mongo.defaults.merge! multi: true, safe: true
 connection = Mongo::Connection.new
-db = connection.db 'default_test'
-db.units.drop
+db = connection.default_test
+db.drop
 
-# Let's define the game unit.
+# Let's define Game Unit.
 class Unit
+  # Including Mongo::Object.
   include Mongo::Object
+
   attr_reader :name, :stats
 
-  # don't forget to allow creating object with no arguments
+  # We need to also the initializer to be used without arguments.
   def initialize name = nil, stats = nil
     @name, @stats = name, stats
   end
 
+  # Creating internal object containing stats of the Unit.
   class Stats
     include Mongo::Object
     attr_accessor :attack, :life, :shield
@@ -149,35 +156,43 @@ class Unit
   end
 end
 
-# Create.
+# Let's create two Heroes.
+#
+# It uses the same Driver API, everything works the same way as with hashes.
 zeratul  = Unit.new('Zeratul',  Unit::Stats.new(85, 300, 100))
 tassadar = Unit.new('Tassadar', Unit::Stats.new(0,  80,  300))
 
 db.units.save zeratul
 db.units.save tassadar
 
-# Udate (we made error - mistakenly set Tassadar's attack as zero, let's fix it).
+# Udating, we made error - mistakenly set Tassadar's attack as zero, let's fix it.
 tassadar.stats.attack = 20
 db.units.save tassadar
 
-# Querying first & all, there's also :each, the same as :all.
-db.units.first name: 'Zeratul'                     # => zeratul
-db.units.all name: 'Zeratul'                       # => [zeratul]
+# Querying first and all documents matching criteria (there's also `:each` method,
+# the same as `:all`).
+p db.units.first(name: 'Zeratul')                  # => zeratul
+p db.units.all(name: 'Zeratul')                    # => [zeratul]
 db.units.all name: 'Zeratul' do |unit|
-  unit                                             # => zeratul
+  p unit                                           # => zeratul
 end
 
-# Simple finders (bang versions also availiable).
-db.units.by_name 'Zeratul'                         # => zeratul
-db.units.first_by_name 'Zeratul'                   # => zeratul
-db.units.all_by_name 'Zeratul'                     # => [zeratul]
+# Dynamic finders, handy way to do simple queries.
+p db.units.by_name('Zeratul')                      # => zeratul
+p db.units.first_by_name('Zeratul')                # => zeratul
+p db.units.all_by_name('Zeratul')                  # => [zeratul]
+
+# Bang versions, will raise error if nothing found.
+p db.units.first!(name: 'Zeratul')                 # => zeratul
+p db.units.by_name!('Zeratul')                     # => zeratul
 
-# Query sugar, use {name: {_gt: 'Z'}} instead of {name: {:$gt => 'Z'}}.
-Mongo.defaults.merge! convert_underscore_to_dollar: true
-db.units.all name: {_gt: 'Z'}                      # => [zeratul]
+# Query sugar, use `:_gt` instead of `:$gt`. It's more convinient to use new hash
+# syntax `{name: {_gt: 'Z'}}` instead of hashrockets `{name: {:$gt => 'Z'}}`.
+Mongo.defaults[:convert_underscore_to_dollar] = true
+p db.units.all(name: {_gt: 'Z'})                   # => [zeratul]
 ```
 
-Source: examples/object.rb
+Source: docs/object.rb
 
 # Installation
 

data/spec/driver/connection_spec.rb

@@ -0,0 +1,9 @@
+require 'driver/spec_helper'
+
+describe "Connection" do
+  with_mongo
+
+  it "should provide handy access to databases" do
+    db.connection.some_db.name.should == 'some_db'
+  end
+end

data/spec/migration/migration_spec.rb

@@ -3,7 +3,10 @@ require 'mongo/migration'
 
 describe "Migration" do
   with_mongo
-  before{@migration = Mongo::Migration.new mongo.db}
+  before do
+    @migration = Mongo::Migration.new
+    @migration.db = mongo.db
+  end
 
   it "shouldn't update if versions are the same" do
     @migration.update(0).should be_false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongodb
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-04 00:00:00.000000000Z
+date: 2011-09-13 00:00:00.000000000Z
 dependencies: []
 description: 
 email: 
@@ -20,12 +20,14 @@ files:
 - Rakefile
 - readme.md
 - lib/mongo/driver/collection.rb
+- lib/mongo/driver/connection.rb
 - lib/mongo/driver/database.rb
 - lib/mongo/driver/dynamic_finders.rb
 - lib/mongo/driver/spec.rb
 - lib/mongo/driver.rb
 - lib/mongo/gems.rb
 - lib/mongo/migration/definition.rb
+- lib/mongo/migration/dsl.rb
 - lib/mongo/migration/migration.rb
 - lib/mongo/migration/tasks.rb
 - lib/mongo/migration.rb
@@ -35,6 +37,7 @@ files:
 - lib/mongo/object/spec.rb
 - lib/mongo/object.rb
 - spec/driver/collection_spec.rb
+- spec/driver/connection_spec.rb
 - spec/driver/crud_spec.rb
 - spec/driver/database_spec.rb
 - spec/driver/dynamic_finders_spec.rb
@@ -46,7 +49,7 @@ files:
 - spec/object/crud_spec.rb
 - spec/object/spec_helper.rb
 - spec/object/validation_spec.rb
-homepage: http://github.com/alexeypetrushin/mongodb
+homepage: http://alexeypetrushin.github.com/mongodb
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -69,5 +72,5 @@ rubyforge_project:
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Save any Ruby object to MongoDB
+summary: Persistence for any Ruby Object & Driver enhancements for MongoDB.
 test_files: []