perform_later 0.0.2 → 0.0.3

data/README.md

@@ -5,9 +5,71 @@ Perform later is a gem meant to work with the [Resque](http://github.com/defunkt
 
 The gem handles queuing tasks without the need to have additional "Worker" classes or with any changes to your original model/object code base.
 
+The gem really simplifies queuing tasks, no need for extra workers and you may never need to change your code.
+
+The gem will "translate" objects to a serializable (suitable for json) versions of those classes.
+
+### Usage
+You can call the `perform_later` method on any object or active record instance
+
+the `perform_later` method has 3 params
+
+```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
+```
+
+### Samples
+
+```ruby
+@user = User.find(1)
+@user.perform_later(:queue_name, :method_name, args)
+```
+
+You can also call objects on the User object itself
+
+```ruby
+User.perform_later(:queue_name, :method_name, args)
+```
+
+## Configuration
+perform_later has a single configuration file, you should put the file in `config/resque_perform_later.yml`
+
+```ruby
+defaults: &DEFAULTS
+  enabled: true
+
+development:
+  <<: *DEFAULTS
+
+test:
+  enabled: false
+
+production:
+  <<: *DEFAULTS
+
+staging:
+  <<: *DEFAULTS
+```
+
+### Configuration explained
+The config is simple, either it's enabled or it's not, and you can set the environment which you want to enable in
+
+## 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
+ 
+
 ## 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.
+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)
+2. Add generator for the configuration file
+
+## Ideas
+1. Add the ability that a method will be tagged as "perform_later", this way you can call the method by name and it will be queued

data/lib/active_record_perform_later.rb

@@ -4,14 +4,14 @@ module ActiveRecordPerformLater
       if ResquePerformLater.config['enabled']
         args = ResquePerformLater.args_to_resque(args)
         
-        Resque::Job.create( queue,
-                            ActiveRecordWorker,
-                            self.class.name,
-                            self.id,
-                            method,
-                            *args)
+        Resque::Job.create(queue,
+          ActiveRecordWorker,
+          self.class.name,
+          self.id,
+          method,
+          *args)
       else
-        self.send( method, *args )
+        self.send(method, *args)
       end
     end
   end

data/lib/active_record_worker.rb

@@ -1,4 +1,10 @@
 class ActiveRecordWorker
+  # 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, id, method, *args)
 	  args = ResquePerformLater.args_from_resque(args)
 	  runner_klass = eval(klass)

data/lib/object_worker.rb

@@ -1,7 +1,10 @@
 class ObjectWorker
-  # @param klass_name [The class name that you should work on]
-  # @param method [method you should send on the class]
-  # @param args [method args]
+  # 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 = ResquePerformLater.args_from_resque(args)
     

data/lib/perform_later/version.rb

@@ -1,3 +1,3 @@
 module PerformLater
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/resque_perform_later.rb

@@ -6,7 +6,6 @@ class ResquePerformLater
   }
 
   # inspired by DelayedJob
-
   CLASS_STRING_FORMAT = /^CLASS\:([A-Z][\w\:]+)$/
   AR_STRING_FORMAT    = /^AR\:([A-Z][\w\:]+)\:(\d+)$/
   YAML_STRING_FORMAT  = /\A---/
@@ -58,9 +57,8 @@ class ResquePerformLater
     if File.exists?(DEFAULT_CONFIG_PATH)
       config = YAML.load(ERB.new(IO.read(DEFAULT_CONFIG_PATH)).result)[self.env_str]
     end
-
+    
     config = {}.merge(DEFAULT_CONFIG || {}).merge(config || {})
-
     @@_config = config
   end
 end

data/spec/lib/active_record_perform_later_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'resque'
+
+describe ActiveRecordPerformLater do
+  let(:user) { User.create }
+
+  let(:enabled) do
+    { 'enabled' => true } 
+  end
+  let(:disabled) do
+    { 'enabled' => false }
+  end
+
+  it "should insert a task into resque when the config is enabled" do
+    Resque.redis = $redis
+
+    ResquePerformLater.stub!(:config).and_return(enabled)
+    user.perform_later(:generic, :full_name)
+
+    Resque.peek(:generic, 0, 20).length.should == 1
+  end
+
+  it "should send the method on the class when the config is disabled" do
+    ResquePerformLater.stub!(:config).and_return(disabled)
+    user.should_receive(:full_name)
+    user.perform_later(:generic, :full_name)
+  end
+
+
+end

data/spec/support/database_models.rb

@@ -1,3 +1,5 @@
 class User < ActiveRecord::Base
-
+  def full_name
+    "Avi Tzurel"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perform_later
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-19 00:00:00.000000000 Z
+date: 2012-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70120073048240 !ruby/object:Gem::Requirement
+  requirement: &70289648690300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70120073048240
+  version_requirements: *70289648690300
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70120073047640 !ruby/object:Gem::Requirement
+  requirement: &70289648689880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70120073047640
+  version_requirements: *70289648689880
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70120073046940 !ruby/object:Gem::Requirement
+  requirement: &70289648689400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70120073046940
+  version_requirements: *70289648689400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70120073046500 !ruby/object:Gem::Requirement
+  requirement: &70289648688780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70120073046500
+  version_requirements: *70289648688780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70120073045940 !ruby/object:Gem::Requirement
+  requirement: &70289648688280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70120073045940
+  version_requirements: *70289648688280
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70120073045260 !ruby/object:Gem::Requirement
+  requirement: &70289648687300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70120073045260
+  version_requirements: *70289648687300
 description: Queue any method in any class or instance with no need for additional
   Worker class and no extra code
 email:
@@ -100,6 +100,7 @@ files:
 - lib/resque_perform_later.rb
 - license
 - perform_later.gemspec
+- spec/lib/active_record_perform_later_spec.rb
 - spec/lib/resque_perform_later_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_connection.rb
@@ -132,6 +133,7 @@ specification_version: 3
 summary: Queue any method in any class or instance with no need for additional Worker
   class and no extra code
 test_files:
+- spec/lib/active_record_perform_later_spec.rb
 - spec/lib/resque_perform_later_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_connection.rb