mongo_db 0.1.9 → 0.1.10

data/lib/mongo_db/model/support/types.rb

@@ -0,0 +1,110 @@
+#
+# Boolean
+#
+module Mongo::Model::BooleanType
+  Mapping = {
+    true    => true,
+    'true'  => true,
+    'TRUE'  => true,
+    'True'  => true,
+    't'     => true,
+    'T'     => true,
+    '1'     => true,
+    1       => true,
+    1.0     => true,
+    false   => false,
+    'false' => false,
+    'FALSE' => false,
+    'False' => false,
+    'f'     => false,
+    'F'     => false,
+    '0'     => false,
+    0       => false,
+    0.0     => false,
+    nil     => nil
+  }
+
+  def cast value
+    if value.is_a? Boolean
+      value
+    else
+      Mapping[value] || false
+    end
+  end
+end
+
+class Boolean; end unless defined?(Boolean)
+
+Boolean.extend Mongo::Model::BooleanType
+
+
+#
+# Date
+#
+require 'date'
+Date.class_eval do
+  def self.cast value
+    if value.nil? || value == ''
+      nil
+    else
+      date = value.is_a?(::Date) || value.is_a?(::Time) ? value : ::Date.parse(value.to_s)
+      date.to_date
+    end
+  rescue
+    nil
+  end
+end
+
+
+#
+# Float
+#
+Float.class_eval do
+  def self.cast value
+    value.nil? ? nil : value.to_f
+  end
+end
+
+
+#
+# Integer
+#
+Integer.class_eval do
+  def self.cast value
+    value_to_i = value.to_i
+    if value_to_i == 0 && value != value_to_i
+      value.to_s =~ /^(0x|0b)?0+/ ? 0 : nil
+    else
+      value_to_i
+    end
+  end
+end
+
+
+#
+# String
+#
+String.class_eval do
+  def self.cast value
+    value.nil? ? nil : value.to_s
+  end
+end
+
+
+#
+# Time
+#
+Time.class_eval do
+  def self.cast value
+    if value.nil? || value == ''
+      nil
+    else
+      # time_class = ::Time.try(:zone).present? ? ::Time.zone : ::Time
+      # time = value.is_a?(::Time) ? value : time_class.parse(value.to_s)
+      # strip milliseconds as Ruby does micro and bson does milli and rounding rounded wrong
+      # at(time.to_i).utc if time
+
+      value.is_a?(::Time) ? value : Date.parse(value.to_s).to_time
+    end
+  end
+end

data/lib/mongo_db/model/validation.rb

@@ -0,0 +1,5 @@
+module Mongo::Model::Validation
+  def _valid?
+    !(respond_to?(:errors) and errors and !errors.empty?)
+  end
+end

data/lib/mongo_db/model.rb

@@ -0,0 +1,30 @@
+begin
+  require 'ruby_ext'
+rescue LoadError => e
+  warn 'Model requires the ruby_ext gem, please install it'
+  raise e
+end
+
+require 'mongo_db/object'
+
+module Mongo::Model; end
+
+%w(
+  support/types
+
+  db
+  assignment
+  callbacks
+  validation
+  crud
+  query
+  scope
+  misc
+  model
+).each{|f| require "mongo_db/model/#{f}"}
+
+module Mongo
+  module Model
+    inherit Db, Assignment, Callbacks, Validation, Crud, Query, Scope, Misc
+  end
+end

data/lib/mongo_db/object/object_serializer.rb

@@ -27,7 +27,7 @@ class Mongo::ObjectSerializer
     opts, validate, callbacks = parse_object_options opts
 
     # before callbacks
-    return false if callbacks and !run_callbacks(objects, :before_validate, :before_save, :before_create)
+    return false if callbacks and !run_callbacks(objects, [:before, :validate], [:before, :save], [:before, :create])
 
     # validation
     return false if validate  and !valid?
@@ -40,7 +40,7 @@ class Mongo::ObjectSerializer
     update_internal_state!
 
     # after callbacks
-    run_callbacks(objects, :after_create, :after_save, :after_validate) if callbacks
+    run_callbacks(objects, [:after, :create], [:after, :save], [:after, :validate]) if callbacks
 
     true
   end
@@ -52,18 +52,18 @@ class Mongo::ObjectSerializer
     # we need to sort out embedded objects into created, updated and destroyed
     created_objects, updated_objects, destroyed_objects = [], [], []
     if callbacks
-      original_ids = original_embedded_objects.collect{|obj| obj.object_id}.to_set
+      original_ids = original_objects.collect{|obj| obj.object_id}.to_set
       objects.each do |obj|
         (original_ids.include?(obj.object_id) ? updated_objects : created_objects) << obj
       end
 
       objects_ids = objects.collect{|obj| obj.object_id}.to_set
-      destroyed_objects = original_embedded_objects.select{|obj| !objects_ids.include?(obj.object_id)}
+      destroyed_objects = original_objects.select{|obj| !objects_ids.include?(obj.object_id)}
 
       all_successfull = [
-        run_callbacks(created_objects,   :before_validate, :before_save,   :before_create),
-        run_callbacks(updated_objects,   :before_validate, :before_save,   :before_update),
-        run_callbacks(destroyed_objects, :before_validate, :before_destroy)
+        run_callbacks(created_objects,   [:before, :validate], [:before, :save],   [:before, :create]),
+        run_callbacks(updated_objects,   [:before, :validate], [:before, :save],   [:before, :update]),
+        run_callbacks(destroyed_objects, [:before, :validate], [:before, :destroy])
       ].reduce(:&)
 
       return false unless all_successfull
@@ -80,9 +80,9 @@ class Mongo::ObjectSerializer
 
     # after callbacks
     if callbacks
-      run_callbacks(created_objects,   :after_create,  :after_save,    :after_validate)
-      run_callbacks(updated_objects,   :after_update,  :after_save,    :after_validate)
-      run_callbacks(destroyed_objects, :after_destroy, :after_validate)
+      run_callbacks(created_objects,   [:after, :create],  [:after, :save],    [:after, :validate])
+      run_callbacks(updated_objects,   [:after, :update],  [:after, :save],    [:after, :validate])
+      run_callbacks(destroyed_objects, [:after, :destroy], [:after, :validate])
     end
 
     true
@@ -94,8 +94,8 @@ class Mongo::ObjectSerializer
     # before callbacks
     if callbacks
       # we need to run :destroy callbacks also on detached embedded objects.
-      all_objects = (objects + original_embedded_objects).uniq{|o| o.object_id}
-      return false unless run_callbacks(all_objects, :before_validate, :before_destroy)
+      all_objects = (objects + original_objects).uniq{|o| o.object_id}
+      return false unless run_callbacks(all_objects, [:before, :validate], [:before, :destroy])
     end
 
     # validation
@@ -107,7 +107,7 @@ class Mongo::ObjectSerializer
     update_internal_state!
 
     # after callbacks
-    run_callbacks(objects, :after_destroy, :after_validate) if callbacks
+    run_callbacks(objects, [:after, :destroy], [:after, :validate]) if callbacks
 
     true
   end
@@ -127,16 +127,15 @@ class Mongo::ObjectSerializer
     true
   end
 
-  def run_callbacks objects, *names
-    all_successfull = true
-    names.each do |name|
+  def run_callbacks objects, *callbacks
+    callbacks.each do |type, method_name|
       objects.each do |obj|
         if obj.respond_to? :_run_callbacks
-          all_successfull = false if obj._run_callbacks(name) == false
+          return false if obj._run_callbacks(type, method_name) == false
         end
       end
     end
-    all_successfull
+    true
   end
 
   def objects
@@ -148,12 +147,12 @@ class Mongo::ObjectSerializer
   end
 
   def update_internal_state!
-    self.original_embedded_objects = objects if Mongo.defaults[:callbacks]
+    self.original_objects = objects if Mongo.defaults[:callbacks]
   end
 
   protected
-    def original_embedded_objects; object.instance_variable_get(:@_original_embedded_objects) end
-    def original_embedded_objects= objects; object.instance_variable_set(:@_original_embedded_objects, objects) end
+    def original_objects; object.instance_variable_get(:@_original_objects) end
+    def original_objects= objects; object.instance_variable_set(:@_original_objects, objects) end
 
     def parse_object_options opts
       opts = opts.clone

data/readme.md

@@ -1,10 +1,10 @@
 Object Model & Ruby driver enhancements for MongoDB.
 
-1. Driver enchancements
-2. Persistence for any Ruby object
-3. Object Model (callbacks, validations, mass-assignment, finders, ...) (work in progress)
+1. Driver enchancements & Migrations.
+2. Persistence for any Ruby object.
+3. Object Model (callbacks, validations, mass-assignment, finders, ...) (work in progress).
 
-Lower layers are completely independent from upper, use only what You need. There are also support for migrations.
+Lower layers are independent from upper, use only what You need.
 
 # MongoDB driver enhancements
 
@@ -16,7 +16,7 @@ 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
-require 'mongo_db/driver/core'
+require 'mongo_db/driver'
 
 # Changing some defaults.
 Mongo.defaults.merge! symbolize: true, multi: true, safe: true
@@ -46,15 +46,8 @@ db.units.all name: 'Zeratul'                       # => [zeratul]
 db.units.all name: 'Zeratul' do |unit|
   unit                                             # => zeratul
 end
-```
-
-Optionall stuff - simple query enchancements:
-
-``` ruby
-# Finders.
-require 'mongo_db/driver/more'
 
-# Simple finders (bang versions also availiable).
+# 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]
@@ -64,6 +57,8 @@ Mongo.defaults.merge! convert_underscore_to_dollar: true
 db.units.all name: {_gt: 'Z'}                      # => [zeratul]
 ```
 
+Source: examples/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.
 
@@ -127,18 +122,135 @@ Mongo.defaults.merge! convert_underscore_to_dollar: true
 db.units.all name: {_gt: 'Z'}                      # => [zeratul]
 ```
 
-# Migrations (work in progress)
+Source: examples/object.rb
 
 # Object Model (work in progress)
 
 Model designed after the excellent "Domain-Driven Design" book by Eric Evans.
 
-- Very small.
-- Minimum extra abstraction, trying to keep things as close to the MongoDB semantic as possible.
+- Very small, see [code stats][:code_stats].
+- The same API for pure driver and Models.
+- Minimum extra abstractions, 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.
+- Full support for embedded objects (validations, callbacks, ...).
+- Scope, default_scope
+- Doesn't try to mimic ActiveRecord, MongoDB is differrent and this tool designed to get most of it.
+
+Existing ODM like MongoMapper and Mongoid are trying to hide simple but non-standard API of MongoDB by covering it with complicated but familiar API.
+This ODM exposes simplicity of MongoDB and leverages it's differences.
+
+``` ruby
+# Connecting to MongoDB.
+require 'mongo_db/model'
+Mongo.defaults.merge! symbolize: true, multi: true, safe: true
+connection = Mongo::Connection.new
+db = connection.db 'default_test'
+db.units.drop
+Mongo::Model.db = db
+
+# Let's define the game unit.
+class Unit
+  inherit Mongo::Model
+  collection :units
+  
+  attr_accessor :name, :status, :stats
+  
+  scope :alive, status: 'alive'
+  
+  class Stats
+    inherit Mongo::Model
+    attr_accessor :attack, :life, :shield
+  end
+end
+
+# Create.
+zeratul  = Unit.new.set(name: 'Zeratul',  status: 'alive', stats: Unit::Stats.new.set(attack: 85, life: 300, shield: 100))
+tassadar = Unit.new.set(name: 'Tassadar', status: 'dead',  stats: Unit::Stats.new.set(attack: 0,  life: 80,  shield: 300))
+
+zeratul.save
+tassadar.save
+
+# Udate (we made error - mistakenly set Tassadar's attack as zero, let's fix it).
+tassadar.stats.attack = 20
+tassadar.save
+
+# Querying first & all, there's also :each, the same as :all.
+Unit.first name: 'Zeratul'                         # => zeratul
+Unit.all name: 'Zeratul'                           # => [zeratul]
+Unit.all name: 'Zeratul' do |unit|
+  unit                                             # => zeratul
+end
+
+# Simple finders (bang versions also availiable).
+Unit.by_name 'Zeratul'                             # => zeratul
+Unit.first_by_name 'Zeratul'                       # => zeratul
+Unit.all_by_name 'Zeratul'                         # => [zeratul]
+
+# Scopes.
+Unit.alive.count                                   # => 1
+Unit.alive.first                                   # => zeratul
+
+# Callbacks & callbacks on embedded models.
+
+# Validations.
+
+# Save model to any collection.
+```
+
+Source: examples/model.rb
+
+# Migrations
+
+Define migration steps, specify desired version and apply it (usually all this should be done via Rake task).
+
+``` ruby
+require 'mongo_db/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'}
+  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'}
+  m.down{|db| db.units.remove name: 'Tassadar'}
+end
+
+# Specify what version of database You need and apply migration.
+migration.update 2
+
+migration.current_version                        # => 2
+db.units.count                                   # => 2
+
+# You can rollback it the same way.
+migration.update 0
+
+migration.current_version                        # => 0
+db.units.count                                   # => 0
+
+# To update to the highest version just call it without the version specified
+migration.update
+
+migration.current_version                        # => 2
+db.units.count                                   # => 2
+```
+
+Source: examples/migration.rb
 
 # Installation
 
@@ -151,4 +263,5 @@ gem install mongo_db
 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
+[mongoid_misc]: https://github.com/alexeypetrushin/mongoid_misc
+[code_stats]: https://raw.github.com/alexeypetrushin/mongo_db/master/doc/code_stats.png

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

@@ -67,4 +67,17 @@ describe "Collection" do
     list.size.should == 1
     list.first[:name].should == 'Zeratul'
   end
+
+  it 'count' do
+    db.units.count(name: 'Zeratul').should == 0
+    db.units.save name: 'Zeratul'
+    db.units.save name: 'Tassadar'
+    db.units.count(name: 'Zeratul').should == 1
+  end
+
+  it "underscore to dollar" do
+    db.units.save name: 'Jim',     age: 34
+    db.units.save name: 'Zeratul', age: 600
+    db.units.all(age: {_lt: 100}).count.should == 1
+  end
 end

data/spec/driver/dynamic_finders_spec.rb

@@ -0,0 +1,50 @@
+require 'driver/spec_helper'
+
+describe "Dynamic Finders" do
+  with_mongo
+
+  before :all do
+    class FindersStub
+      include Mongo::DynamicFinders
+    end
+  end
+
+  after(:all){remove_constants :FindersStub}
+
+  it "parse_finder" do
+    [
+      [:first_by_name,  'Jim'],         [:first,  {name: 'Jim'}],
+      [:first_by_name!, 'Jim'],         [:first!, {name: 'Jim'}],
+
+      [:all_by_name,    'Jim'],         [:all,    {name: 'Jim'}],
+
+      [:each_by_name,   'Jim'],         [:each,   {name: 'Jim'}],
+
+      [:by_name,        'Jim'],         [:first,  {name: 'Jim'}],
+      [:by_name!,       'Jim'],         [:first!, {name: 'Jim'}],
+
+      [:first_by_id,    'id'],          [:first,  {_id: 'id'}],
+      [:first_by_id!,   'id'],          [:first!, {_id: 'id'}],
+      [:by_id,          'id'],          [:first,  {_id: 'id'}],
+      [:by_id!,         'id'],          [:first!, {_id: 'id'}],
+    ].each_slice 2 do |check, expectation|
+      stub = FindersStub.new
+      stub.should_receive(expectation.first).with(expectation.last)
+      stub.send check.first, check.last
+    end
+
+    stub = FindersStub.new
+    -> {stub.invalid_finder 'a', 'b'}.should raise_error(NoMethodError)
+  end
+
+  it "should allow to use bang version only with :first" do
+    stub = FindersStub.new
+    -> {stub.all_by_name!('Jim')}.should raise_error(/can't use bang/)
+  end
+
+  it 'integration with collection' do
+    db.units.first_by_name('Jim').should be_nil
+    db.units.save name: 'Jim'
+    db.units.first_by_name('Jim')[:name].should == 'Jim'
+  end
+end

data/spec/integration/am_validation_spec.rb

@@ -0,0 +1,40 @@
+require 'model/spec_helper'
+
+begin
+  require 'active_model'
+
+  describe "Validations" do
+    with_mongo_model
+
+    before do
+      class Unit
+        inherit Mongo::Model
+        collection :units
+
+        include ActiveModel::Validations
+
+        attr_accessor :name, :status
+
+        validates_presence_of :name
+      end
+    end
+
+    after{remove_constants :Unit}
+
+    it "ActiveModel integration smoke test" do
+      unit = Unit.new
+      unit.should be_invalid
+      unit.errors.size.should == 1
+      unit.errors.first.first.should == :name
+      unit.save.should be_false
+
+      unit.name = 'Zeratul'
+      unit.should be_valid
+      unit.errors.should be_empty
+      unit.save.should be_true
+    end
+  end
+
+rescue LoadError => e
+  warn 'No ActiveModel, integration with ActiveModel::Validations spec will be skipped.'
+end

data/spec/migration/migration_spec.rb

@@ -0,0 +1,60 @@
+require 'driver/spec_helper'
+require 'mongo_db/migration'
+
+describe "Migration" do
+  with_mongo
+  before{@migration = Mongo::Migration.new mongo.db}
+
+  it "shouldn't update if versions are the same" do
+    @migration.update(0).should be_false
+  end
+
+  it "migration should provide access to database" do
+    @migration.add 1 do |m|
+      m.up do |db|
+        db.users.save name: 'Bob'
+      end
+    end
+    @migration.update(1).should be_true
+    db.users.count.should == 1
+  end
+
+  it "increase_db_version" do
+    @migration.current_version.should == 0
+
+    check = mock
+    @migration.add 1 do |m|
+      m.up{check.up}
+    end
+
+    check.should_receive :up
+    @migration.update(1).should be_true
+    @migration.current_version.should == 1
+  end
+
+  it "decrease_db_version" do
+    check = mock
+    @migration.add 1 do |m|
+      m.up{check.up}
+      m.down{check.down}
+    end
+
+    check.should_receive :up
+    @migration.update(1).should be_true
+
+    check.should_receive :down
+    @migration.update(0).should be_true
+    @migration.current_version.should == 0
+  end
+
+  it "should automigrate to highest version" do
+    @migration.add 1 do |m|
+      m.up{}
+    end
+    @migration.add 2 do |m|
+      m.up{}
+    end
+    @migration.update.should be_true
+    @migration.current_version.should == 2
+  end
+end