delayed_job_shallow_mongoid 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'actionmailer'
+gem "delayed_job_mongoid", :git => "https://github.com/collectiveidea/delayed_job_mongoid.git"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'rspec'
+  gem "ruby-debug19"
+end

data/Gemfile.lock

@@ -0,0 +1,113 @@
+GIT
+  remote: https://github.com/collectiveidea/delayed_job_mongoid.git
+  revision: 83a8dc6c56c78ee8c528bd03e8a4cfb3c0e6f4e3
+  specs:
+    delayed_job_mongoid (1.0.6)
+      delayed_job (= 3.0.0.pre4)
+      mongoid (>= 2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.3)
+      actionpack (= 3.1.3)
+      mail (~> 2.3.0)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    archive-tar-minitar (0.5.2)
+    bson (1.4.0)
+    builder (3.0.0)
+    columnize (0.3.5)
+    daemons (1.0.10)
+    delayed_job (3.0.0.pre4)
+      activesupport (~> 3.0)
+      daemons (= 1.0.10)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    mongo (1.4.0)
+      bson (= 1.4.0)
+    mongoid (2.3.4)
+      activemodel (~> 3.1)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    multi_json (1.0.4)
+    polyglot (0.3.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    shoulda (2.11.3)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionmailer
+  bundler (~> 1.0.0)
+  delayed_job_mongoid!
+  jeweler (~> 1.6.4)
+  rcov
+  rspec
+  ruby-debug19
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Joey Aghion
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= delayed_job_shallow_mongoid
+
+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.
+
+== Contributing to delayed_job_shallow_mongoid
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Joey Aghion. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "delayed_job_shallow_mongoid"
+  gem.homepage = "http://github.com/jaghion/delayed_job_shallow_mongoid"
+  gem.license = "MIT"
+  gem.summary = %Q{More efficient Mongoid document serialization for delayed_job.}
+  gem.description = %Q{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.}
+  gem.email = "joey@aghion.com"
+  gem.authors = ["Joey Aghion"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "delayed_job_shallow_mongoid #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/delayed_job_shallow_mongoid.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "delayed_job_shallow_mongoid"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joey Aghion"]
+  s.date = "2011-11-29"
+  s.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."
+  s.email = "joey@aghion.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "delayed_job_shallow_mongoid.gemspec",
+    "lib/delayed/performable_mailer.rb",
+    "lib/delayed/performable_method.rb",
+    "lib/delayed/shallow_mongoid.rb",
+    "lib/delayed/shallow_mongoid/document_stub.rb",
+    "lib/delayed_job_shallow_mongoid.rb",
+    "spec/delayed_job_shallow_mongoid_spec.rb",
+    "spec/spec_helper.rb",
+    "test/helper.rb",
+    "test/test_delayed_job_shallow_mongoid.rb"
+  ]
+  s.homepage = "http://github.com/jaghion/delayed_job_shallow_mongoid"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "More efficient Mongoid document serialization for delayed_job."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<actionmailer>, [">= 0"])
+      s.add_runtime_dependency(%q<delayed_job_mongoid>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+    else
+      s.add_dependency(%q<actionmailer>, [">= 0"])
+      s.add_dependency(%q<delayed_job_mongoid>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<actionmailer>, [">= 0"])
+    s.add_dependency(%q<delayed_job_mongoid>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+  end
+end
+

data/lib/delayed/performable_mailer.rb

@@ -0,0 +1,7 @@
+module Delayed
+  class PerformableMailer
+    def perform
+      ShallowMongoid.load(object).send(method_name, *args.map{|a| ShallowMongoid.load(a) }).deliver
+    end
+  end
+end

data/lib/delayed/performable_method.rb

@@ -0,0 +1,17 @@
+module Delayed
+  class PerformableMethod
+    def initialize(object, method_name, args)
+      raise NoMethodError, "undefined method `#{method_name}' for #{object.inspect}" unless object.respond_to?(method_name, true)
+
+      self.object       = ShallowMongoid.dump(object)
+      self.args         = args.map{|a| ShallowMongoid.dump(a) }
+      self.method_name  = method_name.to_sym
+    end
+    
+    def perform
+      ShallowMongoid.load(object).send(method_name, *args.map{|a| ShallowMongoid.load(a) })
+    rescue Mongoid::Errors::DocumentNotFound
+      true  # do nothing if document has been removed
+    end
+  end
+end

data/lib/delayed/shallow_mongoid/document_stub.rb

@@ -0,0 +1,4 @@
+module Delayed::ShallowMongoid
+  class DocumentStub < Struct.new(:klass, :id)
+  end
+end

data/lib/delayed/shallow_mongoid.rb

@@ -0,0 +1,19 @@
+module Delayed
+  module ShallowMongoid
+    def self.dump(arg)
+      if arg.is_a?(::Mongoid::Document)
+        ShallowMongoid::DocumentStub.new(arg.class, arg._id.to_s)
+      else
+        arg
+      end
+    end
+  
+    def self.load(arg)
+      if arg.is_a?(ShallowMongoid::DocumentStub)
+        arg.klass.find(arg.id)
+      else
+        arg
+      end
+    end
+  end
+end

data/lib/delayed_job_shallow_mongoid.rb

@@ -0,0 +1,5 @@
+require 'delayed_job'
+require File.dirname(__FILE__) + '/delayed/shallow_mongoid'
+require File.dirname(__FILE__) + '/delayed/shallow_mongoid/document_stub'
+require File.dirname(__FILE__) + '/delayed/performable_method'
+require File.dirname(__FILE__) + '/delayed/performable_mailer'

data/spec/delayed_job_shallow_mongoid_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+class TestModel
+  include ::Mongoid::Document
+end
+
+describe Delayed::ShallowMongoid::DocumentStub do
+  before(:each) do
+    @shallow = Delayed::ShallowMongoid::DocumentStub.new(TestModel, 111)
+  end
+  it "should have a klass" do
+    @shallow.klass.should == TestModel
+  end
+  it "should have an id" do
+    @shallow.id.should == 111
+  end
+end
+
+describe ::Delayed::PerformableMethod do
+  before(:each) do
+    @model = TestModel.new(:_id => ::BSON::ObjectId.new)
+  end
+
+  context 'when saving job' do
+    it "should transform object into shallow version" do
+      method = ::Delayed::PerformableMethod.new(@model, :to_s, [])
+      method.object.should be_a_kind_of(Delayed::ShallowMongoid::DocumentStub)
+      method.object.id.should == @model._id.to_s
+    end
+    it "should transform arg into shallow version" do
+      method = ::Delayed::PerformableMethod.new('test', :lines, [@model])
+      method.args.first.should be_a_kind_of(Delayed::ShallowMongoid::DocumentStub)
+      method.args.first.id.should == @model._id.to_s
+    end
+  end
+
+  context 'when running job' do
+    before(:each) do
+      @method = ::Delayed::PerformableMethod.new(@model, :to_s, [])
+    end
+    it "should look up document" do
+      TestModel.should_receive(:find).with(@model._id.to_s).and_return(@model)
+      @method.perform
+    end
+    it "should do nothing if document not found" do
+      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
+    end
+  end
+end
+
+describe ::Delayed::PerformableMailer do
+  before do
+    @model = TestModel.new(:_id => ::BSON::ObjectId.new)
+    @email = mock('email', :deliver => true)
+    @mailer_class = mock('MailerClass', :signup => @email)
+    @mailer = ::Delayed::PerformableMailer.new(@mailer_class, :signup, [@model])
+  end
+  it "should call the method and #deliver on the mailer" do
+    TestModel.should_receive(:find).with(@model._id.to_s).and_return(@model)
+    @mailer_class.should_receive(:signup).with(@model)
+    @email.should_receive(:deliver)
+    @mailer.perform
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'mail'
+require 'action_mailer'
+require 'delayed_job_mongoid'
+require 'delayed_job_shallow_mongoid'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'delayed_job_shallow_mongoid'
+
+class Test::Unit::TestCase
+end

data/test/test_delayed_job_shallow_mongoid.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestDelayedJobShallowMongoid < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: delayed_job_shallow_mongoid
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Joey Aghion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &2168634720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2168634720
+- !ruby/object:Gem::Dependency
+  name: delayed_job_mongoid
+  requirement: &2168632740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2168632740
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2168628960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168628960
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2168626360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2168626360
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2168624280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2168624280
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2168617660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168617660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2168616520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168616520
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &2168613960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168613960
+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
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- delayed_job_shallow_mongoid.gemspec
+- lib/delayed/performable_mailer.rb
+- lib/delayed/performable_method.rb
+- lib/delayed/shallow_mongoid.rb
+- lib/delayed/shallow_mongoid/document_stub.rb
+- lib/delayed_job_shallow_mongoid.rb
+- spec/delayed_job_shallow_mongoid_spec.rb
+- spec/spec_helper.rb
+- test/helper.rb
+- test/test_delayed_job_shallow_mongoid.rb
+homepage: http://github.com/jaghion/delayed_job_shallow_mongoid
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1287393219772870351
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: More efficient Mongoid document serialization for delayed_job.
+test_files: []