low_event 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52951b7a6e2b9553ac992c304630c0754e5e812c1bda2d90d80e6c23c3f25efe
-  data.tar.gz: 5af40c08e8c34a264b3459bc404aa0e4da972449b4000eb92e59272e8c9684b4
+  metadata.gz: c63adedbf6028a0a6c3e15620d5ea736ba53961d318b22ab44d6bc5d75b853b3
+  data.tar.gz: 7956e7c903e68097c74d5eb41a706b8948ed0b98dea333748b3caec15786e890
 SHA512:
-  metadata.gz: 0b4ef4e0f8b5f8cb435ef3185b7ccc14c468625ac7bee5ba6f3c4009778bbef6f5af1ce020210aed8f34770998c0588cbd8a5c3a496761d4653870e7ec3c917a
-  data.tar.gz: dd046cf53a1d39449e9990d899788ce618de3262d75b05dae8fb5d9957d9eab0ad9a8bafc036778a963d989c11f244ddf5a94210aecc4e8ca2387aa9903c89f5
+  metadata.gz: 9c801ef8056b37fea3559da0c9f2729b3c955bf08fd7b430691ea66504a98061d890754d6d1eff7be2173e4ee1a83913eec151902ca2bce4f64da11b6da8e3a4
+  data.tar.gz: 7c801efafc85f09105f91fc3961988304b6c3646f01a30d45cceed0236bf5e20750f91d03cae4958d209a90269f254800d21bbfe55170f3bfe03a419ea32334b

data/lib/events/event.rb

@@ -1,26 +1,63 @@
 # 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 :action
+    attr_reader :key, :action, :created_at
+    attr_accessor :children
 
-    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[@key]
+      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[@key]
+      key.take(event: self) { restore_level(event_tree:) }
+    end
+
+    private
+
+    def branch
+      event_tree = Providers['low.event.pool'].current_event_tree(event: self)
+      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/hidden_event.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'low_type'
+
+module Low
+  module Events
+    # An event that happens on event tree branching and isn't added to the event tree/sequence.
+    class HiddenEvent
+      include LowType
+
+      attr_reader :key, :action, :created_at
+
+      def initialize(key:, action: nil)
+        @key = key
+        @action = action
+        @created_at = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
+      end
+
+      def trigger
+        event_tree = branch
+        key = Observers[@key]
+        key.trigger(event: self) { restore_level(event_tree:) }
+      end
+
+      class << self
+        def trigger(**kwargs)
+          new(**kwargs).trigger
+        end
+
+        def inherited(child)
+          child.include LowType
+        end
+      end
+    end
+  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

@@ -2,12 +2,18 @@
 
 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'
+require_relative 'factories/response_factory' # TODO: Find out who's using this and require it there.
+require_relative 'pool/event_pool'
+
+Providers.define('low.event.pool') do
+  Low::Events::EventPool.new
+end
 
 LowEvent = Low::Event

data/lib/pool/branch_event.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../events/hidden_event'
+
+module Low
+  module Events
+    class BranchEvent < HiddenEvent
+      attr_reader :event_tree, :event
+
+      def initialize(event_tree:, event:)
+        super(key: BranchEvent, action: :branch)
+
+        @event_tree = event_tree
+        @event = event
+      end
+    end
+  end
+end

data/lib/pool/event_pool.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'observers'
+
+require_relative '../events/request_event'
+require_relative 'event_tree'
+require_relative '../support/pool_hash'
+
+module Low
+  module Events
+    class EventPool
+      include Observers
+
+      BUFFER_SIZE = 100
+
+      def initialize
+        @pool = Support::PoolHash.new(BUFFER_SIZE)
+        @request_counts = Support::PoolHash.new(BUFFER_SIZE)
+      end
+
+      def current_event_tree(event:)
+        request_id = request_id(event:)
+
+        return @pool[request_id] if @pool[request_id]
+
+        event_tree = @pool.add(request_id, EventTree.new(request_id:))
+        trigger action: :new_event_tree, event: event_tree
+
+        event_tree
+      end
+
+      def event_trees
+        @pool
+      end
+
+      private
+
+      def request_id(event:)
+        fiber_id = Fiber.current.object_id
+        increment_request_counts(fiber_id:) if event.is_a?(RequestEvent)
+        "#{fiber_id}-#{@request_counts[fiber_id]}"
+      end
+
+      def increment_request_counts(fiber_id:)
+        @request_counts[fiber_id] ||= 0
+        @request_counts[fiber_id] += 1
+      end
+    end
+  end
+end

data/lib/pool/event_tree.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'observers'
+require_relative 'branch_event'
+
+module Low
+  module Events
+    class EventTree
+      include Observers
+
+      attr_reader :request_id, :root_event, :sequence
+      attr_accessor :current_event
+
+      def initialize(request_id: nil)
+        @request_id = request_id
+        @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
+
+        trigger action: :branch, event: BranchEvent.new(event_tree: self, event:)
+      end
+    end
+  end
+end

data/lib/support/pool_hash.rb

@@ -0,0 +1,23 @@
+# 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.
+        if size >= @max_size && !key?(key)
+          # TODO: Notify event pool that item was removed.
+          _old_key, _old_value = shift
+        end
+
+        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.1'
+  EVENT_VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low_event
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - maedi
@@ -51,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: providers
+  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: Events and observers for event-driven applications
 email:
 - maediprichard@gmail.com
@@ -59,12 +73,18 @@ 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/low_event.rb
+- lib/pool/branch_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 +105,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: []