mongo_db 0.1.3 → 0.1.4

data/lib/mongo_db/driver/{collection.rb → core/collection.rb}

@@ -1,16 +1,16 @@
-Mongo::Collection.class_eval do
-  alias_method :save_with_ext, :save
-  def save doc, opts = {}
-    save_with_ext doc, reverse_merge_defaults(opts, :safe)
+module Mongo::Ext::Collection
+  # 
+  # CRUD
+  #   
+  def save_with_ext doc, opts = {}
+    save_without_ext doc, reverse_merge_defaults(opts, :safe)
   end
   
-  alias_method :insert_whth_ext, :insert
-  def insert doc_or_docs, opts = {}
-    insert_whth_ext doc_or_docs, reverse_merge_defaults(opts, :safe)
+  def insert_with_ext doc_or_docs, opts = {}
+    insert_without_ext doc_or_docs, reverse_merge_defaults(opts, :safe)
   end
   
-  alias_method :update_whth_ext, :update
-  def update selector, document, opts = {}
+  def update_with_ext selector, document, opts = {}
     # because :multi works only with $ operators, we need to check it
     opts = if document.keys.any?{|k| k =~ /^\$/}      
       reverse_merge_defaults(opts, :safe, :multi)
@@ -18,14 +18,20 @@ Mongo::Collection.class_eval do
       reverse_merge_defaults(opts, :safe)
     end
     
-    update_whth_ext selector, document, opts
+    update_without_ext selector, document, opts
   end
-  
-  alias_method :remove_with_ext, :remove
-  def remove selector = {}, opts = {}
-    remove_with_ext selector, reverse_merge_defaults(opts, :safe, :multi)
+
+  def remove_with_ext selector = {}, opts = {}
+    remove_without_ext selector, reverse_merge_defaults(opts, :safe, :multi)
+  end
+
+  def destroy *args
+    remove *args
   end
   
+  # 
+  # Querying
+  # 
   def first *args
     o = find_one *args
     ::Mongo::Ext::HashHelper.unmarshal o
@@ -55,8 +61,6 @@ Mongo::Collection.class_eval do
     end
   end
   
-  alias_method :destroy, :remove
-  
   protected
     def reverse_merge_defaults opts, *keys
       h = opts.clone

data/lib/mongo_db/driver/{database.rb → core/database.rb}

@@ -1,4 +1,4 @@
-Mongo::DB.class_eval do
+module Mongo::Ext::DB
   protected
     def method_missing collection_name
       self.collection collection_name

data/lib/mongo_db/driver/core.rb

@@ -0,0 +1,33 @@
+require 'mongo_db/gems'
+
+require 'mongo'
+
+# namespace for extensions
+class Mongo::Ext; end
+
+%w(
+  database
+  collection  
+  hash_helper
+).each{|f| require "mongo_db/driver/core/#{f}"}
+
+# defaults
+Mongo.class_eval do
+  class << self
+    def defaults; @defaults ||= {} end
+    attr_writer :defaults
+  end
+end
+
+# database
+Mongo::DB.send :include, Mongo::Ext::DB
+
+# collection
+Mongo::Collection.class_eval do
+  include Mongo::Ext::Collection
+  
+  %w(insert update remove save).each do |method|
+    alias_method "#{method}_without_ext", method
+    alias_method method, "#{method}_with_ext"
+  end
+end

data/lib/mongo_db/driver/more/collection.rb

@@ -0,0 +1,43 @@
+module Mongo::Ext::Collection
+  # 
+  # first_by_id, special case
+  # 
+  def first_by_id id
+    first _id: id
+  end
+  alias_method :by_id, :first_by_id
+
+  def first_by_id! id
+    first_by_id(id) || raise(Mongo::NotFound, "document with id #{id} not found!")
+  end
+  alias_method :by_id!, :first_by_id!
+  
+  protected
+    # 
+    # first_by_field, all_by_field
+    # 
+    def method_missing clause, *a, &b
+      if clause =~ /^([a-z]_by_[a-z_])|(by_[a-z_])/ 
+        clause = clause.to_s      
+      
+        bang = clause =~ /!$/
+        clause = clause[0..-2] if bang
+      
+        finder, field = if clause =~ /^by_/  
+          ['first', clause.sub(/by_/, '')]
+        else        
+          clause.split(/_by_/, 2)          
+        end                
+        finder = 'first' if finder == 'find'
+      
+        raise "You can't use bang version with :#{finder}!" if bang and finder != 'first'
+      
+        raise "invalid arguments for finder (#{a})!" unless a.size == 1
+        field_value = a.first
+
+        send(finder, field => field_value) || (bang && raise(Mongo::NotFound, "document with #{field}: #{field_value} not found!"))
+      else
+        super
+      end
+    end
+end

data/lib/mongo_db/driver/more.rb

@@ -0,0 +1,13 @@
+require 'mongo_db/driver/core'
+
+class Mongo::NotFound < StandardError; end
+
+%w(
+  collection
+).each{|f| require "mongo_db/driver/more/#{f}"}
+
+Mongo.defaults.merge! \
+  symbolize:   true,
+  batch_size:  50,
+  multi:       true,
+  safe:        true

data/lib/mongo_db/driver.rb

@@ -1,23 +1,2 @@
-require 'mongo_db/gems'
-
-require 'mongo'
-
-# namespace for extensions
-class Mongo::Ext; end
-
-# mongo extensions
-Mongo.class_eval do
-  def self.defaults; @defaults ||= {} end
-  defaults.merge! \
-    symbolize:   true,
-    batch_size:  50,
-    multi:       true,
-    safe:        true
-end
-
-%w(
-  support
-  database
-  collection  
-  hash_helper
-).each{|f| require "mongo_db/driver/#{f}"}
+require 'mongo_db/driver/core'
+require 'mongo_db/driver/more'

data/lib/mongo_db/{driver/support.rb → support.rb}

@@ -1,3 +1,5 @@
+
+
 # Hash.class_eval do
 #   unless defined_method? :subset
 #     def subset *keys, &block

data/readme.md

@@ -1,37 +1,54 @@
-Object Model & Ruby driver enhancements for MongoDB
+Object Model & Ruby driver enhancements for MongoDB.
 
 # MongoDB driver enhancements
 
-- Makes alien API of mongo-ruby-driver friendly & handy.
+MongoDB itself is very powerful, flexible and simple tool, but it's Ruby driver hides it behind complicated API. 
+This enhancements alter the Ruby-driver's API to be more simple and intuitive.
+
+- Makes API of mongo-ruby-driver friendly & handy.
 - No extra abstraction or complexities introduced, all things are exactly the same as in MongoDB.
-- Simple migrations support.
+- Simple migrations support (work in progress).
 
-Sample:
+Note: By default it also adds a little magic and alters some default values of standard driver to be more useful, but You can omit it and require only the core stuff: use *requre 'mongo_db/driver/core'* instead of *requre 'mongo_db/driver'*
 
 ``` ruby
 require 'mongo_db/driver'
 
-# collection shortcuts
-db.some_collection
+# connection & db
+connection = Mongo::Connection.new
+db = connection.db 'default_test'
 
-# save & update
-zeratul = {name: 'Zeratul'}
-db.heroes.save zeratul
+# create
+zeratul =  {name: 'Zeratul',  stats: {attack: 85, life: 300, shield: 100}}
+tassadar = {name: 'Tassadar', stats: {attack: 0,  life: 80,  shield: 300}}
 
-# first & all    
-db.heroes.first name: 'Zeratul'                     # => {name: 'Zeratul'}
+db.units.save zeratul
+db.units.save tassadar
 
-db.heroes.all name: 'Zeratul'                       # => [{name: 'Zeratul'}]
-db.heroes.all name: 'Zeratul' do |hero|
-  hero                                              # => {name: 'Zeratul'}
-end    
+# udate (we made error - mistakenly set Tassadar's attack as zero, let's fix it)
+tassadar[:stats][:attack] = 20
+db.units.save tassadar
 
-# each
-db.heroes.each name: 'Zeratul' do |hero|
-  hero                                              # => {name: 'Zeratul'}
+# querying - first & all, there's also :each, the same as :all
+db.units.first name: 'Zeratul'                      # => zeratul
+db.units.all name: 'Zeratul'                        # => [zeratul]
+db.units.all name: 'Zeratul' do |hero|
+  hero                                              # => zeratul
 end
 ```
 
+Optionall stuff:
+
+``` ruby
+# 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]
+```
+
+More docs - there's no need for more docs, the whole point of this extension is to be small, intuitive, 100% compatible with official driver (at least should be), and require no extra knowledge.
+So, please use standard Ruby driver documentation.
+
 # Object Model (work in progress)
 
 Model designed after the excellent "Domain-Driven Design" book by Eric Evans.
@@ -45,14 +62,21 @@ Model designed after the excellent "Domain-Driven Design" book by Eric Evans.
 
 # Installation & Usage
 
+Installation:
+
 ``` bash
 gem install mongo_db
 ```
 
+Usage:
+
 ``` ruby
 require 'mongo_db/driver'
 ```
 
 # License
 
-Copyright (c) Alexey Petrushin, http://petrush.in, released under the MIT license.
+Copyright (c) Alexey Petrushin, http://petrush.in, released under the MIT license.
+
+[mongo_mapper_ext]: https://github.com/alexeypetrushin/mongo_mapper_ext
+[mongoid_misc]: https://github.com/alexeypetrushin/mongoid_misc

data/spec/driver/{collection_spec.rb → core/collection_spec.rb}

@@ -19,8 +19,8 @@ describe "Collection" do
   describe "symbolize" do
     it 'should always return symbolized hashes' do
       zeratul = {name: 'Zeratul'}
-      db.heroes.save(zeratul).should be_mongo_id
-      r = db.heroes.first(name: 'Zeratul')
+      db.units.save(zeratul).should be_mongo_id
+      r = db.units.first(name: 'Zeratul')
       r[:_id].should be_mongo_id
       r['_id'].should be_nil
       r[:name].should == 'Zeratul'
@@ -33,8 +33,8 @@ describe "Collection" do
         Mongo.defaults[:symbolize] = false
       
         zeratul = {name: 'Zeratul'}
-        db.heroes.save(zeratul).should be_mongo_id
-        r = db.heroes.first(name: 'Zeratul')
+        db.units.save(zeratul).should be_mongo_id
+        r = db.units.first(name: 'Zeratul')
         r[:_id].should be_nil
         r['_id'].should be_mongo_id
         r[:name].should be_nil
@@ -46,24 +46,24 @@ describe "Collection" do
   end
   
   it "first" do
-    db.heroes.first.should be_nil
+    db.units.first.should be_nil
     zeratul = {name: 'Zeratul'}
-    db.heroes.save(zeratul).should be_mongo_id
-    db.heroes.first(name: 'Zeratul')[:name].should == 'Zeratul'
+    db.units.save(zeratul).should be_mongo_id
+    db.units.first(name: 'Zeratul')[:name].should == 'Zeratul'
   end
   
   it 'all' do
-    db.heroes.all.should == []    
+    db.units.all.should == []    
     
     zeratul = {name: 'Zeratul'}
-    db.heroes.save(zeratul).should be_mongo_id
+    db.units.save(zeratul).should be_mongo_id
     
-    list = db.heroes.all(name: 'Zeratul')
+    list = db.units.all(name: 'Zeratul')
     list.size.should == 1
     list.first[:name].should == 'Zeratul'
     
     # with block
-    list = []; db.heroes.all{|o| list << o}
+    list = []; db.units.all{|o| list << o}
     list.size.should == 1
     list.first[:name].should == 'Zeratul'
   end

data/spec/driver/{crud_spec.rb → core/crud_spec.rb}

@@ -10,28 +10,28 @@ describe "Hash CRUD" do
   
     it 'crud' do
       # read
-      db.heroes.count.should == 0
-      db.heroes.all.should == []
-      db.heroes.first.should == nil
+      db.units.count.should == 0
+      db.units.all.should == []
+      db.units.first.should == nil
   
       # create
-      db.heroes.save(@zeratul).should be_mongo_id
+      db.units.save(@zeratul).should be_mongo_id
       @zeratul[:_id].should be_mongo_id
     
       # read
-      db.heroes.all.should == [@zeratul]
-      db.heroes.count.should == 1
-      db.heroes.first.should == @zeratul
+      db.units.all.should == [@zeratul]
+      db.units.count.should == 1
+      db.units.first.should == @zeratul
     
       # update
       @zeratul[:info] = 'Killer of Cerebrates'
-      db.heroes.save @zeratul
-      db.heroes.count.should == 1
-      db.heroes.first(name: 'Zeratul')[:info].should == 'Killer of Cerebrates'
+      db.units.save @zeratul
+      db.units.count.should == 1
+      db.units.first(name: 'Zeratul')[:info].should == 'Killer of Cerebrates'
           
       # destroy
-      db.heroes.destroy @zeratul
-      db.heroes.count.should == 0
+      db.units.destroy @zeratul
+      db.units.count.should == 0
     end
   end
   

data/spec/driver/more/advanced_finders.rb

@@ -0,0 +1,26 @@
+before do
+  @zeratul =  {name: 'Zeratul',  stats: {attack: 85, life: 300, shield: 100}}
+  @tassadar = {name: 'Tassadar', stats: {attack: 20,  life: 80,  shield: 300}}
+  
+  db.units.save @zeratul
+  db.units.save @tassadar
+end
+
+
+
+
+
+
+
+
+
+
+it "selector" do
+  db.units.select{|u| 
+    u.stats.life < 100
+    u.name.exist
+    u.name.in 
+  }.first.should == @tassadar
+  
+  db.units.select{|u| }
+end

data/spec/driver/more/simple_finders_spec.rb

@@ -0,0 +1,51 @@
+require 'driver/spec_helper'
+
+describe "Querying" do
+  with_mongo
+  
+  before do
+    @jim =  {name: 'Jim'}
+    @units = db.units
+  end
+    
+  it "find, first, by" do
+    @units.first_by_name('Jim').should be_nil    
+    -> {@units.first_by_name!('Jim')}.should raise_error(Mongo::NotFound)
+    @units.by_name('Jim').should be_nil    
+    -> {@units.by_name!('Jim')}.should raise_error(Mongo::NotFound)
+    @units.first_by_name('Jim').should be_nil    
+    -> {@units.first_by_name!('Jim')}.should raise_error(Mongo::NotFound)
+    
+    @units.save @jim
+    
+    @units.first_by_name('Jim').should == @jim
+    @units.first_by_name!('Jim').should == @jim
+    @units.by_name('Jim').should == @jim
+    @units.by_name!('Jim').should == @jim
+    @units.first_by_name('Jim').should == @jim
+    @units.first_by_name!('Jim').should == @jim
+  end
+  
+  it "all" do
+    @units.all_by_name('Jim').should == []    
+    @units.save @jim
+    @units.all_by_name('Jim').should == [@jim]
+  end
+  
+  it "should allow to use bang version only with :first" do
+    -> {@units.all_by_name!('Jim')}.should raise_error(/can't use bang/)
+  end
+  
+  it "by_id (special case)" do
+    @units.method(:by_id).should == @units.method(:first_by_id)
+    @units.method(:by_id!).should == @units.method(:first_by_id!)
+    
+    @units.by_id('4de81858cf26bde569000009').should be_nil    
+    -> {@units.by_id!('4de81858cf26bde569000009')}.should raise_error(Mongo::NotFound)
+    
+    @units.save @jim
+    
+    @units.by_id(@jim[:_id]).should == @jim
+    @units.by_id!(@jim[:_id]).should == @jim
+  end
+end

data/spec/driver/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'mongo_db/driver'
-require 'ruby_ext'
 
+require 'ruby_ext'
 require 'rspec_ext'
 require 'mongo_db/driver/spec'
 

data/spec/driver_example_spec.rb

@@ -0,0 +1,45 @@
+require 'driver/spec_helper'
+
+describe "Example" do
+  with_mongo
+  
+  defaults = nil
+  before(:all){defaults = Mongo.defaults.clone}
+  after(:all){Mongo.defaults = defaults}
+  
+  it "core" do    
+    require 'mongo_db/driver'  
+    
+    # connection & db
+    connection = Mongo::Connection.new
+    db = connection.db 'default_test'
+    
+    # collection shortcuts
+    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
+    
+    # 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]
+    db.units.all name: 'Zeratul' do |hero|
+      hero                                             # => zeratul
+    end
+  end
+  
+  it "optional" do
+    # 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]
+  end
+end

data/spec/model/model/crud.rb

@@ -8,7 +8,7 @@ describe "Model CRUD" do
     before do
       class Person
         inherit Mongo::Model
-        collection{db.heroes}
+        collection{db.units}
         
         def initialize name, info; @name, @info = name, info end
         attr_accessor :name, :info

data/spec/model/object/crud_shared.rb

@@ -1,29 +1,29 @@
 shared_examples_for 'object CRUD' do  
   it 'crud' do
     # read
-    db.heroes.count.should == 0
-    db.heroes.all.should == []
-    db.heroes.first.should == nil
+    db.units.count.should == 0
+    db.units.all.should == []
+    db.units.first.should == nil
 
     # create
-    db.heroes.save(@zeratul).should be_true
+    db.units.save(@zeratul).should be_true
     @zeratul.instance_variable_get(:@_id).should be_present
   
     # read
-    db.heroes.count.should == 1
-    db.heroes.all.should == [@zeratul]
-    db.heroes.first.should == @zeratul
-    db.heroes.first.object_id.should_not == @zeratul.object_id
+    db.units.count.should == 1
+    db.units.all.should == [@zeratul]
+    db.units.first.should == @zeratul
+    db.units.first.object_id.should_not == @zeratul.object_id
   
     # update
     @zeratul.info = 'Killer of Cerebrates'
-    db.heroes.save(@zeratul).should be_true
-    db.heroes.count.should == 1
-    db.heroes.first(name: 'Zeratul').info.should == 'Killer of Cerebrates'
+    db.units.save(@zeratul).should be_true
+    db.units.count.should == 1
+    db.units.first(name: 'Zeratul').info.should == 'Killer of Cerebrates'
   
     # destroy
-    db.heroes.destroy(@zeratul).should be_true
-    db.heroes.count.should == 0
+    db.units.destroy(@zeratul).should be_true
+    db.units.count.should == 0
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_db
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-12 00:00:00.000000000Z
+date: 2011-08-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
-  requirement: &2845070 !ruby/object:Gem::Requirement
+  requirement: &2844700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2845070
+  version_requirements: *2844700
 description: 
 email: 
 executables: []
@@ -30,20 +30,24 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - readme.md
-- lib/mongo_db/driver/collection.rb
-- lib/mongo_db/driver/database.rb
-- lib/mongo_db/driver/hash_helper.rb
+- lib/mongo_db/driver/core/collection.rb
+- lib/mongo_db/driver/core/database.rb
+- lib/mongo_db/driver/core/hash_helper.rb
+- lib/mongo_db/driver/core.rb
+- lib/mongo_db/driver/more/collection.rb
+- lib/mongo_db/driver/more.rb
 - lib/mongo_db/driver/spec.rb
-- lib/mongo_db/driver/support.rb
 - lib/mongo_db/driver.rb
 - lib/mongo_db/gems.rb
 - lib/mongo_db/model.rb
-- spec/driver/collection_spec.rb
-- spec/driver/crud_spec.rb
-- spec/driver/database_spec.rb
-- spec/driver/example_spec.rb
-- spec/driver/query_spec.rb
+- lib/mongo_db/support.rb
+- spec/driver/core/collection_spec.rb
+- spec/driver/core/crud_spec.rb
+- spec/driver/core/database_spec.rb
+- spec/driver/more/advanced_finders.rb
+- spec/driver/more/simple_finders_spec.rb
 - spec/driver/spec_helper.rb
+- spec/driver_example_spec.rb
 - spec/migration/migration_spec.rb
 - spec/model/model/crud.rb
 - spec/model/model/query.rb

data/spec/driver/example_spec.rb

@@ -1,29 +0,0 @@
-require 'driver/spec_helper'
-
-describe "Example" do
-  with_mongo
-  
-  it "database & collection" do
-    require 'mongo_db/driver'
-    
-    # collection shortcuts
-    db.some_collection
-    
-    # save & update
-    zeratul = {name: 'Zeratul'}
-    db.heroes.save zeratul
-    
-    # first & all    
-    db.heroes.first name: 'Zeratul'                     # => {name: 'Zeratul'}
-
-    db.heroes.all name: 'Zeratul'                       # => [{name: 'Zeratul'}]
-    db.heroes.all name: 'Zeratul' do |hero|
-      hero                                              # => {name: 'Zeratul'}
-    end    
-    
-    # each
-    db.heroes.each name: 'Zeratul' do |hero|
-      hero                                              # => {name: 'Zeratul'}
-    end
-  end
-end

data/spec/driver/query_spec.rb

@@ -1,27 +0,0 @@
-# require 'driver/spec_helper'
-# 
-# describe "Querying" do
-#   with_mongo
-#   
-#   it "database & collection" do
-#     # collection shortcuts
-#     db.some_collection
-#     
-#     # save & update
-#     zeratul = {name: 'Zeratul'}
-#     db.heroes.save zeratul
-#     
-#     # first & all    
-#     db.heroes.first name: 'Zeratul'                     # => {name: 'Zeratul'}
-# 
-#     db.heroes.all name: 'Zeratul'                       # => [{name: 'Zeratul'}]
-#     db.heroes.all name: 'Zeratul' do |hero|
-#       hero                                              # => {name: 'Zeratul'}
-#     end    
-#     
-#     # each
-#     db.heroes.each name: 'Zeratul' do |hero|
-#       hero                                              # => {name: 'Zeratul'}
-#     end
-#   end
-# end