wresque_wrapper 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "resque", "~> 1.10.0"
+gem "rails", ">= 2.1.0"
+
+group :development do
+  gem "rspec", ">= 2.0.0"
+  gem "mocha", "~> 0.9.10"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,109 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.7)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mocha (0.9.10)
+      rake
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    redis (2.1.1)
+    redis-namespace (0.8.0)
+      redis (< 3.0.0)
+    resque (1.10.0)
+      json (~> 1.4.6)
+      redis-namespace (~> 0.8.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    sinatra (1.1.2)
+      rack (~> 1.1)
+      tilt (~> 1.2)
+    thor (0.14.6)
+    tilt (1.2.2)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  mocha (~> 0.9.10)
+  rails (>= 2.1.0)
+  rcov
+  resque (~> 1.10.0)
+  rspec (>= 2.0.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Simon Coffey
+
+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,23 @@
+= wresque_wrapper
+
+A simple wrapper to allow inline queueing of arbitrary methods to Resque, e.g.:
+
+  MyClass.delay(:queue => :bigjobs).some_class_method
+
+  my_instance.delay(:queue => :jobsworth).some_instance_method
+
+== Contributing to wresque_wrapper
+ 
+* 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 Tribesports Ltd. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+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 = "wresque_wrapper"
+  gem.homepage = "http://github.com/simon@urbanautomaton.com/wresque_wrapper"
+  gem.license = "MIT"
+  gem.summary = %Q{Async-style queueing of class methods using Resque}
+  gem.description = %Q{Allows queueing of model methods, e.g. MyModel.delay.some_method}
+  gem.email = "simon@tribesports.com"
+  gem.authors = ["Simon Coffey"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_runtime_dependency 'resque', '~> 1.10.0'
+  gem.add_runtime_dependency 'rails', '>= 2.1.0'
+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
+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 = "wresque_wrapper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,3 @@
+require 'wresque_wrapper'
+
+ActiveRecord::Base.extend(WresqueWrapper)

data/lib/wresque_wrapper.rb

@@ -0,0 +1,66 @@
+module WresqueWrapper
+  def self.extended(base)
+    base.extend(ClassMethods)
+    base.send(:include, InstanceMethods)
+  end
+
+  module ClassMethods
+    def queue; @queue; end
+    def queue=(queue); @queue = queue; end
+
+    def default_queue; @default_queue; end
+    def default_queue=(queue); @default_queue = queue; end
+
+    def default_worker_queue(queue)
+      @default_queue = queue
+    end
+
+    def perform(id, method, *args)
+      ActiveRecord::Base.verify_active_connections!
+      if id
+        self.find(id).send(method, *args)
+      else
+        self.send(method, *args)
+      end
+    end
+
+    def delay(opts={})
+      WresqueWrapper::WrapperProxies::Proxy.new(self,self,nil,opts[:queue])
+    end
+  end
+
+  module InstanceMethods
+    def delay(opts={})
+      WresqueWrapper::WrapperProxies::Proxy.new(self,self.class,self.id,opts[:queue])
+    end
+  end
+
+  module WrapperProxies
+    class Proxy
+      attr_reader :target
+
+      def initialize(target,klass,target_id,queue)
+        queue ||= klass.default_queue
+        unless queue
+          raise RuntimeError, "No queue specified, and target class has no default queue", caller
+        end
+        @target = target
+        @klass = klass
+        @target_id = target_id
+        @klass.queue = queue
+      end
+
+      def method_missing(method,*args)
+        if @target.respond_to?(method)
+          Resque.enqueue(@target,@target_id,method,*args)
+        else
+          @target.send(method,*args)
+        end
+      end
+
+      def respond_to?(method)
+        super || @target.respond_to?(method)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

data/spec/wresque_wrapper_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+require 'wresque_wrapper'
+
+describe WresqueWrapper do
+
+  before(:all) do
+    module ActiveRecord
+      class Base; end
+    end
+  end
+
+  before(:each) do
+    class DummyClass
+      extend WresqueWrapper
+      default_worker_queue :dummy_queue
+      def id; 1; end
+    end
+
+    ActiveRecord::Base.stubs(:verify_active_connections!).returns(true)
+
+    @dummy = DummyClass.new
+  end
+
+  describe "Class methods" do
+    describe ".extended" do
+      it "should add accessors" do
+        DummyClass.should respond_to :queue
+        DummyClass.should respond_to :default_queue
+      end
+
+      it "should add the instance methods" do
+        @dummy.should respond_to :delay
+      end
+    end
+
+    describe ".default_worker_queue" do
+      it "should set the default queue" do
+        DummyClass.default_worker_queue(:dummier_queue)
+        DummyClass.default_queue.should eql :dummier_queue
+      end
+    end
+
+    describe ".perform" do
+      it "should send the method to an instance if given an id" do
+        test_method = :test_method
+        test_args = [1,2,3]
+        DummyClass.expects(:find).once.returns(@dummy)
+        @dummy.expects(:send).with(test_method,*test_args).once.returns(true)
+        DummyClass.perform(1,test_method,*test_args)
+      end
+
+      it "should send the method to the class if no id is given" do
+        test_method = :test_method
+        test_args = [1,2,3]
+        DummyClass.expects(:send).with(test_method,*test_args).once.returns(true)
+        DummyClass.perform(nil,test_method,*test_args)
+      end
+    end
+
+    describe ".delay" do
+      it "should return the appropriate proxy object" do
+        DummyClass.delay.class.should eql WresqueWrapper::WrapperProxies::Proxy
+      end
+
+      it "should raise an exception if no queue is set" do
+        DummyClass.default_queue = nil
+        lambda { DummyClass.delay }.should raise_error
+      end
+    end
+  end
+
+  describe "Instance methods" do
+    describe "#delay" do
+      it "should return the appropriate proxy object" do
+        @dummy.delay.class.should eql WresqueWrapper::WrapperProxies::Proxy
+      end
+
+      it "should raise an exception if no queue is set" do
+        DummyClass.default_queue = nil
+        lambda { @dummy.delay }.should raise_error
+      end
+    end
+  end
+
+  describe WresqueWrapper::WrapperProxies do
+    describe "Proxy for Class" do
+      before(:each) do
+        @class_proxy = WresqueWrapper::WrapperProxies::Proxy.new(DummyClass,
+                                                                 DummyClass,
+                                                                 nil,
+                                                                 :new_queue)
+      end
+
+      describe "#initialize" do
+        it "should set the target class's queue" do
+          DummyClass.queue.should eql :new_queue
+        end
+
+        it "should retain the target class" do
+          @class_proxy.target.should eql DummyClass
+        end
+      end
+
+      describe "#method_missing" do
+      end
+
+      describe "#respond_to?" do
+      end
+    end
+
+    describe "Proxy for instance" do
+      before(:each) do
+        @instance_proxy = WresqueWrapper::WrapperProxies::Proxy.new(@dummy,
+                                                                    @dummy.class,
+                                                                    @dummy.id,
+                                                                    :new_queue)
+      end
+
+      describe "#initialize" do
+        it "should set the target class's queue" do
+          DummyClass.queue.should eql :new_queue
+        end
+
+        it "should retain the target instance" do
+          @instance_proxy.target.should eql @dummy
+        end
+      end
+
+      describe "#method_missing" do
+      end
+
+      describe "#respond_to?" do
+      end
+    end
+  end
+
+end

data/wresque_wrapper.gemspec

@@ -0,0 +1,79 @@
+# 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 = %q{wresque_wrapper}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Simon Coffey"]
+  s.date = %q{2011-02-02}
+  s.description = %q{Allows queueing of model methods, e.g. MyModel.delay.some_method}
+  s.email = %q{simon@tribesports.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lib/wresque_wrapper.rb",
+    "spec/spec_helper.rb",
+    "spec/wresque_wrapper_spec.rb",
+    "wresque_wrapper.gemspec"
+  ]
+  s.homepage = %q{http://github.com/simon@urbanautomaton.com/wresque_wrapper}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{Async-style queueing of class methods using Resque}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/wresque_wrapper_spec.rb"
+  ]
+
+  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<resque>, ["~> 1.10.0"])
+      s.add_runtime_dependency(%q<rails>, [">= 2.1.0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.10"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<resque>, ["~> 1.10.0"])
+      s.add_runtime_dependency(%q<rails>, [">= 2.1.0"])
+    else
+      s.add_dependency(%q<resque>, ["~> 1.10.0"])
+      s.add_dependency(%q<rails>, [">= 2.1.0"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.10"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<resque>, ["~> 1.10.0"])
+      s.add_dependency(%q<rails>, [">= 2.1.0"])
+    end
+  else
+    s.add_dependency(%q<resque>, ["~> 1.10.0"])
+    s.add_dependency(%q<rails>, [">= 2.1.0"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.10"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<resque>, ["~> 1.10.0"])
+    s.add_dependency(%q<rails>, [">= 2.1.0"])
+  end
+end
+

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: wresque_wrapper
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Simon Coffey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-02 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: resque
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id009
+description: Allows queueing of model methods, e.g. MyModel.delay.some_method
+email: simon@tribesports.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/wresque_wrapper.rb
+- spec/spec_helper.rb
+- spec/wresque_wrapper_spec.rb
+- wresque_wrapper.gemspec
+has_rdoc: true
+homepage: http://github.com/simon@urbanautomaton.com/wresque_wrapper
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -708839286159703456
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Async-style queueing of class methods using Resque
+test_files: 
+- spec/spec_helper.rb
+- spec/wresque_wrapper_spec.rb