foca-beacon 0.1

data/.gitignore

@@ -0,0 +1,2 @@
+doc
+*.gem

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2008-2009 Nicolas Sanguinetti, entp.com
+
+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,57 @@
+= Beacon
+
+Simple observers and notifiers for your code.
+
+The library aims to provide the simplest implementation possible. You get 
+<i>beacons</i>, which are always global and can be "lit up". Whenever you
+light a beacon up, everyone watching will act as instructed.
+
+== How to use this?
+
+Whenever you want to fire an event from your code, call <tt>Beacon.fire</tt>:
+
+    def do_something
+      Beacon.fire(:before_doing_something)
+      # do your thing
+    end
+
+In order to register listeners for that event, call <tt>Beacon.watch</tt>:
+
+    Beacon.watch :before_doing_something do
+      logger.info "I'm about to do something"
+    end
+
+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.
+
+== Passing arguments
+
+If you want to pass arguments to the watchers, just pass them along in
+<tt>Beacon.fire</tt>:
+
+    Beacon.fire(:an_event, "cuack", 3)
+
+And you'll get them as arguments on the block that handles the message:
+
+    Beacon.watch :an_event do |object, index|
+      # here object == "cuack", index == 3
+    end
+
+== 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
+
+== License
+
+The code is licensed under an MIT license. Check the LICENSE file for details.

data/Rakefile

@@ -0,0 +1,34 @@
+require 'spec/rake/spectask'
+
+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
+
+desc "Default: run all tests"
+task :default => :spec
+
+desc "Run library tests"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.title = "Beacon Documentation"
+  rd.rdoc_files.include("README.rdoc", "LICENSE", "lib/**/*.rb")
+  rd.rdoc_dir = "doc"
+end

data/beacon.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name    = "beacon"
+  s.version = "0.1"
+  s.date    = "2009-04-25"
+
+  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.email   = "contacto@nicolassanguinetti.info"
+
+  s.require_paths     = ["lib"]
+  s.has_rdoc          = true
+  s.rubygems_version  = "1.3.1"
+
+  if s.respond_to?(:add_development_dependency)
+    s.add_development_dependency "sr-mg"
+    s.add_development_dependency "rspec"
+  end
+
+  s.files = %w[
+.gitignore
+LICENSE
+README.rdoc
+Rakefile
+beacon.gemspec
+lib/beacon.rb
+]
+end

data/lib/beacon.rb

@@ -0,0 +1,41 @@
+module Beacon
+  # 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)
+    events[event].each do |callback|
+      callback.call(*args)
+    end
+  end
+
+  # 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.
+  #
+  #     Beacon.watch :some_event do |foo, bar, baz|
+  #       # do stuff with foo, bar, and baz
+  #     end
+  #
+  # 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 self.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
+
+  def self.events
+    @events ||= Hash.new {|h,k| h[k] = [] }
+  end
+  private_class_method :events
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: foca-beacon
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- "Nicol\xC3\xA1s Sanguinetti"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sr-mg
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple and straightforward observers for your code
+email: contacto@nicolassanguinetti.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- beacon.gemspec
+- lib/beacon.rb
+has_rdoc: true
+homepage: http://github.com/foca/beacon
+post_install_message: 
+rdoc_options: []
+
+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: 2
+summary: Simple and straightforward observers for your code
+test_files: []
+