signals 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0a17dcf963e613b1958719ee6335e765e1f4233
-  data.tar.gz: f322c5f49706eb819a44e39a8bb54211bf7fc49b
+  metadata.gz: f4c85e1c8bbac32c7a94627bd21b1b4c8e4abae5
+  data.tar.gz: 7f8da72aa990368a5c347d4360cfe0fa537a70b6
 SHA512:
-  metadata.gz: c6317c3d341b4fd50be0eaf0ef67e5ce8bbab4e1bb99ab60c4a4fa21dbe27d3d3bf6efbc57831b0ca82bb31572dd7be9b020d4ebcc8a3524fe403c4b425de9e0
-  data.tar.gz: e20efc2de3708bbf8e53ba7a574dd353799dfd0d58d51787f16e895844287c4f94000ecbbe61a4c142bccb4180841d608a2e2e724804f52ceabef8bf0778eccb
+  metadata.gz: 58e800ed2f583788265d2dde09aaae317ccc12fb262d9fed67abbfa26d046df1cfba69716f679c6239bdbb928043fc3c69e372b69a795173f83e2de1e37fb33d
+  data.tar.gz: 84a3b7c9048dc56c705b17a6521b508b7175b05db82625d43408c9da464d069995227a6d1d7ccd3bd8ad0802f4106caa0584d19f96dbd7f2875e8f00d7cc5582

data/README.md

@@ -1,8 +1,11 @@
 # Signals
 
-A light weight publish / subscribe. It is similar to how the gem Wisper works
-but without extra functionality. This library assumes nothing and concurrency is
-not a priortiy.
+[![Code Climate](https://codeclimate.com/github/warmwaffles/signals.png)](https://codeclimate.com/github/warmwaffles/signals)
+
+A light weight publish / subscribe. It is similar to how the Wisper gem works.
+Except that listeners must include `Signals::Subscriber` so that it can have a
+nice DSL and listen for specific events and trigger actions based on those
+events. This library also has no external dependencies.
 
 ## Installation
 
@@ -54,12 +57,85 @@ coach.subscribe(center)
 coach.on(:stop) do |c|
   puts "I'm telling you to stop"
 end
+
+coach.broadcast(:v_formation, coach)
+coach.broadcast(:hat_trick, coach)
+coach.broadcast(:stop, coach)
+```
+
+## Rails Usage
+
+```rb
+# app/controllers/something_controller.rb
+class SomethingController < ApplicationController
+  # ...
+  def create
+    service = CreateSomething.new(something_params)
+    service.subscribe(AListener.new)
+    service.subscribe(AnotherListener.new)
+    service.on(:create_something_successful) do |something|
+      redirect_to something_path(something)
+    end
+    service.on(:create_something_failed) do |something|
+      @something = something
+      render action: 'new'
+    end
+    service.execute
+  end
+  # ...
+end
+```
+
+```rb
+# app/services/create_something.rb
+class CreateSomething
+  include Signals::Publisher
+
+  def initialize(something_params={})
+    @something = Something.new(something_params)
+  end
+
+  def execute
+    if @something.save
+      broadcast(:create_something_successful, @something)
+    else
+      broadcast(:create_something_failed, @something)
+    end
+  end
+end
+```
+
+```rb
+# app/listeners/a_listener.rb
+class AListener
+  include Signals::Subscriber
+
+  listen_for :create_something_success => :enqueue_send_email
+
+  def enqueue_send_email
+    # queue it up to send an email
+  end
+end
+```
+
+```rb
+# app/listeners/another_listener.rb
+class AnotherListener
+  include Signals::Subscriber
+
+  listen_for :create_something_failed => :log_failure
+
+  def log_failure(something)
+    Rails.logger.error "Something failed"
+  end
+end
 ```
 
 ## 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
+  1. Fork it
+  2. Create your feature branch
+  3. Commit your changes
+  4. Write tests for those changes
+  5. Push the changes
+  6. Create new Pull Request

data/lib/signals/publisher.rb

@@ -3,13 +3,9 @@ module Signals
   module Publisher
 
     def self.included(base)
-      base.extend(ClassMethods)
       base.send(:include, InstanceMethods)
     end
 
-    module ClassMethods
-    end
-
     module InstanceMethods
       # Broadcasts an event to all of the subscribed listeners
       # @return [void]
@@ -29,12 +25,21 @@ module Signals
       end
 
       # Subscribe a listener to the publisher
+      # @param [Object] listener
       # @return [void]
       def subscribe(listener)
         listeners.add(listener)
         nil
       end
 
+      # Unsubscribe a listener from the publisher
+      # @param [Object] listener
+      # @return [void]
+      def unsubscribe(listener)
+        listeners.delete(listener)
+        nil
+      end
+
       # All of the listeners subscribed to a publisher
       # @return [Set] a unique set of listeners
       def listeners

data/lib/signals/subscriber.rb

@@ -104,6 +104,9 @@ module Signals
         events.include?(event)
       end
 
+      # Get actions for a specific event
+      # @param [Symbol] event
+      # @return [Array]
       def actions_for(event)
         self.events[event] || Array.new
       end

data/lib/signals/version.rb

@@ -1,3 +1,3 @@
 module Signals
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signals
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthew Johnston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-03 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler