perform_later 1.0 → 1.0.1

data/.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 pkg/*
 .tags
 .tags_sorted_by_file
+coverage/*

data/README.md

@@ -3,11 +3,11 @@
 ## Overview
 Perform later is a gem meant to work with the [Resque](http://github.com/defunkt/resque) queue system.
 
-The gem handles queuing tasks without the need to have additional "Worker" classes.
+Usually, when working with Resque, you need separate "Worker" classes and you also need to do `Resque.enqueue` whenever you want to add a task to the queue.
 
-The gem will "translate" objects to a serializable (suitable for JSON) versions of those classes.
+That can be a real hassle if you are adding Resque to an existing project, it can also add quite a bit of code to your system.
 
-The Gem also support a workflow similar to `async_method`, meaning you can just call method on your objects and configure those methods to be queued by default. No worries, you can always call the method in `now` mode, which will execute the method in sync.
+`perform_later` fills this need, it offers a suite to handle all of your queuing needs, both for Objects and for ActiveRecord models.
 
 ## Why?
 *Why* should you queue something for later?
@@ -17,55 +17,120 @@ You should queue something whenever the method handles some heavy lifting, some
 The basic logic is that whatever you don't need to do NOW, you should do later, this will make your site faster and the users will feel it.
 
 ## Real life use case
-At [Gogobot](http://gogobot.com) whenever you post a review, there's major score calculation going on, this can take 20-30 seconds sometimes.
+At [Gogobot](http://gogobot.com) whenever you post a review, there's major score calculation going on. This can sometimes take up to a minute, depending on the user graph.
 
 The user should not wait for this on submit, it can be queued into later execution.
 
-### Usage
-You can call the `perform_later` method on any object or active record instance
+## Installation
+gem install perform_later
 
-the `perform_later` method has 3 params
+If you are using bundler, simply add
+`gem "perform_later"` to your Gemfile
+
+
+## Configuration
+You can configure `perform_later` exactly as you configure your rails app.
+
+Inside your `#{env}.rb` file (for example development.rb)
 
 ```ruby
-:queue_name #The queue in which this task will be in
-:method_name #the method that will be called on the object
-args #array of arguments
+config.later.enabled = true # this will default to false if unset
 ```
 
-### Samples
+## Usage
+
+### ActiveRecord
+
+`perform_later` comes with a special method you can use on ActiveRecord models.
+
+
+```ruby
+
+	class User < ActiveRecord::Base
+	  def long_running_method
+	    # Your code here
+	  end
+	  later :long_running_method
+	
+	  def long_running_method_2
+	    # Your code here
+	  end
+	  later :long_running_method_2, queue: :some_queue_name
+	
+	  def lonely_long_running_method
+	    # Your code here
+	  end
+	  later :lonely_long_running_method, :loner => true, queue: :some_queue_name
+	end
+	
+```
 
 ```ruby
-@user = User.find(1)
-@user.perform_later(:queue_name, :method_name, args)
+	u = User.find(some_user_id)
+	u.long_running_method # Method will be queued into the :generic queue
+	u.long_running_method_2 # Method will be queued into :some_queue_name queue
+	u.lonely_long_running_method # Method will be queued into the :some_queue_name queue, only a single instance of this method can exist in the queue.
 ```
 
-You can also call objects on the User object itself
+You can of course choose to run the method off the queue, just prepend `now_` to the method name and it will be executed in sync.
 
 ```ruby
-User.perform_later(:queue_name, :method_name, args)
+	u = User.find(some_user_id)
+	u.now_long_running_method
 ```
 
+### Objects/Classes
 
+If you want object methods to be queued, you will have to use the `perform_later` special method.
 
-## Configuration
-You can configure `perform_later` exactly as you configure your rails app.
+```ruby
+	class SomeClass
+		def some_heavy_lifting_method
+	  	  # Your code here
+	  	end
+	  	
+		def some_more_heavy_lifting(user_id)
+	  	  # Your code here
+	  	end  	
+	end
+	
+	SomeClass.perform_later(:queue_name, :some_heavy_lifting_method)
+	SomeClass.perform_later(:queue_name, :some_more_heavy_lifting, user_id)
+```
 
-Inside your `#{env}.rb` file (for example development.rb)
+## The params parser
+`perform_later` has a special class called `ArgsParser`, this class is in charge of *translating* the args you are passing into params that can actually be serialized to JSON cleanly.
+
+Examples:
 
 ```ruby
-config.perform_later.enabled = false # this will default to true if unset
+	user = User.find(1)
+	PerformLater::ArgsParser.params_to_resque(user) => 'AR:#User:1'
+	
+	hotel = Hotel.find(1)
+	PerformLater::ArgsParser.params_to_resque(hotel) => 'AR:#Hotel:1'
+	
+	hash = { name: "something", other: "something else" }
+	PerformLater::ArgsParser.params_to_resque(hash) 
+	=> ---
+		:name: something
+		:other: something else
+	# Hashes are translated into YAML
 ```
 
-## What happens in test when it's disabled
-In test mode, the method is not queued, it's being sent immediately on the object, this way your test work completely normal and you don't need to worry about Resque or Redis in your tests, this is very useful
- 
+Basically, the `ArgsParser` class allows you to keep passing any args you want to your methods without worrying about whether they serialize cleanly or not.
+
+`ArgsParser` also patched `resque-mailer` so you can pass in AR objects to mailers as well.
 
+ 
 ## Contribute / Bug reports
+
 If you have an issue with this gem, please open an issue in the main repo, it will help tons if you could supply a failing spec with that, so I can better track where the bug is coming from, if not, no worries, just report I will do my best to address it as fast and efficient as I can.
 
 If you want to contribute (awesome), open a feature branch, base it on master.
 
 Be as descriptive as you can in the pull request description, just to be clear what problem you are solving or what feature are you adding.
 
-## TODO
-1. Add the ability to perform_later without a queue provided (will go to a default queue - configurable)
+## Author
+
+Avi Tzurel ([@kensodev](http://twitter.com/kensodev)) http://www.kensodev.com

data/lib/object_perform_later.rb

@@ -1,12 +1,15 @@
 module ObjectPerformLater
+
   def perform_later(queue, method, *args)
     if PerformLater.config.enabled?
       args = PerformLater::ArgsParser.args_to_resque(args)
-      Resque::Job.create(queue, ObjectWorker, self.name, method, *args)
+      Resque::Job.create(queue, PerformLater::Workers::Objects::Worker, self.name, method, *args)
     else
       self.send(method, *args)
     end
   end
+
 end
 
-Object.send :include, ObjectPerformLater
+Object.send(:include, ObjectPerformLater)
+

data/lib/perform_later/railtie.rb

@@ -1,5 +1,5 @@
 module PerformLater
   class Railtie < ::Rails::Railtie
-    config.perform_later = PerformLater::Config
+    config.later = PerformLater::Config
   end
 end

data/lib/perform_later/version.rb

@@ -1,3 +1,3 @@
 module PerformLater
-  VERSION = "1.0"
+  VERSION = "1.0.1"
 end

data/lib/perform_later.rb

@@ -6,10 +6,11 @@ require 'resque-loner'
 require 'perform_later/args_parser'
 require 'active_record'
 require 'resque_mailer_patch'
-require 'object_worker'
 require 'object_perform_later'
 require 'perform_later/workers/active_record/worker'
 require 'perform_later/workers/active_record/lone_worker'
+require 'perform_later/workers/objects/worker'
+require 'perform_later/workers/objects/lone_worker'
 
 module PerformLater
   def self.config
@@ -27,6 +28,4 @@ end
 
 ActiveSupport.on_load(:active_record) do
   include Resque::Plugins::Later::Method
-end
-
-
+end

data/perform_later.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'spork-rails'
   s.add_development_dependency 'fakeredis'
+  s.add_development_dependency 'simplecov'
 end

data/spec/lib/perform_later/config_spec.rb

@@ -1,4 +1,4 @@
-require 'perform_later/config'
+require 'spec_helper'
 
 describe PerformLater::Config do
   before(:each) { PerformLater.config.enabled = false }

data/spec/lib/resque/plugins/later/method_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'perform_later'
 
 describe Resque::Plugins::Later::Method do
   before(:each) { PerformLater.config.enabled = true }

data/spec/spec_helper.rb

@@ -6,8 +6,9 @@ require "support/database_connection"
 require "support/database_models"
 require "redis"
 require 'fakeredis/rspec'
+require 'simplecov'
 
-
+SimpleCov.start
 
 RSpec.configure do |config|
   config.mock_with :rspec

data/spec/support/database_models.rb

@@ -1,15 +1,16 @@
 class User < ActiveRecord::Base
   def long_running_method
-    true
+    # Your code here
   end
   later :long_running_method
 
-  def lonely_long_running_method
-    true
+  def long_running_method_2
+    # Your code here
   end
-  later :lonely_long_running_method, :loner => true
+  later :long_running_method_2, queue: :some_queue_name
 
-  def self.get_metadata
-    {}
+  def lonely_long_running_method
+    # Your code here
   end
+  later :lonely_long_running_method, :loner => true, queue: :some_queue_name
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perform_later
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -171,6 +171,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Queue any method in any class or instance with no need for additional
   Worker class and no extra code
 email:
@@ -187,7 +203,6 @@ files:
 - Rakefile
 - init.rb
 - lib/object_perform_later.rb
-- lib/object_worker.rb
 - lib/perform_later.rb
 - lib/perform_later/args_parser.rb
 - lib/perform_later/config.rb

data/lib/object_worker.rb

@@ -1,12 +0,0 @@
-class ObjectWorker
-  # Public: perform.
-  #
-  # klass_name - name of the class (string).
-  # method - method name, this method will be called on the object.
-  # *args - array of arguments to send to the method
-  #
-  def self.perform(klass_name, method, *args)
-    args = PerformLater::ArgsParser.args_from_resque(args)
-    klass_name.constantize.send(method, *args)
-  end
-end