service_skeleton 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d49a02ddaf68cb61da78352ed7f114f1ba12034dcd02852ce20aab2c87ea390
-  data.tar.gz: 9090f37cac4cc61fa538fc56a34c859fd44adc252e0fd212ea3a63a877a46666
+  metadata.gz: 2eb043ee79208c4b1b457b1b9deb2b5901119339c9789d8a6d511870bc038e46
+  data.tar.gz: 6848edcb6fe369e5a6ce0dcf823780ee8047f8953b40ea261e03aa0f47314d27
 SHA512:
-  metadata.gz: 85685190eb12f5072744e7098f529cf12fc4755483fee50a47f8f46db7b83acf587eed549e973a02d903dd4a5d9bf9929c24a515996002e6b072629ff780af9d
-  data.tar.gz: e80d673512846c362094c962b21ffdababeae718194d9ba48b60dc73f733b8ccc820fbff8c1766f1a48eb4ccc2deb912fb6194bd788d526d7241bfd10b9d9295
+  metadata.gz: 43fe6a4e0ad9adb50cd78c09c41063df614a0116c194283710660b24f2877994038bb818e35ad78eb7b72da62c3ec7e75646fc2bfae5c6f85ef5fdd7a5289dba
+  data.tar.gz: 9aacd383f2d867a51b19adc8c1d501ad383497d13a72de0b8fa9992301b029cd23e60aaa3c72511e98f240ed060dd1dab6b8b38a89a9de3cce19a40c8c696f39

data/README.md

@@ -268,7 +268,7 @@ default for a config variable, like so:
     class GenericHelloService
       include ServiceSkeleton
 
-      string :RECIPIENT, match: /\a\w+\z/, default: "Anonymous Coward"
+      string :RECIPIENT, match: /\A\w+\z/, default: "Anonymous Coward"
 
       # ...
 

data/lib/service_skeleton/hurriable_timer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# A mechanism for waiting until a timer expires or until another thread signals
+# readiness.
+class ServiceSkeleton::HurriableTimer
+  def initialize(timeout)
+    @mutex = Mutex.new
+    @condition = ConditionVariable.new
+    @end_time = now + timeout
+    @hurried = false
+  end
+
+  # Wait for the timer to elapse
+  #
+  # Any number of threads can wait on the same HurriableTimer
+  def wait(t = nil)
+    end_time =
+      if t
+        [@end_time, now + t].min
+      else
+        @end_time
+      end
+
+    @mutex.synchronize {
+      while true
+        remaining = end_time - now
+
+        if remaining < 0 || @hurried
+          break
+        else
+          @condition.wait(@mutex, remaining)
+        end
+      end
+    }
+
+    nil
+  end
+
+  # Cause the timer to trigger early if it hasn't already expired
+  #
+  # This method is idempotent
+  def hurry!
+    @mutex.synchronize {
+      @hurried = true
+      @condition.broadcast
+    }
+
+    nil
+  end
+
+  def expired?
+    @hurried || @end_time - now < 0
+  end
+
+  private
+
+  def now
+    # Using this instead of Time.now, because it isn't affected by NTP updates
+    Process.clock_gettime(Process::CLOCK_MONOTONIC_RAW)
+  end
+end

data/lib/service_skeleton/hurriable_timer_sequence.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# HurribleTimerSequence is a resettable version of HurriableTimer, designed for
+# cases where some action needs to happen at at least some frequency, but may
+# happen more often when other threads trigger the process early.
+#
+# It would have been possible to implement this without requiring allocation on
+# reset, by reusing the mutex and condition variable in the normal timer, but
+# this version is more obviously correct.
+class ServiceSkeleton::HurriableTimerSequence
+  def initialize(timeout)
+    @mutex = Mutex.new
+    @timeout = timeout
+    @latest = ServiceSkeleton::HurriableTimer.new(@timeout)
+  end
+
+  def reset!
+    @mutex.synchronize {
+      @latest.hurry!
+      @latest = ServiceSkeleton::HurriableTimer.new(@timeout)
+    }
+  end
+
+  def wait(t = nil)
+    @mutex.synchronize { @latest }.wait(t)
+  end
+
+  def hurry!
+    @mutex.synchronize { @latest }.hurry!
+  end
+
+  def expired?
+    @mutex.synchronize { @latest }.expired?
+  end
+end

data/lib/service_skeleton.rb

@@ -3,6 +3,8 @@
 require_relative "service_skeleton/config_class"
 require_relative "service_skeleton/config_variables"
 require_relative "service_skeleton/generator"
+require_relative "service_skeleton/hurriable_timer"
+require_relative "service_skeleton/hurriable_timer_sequence"
 require_relative "service_skeleton/logging_helpers"
 require_relative "service_skeleton/metrics_methods"
 require_relative "service_skeleton/service_name"

data/service_skeleton.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |s|
   s.name = "service_skeleton"
 
-  s.version = '2.0.2'
+  s.version = '2.1.0'
 
   s.platform = Gem::Platform::RUBY
 

data/ultravisor/spec/spec_helper.rb

@@ -7,8 +7,10 @@ require 'rspec/mocks'
 Thread.report_on_exception = false
 
 require 'simplecov'
-SimpleCov.start do
-  add_filter('spec')
+unless SimpleCov.running
+  SimpleCov.start do
+    add_filter('spec')
+  end
 end
 
 class ListIncompletelyCoveredFiles

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Matt Palmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -275,6 +275,8 @@ files:
 - lib/service_skeleton/error.rb
 - lib/service_skeleton/filtering_logger.rb
 - lib/service_skeleton/generator.rb
+- lib/service_skeleton/hurriable_timer.rb
+- lib/service_skeleton/hurriable_timer_sequence.rb
 - lib/service_skeleton/logging_helpers.rb
 - lib/service_skeleton/metric_method_name.rb
 - lib/service_skeleton/metrics_methods.rb
@@ -334,7 +336,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: The bare bones of a service