mongo_db 0.0.1 → 0.1.0

data/Rakefile

@@ -3,10 +3,9 @@ require 'rake_ext'
 project(
   name: "mongo_db",
   # official_name: "mongo_db",
-  version: '0.0.1',
+  version: '0.1.0',
   gem: true,
-  summary: "MongDB ODM. In development, don't use it, come back at 11/8/25",
-  # Very small, schema-less, config-less Ruby ODM for MongoDB",
+  summary: "Model & Ruby driver enchancements for MongoDB",
 
   author: "Alexey Petrushin",
   homepage: "http://github.com/alexeypetrushin/mongo_db"

data/lib/mongo_db/driver/collection.rb

@@ -0,0 +1,68 @@
+Mongo::Collection.class_eval do
+  alias_method :save_with_ext, :save
+  def save doc, opts = {}
+    save_with_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)
+  end
+  
+  alias_method :update_whth_ext, :update
+  def update 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)
+    else
+      reverse_merge_defaults(opts, :safe)
+    end
+    
+    update_whth_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)
+  end
+  
+  def first *args
+    o = find_one *args
+    ::Mongo::Ext::HashHelper.unmarshal o
+  end
+  
+  def all *args, &block
+    if block
+      each *args, &block
+    else
+      list = []
+      each(*args){|o| list << o}
+      list
+    end
+  end
+  
+  def each selector = {}, opts = {}, &block
+    cursor = nil
+    begin
+      cursor = find selector, reverse_merge_defaults(opts, :batch_size)
+      cursor.each do |o|
+        o = ::Mongo::Ext::HashHelper.unmarshal o
+        block.call o
+      end
+      nil
+    ensure
+      cursor.close if cursor
+    end
+  end
+  
+  alias_method :destroy, :remove
+  
+  protected
+    def reverse_merge_defaults opts, *keys
+      h = opts.clone
+      keys.each do |k|
+        h[k] = Mongo.defaults[k] if Mongo.defaults.include?(k) and !h.include?(k)
+      end
+      h
+    end
+end

data/lib/mongo_db/driver/database.rb

@@ -1,5 +1,6 @@
-class Mongo::DB
-  def method_missing collection_name
-    self[collection_name]
-  end
+Mongo::DB.class_eval do
+  protected
+    def method_missing collection_name
+      self.collection collection_name
+    end
 end

data/lib/mongo_db/driver/hash_helper.rb

@@ -0,0 +1,34 @@
+require 'set'
+require 'date'
+
+class Mongo::Ext::HashHelper
+  # SIMPLE_TYPES = [
+  #   String, Symbol, 
+  #   Numeric, 
+  #   Regexp, 
+  #   Array, 
+  #   TrueClass, FalseClass, 
+  #   Date, DateTime,
+  #   BSON::ObjectId
+  # ].to_set
+
+  class << self
+    # symbolizing hashes
+    def unmarshal o
+      return o unless Mongo.defaults[:symbolize]
+      
+      if o.is_a? Hash
+        h = {}
+        o.each do |k, v|
+          k = k.to_sym if k.is_a?(String)
+          h[k] = unmarshal v
+        end
+        h
+      elsif o.is_a? Array
+        o.collect{|v| unmarshal v}
+      else        
+        o
+      end
+    end
+  end
+end

data/lib/mongo_db/driver/spec.rb

@@ -1,11 +1,11 @@
-MONGO_TEST_DATABASE = 'default_test'
+MONGO_TEST_DATABASE_NAME = 'default_test'
 
 rspec do    
   def mongo
     $mongo || raise('Mongo not defined (use :with_mongo helper)!')
   end
   
-  def clear_mongo name = MONGO_TEST_DATABASE
+  def clear_mongo name = MONGO_TEST_DATABASE_NAME
     mongo.db.collection_names.each do |name|
       next if name =~ /^system\./
       mongo.db.collection(name).drop
@@ -14,12 +14,12 @@ rspec do
   
   class << self
     def with_mongo
-      require 'ostruct'
-    
       before :all do
+        require 'ostruct'
+        
         $mongo = OpenStruct.new.tap do |m|
           m.connection = Mongo::Connection.new
-          m.db = m.connection.db MONGO_TEST_DATABASE
+          m.db = m.connection.db MONGO_TEST_DATABASE_NAME
         end
       end      
       after(:all){$mongo = nil}

data/lib/mongo_db/driver/support.rb

@@ -0,0 +1,28 @@
+# Hash.class_eval do
+#   unless defined_method? :subset
+#     def subset *keys, &block
+#       keys = keys.first if keys.first.is_a? Array
+#       h = {}    
+#       if keys
+#         self.each do |k, v|
+#           h[k] = v if keys.include? k
+#         end
+#       else
+#         self.each do |k, v|
+#           h[k] = v if block.call k
+#         end
+#       end
+#       h
+#     end
+#   end
+#   
+#   unless defined_method? :reverse_merge
+#     def reverse_merge(other_hash)
+#       other_hash.merge(self)
+#     end
+# 
+#     def reverse_merge!(other_hash)
+#       merge!(other_hash){|k,o,n| o }
+#     end
+#   end  
+# end

data/lib/mongo_db/driver.rb

@@ -1,5 +1,23 @@
+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
-).each{|f| require "mongo_model/support/#{f}"}
+  collection  
+  hash_helper
+).each{|f| require "mongo_db/driver/#{f}"}

data/lib/mongo_db/model.rb

@@ -0,0 +1,4 @@
+require 'mongo_db/driver'
+
+%w(
+).each{|f| require "mongo_db/model/#{f}"}

data/readme.md

@@ -1,9 +1,58 @@
-# Ruby ODM for MongoDB
+Model & Ruby driver enchancements for MongoDB
 
-Not finished, in development.
+# MongoDB driver enchancements
+
+- Makes alien 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.
+
+Sample:
+
+``` ruby
+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
+```
+
+# Model (work in progress)
+
+Model designed after the excellent "Domain-Driven Design" book by Eric Evans.
 
 - Very small.
-- Schema-less, dynamic.
+- Minimum extra abstraction, trying to keep things as close to the MongoDB semantic as possible.
+- Schema-less, dynamic (with ability to specify types for mass-assignment).
 - Models can be saved to any collection.
 - Full support for embedded objects (and MDD composite pattern).
-- Doesn't try to mimic ActiveRecord, it's differrent and designed to get most of MongoDB.
+- Doesn't try to mimic ActiveRecord, it's differrent and designed to get most of MongoDB.
+
+# Installation & Usage
+
+``` bash
+gem install mongo_db
+```
+
+``` ruby
+require 'mongo_db/driver'
+```
+
+# License
+
+Copyright (c) Alexey Petrushin, http://petrush.in, released under the MIT license.

data/spec/driver/collection_spec.rb

@@ -0,0 +1,70 @@
+require 'driver/spec_helper'
+
+describe "Collection" do
+  with_mongo
+  
+  it 'by default save must update all matched by criteria (not first as defautl in mongo)' do
+    db.units.save name: 'Probe', race: 'Protoss', status: 'alive'
+    db.units.save name: 'Zealot', race: 'Protoss', status: 'alive'
+
+    # update
+    db.units.update({race: 'Protoss'}, :$set => {status: 'dead'})
+    db.units.all.collect{|u| u[:status]}.should == %w(dead dead)
+    
+    # destroy
+    db.units.destroy race: 'Protoss'
+    db.units.count.should == 0
+  end
+  
+  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')
+      r[:_id].should be_mongo_id
+      r['_id'].should be_nil
+      r[:name].should == 'Zeratul'
+      r['name'].should be_nil
+    end
+    
+    it "should be able to disable symbolization" do
+      old = Mongo.defaults[:symbolize]
+      begin
+        Mongo.defaults[:symbolize] = false
+      
+        zeratul = {name: 'Zeratul'}
+        db.heroes.save(zeratul).should be_mongo_id
+        r = db.heroes.first(name: 'Zeratul')
+        r[:_id].should be_nil
+        r['_id'].should be_mongo_id
+        r[:name].should be_nil
+        r['name'].should == 'Zeratul'
+      ensure
+        Mongo.defaults[:symbolize] = old
+      end
+    end
+  end
+  
+  it "first" do
+    db.heroes.first.should be_nil
+    zeratul = {name: 'Zeratul'}
+    db.heroes.save(zeratul).should be_mongo_id
+    db.heroes.first(name: 'Zeratul')[:name].should == 'Zeratul'
+  end
+  
+  it 'all' do
+    db.heroes.all.should == []    
+    
+    zeratul = {name: 'Zeratul'}
+    db.heroes.save(zeratul).should be_mongo_id
+    
+    list = db.heroes.all(name: 'Zeratul')
+    list.size.should == 1
+    list.first[:name].should == 'Zeratul'
+    
+    # with block
+    list = []; db.heroes.all{|o| list << o}
+    list.size.should == 1
+    list.first[:name].should == 'Zeratul'
+  end
+end

data/spec/{mongo_model/hash → driver}/crud_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require 'driver/spec_helper'
 
 describe "Hash CRUD" do
-  with_mongo_model
+  with_mongo
   
   describe 'simple' do
     before do
@@ -15,7 +15,8 @@ describe "Hash CRUD" do
       db.heroes.first.should == nil
   
       # create
-      db.heroes.save(@zeratul)
+      db.heroes.save(@zeratul).should be_mongo_id
+      @zeratul[:_id].should be_mongo_id
     
       # read
       db.heroes.all.should == [@zeratul]
@@ -24,12 +25,12 @@ describe "Hash CRUD" do
     
       # update
       @zeratul[:info] = 'Killer of Cerebrates'
-      db.heroes.save({name: 'Zeratul'}, @zeratul)
+      db.heroes.save @zeratul
       db.heroes.count.should == 1
-      db.heroes.first(name: 'Zeratul').info.should == 'Killer of Cerebrates'
-    
+      db.heroes.first(name: 'Zeratul')[:info].should == 'Killer of Cerebrates'
+          
       # destroy
-      db.heroes.destroy name: 'Zeratul'
+      db.heroes.destroy @zeratul
       db.heroes.count.should == 0
     end
   end
@@ -47,7 +48,7 @@ describe "Hash CRUD" do
     
     it 'crud' do
       # create
-      db.players.save(@player)
+      db.players.save(@player).should be_mongo_id
 
       # read
       db.players.count.should == 1
@@ -55,14 +56,14 @@ describe "Hash CRUD" do
 
       # update
       @player[:missions].first[:stats][:units] = 9
-      @player.missions << {name: 'Desperate Alliance', stats: {buildings: 11, units: 40}},
-      db.players.save({name: 'Alex'}, @player)
+      @player[:missions].push name: 'Desperate Alliance', stats: {buildings: 11, units: 40}
+      db.players.save(@player).should_not be_nil
       db.players.count.should == 1
       db.players.first.should == @player
       db.players.first.object_id.should_not == @player.object_id
 
       # destroy
-      db.players.destroy name: 'Alex'
+      db.players.destroy @player
       db.players.count.should == 0
     end
   end  

data/spec/driver/database_spec.rb

@@ -0,0 +1,9 @@
+require 'driver/spec_helper'
+
+describe "Database" do
+  with_mongo
+
+  it "should provide handy access to collections" do
+    db.some_collection.name.should == 'some_collection'
+  end
+end

data/spec/driver/example_spec.rb

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,27 @@
+# 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

data/spec/driver/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'mongo_db/driver'
+require 'ruby_ext'
+
+require 'rspec_ext'
+require 'mongo_db/driver/spec'
+
+# 
+# Handy spec helpers
+# 
+rspec do
+  def db
+    mongo.db
+  end
+end
+
+Object.class_eval do
+  def mongo_id?; false end
+end
+BSON::ObjectId.class_eval do
+  def mongo_id?; true end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_db
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &1006610 !ruby/object:Gem::Requirement
+  requirement: &319910 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *1006610
+  version_requirements: *319910
 - !ruby/object:Gem::Dependency
   name: mongo
-  requirement: &1015350 !ruby/object:Gem::Requirement
+  requirement: &601440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *1015350
+  version_requirements: *601440
 description: 
 email: 
 executables: []
@@ -41,26 +41,29 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - readme.md
-- lib/mongo_db/driver/connection.rb
+- lib/mongo_db/driver/collection.rb
 - lib/mongo_db/driver/database.rb
+- lib/mongo_db/driver/hash_helper.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
-- lib/mongo_db.rb
-- spec/mongo_ext/migration_spec.rb
-- spec/mongo_ext/misc_spec.rb
-- spec/mongo_ext/spec_helper.rb
-- spec/mongo_model/hash/crud_spec.rb
-- spec/mongo_model/model/crud_spec.rb
-- spec/mongo_model/model/query_spec.rb
-- spec/mongo_model/object/callbacks_spec.rb
-- spec/mongo_model/object/crud_shared.rb
-- spec/mongo_model/object/crud_spec.rb
-- spec/mongo_model/object/validation_spec.rb
-- spec/mongo_model/spec_helper.rb
-- spec/query_spec.rb
-- spec/test_spec.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
+- spec/driver/spec_helper.rb
+- spec/migration/migration_spec.rb
+- spec/model/model/crud.rb
+- spec/model/model/query.rb
+- spec/model/object/callbacks.rb
+- spec/model/object/crud.rb
+- spec/model/object/crud_shared.rb
+- spec/model/object/validation.rb
+- spec/model/spec_helper.rb
+- spec/test.rb
 homepage: http://github.com/alexeypetrushin/mongo_db
 licenses: []
 post_install_message: 
@@ -84,5 +87,5 @@ rubyforge_project:
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: MongDB ODM. In development, don't use it, come back at 11/8/25
+summary: Model & Ruby driver enchancements for MongoDB
 test_files: []

data/lib/mongo_db.rb

@@ -1,3 +0,0 @@
-require 'mongo_db/gems'
-require 'mongo_db/driver'
-require 'mongo_db/model'

data/spec/mongo_ext/misc_spec.rb

@@ -1,10 +0,0 @@
-require 'mongo_ext/spec_helper'
-
-describe "Mongo Extensions" do
-  with_mongo
-  
-  it "should provide handy access to collections" do
-    mongo.db['collection1']
-    mongo.db.collection1
-  end
-end

data/spec/mongo_ext/spec_helper.rb

@@ -1,4 +0,0 @@
-require 'mongo_ext'
-
-require 'rspec_ext'
-require 'mongo_ext/spec'