has-guarded-handlers 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+spec/reports
+.yardoc
+doc
+.*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--colour
+--tty

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 0.0.1
+  * Feature: Some code that works!

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in has-guarded-handlers.gemspec
+gemspec
+
+if RUBY_PLATFORM =~ /darwin/
+  gem 'growl_notify'
+  gem 'rb-fsevent'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ben Langfeld, Jeff Smick
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# HasGuardedHandlers
+HasGuardedHandlers allows an object's API to provide flexible handler registration, storage and matching to arbitrary events.
+
+## Installation
+    gem install has-guarded-handlers
+
+## Usage
+
+```ruby
+require 'has_guarded_handlers'
+
+class A
+  include HasGuardedHandlers
+
+  def receive_event(event)
+    trigger_handler :event, event
+  end
+end
+
+a = A.new
+a.register_handler :event, :type => :foo do
+  puts "Handled the event"
+end
+
+class Event
+  attr_accessor :type
+end
+
+event = Event.new.tap { |e| e.type = :foo }
+a.receive_event event
+```
+
+## Links:
+* [Source](https://github.com/adhearsion/has-guarded-handlers)
+* [Documentation](http://rdoc.info/github/adhearsion/has-guarded-handlers/master/frames)
+* [Bug Tracker](https://github.com/adhearsion/has-guarded-handlers/issues)
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Ben Langfeld, Jeff Smick. MIT licence (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'ci/reporter/rake/rspec'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--color'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rspec_opts = '--color'
+end
+
+task :default => :spec
+task :ci => ['ci:setup:rspec', :spec]
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/has-guarded-handlers.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has_guarded_handlers/version"
+
+Gem::Specification.new do |s|
+  s.name        = "has-guarded-handlers"
+  s.version     = HasGuardedHandlers::VERSION
+  s.authors     = ["Ben Langfeld", "Jeff Smick"]
+  s.email       = ["ben@langfeld.me"]
+  s.homepage    = "http://github.com/adhearsion/has-guarded-handlers"
+  s.summary     = %q{A library for associating a set of event handlers, complete with guards, with a Ruby object}
+  s.description = %q{Allow an object's API to provide flexible handler registration, storage and matching to arbitrary events.}
+
+  s.rubyforge_project = "has-guarded-handlers"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'bundler', ["~> 1.0.0"]
+  s.add_development_dependency 'rspec', [">= 2.5.0"]
+  s.add_development_dependency 'mocha', [">= 0"]
+  s.add_development_dependency 'ci_reporter', [">= 1.6.3"]
+  s.add_development_dependency 'yard', ["~> 0.7.0"]
+  s.add_development_dependency 'rake', [">= 0"]
+  s.add_development_dependency 'guard-rspec'
+end

data/lib/has_guarded_handlers.rb

@@ -0,0 +1,86 @@
+require "has_guarded_handlers/version"
+
+module HasGuardedHandlers
+  def initialize(*args)
+    @handlers = {}
+  end
+
+  # Register a handler
+  #
+  # @param [Symbol, nil] type set the filter on a specific handler
+  # @param [guards] guards take a look at the guards documentation
+  # @yield [Object] stanza the incoming event
+  def register_handler(type, *guards, &handler)
+    check_guards guards
+    @handlers[type] ||= []
+    @handlers[type] << [guards, handler]
+  end
+
+  # Clear handlers with given guards
+  #
+  # @param [Symbol, nil] type remove filters for a specific handler
+  # @param [guards] guards take a look at the guards documentation
+  def clear_handlers(type, *guards)
+    @handlers[type].delete_if { |g, _| g == guards }
+  end
+
+  def trigger_handler(type, event)
+    return unless handler = @handlers[type]
+    catch :halt do
+      handler.find do |guards, handler|
+        catch(:pass) { call_handler handler, guards, event }
+      end
+    end
+  end
+
+  private
+
+  def call_handler(handler, guards, event)
+    handler.call event unless guarded?(guards, event)
+  end
+
+  # If any of the guards returns FALSE this returns true
+  # the logic is reversed to allow short circuiting
+  # (why would anyone want to loop over more values than necessary?)
+  #
+  # @private
+  def guarded?(guards, event)
+    guards.find do |guard|
+      case guard
+      when Symbol
+        !event.__send__ guard
+      when Array
+        # return FALSE if any item is TRUE
+        !guard.detect { |condition| !guarded? [condition], event }
+      when Hash
+        # return FALSE unless any inequality is found
+        guard.find do |method, test|
+          value = event.__send__(method)
+          # last_match is the only method found unique to Regexp classes
+          if test.class.respond_to?(:last_match)
+            !(test =~ value.to_s)
+          elsif test.is_a?(Array)
+            !test.include? value
+          else
+            test != value
+          end
+        end
+      when Proc
+        !guard.call event
+      end
+    end
+  end
+
+  def check_guards(guards)
+    guards.each do |guard|
+      case guard
+      when Array
+        guard.each { |g| check_guards [g] }
+      when Symbol, Proc, Hash, String
+        nil
+      else
+        raise "Bad guard: #{guard.inspect}"
+      end
+    end
+  end
+end

data/lib/has_guarded_handlers/version.rb

@@ -0,0 +1,3 @@
+module HasGuardedHandlers
+  VERSION = "0.0.1"
+end

data/spec/has_guarded_handlers_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe TestObject do
+  subject { TestObject.new :bar }
+
+  it { should be_a TestObject }
+  its(:foo) { should == :bar }
+
+  let(:event) { mock 'Event' }
+  let(:response) { mock 'Response' }
+
+  it 'can register a handler' do
+    response.expects(:call).twice.with(event)
+    subject.register_handler(:event) { |e| response.call e }
+    subject.trigger_handler :event, event
+    subject.trigger_handler :event, event
+  end
+
+  it 'allows for breaking out of handlers' do
+    response.expects(:handle).once
+    response.expects(:fail).never
+    subject.register_handler :event do |_|
+      response.handle
+      throw :halt
+      response.fail
+    end
+    subject.trigger_handler :event, event
+  end
+
+  it 'allows for passing to the next handler of the same type' do
+    response.expects(:handle1).once
+    response.expects(:handle2).once
+    response.expects(:fail).never
+    subject.register_handler :event do |_|
+      response.handle1
+      throw :pass
+      response.fail
+    end
+    subject.register_handler :event do |_|
+      response.handle2
+    end
+    subject.trigger_handler :event, event
+  end
+
+  it 'can clear handlers' do
+    response.expects(:call).once
+
+    subject.register_handler(:event) { |_| response.call }
+    subject.trigger_handler :event, event
+
+    subject.clear_handlers :event
+    subject.trigger_handler :event, event
+  end
+
+  describe 'guards' do
+    it 'can be a symbol' do
+      response.expects(:call).once
+      subject.register_handler(:event, :chat?) { |_| response.call }
+
+      event.expects(:chat?).returns true
+      subject.trigger_handler :event, event
+
+      event.expects(:chat?).returns false
+      subject.trigger_handler :event, event
+    end
+
+    it 'can be a hash with string match' do
+      response.expects(:call).once
+      subject.register_handler(:event, :body => 'exit') { |_| response.call }
+
+      event.expects(:body).returns 'exit'
+      subject.trigger_handler :event, event
+
+      event.expects(:body).returns 'not-exit'
+      subject.trigger_handler :event, event
+    end
+
+    it 'can be a hash with a value' do
+      response.expects(:call).once
+      subject.register_handler(:event, :number => 0) { |_| response.call }
+
+      event.expects(:number).returns 0
+      subject.trigger_handler :event, event
+
+      event.expects(:number).returns 1
+      subject.trigger_handler :event, event
+    end
+
+    it 'can be a hash with a regexp' do
+      response.expects(:call).once
+      subject.register_handler(:event, :body => /exit/) { |_| response.call }
+
+      event.expects(:body).returns 'more than just exit, but exit still'
+      subject.trigger_handler :event, event
+
+      event.expects(:body).returns 'keyword not found'
+      subject.trigger_handler :event, event
+
+      event.expects(:body).returns nil
+      subject.trigger_handler :event, event
+    end
+
+    it 'can be a hash with an array' do
+      response.expects(:call).twice
+      subject.register_handler(:event, :type => [:result, :error]) { |_| response.call }
+
+      event = mock 'Event'
+      event.expects(:type).at_least_once.returns :result
+      subject.trigger_handler :event, event
+
+      event = mock 'Event'
+      event.expects(:type).at_least_once.returns :error
+      subject.trigger_handler :event, event
+
+      event = mock 'Event'
+      event.expects(:type).at_least_once.returns :get
+      subject.trigger_handler :event, event
+    end
+
+    it 'chained are treated like andand (short circuited)' do
+      response.expects(:call).once
+      subject.register_handler(:event, :type => :get, :body => 'test') { |_| response.call }
+
+      event = mock 'Event'
+      event.expects(:type).at_least_once.returns :get
+      event.expects(:body).returns 'test'
+      subject.trigger_handler :event, event
+
+      event = mock 'Event'
+      event.expects(:type).at_least_once.returns :set
+      event.expects(:body).never
+      subject.trigger_handler :event, event
+    end
+
+    it 'within an Array are treated as oror (short circuited)' do
+      response.expects(:call).twice
+      subject.register_handler(:event, [{:type => :get}, {:body => 'test'}]) { |_| response.call }
+
+      event = mock 'Event'
+      event.expects(:type).at_least_once.returns :set
+      event.expects(:body).returns 'test'
+      subject.trigger_handler :event, event
+
+      event = mock 'Event'
+      event.stubs(:type).at_least_once.returns :get
+      event.expects(:body).never
+      subject.trigger_handler :event, event
+    end
+
+    it 'can be a lambda' do
+      response.expects(:call).once
+      subject.register_handler(:event, lambda { |e| e.number % 3 == 0 }) { |_| response.call }
+
+      event.expects(:number).at_least_once.returns 3
+      subject.trigger_handler :event, event
+
+      event.expects(:number).at_least_once.returns 2
+      subject.trigger_handler :event, event
+    end
+
+    it 'raises an error when a bad guard is tried' do
+      lambda {
+        subject.register_handler(:event, 0) {}
+      }.should raise_error RuntimeError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'has_guarded_handlers'
+require 'mocha'
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
+class TestObject
+  include HasGuardedHandlers
+
+  attr_reader :foo
+
+  def initialize(foo)
+    @foo = foo
+    super
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: has-guarded-handlers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben Langfeld
+- Jeff Smick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-21 00:00:00.000000000 +01:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2157593120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157593120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157592500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157592500
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2157591880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157591880
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: &2157591320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :development
+  prerelease: false
+  version_requirements: *2157591320
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2157590820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157590820
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157590320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157590320
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2157589900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157589900
+description: Allow an object's API to provide flexible handler registration, storage
+  and matching to arbitrary events.
+email:
+- ben@langfeld.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- has-guarded-handlers.gemspec
+- lib/has_guarded_handlers.rb
+- lib/has_guarded_handlers/version.rb
+- spec/has_guarded_handlers_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/adhearsion/has-guarded-handlers
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: has-guarded-handlers
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A library for associating a set of event handlers, complete with guards,
+  with a Ruby object
+test_files:
+- spec/has_guarded_handlers_spec.rb
+- spec/spec_helper.rb