event_aggregator 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in event_aggregator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stephan Eriksen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. 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/README.md

@@ -0,0 +1,61 @@
+# EventAggregator
+
+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 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'event_aggregator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install event_aggregator
+
+## Usage
+
+	#!/usr/bin/ruby
+
+	require "rubygems"
+	require "event_aggregator"
+
+	class Foo
+		include EventAggregator::Listener
+		def initialize()
+			message_type_to_recieve_add( "foo", lambda{|data| puts "bar" } )
+
+			message_type_to_recieve_add( "foo2", method(:handle_message) )
+		end
+
+		def handle_message(data)
+			puts data
+		end
+	end
+
+	f = Foo.new
+
+	EventAggregator::Message.new("foo", "data").publish
+	#=> bar
+	EventAggregator::Message.new("foo2", "data").publish
+	#=> data
+	EventAggregator::Message.new("foo3", "data").publish
+	#=> 
+
+## 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
+
+## Todo:
+
+ - Enable threaded message passing for higher performance. 
+ - Improving the readme and documentation in the gem.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/event_aggregator.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'event_aggregator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "event_aggregator"
+  spec.version       = EventAggregator::VERSION
+  spec.authors       = ["Stephan Eriksen"]
+  spec.email         = ["stephan.n.eriksen@gmail.com"]
+  spec.description   = %q{A simple Ruby event aggregator.}
+  spec.summary       = %q{Event aggregator for Ruby.}
+  spec.homepage      = "https://github.com/stephan-nordnes-eriksen/event_aggregator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/event_aggregator/aggregator.rb

@@ -0,0 +1,27 @@
+module EventAggregator
+	class Aggregator
+		@@listeners = Hash.new([])
+
+		@@message_types = Hash.new
+
+		def self.register( listener, message_type )
+			@@listeners[message_type] << listener unless @@listeners[message_type].include?(listener)
+		end
+
+		def self.unregister( listener, message_type )
+			@@listeners[message_type].delete listener
+		end
+
+		def self.message_publish ( message )
+			return "Not a valid message" unless message.is_a? EventAggregator::Message
+
+			@@listeners[message.message_type].each do |l|
+				l.recieve_message message
+			end
+		end
+
+		def self.register_message_type(message_type)
+			@@message_types[message_types] = [] unless @@message_types[message_types]
+		end
+	end
+end

data/lib/event_aggregator/listener.rb

@@ -0,0 +1,105 @@
+module EventAggregator
+	# Public: A module you can include or extend to recieve messages from
+	# the event Aggregator system.
+	#
+	# Examples
+	#
+	#   class Foo
+	# 		Include Listener
+	# 		...
+	# 		def initialize()
+	# 			...
+	# 			message_type_to_recieve_add( "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 "recieve 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 recieve_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 recieve. Overwirte existing callback when existing message type is given.
+		#
+		# message_type 	- A string indicating the message type you want to recieve from the event aggregrator. Can actually be anything.
+		# callback 		- The method that will be invoked every time this message type is recieved. Must have: callback.respond_to? :call #=> true
+		#
+		# Examples
+		#
+		#   message_type_to_recieve_add("foo", method(:my_class_method))
+		#   message_type_to_recieve_add("foo", lambda { puts "foo" })
+		#   message_type_to_recieve_add("foo", Proc.new { puts "foo" })
+		#
+		def message_type_to_recieve_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 )
+		end
+
+		# Public: Used to remove a certain type of message from your listening types. Messages of this specific type will no longer
+		# invoke any callbacks.
+		#
+		# message_type -A string indicating the message type you no longer want to recieve.
+		#
+		# Examples
+		#
+		#   message_type_to_recieve_remove("foo")
+		#
+		def message_type_to_recieve_remove( message_type )
+			event_listener_listens_to[message_type] = nil
+			Aggregator.unregister(self, message_type)
+		end
+	end
+end

data/lib/event_aggregator/message.rb

@@ -0,0 +1,15 @@
+module EventAggregator
+	class Message
+		attr_accessor :message_type, :data
+		@message_type = nil
+		@data = nil
+		def initialize(message_type, data)
+			@message_type = message_type
+			@data = data
+		end
+
+		def publish
+			Aggregator.message_publish( self )
+		end
+	end
+end

data/lib/event_aggregator/version.rb

@@ -0,0 +1,3 @@
+module EventAggregator
+  VERSION = "0.0.1"
+end

data/lib/event_aggregator.rb

@@ -0,0 +1,8 @@
+require "event_aggregator/version"
+require "event_aggregator/aggregator"
+require "event_aggregator/listener"
+require "event_aggregator/message"
+
+module EventAggregator
+  
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: event_aggregator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stephan Eriksen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple Ruby event aggregator.
+email:
+- stephan.n.eriksen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- event_aggregator.gemspec
+- lib/event_aggregator.rb
+- lib/event_aggregator/aggregator.rb
+- lib/event_aggregator/listener.rb
+- lib/event_aggregator/message.rb
+- lib/event_aggregator/version.rb
+homepage: https://github.com/stephan-nordnes-eriksen/event_aggregator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Event aggregator for Ruby.
+test_files: []