bjallen-hit_me_back 1.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 B.J. Allen
+
+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.rdoc

@@ -0,0 +1,7 @@
+= hit_me_back
+
+Hit Me Back is a simple subscribe/notify observer pattern framework. It has no dependencies which allows it to work well in situations where you are packaging up self-contained applications that may or may not be using their own embedded ruby vm.
+
+== Copyright
+
+Copyright (c) 2009 B.J. Allen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hit_me_back"
+    gem.summary = %Q{Hit Me Back is a simple subscribe/notify observer pattern framework.}
+    gem.description = %Q{Simple subscribe/notify observer pattern framework for Ruby projects}
+    gem.email = "bjallen@mac.com"
+    gem.homepage = "http://github.com/bjallen/hit_me_back"
+    gem.authors = ["B.J. Allen"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hit_me_back #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/hit_me_back.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hit_me_back}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["B.J. Allen"]
+  s.date = %q{2009-07-03}
+  s.description = %q{Simple subscribe/notify observer pattern framework for Ruby projects}
+  s.email = %q{bjallen@mac.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "hit_me_back.gemspec",
+     "lib/hit_me_back.rb",
+     "lib/hit_me_back/event.rb",
+     "pkg/hit_me_back-0.0.0.gem",
+     "pkg/hit_me_back-1.0.0.gem",
+     "test/hit_me_back_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bjallen/hit_me_back}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Hit Me Back is a simple subscribe/notify observer pattern framework.}
+  s.test_files = [
+    "test/hit_me_back_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/hit_me_back/event.rb

@@ -0,0 +1,10 @@
+module HitMeBack
+  class Event
+    attr_accessor :name, :listeners
+    def initialize(name, obj)
+      @name = name
+      @listeners = []
+      @listeners << obj
+    end
+  end
+end

data/lib/hit_me_back.rb

@@ -0,0 +1,29 @@
+module HitMeBack
+  
+  attr_accessor :events
+  
+  def add_listener(event_name, listener)
+    @events = [] if @events.nil?
+    matching_events = @events.find_all { |event| event.name == event_name }
+
+    if matching_events.empty?
+      @events << Event.new(event_name, listener)
+    else
+      matching_events.first.listeners << listener
+    end
+  end
+  
+  def remove_listener(event_name, listener)
+    event = @events.find { |x| x.name == event_name }
+    event.listeners.reject! { |x| x == listener } unless event.nil?
+  end
+  
+  def notify_listeners(event_name)
+    event = @events.find { |x| x.name == event_name }
+    event.listeners.each do |listener|
+      listener.send(event.name, self) if listener.respond_to?(event.name)
+    end unless event.nil?
+  end
+end
+
+require 'hit_me_back/event'

data/test/hit_me_back_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+class HitMeBackTest < Test::Unit::TestCase
+  
+  def setup
+    @ac = AppController.new
+    @bp = BackgroundProcess.new
+  end
+  
+  def test_for_addition_of_module_methods
+    x = PlainClass.new
+    methods_to_check_for = ['events','add_listener','remove_listener','notify_listeners']   
+    common_methods_before = methods_to_check_for & x.methods  
+    x.extend(HitMeBack)   
+    common_methods_after = methods_to_check_for & x.methods   
+    assert_equal common_methods_after.size, common_methods_before.size + methods_to_check_for.size
+  end
+  
+  def test_for_ability_to_add_an_event
+    @bp.add_listener(:something_happened, @ac)
+    assert !@bp.events.find { |x| x.name == :something_happened }.nil?
+  end
+  
+  def test_for_ability_to_add_listener
+    @bp.add_listener(:something_happened, @ac)
+    event = @bp.events.find { |x| x.name == :something_happened }
+    flunk 'the event called :something_happened was not found' if event.nil?
+    listeners = event.listeners.find_all { |x| x.class == AppController }
+    assert_equal listeners.size, 1
+  end
+  
+  def test_for_ability_to_remove_listener
+    @bp.add_listener(:something_happened, @ac)
+    @bp.remove_listener(:something_happened, @ac)
+    event = @bp.events.find { |x| x.name == :something_happened }
+    flunk 'the event called :something_happened was not found' if event.nil?
+    listeners = event.listeners.find_all { |x| x.class == AppController }
+    assert_equal listeners.size, 0
+  end
+  
+  def test_that_correct_method_is_called_on_listener
+    @bp.add_listener(:something_happened, @ac)
+    @bp.add_listener(:process_completed, @ac)
+    flunk 'the notified flag was true too early' if @ac.notified_of_completion
+    @bp.notify_listeners(:something_happened)
+    flunk 'the notified flag was set for the wrong event' if @ac.notified_of_completion
+    @bp.notify_listeners(:process_completed)
+    assert @ac.notified_of_completion
+  end
+  
+  def test_that_the_notifier_is_passed_to_the_listener
+    @bp.name = 'my process 1234'
+    @bp.add_listener(:process_completed, @ac)
+    @bp.notify_listeners(:process_completed)
+    assert_equal @ac.notifier.name, 'my process 1234'
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hit_me_back'
+
+class Test::Unit::TestCase
+end
+
+class AppController
+  attr_accessor :process_started, :notified_of_completion
+  attr_accessor :notifier
+  def initialize
+    @process_started = false
+    @notified_of_completion = false
+  end
+  
+  def start_process
+    @process_started = true
+  end
+  
+  def process_completed(obj)
+    @notified_of_completion = true
+    @notifier = obj
+  end
+end
+
+class BackgroundProcess  
+  include HitMeBack
+  attr_accessor :process_started, :notified_of_completion
+  attr_accessor :name
+  def initialize
+    @process_started = false
+    @notified_of_completion = false
+  end
+
+  def start_process
+    @process_started = true
+  end
+  
+  def process_completed
+    @notified_of_completion = true
+  end
+end
+
+class PlainClass
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: bjallen-hit_me_back
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- B.J. Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simple subscribe/notify observer pattern framework for Ruby projects
+email: bjallen@mac.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- LICENSE
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- hit_me_back.gemspec
+- lib/hit_me_back.rb
+- lib/hit_me_back/event.rb
+- pkg/hit_me_back-0.0.0.gem
+- pkg/hit_me_back-1.0.0.gem
+- test/hit_me_back_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/bjallen/hit_me_back
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Hit Me Back is a simple subscribe/notify observer pattern framework.
+test_files: 
+- test/hit_me_back_test.rb
+- test/test_helper.rb