low_event 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2c66b94c35dc2723cd5d9a619044ed9484eeb100111c58d4cfcdab85564935b
-  data.tar.gz: b0a7e10cc9c4a00f1430da97fa31f912594fb055a9c47f9013ee19a315de42eb
+  metadata.gz: cf4bf7bbf94dbe27393a82dc61c8660b24bc62f55564e4448ed4c696b5809141
+  data.tar.gz: ac1225567c974ff857aad213e0f700330176d7fd2ee90f6336cc3aa739ba2790
 SHA512:
-  metadata.gz: 6072b61cd206ce639447138129c471043afaa110df08d927feadcdaac02ca80266dc44c54e5affd5a87a14ab94200577e81ee9d753b2bae42a6a0eb482041421
-  data.tar.gz: daed9d381a46b084eb6a09787089d5be89103a714c2e62767fd3046c2a3fd7e1341b304debf44807144b1e1ebf968f2261d5ac3ccf253c6a0fb81679ecee055d
+  metadata.gz: 0add64213a67957924c8af4259633fe3f0aa53b4f5d6ba69939292e2fd3d94f2dddb3d29e71b170ea053e57b07a0c3a208762ff9206a19fa9a664bfafa431b31
+  data.tar.gz: fb618e3d9cfab04ea382537631c1abffafbc153a24acd5c6124bf3ed1495572497a8432b68018bfa68f9ee93c966746196dc7adc6b5b2835afb3d1a9001765d9

data/lib/events/event.rb

@@ -1,26 +1,68 @@
 # frozen_string_literal: true
 
+require 'observers'
+require_relative '../support/value_object'
+
 module Low
+  # An event represents what is currently happening in your application.
+  #
+  # Events are mutable in most cases (except for RenderEvent). They are action-driven, representing inputs and outputs
+  # that are currently happening in a linear pipeline-like flow. They are present-tense and one-to-many with one return value.
+  # The result of the previous event is made available to the next event. [UNRELEASED]
+  #
+  # Integrations:
+  # - Observers for observer pattern via 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 Support::ValueObject
+
+    attr_reader :key, :action, :created_at
+    attr_accessor :children
 
-    attr_reader :action
+    ROOT_FIBER = Fiber.current
 
-    def initialize(action: nil)
+    def initialize(key:, action: nil, children: [])
+      @key = key
       @action = action
+      @children = children
+      @created_at = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
+    end
+
+    def trigger
+      event_tree = branch
+      key = Observers::Keys[@key] || raise(Observers::Keys::MissingKeyError)
+      key.trigger(event: self) { restore_level(event_tree:) }
     end
 
-    # Consider LowEvent a value object.
-    def ==(other) = other.class == self.class
-    def eql?(other) = self == other
-    def hash = [self.class].hash
+    def take
+      event_tree = branch
+      key = Observers::Keys[@key] || raise(Observers::Keys::MissingKeyError)
+      key.take(event: self) { restore_level(event_tree:) }
+    end
+
+    private
+
+    def branch
+      # Don't create a singular ever-growing stream tree.
+      return nil if ROOT_FIBER == Fiber.current
+
+      event_tree = Low::Providers['low.event.pool'].current_event_tree
+      event_tree.branch(event: self)
+    end
+
+    def restore_level(event_tree:)
+      event_tree.current_event = self if event_tree.respond_to?(:current_event)
+    end
 
-    # Integrate with Observers, providing a self-contained API via an event's class.
     class << self
       def trigger(**kwargs)
-        observable = Observers::Observables[self] || raise(Observers::Observables::MissingKeyError)
-        event = new(**kwargs)
-        observable.trigger action: event.action, event:
+        new(**kwargs).trigger
+      end
+
+      def take(**kwargs)
+        new(**kwargs).take
       end
 
       def inherited(child)

data/lib/events/render_event.rb

@@ -2,8 +2,9 @@
 
 module Low
   module Events
-    RenderEvent = Data.define(:action, :render) do
-      def initialize(action: :render, render: nil)
+    RenderEvent = Data.define(:action, :props) do
+      # TODO: Duplicate props when used in a parallelized situation (antlers: "<{ :parallelize }>")
+      def initialize(action: :render, props: {})
         super
       end
     end

data/lib/events/request_event.rb

@@ -8,7 +8,7 @@ module Low
       attr_reader :request
 
       def initialize(request:, action: :handle)
-        super(action:)
+        super(key: self.class, action:)
 
         @request = request
       end

data/lib/events/status_event.rb

@@ -7,8 +7,8 @@ module Low
     class StatusEvent < Event
       attr_reader :status, :request
 
-      def initialize(status:, request:)
-        super()
+      def initialize(status:, request:, action: :render)
+        super(key: status, action:)
 
         @status = status
         @request = request

data/lib/low_event.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'low_dependency'
 require 'low_type'
 require 'observers'
 
@@ -8,6 +9,11 @@ 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'
+require_relative 'factories/response_factory' # TODO: Find out who's using this and require it there.
+require_relative 'pool/event_pool'
+
+LowDependency.provide('low.event.pool') do
+  Low::Events::EventPool.new
+end
 
 LowEvent = Low::Event

data/lib/pool/event_pool.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'event_tree'
+require_relative '../support/pool_hash'
+
+module Low
+  module Events
+    class EventPool
+      BUFFER_SIZE = 100.freeze
+
+      def initialize
+        @pool = Support::PoolHash.new(BUFFER_SIZE)
+      end
+
+      def current_event_tree
+        @pool[stream_id] || @pool.add(stream_id, EventTree.new)
+      end
+      
+      def event_trees
+        @pool
+      end
+
+      private
+
+      def stream_id
+        Fiber.current
+      end
+    end
+  end
+end

data/lib/pool/event_tree.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Low
+  module Events
+    class EventTree
+      attr_reader :root_event, :sequence
+      attr_accessor :current_event
+
+      def initialize
+        @root_event = nil
+        @current_event = nil
+
+        @sequence = []
+      end
+
+      def branch(event:)
+        @sequence << event
+
+        if @root_event.nil?
+          @root_event = event
+          @current_event = event
+        else
+          @current_event.children << event
+        end
+      end
+    end
+  end
+end

data/lib/support/pool_hash.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Low
+  module Support
+    class PoolHash < Hash
+      def initialize(max_size)
+        @max_size = max_size
+
+        super()
+      end
+
+      def add(key, value)
+        # Prune the hash when a new item added.
+        shift if size >= @max_size && !key?(key)
+        self[key] = value
+      end
+    end
+  end
+end

data/lib/support/value_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Low
+  module Support
+    module ValueObject
+      def ==(other) = other.class == self.class
+      def eql?(other) = self == other
+      def hash = [self.class].hash
+    end
+  end
+end

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low_event
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - maedi
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 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'
 - !ruby/object:Gem::Dependency
   name: low_type
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +79,10 @@ files:
 - lib/events/status_event.rb
 - lib/factories/response_factory.rb
 - lib/low_event.rb
+- lib/pool/event_pool.rb
+- lib/pool/event_tree.rb
+- lib/support/pool_hash.rb
+- lib/support/value_object.rb
 - lib/version.rb
 homepage: https://github.com/low-rb/low_event
 licenses: []
@@ -85,7 +103,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: Observable events
 test_files: []