observers 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1c16092762a682c96f1cc007988ec2406d3b2dd6ce91c1b793b2fbf4f95d628
-  data.tar.gz: 18045745a7cc775e61dd9afc1f46a80074565be6986a37ead5b30d49105a6e77
+  metadata.gz: 3803ec73448522b725c60b2929a3f3fe2fee1e87f102b5a75f8fadbebc2beec9
+  data.tar.gz: 9d4e91f3e4026c4fc813b338e8baf2b45164c46681e404e10b5a53c539302a60
 SHA512:
-  metadata.gz: 8c3eb3b00120bfcd498345c0f1ef44322212eacaa6856d794fb9e74044b7a26fa4a6502067cec87aaeff241b4835f5f5e0c048a80d59fe61e3dda277b84c03af
-  data.tar.gz: 843137754e96d5187b23f36fa72e2aa423cba6b9e0af82a99d3b84ef046bc7c2feb76fd3acfe0b3607ea55a6ef250d23ee0f90a211266bd551d5b2045211156f
+  metadata.gz: 64bec520fd5246a61892e71ec40609b1e5cdaf00ef4e1cf9c28c5f1e0c27e9a6e561f3d6db2e3b89bb596d8c4d867deb4aac8c18cba97a80085e5d7149f458be
+  data.tar.gz: bb87af0e748a370272c760b80236694228596a0d9e702d2636f8854122f72636b5607f28cec56b9bef483f449a79dd0e5d8c67b659586b6742d881a97f044445

data/lib/models/observer.rb

@@ -12,9 +12,12 @@ module Observers
 
     def trigger(action:, event:)
       action = @action if @action
-      event ? @observer.send(action, **{ event: event }) : @observer.send(action)
+      event ? @observer.send(action, **{ event: }) : @observer.send(action)
     rescue ArgumentError
       type = @observer.instance_of?(Class) ? @observer : @observer.class
+
+      raise ArgumentError, "#{type}##{action} has an 'event:' keyword argument but no event was sent" if event.nil?
+
       raise ArgumentError, "#{event.class} sent to #{type}##{action} but it has no 'event:' keyword argument"
     end
   end

data/lib/observables.rb

@@ -4,59 +4,45 @@ require_relative 'models/observable'
 
 module Observers
   class Observables
+    class MissingObservableError < StandardError; end
+
     class << self
       def observables
         @observables ||= {}
         @observables
       end
-
-      def reset
-        @observables = {}
-      end
+      alias all observables
 
       def upsert(key:)
         observables[key] = Observable.new(key:) if observables[key].nil?
         observables[key]
       end
 
+      def reset
+        @observables = {}
+      end
+
       def observe(key:, observer:)
         observable = observables[key] || upsert(key:)
         observable.add_observer(observer:)
       end
 
-      def trigger(actionable:, key:)
-        action, event = parse_actionable(actionable:)
+      # @return: The result of the last trigger with a non-nil value.
+      def trigger(key:, action:, event:)
+        action = event.action if event && action.nil?
+        action = :handle if action.nil?
 
-        observables[key].observers.each do |observer|
-          observer.trigger(action:, event:)
-        end
-
-        nil # The trigger method is boring and uneventful, it fires events and if it doesn't complain then all is okay.
-      end
+        observable = observables[key]
+        raise MissingObservableError, "Observable key '#{key}' not found" if observable.nil?
 
-      def take(actionable:, key:)
-        action, event = parse_actionable(actionable:)
+        last_result = nil
 
         observables[key].observers.each do |observer|
           result = observer.trigger(action:, event:)
-          return result unless result.nil?
-        end
-
-        nil # This is a bad day for the take method, one of the worst.
-      end
-
-      private
-
-      def parse_actionable(actionable:)
-        action = actionable
-        event = nil
-
-        if actionable.class.ancestors.any? { |ancestor| ancestor.to_s == 'Low::Event' }
-          event = actionable
-          action = event.action
+          last_result = result unless result.nil?
         end
 
-        [action, event]
+        last_result
       end
     end
   end

data/lib/observers.rb

@@ -4,23 +4,29 @@ require_relative 'observables'
 require_relative 'models/observer'
 
 module Observers
+  def self.included(klass)
+    klass.extend Observers
+  end
+
+  def observables
+    Observables.observables
+  end
+
   def observable(key = self)
     Observables.upsert(key:)
   end
 
   # TODO: Unit test order.
-  def observe(key, action = nil, order: Observables.observables.count)
-    observer = Observer.new(observer: self, action:, order:)
+  def observe(key, overridden_action: nil, order: Observables.observables.count)
+    observer = Observer.new(observer: self, action: overridden_action, order:)
     Observables.observe(key:, observer:)
   end
 
-  def trigger(actionable, key = nil)
-    Observables.trigger(actionable:, key: key || self)
+  # Returns the last observer with a non-nil return value.
+  def trigger(key = self, action: nil, event: nil)
+    # TODO: Parsing logic can be simplified/removed now that action and event args are separated.
+    Observables.trigger(key:, action:, event:)
   end
 
-  # Returns the first observer with a non-nil return value.
-  # One day it may use ractors and be concurrent, if we can freeze the args.
-  def take(actionable, key = nil)
-    Observables.take(actionable:, key: key || self)
-  end
+  # TODO: Provide a "pipe/port/take" method that uses ractors to be concurrent... if supplied with immutable Data?
 end

data/lib/version.rb

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

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: observers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - maedi
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: low_dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Observe events for objects of any kind
 email:
 - maediprichard@gmail.com