ruby_events 0.0.3 → 0.0.4

data/Rakefile

@@ -12,7 +12,7 @@ require 'rake/testtask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'ruby_events'
-  s.version = '0.0.3'
+  s.version = '0.0.4'
   s.has_rdoc = true
   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!'
@@ -32,9 +32,9 @@ Rake::GemPackageTask.new(spec) do |p|
 end
 
 Rake::RDocTask.new do |rdoc|
-  files =['README', 'LICENSE', 'lib/**/*.rb']
+  files =['README.markdown', 'lib/**/*.rb']
   rdoc.rdoc_files.add(files)
-  rdoc.main = "README" # page to start on
+  rdoc.main = "README.markdown" # page to start on
   rdoc.title = "ruby_events Docs"
   rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
   rdoc.options << '--line-numbers'

data/lib/ruby_events.rb

@@ -1,20 +1,26 @@
+# 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
   class Events
+    # Initialize the events class by instantiating the class methods we'll be
+    # using.
     def initialize(parent)
       @parent = parent
       @events = {}
     end
 
+    # Add a listener to the passed event type.
     def listen(event_type, &event)
       @events[event_type] = [] unless @events.has_key? event_type
       # TODO: Can we allow both block and an array of Proc's here?
-#      events = [events] unless events.respond_to? :each
-#      events.each do |event|
-#        @events[event_type] << event
-#      end
       @events[event_type] << event
     end
 
+    # Fire all registered listeners to the passed event, passing them the
+    # arguments as provided.
     def fire(event_type, *arguments)
       if @events.has_key?(event_type)
         @events[event_type].each do |event|
@@ -23,16 +29,19 @@ module RubyEvents
       end
     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)
       old_method = (method.to_s + '_event_old').to_sym
       if @parent && @parent.respond_to?(method) && !@parent.respond_to?(old_method)
-        @parent.class.class_eval do
+        @parent = @parent.class
+        @parent.class_eval do
           alias_method old_method, method
         end
         
-        # FIXME: Without the internet, this is all I could remember; there is
-        # definitely a better way to do this, so please fix it!
-        #
+        method = method.to_s
+        old_method = old_method.to_s
+        
         # FIXME: We need to find a way to call the block that's been passed
         # so they can define the arguments they want to pass to the event.
         #
@@ -42,12 +51,13 @@ module RubyEvents
         #
         # Make sure the self.send is at the end, or we won't return what we
         # are supposed to.
-        @parent.class.class_eval('def ' + method.to_s + '(*args); events.fire(:' + event_type.to_s + ', *args); self.send("' + old_method.to_s + '".to_sym, *args); end')
+        @parent.class_eval('def ' + method + '(*args); events.fire(:' + event_type + ', *args); self.send("' + old_method + '".to_sym, *args); end')
       else
         # TODO: Need to raise exception here.
       end
     end
 
+    # Remove a method from the listening queue.
     def remove(event_type, event)
       if @events.has_key?(event_type)
         @events[event_type].delete_if {|stored_event| stored_event == event}
@@ -56,12 +66,13 @@ module RubyEvents
   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 || @events = RubyEvents::Events.new(self)
   end
-
-  def events=(events)
-    @events = events
-  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Nathan Kleyn
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-26 00:00:00 +01:00
+date: 2010-04-29 00:00:00 +01:00
 default_executable: 
 dependencies: []