event_aggregator 0.0.2 → 1.0.0.pre

data/README.md

@@ -1,10 +1,8 @@
 # EventAggregator
 
-#### Note: This is a very early release and subject to many changes. It is currently not tested propperly, and there are several issues ranging from potential dead-locks to upcoming refactoring.
+The gem 'event_aggregator' is designed for usie with the event aggregator pattern in Ruby.
 
-The 'event_aggregator' gem is a gem for using the event aggregator pattern in Ruby. 
-
-An event aggregator is essentially a message passing service that aims at decoupeling object communication and that lets 
+An event aggregator is essentially a message passing service that aims at decoupeling objects in your code. This is achieved with messages that has a type and some data. A message might be produced when an event, or other condition, occurs within one object or class that might be of interest to thers. This object or class then put all relevant data into the message and publishes it. This message will then be distributed to all other objects that want to recieve this message type. This way the object or class that first got knowledge of the condition do not need to be aware of every other object that might be interested in knowing about this. It also removes the need for this class to implement any listeners and so forth. This way the listener, the receiver of the message, does not need to know that the sender even exists. This will help your code be a lot cleaner and remove a lot of bug-producing couplings between objects.
 
 ## Installation
 
@@ -30,9 +28,9 @@ Or install it yourself as:
 	class Foo
 		include EventAggregator::Listener
 		def initialize()
-			message_type_to_receive_add( "foo", lambda{|data| puts "bar" } )
+			message_type_register( "foo", lambda{|data| puts "bar" } )
 
-			message_type_to_receive_add( "foo2", method(:handle_message) )
+			message_type_register( "foo2", method(:handle_message) )
 		end
 
 		def handle_message(data)
@@ -48,6 +46,47 @@ Or install it yourself as:
 	#=> data
 	EventAggregator::Message.new("foo3", "data").publish
 	#=> 
+	f.message_type_unregister("foo2")
+	EventAggregator::Message.new("foo2", "data").publish
+	#=>
+	
+	EventAggregator::Message.new("foo2", "data").publish
+	EventAggregator::Message.new("foo2", "data2").publish
+	#=> data2
+	#=> data
+
+Message.publish is async by default. To make it synchroneus (not recommended) use the following:
+
+	EventAggregator::Message.new("foo2", "data", false).publish
+	#=> data
+
+The message data is duplicated by default for each of the receiving listeners. To force the same object for all listeners, set the consisten_data property.
+
+	EventAggregator::Message.new("foo2", "data", true, true).publish
+	
+This enables you to do the following:
+
+	class Foo
+		include EventAggregator::Listener
+		def initialize()
+			message_type_register( "foo", lambda{|data| data = data + " bar" } )
+		end
+	end
+
+	f1 = Foo.new
+	f2 = Foo.new
+	data = "foo"
+
+	EventAggregator::Message.new("foo", data).publish
+	
+	puts data
+	#=> "foo bar bar"
+
+
+## Usage Considerations
+All messages are processed async by default. This means that there might be raise conditions in your code. 
+
+If you force synchroneus message publishing you should take extra care of where in your code you produce new messages. You can very easily create infinite loops where messages are published and consumed by the same listener. Because of this it is adivised not to produce messages within the callback for the listener, even when using async message publishing. Another good rule is never to produce messages of the same type as those you listen to. This does not completely guard you, as there can still exist loops between two or more listeners.
 
 ## Contributing
 
@@ -58,7 +97,16 @@ Or install it yourself as:
 5. Create new Pull Request
 
 ## Todo:
-
- - Adding tests
- - Enable threaded message passing for higher performance. 
  - Improving the readme and documentation in the gem.
+
+## Versioning Standard:
+Using Semantic Versioning - http://semver.org/
+### Versioning Summary
+Given a version number MAJOR.MINOR.PATCH, increment the:
+
+### 0.0.X - Patch
+	Small updates and patches that are backwards-compatible. Updating from 0.0.X -> 0.0.Y should not break your code.
+### 0.X - Minor
+	Adding functionality and changes that are backwards-compatible. Updating from 0.X -> 0.Y should not break your code.
+### X - Major
+	Architectural changes and other major changes that alter the API. Updating from X -> Y will most likely break your code.

data/event_aggregator.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'factory_girl'
   spec.add_development_dependency 'faker'
+  
+  spec.add_runtime_dependency 'sucker_punch', "~> 1.0"
 end

data/lib/event_aggregator.rb

@@ -2,6 +2,7 @@ require "event_aggregator/version"
 require "event_aggregator/aggregator"
 require "event_aggregator/listener"
 require "event_aggregator/message"
+require "event_aggregator/message_job"
 
 module EventAggregator
   

data/lib/event_aggregator/aggregator.rb

@@ -1,5 +1,3 @@
-#require 'singleton'
-
 module EventAggregator
 
 	# Public: TODO: Could potentially turn this into a module.
@@ -12,29 +10,59 @@ module EventAggregator
 	# 		end
 	# 	end
 	class Aggregator
-		#include Singleton
 		class <<self; private :new; end
-		#TODO: Figure out how to do singleton pattern properly
 
 		@@listeners = Hash.new{|h, k| h[k] = []}
 
-		def self.register( listener, message_type )
-			@@listeners[message_type] << listener unless ! (listener.class < EventAggregator::Listener) || @@listeners[message_type].include?(listener)
+		# Public: Register an EventAggregator::Listener to recieve
+		# 		  a specified message type
+		#
+		# listener - An EventAggregator::Listener which should recieve
+		# 			 the messages.
+		# message_type - The message type to recieve. Can be anything except nil.
+		# 				 Often it is preferable to use a string eg. "Message Type".
+		def self.register( listener, message_type, callback )
+			@@listeners[message_type] << [listener, callback] unless ! (listener.class < EventAggregator::Listener) || @@listeners[message_type].include?(listener)
 		end
 
+		# Public: Unegister an EventAggregator::Listener to a
+		# 		  specified message type. The listener will no
+		# 		  longer get messages of this type.
+		#
+		# listener - The EventAggregator::Listener which should no longer recieve
+		# 			 the messages.
+		# message_type - The message type to unregister for.
 		def self.unregister( listener, message_type )
-			@@listeners[message_type].delete listener
+			@@listeners[message_type].delete_if{|value| value[0] == listener}
 		end
+
+		# Public: As Unregister, but will unregister listener from all message types.
+		#
+		# listener - The listener who should no longer get any messages at all,
+		# 			 regardless of type.
 		def self.unregister_all( listener )
 			@@listeners.each do |e|
-				e[1].delete(listener)
+				e[1].delete_if{|value| value[0] == listener}
 			end
 		end
-		def self.message_publish ( message )
-			raise "Invalid message" unless message.is_a? EventAggregator::Message
 
+		# Public: Will publish the specified message to all listeners
+		# 		  who has registered for this message type.
+		#
+		# message - The message to be distributed to the listeners.
+		# async - true => message will be sent async. Default true
+		# consisten_data - true => the same object will be sent to all recievers. Default false
+		def self.message_publish ( message, async = true, consisten_data = false )
+			raise "Invalid message" unless message.respond_to?(:message_type) && message.respond_to?(:data)
 			@@listeners[message.message_type].each do |l|
-				l.receive_message message
+				if l[1].respond_to? :call
+					case [async, consisten_data]
+					when [true, true]   then EventAggregator::MessageJob.new.async.perform(message.data,       l[1])
+					when [true, false]  then EventAggregator::MessageJob.new.async.perform(message.data.clone, l[1])
+					when [false, true]  then EventAggregator::MessageJob.new.perform(      message.data,       l[1])
+					when [false, false] then EventAggregator::MessageJob.new.perform(      message.data.clone, l[1])
+					end
+				end
 			end
 		end
 	end

data/lib/event_aggregator/listener.rb

@@ -9,69 +9,13 @@ module EventAggregator
 	# 		...
 	# 		def initialize()
 	# 			...
-	# 			message_type_to_receive_add( "foo", lambda{ puts "bar" } )
+	# 			message_type_register( "foo", lambda{ puts "bar" } )
 	# 		end
 	# 		...
 	#  	end
 	#
 	module Listener
-
-		#event_listener_listens_to = Hash.new() #This actually sets Listener.event_listener_listens_to = Hash.new, not the instance
-
-
-		# Public: This is the callback method when the module is extended.
-		# Using this to setup the last few things before the event listener can start.
-		#
-		# base - The class object for the class extening the Listener module
-		#
-		# Returns nil
-		def self.extended(base)
-			# Initialize module.
-			#		add_auto_register_procedure(base) #Depricated now, but it is utterly awesome that you can do this.
-		end
-
-		# Public: This is the callback method when the module is included.
-		# Using this to setup the last few things before the event listener can start.
-		#
-		# base - The class object for the class including the Listener module
-		#
-		# Returns nil
-		def self.included(base)
-			# Initialize module.
-			#		add_auto_register_procedure(base) #Depricated now, but it is utterly awesome that you can do this.
-		end
-
-
-		# Public: DEPRICATED: Adding extra initialize to the class so that we make sure new objects are added to the EventAggregators registry.
-		# This whole hack-deal is possibly not nescessary. Can be omited with a simple "register" when you add a new "receive message_type"
-		#
-		# base - The class object for the class including the Listener module
-		#
-		# Returns nil
-		def self.add_auto_register_procedure(base)
-			base.class_eval do
-				# back up method's name
-				alias_method :old_initialize, :initialize
-
-				# replace the old method with a new version which adds the Aggregator registry
-				def initialize(*args)
-					Aggregator.register self
-					old_initialize(*args)
-				end
-			end
-		end
-
-		def receive_message( message )
-			m = event_listener_listens_to[message.message_type]
-
-			m.call(message.data) if m.respond_to? :call #Should not need the check here, however who knows what kind of conurrency issues we might have.
-			#This will probably become hotpath, so having the extra check can be problematic.
-		end
-
 		private
-		def event_listener_listens_to
-			@event_listener_listens_to ||= Hash.new
-		end
 		# public: Use to add message types you want to receive. Overwirte existing callback when existing message type is given.
 		#
 		# message_type 	- A string indicating the message type you want to receive from the event aggregrator. Can actually be anything.
@@ -79,13 +23,12 @@ module EventAggregator
 		#
 		# Examples
 		#
-		#   message_type_to_receive_add("foo", method(:my_class_method))
-		#   message_type_to_receive_add("foo", lambda { puts "foo" })
-		#   message_type_to_receive_add("foo", Proc.new { puts "foo" })
+		#   message_type_register("foo", method(:my_class_method))
+		#   message_type_register("foo", lambda { puts "foo" })
+		#   message_type_register("foo", Proc.new { puts "foo" })
 		#
-		def message_type_to_receive_add( message_type, callback )
-			event_listener_listens_to[message_type] = callback #unless event_listener_listens_to[message_type] #It makes more sence to overwrite in the case it already exists.
-			Aggregator.register( self, message_type )
+		def message_type_register( message_type, callback )
+			Aggregator.register( self, message_type, callback)
 		end
 
 		# Public: Used to remove a certain type of message from your listening types. Messages of this specific type will no longer
@@ -95,10 +38,9 @@ module EventAggregator
 		#
 		# Examples
 		#
-		#   message_type_to_receive_remove("foo")
+		#   message_type_unregister("foo")
 		#
-		def message_type_to_receive_remove( message_type )
-			event_listener_listens_to[message_type] = nil
+		def message_type_unregister( message_type )
 			Aggregator.unregister(self, message_type)
 		end
 	end

data/lib/event_aggregator/message.rb

@@ -3,15 +3,31 @@ module EventAggregator
 		attr_accessor :message_type, :data
 		@message_type = nil
 		@data = nil
-		def initialize(message_type, data)
-			raise "Illegal Message Type" if !message_type
+		@async = nil
+		@consisten_data = nil
+
+		
+		# Public: Initialize the Message
+		#
+		# message_type - The type of the message which determine
+		# which listeners will recieve the message
+		# data -
+		# async = true - Indicates if message should be published async or not
+		# consisten_data = false - Indicates if message listeners should recieve
+		# the same object reference
+		def initialize(message_type, data, async = true, consisten_data = false)
+			raise "Illegal Message Type" if message_type == nil
 			
 			@message_type = message_type
 			@data = data
+			@async = async
+			@consisten_data = consisten_data
 		end
-
+		
+		# Public: Will publish the message to all that 
+		# 		  listens of this message_type
 		def publish
-			Aggregator.message_publish( self )
+			Aggregator.message_publish( self, async, consisten_data )
 		end
 	end
 end

data/lib/event_aggregator/message_job.rb

@@ -0,0 +1,9 @@
+module EventAggregator
+	class MessageJob
+		include SuckerPunch::Job
+
+		def perform(data, callback)
+			callback.call(data)
+		end
+	end
+end

data/lib/event_aggregator/version.rb

@@ -1,3 +1,3 @@
 module EventAggregator
-  VERSION = "0.0.2"
+  VERSION = "1.0.0.pre"
 end

data/spec/factories.rb

@@ -2,7 +2,7 @@ require 'factory_girl'
 require 'faker'
 require 'event_aggregator'
 
-
+
 # Public: Not really used. Might not be needed at all. The same 
 # 		  goes for FactoryGirl in general. Might not be needed.
 #
@@ -16,7 +16,7 @@ FactoryGirl.define do
 	end
 	factory :message do
 		message_type { Faker::Name.name }
-		data { Faker::Commerce.product_name } #TODO: This bracket should be unnescecary
+		data { Faker::Commerce.product_name } 
 		#initialize_with(Faker::Name.name, Faker::Name.name)
 	end
 end

data/spec/lib/event_aggregator/aggregator_spec.rb

@@ -4,7 +4,8 @@ describe EventAggregator::Aggregator do
 	let(:listener)       { (Class.new { include EventAggregator::Listener }).new }
 	let(:listener_class) { Class.new { include EventAggregator::Listener }}
 	let(:message_type)   { Faker::Name.name }
-	let(:data)   { Faker::Name.name }
+	let(:data)   		 { Faker::Name.name }
+	let(:callback)		 { lambda{ |data| } }
 
 	before(:each) do
 		EventAggregator::Aggregator.class_variable_set :@@listener, Hash.new{|h, k| h[k] = []}
@@ -12,58 +13,58 @@ describe EventAggregator::Aggregator do
 	describe "self.register" do
 		describe 'legal parameters' do
 			it 'registered at correct place' do
-				EventAggregator::Aggregator.register(listener, message_type)
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to include(listener)
+				EventAggregator::Aggregator.register(listener, message_type, callback)
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to include([listener, callback])
 			end
 
-			it 'should not be registered in wrong place' do
-				EventAggregator::Aggregator.register(listener, message_type)
+			it 'not be registered in wrong place' do
+				EventAggregator::Aggregator.register(listener, message_type, callback)
 				EventAggregator::Aggregator.class_variable_get(:@@listeners).each do |e|
 					if e[0] == message_type
-						expect(e[1]).to include(listener)
+						expect(e[1]).to include([listener, callback])
 					else
-						expect(e[1]).to_not include(listener)
+						expect(e[1]).to_not include([listener, callback])
 					end
 				end
 			end
 		end
 		describe 'illegal parameters' do
-			it 'should not allow nil as message type' do
-				expect{EventAggregator::Aggregator.register(nil, message_type)}.to_not change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
+			it 'not allow nil as message type' do
+				expect{EventAggregator::Aggregator.register(nil, message_type, callback)}.to_not change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
 			end
-			it 'should not allow non-listener to register' do
-				expect{EventAggregator::Aggregator.register(EventAggregator::Message.new("a","b"), message_type)}.to_not change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
-				expect{EventAggregator::Aggregator.register("string", message_type)}.to_not                              change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
-				expect{EventAggregator::Aggregator.register(1, message_type)}.to_not                                     change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
-				expect{EventAggregator::Aggregator.register(2.0, message_type)}.to_not                                   change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
+			it 'not allow non-listener to register' do
+				expect{EventAggregator::Aggregator.register(EventAggregator::Message.new("a","b"), message_type, callback)}.to_not change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
+				expect{EventAggregator::Aggregator.register("string", message_type, callback)}.to_not                              change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
+				expect{EventAggregator::Aggregator.register(1, message_type, callback)}.to_not                                     change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
+				expect{EventAggregator::Aggregator.register(2.0, message_type, callback)}.to_not                                   change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
 			end
 		end
 	end
 
 	describe "self.unregister" do
 		describe 'legal parameters'  do
-			it 'should decrease count by 1' do
-				EventAggregator::Aggregator.register(listener, message_type)
+			it 'decrease count by 1' do
+				EventAggregator::Aggregator.register(listener, message_type, callback)
 				expect{EventAggregator::Aggregator.unregister(listener, message_type)}.to change{EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type].length}.by(-1)
 			end
-			it 'should be remove from list' do
-				EventAggregator::Aggregator.register(listener, message_type)
+			it 'be remove from list' do
+				EventAggregator::Aggregator.register(listener, message_type, callback)
 				EventAggregator::Aggregator.unregister(listener, message_type)
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to_not include(listener)
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to_not include([listener, callback])
 			end
-			it 'should keep listener in unrelated lists' do
+			it 'keep listener in unrelated lists' do
 				message_type2 = message_type + " different"
 				
-				EventAggregator::Aggregator.register(listener, message_type)
-				EventAggregator::Aggregator.register(listener, message_type2)
+				EventAggregator::Aggregator.register(listener, message_type, callback)
+				EventAggregator::Aggregator.register(listener, message_type2, callback)
 				
 				EventAggregator::Aggregator.unregister(listener, message_type)
 				
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type2]).to include(listener)
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type2]).to include([listener, callback])
 			end
 		end
 		describe 'unregitering nonregisterd listener' do
-			it 'should not change list' do
+			it 'not change list' do
 				message_type1 = message_type + " different 1"
 				message_type2 = message_type + " different 2"
 				message_type3 = message_type + " different 3"
@@ -71,9 +72,9 @@ describe EventAggregator::Aggregator do
 				listener2 	  = listener_class.new
 				listener3 	  = listener_class.new
 
-				EventAggregator::Aggregator.register(listener1, message_type1)
-				EventAggregator::Aggregator.register(listener2, message_type2)
-				EventAggregator::Aggregator.register(listener3, message_type3)
+				EventAggregator::Aggregator.register(listener1, message_type1, callback)
+				EventAggregator::Aggregator.register(listener2, message_type2, callback)
+				EventAggregator::Aggregator.register(listener3, message_type3, callback)
 				
 				#Touching hash
 				EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]
@@ -82,22 +83,22 @@ describe EventAggregator::Aggregator do
 				expect{EventAggregator::Aggregator.unregister(listener2, message_type)}.to_not change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
 				expect{EventAggregator::Aggregator.unregister(listener3, message_type)}.to_not change{EventAggregator::Aggregator.class_variable_get(:@@listeners)}
 
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type1]).to include(listener1)
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type2]).to include(listener2)
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type3]).to include(listener3)
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type1]).to include([listener1, callback])
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type2]).to include([listener2, callback])
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type3]).to include([listener3, callback])
 			end
 		end
 		describe 'unregitering listener from wrong message type' do
-			it 'should not change list' do
+			it 'not change list' do
 				message_type2 = message_type + " different"
 
-				EventAggregator::Aggregator.register(listener, message_type)
+				EventAggregator::Aggregator.register(listener, message_type, callback)
 
 				expect{EventAggregator::Aggregator.unregister(listener, message_type2)}.to_not change{EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]}
 			end
 		end
 		describe 'unregitering non-listener class' do
-			it 'should not change register list' do
+			it 'not change register list' do
 				#Touching hash
 				EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]
 
@@ -111,14 +112,14 @@ describe EventAggregator::Aggregator do
 
 	describe "self.unregister_all" do
 		describe "unregistering listener registered to one message type" do
-			it "should unregister from list" do
-				EventAggregator::Aggregator.register(listener, message_type)
+			it "unregister from list" do
+				EventAggregator::Aggregator.register(listener, message_type, callback)
 
 				EventAggregator::Aggregator.unregister_all(listener)
 				
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to_not  include(listener)
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to_not  include([listener, callback])
 			end
-			it "should not unregister wrong listener" do
+			it "not unregister wrong listener" do
 				listener2 = listener_class.new
 				listener3 = listener_class.new
 				listener4 = listener_class.new
@@ -126,65 +127,67 @@ describe EventAggregator::Aggregator do
 				message_type2 = message_type + " different"
 				message_type3 = message_type + " different 2"
 
-				EventAggregator::Aggregator.register(listener, message_type)
-				EventAggregator::Aggregator.register(listener2, message_type)
-				EventAggregator::Aggregator.register(listener3, message_type2)
-				EventAggregator::Aggregator.register(listener4, message_type3)
+				EventAggregator::Aggregator.register(listener, message_type, callback)
+				EventAggregator::Aggregator.register(listener2, message_type, callback)
+				EventAggregator::Aggregator.register(listener3, message_type2, callback)
+				EventAggregator::Aggregator.register(listener4, message_type3, callback)
 
 				
 				EventAggregator::Aggregator.unregister_all(listener)
 
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to include(listener2)
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type2]).to include(listener3)
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type3]).to include(listener4)
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to include([listener2, callback])
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type2]).to include([listener3, callback])
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type3]).to include([listener4, callback])
 			end
 		end
 		describe "unregistering listener registered for several message types" do
-			it "should unregister from all lists" do
-				EventAggregator::Aggregator.register(listener, message_type)
+			it "unregister from all lists" do
+				EventAggregator::Aggregator.register(listener, message_type, callback)
 				message_type2 = message_type + " different"
-				EventAggregator::Aggregator.register(listener, message_type2)
+				EventAggregator::Aggregator.register(listener, message_type2, callback)
 
 				EventAggregator::Aggregator.unregister_all(listener)
 
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to_not include(listener)
-				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type2]).to_not include(listener)
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type]).to_not include([listener, callback])
+				expect(EventAggregator::Aggregator.class_variable_get(:@@listeners)[message_type2]).to_not include([listener, callback])
 			end
 		end
 	end
 
 	describe "self.message_publish" do
 		describe 'legal parameters' do
-			it 'should receive correct messages' do
-				EventAggregator::Aggregator.register(listener, message_type)
+			it 'run correct callback' do
+				EventAggregator::Aggregator.register(listener, message_type, callback)
 				message = EventAggregator::Message.new(message_type, data)
 
-				expect(listener).to receive(:receive_message).with(message)
+				expect(callback).to receive(:call).with(data)
 
 				EventAggregator::Aggregator.message_publish(message)
 			end
-			it 'should not receive incorrect messages' do
+			it 'not run incorrect callback' do
 				message_type2 = message_type + " different"
 				
-				EventAggregator::Aggregator.register(listener, message_type)
+				EventAggregator::Aggregator.register(listener, message_type, callback)
 				message = EventAggregator::Message.new(message_type2, data)
 
-				expect(listener).to_not receive(:receive_message)
+				expect(callback).to_not receive(:call).with(data)
 
 				EventAggregator::Aggregator.message_publish(message)
 			end
 
-			it 'should send message to right listener' do
+			it 'run correct callback in list' do
 				listener2 = listener_class.new
 				message_type2 = message_type + " different"
 
-				EventAggregator::Aggregator.register(listener, message_type)
-				EventAggregator::Aggregator.register(listener, message_type2)
+				callback2 = lambda{|data|}
+
+				EventAggregator::Aggregator.register(listener, message_type, callback)
+				EventAggregator::Aggregator.register(listener, message_type2, callback2)
 
 				message = EventAggregator::Message.new(message_type, data)
 
-				expect(listener).to receive(:receive_message).with(message)
-				expect(listener2).to_not receive(:receive_message)
+				expect(callback).to receive(:call).with(data)
+				expect(callback2).to_not receive(:call)
 
 				EventAggregator::Aggregator.message_publish(message)
 			end
@@ -198,5 +201,52 @@ describe EventAggregator::Aggregator do
 				expect{EventAggregator::Aggregator.message_publish(nil)}.to      raise_error
 			end
 		end
+		describe 'consisten_data behaviour' do
+			it 'uses same object when true' do
+				listener2 = listener_class.new
+				callback1 = lambda{|data|}
+				callback2 = lambda{|data|}
+
+				EventAggregator::Aggregator.register(listener, message_type, callback1)
+				EventAggregator::Aggregator.register(listener2, message_type, callback2)
+				
+				message = EventAggregator::Message.new(message_type, data)
+
+				expect(callback1).to receive(:call) {|arg| expect(arg).to equal(data)}
+				expect(callback2).to receive(:call) {|arg| expect(arg).to equal(data)}
+
+				EventAggregator::Aggregator.message_publish(message, false, true)
+			end
+			it 'uses different objects when false' do
+				listener2 = listener_class.new
+				callback1 = lambda{|data| data ="no"}
+				callback2 = lambda{|data| data ="no"}
+
+				EventAggregator::Aggregator.register(listener, message_type, callback1)
+				EventAggregator::Aggregator.register(listener2, message_type, callback2)
+				
+				message = EventAggregator::Message.new(message_type, data)
+
+				expect(callback1).to receive(:call) {|arg| expect(arg).to_not equal(data)}
+				expect(callback2).to receive(:call) {|arg| expect(arg).to_not equal(data)}
+
+				EventAggregator::Aggregator.message_publish(message, false, false)
+			end
+			it 'objects have same values when false' do
+				listener2 = listener_class.new
+				callback1 = lambda{|data| data ="no"}
+				callback2 = lambda{|data| data ="no"}
+
+				EventAggregator::Aggregator.register(listener, message_type, callback1)
+				EventAggregator::Aggregator.register(listener2, message_type, callback2)
+				
+				message = EventAggregator::Message.new(message_type, data)
+
+				expect(callback1).to receive(:call) {|arg| expect(arg).to eq(data)}
+				expect(callback2).to receive(:call) {|arg| expect(arg).to eq(data)}
+
+				EventAggregator::Aggregator.message_publish(message, false, false)
+			end
+		end
 	end
 end

data/spec/lib/event_aggregator/listener_spec.rb

@@ -23,68 +23,38 @@ describe EventAggregator::Listener do
 		EventAggregator::Aggregator.class_variable_set :@@listener, Hash.new{|h, k| h[k] = []}
 		@message = EventAggregator::Message.new(message_type, data)
 	end
-	describe '.receive_message' do
-		describe 'legal parameters' do
-			it 'execute callback' do
-				#TODO: This is subject to refactor because the method is stroed in the module by a hack.
-				# This stuff should be moved to the aggregator, or somewhere else.
-				listener.class.publicize_methods do
-					listener.message_type_to_receive_add(message_type, lambda_method)
-
-					expect(lambda_method).to receive(:call)
-
-					listener.receive_message(@message)
-				end
-			end
-		end
-		describe 'illegal parameters' do
-			#This should not recieve illegal parameters.
-			it 'pending' do
-				pending "not implemented"
-			end
-		end
-	end
 
 	describe '.message_type_to_receive_add' do
 		describe 'legal parameters' do
-			it 'should register at aggregator' do
-				expect(EventAggregator::Aggregator).to receive(:register).with(listener, message_type)
+			it 'invoke aggregator register' do
+				expect(EventAggregator::Aggregator).to receive(:register).with(listener, message_type, lambda_method)
 				
 				listener.class.publicize_methods do
-					listener.message_type_to_receive_add(message_type, lambda_method)
+					listener.message_type_register(message_type, lambda_method)
 				end
 			end
-			it 'pending' do
-				pending "not implemented"
-			end
 		end
 		describe 'illegal parameters' do
-			it 'not valid' do
-				expect{listener.message_type_to_receive_add(message_type, nil)}.to                raise_error
-				expect{listener.message_type_to_receive_add(message_type, 1)}.to                  raise_error
-				expect{listener.message_type_to_receive_add(message_type, "string")}.to           raise_error
-				expect{listener.message_type_to_receive_add(message_type, listener_class.new)}.to raise_error
+			it 'raise error' do
+				expect{listener.message_type_register(message_type, nil)}.to                raise_error
+				expect{listener.message_type_register(message_type, 1)}.to                  raise_error
+				expect{listener.message_type_register(message_type, "string")}.to           raise_error
+				expect{listener.message_type_register(message_type, listener_class.new)}.to raise_error
 			end
 		end
 	end
 
 	describe '.message_type_to_receive_remove' do
 		describe 'legal parameters' do
-			it 'not recieve callbacks' do
+			it 'invoke aggregator unregister' do
 				listener.class.publicize_methods do
-					listener.message_type_to_receive_add(message_type, lambda_method)
-					listener.message_type_to_receive_remove(message_type)
+					listener.message_type_register(message_type, lambda_method)
+					
+					expect(EventAggregator::Aggregator).to receive(:unregister).with(listener, message_type)
 
-					expect(lambda_method).to_not receive(:call)
-
-					listener.receive_message(@message)
+					listener.message_type_unregister(message_type)
 				end
 			end
 		end
-		describe 'illegal parameters' do
-			it 'not registered reciever' do
-				pending "This will really likely be removed in next refactor"
-			end
-		end
 	end
 end

data/spec/lib/event_aggregator/message_spec.rb

@@ -5,25 +5,20 @@ describe EventAggregator::Message do
 		let(:message_type) {Faker::Name.name}
 		let(:data)         {Faker::Name.name}
 		let(:listener_class) { (Class.new { include EventAggregator::Listener }) }
+		let(:callback)		 { lambda{ |data| } }
 
     	before(:each) do
 			EventAggregator::Aggregator.class_variable_set :@@listener, Hash.new{|h, k| h[k] = []}
 			@listener_one = listener_class.new
 			@listener_two = listener_class.new
 			
-			EventAggregator::Aggregator.register(@listener_one, message_type)
-			EventAggregator::Aggregator.register(@listener_two, message_type+" different")
+			EventAggregator::Aggregator.register(@listener_one, message_type, callback)
+			EventAggregator::Aggregator.register(@listener_two, message_type+" different", callback)
 		end
 
-    	it 'should be received by a correct subscribers' do
-    		message = EventAggregator::Message.new(message_type, data)
-    		expect(@listener_one).to receive(:receive_message).with(message)
-    		expect(@listener_two).to_not receive(:receive_message)
-
-    		message.publish
-    	end
-    	it 'should be published to the aggregator' do
+    	it 'should invoke message_publish on aggregator' do
     		message = EventAggregator::Message.new(message_type, data)
+    		
     		expect(EventAggregator::Aggregator).to receive(:message_publish).with(message)
 
     		message.publish

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require "rubygems"
 require "bundler/setup"
 require "factory_girl"
 require "faker"
+require "sucker_punch"
+require "sucker_punch/testing/inline"
 
 require "event_aggregator"
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: event_aggregator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 1.0.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - Stephan Eriksen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2013-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: A simple Ruby event aggregator.
 email:
 - stephan.n.eriksen@gmail.com
@@ -110,6 +126,7 @@ files:
 - lib/event_aggregator/aggregator.rb
 - lib/event_aggregator/listener.rb
 - lib/event_aggregator/message.rb
+- lib/event_aggregator/message_job.rb
 - lib/event_aggregator/version.rb
 - spec/factories.rb
 - spec/lib/event_aggregator/aggregator_spec.rb
@@ -132,9 +149,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25