resugan 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8436d6c33951f98da4d83996218eabaca1425f07
-  data.tar.gz: 3bdc108d04b3ae9a7140212ead07f9e0d3aceef4
+  metadata.gz: 9654ca7f5f98456f020eb91f5bc89498957b6fe9
+  data.tar.gz: 5ee0ae2b994d3bec9077d0025f3683c1aba9c3f0
 SHA512:
-  metadata.gz: bb6cea9e23d0d5012c8bca0deaced58cbe04c55fa3845ba6beb6872326d9590a335adc2491300dd1e5a89b060e9d29eec43ee426158a10c457fc57c8568cafc4
-  data.tar.gz: 171ec8152a6b3a49598eed4c351836f720adea8c9ba323a6eeefd2a53f3edd4217491fc6bc3fa167f332a30a1ba0cdd8f81f959e63334c277c7f6ef73a793667
+  metadata.gz: 52f12f972eb824baa776710c7fd0b98f805ab790cc491be0403db7881a9ca90affd80623f7266ae27da09a0b20d95421c2614615295813beaf698770374b17f3
+  data.tar.gz: 7e57c11239e0aecfb94162094f2260c5f998cf997e21f2f600e8eb8af0310cfca7fdb2807370a94aefd5f5e444d202e34c507dd9ea51f1562d0b9f20bc8eaf57

data/README.md

@@ -6,7 +6,7 @@ Simple, powerful and unobstrusive event driven architecture framework for ruby.
 a base framework in order to build a more powerful event based system on top of it. Events cuts across multiple objects and allows you to cleanly separate business logic to other cross cutting concerns like analytics and logging. Multiple events are consolidated allowing you to efficiently batch related operations together.
 
 Also allows for a customizable backend which enables the use of various evented queuing mechanisms
-like redis queue, amazon sqs with minimal changes to your code that generates the events.
+like redis queue, amazon SQS with minimal changes to your code that generates the events.
 
 ## Installation
 
@@ -26,19 +26,23 @@ Or install it yourself as:
 
 ## Basic Usage
 
-Register listeners:
+Register listeners, using :
 
 ```ruby
-  _listener :event1 do |params|
+  _listener :event1 do |array_of_params|
     puts "hello! event 2 has been called!"
   end
 
-  _listener :hay do |params|
+  _listener :hay do |array_of_params|
     puts "hello! someone said hay!"
   end
 ```
 
-Generate events and wrap them in a resugan block:
+Listeners are basically code that listens to an event, in this case :event1 and :hay.
+an array of params equal to the number of times that specific event was captured
+will be passed. So if :event1 was called twice, array_of_params will contain 2 elements.
+
+Generate events using _fire and wrap them in a resugan block:
 
 ```ruby
 resugan {
@@ -52,7 +56,13 @@ resugan {
 }
 ```
 
-Note that events don't have to be fired at the top level of the block, even objects used inside the block can invoke fire to generate an event.
+The _fire method is available inside all objects, however the events won't be
+collected unless within the context of a resugan block. The idea is that you
+can prepackage a library that fires those events but won't actually
+get used until someone specifically listens for it.
+
+Note that events don't have to be fired at the top level of the block, even objects
+used inside the block can invoke fire to generate an event.
 
 The two events should fire and should print:
 
@@ -101,18 +111,17 @@ Please see spec/resugan_spec.rb for more examples and details.
 
 Resugan supports namespaces, allowing you to group listeners and trigger them separately
 
-
 ```ruby
-  _listener :event1, namespace: "group1" do |params|
+  _listener :event1, namespace: "group1" do |array_of_params|
     puts "hello! event 2 has been called!"
   end
 
-  _listener :event1, namespace: "group2" do |params|
+  _listener :event1, namespace: "group2" do |array_of_params|
     puts "hello! someone said hay!"
   end
 
-  _listener :log, namespace: %w(group1 group2) do |params|
-    params.each {
+  _listener :log, namespace: %w(group1 group2) do |array_of_params|
+    array_of_params.each {
       puts "listener that belongs to 2 namespaces"
     }
   end
@@ -138,6 +147,18 @@ listener that belongs to 2 namespaces
 hello! someone said hay!
 listener that belongs to 2 namespaces
 ```
+## Unique Listeners
+
+the _listener always creates a new listener for an event, so if it so happens that
+the code that creates those listeners gets executed again it will create another one.
+if you want to make sure that listener only gets executed once you can pass an id
+option:
+
+```ruby
+listener :event1, id: 'no_other_listener_like_this' do |array|
+ # some code that gets executed
+end
+```
 
 ## Customizing the Event dispatcher
 
@@ -182,15 +203,27 @@ Line source should now be passed as params everytime you fire an event. You can
 view it by dumping a resugan context.
 
 ```ruby
-puts resugan {
+puts(resugan {
   _fire :event1
-}.dump
+}.dump)
 ```
 
 ```ruby
 {:event1=>[{:params=>{:_source=>"/Users/jedld/workspace/resugan/spec/resugan_spec.rb:144:in `block (5 levels) in <top (required)>'"}}]}
 ```
 
+## Using Resugan::Engine::MarshalledInlineDispatcher
+
+By default, resugan uses the Resugan::Engine::InlineDispatcher as the default dispatcher for 
+all namespaces. For performance reasons, params passed to the _fire method are passed as is, but there are
+times when you want to simulate params that are passed using JSON.parse as is the case
+when using a custom dispatcher that uses redis (see resugan-worker). In this case you may set MarshalledInlineDispatcher
+as the default dispatcher for test and development environment instead (e.g. rails):
+
+```ruby
+Resugan::Kernel.set_default_dispatcher(Resugan::Engine::MarshalledInlineDispatcher) if Rails.env.development? || Rails.env.test?
+```
+
 ## Related Projects
 
 Below are projects that extend resugan.
@@ -203,6 +236,10 @@ Can also be used as a sample on how to extend resugan.
 
 https://github.com/jedld/resugan-worker
 
+## Similar Projects
+
+wisper (https://github.com/krisleech/wisper) - An excellent gem that focuses on a pub-sub model. Though its global listeners somehow have the same effect though in a syntactically different way than resugan.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/resugan.rb

@@ -5,6 +5,8 @@ require "resugan/thread"
 require "resugan/context"
 require "resugan/object_helpers"
 require "resugan/engine/inline_dispatcher"
+require "resugan/engine/marshalled_inline_dispatcher"
+require "json"
 
 module Resugan
 end

data/lib/resugan/engine/marshalled_inline_dispatcher.rb

@@ -0,0 +1,17 @@
+module Resugan
+  module Engine
+    class MarshalledInlineDispatcher
+      def dispatch(namespace, events)
+        marshalled_events = []
+        events.each do |k, v|
+          marshalled_events << { event: k, args: v }.to_json
+        end
+
+        marshalled_events.each do |event|
+          unmarshalled_event = JSON.parse(event)
+          Resugan::Kernel.invoke(namespace, unmarshalled_event['event'], unmarshalled_event['args'])
+        end
+      end
+    end
+  end
+end

data/lib/resugan/kernel.rb

@@ -33,7 +33,7 @@ module Resugan
 
     def self.register_dispatcher(dispatcher, namespace = '')
       @dispatchers = {} unless @dispatchers
-      @dispatchers[namespace] = dispatcher
+      @dispatchers[namespace] = dispatcher.is_a?(Class) ? dispatcher.new : dispatcher
     end
 
     def self.register(event, &block)
@@ -64,8 +64,6 @@ module Resugan
 
     def self.invoke(namespace, event, payload = [])
       event = "#{namespace}_#{event}".to_sym
-      puts "invoke"
-      p @_listener
       if @_listener && @_listener[event]
         @_listener[event].each do |_listener|
           _listener.call(payload.map { |p| p[:params] || p['params'] })

data/lib/resugan/version.rb

@@ -1,3 +1,3 @@
 module Resugan
-  VERSION = "0.1.11"
+  VERSION = "0.1.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resugan
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Joseph Emmanuel Dayo
@@ -87,6 +87,7 @@ files:
 - lib/resugan.rb
 - lib/resugan/context.rb
 - lib/resugan/engine/inline_dispatcher.rb
+- lib/resugan/engine/marshalled_inline_dispatcher.rb
 - lib/resugan/kernel.rb
 - lib/resugan/object.rb
 - lib/resugan/object_helpers.rb