micro_q 0.6.5 → 0.7.0

data/README.md

@@ -2,7 +2,7 @@
 
 MicroQ is a per-process asynchronous background queue.
 
-It's simple startup and intuitive interface makes it the best choice for new and lagacy apps.
+It's simple startup and intuitive interface makes it the best choice for new and legacy apps.
 
 ## Installation
 
@@ -19,8 +19,10 @@ Or install it:
 ## Usage
 
 ```ruby
-# A typical worker
+## A typical worker class
 class MyWorker
+  worker :update # sets up the dsl and adds additional async_ methods
+
   def perform
     # do some performing here
   end
@@ -31,24 +33,30 @@ class MyWorker
 end
 ```
 
-###Simple (default)
+###Simple
 
 ```ruby
-# Using the async proxy API
-MyWorker.async.perform
-
-MyWorker.async.update(:user_id => user.id)
-
-# Through the raw push API
-MicroQ.push(:class => 'MyWorker') # Defaults to the perform method
-
-# With a custom method
-MicroQ.push(:class => 'MyWorker', :method => 'update', :args => [{:user_id => user.id}])
+MyWorker.async_perform
+MyWorker.async_update(:user_id => user.id)
 ```
 
 ###Advanced
 
-###Custom Loaders
+Safely using an ActiveRecord instance via the Custom Loader API 
+```ruby
+# app/models/user.rb
+class User < Activerecord::Base
+  def update_social_data
+    # Send HTTP requests to Facebook, Twitter, etc
+  end
+end
+
+# app/controllers/users_controller.rb
+def update
+  user = account.users.find(params[:id])
+  user.async.update_social_data
+end
+```
 
 ## Contributing
 

data/lib/micro_q/dsl.rb

@@ -0,0 +1,28 @@
+module MicroQ
+  module DSL
+    def worker(*opts)
+      self.class_eval do
+        def self.microq_options
+          @microq_options ||= { :methods => [:perform] }
+        end
+      end
+
+      if Hash === opts.last
+        self.microq_options.merge!(opts.pop)
+      end
+
+      async_methods = self.microq_options[:methods] |= opts.flatten
+
+      self.class_eval do
+        async_methods.each do |method|
+          async_method = :"async_#{method}"
+          define_singleton_method(async_method) do |*args|
+            MicroQ::Proxy::Instance.new(:class => self).send(method, *args)
+          end unless respond_to?(async_method)
+        end
+      end
+    end
+  end
+end
+
+Object.send(:extend, MicroQ::DSL)

data/lib/micro_q/methods/action_mailer.rb

@@ -1,17 +1,17 @@
 module MicroQ
   module Methods
     ##
-    # Methods that are added to ActionMailer instances
+    # Methods that are added to the ActionMailer class
     #
     # When mailing asynchronously, the deliver method needs to be
     # called which means a custom wrapper.
     #
     module ActionMailer
-      def async
-        MicroQ::Proxy::ActionMailer.new(
+      def async(options = {})
+        MicroQ::Proxy::ActionMailer.new(options.merge(
           :class => MicroQ::Wrapper::ActionMailer,
           :base => self
-        )
+        ))
       end
     end
   end

data/lib/micro_q/methods/active_record.rb

@@ -14,8 +14,8 @@ module MicroQ
     # store the id as the argument for find.
     #
     module ActiveRecord
-      def async
-        options = {
+      def async(options = {})
+        defaults = {
           :class => self.class,
           :loader => {
             :method => 'find',
@@ -23,7 +23,9 @@ module MicroQ
           }
         }
 
-        MicroQ::Proxy::Instance.new(options)
+        MicroQ::Proxy::Instance.new(
+          options.merge(defaults)
+        )
       end
     end
   end

data/lib/micro_q/methods/class.rb

@@ -9,8 +9,10 @@ module MicroQ
     # message invocation
     #
     module Class
-      def async
-        MicroQ::Proxy::Class.new(:class => self, :loader => {})
+      def async(options = {})
+        MicroQ::Proxy::Class.new(
+          options.merge(:class => self, :loader => {})
+        )
       end
     end
   end

data/lib/micro_q/methods/instance.rb

@@ -11,8 +11,10 @@ module MicroQ
     # what the default worker does.
     #
     module Instance
-      def async
-        MicroQ::Proxy::Instance.new(:class => self.class)
+      def async(options = {})
+        MicroQ::Proxy::Instance.new(
+          options.merge(:class => self.class)
+        )
       end
     end
   end

data/lib/micro_q/version.rb

@@ -1,7 +1,7 @@
 module MicroQ
   MAJOR = 0
-  MINOR = 6
-  POINT = 5
+  MINOR = 7
+  POINT = 0
 
   VERSION = [MAJOR, MINOR, POINT].join('.')
 end

data/lib/micro_q.rb

@@ -45,6 +45,7 @@ end
 require 'micro_q/middleware'
 require 'micro_q/wrappers'
 require 'micro_q/methods'
+require 'micro_q/dsl'
 require 'micro_q/proxies'
 require 'micro_q/worker'
 require 'micro_q/queue'

data/spec/lib/dsl_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe MicroQ::DSL do
+  describe '.worker' do
+    class OtherWorker
+      worker :update
+    end
+
+    it 'should add the method' do
+      Object.should be_respond_to(:worker)
+    end
+
+    it 'should include the dsl module' do
+      Object.should be_is_a(MicroQ::DSL)
+    end
+
+    it 'should add the async_perform method' do
+      OtherWorker.should be_respond_to(:async_perform)
+    end
+
+    it 'should add async_ prefixed method when given them' do
+      OtherWorker.should be_respond_to(:async_update)
+    end
+
+    describe 'when calling the async_ method' do
+      let(:method) { ->(*args) { OtherWorker.async_perform(*args) } }
+
+      before do
+        @proxy = mock(MicroQ::Proxy::Instance, :perform => nil)
+        MicroQ::Proxy::Instance.stub(:new).and_return(@proxy)
+      end
+
+      it 'should create a proxy' do
+        MicroQ::Proxy::Instance.should_receive(:new).and_return(@proxy)
+
+        method.call
+      end
+
+      it 'should have the class' do
+        MicroQ::Proxy::Instance.should_receive(:new).with(hash_including(:class => OtherWorker)).and_return(@proxy)
+
+        method.call
+      end
+
+      it 'should call the perform method' do
+        @proxy.should_receive(:perform)
+
+        method.call
+      end
+
+      it 'should have given arguments' do
+        @proxy.should_receive(:perform).with('hey yay', 4)
+
+        method.call('hey yay', 4)
+      end
+    end
+
+    describe 'when calling the async_something method' do
+      let(:method) { ->(*args) { OtherWorker.async_update(*args) } }
+
+      before do
+        @proxy = mock(MicroQ::Proxy::Instance, :update => nil)
+        MicroQ::Proxy::Instance.stub(:new).and_return(@proxy)
+      end
+
+      it 'should have the class' do
+        MicroQ::Proxy::Instance.should_receive(:new).with(hash_including(:class => OtherWorker)).and_return(@proxy)
+
+        method.call
+      end
+
+      it 'should call the update method' do
+        @proxy.should_receive(:update)
+
+        method.call
+      end
+
+      it 'should have given arguments' do
+        @proxy.should_receive(:update).with('hey yay', 12)
+
+        method.call('hey yay', 12)
+      end
+    end
+
+    describe 'when given custom options' do
+      class OneWorker; worker :one_method end
+      class OptionWorker
+        worker :method_name, :queue => 'my-queue', :option => 'value'
+        worker :other_method, :queue => 'my-queue', :option => 'value'
+      end
+
+      it 'should have the async_ methods' do
+        OptionWorker.should be_respond_to(:async_method_name)
+        OptionWorker.should be_respond_to(:async_other_method)
+      end
+
+      it 'should store the options' do
+        OptionWorker.microq_options[:queue].should == 'my-queue'
+        OptionWorker.microq_options[:option].should == 'value'
+      end
+
+      it 'should merge the given methods' do
+        OptionWorker.microq_options[:methods].should == [:perform, :method_name, :other_method]
+      end
+
+      it 'should not bleed methods' do
+        OneWorker.microq_options[:methods].should == [:perform, :one_method]
+      end
+    end
+  end
+end

data/spec/lib/methods/action_mailer_spec.rb

@@ -24,5 +24,15 @@ describe MicroQ::Methods::ActionMailer do
 
       async.call
     end
+
+    describe 'when given when to run the job' do
+      let(:method) { -> { MyMailer.async(:at => "sometime") } }
+
+      it 'should pass the option' do
+        MicroQ::Proxy::ActionMailer.should_receive(:new).with(hash_including(:at => "sometime"))
+
+        method.call
+      end
+    end
   end
 end

data/spec/lib/methods/active_record_spec.rb

@@ -54,8 +54,18 @@ describe MicroQ::Methods::ActiveRecord, :active_record => true do
   it_behaves_like 'a_worker', 'process'
 
   describe 'when calling to async.method proxy' do
-    let(:method) { lambda {|*args| subject.async.process(*args) } }
+    let(:method) { ->(*args) { subject.async.process(*args) } }
 
     it_behaves_like 'an async AR instance'
+
+    describe 'when given when to run the job' do
+      let(:method) { -> { subject.async(:at => "sometime") } }
+
+      it 'should pass the option' do
+        MicroQ::Proxy::Instance.should_receive(:new).with(hash_including(:at => "sometime"))
+
+        method.call
+      end
+    end
   end
 end

data/spec/lib/methods/class_spec.rb

@@ -48,8 +48,18 @@ describe MicroQ::Methods::Class do
   it_behaves_like 'a_worker', 'seed'
 
   describe 'when calling to async.method proxy' do
-    let(:method) { lambda {|*args| subject.async.seed(*args) } }
+    let(:method) { ->(*args) { subject.async.seed(*args) } }
 
     it_behaves_like 'an async class'
+
+    describe 'when given when to run the job' do
+      let(:method) { -> { subject.async(:at => "sometime") } }
+
+      it 'should pass the option' do
+        MicroQ::Proxy::Class.should_receive(:new).with(hash_including(:at => "sometime"))
+
+        method.call
+      end
+    end
   end
 end

data/spec/lib/methods/instance_spec.rb

@@ -42,8 +42,18 @@ describe MicroQ::Methods::Instance do
   it_behaves_like 'a_worker', 'process'
 
   describe 'when calling to async.method proxy' do
-    let(:method) { lambda {|*args| subject.async.process(*args) } }
+    let(:method) { ->(*args) { subject.async.process(*args) } }
 
     it_behaves_like 'an async instance'
+
+    describe 'when given when to run the job' do
+      let(:method) { -> { subject.async(:at => "sometime") } }
+
+      it 'should pass the option' do
+        MicroQ::Proxy::Instance.should_receive(:new).with(hash_including(:at => "sometime"))
+
+        method.call
+      end
+    end
   end
 end

data/spec/lib/middleware/server/retry_spec.rb

@@ -17,7 +17,7 @@ describe MicroQ::Middleware::Server::Retry, :middleware => true do
 
     describe 'when the block raises an Exception' do
       let(:exception) { Exception.new }
-      let(:block) { lambda { raise exception } }
+      let(:block) { -> { raise exception } }
 
       describe 'when retry is disabled' do
         before do

data/spec/lib/proxies/action_mailer_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe MicroQ::Proxy::ActionMailer do
-  let(:method) { lambda {|*args| subject.mail_me(*args) } }
+  let(:method) { ->(*args) { subject.mail_me(*args) } }
   let(:options) { { :class => MicroQ::Wrapper::ActionMailer, :base => MyMailer } }
 
   class MyMailer < ActionMailer::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: micro_q
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-15 00:00:00.000000000 Z
+date: 2013-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -202,6 +202,7 @@ files:
 - Rakefile
 - lib/micro_q.rb
 - lib/micro_q/config.rb
+- lib/micro_q/dsl.rb
 - lib/micro_q/manager.rb
 - lib/micro_q/manager/default.rb
 - lib/micro_q/methods.rb
@@ -232,6 +233,7 @@ files:
 - spec/helpers/methods_examples.rb
 - spec/helpers/queues_examples.rb
 - spec/lib/config_spec.rb
+- spec/lib/dsl_spec.rb
 - spec/lib/manager/default_spec.rb
 - spec/lib/methods/action_mailer_spec.rb
 - spec/lib/methods/active_record_spec.rb
@@ -263,21 +265,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -938614876978684754
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -938614876978684754
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: ''
@@ -285,6 +281,7 @@ test_files:
 - spec/helpers/methods_examples.rb
 - spec/helpers/queues_examples.rb
 - spec/lib/config_spec.rb
+- spec/lib/dsl_spec.rb
 - spec/lib/manager/default_spec.rb
 - spec/lib/methods/action_mailer_spec.rb
 - spec/lib/methods/active_record_spec.rb
@@ -304,3 +301,4 @@ test_files:
 - spec/lib/worker/standard_spec.rb
 - spec/lib/wrappers/action_mailer_spec.rb
 - spec/spec_helper.rb
+has_rdoc: