resque-async-method 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Nick Ragaz
+
+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.md

@@ -0,0 +1,50 @@
+Resque::Plugins::Async::Method
+==============================
+
+Make Active Record instance methods asynchronous using [resque](http://www.github.com/defunkt/resque).
+
+Works with Ruby ~> 1.9, Rails ~> 3 and Resque ~> 1.17. (Probably works with earlier versions too -- but why?)
+
+Usage
+-----
+
+    class User < ActiveRecord::Base
+      # Not needed! This is done using a hook on ActiveRecord::Base.
+      # include Resque::Plugins::Async::Method
+      
+      def preprocess_avatar_for_a_long_time
+        # do stuff
+      end
+      async_method :preprocess_avatar_for_a_long_time
+      
+      def send_a_very_long_email
+        # do stuff
+      end
+      async_method :send_a_very_long_email, queue: 'emails'
+    end
+    
+    u = User.find(1)
+    
+    u.preprocess_avatar_for_a_long_time # => queued in 'users' queue
+    u.send_a_very_long_email # => queued in 'emails' queue
+    u.sync_send_a_very_long_email # => happens right away!
+
+Note that in the test environment, none of this magic happens. You can test the expected output immediately.
+
+Method return values will change. `Resque.enqueue` will return `[]` from an async'ed method.
+
+Sometimes it's nice to async a method that you're including from a module:
+
+    module MyExtension
+      extend ActiveSupport::Concern
+      
+      include Resque::Plugins::Async::Method
+      
+      included do
+        async_method :generate_matrix, queue: 'matrices'
+      end
+      
+      def generate_matrix
+        # do stuff
+      end
+    end

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Resque::Plugins::Async::Method'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/resque-async-method.rb

@@ -0,0 +1,14 @@
+require 'active_support/dependencies'
+
+module Resque
+  module Plugins
+    module Async
+      autoload :Method, 'resque/plugins/async/method'
+      autoload :Worker, 'resque/plugins/async/worker'
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include Resque::Plugins::Async::Method
+end

data/lib/resque/plugins/async/method.rb

@@ -0,0 +1,29 @@
+require 'resque/plugins/async/worker'
+
+module Resque::Plugins::Async::Method
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def async_method(method_name, opts={})
+      # Allow tests to call sync_ methods ...
+      alias_method :"sync_#{method_name}", method_name
+    
+      # ... but don't actually make them asynchronous
+      return if Rails.env.test?
+    
+      define_method "#{method_name}" do |*args|
+        my_klass       = Resque::Plugins::Async::Worker
+        my_klass.queue = opts[:queue] ||
+                         send(:class).name.underscore.pluralize
+    
+        Resque.enqueue(
+          my_klass,
+          send(:class).name,
+          send(:id),
+          :"sync_#{method_name}",
+          *args
+        )
+      end
+    end
+  end
+end

data/lib/resque/plugins/async/worker.rb

@@ -0,0 +1,15 @@
+class Resque::Plugins::Async::Worker
+  @queue = :async_methods
+  
+  def self.queue=(name)
+    @queue = name
+  end
+  
+  def self.queue
+    @queue
+  end
+  
+  def self.perform(klass, *args)
+    klass.constantize.find(args.shift).send(args.shift, *args)
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: resque-async-method
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nick Ragaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-14 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &2161486000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161486000
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2161485560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161485560
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2161485140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161485140
+description: Make Active Record instance methods asynchronous using resque.
+email: nick.ragaz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/resque/plugins/async/method.rb
+- lib/resque/plugins/async/worker.rb
+- lib/resque-async-method.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: http://github.com/nragaz/resque-async-method
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Make Active Record instance methods asynchronous using resque.
+test_files: []