evt-wait 2.0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bca2702e59c02ee267536fcdef906db0bb76d5c2eddc64abbd6cbec0f0057731
+  data.tar.gz: 2b571bae744dad9731a0c90b35e417199603d3d29c7dcde17728b8fb2c6bdada
+SHA512:
+  metadata.gz: bc83aa97f8703d2f68fae17bec1d99801df345d9743d57cb88e46062fe77f24fb805f05a394a3c8cc819ec83f618d13972a095477398904552cdabb5d2a86b98
+  data.tar.gz: 8ec8d89999fc8816510af933c73bdd5384a78bb91252bd1da0581ac877f65dbf9bb5c77b50a427a6a255b6de30f83d364e185f565859c08cbed19efa1119d4d9

data/lib/wait/controls/time.rb

@@ -0,0 +1,5 @@
+class Wait
+  module Controls
+    Time = Clock::Controls::Time
+  end
+end

data/lib/wait/controls.rb

@@ -0,0 +1,3 @@
+require 'clock/controls'
+
+require 'wait/controls/time'

data/lib/wait/log.rb

@@ -0,0 +1,9 @@
+class Wait
+  class Log < ::Log
+    def tag!(tags)
+      tags << :until
+      tags << :library
+      tags << :verbose
+    end
+  end
+end

data/lib/wait/wait.rb

@@ -0,0 +1,169 @@
+class Wait
+  Error = Class.new(RuntimeError)
+  NoBlockError = Class.new(Error)
+  TimeoutError = Class.new(Error)
+  ResultTypeError = Class.new(Error)
+
+  include Dependency
+  include Log::Dependency
+
+  dependency :clock, Clock::UTC
+  dependency :telemetry, Telemetry
+
+  def self.build
+    instance = new
+    instance.configure
+    instance
+  end
+
+  def self.configure(receiver, attr_name: nil)
+    attr_name ||= :wait
+    instance = build
+    receiver.public_send("#{attr_name}=", instance)
+  end
+
+  def configure
+    Clock::UTC.configure(self)
+    ::Telemetry.configure(self)
+  end
+
+  def self.call(interval_milliseconds: nil, timeout_milliseconds: nil, &condition)
+    instance = build
+    instance.call(interval_milliseconds: interval_milliseconds, timeout_milliseconds: timeout_milliseconds, &condition)
+  end
+
+  def call(interval_milliseconds: nil, timeout_milliseconds: nil, &condition)
+    interval_milliseconds ||= Defaults.interval_milliseconds
+
+    if condition.nil?
+      raise NoBlockError, "Wait must be actuated with a block"
+    end
+
+    stop_time = nil
+    stop_time_iso8601 = nil
+    if not timeout_milliseconds.nil?
+      stop_time = clock.now + (timeout_milliseconds.to_f / 1000.0)
+      stop_time_iso8601 = clock.iso8601(stop_time, precision: 5)
+    end
+
+    logger.trace { "Cycling (Interval Milliseconds: #{interval_milliseconds.inspect}, Timeout Milliseconds: #{timeout_milliseconds.inspect}, Stop Time: #{stop_time_iso8601.inspect})" }
+
+    cycle = -1
+    result = nil
+    loop do
+      cycle += 1
+      telemetry.record(:cycle, cycle)
+
+      result, elapsed_milliseconds = evaluate_condition(cycle, &condition)
+
+      if result.nil?
+        result = false
+      end
+
+      if not (result.is_a?(TrueClass) || result.is_a?(FalseClass))
+        raise ResultTypeError, "The block result must be boolean (Result: #{result.inspect})"
+      end
+
+      if result == true
+        logger.debug { "Cycle condition is met (Cycle: #{cycle})" }
+        telemetry.record(:condition_satisfied)
+        break
+      end
+
+      delay(interval_milliseconds, elapsed_milliseconds)
+
+      if !timeout_milliseconds.nil?
+        now = clock.now
+        if now >= stop_time
+          logger.debug { "Timeout has lapsed (Cycle: #{cycle}, Stop Time: #{stop_time_iso8601}, Timeout Milliseconds: #{timeout_milliseconds.inspect})" }
+          telemetry.record(:timed_out, now)
+          break
+        end
+      end
+    end
+
+    logger.debug { "Cycled (Cycles: #{cycle + 1}, Interval Milliseconds: #{interval_milliseconds.inspect}, Timeout Milliseconds: #{timeout_milliseconds.inspect}, Stop Time: #{stop_time_iso8601})" }
+
+    cycle_count = cycle + 1
+
+    return cycle_count
+  end
+
+  def evaluate_condition(cycle, &condition)
+    condition_start_time = clock.now
+
+    logger.trace { "Evaluating condition (Cycle: #{cycle}, Start Time: #{clock.iso8601(condition_start_time, precision: 5)})" }
+
+    result = condition.call(cycle)
+
+    condition_end_time = clock.now
+    elapsed_milliseconds = clock.elapsed_milliseconds(condition_start_time, condition_end_time)
+
+    logger.debug { "Evaluated condition (Cycle: #{cycle}, Elapsed Milliseconds: #{elapsed_milliseconds}, Start Time: #{clock.iso8601(condition_start_time, precision: 5)}, End Time: #{clock.iso8601(condition_end_time, precision: 5)})" }
+
+    [result, elapsed_milliseconds]
+  end
+
+  def delay(interval_milliseconds, elapsed_milliseconds)
+    delay_milliseconds = interval_milliseconds - elapsed_milliseconds
+
+    logger.trace { "Delaying (Delay Milliseconds: #{delay_milliseconds}, Interval Milliseconds: #{interval_milliseconds}, Elapsed Milliseconds: #{elapsed_milliseconds})" }
+
+    if delay_milliseconds <= 0
+      logger.debug { "Elapsed time exceeds or equals interval. Not delayed. (Delay Milliseconds: #{delay_milliseconds}, Interval Milliseconds: #{interval_milliseconds}, Elapsed Milliseconds: #{elapsed_milliseconds})" }
+      return
+    end
+
+    delay_seconds = (delay_milliseconds.to_f / 1000.0)
+
+    sleep delay_seconds
+
+    telemetry.record(:delayed, delay_milliseconds)
+
+    logger.debug { "Finished delaying (Delay Milliseconds: #{delay_milliseconds}, Interval Milliseconds: #{interval_milliseconds}, Elapsed Milliseconds: #{elapsed_milliseconds})" }
+  end
+
+  def self.register_telemetry_sink(cycle)
+    sink = Telemetry.sink
+    cycle.telemetry.register(sink)
+    sink
+  end
+
+  module Defaults
+    def self.interval_milliseconds
+      0
+    end
+  end
+
+  module Telemetry
+    class Sink
+      include ::Telemetry::Sink
+
+      record :cycle
+      record :condition_satisfied
+      record :delayed
+      record :timed_out
+    end
+
+    def self.sink
+      Sink.new
+    end
+  end
+
+  module Substitute
+    def self.build
+      instance = Wait.build
+
+      sink = Wait.register_telemetry_sink(instance)
+      instance.telemetry_sink = sink
+
+      instance.configure
+
+      instance
+    end
+
+    class Wait < ::Wait
+      attr_accessor :telemetry_sink
+    end
+  end
+end

data/lib/wait.rb

@@ -0,0 +1,6 @@
+require 'log'
+require 'telemetry'
+require 'clock'
+
+require 'wait/log'
+require 'wait/wait'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: evt-wait
+version: !ruby/object:Gem::Version
+  version: 2.0.1.1
+platform: ruby
+authors:
+- The Eventide Project
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evt-log
+  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: evt-telemetry
+  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: evt-clock
+  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: test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/wait.rb
+- lib/wait/controls.rb
+- lib/wait/controls/time.rb
+- lib/wait/log.rb
+- lib/wait/wait.rb
+homepage: https://github.com/eventide-project/wait
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Generalized implementation of execution-until-condition with support for
+  timeout and polling interval
+test_files: []