ruby_events 1.1.0.beta2 → 1.1.0

data/README.markdown

@@ -60,6 +60,11 @@ a little bit of sugar:
     
     a << 'this is a test'
     
+You can supply multiple methods to fire a single event type on, useful for
+catching methods and their aliases:
+
+    a.events.fire_on_method(['<<'.to_sym, :push], :item_injected)
+    
 You can supply the `listen` method with a Proc, an array of Procs, or a block.
 You can also give it a mixute of Procs and a block if you really want:
 
@@ -88,3 +93,27 @@ Effectively, you can use the events as callbacks on any method:
     puts a.merge(b)
 
 All ruby_events functionality is just an object.events call away.
+
+## Licence
+
+The MIT License
+
+Copyright (c) 2011 Nathan Kleyn
+
+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/Rakefile

@@ -1,32 +1,9 @@
-require 'lib/ruby_events'
 require 'rubygems'
 require 'rake'
 require 'rake/clean'
-require 'rubygems/package_task'
 require 'rdoc/task'
 require 'rake/testtask'
 
-spec = Gem::Specification.new do |s|
-  s.name = 'ruby_events'
-  s.version = RubyEvents::Events.version
-  s.extra_rdoc_files = ['README.markdown']
-  s.summary = 'A really simple event implementation that hooks into the Object class. Now all your objects can join in the fun of firing events!'
-  s.description = s.summary + ' See http://github.com/nathankleyn/ruby_events for more information.'
-  s.author = 'Nathan Kleyn'
-  s.email = 'nathan@unfinitydesign.com'
-  s.homepage = 'http://github.com/nathankleyn/ruby_events'
-  # s.executables = ['your_executable_here']
-  s.files = %w(README.markdown Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
-  s.require_path = "lib"
-  s.bindir = "bin"
-end
-
-Gem::PackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  p.need_tar = true
-  p.need_zip = true
-end
-
 RDoc::Task.new do |rdoc|
   files =['README.markdown', 'lib/**/*.rb']
   rdoc.rdoc_files.add(files)

data/lib/ruby_events.rb

@@ -1,112 +1,2 @@
-# The RubyEvents module contains the core logic used by the events firing class.
-# All Object's are extended by default with an events accessor that is set to
-# an instance of the RubyEvents::Events class. By calling the methods on this
-# accessor, you can set up and listen to events or callbacks as fired by this
-# class.
-module RubyEvents
-  # The Events class. Contains all the methods and functionality that drives
-  # the actual processes of adding, listening, calling and receiving events.
-  class Events
-    # The current version of RubyEvents.
-    def self.version
-      '1.1.0.beta2'
-    end
-    
-    # Initialize the events class by instantiating the class methods we'll be
-    # using.
-    def initialize(parent)
-      @parent, @events = parent, {}
-    end
-
-    # Add a listener to the passed event type. You can pass a Proc, an array of
-    # Proc's, or a block.
-    def listen(event_type, procs = nil, &block)
-      @events[event_type] = [] unless event_is_defined(event_type)
-      procs_collected = []
-      if procs.respond_to?(:each) && procs.respond_to?(:to_a)
-        procs_collected += procs.to_a
-      elsif procs
-        procs_collected << procs
-      end
-      procs_collected << block if block
-      @events[event_type] += procs_collected
-    end
-
-    # Fire all registered listeners to the passed event, passing them the
-    # arguments as provided.
-    def fire(event_type, *arguments)
-      @events[event_type].each do |event|
-        event.call(*arguments)
-      end if event_is_defined(event_type)
-    end
-    
-    # Set an event to fire when passed method is called. This is useful for
-    # adding callbacks or events to built-in methods.
-    def fire_on_method(method, event_type, &block)
-      # We alias @parent to parent here, because class_eval can't see outside
-      # this scope otherwise.
-      parent, old_method = @parent, ('ruby_events_' + method.to_s + '_event_old').to_sym
-      if parent && parent.respond_to?(method)
-        parent.class.class_eval do
-          # If the parent is already responding to the alias method, it means
-          # the fire_on_method event was already triggered. Remove the other
-          # event and continue if this happens.
-          if parent.respond_to?(old_method, true)
-            remove_method method
-            alias_method method, old_method
-            remove_method old_method
-          end
-        
-          alias_method old_method, method
-          private old_method
-          
-          # Make sure the self.send is at the end, or we won't return what we
-          # are supposed to.
-          define_method method do |*args|
-            events.fire(event_type, *args)
-            block.call(*args) if block # Calling the block we've been passed
-            __send__(old_method, *args)
-          end
-        end
-      else
-        raise 'The given object does not respond to method you are trying to intercept calls to.'
-      end
-    end
-
-    # Remove a method from the listening queue.
-    def remove(event_type, event)
-      @events[event_type].delete_if {|stored_event| stored_event == event} if event_is_defined(event_type)
-    end
-
-    # Remove a fire on method alias event.
-    def remove_fire_on_method(method)
-      parent, old_method = @parent, ('ruby_events_' + method.to_s + '_event_old').to_sym
-      parent.class.class_eval do
-        if parent.respond_to?(old_method, true)
-          remove_method method
-          alias_method method, old_method
-          public method
-        else
-          raise 'The fire on method trigger you were trying to remove does not exist.'
-        end
-      end
-    end
-    
-    private
-    # Checks if an event of event_type is defined in the collection of events.
-    def event_is_defined(event_type)
-      @events.has_key?(event_type)
-    end
-  end
-end
-
-# Extending the Object class with the events accessor.
-class Object
-  attr_writer :events
-  
-  # Attribute reader for the events accessor. Returns a new instance of the
-  # events class if not defined, or the already defined class otherwise.
-  def events
-    @events ||= RubyEvents::Events.new(self)
-  end
-end
+require File.join(File.dirname(__FILE__), "ruby_events/core")
+require File.join(File.dirname(__FILE__), "ruby_events/object_patch")

data/lib/ruby_events/core.rb

@@ -0,0 +1,106 @@
+# The RubyEvents module contains the core logic used by the events firing class.
+# All Object's are extended by default with an events accessor that is set to
+# an instance of the RubyEvents::Events class. By calling the methods on this
+# accessor, you can set up and listen to events or callbacks as fired by this
+# class.
+module RubyEvents
+  # The Events class. Contains all the methods and functionality that drives
+  # the actual processes of adding, listening, calling and receiving events.
+  class Events
+    # The current version of RubyEvents.
+    def self.version
+      '1.1.0'
+    end
+    
+    # Initialize the events class by instantiating the class methods we'll be
+    # using.
+    def initialize(parent)
+      @parent, @events = parent, {}
+    end
+
+    # Add a listener to the passed event type. You can pass a Proc, an array of
+    # Proc's, or a block.
+    def listen(event_type, procs = nil, &block)
+      @events[event_type] = [] unless event_is_defined(event_type)
+      procs_collected = []
+      if procs.respond_to?(:each) && procs.respond_to?(:to_a)
+        procs_collected += procs.to_a
+      elsif procs
+        procs_collected << procs
+      end
+      procs_collected << block if block
+      @events[event_type] += procs_collected
+    end
+
+    # Fire all registered listeners to the passed event, passing them the
+    # arguments as provided.
+    def fire(event_type, *arguments)
+      @events[event_type].each do |event|
+        event.call(*arguments)
+      end if event_is_defined(event_type)
+    end
+    
+    # Set an event to fire when passed method is called. This is useful for
+    # adding callbacks or events to built-in methods.
+    def fire_on_method(method, event_type, &block)
+      if method.is_a? Array
+        method.map { |sym| fire_on_method(sym, event_type, &block) }
+        return
+      end
+      
+      # We alias @parent to parent here, because class_eval can't see outside
+      # this scope otherwise.
+      parent, old_method = @parent, ('ruby_events_' + method.to_s + '_event_old').to_sym
+      if parent && parent.respond_to?(method)
+        parent.class.class_eval do
+          # If the parent is already responding to the alias method, it means
+          # the fire_on_method event was already triggered. Remove the other
+          # event and continue if this happens.
+          if parent.respond_to?(old_method, true)
+            remove_method method
+            alias_method method, old_method
+            remove_method old_method
+          end
+        
+          alias_method old_method, method
+          private old_method
+          
+          # Make sure the self.send is at the end, or we won't return what we
+          # are supposed to.
+          define_method method do |*args|
+            events.fire(event_type, *args)
+            block.call(*args) if block # Calling the block we've been passed
+            __send__(old_method, *args)
+          end
+        end
+      else
+        raise 'The given object does not respond to method you are trying to intercept calls to.'
+      end
+    end
+
+    # Remove a method from the listening queue.
+    def remove(event_type, event)
+      @events[event_type].delete_if {|stored_event| stored_event == event} if event_is_defined(event_type)
+    end
+
+    # Remove a fire on method alias event.
+    def remove_fire_on_method(method)
+      parent, old_method = @parent, ('ruby_events_' + method.to_s + '_event_old').to_sym
+      parent.class.class_eval do
+        if parent.respond_to?(old_method, true)
+          remove_method method
+          alias_method method, old_method
+          public method
+        else
+          raise 'The fire on method trigger you were trying to remove does not exist.'
+        end
+      end
+    end
+    
+    private
+    # Checks if an event of event_type is defined in the collection of events.
+    def event_is_defined(event_type)
+      @events.has_key?(event_type)
+    end
+  end
+end

data/lib/ruby_events/object_patch.rb

@@ -0,0 +1,10 @@
+# Extending the Object class with the events accessor.
+class Object
+  attr_writer :events
+  
+  # Attribute reader for the events accessor. Returns a new instance of the
+  # events class if not defined, or the already defined class otherwise.
+  def events
+    @events ||= RubyEvents::Events.new(self)
+  end
+end

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_events
 version: !ruby/object:Gem::Version 
-  hash: 62196375
-  prerelease: 6
+  hash: 19
+  prerelease: 
   segments: 
   - 1
   - 1
   - 0
-  - beta
-  - 2
-  version: 1.1.0.beta2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Nathan Kleyn
@@ -17,10 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-28 00:00:00 Z
-dependencies: []
-
-description: A really simple event implementation that hooks into the Object class. Now all your objects can join in the fun of firing events! See http://github.com/nathankleyn/ruby_events for more information.
+date: 2011-06-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A really simple event implementation that hooks into the Object classpec. Now all your objects can join in the fun of firing events! See http://github.com/nathankleyn/ruby_events for more information.
 email: nathan@unfinitydesign.com
 executables: []
 
@@ -32,6 +43,8 @@ files:
 - README.markdown
 - Rakefile
 - lib/ruby_events.rb
+- lib/ruby_events/object_patch.rb
+- lib/ruby_events/core.rb
 homepage: http://github.com/nathankleyn/ruby_events
 licenses: []
 
@@ -52,20 +65,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: A really simple event implementation that hooks into the Object class. Now all your objects can join in the fun of firing events!
+summary: A really simple event implementation that hooks into the Object classpec. Now all your objects can join in the fun of firing events!
 test_files: []