beacon 0.1 → 0.9.0

data/.gitignore

@@ -1,2 +1,3 @@
-doc
-*.gem
+/doc
+/pkg
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode
+env:
+  - RUBYOPT="$RUBYOPT -Ilib"
+notifications:
+  email:
+    - contacto@nicolassanguinetti.info

data/CHANGES

@@ -0,0 +1,11 @@
+0.9 - March 20th, 2012
+----------------------
+
+* Support for isolated events.
+* Beacon is now a mixin.
+* Added aliases `on` and `trigger` for `watch` and `fire`.
+
+0.1 - April 25th, 2009
+----------------------
+
+Initial release!

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.rdoc

@@ -25,6 +25,10 @@ Each time you call <tt>watch</tt> with a given name, you register a different
 handler for that name. Each time you call <tt>fire</tt> <b>all</b> handlers
 for that event are run, in the order they were registered.
 
+You can use <tt>on</tt> as an alias of <tt>watch</tt>, and <tt>trigger</tt> as
+an alias of <tt>fire</tt>, since those seem to be popular choices among event
+observing libraries.
+
 == Passing arguments
 
 If you want to pass arguments to the watchers, just pass them along in
@@ -38,6 +42,47 @@ And you'll get them as arguments on the block that handles the message:
       # here object == "cuack", index == 3
     end
 
-== License
+== Advanced handlers
+
+Instead of blocks, <tt>Beacon.watch</tt> can receive any object that responds
+to <tt>call</tt>, so if you need any advanced logic in your handlers, you can
+declare them like this:
+
+    class MyHandler
+      def call(foo, bar=0)
+        puts foo.inspect, bar
+      end
+    end
+
+    Beacon.watch :an_event, MyHandler.new
+
+== Isolated events
+
+You can include Beacon into your objects to have isolated events on a per-object
+basis if you need that:
+
+    class MyObservable
+      include Beacon
+    end
+
+    obj = MyObservable.new
+    obj.watch(:an_event) { |object, *args| puts *args }
+    obj.trigger(:an_event, "foo")
+
+== Installing with rubygems
+
+    gem install beacon
+
+== Contributing
+
+Clone our git repo from <tt>git://github.com/foca/beacon.git</tt>. The preffered
+way to send a patch is to push to a clone of the repo on github[http://github.com]
+but if you want to mail me a patch or point me to a diff I won't complain. Though
+I'll probably take more to apply it :)
+
+== Authors
+
+Code written by foca[http://github.com/foca], with the help and ideas of
+halorgium[http://github.com/halorgium], and tizoc[http://github.com/tizoc].
 
 The code is licensed under an MIT license. Check the LICENSE file for details.

data/Rakefile

@@ -1,33 +1,25 @@
-require "rake/testtask"
-
-begin
-  require "hanna/rdoctask"
-rescue LoadError
-  require "rake/rdoctask"
-end
-
-begin
-  require "metric_fu"
-rescue LoadError
-end
-
-begin
-  require "mg"
-  MG.new("beacon.gemspec")
-rescue LoadError
-end
+require "rspec/core/rake_task"
+require "hanna/rdoctask"
+require "rubygems/package_task"
 
 desc "Default: run all tests"
-task :default => :test
+task default: :spec
 
-desc "Run web application tests"
-Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList["test/**/*_test.rb"]
+desc "Run library tests"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rspec_opts = %w(-fs --color)
 end
 
 Rake::RDocTask.new do |rd|
-  rd.main = "README"
   rd.title = "Beacon Documentation"
+  rd.main = "README.rdoc"
   rd.rdoc_files.include("README.rdoc", "LICENSE", "lib/**/*.rb")
   rd.rdoc_dir = "doc"
 end
+
+gem_spec = eval(File.read("./beacon.gemspec")) rescue nil
+Gem::PackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end

data/beacon.gemspec

@@ -1,31 +1,22 @@
 Gem::Specification.new do |s|
   s.name    = "beacon"
-  s.version = "0.1"
-  s.date    = "2009-04-22"
+  s.version = "0.9.0"
+  s.date    = "2012-03-20"
 
   s.description = "Simple and straightforward observers for your code"
   s.summary     = "Simple and straightforward observers for your code"
   s.homepage    = "http://github.com/foca/beacon"
 
-  s.authors = ["Nicolás Sanguinetti"]
+  s.authors = ["Nicolas Sanguinetti"]
   s.email   = "contacto@nicolassanguinetti.info"
 
   s.require_paths     = ["lib"]
   s.has_rdoc          = true
-  s.rubygems_version  = "1.3.1"
+  s.rubyforge_project = "beacon"
 
-  if s.respond_to?(:add_development_dependency)
-    s.add_development_dependency "sr-mg"
-    s.add_development_dependency "contest"
-    s.add_development_dependency "redgreen"
-  end
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "hanna", "~> 0.1"
 
-  s.files = %w[
-.gitignore
-LICENSE
-README.rdoc
-Rakefile
-beacon.gemspec
-lib/beacon.rb
-]
+  s.files = `git ls-files`.split "\n"
+  s.platform = Gem::Platform::RUBY
 end

data/lib/beacon.rb

@@ -1,13 +1,16 @@
 module Beacon
+  extend self
+
   # Fire an event to be processed by all the watchers. You pass the event name
   # and any arguments you want passed to the event handlers.
   #
   #     Beacon.fire(:some_event, "an argument", 2, "another")
-  def self.fire(event, *args)
+  def fire(event, *args)
     events[event].each do |callback|
       callback.call(*args)
     end
   end
+  alias_method :trigger, :fire
 
   # Register a callback for a given event. Each time you call <tt>fire</tt> then
   # all the callbacks registered for that name will be called in order.
@@ -15,12 +18,28 @@ module Beacon
   #     Beacon.watch :some_event do |foo, bar, baz|
   #       # do stuff with foo, bar, and baz
   #     end
-  def self.watch(event, &handler)
+  #
+  # Instead of passing a block, you can pass any object that responds to 
+  # <tt>#call</tt>. Like this:
+  #
+  #     class MyHandler
+  #       def call(foo=1, bar=2, baz=3)
+  #         puts foo, bar, baz
+  #       end
+  #     end
+  #
+  #     Beacon.watch :some_event, MyHandler.new
+  def watch(event, handler=nil, &default_handler)
+    if handler && block_given?
+      raise ArgumentError, "You cannot register a handler with both a block and an object"
+    end
+    handler = handler || default_handler || raise(ArgumentError, "You must provide a handler")
     events[event] << handler
   end
+  alias_method :on, :watch
 
-  def self.events
+  def events
     @events ||= Hash.new {|h,k| h[k] = [] }
   end
-  private_class_method :events
+  private :events
 end

data/spec/fire_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe Beacon do
+  describe "with a pass-through handler watching :event" do
+    before(:each) do
+      @args = nil
+      Beacon.watch(:event) do |*args|
+        @args = args
+      end
+    end
+
+    it "allows firing an event with no args" do
+      Beacon.fire(:event)
+      @args.should == []
+    end
+
+    it "allows firing an event with 1 arg" do
+      Beacon.fire(:event, :test)
+      @args.should == [:test]
+    end
+
+    it "allows firing an event with args and options" do
+      Beacon.fire(:event, :foo, :bar, :baz => :quux)
+      @args.should == [:foo, :bar, {:baz => :quux}]
+    end
+  end
+end

data/spec/isolated_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Beacon do
+  class Observable < Struct.new(:int)
+    include Beacon
+  end
+
+  let(:observable_1) { Observable.new(1) }
+  let(:observable_2) { Observable.new(1) }
+
+  before do
+    observable_1.watch(:inc) { observable_1.int += 1 }
+  end
+
+  it "can listen to events on instances of objects where you mix in Beacon" do
+    expect { observable_1.trigger(:inc) }.to change { observable_1.int }.by(1)
+  end
+
+  it "will ignore events fired on other instances" do
+    expect { observable_2.trigger(:inc) }.to_not change { observable_1.int }.by(1)
+    expect { Beacon.trigger(:inc) }.to_not change { observable_1.int }.by(1)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "beacon"
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Beacon.instance_variable_set(:@events, nil)
+  end
+end

data/spec/watch_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+class Handler
+  def initialize
+    @value = nil
+  end
+  attr_reader :value
+
+  def call
+    @value = 1
+  end
+end
+
+describe Beacon do
+  it "allows watching an event with a block" do
+    value = nil
+    Beacon.watch(:event) do
+      value = 1
+    end
+    Beacon.fire(:event)
+    value.should == 1
+  end
+
+  it "allows watching an event with an object" do
+    handler = Handler.new
+    Beacon.watch(:event, handler)
+    Beacon.fire(:event)
+    handler.value.should == 1
+  end
+
+  it "disallows watching an event without either a block or an object" do
+    lambda { Beacon.watch(:event) }.
+      should raise_error(ArgumentError, "You must provide a handler")
+  end
+
+  it "disallows watching an event both a block and an object" do
+    lambda {
+      Beacon.watch(:event, Handler.new) do
+        nil
+      end
+    }.should raise_error(ArgumentError, "You cannot register a handler with both a block and an object")
+  end
+end

metadata

@@ -1,87 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: beacon
-version: !ruby/object:Gem::Version 
-  version: "0.1"
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
 platform: ruby
-authors: 
-- "Nicol\xC3\xA1s Sanguinetti"
+authors:
+- Nicolas Sanguinetti
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-04-22 00:00:00 -03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: sr-mg
+date: 2012-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70336345771700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: contest
+  prerelease: false
+  version_requirements: *70336345771700
+- !ruby/object:Gem::Dependency
+  name: hanna
+  requirement: &70336345769800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: redgreen
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+  prerelease: false
+  version_requirements: *70336345769800
 description: Simple and straightforward observers for your code
 email: contacto@nicolassanguinetti.info
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
+- CHANGES
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
 - beacon.gemspec
 - lib/beacon.rb
-has_rdoc: true
+- spec/fire_spec.rb
+- spec/isolated_spec.rb
+- spec/spec_helper.rb
+- spec/watch_spec.rb
 homepage: http://github.com/foca/beacon
+licenses: []
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1274202390002964611
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1274202390002964611
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.1
+rubyforge_project: beacon
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Simple and straightforward observers for your code
 test_files: []
-