event_aggregator 1.0.0.pre → 1.0.1

data/README.md

@@ -1,8 +1,6 @@
-# EventAggregator
+# EventAggregator gem
 
-The gem 'event_aggregator' is designed for usie with the event aggregator pattern in Ruby.
-
-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.
+The gem 'event_aggregator' is designed for use with the event aggregator pattern in Ruby.
 
 ## Installation
 
@@ -36,6 +34,10 @@ Or install it yourself as:
 		def handle_message(data)
 			puts data
 		end
+		
+		def foo_unregister(*args)
+			message_type_unregister(*args)
+		end
 	end
 
 	f = Foo.new
@@ -45,56 +47,67 @@ Or install it yourself as:
 	EventAggregator::Message.new("foo2", "data").publish
 	#=> data
 	EventAggregator::Message.new("foo3", "data").publish
-	#=> 
-	f.message_type_unregister("foo2")
+	#=> []
+	f.foo_unregister("foo2")
 	EventAggregator::Message.new("foo2", "data").publish
-	#=>
+	#=> []
 	
-	EventAggregator::Message.new("foo2", "data").publish
-	EventAggregator::Message.new("foo2", "data2").publish
+	#Possible outcome:
+	EventAggregator::Message.new("foo", "data").publish
+	EventAggregator::Message.new("foo", "data2").publish
 	#=> data2
 	#=> data
 
-Message.publish is async by default. To make it synchroneus (not recommended) use the following:
+Message.publish is asynchronous by default. To make it synchronous (not recommended) use the following:
 
-	EventAggregator::Message.new("foo2", "data", false).publish
+	EventAggregator::Message.new("foo", "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.
+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 to true.
 
-	EventAggregator::Message.new("foo2", "data", true, true).publish
+	EventAggregator::Message.new("foo", "data", true, true).publish
 	
-This enables you to do the following:
+This enables the following:
 
 	class Foo
 		include EventAggregator::Listener
 		def initialize()
-			message_type_register( "foo", lambda{|data| data = data + " bar" } )
+			message_type_register( "foo", lambda{|data| data << " bar" } )
 		end
 	end
 
 	f1 = Foo.new
 	f2 = Foo.new
 	data = "foo"
+	
+	EventAggregator::Message.new("foo", data, true, false).publish
+
+	puts data 
+	#=> "foo"
 
-	EventAggregator::Message.new("foo", data).publish
+	EventAggregator::Message.new("foo", data, true, true).publish
 	
 	puts data
 	#=> "foo bar bar"
 
+	EventAggregator::Message.new("foo", data, true, true).publish
+	
+	puts data
+	#=> "foo bar bar bar bar"
+
+
 
 ## Usage Considerations
-All messages are processed async by default. This means that there might be raise conditions in your code. 
+All messages are processed asynchronous 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.
+If you force synchronous 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 advised not to produce messages within the callback for the listener, even when using asynchronous 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
+## About Event Aggregators
+An event aggregator is essentially a message passing service that aims at decoupling 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. When such conditions occurs a message can be produced with all relevant data in it. This message can then be published. The message will then be distributed to all other objects that want to receive this message type. This way the object or class that produced the message do not need to be aware of every other object that might be interested in the condition that just occurred. It also removes the need for this class to implement any consumer producer pattern or other similar methods to solving this problem. With an event aggregator the listener, the receiver of the message, does not need to know that the sender even exists. This will remove a lot of bug-producing couplings between objects and help your code become cleaner.
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+For more information see: http://martinfowler.com/eaaDev/EventAggregator.html 
+
+Or: https://www.google.com/#q=event+aggregator
 
 ## Todo:
  - Improving the readme and documentation in the gem.
@@ -102,11 +115,17 @@ If you force synchroneus message publishing you should take extra care of where
 ## Versioning Standard:
 Using Semantic Versioning - http://semver.org/
 ### Versioning Summary
-Given a version number MAJOR.MINOR.PATCH, increment the:
 
-### 0.0.X - Patch
+#### 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
+#### 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.
+#### X - Major
+	Architectural changes and other major changes that alter the API. Updating from X -> Y will most likely break your code.
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/event_aggregator.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'factory_girl'
   spec.add_development_dependency 'faker'
   
-  spec.add_runtime_dependency 'sucker_punch', "~> 1.0"
+  spec.add_dependency 'sucker_punch', "~> 1.0"
 end

data/lib/event_aggregator.rb

@@ -1,9 +1,11 @@
+require "sucker_punch"
 require "event_aggregator/version"
 require "event_aggregator/aggregator"
 require "event_aggregator/listener"
 require "event_aggregator/message"
 require "event_aggregator/message_job"
 
+
 module EventAggregator
   
 end

data/lib/event_aggregator/aggregator.rb

@@ -22,6 +22,7 @@ module EventAggregator
 		# 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 )
+			raise "Illegal callback" unless callback.respond_to?(:call)
 			@@listeners[message_type] << [listener, callback] unless ! (listener.class < EventAggregator::Listener) || @@listeners[message_type].include?(listener)
 		end
 
@@ -52,11 +53,11 @@ module EventAggregator
 		# 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 )
+		def self.message_publish ( message )
 			raise "Invalid message" unless message.respond_to?(:message_type) && message.respond_to?(:data)
 			@@listeners[message.message_type].each do |l|
 				if l[1].respond_to? :call
-					case [async, consisten_data]
+					case [message.async, message.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])

data/lib/event_aggregator/message.rb

@@ -1,20 +1,37 @@
 module EventAggregator
+	
+	# Public: The Message class is used as a distribution object
+	# for the EventAggregator::Aggregator to send messages to 
+	# EventAggregator::Listener objects
+	#
+	# Examples
+	# 
+	# EventAggregator::Message.new("foo", "data").publish
+	# EventAggregator::Message.new("foo", "data", true, false).publish #equivalent to the first example
+	# EventAggregator::Message.new("foo2", 7843).publish #Data can be anything
+	# #Data can be anything
+	# EventAggregator::Message.new("foo2", lambda{p ["", "bA", "bw", "bA", "IA", "bg", "YQ", "aA", "cA", "ZQ", "dA", "w"].map{|e| e[0] && e[0] == "w" ?'U'+e : 'n'+e}.reverse.join('==\\').unpack(('m'+'x'*4)*11).join}).publish
+	# #Non-asynchroneus distribution and consistend data object for all listeners.
+	# EventAggregator::Message.new("foo3", SomeClass.new(), false, true).publish 
+	# 
 	class Message
-		attr_accessor :message_type, :data
+		attr_accessor :message_type, :data, :async, :consisten_data
 		@message_type = nil
 		@data = nil
 		@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 -
+		# which EventAggregator::Listener objects will recieve the message
+		# upon publish
+		# data - The data that will be passed to the 
+		# EventAggregator::Listener objects
 		# async = true - Indicates if message should be published async or not
-		# consisten_data = false - Indicates if message listeners should recieve
-		# the same object reference
+		# consisten_data = false - Indicates if EventAggregator::Listener objects
+		# should recieve a consistent object reference or clones.
 		def initialize(message_type, data, async = true, consisten_data = false)
 			raise "Illegal Message Type" if message_type == nil
 			
@@ -23,11 +40,12 @@ module EventAggregator
 			@async = async
 			@consisten_data = consisten_data
 		end
-		
-		# Public: Will publish the message to all that 
-		# 		  listens of this message_type
+		
+		# Public: Will publish the message to all instances of 
+		# EventAggregator::Listener that is registered for message types 
+		# equal to this.message_type
 		def publish
-			Aggregator.message_publish( self, async, consisten_data )
+			Aggregator.message_publish( self )
 		end
 	end
 end

data/lib/event_aggregator/message_job.rb

@@ -1,7 +1,17 @@
 module EventAggregator
+	
+	# Public: MessageJob is a class used by the EventAggregator::Aggregator
+	# for processing message distribution.
+	#
 	class MessageJob
 		include SuckerPunch::Job
-
+		
+		# Public: Duplicate some text an arbitrary number of times.
+		#
+		# data - The data that will be sent to the callback, originating 
+		# from a message.
+		# callback - The callback that will be processed with the data as 
+		# a parameter
 		def perform(data, callback)
 			callback.call(data)
 		end

data/lib/event_aggregator/version.rb

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

data/spec/lib/event_aggregator/aggregator_spec.rb

@@ -210,12 +210,12 @@ describe EventAggregator::Aggregator do
 				EventAggregator::Aggregator.register(listener, message_type, callback1)
 				EventAggregator::Aggregator.register(listener2, message_type, callback2)
 				
-				message = EventAggregator::Message.new(message_type, data)
+				message = EventAggregator::Message.new(message_type, data, false, true)
 
 				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)
+				EventAggregator::Aggregator.message_publish(message)
 			end
 			it 'uses different objects when false' do
 				listener2 = listener_class.new
@@ -225,12 +225,12 @@ describe EventAggregator::Aggregator do
 				EventAggregator::Aggregator.register(listener, message_type, callback1)
 				EventAggregator::Aggregator.register(listener2, message_type, callback2)
 				
-				message = EventAggregator::Message.new(message_type, data)
+				message = EventAggregator::Message.new(message_type, data, false, false)
 
 				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)
+				EventAggregator::Aggregator.message_publish(message)
 			end
 			it 'objects have same values when false' do
 				listener2 = listener_class.new
@@ -240,12 +240,12 @@ describe EventAggregator::Aggregator do
 				EventAggregator::Aggregator.register(listener, message_type, callback1)
 				EventAggregator::Aggregator.register(listener2, message_type, callback2)
 				
-				message = EventAggregator::Message.new(message_type, data)
+				message = EventAggregator::Message.new(message_type, data, false, false)
 
 				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)
+				EventAggregator::Aggregator.message_publish(message)
 			end
 		end
 	end

data/spec/lib/event_aggregator/message_job_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe EventAggregator::MessageJob do
+	let(:callback)    { lambda{ |data| } }
+	let(:data)        { Faker::Name.name }
+	let(:message_job) { EventAggregator::MessageJob.new }
+
+	describe '.perform' do
+		describe 'legal parameters' do
+			it 'excute callback with data' do
+				expect(callback).to receive(:call).with(data)
+				
+				message_job.perform(data, callback)
+			end
+		end
+		describe 'illegal parameters' do
+			it 'should never be passed to MessageJob' do
+				expect(true).to eq(true)
+			end
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -2,10 +2,10 @@ require "rubygems"
 require "bundler/setup"
 require "factory_girl"
 require "faker"
-require "sucker_punch"
+require "event_aggregator"
 require "sucker_punch/testing/inline"
 
-require "event_aggregator"
+
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: event_aggregator
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
-  prerelease: 6
+  version: 1.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Stephan Eriksen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
+date: 2013-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - spec/factories.rb
 - spec/lib/event_aggregator/aggregator_spec.rb
 - spec/lib/event_aggregator/listener_spec.rb
+- spec/lib/event_aggregator/message_job_spec.rb
 - spec/lib/event_aggregator/message_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/stephan-nordnes-eriksen/event_aggregator
@@ -149,9 +150,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -162,5 +163,6 @@ test_files:
 - spec/factories.rb
 - spec/lib/event_aggregator/aggregator_spec.rb
 - spec/lib/event_aggregator/listener_spec.rb
+- spec/lib/event_aggregator/message_job_spec.rb
 - spec/lib/event_aggregator/message_spec.rb
 - spec/spec_helper.rb