simple_events 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fe99b62b6f4ad0043c5f399e3f361dce022969c
+  data.tar.gz: 01bfd3635def53a48f57ef87fdcb7a2bc7915cd3
+SHA512:
+  metadata.gz: 7689b5343f2452a2e27c35defa264aeeafb0f93c016b2571a5ab65b34f926feebc46e21587a30a525e99c5cb739bae84cff102aabc9434d1630b45852788cc1a
+  data.tar.gz: 2bab23fe61c6df2881765f59394faa44c95824ff5fdc75c2043b19785f778cf03a726c986d310e05e4497d6042c1dd024bc11ca9d46bb2217cccfa6185997178

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_events.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+----
+
+Copyright (c) 2013 Jason R. Clark
+
+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,42 @@
+# SimpleEvents
+
+A basic eventing system
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_events'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_events
+
+## Usage
+
+Create a new event notifier:
+
+    events = SimpleEvent::Notifier.new
+    
+Subscribe to an event:
+
+    events.subscribe(:all_done) do |*args|
+      # Handle the event here...
+    end
+
+Notify of an event:
+
+    events.notify(:all_done, "pass", "along", "args")
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/simple_events'
+  t.test_files = FileList['test/lib/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/simple_events.rb

@@ -0,0 +1,2 @@
+require "simple_events/version"
+require "simple_events/notifier"

data/lib/simple_events/notifier.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'logger'
+
+module SimpleEvents
+  class Notifier
+
+    attr_accessor :runaway_threshold
+
+    def initialize
+      @events = {}
+      @runaway_threshold = 100
+    end
+
+    def subscribe(event, &handler)
+      @events[event] ||= []
+      @events[event] << handler
+      check_for_runaway_subscriptions(event)
+    end
+
+    def check_for_runaway_subscriptions(event)
+      count = @events[event].size
+      logger.debug("Run-away event subscription on #{event}? Subscribed #{count}") if count > @runaway_threshold
+    end
+
+    def clear
+      @events.clear
+    end
+
+    def notify(event, *args)
+      return unless @events.has_key?(event)
+
+      @events[event].each do |handler|
+        begin
+          handler.call(*args)
+        rescue => err
+          logger.debug("Failure during notify for #{@event}\n#{err.class} #{err.message}")
+        end
+      end
+    end
+
+    @@logger = nil
+
+    def self.logger
+      @@logger ||= ::Logger.new($stdout)
+    end
+
+    def self.logger=(new_logger)
+      @@logger = new_logger
+    end
+
+    def logger
+      self.class.logger
+    end
+
+    def logger=(new_logger)
+      self.class.logger = new_logger
+    end
+
+  end
+end
+

data/lib/simple_events/version.rb

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

data/simple_events.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_events/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_events"
+  spec.version       = SimpleEvents::VERSION
+  spec.authors       = ["Jason R. Clark"]
+  spec.email         = ["jason@jasonrclark.net"]
+  spec.description   = %q{A basic event notification system}
+  spec.summary       = %q{Simple Events provides basic, synchronous, in-process event dispatch to help in decoupling your app}
+  spec.homepage      = "http://github.com/jasonrclark/simple_events"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/test/lib/simple_events/notifier_test.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','minitest_helper'))
+
+class NotifierTest < MiniTest::Unit::TestCase
+
+  def setup
+    @events = SimpleEvents::Notifier.new
+    @events.logger = MiniTest::Mock.new
+    @events.logger.expect(:debug, nil, [String])
+
+    @called = false
+    @called_with = nil
+
+    @check_method = Proc.new do |*args|
+      @called = true
+      @called_with = args
+    end
+  end
+
+  def teardown
+    @events.logger = nil
+  end
+
+  #
+  # Tests
+  #
+
+  def test_notifies
+    @events.subscribe(:before_call, &@check_method)
+    @events.notify(:before_call, :env => "env")
+
+    assert_was_called
+    assert_equal([{:env => "env"}], @called_with)
+  end
+
+  def test_failure_during_notify_doesnt_block_other_hooks
+    @events.subscribe(:after_call) { raise "Boo!" }
+    @events.subscribe(:after_call, &@check_method)
+
+    @events.notify(:after_call)
+
+    assert_was_called
+  end
+
+  def test_runaway_events
+    logger = MiniTest::Mock.new
+    logger.expect(:debug, nil, [String])
+    SimpleEvents::Notifier.logger = logger
+
+    @events.runaway_threshold = 0
+    @events.subscribe(:my_event) {}
+
+    logger.verify
+  ensure
+    SimpleEvents::Notifier.logger = nil
+  end
+
+  def test_clear
+    @events.subscribe(:after_call, &@check_method)
+    @events.clear
+    @events.notify(:after_call)
+
+    assert_was_not_called
+  end
+
+  #
+  # Helpers
+  #
+
+  def assert_was_called
+    assert @called, "Event wasn't called"
+  end
+
+  def assert_was_not_called
+    assert !@called, "Event was called"
+  end
+
+end

data/test/lib/simple_events_test.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'..','minitest_helper'))
+
+class TestSimpleEvents < MiniTest::Unit::TestCase
+  def test_that_it_has_a_version_number
+    refute_nil ::SimpleEvents::VERSION
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'simple_events'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: simple_events
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason R. Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A basic event notification system
+email:
+- jason@jasonrclark.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simple_events.rb
+- lib/simple_events/notifier.rb
+- lib/simple_events/version.rb
+- simple_events.gemspec
+- test/lib/simple_events/notifier_test.rb
+- test/lib/simple_events_test.rb
+- test/minitest_helper.rb
+homepage: http://github.com/jasonrclark/simple_events
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Simple Events provides basic, synchronous, in-process event dispatch to help
+  in decoupling your app
+test_files:
+- test/lib/simple_events/notifier_test.rb
+- test/lib/simple_events_test.rb
+- test/minitest_helper.rb