observers 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03108108c365bb1857d0ff575823ba87a1c530e0c83014534e8f6d696ea0a3dd'
-  data.tar.gz: be85d6ddfe681c52ea79b3f09dc1538c1da6c494fbf8667cc2a98237f3e1c12e
+  metadata.gz: 1baa5ca1c0866fe6e708bc669db53424411099c44a7747cbe441f3e50191b3b8
+  data.tar.gz: 361100827e869fa95814d94ae4789637bb7b794d3e55063414adc647683e47e9
 SHA512:
-  metadata.gz: d3845675c5749e181bea80f4082ab86df3072258867847562a214e872f02bc668688dc41e02e95e5ab91c3c2bd5649986cc850c108141b06f8c40054fd97b010
-  data.tar.gz: 94ca9aaedd1c66bc410115e4bd9426a38dd497eaa8563d68488a4fb4b917d9e7150f31e64735fdffd058bb669570bcf81bb9c91e70904882cc902933b2fafb89
+  metadata.gz: 319423e0cd9b9cc4b2c68dd5887eef9c0cae72102957d79bddb86e13f18dcc369fdb5b5d361d88c5b27fb1503c80883c2c3692a50fb847c01b3caa206a622a07
+  data.tar.gz: afcfe235cc45aad95d657d3da28c118d116d767cda8f24790c7c99467cfc660493c18896eb0b0dcda893a0117b45b0e74b80ec290439a79e16821e54b0183811

data/lib/models/key.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Observers
+  class NoObserversError < StandardError; end
+
   class Key
     attr_reader :observers
 
@@ -10,21 +12,19 @@ module Observers
     end
 
     def observe(object:, action:)
-      # TODO: We can observe objects directly, no need to wrap in an observer... no need to let the object's observer override the action?
+      # TODO: We can observe objects directly, no need to wrap in an observer, unless need to let the object's observer override the action?
       # A future reason I can think of for keeping observer wrapper is to track whether the object has implemented certain actions/methods.
       @observers << Observer.new(object:, action:)
     end
 
     # @returns: The result of the last observer with a non-nil value.
     def trigger(action: nil, event: nil)
-      empty_observers_callback
-
-      action = event.action if event && action.nil?
-      action = :handle if action.nil?
+      # TODO: Breaks some tests... should it? Yes. Should it be disabled when testing? Yes.
+      # raise NoObserversError, "No observers configured for #{@key}" if @observers.empty?
 
       last_result = nil
 
-      @observers.each do |observer|
+      per_observer_per_action(action:, event:) do |observer, action|
         result = observer.trigger(action:, event:)
         last_result = result unless result.nil?
         yield if block_given?
@@ -33,26 +33,41 @@ module Observers
       last_result
     end
 
-    # @returns: The result of the first observer with a non-nil value.
+    # @returns: The result of the first observer and the first action with a non-nil value.
     def take(action: nil, event: nil)
-      empty_observers_callback
-
-      action = event.action if event && action.nil?
-      action = :handle if action.nil?
+      # TODO: Breaks some tests... should it? Yes. Should it be disabled when testing? Yes.
+      # raise NoObserversError, "No observers configured for #{@key}" if @observers.empty?
 
-      @observers.each do |observer|
+      per_observer_per_action(action:, event:) do |observer, action|
         result = observer.trigger(action:, event:)
         yield if block_given?
         return result unless result.nil?
       end
 
-      nil # This is a bad day for the take method, one of the worst.
+      # None of the observers returned a non-nil value.
+      nil
     end
 
     private
 
-    def empty_observers_callback
-      Observers.config.empty_observers_callback.call(@key) if Observers.config.empty_observers_callback && @observers.empty?
+    def per_observer_per_action(action:, event:)
+      action ||= event&.action
+
+      if action
+        @observers.each do |observer|
+          yield observer, action
+        end
+      elsif event&.actions
+        @observers.each do |observer|
+          event.actions.each do |action|
+            yield observer, action
+          end
+        end
+      else
+        @observers.each do |observer|
+          yield observer, :handle
+        end
+      end
     end
   end
 end

data/lib/models/observer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'observer_error'
+
 module Observers
   class Observer
     attr_reader :object, :action
@@ -12,21 +14,18 @@ module Observers
     def trigger(action:, event:)
       action = @action if @action
 
+      return unless @object.respond_to?(action)
+
       # Assumption that if method has params then that param is "event:".
       if event && @object.method(action).parameters.count > 0
         @object.send(action, **{ event: })
       else
         @object.send(action)
       end
-    rescue ArgumentError => e
-      type = @object.instance_of?(Class) ? @object : @object.class
-      method_type = @object.instance_of?(Class) ? '.' : '#'
-
-      raise ArgumentError, "#{type}##{action} has an 'event:' keyword argument but no event arg was sent" if event.nil?
-
-      # Events trigger events, so the error bubbles up to becomes the error message for the next rescue's error message:
-      # "RequestEvent sent to Rain::Router#handle -> StatusEvent sent to Error404Node.render -> unknown keyword: :props"
-      raise ArgumentError, "#{event.class} sent to #{type}#{method_type}#{action} -> #{e.message}"
+    rescue StandardError => e
+      # Events trigger events, so this error bubbles up to become the error for the next rescue:
+      # "RequestEvent -> Rain::Router#route_request -> StatusEvent -> Error404Node.render -> unknown keyword: :props"
+      raise ObserverError.new(e.message, object:, event:, action:, previous_error: e)
     end
   end
 end

data/lib/models/observer_error.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Observers
+  # Map the events and actions along the way when showing an exception.
+  # Any exceptions in this class itself will fail silently as they will error out into itself.
+  class ObserverError < StandardError
+    def initialize(message, object:, event:, action:, previous_error:)
+      super(message)
+
+      @event = event
+      @object = object
+      @action = action
+      @previous_error = previous_error
+    end
+
+    def link
+      class_type = @object.instance_of?(Class) ? @object : @object.class
+      method_type = @object.instance_of?(Class) ? '.' : '#'
+      "#{@event.class} -> #{class_type}#{method_type}#{@action}"
+    end
+
+    def to_s
+      chain = [link]
+      first_error = first_error(@previous_error, chain:)
+      error_location = first_error.backtrace.first
+
+      "#{chain.join(' -> ')} -> #{first_error.message}\n#{error_location}"
+    end
+
+    private
+
+    def first_error(error, chain:)
+      chain << error.link if error.respond_to?(:link)
+
+      return error unless error.respond_to?(:previous_error)
+
+      first_error(error.previous_error, chain:)
+    end
+  end
+end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Observers
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: observers
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - maedi
@@ -19,6 +19,7 @@ files:
 - lib/keys.rb
 - lib/models/key.rb
 - lib/models/observer.rb
+- lib/models/observer_error.rb
 - lib/observers.rb
 - lib/version.rb
 homepage: https://github.com/raindeer-rb/observers
@@ -40,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Observe objects of any kind
 test_files: []