has-guarded-handlers 0.0.3 → 0.1.0

data/CHANGELOG.md

@@ -1,8 +1,11 @@
+# 0.1.0
+  * Allow setting a priority with which to execute a handler, where higher priority handlers are exectuted first
+
 # 0.0.3
-  # Allow classes to be passed as guards, matching against an event via #is_a?
+  * Allow classes to be passed as guards, matching against an event via #is_a?
 
 # 0.0.2
-  # Bugfix: The mixin now does not hijack the target's initializer which was causing issues with inheritance
+  * Bugfix: The mixin now does not hijack the target's initializer which was causing issues with inheritance
 
 # 0.0.1
   * Feature: Some code that works!

data/lib/has_guarded_handlers.rb

@@ -7,10 +7,21 @@ module HasGuardedHandlers
   # @param [guards] guards take a look at the guards documentation
   # @yield [Object] stanza the incoming event
   def register_handler(type, *guards, &handler)
+    register_handler_with_priority type, 0, *guards, &handler
+  end
+
+  # Register a handler with a specified priority
+  #
+  # @param [Symbol, nil] type set the filter on a specific handler
+  # @param [Integer] priority the priority of the handler. Higher priority executes first
+  # @param [guards] guards take a look at the guards documentation
+  # @yield [Object] stanza the incoming event
+  def register_handler_with_priority(type, priority, *guards, &handler)
     initialize_guarded_handlers
     check_guards guards
-    @handlers[type] ||= []
-    @handlers[type] << [guards, handler]
+    @handlers[type] ||= {}
+    @handlers[type][priority] ||= []
+    @handlers[type][priority] << [guards, handler]
   end
 
   # Clear handlers with given guards
@@ -19,12 +30,14 @@ module HasGuardedHandlers
   # @param [guards] guards take a look at the guards documentation
   def clear_handlers(type, *guards)
     initialize_guarded_handlers
-    @handlers[type].delete_if { |g, _| g == guards }
+    @handlers[type].each_pair do |priority, handlers|
+      handlers.delete_if { |g, _| g == guards }
+    end
   end
 
   def trigger_handler(type, event)
     initialize_guarded_handlers
-    return unless handler = @handlers[type]
+    return unless handler = handlers_of_type(type)
     catch :halt do
       handler.find do |guards, handler|
         catch(:pass) { call_handler handler, guards, event }
@@ -34,6 +47,15 @@ module HasGuardedHandlers
 
   private
 
+  def handlers_of_type(type)
+    hash = @handlers[type]
+    values = []
+    hash.keys.sort.reverse.each do |key|
+      values += hash[key]
+    end
+    values
+  end
+
   def call_handler(handler, guards, event)
     handler.call event unless guarded?(guards, event)
   end

data/lib/has_guarded_handlers/version.rb

@@ -1,3 +1,3 @@
 module HasGuardedHandlers
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/has_guarded_handlers_spec.rb

@@ -39,6 +39,50 @@ describe TestObject do
     subject.trigger_handler :event, event
   end
 
+  describe 'when registering handlers with the same priority' do
+    it 'preserves the order of specification of the handlers' do
+      sequence = sequence 'handler_priority'
+      response.expects(:handle1).once.in_sequence sequence
+      response.expects(:handle2).once.in_sequence sequence
+      response.expects(:handle3).once.in_sequence sequence
+      subject.register_handler :event do |_|
+        response.handle1
+        throw :pass
+      end
+      subject.register_handler :event do |_|
+        response.handle2
+        throw :pass
+      end
+      subject.register_handler :event do |_|
+        response.handle3
+        throw :pass
+      end
+      subject.trigger_handler :event, event
+    end
+  end
+
+  describe 'when registering handlers with a specified priority' do
+    it 'executes handlers in that order' do
+      sequence = sequence 'handler_priority'
+      response.expects(:handle1).once.in_sequence sequence
+      response.expects(:handle2).once.in_sequence sequence
+      response.expects(:handle3).once.in_sequence sequence
+      subject.register_handler_with_priority :event, -10 do |_|
+        response.handle3
+        throw :pass
+      end
+      subject.register_handler_with_priority :event, 0 do |_|
+        response.handle2
+        throw :pass
+      end
+      subject.register_handler_with_priority :event, 10 do |_|
+        response.handle1
+        throw :pass
+      end
+      subject.trigger_handler :event, event
+    end
+  end
+
   it 'can clear handlers' do
     response.expects(:call).once
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has-guarded-handlers
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-21 00:00:00.000000000 +01:00
+date: 2011-10-28 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156641740 !ruby/object:Gem::Requirement
+  requirement: &2165367660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2156641740
+  version_requirements: *2165367660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156641100 !ruby/object:Gem::Requirement
+  requirement: &2165366980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2156641100
+  version_requirements: *2165366980
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2156640520 !ruby/object:Gem::Requirement
+  requirement: &2165366340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156640520
+  version_requirements: *2165366340
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2156639920 !ruby/object:Gem::Requirement
+  requirement: &2165365700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2156639920
+  version_requirements: *2165365700
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2156639320 !ruby/object:Gem::Requirement
+  requirement: &2165365060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,10 +67,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *2156639320
+  version_requirements: *2165365060
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156638720 !ruby/object:Gem::Requirement
+  requirement: &2165364420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156638720
+  version_requirements: *2165364420
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2156638220 !ruby/object:Gem::Requirement
+  requirement: &2165363900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,7 +89,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156638220
+  version_requirements: *2165363900
 description: Allow an object's API to provide flexible handler registration, storage
   and matching to arbitrary events.
 email: