observers 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ab0c93bff9df65a8fcf5bf39a6196ac9f4be51bf823dfc7eeabebe0d2ec21e8
-  data.tar.gz: ec0de69288f9ea75794b5027d4eb1df90810c399310fcc43dfac873ae6accee0
+  metadata.gz: c6d833421a632a5d73e0b3bcd73d227881b67cfa5384bb386632b04607e3745d
+  data.tar.gz: 458dbadf1111fa9cdbeef5d65cce5bcd8b6da3ea355c4178ced79e0c48824f50
 SHA512:
-  metadata.gz: d09f8cd88c509452aa3d9627f3326a7fb2ba3120a938fa8b32b397f64908bb668f52d5750527f96d70ee140071c220693e7f916908dfac09a2e0b1521e624aa1
-  data.tar.gz: 4ac4a3bddaf49ae0e000fd44402e3c9cca88e3078dab7a7e9b02046d6cf4246c8a9ece9c8dcc8b5d5795c5fe531991478383d6db2739cbe3dc7ef3aa03069149
+  metadata.gz: 5e1b8ad7ac1007633742d060524135d9013972dd973676a6f89a4c831668f9a590f0106397c315e727758b6e8e30ce344529750fd33d84f3305f7bbb4c805556
+  data.tar.gz: ec92959757150e34c161acd7152bdd4e82501a4dc3f0e4b0ffd79cd321fc196c81ce3d148040bff9121ec651ed351d215f636ac2e3042768032dfe225fa9c241

data/lib/keys.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'models/key'
+
+module Observers
+  class Keys
+    class MissingKeyError < StandardError; end
+
+    class << self
+      def keys
+        @keys ||= {}
+        @keys
+      end
+
+      def fetch(key)
+        # TODO: Log instead per configuration, much better to fail silently sometimes!
+        keys[key] || raise(MissingKeyError, "Key key '#{key}' not found")
+      end
+
+      def [](key)
+        keys[key] || upsert(key:)
+      end
+
+      def upsert(key:)
+        keys[key] = Key.new if keys[key].nil?
+        keys[key]
+      end
+
+      def reset
+        @keys = {}
+      end
+    end
+  end
+end

data/lib/models/{observable.rb → key.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Observers
-  class Observable
+  class Key
     attr_reader :observers
 
     def initialize
@@ -9,11 +9,13 @@ 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?
+      # 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:, event:)
+    def trigger(action: nil, event:)
       action = event.action if event && action.nil?
       action = :handle if action.nil?
 
@@ -22,18 +24,20 @@ module Observers
       @observers.each do |observer|
         result = observer.trigger(action:, event:)
         last_result = result unless result.nil?
+        yield if block_given?
       end
 
       last_result
     end
 
     # @returns: The result of the first observer with a non-nil value.
-    def take(action:, event:)
+    def take(action: nil, event:)
       action = event.action if event && action.nil?
       action = :handle if action.nil?
 
       @observers.each do |observer|
         result = observer.trigger(action:, event:)
+        yield if block_given?
         return result unless result.nil?
       end
 

data/lib/observers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'observables'
+require_relative 'keys'
 require_relative 'models/observer'
 
 module Observers
@@ -10,35 +10,35 @@ module Observers
     end
   end
 
-  # Add an observer on the observable side.
+  # Add an observer on the key side.
   def observers(key = self)
     Struct.new(:key) do
       def push(object, action: nil)
-        Observables[key].observe(object:, action:)
+        Keys[key].observe(object:, action:)
       end
       alias :<< :push
 
       def count
-        Observables[key].observers.count
+        Keys[key].observers.count
       end
     end.new(key)
   end
 
   # Add an observer on the observer side.
   def observe(key, action: nil)
-    Observables[key].observe(object: self, action:)
+    Keys[key].observe(object: self, action:)
   end
 
-  def trigger(key = self, action: nil, event: nil)
-    Observables.fetch(key).trigger(action:, event:)
+  def trigger(key: self, action: nil, event: nil)
+    Keys.fetch(key).trigger(action:, event:)
   end
 
-  def take(key = self, action: nil, event: nil)
-    Observables.fetch(key).take(action:, event:)
+  def take(key: self, action: nil, event: nil)
+    Keys.fetch(key).take(action:, event:)
   end
 
   # TODO: Provide a "pipe/port/take" method that uses ractors to be concurrent... if supplied with immutable Data?
 end
 
 # For quick debugging, not official API.
-OOO = Observers::Observables.observables unless defined?(OOO)
+OKK = Observers::Keys.keys unless defined?(OKK)

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: observers
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - maedi
@@ -30,9 +30,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/models/observable.rb
+- lib/keys.rb
+- lib/models/key.rb
 - lib/models/observer.rb
-- lib/observables.rb
 - lib/observers.rb
 - lib/version.rb
 homepage: https://github.com/maedi/observers
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Observe objects of any kind
 test_files: []

data/lib/observables.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'models/observable'
-
-module Observers
-  class Observables
-    class MissingKeyError < StandardError; end
-
-    class << self
-      def observables
-        @observables ||= {}
-        @observables
-      end
-
-      def fetch(key)
-        # TODO: Log instead per configuration, much better to fail silently sometimes!
-        observables[key] || raise(MissingKeyError, "Observable key '#{key}' not found")
-      end
-
-      def [](key)
-        observables[key] || upsert(key:)
-      end
-
-      def upsert(key:)
-        observables[key] = Observable.new if observables[key].nil?
-        observables[key]
-      end
-
-      def reset
-        @observables = {}
-      end
-    end
-  end
-end