resugan 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 125a46c660b15e707e2e9c7ff8566b1f396748ae
-  data.tar.gz: 9902cfe5e810f491fed9580e48b539bf99c5048e
+  metadata.gz: 7b0da82adc30cfab65fae130355e751f37aaa0ec
+  data.tar.gz: ba8ca7543faf7d229e11a986f0376ce65b4a880b
 SHA512:
-  metadata.gz: 058d79aec3ee6752265d00687f6bd4644ddb3f2c27f6016b764cbad4e8a84a1fbe7a5e4ef10c113c10c68d028118f2eb3eec395049a8731c7ceba5ebfccc6478
-  data.tar.gz: 2e9fd51c681d1bc04323037c6a41ea1fb8e76d0dac678adba2b0dbc4c89a01fbf18ccb5d9e28aeddf20b1492942964b3d0c804bf72765dd02e26166141d357f8
+  metadata.gz: 6f15686a8c362eb7206e3160517026ceb5d7a29ef1155ae8c863319524ee2e1713b22d7d9621d5b885b6046ff9ce2f18e5682ccc72de3214d62c5f3be92777b6
+  data.tar.gz: b6a4838b230915d920ff92c9814f7e8ec8cd4b35ffe6f275d38a2ac0b211c4cafef897124868141de5c9fb198f4b0f3e920772b1c4870a5154b358db5e822253

data/README.md

@@ -59,6 +59,37 @@ hello! someone said hay!
 Note that your listener will be executed once even if an event has been fired
 multiple times. However params will contain the payload of both events. This allows you to batch together requests and efficiently dispatch them as a group.
 
+# Object helpers
+
+Helpers are available to make listening firing events a little bit cleaner:
+
+```ruby
+class TestObject
+  include Resugan::ObjectHelpers
+end
+```
+
+This basically allows for the attach_hook to be available
+
+```ruby
+class TestObject
+  include Resugan::ObjectHelpers
+
+  def method2
+    _fire :event1
+  end
+
+  def method3
+    _fire :event2, param1: "hello"
+  end
+
+  attach_hook :method2
+  attach_hook :method3, namespace: "namespace1"
+end
+```
+
+What this does is it essentially wraps the specified methods inside a resugan block.
+
 Please see spec/resugan_spec.rb for more examples and details.
 
 ## namespaces
@@ -115,6 +146,41 @@ Or assign it to a specific namespace:
   Resugan::Kernel.register_dispatcher(MyCustomerDispatcher, 'CustomGroup')
 ```
 
+## Debugging
+
+Sometimes you need to track where events are fired. You can do so by enabling line tracing:
+
+```ruby
+  Resugan::Kernel.enable_line_trace true
+```
+
+Line source should now be passed as params everytime you fire an event. You can also
+view it by dumping a resugan context.
+
+```ruby
+puts resugan {
+  _fire :event1
+}.dump
+```
+
+```ruby
+{:event1=>[{:params=>{:_source=>"/Users/jedld/workspace/resugan/spec/resugan_spec.rb:144:in `block (5 levels) in <top (required)>'"}}]}
+```
+
+
+
+## Related Projects
+
+Below are projects that extend resugan.
+
+Resugan Worker
+--------------
+
+A project that wraps resugan listeners to be consumed using an external worker.
+Can also be used as a sample on how to extend resugan.
+
+https://github.com/jedld/resugan-worker
+
 ## 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/context.rb

@@ -5,6 +5,10 @@ module Resugan
       @events = {}
     end
 
+    def namespace
+      @namespace
+    end
+
     def register(event, params = {})
       event = event.to_sym
       payload = { params: params }
@@ -19,5 +23,9 @@ module Resugan
       dispatcher = Resugan::Kernel.dispatcher_for(@namespace)
       dispatcher.dispatch(@namespace, @events)
     end
+
+    def dump
+      @events
+    end
   end
 end

data/lib/resugan/kernel.rb

@@ -1,5 +1,14 @@
 module Resugan
   class Kernel
+    # flag to log the line source where a fire was executed
+    def self.enable_line_trace(enable)
+      @enable = enable
+    end
+
+    def self.line_trace_enabled?
+      @enable || false
+    end
+
     def self.set_default_dispatcher(dispatcher)
       @default_dispatcher ||= dispatcher.new
     end

data/lib/resugan/object.rb

@@ -7,9 +7,13 @@ class Object
 
     context = current_thread.pop_resugan_context
     context.invoke
+    
+    context
   end
 
   def _fire(event, params = {})
+    params[:_source] = caller[0] if Resugan::Kernel.line_trace_enabled?
+
     current_thread = Thread.current
     if current_thread.resugan_context
       current_thread.resugan_context.register(event, params)

data/lib/resugan/version.rb

@@ -1,3 +1,3 @@
 module Resugan
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resugan
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Joseph Emmanuel Dayo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: simple, powerful and unobstrusive event framework for ruby