observers 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82c40c0a93bc5ffefe86c3c27685e18fd699a7188c8ffc10899386974e48ac3c
-  data.tar.gz: 70992908f64214fc993e2bad241c7bb81cccbf6b07d4a895e79a8bf173299b05
+  metadata.gz: 701e08478d6d96ff9be87ea056510e4dcf4995bc779c726d263dc9ba7d5803be
+  data.tar.gz: 1d9a10983efabeb4d7ac66c7d6df2f4d4204b947b85836369fdc93e9d91ffc57
 SHA512:
-  metadata.gz: d75da6da3eb93b6e8e3e8fdd9e343560d96bfec7828fe38822945d0927edddd72e80a93e15bb8421629aa2f0d64e6f0012dd242de27204ecf9bc8783ece184b3
-  data.tar.gz: 58df26a6e12b767cbd9ffc46f3eda991a04ab85791c714e61fabd92b98e6e4ec64d537d17f57358cf2974516dbf15375f9320eba4dd87a6fa3fc97c5197fa7da
+  metadata.gz: 2b1a653fa0e7cc33a70d121620c67141061618dc270cd6793b713b04822fe2ed32f0934c30b30079f190d8c3acfeb7aa90df086a4fe66fd3c09fc1e12adaa231
+  data.tar.gz: bcb0708e1be9ec611a28b887a3d18b3cba0798a05d4b8c9c3a502694aa3770e9a06f6cc1767d83aaa085900de6bb58d46e557edfc0dc9b80bd7ad68a7ac731af

data/lib/models/observer.rb

@@ -4,12 +4,14 @@ module Observers
   class Observer
     attr_reader :order
 
-    def initialize(observer:, order:)
+    def initialize(observer:, action:, order:)
       @observer = observer
+      @action = action
       @order = order
     end
 
     def trigger(action:, event:)
+      action = @action if @action
       event ? @observer.send(action, **{ event: event }) : @observer.send(action)
     rescue ArgumentError
       type = @observer.instance_of?(Class) ? @observer : @observer.class

data/lib/observables.rb

@@ -4,66 +4,58 @@ 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(*args, key:)
-        key, action, event = parse_args(*args, key:)
+      # @return: The last result of the trigger.
+      def trigger(actionable:, key:)
+        action, event = parse_actionable(actionable:)
 
-        observables[key].observers.each do |observer|
-          observer.trigger(action:, event:)
-        end
+        observable = observables[key]
+        raise MissingObservableError, "Observable key '#{key}' not found" if observable.nil?
 
-        nil # The trigger method is boring and uneventful, it fires events and if it doesn't complain then all is okay.
-      end
-
-      def take(*args, key:)
-        key, action, event = parse_args(*args, key:)
+        last_result = nil
 
         observables[key].observers.each do |observer|
           result = observer.trigger(action:, event:)
-          return result unless result.nil?
+          last_result = result unless result.nil?
         end
 
-        nil # This is a bad day for the take method, one of the worst.
+        last_result
       end
 
       private
 
-      def parse_args(*args, key:)
-        action = nil
+      def parse_actionable(actionable:)
+        action = actionable
         event = nil
 
-        case args.count
-        when 1
-          action = args.first
-        when 2
-          key, action = args
-        end
-
-        if action.respond_to?(:action)
-          event = action
+        if actionable.class.ancestors.any? { |ancestor| ancestor.to_s == 'Low::Event' }
+          event = actionable
           action = event.action
         end
 
-        [key, action, event]
+        [action, event]
       end
     end
   end

data/lib/observers.rb

@@ -4,23 +4,31 @@ 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: Test order.
-  def observe(key, order: Observables.observables.count)
-    observer = Observer.new(observer: self, order:)
+  # TODO: Unit test 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(*args)
-    Observables.trigger(*args, key: self)
-  end
+  # Returns the last observer with a non-nil return value.
+  def trigger(key = self, action: nil, event: nil)
+    raise ArgumentError, 'Action or event required' if action.nil? && event.nil?
 
-  # 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(*args)
-    Observables.take(*args, key: self)
+    # TODO: Parsing logic can be simplified/removed now that action and event args are separated.
+    Observables.trigger(actionable: action || event, key:)
   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.1.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: observers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 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