ayl-rails 0.1.1 → 0.1.2

data/README.rdoc

@@ -20,6 +20,28 @@ becomes
     ayl_after_create :method #,
     ayl_after_update :method
 
+In addition, the callback definitions can be parameterized in a couple of different ways.
+
+First, you can make the callbacks conditional in the same way that you can make standard ActiveRecord callbacks conditional:
+
+    ayl_after_create :method, :if => :should_it_be_called?
+
+In this example, the method will only be invoked on create if the method "should_it_be_called?" responds with true.
+Alternatively, something like:
+
+    ayl_after_create :method, :unless => :should_it_be_called?
+
+In this example, the method will only be invoked on create if the method "should_it_be_called? responds with false.
+
+You can also specify message parameters to control how the asynchronous message is processed. For example,
+
+    ayl_after_create :method, :message_options => { :delay => 20 }
+
+will request that the underlying queuing engine will delay processing of the message for 20 seconds.
+
+Naturally, the two types of parameters can be combined for a callback:
+
+    ayl_after_create :method, :message_options => { :delay => 20 }, :unless => :it_should_not_be_called?
 
 == Contributing to ayl-rails
  

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/ayl-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ayl-rails"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["j0hnds@gmail.com"]
-  s.date = "2011-11-27"
+  s.date = "2011-11-30"
   s.description = "Partner to ayl to allow ActiveRecord after_* hooks to be made asynchronous."
   s.email = "j0hnds@gmail.com"
   s.extra_rdoc_files = [

data/lib/ayl-rails/railtie.rb

@@ -31,20 +31,28 @@ module Ayl
         def add_ayl_hook(hook, *args, &block)
           if args && args.first.is_a?(Symbol)
             method = args.shift
-            ayl_hooks(*args)[hook] << lambda{|o| o.send(method)}
+            ayl_hooks(hook, *args) << lambda{|o| o.send(method)}
           else
-            ayl_hooks(*args)[hook] << block
+            ayl_hooks(hook, *args) << block
           end
         end
 
-        def ayl_hooks(*args)
-          @ayn_hooks ||= Hash.new do |hash, hook|
+        def ayl_hooks(hook_key, *args)
+          @ayl_hooks ||= Hash.new { |hash, hook| hash[hook] = [] }
+
+          message_options = {}
+          if args && args.first.is_a?(Hash) && args.first.has_key?(:message_options)
+            message_options = args.first[:message_options]
+            args.first.delete(:message_options)
+          end
+
+          if not @ayl_hooks.has_key?(hook_key)
             # Remember: this block is invoked only once for each
             # access of a key that has not been used before.
             
             # Define the name of a method that the standard hook
             # method will call when the standard hook fires
-            ahook = "_ayl_#{hook}".to_sym
+            ahook = "_ayl_#{hook_key}".to_sym
             
             # This is for the producer's benefit
             # So, this is the equivalent of performing the following
@@ -58,24 +66,25 @@ module Ayl
             # So, the self.class target for the ayl_send is because we
             # need to call the ayl_send method at the singleton level.
             #
-            send(hook, *args) { |o| self.class.ayl_send(ahook, o) }
+            send(hook_key, *args) { |o| self.class.ayl_send_opts(ahook, message_options, o) }
 
             # This is for the worker's benefit
             #
             # This defines the instance method
             method_code = <<-EOF
               def #{ahook}(o)
-                _run_ayl_hooks(#{hook.inspect}, o)
+                _run_ayl_hooks(#{hook_key.inspect}, o)
               end
             EOF
             instance_eval(method_code, __FILE__, __LINE__ - 1)
-
-            hash[hook] = []
           end
+
+          # Return the array associated with the hook key
+          @ayl_hooks[hook_key]
         end
 
         def _run_ayl_hooks(hook, o)
-          ayl_hooks[hook].each { |b| b.call(o) }
+          ayl_hooks(hook).each { |b| b.call(o) }
         end
 
       end

data/spec/rails_extensions_spec.rb

@@ -60,6 +60,15 @@ class AfterCreate::MyModel < ActiveRecord::Base
   end
 end
 
+module MessageOptions; end
+
+class MessageOptions::MyModel < ActiveRecord::Base
+
+  ayl_after_create :handle_after_create, :message_options => { :delay => 20 }
+  ayl_after_update :handle_after_update
+
+end
+
 module ConditionalCallbacks; end
 
 class ConditionalCallbacks::MyModel < ActiveRecord::Base
@@ -67,7 +76,7 @@ class ConditionalCallbacks::MyModel < ActiveRecord::Base
 
   ayl_after_create :handle_after_create, :if => :should_do_callback?
 
-  ayl_after_update :handle_after_update, :if => :should_do_callback?
+  ayl_after_update :handle_after_update, :unless => :should_do_callback?
 
   private
 
@@ -153,7 +162,7 @@ describe "Rails Extensions" do
     it "should represent the instance of a particular model using a 'find'" do
       model = InstanceMethod::MyModel.create(:name => 'loud')
 
-      model.to_rrepr.should == "InstanceMethod::MyModel.find(#{model.id})"
+      model.to_rrepr.should == "InstanceMethod::MyModel.unscoped.find(#{model.id})"
     end
 
     it "should invoke the instance method asynchronously with no options" do
@@ -192,21 +201,34 @@ describe "Rails Extensions" do
 
   context "when using conditional callbacks" do
 
-    it "should invoke the after_create and after_update callbacks when the flag is true" do
+    it "should invoke the after_create but not the after_update callbacks when the flag is true" do
       model = ConditionalCallbacks::MyModel.new(:name => "spud")
       model.do_callback = true # Should allow after_create to be called, but not after_update
       model.save
       model.update_attribute(:name, "dog")
-      WhatHappened.instance.what_ran.should == [ "handle after create", "handle after update" ]
+      WhatHappened.instance.what_ran.should == [ "handle after create" ]
     end
 
-    it "should not invoke the after_create or after_update callbacks when the flag is false" do
+    it "should invoke the after_update but not the after_create callbacks when the flag is false" do
       model = ConditionalCallbacks::MyModel.new(:name => "spud")
       model.do_callback = false # Should allow after_update to be called, but not after_create
       model.save
       model.update_attribute(:name, "dog")
-      WhatHappened.instance.what_ran.should be_blank
+      WhatHappened.instance.what_ran.should == [ "handle after update" ]
+    end
+  end
+
+  context "when using message parameters" do
+
+    it "should pass the message options to the ayl_after_create, but not to the ayl_after_update" do
+      model = MessageOptions::MyModel.new(:name => "spud")
+      MessageOptions::MyModel.should_receive(:ayl_send_opts).with(:_ayl_after_create, { :delay => 20 }, model)
+      MessageOptions::MyModel.should_receive(:ayl_send_opts).with(:_ayl_after_update, { }, model)
+
+      model.save
+      model.update_attribute(:name, "dog")
     end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ayl-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-27 00:00:00.000000000Z
+date: 2011-11-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ayl
-  requirement: &82467240 !ruby/object:Gem::Requirement
+  requirement: &79641030 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *82467240
+  version_requirements: *79641030
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &82466930 !ruby/object:Gem::Requirement
+  requirement: &79640730 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *82466930
+  version_requirements: *79640730
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &82466600 !ruby/object:Gem::Requirement
+  requirement: &79640380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *82466600
+  version_requirements: *79640380
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &82466170 !ruby/object:Gem::Requirement
+  requirement: &79639970 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *82466170
+  version_requirements: *79639970
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &82465650 !ruby/object:Gem::Requirement
+  requirement: &79639420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *82465650
+  version_requirements: *79639420
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &82465210 !ruby/object:Gem::Requirement
+  requirement: &79639010 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82465210
+  version_requirements: *79639010
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &82434600 !ruby/object:Gem::Requirement
+  requirement: &79609090 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82434600
+  version_requirements: *79609090
 description: Partner to ayl to allow ActiveRecord after_* hooks to be made asynchronous.
 email: j0hnds@gmail.com
 executables: []
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 812368029
+      hash: 1033823859
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: