low_event 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf4bf7bbf94dbe27393a82dc61c8660b24bc62f55564e4448ed4c696b5809141
-  data.tar.gz: ac1225567c974ff857aad213e0f700330176d7fd2ee90f6336cc3aa739ba2790
+  metadata.gz: 7ce2e06fbf3ed01693a0ea9d8debd51bb06728cede50512fc2900aceea3cd34e
+  data.tar.gz: 1ec225183c4d31f9b8fccacff0aefc10ae47f83bbefced301d21e4af5d81ed7b
 SHA512:
-  metadata.gz: 0add64213a67957924c8af4259633fe3f0aa53b4f5d6ba69939292e2fd3d94f2dddb3d29e71b170ea053e57b07a0c3a208762ff9206a19fa9a664bfafa431b31
-  data.tar.gz: fb618e3d9cfab04ea382537631c1abffafbc153a24acd5c6124bf3ed1495572497a8432b68018bfa68f9ee93c966746196dc7adc6b5b2835afb3d1a9001765d9
+  metadata.gz: 5a35fa062bb378c0485cec1ab5713cbadfd93374628630342458d0570008ca43bf9638d1913312257c35a8204e6a8e4ee4964ada8cbbe4717435719e36487b42
+  data.tar.gz: 2135cae6a7b1d6fb4709f328aeec00e5d6d6da7b667707eda3e8af8b2fac968d2dc182c382ea9c3a48675a4062d9dc2276361604b9cfc3b0f8e62d57f5f069cf

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::Keys[@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

@@ -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,18 +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
 
-    ROOT_FIBER = Fiber.current
-
+    # The subclass will provide the key, usually "self.class".
     def initialize(key:, action: nil, children: [])
       @key = key
       @action = action
@@ -32,42 +35,34 @@ module Low
 
     def trigger
       event_tree = branch
-      key = Observers::Keys[@key] || raise(Observers::Keys::MissingKeyError)
+      key = Observers::Keys[@key]
       key.trigger(event: self) { restore_level(event_tree:) }
     end
 
     def take
       event_tree = branch
-      key = Observers::Keys[@key] || raise(Observers::Keys::MissingKeyError)
+      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
-      # 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 = 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
-
-    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,18 +1,16 @@
 # frozen_string_literal: true
 
-require 'low_dependency'
-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'
 
-LowDependency.provide('low.event.pool') do
+Providers.define('low.event.pool') do
   Low::Events::EventPool.new
 end
 

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

@@ -1,29 +1,49 @@
 # 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
-      BUFFER_SIZE = 100.freeze
+      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
-        @pool[stream_id] || @pool.add(stream_id, EventTree.new)
+      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 stream_id
-        Fiber.current
+      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

data/lib/pool/event_tree.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
+require 'observers'
+require_relative 'branch_event'
+
 module Low
   module Events
     class EventTree
-      attr_reader :root_event, :sequence
+      include Observers
+
+      attr_reader :request_id, :root_event, :sequence
       attr_accessor :current_event
 
-      def initialize
+      def initialize(request_id: nil)
+        @request_id = request_id
         @root_event = nil
         @current_event = nil
-
         @sequence = []
       end
 
@@ -22,6 +27,8 @@ module Low
         else
           @current_event.children << event
         end
+
+        trigger action: :branch, event: BranchEvent.new(event_tree: self, event:)
       end
     end
   end

data/lib/support/pool_hash.rb

@@ -11,7 +11,11 @@ module Low
 
       def add(key, value)
         # Prune the hash when a new item added.
-        shift if size >= @max_size && !key?(key)
+        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

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Low
-  EVENT_VERSION = '0.4.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.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - maedi
@@ -10,35 +10,35 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: low_dependency
+  name: low_type
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: low_type
+  name: observers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: observers
+  name: protocol-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: protocol-http
+  name: providers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -72,13 +72,16 @@ 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
 - lib/pool/event_tree.rb
 - lib/support/pool_hash.rb