low_event 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c63adedbf6028a0a6c3e15620d5ea736ba53961d318b22ab44d6bc5d75b853b3
-  data.tar.gz: 7956e7c903e68097c74d5eb41a706b8948ed0b98dea333748b3caec15786e890
+  metadata.gz: 7ce2e06fbf3ed01693a0ea9d8debd51bb06728cede50512fc2900aceea3cd34e
+  data.tar.gz: 1ec225183c4d31f9b8fccacff0aefc10ae47f83bbefced301d21e4af5d81ed7b
 SHA512:
-  metadata.gz: 9c801ef8056b37fea3559da0c9f2729b3c955bf08fd7b430691ea66504a98061d890754d6d1eff7be2173e4ee1a83913eec151902ca2bce4f64da11b6da8e3a4
-  data.tar.gz: 7c801efafc85f09105f91fc3961988304b6c3646f01a30d45cceed0236bf5e20750f91d03cae4958d209a90269f254800d21bbfe55170f3bfe03a419ea32334b
+  metadata.gz: 5a35fa062bb378c0485cec1ab5713cbadfd93374628630342458d0570008ca43bf9638d1913312257c35a8204e6a8e4ee4964ada8cbbe4717435719e36487b42
+  data.tar.gz: 2135cae6a7b1d6fb4709f328aeec00e5d6d6da7b667707eda3e8af8b2fac968d2dc182c382ea9c3a48675a4062d9dc2276361604b9cfc3b0f8e62d57f5f069cf

data/lib/events/hidden_event.rb

@@ -18,7 +18,7 @@ module Low
 
       def trigger
         event_tree = branch
-        key = Observers[@key]
+        key = Observers::Keys[@key]
         key.trigger(event: self) { restore_level(event_tree:) }
       end
 

data/lib/events/request_event.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'event'
+require_relative '../interfaces/event'
 
 module Low
   module Events

data/lib/events/response_event.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'protocol/http'
-require_relative 'event'
+require_relative '../interfaces/event'
 
 module Low
   module Events

data/lib/events/status_event.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'event'
+require_relative '../interfaces/event'
 
 module Low
   module Events

data/lib/interfaces/definable.rb

@@ -0,0 +1,15 @@
+module Low
+  module Events
+    module Definable
+      def define(key = self)
+        yield observers(key)
+      end
+
+      class << self
+        def included(klass)
+          klass.extend Definable
+        end
+      end
+    end
+  end
+end

data/lib/{events → interfaces}/event.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'low_type'
 require 'observers'
+require_relative 'definable'
 require_relative '../support/value_object'
 
 module Low
@@ -11,16 +13,19 @@ module Low
   # The result of the previous event is made available to the next event. [UNRELEASED]
   #
   # Integrations:
-  # - Observers for observer pattern via an event-centric API
+  # - Observers for observer pattern which we wrap in an event-centric API
   # - EventPool for a tree of events and their child events
   # - LowState for state machines to trigger multiple actions [UNLRELEASED]
   class Event
     include LowType
+    include Observers
+    include Events::Definable
     include Support::ValueObject
 
     attr_reader :key, :action, :created_at
     attr_accessor :children
 
+    # The subclass will provide the key, usually "self.class".
     def initialize(key:, action: nil, children: [])
       @key = key
       @action = action
@@ -30,16 +35,25 @@ module Low
 
     def trigger
       event_tree = branch
-      key = Observers[@key]
+      key = Observers::Keys[@key]
       key.trigger(event: self) { restore_level(event_tree:) }
     end
 
     def take
       event_tree = branch
-      key = Observers[@key]
+      key = Observers::Keys[@key]
       key.take(event: self) { restore_level(event_tree:) }
     end
 
+    class << self
+      def trigger(**kwargs) = new(**kwargs).trigger
+      def take(**kwargs) = new(**kwargs).take
+
+      def inherited(child)
+        child.include LowType
+      end
+    end
+
     private
 
     def branch
@@ -50,19 +64,5 @@ module Low
     def restore_level(event_tree:)
       event_tree.current_event = self if event_tree.respond_to?(:current_event)
     end
-
-    class << self
-      def trigger(**kwargs)
-        new(**kwargs).trigger
-      end
-
-      def take(**kwargs)
-        new(**kwargs).take
-      end
-
-      def inherited(child)
-        child.include LowType
-      end
-    end
   end
 end

data/lib/low_event.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
-require 'low_type'
-require 'observers'
 require 'providers'
 
-require_relative 'events/event'
 require_relative 'events/render_event'
 require_relative 'events/request_event'
 require_relative 'events/response_event'
 require_relative 'events/status_event'
 require_relative 'factories/response_factory' # TODO: Find out who's using this and require it there.
+require_relative 'interfaces/event'
 require_relative 'pool/event_pool'
 
 Providers.define('low.event.pool') do

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Low
-  EVENT_VERSION = '0.5.0'
+  EVENT_VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low_event
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - maedi
@@ -72,13 +72,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/events/event.rb
 - lib/events/hidden_event.rb
 - lib/events/render_event.rb
 - lib/events/request_event.rb
 - lib/events/response_event.rb
 - lib/events/status_event.rb
 - lib/factories/response_factory.rb
+- lib/interfaces/definable.rb
+- lib/interfaces/event.rb
 - lib/low_event.rb
 - lib/pool/branch_event.rb
 - lib/pool/event_pool.rb