ribbon-event_bus 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07d4601534a5d201e75d5c81367616d82e278c2e
-  data.tar.gz: de763f8aeb39610d210860de8050f6dd6a78327d
+  metadata.gz: cd26c9dead029e9b0486e8ba596468db76fb7bb3
+  data.tar.gz: 0051194033a07c691886ce03b1f9a2ff07f83a94
 SHA512:
-  metadata.gz: 0d1adb38016cc6bb5c59b9d345d147f2dc224d69de9bf166bc13a1a0e4c32869a84a3f3e362a163473551f54a88b1d90d1679838e5d0fcf99488b728063d7a36
-  data.tar.gz: 76a811606c9e92f8c87f6c9131ad7e20e8a011648729c8b86f2da4b053d2a34e5dfd1e8a347cbe50a01820837a15401c4e440d777e3b8098c3a54ce244e4eb29
+  metadata.gz: 0b42f285a3fbca1401bff8810282a38c3392da3d56a03c9c594cd2fc2c93556a55a403ed0ab943f05bc96f040d1b90b4741e2c0b61e3e630c41a64a4d3d93c84
+  data.tar.gz: 2757b6055e37f0bb290d3ff98ee279d955f947f75a9de935c310ae2c91b7f5d16f9f4bf4affd2c6f917be3929901aa057f5a2a5818a94367ed858142f23ecc39

data/lib/ribbon/event_bus/errors.rb

@@ -25,6 +25,7 @@ module Ribbon::EventBus
     class SubscriptionError < Error; end
     class InvalidPriorityError < SubscriptionError; end
     class UnexpectedEventError < SubscriptionError; end
+    class DuplicateIdentifierError < SubscriptionError; end
 
     ###
     # Publisher Errors

data/lib/ribbon/event_bus/instance.rb

@@ -68,8 +68,8 @@ module Ribbon
         _registered_subscriptions_to(event_name).dup
       end
 
-      def find_subscription(locator)
-        _subscriptions_by_locators[locator]
+      def find_subscription(identifier)
+        _subscriptions_by_identifiers[identifier]
       end
 
       def find_publisher(publisher)
@@ -82,11 +82,11 @@ module Ribbon
       end
 
       def _register_subscription(subscription)
-        if _subscriptions_by_locators[subscription.locator]
+        if _subscriptions_by_identifiers[subscription.identifier]
           # This is not expected to occur
-          raise Errors::SubscriptionError, "duplicate locator: #{subscription.locator.inspect}"
+          raise Errors::SubscriptionError, "duplicate identifier: #{subscription.identifier.inspect}"
         else
-          _subscriptions_by_locators[subscription.locator] = subscription
+          _subscriptions_by_identifiers[subscription.identifier] = subscription
        end
 
         _registered_subscriptions_to(subscription.event_name)
@@ -116,8 +116,8 @@ module Ribbon
         (@__registered_subscriptions ||= {})[event_name] ||= []
       end
 
-      def _subscriptions_by_locators
-        @__registered_subscriptions_by_locator ||= {}
+      def _subscriptions_by_identifiers
+        @__registered_subscriptions_by_identifier ||= {}
       end
 
       def _load_default_config

data/lib/ribbon/event_bus/subscription.rb

@@ -7,12 +7,12 @@ module Ribbon::EventBus
     include Mixins::Serializable
 
     config_key :subscriptions
-    serialize_with :instance, :locator
+    serialize_with :instance, :identifier
 
     attr_reader :name
     attr_reader :event_name
     attr_reader :priority
-    attr_reader :locator
+    attr_reader :identifier
 
     def initialize(event_name, params={}, &block)
       @event_name = event_name.to_sym
@@ -20,14 +20,17 @@ module Ribbon::EventBus
 
       _evaluate_params(params)
 
-      @name ||= _path
-      @locator = _generate_locator
+      @identifier = _generate_identifier
 
-      instance._register_subscription(self)
+      if instance.find_subscription(identifier)
+        raise Errors::DuplicateIdentifierError, "give this subscription a unique name"
+      else
+        instance._register_subscription(self)
+      end
     end
 
-    def self.load_from_serialized(instance, locator)
-      instance.find_subscription(locator)
+    def self.load_from_serialized(instance, identifier)
+      instance.find_subscription(identifier)
     end
 
     def handle(event)
@@ -40,7 +43,7 @@ module Ribbon::EventBus
     end
 
     def to_s
-      "Subscription(#{event_name}, #{name})"
+      "Subscription(on #{event_name}: #{name || _path})"
     end
 
     private
@@ -49,8 +52,15 @@ module Ribbon::EventBus
       @__path ||= _determine_path
     end
 
+    ##
+    # Determines the file path of the ruby code defining the subscription.
+    # It's important that this is called from within the initializer to get the
+    # desired effect.
     def _determine_path
       path = File.expand_path('../..', __FILE__)
+
+      # Will be something like:
+      # "/path/to/file.rb:47:in `method_name'"
       non_event_bus_caller = caller.find { |c| !c.start_with?(path) }
 
       unless non_event_bus_caller
@@ -61,8 +71,22 @@ module Ribbon::EventBus
       non_event_bus_caller
     end
 
-    def _generate_locator
-      Digest::MD5.hexdigest(_path).to_sym
+    ##
+    # Generates a unique identifier for this subscription which will be used to
+    # "serialize" it.
+    #
+    # The goal here is to generate a identifier that is the same across different
+    # processes and servers and that ideally changes infrequently between
+    # application versions, but when it does change, it should do so predictably.
+    def _generate_identifier
+      # Cut off everything from the line number onward. That way, the identifier
+      # does not change when the subscription block moves to a different line.
+      index = _path.rindex(/:\d+:/) - 1
+      path = _path[0..index]
+
+      raise Errors::SubscriptionError, "Invalid path: #{path}" unless File.exists?(path)
+
+      Digest::MD5.hexdigest("#{path}:#{event_name}:#{name}").to_sym
     end
 
     def _symbol_to_priority(sym)
@@ -89,7 +113,7 @@ module Ribbon::EventBus
     ###
     def _evaluate_params(params)
       @instance = params[:instance]
-      @name = params[:name]
+      @name = params[:name].to_s
       @priority = _evaluate_priority(params[:priority])
     end
 

data/lib/ribbon/event_bus/version.rb

@@ -1,5 +1,5 @@
 module Ribbon
   module EventBus
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ribbon-event_bus
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Honer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ribbon-plugins
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: An asynchronous event bus for Ruby.