ribbon-event_bus 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c83efffe844e2c1892b1e481097a5831aedf70ee
-  data.tar.gz: 186b25081e035b0b0ce0a2eb471fea5aee74b260
+  metadata.gz: fa0e255bfceecf580acb711845bdf8402d212593
+  data.tar.gz: 107d32e1e5dd6c66597aaefae1d3dfa6a2cc13ab
 SHA512:
-  metadata.gz: ffd5b13af305094619bfc9b9fd51fa3df095b2fee5b1a037b4f79eebd09ad0848661d78e96d27f44aadf3af882fa709cdd71895f9e253ee5ca94551220ebf54d
-  data.tar.gz: 6c9ef7a77f6b8934edb74e206d7ae785ddf9738fe4f5d72c89602f9d8d668653a1b1030b3d60fb3dc37a71f0f05fbdce6190d138e5cb2cbc736ae9caba5c34d9
+  metadata.gz: 29404aa9a31933c838acd94e60d9c0f22bd8d9ea2e46739fcca65cc83dc6778527df8ac2ecc4f801c23daff2067f61465b642eb39d65da2d801f5bc256eb7900
+  data.tar.gz: 830ded2e0e09da4db4403dbdc228565302895f711edb5b2c117d612747f576f3797f2343ae1815b3ad5de00e166e65d81e587037ed780a04e8a2de2b6ae57c14

data/lib/ribbon/event_bus/config.rb

@@ -18,6 +18,12 @@ module Ribbon::EventBus
       end
     end
 
+    class UndefinedValue
+      def !
+        true
+      end
+    end
+
     attr_reader :name
 
     def initialize(name=nil, &block)
@@ -60,28 +66,10 @@ module Ribbon::EventBus
       elsif /^(\w+)\?$/.match(meth_str)
         !!_get($1)
       else
-        object = _get(meth)
-        object = _set(meth, Config.new((name ? "#{name}." : '') + meth_str)) unless object
-        object
+        _get_or_create_namespace(meth)
       end
     end
 
-    def nested(name)
-      _nested[name.to_sym]
-    end
-
-    def nest_value(name, value)
-      nested()
-    end
-
-    def nested_values(key)
-      _nested_values[key.to_sym]
-    end
-
-    def nested_configs(namespace)
-      _nested_configs[namespace.to_sym]
-    end
-
     def merge_hash!(hash)
       hash.each { |k, v|
         if v.is_a?(Hash)
@@ -103,6 +91,16 @@ module Ribbon::EventBus
       _nested[key.to_sym]
     end
 
+    def _get_or_create_namespace(key)
+      object = _get(key)
+
+      if object.is_a?(UndefinedValue)
+        object = _set(key, Config.new((name ? "#{name}." : '') + key.to_s))
+      end
+
+      object
+    end
+
     def _set(key, *args, &block)
       object = _args_to_object(*args, &block)
       _nested[key.to_sym] = object
@@ -111,7 +109,7 @@ module Ribbon::EventBus
     def _add(key, *args, &block)
       raise NotAddableError, self.inspect if @_value && !@_value.is_a?(Array)
       object = _args_to_object(*args, &block)
-      _set(key, object.is_a?(Proc) ? ProcArray.new : []) unless _get(key)
+      _set(key, object.is_a?(Proc) ? ProcArray.new : []) if !_get(key)
       _get(key).push(object)
     end
 
@@ -128,7 +126,7 @@ module Ribbon::EventBus
     end
 
     def _nested
-      @_nested ||= {}
+      @_nested ||= Hash.new { |hash, key| hash[key] = UndefinedValue.new }
     end
   end # Config
 end # Ribbon::EventBus

data/lib/ribbon/event_bus/errors.rb

@@ -41,6 +41,11 @@ module Ribbon::EventBus
     class MissingProcError < ProcPublisherError; end
     class InvalidArityError < ProcPublisherError; end
 
+    ###
+    # Plugin Errors
+    ###
+    class PluginError < Error; end
+
     ###
     # Serializable Errors
     ###

data/lib/ribbon/event_bus/event.rb

@@ -25,13 +25,21 @@ module Ribbon::EventBus
     end
 
     def publish
-      instance.publishers.each { |p| p.publish(self) }
+      plugins.perform(:publish, self) { |event|
+        instance.publishers.each { |p| p.publish(event) }
+      }
     end
 
     def subscriptions
       instance.subscriptions_to(self)
     end
 
+    def to_s
+      "Event(#{name}" <<
+        (params && !params.empty? && ", #{params.inspect}" or '') <<
+        ")"
+    end
+
     private
 
     ############################################################################

data/lib/ribbon/event_bus/instance.rb

@@ -1,3 +1,5 @@
+require 'ribbon/plugins'
+
 module Ribbon
   module EventBus
     DEFAULT_CONFIG_PATH = File.expand_path('../../../../config/defaults.yml', __FILE__).freeze
@@ -11,9 +13,14 @@ module Ribbon
     ##############################################################################
     class Instance
       include Mixins::Serializable
+      include Ribbon::Plugins::ComponentMixin
 
       serialize_with :name
 
+      plugin_loader do |plugin|
+        _translate_object_to_plugin(plugin)
+      end
+
       attr_reader :name
       attr_reader :publishers
 
@@ -43,6 +50,10 @@ module Ribbon
         }
       end
 
+      def plugin(*args)
+        config { plugin(*args) }
+      end
+
       def publish(*args)
         raise Errors::NoPublishersDefinedError unless publishers && !publishers.empty?
         _args_to_event(*args).publish
@@ -75,6 +86,23 @@ module Ribbon
       end
 
       private
+      def _translate_object_to_plugin(object)
+        case object
+        when String, Symbol
+          _translate_string_to_plugin(object.to_s)
+        end
+      end
+
+      def _translate_string_to_plugin(string)
+        begin
+          Plugins.const_get(
+            string.split('_').map(&:capitalize).join + 'Plugin'
+          )
+        rescue
+          nil # Let the Plugins gem handle this.
+        end
+      end
+
       def _registered_subscriptions_to(event_name)
         (@__registered_subscriptions ||= {})[event_name] ||= []
       end
@@ -101,11 +129,23 @@ module Ribbon
 
       def _process_config
         @publishers = _load_publishers.dup.freeze
+        _update_plugins
       end
 
       def _load_publishers
         Publishers.load_for_instance(self)
       end
+
+      def _update_plugins
+        plugins.clear
+
+        if config.plugin?
+          config.plugin.each { |plugin|
+            plugin = [plugin] unless plugin.is_a?(Array)
+            plugins.add(*plugin)
+          }
+        end
+      end
     end # Instance
   end # EventBus
 end # Ribbon

data/lib/ribbon/event_bus/mixins/has_instance.rb

@@ -4,6 +4,10 @@ module Ribbon
       def instance
         (defined?(@instance) && @instance) || EventBus.instance
       end
+
+      def plugins
+        instance.send(:plugins)
+      end
     end
   end
 end

data/lib/ribbon/event_bus/plugins/logging_plugin.rb

@@ -0,0 +1,68 @@
+require 'logger'
+
+module Ribbon::EventBus
+  module Plugins
+    class LoggingPlugin < Plugin
+      config_key :logging
+
+      def logger
+        @_logger ||= _load_logger
+      end
+
+      around_publish do |event|
+        _run('Publishing', event) { publish }
+      end
+
+      around_resque_publish do |event|
+        _run('Publishing on Resque', event) { resque_publish }
+      end
+
+      around_subscription do |sub, event|
+        _run('Executing Subscription', sub) { subscription }
+      end
+
+      private
+      def _load_logger
+        if config.logger?
+          config.logger
+        else
+          Logger.new(STDOUT).tap { |logger|
+            logger.level = _load_level
+          }
+        end
+      end
+
+      def _load_level
+        case config.level
+        when :info, nil
+          Logger::INFO
+        when :warn
+          Logger::WARN
+        when :error
+          Logger::ERROR
+        when :fatal
+          Logger::FATAL
+        else
+          raise Errors::PluginError, "Invalid plugins.logging.level: #{config.level.inspect}"
+        end
+      end
+
+      def _run(subject, object, &block)
+        logger.debug("#{subject}: #{object}")
+
+        if config.log_exceptions?
+          begin
+            block.call
+          rescue Exception => e
+            logger.fatal("Exception raised when #{subject.downcase} #{object}: #{e.inspect}")
+            raise
+          end
+        else
+          block.call
+        end
+
+        logger.debug("Finished #{subject}: #{object}")
+      end
+    end
+  end
+end

data/lib/ribbon/event_bus/plugins/plugin.rb

@@ -0,0 +1,22 @@
+require 'ribbon/plugins'
+
+module Ribbon::EventBus
+  module Plugins
+    class Plugin < Ribbon::Plugins::Plugin
+      include Mixins::HasInstance
+      include Mixins::HasConfig
+
+      config_key :plugins
+
+      def initialize(plugins, params={})
+        super(plugins)
+        @instance = plugins.component
+        @_params = params || {}
+      end
+
+      def config
+        @__config ||= super.merge_hash!(@_params)
+      end
+    end
+  end
+end

data/lib/ribbon/event_bus/plugins.rb

@@ -0,0 +1,6 @@
+module Ribbon::EventBus
+  module Plugins
+    autoload(:Plugin,        'ribbon/event_bus/plugins/plugin')
+    autoload(:LoggingPlugin, 'ribbon/event_bus/plugins/logging_plugin')
+  end
+end

data/lib/ribbon/event_bus/publishers/resque_publisher.rb

@@ -22,17 +22,20 @@ module Ribbon::EventBus
 
         def self.perform(sub_queue_format, serialized_event)
           event = Event.deserialize(serialized_event)
-
-          event.subscriptions.each { |s|
-            SubscriptionJob.set_queue(
-              (sub_queue_format % {
-                event: event.name,
-                priority: s.priority
-              }).to_sym
-            )
-
-            Resque.enqueue(SubscriptionJob, s.serialize, event.serialize)
-          }
+          instance = event.instance
+
+          instance.plugins.perform(:resque_publish, event) do |event|
+            event.subscriptions.each { |s|
+              SubscriptionJob.set_queue(
+                (sub_queue_format % {
+                  event: event.name,
+                  priority: s.priority
+                }).to_sym
+              )
+
+              Resque.enqueue(SubscriptionJob, s.serialize, event.serialize)
+            }
+          end
         end
       end
 

data/lib/ribbon/event_bus/subscription.rb

@@ -9,6 +9,7 @@ module Ribbon::EventBus
     config_key :subscriptions
     serialize_with :instance, :locator
 
+    attr_reader :name
     attr_reader :event_name
     attr_reader :priority
     attr_reader :locator
@@ -26,7 +27,9 @@ module Ribbon::EventBus
       @_block = block
 
       _evaluate_params(params)
-      _generate_locator
+
+      @name ||= _path
+      @locator = _generate_locator
 
       instance._register_subscription(self)
     end
@@ -38,12 +41,23 @@ module Ribbon::EventBus
     def handle(event)
       raise Errors::UnexpectedEventError, 'wrong name' unless event.name == event_name
       raise Errors::UnexpectedEventError, 'wrong instance' unless event.instance == instance
-      @_block.call(event)
+
+      plugins.perform(:subscription, self, event) { |subscription, event|
+        @_block.call(event)
+      }
+    end
+
+    def to_s
+      "Subscription(#{event_name}, #{name})"
     end
 
     private
 
-    def _generate_locator
+    def _path
+      @__path ||= _determine_path
+    end
+
+    def _determine_path
       path = File.expand_path('../..', __FILE__)
       non_event_bus_caller = caller.find { |c| !c.start_with?(path) }
 
@@ -52,7 +66,11 @@ module Ribbon::EventBus
         raise Errors::SubscriptionError, "Could not find non-EventBus caller"
       end
 
-      @locator = Digest::MD5.hexdigest(non_event_bus_caller).to_sym
+      non_event_bus_caller
+    end
+
+    def _generate_locator
+      Digest::MD5.hexdigest(_path).to_sym
     end
 
     ############################################################################
@@ -65,9 +83,9 @@ module Ribbon::EventBus
     # Root evaluation method.
     ###
     def _evaluate_params(params)
-      params = params.dup
-      @instance = params.delete(:instance)
-      @priority = _evaluate_priority(params.delete(:priority))
+      @instance = params[:instance]
+      @name = params[:name]
+      @priority = _evaluate_priority(params[:priority])
     end
 
     ###

data/lib/ribbon/event_bus/version.rb

@@ -1,5 +1,5 @@
 module Ribbon
   module EventBus
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/ribbon/event_bus.rb

@@ -1,12 +1,13 @@
 module Ribbon
   module EventBus
-    autoload(:Instance, 'ribbon/event_bus/instance')
-    autoload(:Errors, 'ribbon/event_bus/errors')
-    autoload(:Config, 'ribbon/event_bus/config')
-    autoload(:Event, 'ribbon/event_bus/event')
+    autoload(:Instance,     'ribbon/event_bus/instance')
+    autoload(:Config,       'ribbon/event_bus/config')
+    autoload(:Publishers,   'ribbon/event_bus/publishers')
+    autoload(:Plugins,      'ribbon/event_bus/plugins')
+    autoload(:Event,        'ribbon/event_bus/event')
     autoload(:Subscription, 'ribbon/event_bus/subscription')
-    autoload(:Publishers, 'ribbon/event_bus/publishers')
-    autoload(:Mixins, 'ribbon/event_bus/mixins')
+    autoload(:Mixins,       'ribbon/event_bus/mixins')
+    autoload(:Errors,       'ribbon/event_bus/errors')
 
     module_function
 

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: ribbon-event_bus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Honer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ribbon-plugins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +159,9 @@ files:
 - lib/ribbon/event_bus/mixins/has_config.rb
 - lib/ribbon/event_bus/mixins/has_instance.rb
 - lib/ribbon/event_bus/mixins/serializable.rb
+- lib/ribbon/event_bus/plugins.rb
+- lib/ribbon/event_bus/plugins/logging_plugin.rb
+- lib/ribbon/event_bus/plugins/plugin.rb
 - lib/ribbon/event_bus/publishers.rb
 - lib/ribbon/event_bus/publishers/proc_publisher.rb
 - lib/ribbon/event_bus/publishers/publisher.rb
@@ -148,7 +171,8 @@ files:
 - lib/ribbon/event_bus/subscription.rb
 - lib/ribbon/event_bus/version.rb
 homepage: http://github.com/ribbon/event_bus
-licenses: []
+licenses:
+- BSD
 metadata: {}
 post_install_message: 
 rdoc_options: []