acts_as_async 0.1.0 → 0.2.0

data/LICENSE

@@ -1,20 +1,7 @@
-Copyright (c) Brendan Loudermilk
+Copyright (c) 2011 Brendan Loudermilk
 
-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:
+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 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.
+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

@@ -1,3 +1,122 @@
-# Async Record!
+# ActsAsAsync
 
-It's pretty cool
+ActsAsAsync is an ActiveRecord extension that provides your models with
+easy-to-use Resque helpers.
+
+
+## Installation
+
+Installing ActsAsAsync is as simple as adding it to your Gemfile:
+
+    $ cat Gemfile
+    ...
+    gem "acts_as_async"
+    ...
+
+
+## Usage
+
+ActsAsAsync aims to be as simple as possible to use. Including it in your model
+is as easy as:
+
+    class Post < ActiveRecord::Base
+      acts_as_async
+    end
+
+### Basic usage
+
+ActsAsAsync adds three instance methods to your model that you can use to async
+any other instance method:
+
+    post = Post.create(:body => "Wow, acts_as_async is neat!")
+
+    # Self-destruct as soon as possible
+    post.async(:destroy)
+
+    # Self-destruct at this time tomorrow
+    post.async_at(Time.now + 1.day, :destroy)
+
+    # Self-destruct in 10 minutes
+    post.async_in(10.minutes, :destroy)
+
+It also adds three identical class methods:
+
+    Post.async(:destroy_all)
+    Post.async_at(1.day.from_now, :destroy_all)
+    Post.async_in(10.minutes, :destroy_all)
+
+### Dynamic methods
+
+In addition to the helper methods above, ActsAsAsync supports dynamic methods
+for any existing method on your model. For example:
+
+    class Audiobook < ActiveRecord::Base
+      acts_as_async
+
+      def transcribe
+        # Some long-running logic here
+      end
+
+      def read!
+        # Computers like to read too!
+      end
+
+      def paint(color)
+        # I don't know why you'd paint a book...
+      end
+    end
+
+    book = Audiobook.first
+
+	# Transcribe the book as soon as possible
+    book.async_transcribe
+
+    # Read the book at this time tomorrow
+    book.async_read_at!(Time.now + 1.day)
+
+    # Paint the book blue in a couple years
+    book.async_paint_in(2.years, "blue")
+
+### Additional notes
+
+  * You can pass any number of additional arguments to async'd methods so long
+    as they can be serialized into JSON
+  * Adding acts_as_async to your Gemfile automatically loads both Resque and
+    Resque-scheduler's rake tasks. This means you can use both 
+    `$ rake resque:work` and `$ rake resque:scheduler` right out of the box.
+  * By deafult, each model will add tasks to a queue named "default". You can
+	pass the `:queue` option to `acts_as_async` to specify a different queue.
+  * Dynamic methods support names with exclamation points but not question
+    marks. This was a design decision to discourage misuse of the question mark
+    in method names. If you absolutely must async a method with a question mark,
+    just use one of the `async :method` helpers.
+
+
+## Everything else...
+
+ActsAsAsync is simply a thin layer on top of [Resque][resque] and 
+[Resque-scheduler][resque_scheduler]. To learn how to configure your redis
+connection, run workers, view the web interface, and more visit their home
+pages.
+
+[resque]: https://github.com/defunkt/resque
+[resque_scheduler]: https://github.com/bvandenbos/resque-scheduler
+
+
+## Compatibility
+
+ActsAsAsync is tested against the same Rubies as Resque: Ruby 1.8.7, 1.9.2,
+Rubinius 2.0, and JRuby.
+
+**Adding better test coverage is top priority at the moment. Don't be shy, issue
+a pull request with your tests.**
+
+![Build Status](https://secure.travis-ci.org/bloudermilk/acts_as_async.png?branch=master&.png)
+
+[Build History](http://travis-ci.org/mongoid/mongoid)
+
+
+## License
+
+ActsAsAsync is released under the MIT license. See the LICENSE file for more
+info.

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler"
+Bundler.setup
+
+require "rake"
+require "rspec"
+require "rspec/core/rake_task"
+
+lib_path = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include? lib_path
+
+require "acts_as_async/version"
+
+RSpec::Core::RakeTask.new("spec")
+task :default => :spec
+
+task :build do
+  system "gem build acts_as_async.gemspec"
+end
+
+task :install => :build do
+  system "sudo gem install acts_as_async-#{ActsAsAsync::VERSION}.gem"
+end
+

data/lib/acts_as_async/base_extensions.rb

@@ -4,12 +4,12 @@ module ActsAsAsync
 
     module ClassMethods
       def acts_as_async(opts={})
-        # Make the default queue for this class "default"
-        opts.reverse_merge!(queue: :default)
-
-        # Set the queue unless one is already set
-        unless instance_variable_defined?(:@queue)
+        # Set the queue to the passed option
+        if opts[:queue]
           instance_variable_set(:@queue, opts[:queue])
+        # If no option was passed and there isn't a queue defined, use "default"
+        elsif !instance_variable_defined?(:@queue)
+          instance_variable_set(:@queue, :default)
         end
 
         include ActsAsAsync::Helper

data/lib/acts_as_async/helper.rb

@@ -2,6 +2,11 @@ module ActsAsAsync
   module Helper
     extend ActiveSupport::Concern
 
+    included do
+      include SharedMethods
+      extend SharedMethods
+    end
+
     module ClassMethods
       # Args will be an optional ID, a method name and optional arguments
       def perform(*args)
@@ -17,7 +22,7 @@ module ActsAsAsync
           method = args.shift
         end
 
-        receiver.send(method, *args)
+        receiver.__send__(method, *args)
       end
 
       def async(method, *args)
@@ -46,5 +51,47 @@ module ActsAsAsync
         Resque.enqueue_in(time, self.class, id, method, *args)
       end
     end
+
+    module SharedMethods
+      METHOD_REGEXP = /\Aasync_([a-zA-Z]\w*?)(_at|_in)?(!)?\z/
+
+      def method_missing(method_id, *args, &block)
+        if method_id =~ METHOD_REGEXP
+          # Compose the method to be async'd, with an optional bang
+          method = "#{$1}#{$3}"
+
+          if respond_to? method
+            # If we're not using the _at or _in methods, just call async
+            if $2.nil?
+              __send__(:async, method, *args)
+
+            # Otherwise compose the Helper method
+            else
+              __send__("async#{$2}", args.shift, method, *args)
+            end
+          else
+            message = "Tried to async the method #{method} but it isn't defined."
+            raise NoMethodError, message
+          end
+        else
+          super
+        end
+      end
+
+      # Use respond_to_missing? on newer Ruby versions but fall back to
+      # overriding respond_to? on older versions. In both cases, return
+      # true for any match, even if the method to be async'd doesn't 
+      # exist, since technically we do respond to that method but throw
+      # an exception.
+      if RUBY_VERSION >= "1.9.2"
+        def respond_to_missing?(method_id, *)
+          method_id =~ METHOD_REGEXP || super
+        end
+      else
+        def respond_to?(method_id, *)
+          method_id =~ METHOD_REGEXP || super
+        end
+      end
+    end
   end
 end

data/lib/acts_as_async/version.rb

@@ -1,3 +1,3 @@
 module ActsAsAsync
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/acts_as_async.rb

@@ -1,3 +1,7 @@
+require "active_support/concern"
+
+require "active_record"
+
 require "resque"
 require "resque_scheduler"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_async
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-21 00:00:00.000000000Z
+date: 2011-10-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70318317253520 !ruby/object:Gem::Requirement
+  requirement: &70184556181300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70318317253520
+  version_requirements: *70184556181300
 - !ruby/object:Gem::Dependency
   name: resque-scheduler
-  requirement: &70318317253100 !ruby/object:Gem::Requirement
+  requirement: &70184556180800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70318317253100
+  version_requirements: *70184556180800
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70184556180220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70184556180220
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70318317252680 !ruby/object:Gem::Requirement
+  requirement: &70184556179620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,29 +54,27 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70318317252680
-description: ! '    This gem is so crazy you won''t believe.
-
-'
-email: brendan@gophilosophie.com
+  version_requirements: *70184556179620
+description: ActsAsAsync is an ActiveRecord extension that provides your models with
+  easy-to-use Resque helpers.
+email:
+- brendan@gophilosophie.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.md
+extra_rdoc_files: []
 files:
-- README.md
-- LICENSE
 - lib/acts_as_async/base_extensions.rb
 - lib/acts_as_async/helper.rb
 - lib/acts_as_async/railtie.rb
 - lib/acts_as_async/version.rb
 - lib/acts_as_async.rb
+- LICENSE
+- Rakefile
+- README.md
 homepage: http://github.com/bloudermilk/acts_as_async
 licenses: []
 post_install_message: 
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -74,16 +83,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4440450066479930508
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4440450066479930508
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Acts As Async is a Resque-backed ActiveRecord delayed job tool
+summary: The marriage of ActiveRecord and Resque.
 test_files: []