eventable 0.1.3 → 0.1.4

data/README.markdown

@@ -27,7 +27,7 @@ Events and threads do not scale well past a certain point but that's OK; they ar
 ##Usage Instructions##
 
 * Include the module
-* **Important:** If you have an initialize method call `super` as first line (see below). If you don't have an initialize method you don't have to add one. Super is called automatically for you.
+* **Important:** If you have an initialize method `super` must be the first line of that method (see below). If you don't have an initialize method you don't have to add one. Super is called automatically for you.
 * Add an event, e.g. `event :your_event`
 * Fire the event when it should be fired: `fire_event(:your_event)`
 
@@ -137,12 +137,11 @@ This example shows you how you might actually use it in a multi-threaded environ
       end
   
       def stuff_happened(stuff)
-        splat = stuff
-        puts "[#{splat[:parent_id]}] stuff_happened callback: #{splat[:some_value]}"
+        puts "[#{stuff[:parent_id]}] stuff_happened callback: #{stuff[:some_value]}"
       end
   
       def other_stuff_happened
-        puts "[n/a] same_stuff_happened callback: n/a"
+        puts "[n/a] other_stuff_happened callback: n/a"
       end
   
     end
@@ -156,7 +155,9 @@ This example shows you how you might actually use it in a multi-threaded environ
     # or attach to events outside of a listener class
     evented.register_for_event(event: :other_stuff_happens, listener: listener, callback: :other_stuff_happened)
 
+    # Start firing off the events
     evented.start_other_stuff_happening
+    
     (1..3).each do |index|
       listener.do_somestuff(index)
       puts "[#{index}] did some stuff, sleeping"
@@ -169,6 +170,17 @@ This example shows you how you might actually use it in a multi-threaded environ
 
 ##Version History##
 
+**2011.07.05**
+Ver: 0.1.4
+
+Updates:
+
+* Added running specs to rake tasks (Colin Gemmell)
+
+Bug fixes:
+
+* Did not accept initialization parameters so caused errors if your class inherited from another class that needed them. (Paul Strong)
+
 **2011.06.28**  
 Ver: 0.1.3  
 
@@ -179,24 +191,25 @@ This patches one of the last concurrency issues; if a callback takes a long time
 
 It's your responsiblity to make sure your callback works, as long as it does the callback thread will go out of scope (unless you retain it) and everyone is happy.  
 
-**2011.06.17**
-Ver: 0.1.2
+**2011.06.17**  
+Ver: 0.1.2  
 
 Design updates/fixes:
 
 * Renamed most instance variables to help avoid name collisions.
-* Threadsafe mutex creation. Make sure you call `super` in your class's initialize method!
+* Threadsafe mutex creation. Make sure you call `super` in your class's initialize method! (Robert Klemme)
 
 **2011.06.10**  
 Ver: 0.1.1  
 
 Features:  
-If events fired specifically returns true and returns false if it can't for whatever reason (e.g. no listeners registered).
+
+* If events fired specifically returns true and returns false if it can't for whatever reason (e.g. no listeners registered).
 
 Fixes:  
 
-* Throws error if event is fired and no listeners are registered (Thanks for bug report Benjamin Yu)
-* Workaround for RubyGems pre 1.8.3 date bug that locks up all of RubyGems (Thanks again Benjamin Yu)
+* Throws error if event is fired and no listeners are registered (Benjamin Yu)
+* Workaround for RubyGems pre 1.8.3 date bug that locks up all of RubyGems (Benjamin Yu)
 
 
 **2011.06.06**  
@@ -210,8 +223,9 @@ Releasing just to stop RubyGems.org from showing last beta instead of newest bet
 
 **2011.06.05**  
 Ver: 0.1.0.beta2  
-Wrapped #\_id2ref call in begin...rescue block.  
-Added thread synchronization to calls that modify or read callbacks cache.
+
+* Wrapped #\_id2ref call in begin...rescue block. (Evan Phoenix)
+* Added thread synchronization to calls that modify or read callbacks cache.
 
 **2011.06.05**  
 Ver: 0.1.0.beta1  
@@ -229,4 +243,13 @@ Garbage collection safe:
 
 **2011.06.04**  
 Ver: 0.0.1.alpha  
-Just wrote it as a proof of concept.  
+Just wrote it as a proof of concept. 
+
+
+##Patches/Pull requests##
+
+* Fork the project.
+* Make your feature addition or bug fix (**do not** alter whitespace unless that is a bug!)
+* Add RSpecs for the fix/feature. If you don't have specs I can't add it.
+* Commit your changes. (**do not** change the rakefile, version, or history)
+* Send a pull request. I respond to pull request very, very quickly.

data/Rakefile

@@ -1 +1,16 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+  t.verbose = false
+end
+
+# Add running specs to the gem tasks
+[:build, :install, :release].each do |task_name|
+  task task_name => :spec
+end

data/lib/eventable/eventable.rb

@@ -30,7 +30,7 @@ module Eventable
     base.extend(EventableEventMethods)
   end
 
-  def initialize
+  def initialize(*args)
     super
     @eventable_mutex = Mutex.new
   end

data/lib/eventable/version.rb

@@ -1,3 +1,3 @@
 module Eventable
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/eventable/eventable_spec.rb

@@ -10,7 +10,7 @@ describe Eventable do
     @listener = ListenClass.new
   end
 
-  context "when inheriting eventable" do
+  context "when mixing in Eventable" do
 
     it "should not raise an error if class has no initialize method" do
       lambda{
@@ -50,6 +50,51 @@ describe Eventable do
       }.should raise_error(Eventable::Errors::SuperNotCalledInInitialize)
     end
 
+    context "and the class inherites from a class with initialization parameters" do
+
+      it "should not raise an error if they are optional and not given" do
+        class Baz
+          def initialize(attributes = nil, options = {})
+          end
+        end
+
+        class Qiz < Baz
+          include Eventable
+        end
+
+        expect{q = Qiz.new}.should_not raise_error
+      end
+
+      it "should not raise an error if they are required and given" do
+        class Baz2
+          def initialize(attributes)
+          end
+        end
+
+        class Qiz2 < Baz2
+          include Eventable
+        end
+        expect{q = Qiz2.new('blah')}.should_not raise_error
+      end
+
+      it "should pass along blocks if given" do
+        class Baz3
+          def initialize(attributes = nil, &block)
+            yield if block_given?
+          end
+        end
+
+        class Qiz3 < Baz3
+          include Eventable
+        end
+        random_value = rand(9999999999)
+        Qiz3.new() { @cheesy = random_value } 
+        @cheesy.should == random_value 
+        remove_instance_variable :@cheesy
+      end
+
+    end
+
   end
 
   context "when specifiying an event" do
@@ -431,4 +476,3 @@ class AnotherListenClass
   end
 end
 
-

metadata

@@ -2,7 +2,7 @@
 name: eventable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Mike Bethany
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-29 00:00:00 Z
+date: 2011-07-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec