publisher 1.1.0 → 1.1.1

data/History.txt

@@ -1,3 +1,7 @@
+== 1.1.1 / 2007-12-28
+
+* Subclasses now inherit the events supported by their ancestors
+
 == 1.1.0 / 2007-11-21
 
 * Moved publisher out of internal AO repository into atomicobject.rb project.

data/README.txt

@@ -1,12 +1,14 @@
-publisher
-* http://rubyforge.org/projects/atomicobjectrb/
-* http://atomicobjectrb.rubyforge.org/constructor
+== Publisher
+
+* http://atomicobject.github.com/publisher
+* http://github.com/atomicobject/publisher
+* http://gemcutter.com/gems/publisher
 
 == DESCRIPTION:
   
 publisher is a module for extending a class with event subscription and firing capabilities.  This is helpful for implementing objects that participate in the Observer design pattern.
 
-== FEATURES/PROBLEMS:
+== FEATURES:
   
 * Nice syntax for declaring events that can be subscribed for
 * Convenient event firing syntax
@@ -73,3 +75,4 @@ 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

@@ -13,6 +13,9 @@ Rake::TestTask.new("test") { |t|
   t.verbose = true
 }
 
+#
+# Hoe stuff: rubyforge project release
+#
 Hoe.new('publisher', Publisher::VERSION) do |p|
   p.rubyforge_name = 'atomicobjectrb'
   p.author = 'Atomic Object'
@@ -20,8 +23,14 @@ Hoe.new('publisher', Publisher::VERSION) do |p|
   p.summary = 'Event subscription and firing mechanism'
   p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
   p.url = p.paragraphs_of('README.txt', 1).first.gsub(/\* /,'').split(/\n/)
-#  p.url = p.paragraphs_of('README.txt', 1).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
 end
 
-# vim: syntax=Ruby
+if File.exists?("../tools/")
+  load "../tools/tasks/homepage.rake"
+  load "../tools/tasks/release_tagging.rake"
+  ReleaseTagging.new do |t|
+    t.package = "publisher"
+    t.version = Publisher::VERSION
+  end
+end

data/lib/publisher.rb

@@ -1,6 +1,6 @@
 # See README.txt for synopsis 
 module Publisher
-  VERSION = "1.1.0" #:nodoc:#
+  VERSION = "1.1.1" #:nodoc:#
 
 	# Use this method (or one of the aliases) to declare which events you support
 	# Once invoked, your class will have the neccessary supporting methods for subscribing and firing.
@@ -13,6 +13,19 @@ module Publisher
 	alias :has_event :has_events
 	alias :can_fire :has_events
 
+  def published_events
+    return @published_events if @published_events == :any_event_is_ok
+    my_events = @published_events || []
+    if self.superclass.respond_to?(:published_events)
+      inherited = self.superclass.published_events
+      if inherited == :any_event_is_ok
+        return :any_event_is_ok
+      end
+      my_events += self.superclass.published_events
+    end
+    my_events
+  end
+
 	# Use this method to allow subscription and firing of arbitrary events.
 	# This is convenient if, eg, your class has dynamic event names.
 	# Don't use this unless you have to; it's better to declare your events if you 
@@ -65,7 +78,8 @@ module Publisher
 		# Does nothing if the current class supports the named event.
 		# Raises RuntimeError otherwise.
 		def ensure_valid(event) #:nodoc:#
-			events = self.class.class_eval { @published_events }
+#			events = self.class.class_eval { @published_events }
+			events = self.class.published_events
 			return if events == :any_event_is_ok
 			raise "Event '#{event}' not available" unless events and events.include?(event)
 		end

data/test/publisher_test.rb

@@ -188,20 +188,6 @@ class PublisherTest < Test::Unit::TestCase
 		assert_equal 'huh', out
 	end
 
-# Cannot inherit events right now
-#  class SomebodyKid < Somebody
-#	end
-#
-#	def test_inheriting_events
-#		obj = SomebodyKid.new
-#		out = nil
-#		obj.on :eat_this do |food|
-#			out = food
-#		end
-#		obj.go "taco"
-#		assert_equal "taco", out
-#	end
-
 	def test_extending_publisher_doesnt_affect_normal_inheritance
 		obj = Billy.new('wheel')
 		assert_equal 'wheel', obj.chair
@@ -248,6 +234,56 @@ class PublisherTest < Test::Unit::TestCase
 		assert_equal "burger", out1, "First subscription no go"
 		assert_equal "burger", out2, "Second subscription no go"
 	end
+
+  def test_subclasses_inherit_events
+    a = []
+    grampa = Grandfather.new
+    grampa.on :cannons do
+      a <<  "grampa's cannons" 
+    end
+
+    dad = Dad.new
+    dad.on :cannons do
+      a <<  "dad's cannons" 
+    end
+
+    dave = Dave.new
+    dave.on :cannons do
+      a <<  "dave's cannons" 
+    end
+    dave.on :specific do
+      a <<  "dave's specific" 
+    end
+
+    grampa.go
+    dad.go
+    dave.go
+    dave.doit
+
+    assert_equal [ 
+      "grampa's cannons",
+      "dad's cannons",
+      "dave's cannons",
+      "dave's specific"
+    ], a
+  end
+
+  def test_subclasses_inherit_wide_open_events
+    a = []
+    dynamo = Dynamo.new
+    dynamo.when :surprise do
+      a << "surprise"
+    end
+    dynamo.go(:surprise)
+
+    son = SonOfDynamo.new
+    son.when :hooray do
+      a << "hooray"
+    end
+    son.kick_it(:hooray)
+
+    assert_equal [ "surprise", "hooray" ], a
+  end
  
 	#
 	# HELPERS
@@ -355,4 +391,38 @@ class PublisherTest < Test::Unit::TestCase
 		end
 	end
 
+  class Grandfather 
+    extend Publisher
+    can_fire :cannons
+
+    def go
+      fire :cannons
+    end
+  end
+
+  class Dad < Grandfather
+  end
+
+  class Dave < Dad
+    can_fire :specific
+
+    def doit
+      fire :specific
+    end
+  end
+  
+  class Dynamo
+    extend Publisher
+    can_fire_anything
+    def go(sym)
+      fire sym
+    end
+  end
+
+  class SonOfDynamo < Dynamo
+    def kick_it(sym)
+      fire sym
+    end
+  end
+
 end

metadata

@@ -1,27 +1,43 @@
 --- !ruby/object:Gem::Specification 
 name: publisher
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-platform: ""
+  version: 1.1.1
+platform: ruby
 authors: 
 - Atomic Object
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2007-11-21 00:00:00 -05:00
+date: 2009-11-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.3.0
+        version: 2.3.3
     version: 
-description: "== FEATURES/PROBLEMS:  * Nice syntax for declaring events that can be subscribed for * Convenient event firing syntax * Subscribe / unsubscribe functionality * Several method name aliases give you the flexibility to make your code more readable (eg, *fire*, *notify*, *emit*)  == SYNOPSIS:  require 'rubygems' require 'publisher'  class CustomerListHolder extend Publisher can_fire :customer_added, :list_cleared"
+description: |-
+  == DESCRIPTION:
+    
+  publisher is a module for extending a class with event subscription and firing capabilities.  This is helpful for implementing objects that participate in the Observer design pattern.
+  
+  == FEATURES:
+    
+  * Nice syntax for declaring events that can be subscribed for
+  * Convenient event firing syntax
+  * Subscribe / unsubscribe functionality
+  * Several method name aliases give you the flexibility to make your code more readable (eg, *fire*, *notify*, *emit*)
+  
+  == SYNOPSIS:
+  
+    require 'rubygems'
+    require 'publisher'
 email: dev@atomicobject.com
 executables: []
 
@@ -40,7 +56,9 @@ files:
 - test/publisher_test.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: "== DESCRIPTION:"
+homepage: http://atomicobject.github.com/publisher
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -62,9 +80,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: atomicobjectrb
-rubygems_version: 0.9.5
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Event subscription and firing mechanism
 test_files: 
 - test/test_helper.rb