pubsubhub 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3593b95bdec65c16c1ffb96905f6ca3031d4cf4
+  data.tar.gz: b5476d46c224486b036e4b89c7dd44077f34b4cc
+SHA512:
+  metadata.gz: 8782b4ebddfd438745ab2dd5261b8365c4227fd9dad74ed7561dd8f1fc32ed1617a4fa79b1b59c6173e6ebcf3a61ed7f7d7d39f1d2c684bcd3c9279cdd819982
+  data.tar.gz: 2cb5b9378f5341349642bd338927d5bec8fc45043fe07833b4339044834b9c87a74e7cdfc46ae8e9ba5ea6a500bc08fc85bf68351b6750e60950edf0667c3d9a

data/lib/pubsubhub.rb

@@ -0,0 +1,124 @@
+require 'forwardable'
+require 'singleton'
+
+# The `PubSubHub` provides a mechanism to subscribe to events and notify
+# objects of events.
+#
+# To subscribe to an event, add a hash to
+# {file:config/initializers/pub_sub_hub.rb}. The listener must implement
+# `handle_#{event_name}`.
+#
+#     # {file:config/initializers/pub_sub_hub.rb}
+#
+#     PubSubHub.register(
+#       took_action: [
+#         { listener: Mailer, async: true },
+#       ],
+#     )
+#
+# To trigger an event, call `PubSubHub.trigger`. All the arguments are
+# forwarded to the `listener`.
+#
+#     class Action
+#       def take_action(person)
+#         # ...
+#         PubSubHub.trigger :took_action, self, person
+#       end
+#     end
+#
+#     class Mailer
+#       def self.handle_took_action(action, person)
+#         # send `action.creator` an email
+#       end
+#     end
+#
+# By default, exceptions raised during event propagation are handled by printing
+# them to standard error. You can set a custom handler by passing in a callable
+# object to `PubSubHub.error_handler=`. We use this at Causes to integrate with
+# our `Oops` plug-in, without creating a hard dependency on it:
+#
+#     PubSubHub.error_handler = ->(exception) { Oops.log(exception) }
+#
+# Likewise, dispatch of `async: true` events is handled by a callable passed in
+# to `PubSubHub.async_dispatcher=`. The default implementation just calls
+# `Object#send` (ie. it is not actually asynchronous). At Causes, we've supplied
+# a custom dispatcher that relies on the async_observer plug-in:
+#
+#     PubSubHub.async_dispatcher = ->(listener, handler, args) do
+#       listener.async_send(handler, *args)
+#     end
+#
+class PubSubHub
+  include Singleton
+
+  VERSION = '0.0.1'
+
+  class << self
+    extend Forwardable
+
+    # Convenience methods:
+    def_delegators :instance,
+      :async_dispatcher,
+      :async_dispatcher=,
+      :error_handler,
+      :error_handler=,
+      :register,
+      :trigger
+  end
+
+  attr_accessor :async_dispatcher, :error_handler
+  attr_reader :registry
+
+  def initialize
+    @async_dispatcher = ->(listener, handler, args) do
+      listener.send(handler, *args)
+    end
+
+    @error_handler = ->(exception) { STDERR.puts exception }
+  end
+
+  def register(registry)
+    @registry = validate_registry!(registry)
+  end
+
+  # Notifies listeners of a event.
+  #
+  # Arguments are forwarded to the handlers. If the listener registered with
+  # `async: true`, `trigger` calls the handler using an asynchronous dispatcher.
+  #
+  # The default dispatcher just forwards the message directly. For an example of
+  # a dispatcher that is actually asynchronous, see
+  # {file:config/initializers/pub_sub_hub.rb}, which sets up:
+  #
+  #   PubSubHub.async_dispatcher = ->(listener, handler, args) do
+  #     listener.async_send(handler, *args)
+  #   end
+  #
+  def trigger(event_name, *args)
+    @registry[event_name.to_sym].each do |registration|
+      begin
+        listener = registration[:listener]
+        async    = registration[:async]
+        handler  = :"handle_#{event_name}"
+
+        if async
+          @async_dispatcher.call(listener, handler, args)
+        else
+          listener.send(handler, *args)
+        end
+      rescue => e
+        @error_handler.call(e)
+      end
+    end
+  end
+
+private
+
+  def validate_registry!(registry)
+    registry.each do |event_name, registrations|
+      registrations.any? do |registration|
+        raise ArgumentError unless registration[:listener]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: pubsubhub
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Causes Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PubSubHub allows you to loosen the coupling between components in a system
+  by providing a centralized registry of events and listeners that subscribe to them.
+email:
+- eng@causes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pubsubhub.rb
+homepage: https://github.com/causes/pubsubhub
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Simple event-based publish-subscribe library
+test_files: []