toystore-mongo 0.7.0 → 0.8.0

data/Gemfile

@@ -5,7 +5,7 @@ require 'plucky/version'
 
 group(:development) do
   gem 'bson_ext', Plucky::MongoVersion, :require => false
-  gem 'SystemTimer'
+  gem 'SystemTimer', :platform => :ruby_18
   gem 'rake',       '~> 0.8.7'
   gem 'rspec',      '~> 2.3'
   gem 'log_buddy',  '~> 0.5.0'

data/README.rdoc

@@ -6,6 +6,23 @@ Mongo integration for Toystore.
 
   $ gem install toystore-mongo
 
+== Usage
+
+  class User
+    include Toy::Mongo
+    store Mongo::Connection.new.db('myapp')['users']
+
+    attribute :name, String
+  end
+
+Including Toy::Mongo includes Toy::Store and then does a few things:
+
+* Includes Plucky querying so you can do things like User.count, User.all, User.first, and much more
+* Sets the key factory to object id
+* Overrides get so that it also works with string representation of object id
+* Overrides get_multi so that it performs one query instead of one query per id
+* Adds instance method atomic_update_attributes for persisting only the changes (see #persistable_changes)
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/lib/toy/mongo/querying.rb

@@ -29,6 +29,26 @@ module Toy
           end
         end
 
+        def get(id)
+          super Plucky.to_object_id(id)
+        end
+
+        # Mongo does not guarantee sort order when using $in.
+        # So we manually sort in ruby for now. Not stoked about
+        # this, but it gets the job done.
+        def get_multi(*ids)
+          ids  = ids.flatten
+          all(:_id => {'$in' => ids}).sort do |a, b|
+            index_a = ids.index(a.id)
+            index_b = ids.index(b.id)
+            if index_a.nil? || index_b.nil?
+              1
+            else
+              index_a <=> index_b
+            end
+          end
+        end
+
         def query
           # TODO: add object id keys to convert
           Plucky::Query.new(store.client, :transformer => transformer).object_ids(object_id_attributes)
@@ -73,7 +93,12 @@ module Toy
         criteria = {'_id' => id}
         criteria.update(opts[:criteria]) if opts[:criteria]
         options[:safe] = opts.key?(:safe) ? opts[:safe] : store.options[:safe]
-        store.client.update(criteria, update, options)
+
+        run_callbacks(:save) do
+          run_callbacks(:update) do
+            store.client.update(criteria, update, options)
+          end
+        end
       end
     end
   end

data/lib/toy/mongo/version.rb

@@ -1,5 +1,5 @@
 module Toy
   module Mongo
-    VERSION = '0.7.0'
+    VERSION = '0.8.0'
   end
 end

data/lib/toy/mongo.rb

@@ -10,10 +10,10 @@ module Toy
     extend ActiveSupport::Concern
 
     included do
+      include Toy::Store
       include Querying
+
+      key(Toy::Identity::ObjectIdKeyFactory.new)
     end
   end
 end
-
-Toy.key_factory = Toy::Identity::ObjectIdKeyFactory.new
-Toy.plugin(Toy::Mongo)

data/spec/helper.rb

@@ -15,6 +15,7 @@ Bundler.require(:development)
 
 require 'toy/mongo'
 require 'support/constants'
+require 'support/callbacks_helper'
 
 STORE = Mongo::Connection.new.db('testing')['toystore-mongo']
 
@@ -23,7 +24,7 @@ Logger.new(log_path.join('test.log')).tap do |log|
   Toy.logger = log
 end
 
-Rspec.configure do |c|
+RSpec.configure do |c|
   c.include(Support::Constants)
 
   c.before(:each) do

data/spec/support/callbacks_helper.rb

@@ -0,0 +1,22 @@
+module CallbacksHelper
+  extend ActiveSupport::Concern
+
+  included do
+    [ :before_create,  :after_create,
+      :before_update,  :after_update,
+      :before_save,    :after_save,
+      :before_destroy, :after_destroy].each do |callback|
+      callback_method = "#{callback}_callback"
+      send(callback, callback_method)
+      define_method(callback_method) { history << callback.to_sym }
+    end
+  end
+
+  def history
+    @history ||= []
+  end
+
+  def clear_history
+    @history = nil
+  end
+end

data/spec/support/constants.rb

@@ -33,7 +33,7 @@ module Support
           def self.name; '#{name}' end
           def self.to_s; '#{name}' end
         """ if name
-        model.send(:include, Toy::Store)
+        model.send(:include, Toy::Mongo)
         model.store(:mongo, STORE)
       end
     end

data/spec/toy/mongo/querying_spec.rb

@@ -4,6 +4,7 @@ describe Toy::Mongo::Querying do
   uses_constants('User')
 
   before(:each) do
+    User.send(:include, CallbacksHelper)
     User.identity_map_off
     User.attribute(:name, String)
     User.attribute(:bio, String)
@@ -48,6 +49,12 @@ describe Toy::Mongo::Querying do
       @user.atomic_update('$set' => {'name' => 'Frank'})
     end
 
+    it "runs callbacks in correct order" do
+      doc = User.create.tap(&:clear_history)
+      doc.atomic_update({})
+      doc.history.should == [:before_save, :before_update, :after_update, :after_save]
+    end
+
     context "with :safe option" do
       it "overrides store's :safe option" do
         User.store(:mongo, STORE, :safe => false)
@@ -132,4 +139,40 @@ describe Toy::Mongo::Querying do
       @user.atomic_update_attributes(:name => 'Frank')
     end
   end
+
+  describe "#get" do
+    before(:each) do
+      @user = User.create
+    end
+
+    it "works for string object id" do
+      User.get(@user.id.to_s).should == @user
+    end
+
+    it "works for object id" do
+      User.get(@user.id).should == @user
+    end
+
+    it "returns nil for invalid object id" do
+      User.get('1234').should be_nil
+    end
+  end
+
+  describe "#get_multi" do
+    before(:each) do
+      @user1 = User.create
+      @user2 = User.create
+      @users = User.get_multi(@user2.id, @user1.id)
+    end
+
+    it "returns multiple documents in correct order" do
+      @users.should == [@user2, @user1]
+    end
+
+    it "performs one query" do
+      User.should_not_receive(:get)
+      User.should_receive(:all).once.and_return([])
+      User.get_multi(@user1.id, @user2.id)
+    end
+  end
 end

data/spec/toy/mongo_spec.rb

@@ -3,8 +3,9 @@ require 'helper'
 describe Toy::Mongo do
   it "defaults key factory to object_id" do
     klass = Class.new do
-      include Toy::Store
+      include Toy::Mongo
     end
+
     klass.key_factory.should be_instance_of(Toy::Identity::ObjectIdKeyFactory)
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: toystore-mongo
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - John Nunemaker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-07 00:00:00 Z
+date: 2011-09-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plucky
@@ -88,6 +88,7 @@ files:
 - lib/toystore-mongo.rb
 - spec/helper.rb
 - spec/spec.opts
+- spec/support/callbacks_helper.rb
 - spec/support/constants.rb
 - spec/toy/extensions/bson_object_id_spec.rb
 - spec/toy/identity/object_id_key_factory_spec.rb
@@ -123,16 +124,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Mongo integration for Toystore
 test_files: 
 - spec/helper.rb
 - spec/spec.opts
+- spec/support/callbacks_helper.rb
 - spec/support/constants.rb
 - spec/toy/extensions/bson_object_id_spec.rb
 - spec/toy/identity/object_id_key_factory_spec.rb
 - spec/toy/mongo/querying_spec.rb
 - spec/toy/mongo_spec.rb
-has_rdoc: