delayed_job_shallow_mongoid 0.2.6 → 0.2.7

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.2.7

data/delayed_job_shallow_mongoid.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "delayed_job_shallow_mongoid"
-  s.version = "0.2.6"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joey Aghion"]

data/lib/delayed/performable_method.rb

@@ -16,7 +16,7 @@ module Delayed
     
     def display_name
       if object.is_a?(ShallowMongoid::DocumentStub)
-        return "#{object.klass}[#{object.id}]##{method_name}"
+        "#{object.description}##{method_name}"
       else
         "#{object.class}##{method_name}"
       end

data/lib/delayed/shallow_mongoid.rb

@@ -1,18 +1,32 @@
 module Delayed
   module ShallowMongoid
     def self.dump(arg)
-      if arg.is_a?(::Mongoid::Document) && !arg.embedded?
-        ShallowMongoid::DocumentStub.new(arg.class, arg._id.to_s)
+      return arg unless arg.is_a?(::Mongoid::Document)
+      if arg.embedded?
+        ShallowMongoid::DocumentStub.new(arg._root.class, arg._root._id.to_s, selector_from(arg))
       else
-        arg
+        ShallowMongoid::DocumentStub.new(arg.class, arg._id.to_s)
       end
     end
   
     def self.load(arg)
-      if arg.is_a?(ShallowMongoid::DocumentStub)
-        arg.klass.find(arg.id)
-      else
-        arg
+      return arg unless arg.is_a?(ShallowMongoid::DocumentStub)
+      result = arg.klass.find(arg.id)
+      (arg.selector || []).each do |message|
+        result = result.send(*message)
+      end
+      result
+    end
+  
+    # The chain of relations allowing us to locate an embedded document.
+    # E.g., ['images', ['find', '4eef..678'], 'width']
+    def self.selector_from(doc)
+      [].tap do |selector|
+        while doc._parent do
+          selector.unshift ['find', doc._id.to_s] if doc.metadata.macro == :embeds_many
+          selector.unshift doc.metadata.key
+          doc = doc._parent
+        end
       end
     end
   end

data/lib/delayed/shallow_mongoid/document_stub.rb

@@ -1,7 +1,11 @@
 module Delayed::ShallowMongoid
-  class DocumentStub < Struct.new(:klass, :id)
-    def display_name
-      "#{klass}[#{id}]##{method_name}"
+  class DocumentStub < Struct.new(:klass, :id, :selector)
+    def description
+      "#{klass}[#{id}]".tap do |desc|
+        desc << "." + selector.map{ |s|
+          s.is_a?(Array) ? "#{s.first}(#{s[1..-1].map(&:inspect).join(', ')})" : s
+        }.join(".") if selector && selector.any?
+      end
     end
   end
 end

data/spec/delayed_job_shallow_mongoid_spec.rb

@@ -1,25 +1,36 @@
 require 'spec_helper'
 
-class TestModel
+class GrandchildModel
   include ::Mongoid::Document
-  embeds_many :child_models
+  embedded_in :child_model, :inverse_of => :grandchild_models
 end
-
 class ChildModel
   include ::Mongoid::Document
-  embedded_in :test_model, inverse_of: :child_models
+  embedded_in :test_model, :inverse_of => :child_models
+  embeds_many :grandchild_models
+end
+class TestModel
+  include ::Mongoid::Document
+  embeds_many :child_models
 end
 
 describe Delayed::ShallowMongoid::DocumentStub do
-  before(:each) do
-    @shallow = Delayed::ShallowMongoid::DocumentStub.new(TestModel, 111)
-  end
   it "should have a klass" do
+    @shallow = Delayed::ShallowMongoid::DocumentStub.new(TestModel, 111)
     @shallow.klass.should == TestModel
   end
   it "should have an id" do
+    @shallow = Delayed::ShallowMongoid::DocumentStub.new(TestModel, 111)
     @shallow.id.should == 111
   end
+  it "should have an optional selector" do
+    @shallow = Delayed::ShallowMongoid::DocumentStub.new(TestModel, 111)
+    @shallow.selector.should == nil
+  end
+  it "can have an actual selector" do
+    @shallow = Delayed::ShallowMongoid::DocumentStub.new(TestModel, 111, [:a, :b])
+    @shallow.selector.should == [:a, :b]
+  end
 end
 
 describe ::Delayed::PerformableMethod do
@@ -38,37 +49,64 @@ describe ::Delayed::PerformableMethod do
       method.args.first.should be_a_kind_of(Delayed::ShallowMongoid::DocumentStub)
       method.args.first.id.should == @model._id.to_s
     end
-    it "should not transform embedded document into shallow version" do
-      child = ChildModel.new
-      @model.child_models << child
-      method = ::Delayed::PerformableMethod.new(child, :to_s, [])
-      method.object.should_not be_a_kind_of(Delayed::ShallowMongoid::DocumentStub)
+    context "with an embedded document" do
+      before(:each) do
+        @child = ChildModel.new(:_id => ::BSON::ObjectId.new)
+        @model.child_models << @child
+      end
+      after(:each) do
+        @method.object.should be_a_kind_of(Delayed::ShallowMongoid::DocumentStub)
+        @method.object.id.should == @model.id.to_s
+        @method.object.klass.should == @model.class
+      end
+      it "should store the selector" do
+        @method = ::Delayed::PerformableMethod.new(@child, :to_s, [])
+        @method.object.selector.should == ['child_models', ['find', @child._id.to_s]]
+      end
+      it "should store the deeply nested selector" do
+        @grandchild = GrandchildModel.new(:_id => ::BSON::ObjectId.new)
+        @model.child_models.first.grandchild_models << @grandchild
+        @method = ::Delayed::PerformableMethod.new(@grandchild, :to_s, [])
+        @method.object.selector.should == ['child_models', ['find', @child._id.to_s], 'grandchild_models', ['find', @grandchild._id.to_s]]
+      end
     end
   end
 
   context 'when running job' do
-    before(:each) do
-      @method = ::Delayed::PerformableMethod.new(@model, :to_s, [])
-    end
     it "should look up document" do
+      method = ::Delayed::PerformableMethod.new(@model, :to_s, [])
       TestModel.should_receive(:find).with(@model._id.to_s).and_return(@model)
-      @method.perform
+      method.perform
     end
     it "should do nothing if document not found" do
+      method = ::Delayed::PerformableMethod.new(@model, :to_s, [])
       error = ::Mongoid::Errors::DocumentNotFound.new(TestModel, @model._id)
       TestModel.should_receive(:find).with(@model._id.to_s).and_raise(error)
-      @method.perform.should be_true
+      method.perform.should be_true
+    end
+    it "should find embedded document" do
+      child = ChildModel.new(:_id => ::BSON::ObjectId.new)
+      @model.child_models << child
+      method = ::Delayed::PerformableMethod.new(child, :to_s, [])
+      TestModel.should_receive(:find).with(@model._id.to_s).and_return(@model)
+      method.perform
     end
   end
   
   context "display_name" do
     it "should return underlying class when a stub is being used" do
-      @method = ::Delayed::PerformableMethod.new(@model, :to_s, [])
-      @method.display_name.should == "TestModel[#{@model._id}]#to_s"
+      method = ::Delayed::PerformableMethod.new(@model, :to_s, [])
+      method.display_name.should == "TestModel[#{@model._id}]#to_s"
     end
     it "should return usual name when no stub is involved" do
-      @method = ::Delayed::PerformableMethod.new(:test, :to_s, [])
-      @method.display_name.should == "Symbol#to_s"
+      method = ::Delayed::PerformableMethod.new(:test, :to_s, [])
+      method.display_name.should == "Symbol#to_s"
+    end
+    it "should include selector when document is embedded" do
+      child = ChildModel.new(:_id => ::BSON::ObjectId.new)
+      @model.child_models << child
+      method = ::Delayed::PerformableMethod.new(child, :to_s, [])
+      method.display_name.should == "TestModel[#{@model._id}].child_models.find(\"#{child._id}\")#to_s"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_shallow_mongoid
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayed_job
-  requirement: &2157589320 !ruby/object:Gem::Requirement
+  requirement: &2168767700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *2157589320
+  version_requirements: *2168767700
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2157588680 !ruby/object:Gem::Requirement
+  requirement: &2168767040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2157588680
+  version_requirements: *2168767040
 - !ruby/object:Gem::Dependency
   name: actionmailer
-  requirement: &2157588060 !ruby/object:Gem::Requirement
+  requirement: &2168766380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157588060
+  version_requirements: *2168766380
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2157587500 !ruby/object:Gem::Requirement
+  requirement: &2168765780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157587500
+  version_requirements: *2168765780
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2157586840 !ruby/object:Gem::Requirement
+  requirement: &2168765040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2157586840
+  version_requirements: *2168765040
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2157586280 !ruby/object:Gem::Requirement
+  requirement: &2168764440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2157586280
+  version_requirements: *2168764440
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157585740 !ruby/object:Gem::Requirement
+  requirement: &2168763800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157585740
+  version_requirements: *2168763800
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2157585060 !ruby/object:Gem::Requirement
+  requirement: &2168763160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157585060
+  version_requirements: *2168763160
 description: When the object or arg to a delayed_job is a Mongoid document, store
   only a small stub of the object instead of the full serialization.
 email: joey@aghion.com
@@ -138,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3402765443251860913
+      hash: 265545571011826092
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: