evt-poll 0.1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89cf5f449b8dcf01f48c82d39a139434ea8ac185c7178bac749c4394de174bf7
+  data.tar.gz: d24ea1791c7bf0400b32b33a83fa07963f700623ed3169dff10967ed417f18f3
+SHA512:
+  metadata.gz: 0f875934c022770e5b14eed4b066326ec0c0faf60bb48d8e09450d508e72d20c398dbda654124a0337a8ca484c05ea16f9b1ae392fcac0f1b1220f8d821c55f7
+  data.tar.gz: ea00a5edf1896470713a6cb76cd516ae97f19a99e8832f7c54f63aa7cc2525b96521f2b976173d431119587c46c17eee8b7db3397e1aab98a41e35b74d163821

data/lib/poll.rb

@@ -0,0 +1,7 @@
+require 'log'
+require 'telemetry'
+require 'clock'
+
+require 'poll/log'
+require 'poll/cycle'
+require 'poll/defaults'

data/lib/poll/controls.rb

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

data/lib/poll/controls/time.rb

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

data/lib/poll/cycle.rb

@@ -0,0 +1,179 @@
+class Poll
+  Error = Class.new(RuntimeError)
+
+  include Log::Dependency
+
+  dependency :clock, Clock::UTC
+  dependency :telemetry, Telemetry
+
+  attr_writer :interval_milliseconds
+  def interval_milliseconds
+    @interval_milliseconds ||= Defaults.interval_milliseconds
+  end
+
+  attr_accessor :timeout_milliseconds
+
+  attr_writer :delay_condition
+  def delay_condition
+    @delay_condition ||= Defaults.delay_condition
+  end
+
+  def self.build(interval_milliseconds: nil, timeout_milliseconds: nil, delay_condition: nil)
+    instance = new
+
+    instance.interval_milliseconds = interval_milliseconds
+    instance.timeout_milliseconds = timeout_milliseconds
+    instance.delay_condition = delay_condition
+
+    instance.configure
+
+    instance
+  end
+
+  def self.configure(receiver, attr_name: nil, interval_milliseconds: nil, timeout_milliseconds: nil, delay_condition: nil, cycle: nil)
+    attr_name ||= :cycle
+
+    if !cycle.nil?
+      instance = cycle
+    else
+      instance = build(interval_milliseconds: interval_milliseconds, timeout_milliseconds: timeout_milliseconds, delay_condition: delay_condition)
+    end
+
+    receiver.public_send "#{attr_name}=", instance
+  end
+
+  def self.none
+    None.build
+  end
+
+  def configure
+    Clock::UTC.configure self
+    ::Telemetry.configure self
+  end
+
+  def self.call(interval_milliseconds: nil, timeout_milliseconds: nil, delay_condition: nil, &action)
+    instance = build(interval_milliseconds: interval_milliseconds, timeout_milliseconds: timeout_milliseconds, delay_condition: delay_condition)
+    instance.call(&action)
+  end
+
+  def call(&action)
+    stop_time = nil
+    stop_time_iso8601 = nil
+    if !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}, Timeout Milliseconds: #{timeout_milliseconds.inspect}, Stop Time: #{stop_time_iso8601})" }
+
+    cycle = -1
+    result = nil
+    loop do
+      cycle += 1
+      telemetry.record :cycle, cycle
+
+      result, elapsed_milliseconds = invoke(cycle, &action)
+
+      if delay_condition.(result)
+        logger.debug { "Got no results from action (Cycle: #{cycle})" }
+        delay(elapsed_milliseconds)
+      else
+        logger.debug { "Got results from action (Cycle: #{cycle})" }
+        telemetry.record :got_result
+        break
+      end
+
+      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})" }
+          telemetry.record :timed_out, now
+          break
+        end
+      end
+    end
+
+    logger.debug { "Cycled (Iterations: #{cycle + 1}, Interval Milliseconds: #{interval_milliseconds}, Timeout Milliseconds: #{timeout_milliseconds.inspect}, Stop Time: #{stop_time_iso8601})" }
+
+    return result
+  end
+
+  def invoke(cycle, &action)
+    if action.nil?
+      raise Error, "Poll must be actuated with a block"
+    end
+
+    action_start_time = clock.now
+
+    logger.trace { "Invoking action (Cycle: #{cycle}, Start Time: #{clock.iso8601(action_start_time, precision: 5)})" }
+
+    result = action.call(cycle)
+
+    action_end_time = clock.now
+    elapsed_milliseconds = clock.elapsed_milliseconds(action_start_time, action_end_time)
+
+    telemetry.record :invoked_action, elapsed_milliseconds
+
+    logger.debug { "Invoked action (Cycle: #{cycle}, Elapsed Milliseconds: #{elapsed_milliseconds}, Start Time: #{clock.iso8601(action_start_time, precision: 5)}, End Time: #{clock.iso8601(action_end_time, precision: 5)})" }
+
+    [result, elapsed_milliseconds]
+  end
+
+  def delay(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 Telemetry
+    class Sink
+      include ::Telemetry::Sink
+
+      record :cycle
+      record :invoked_action
+      record :got_result
+      record :delayed
+      record :timed_out
+    end
+
+    def self.sink
+      Sink.new
+    end
+  end
+
+  module Substitute
+    def self.build
+      instance = Poll.build(timeout_milliseconds: 0)
+
+      sink = Poll.register_telemetry_sink(instance)
+      instance.telemetry_sink = sink
+
+      instance.configure
+
+      instance
+    end
+
+    class Poll < ::Poll
+      attr_accessor :telemetry_sink
+    end
+  end
+end

data/lib/poll/defaults.rb

@@ -0,0 +1,17 @@
+class Poll
+  module Defaults
+    def self.interval_milliseconds
+      0
+    end
+
+    def self.delay_condition
+      lambda do |result|
+        if result.respond_to?(:empty?)
+          result.empty?
+        else
+          result.nil?
+        end
+      end
+    end
+  end
+end

data/lib/poll/log.rb

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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: evt-poll
+version: !ruby/object:Gem::Version
+  version: 0.1.0.0
+platform: ruby
+authors:
+- The Eventide Project
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-07 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/poll.rb
+- lib/poll/controls.rb
+- lib/poll/controls/time.rb
+- lib/poll/cycle.rb
+- lib/poll/defaults.rb
+- lib/poll/log.rb
+homepage: https://github.com/eventide-project/cycle
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Generalized implementation of polling
+test_files: []