qe 0.1.3 → 0.2.0

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    qe (0.1.3)
+    qe (0.2.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
       builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.8)
+    activesupport (3.2.9)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     arel (3.0.2)
     awesome_print (1.1.0)
-    backburner (0.2.5)
-      beaneater (~> 0.1.2)
+    backburner (0.3.0)
+      beaneater (~> 0.2.0)
       dante (~> 0.1.5)
-    beaneater (0.1.2)
+    beaneater (0.2.0)
     builder (3.0.4)
     celluloid (0.12.3)
       facter (>= 1.6.12)
@@ -30,7 +30,7 @@ GEM
     coderay (1.0.8)
     connection_pool (0.9.2)
     dante (0.1.5)
-    delayed_job (3.0.3)
+    delayed_job (3.0.4)
       activesupport (~> 3.0)
     delayed_job_active_record (0.3.3)
       activerecord (>= 2.1.0, < 4)
@@ -57,15 +57,15 @@ GEM
       redis-namespace (~> 1.0)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    sidekiq (2.5.2)
+    rspec-mocks (2.12.0)
+    sidekiq (2.5.3)
       celluloid (~> 0.12.0)
       connection_pool (~> 0.9.2)
       multi_json (~> 1)

data/README.md

@@ -75,7 +75,41 @@ MailerWorker.enqueue({
 })
 ```
 
-## Development support
+### Defining actions
+
+Sometimes you want to create several actions in a single worker, just because is easier. Instead of manually dispatch the action on your perform method, you can
+just add the `Qe::Action` module.
+
+``` ruby
+class NotificationWorker
+  include Qe::Worker
+  include Qe::Action
+
+  def shutdown
+    puts options[:message]
+  end
+
+  def startup
+    puts options[:message]
+  end
+
+  def default
+    puts options[:message]
+  end
+end
+```
+
+Now, you can just enqueue jobs by defining the `:action` option. If no action is defined, then the default is executed.
+
+``` ruby
+NotificationWorker.enqueue(:action => :shutdown, :message => "shutting down")
+NotificationWorker.enqueue(:action => :startup, :message => "starting up")
+NotificationWorker.enqueue(:message => "wat?")
+```
+
+The action must be a existing public method. If not defined, `Qe::Action::MissingActionError` exception is raised.
+
+### Development support
 
 Qe comes with development support. Instead of starting up workers on development environment, you can use the `Qe::Immediate` adapter, which executes your worker right away!
 
@@ -85,7 +119,7 @@ Qe.adapter = Qe::Immediate
 
 If you're using Rails, you can add the line above to your `config/environments/development.rb` file.
 
-## Testing support
+### Testing support
 
 Qe also comes with testing support. Just require the `qe/testing.rb` file
 and a fake queuing adapter will be used. All enqueued jobs will be stored
@@ -114,13 +148,11 @@ end
 ```
 
 
-Maintainer
-----------
+## Maintainer
 
 * Nando Vieira (<http://nandovieira.com.br>)
 
-License:
---------
+## License:
 
 (The MIT License)
 

data/lib/qe.rb

@@ -1,3 +1,4 @@
+require "qe/action"
 require "qe/immediate"
 require "qe/version"
 require "qe/worker"

data/lib/qe/action.rb

@@ -0,0 +1,14 @@
+module Qe
+  module Action
+    MissingActionError = Class.new(StandardError)
+
+    def perform
+      action = options.fetch(:action, :default)
+
+      raise MissingActionError,
+        "the action #{action.inspect} is not defined" unless respond_to?(action)
+
+      public_send(action)
+    end
+  end
+end

data/lib/qe/version.rb

@@ -1,3 +1,3 @@
 module Qe
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/qe/action_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe Qe::Action do
+  NotificationWorker = Class.new do
+    include Qe::Worker
+    include Qe::Action
+
+    def shutdown; end
+    def default; end
+  end
+
+  let(:job) { NotificationWorker.new({}) }
+
+  it "responds to perform" do
+    expect(job).to respond_to(:perform)
+  end
+
+  it "performs specified action" do
+    job.should_receive(:hello)
+    job.options[:action] = :hello
+
+    job.perform
+  end
+
+  it "executes default action when have no action" do
+    job.should_receive(:default)
+    job.perform
+  end
+
+  it "raises exception when action method doesn't exist" do
+    job.options[:action] = :invalid
+
+    expect {
+      job.perform
+    }.to raise_error(Qe::Action::MissingActionError, "the action :invalid is not defined")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qe
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -199,6 +199,7 @@ files:
 - examples/sidekiq.ru
 - examples/workers.rb
 - lib/qe.rb
+- lib/qe/action.rb
 - lib/qe/beanstalk.rb
 - lib/qe/delayed_job.rb
 - lib/qe/immediate.rb
@@ -210,6 +211,7 @@ files:
 - lib/qe/version.rb
 - lib/qe/worker.rb
 - qe.gemspec
+- spec/qe/action_spec.rb
 - spec/qe/beanstalk_spec.rb
 - spec/qe/delayed_job_spec.rb
 - spec/qe/enqueue_matcher_spec.rb
@@ -239,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A simple interface over several background job libraries like Resque, Sidekiq