observers 0.9.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbb9116b5b3a86d777d4aca13b5c4c04214340596e1df83adebada4dd871bc43
-  data.tar.gz: 560fbbb9480ac2968036b8024e9362c12ea68994c77a587abc2432505ceeda7f
+  metadata.gz: c38971f478fd313e247a319a800bcc05ff9ebc7988c2667998f158d2fcc3ed9c
+  data.tar.gz: 3de19946713ee620c28a81b8ed4660c54d6f626a1f3fdec5b961d72864b4d228
 SHA512:
-  metadata.gz: 403fe656fda85237d897b4e82b84e9b770f352807ac5ef05a37f4c1d58784af7f43e5f22d6ab5999bdebeea831350757125f184870de45ad78330efc6fe07ace
-  data.tar.gz: '06680f408eaf15377c441fd995a7a3b05b3a41bcf6b8e3e3aa87dd06a6e65227f43a50b01c03193845d26d306e368b2ecfaec814af0cb8f4ba9a34386641af83'
+  metadata.gz: 4b874d0023082d05272169f7043664f366c956af07aac5c001fb851f38aaa8ffddb95015a42a1433f040d28f7afd5663f96db060c7d6d303e2a2bbf70cbf9125
+  data.tar.gz: 2736567734f313b0bc7308b9a6e92231f2628f2d97015b061fefb6075cce94f8ef0461dcdd0007dae2dcddeaceb2bb810f4676ed29f5eb9b8eb1c371710998fc

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
@@ -20,15 +22,10 @@ module Observers
       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 become the error message for the next rescue's error message:
-      # "RequestEvent sent to Rain::Router#route_request -> 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/observers.rb

@@ -37,8 +37,13 @@ module Observers
     end.new(key)
   end
 
-  def observe(key, action: nil)
-    Keys[key].observe(object: self, action:)
+  # Observe a key with "observe key, action: :action", or keys and their actions with "observe key => :action".
+  # Ruby passes "key => :action" as keyword arguments when the key isn't a symbol, so they arrive in key_actions.
+  def observe(key = nil, action: nil, **key_actions)
+    key_actions = key.is_a?(Hash) ? key : { key => action } unless key.nil?
+    raise ArgumentError, 'Missing key to observe' if key_actions.empty?
+
+    key_actions.each { |each_key, each_action| Keys[each_key].observe(object: self, action: each_action) }
   end
 
   def trigger(key: self, action: nil, event: nil)

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: observers
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.1.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