govdelivery-proctor 1.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bce8d79f6531e5607f2cc402de70da89aa6c961a
-  data.tar.gz: cc01c5f9d058db7f0aacff5ecffa1141417dac37
+  metadata.gz: 91a9b90149544728c77ca574a3aea6c8a9e38562
+  data.tar.gz: d20eeee7b30bb5d9d27a721830c2f5c1633647a3
 SHA512:
-  metadata.gz: 1047b2266805be8100f8d365a36952e4a91afb18dac09a15a84c9563094971fbf3ace15ff6b5a0823aa0340c62eaf72a0f98f180e2c91392f016d3258e40cdd6
-  data.tar.gz: 75b16d48140304a9cab0cf1343b2f153cda23bd7ca0ee77a02ecd5d901fade3c8b3ba8be2269aae0ca67aba32400bf5247f255c70d8b1ae2ef8c267946f1391f
+  metadata.gz: f78e93e3d88422f8e54e12c0e81c6e68ac7b38584bd548fc92e195c445265f5ba6e0f076e00bdf86f6f667183fbf16c050e0758f4c224e7c194bd5bb0d593c6f
+  data.tar.gz: 45599c8cc3c0e03332b7f8675a17a8fa74eac2f61754a53fb83eb6a8d612c68896af89eba665524a2828d74c2ff6b58b9934479417a1ea066ffb45f247128739

data/.gitlab-ci.yml

@@ -0,0 +1,17 @@
+before_script:
+  - rbenv install -s
+  - bundle -v || gem install bundler
+  - bundle install --quiet --path .bundle
+
+stages:
+  - Test
+
+cache:
+  key: bundle_files
+  paths:
+    - .bundle/
+
+Test:
+  stage: Test
+  script:
+    - bundle exec rake test

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.25

data/CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 [How to use a CHANGELOG](http://keepachangelog.com/)
+## [1.3.1]
+### Fixed
+- Changes made as part of 1.3.0 caused an error to be thrown when ActiveSupport::Duration was used for `limit` or `inc` arguments of accelerating_check
+- Reverted `Math.log` formula for accelerating_check in favor of a more simple formula because the former was worse than the latter
+- Live logging amount of time an operation will be sleeping before sleep occurs
 ## [1.3.0]
 ### Added
 - Say hello to steady_check which sleeps for the increment passed to it

data/Gemfile

@@ -1,2 +1,2 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -1,33 +1,55 @@
 PATH
   remote: .
   specs:
-    govdelivery-proctor (1.2.1)
+    govdelivery-proctor (1.3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (9.0.5)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
     coderay (1.1.1)
+    ffi (1.9.14-java)
+    i18n (0.7.0)
+    json (1.8.3)
+    json (1.8.3-java)
     method_source (0.8.2)
-    power_assert (0.3.0)
+    minitest (5.10.1)
+    power_assert (0.4.1)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-byebug (3.4.0)
-      byebug (~> 9.0)
-      pry (~> 0.10)
+    pry (0.10.4-java)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    rake (11.3.0)
     slop (3.6.0)
-    test-unit (3.2.1)
+    spoon (0.0.6)
+      ffi
+    test-unit (3.2.3)
       power_assert
+    thread_safe (0.3.5)
+    thread_safe (0.3.5-java)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
+  activesupport (~> 4.0)
   bundler (~> 1.7)
   govdelivery-proctor!
-  pry-byebug (~> 3.4)
+  pry
+  rake
   test-unit
 
 BUNDLED WITH

data/README.md

@@ -78,16 +78,20 @@ end
 ## Development
 ### Get Dev Dependencies
 
-   $ bundle install
+    $ bundle install
 
 ### Build
 
-   $ gem build proctor.gemspec
+    $ gem build proctor.gemspec
 
 ### Install locally
 
-   $ gem install govdelivery-proctor-1.2.0.gem
+    $ gem install govdelivery-proctor-1.3.1.gem
 
 ### Test
 
-   $ rake test
+    $ rake test
+
+### Push to rubygems
+
+    $ gem push govdelivery-proctor-1.3.1.gem

data/lib/govdelivery/proctor/base.rb

@@ -1,7 +1,7 @@
 module GovDelivery::Proctor
   class CheckTimeExceeded < StandardError; end
 
-  def self.backoff_check(limit, desc = 'Backoff check', inc = 1)
+  def self.backoff_check(limit, desc = 'Backoff check', inc = 20)
     raise 'Check requires a block' unless block_given?
     check(limit, 'backoff', desc, inc) do
       yield
@@ -10,14 +10,14 @@ module GovDelivery::Proctor
 
   # Sometimes you want to reverse backoff because as time
   # passes it is more likely your condition is true
-  def self.accelerating_check(limit, desc = 'Backon check', inc = 1)
+  def self.accelerating_check(limit, desc = 'Accelerating check', inc = 20)
     raise 'Check requires a block' unless block_given?
     check(limit, 'accelerate', desc, inc) do
       yield
     end
   end
 
-  def self.steady_check(limit, desc = 'Steady check', inc = 1)
+  def self.steady_check(limit, desc = 'Steady check', inc = 10)
     raise 'Check requires a block' unless block_given?
     check(limit, 'steady', desc, inc) do
       yield
@@ -25,22 +25,24 @@ module GovDelivery::Proctor
   end
 
   # if backoff, double the wait time each time
-  # if accelerating, ramp up after long pause
+  # if accelerate, halve the wait time each time based on limit
+  #    and use increment only for minimum wait time
   # if steady, just keep it steady
+  # to_i used to make ActiveSupport::Durations safe
   def self.sleep_time(check_type, limit, increment, iteration)
-    case check_type
-    when 'steady'
-      increment
-    when 'backoff'
-      (2**iteration) * increment
-    when 'accelerate'
-      val = Math.log(limit, iteration + 1)
-      val = val.to_f.infinite? ? limit / increment : val
-      val = val.to_f.nan? ? 1 : val.round
-      [increment, val * increment].max
-    else
-      raise "Check type #{check_type} invalid: choose backon, accelerate or steady."
-    end
+    limit = limit.to_i
+    increment = increment.to_i
+    sleep_time = case check_type
+                 when 'steady'
+                   increment
+                 when 'backoff'
+                   (2**iteration) * increment
+                 when 'accelerate'
+                   [(limit / 2) / (iteration + 1), increment].max
+                 else
+                   raise "Check type #{check_type} invalid: choose accelerate, backoff, or steady."
+                 end
+    [sleep_time, limit].min
   end
 
   def self.check(limit, check_type, desc, inc)
@@ -50,7 +52,8 @@ module GovDelivery::Proctor
     x = 0
     response = nil
     Kernel.loop do
-      sleep_time = sleep_time(check_type, limit, inc, ++x)
+      sleep_time = sleep_time(check_type, limit, inc, x)
+      getStandardLogger.info("sleeping for #{sleep_time} seconds")
       sleep(sleep_time)
       slept_time += sleep_time
       response = yield
@@ -59,9 +62,9 @@ module GovDelivery::Proctor
         fail_message = "#{desc} has taken too long. Have waited #{slept_time} seconds\nlog: #{@backBuffer.string}"
         raise CheckTimeExceeded, fail_message
       end
+      x += 1
       # We're doing this twice, once for standard out so you can see it's still
       # working, and then again inside the logged output if it fails.
-
       getStandardLogger.info("Still waiting while #{desc}, current time=#{slept_time}")
       log.info("Still waiting while #{desc}, current time=#{slept_time}")
     end

data/lib/govdelivery/proctor/version.rb

@@ -1,5 +1,5 @@
 module GovDelivery
   module Proctor
-    VERSION = "1.3"
+    VERSION = "1.3.1"
   end
 end

data/proctor.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'test-unit'
   spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'activesupport', '~>4.0'
 end

data/test/test_helper.rb

@@ -4,5 +4,6 @@ Bundler.require :default, :test
 
 require 'test/unit'
 require 'govdelivery-proctor'
-require 'pry-byebug'
+require 'pry'
 require 'logger'
+require 'active_support/time'

data/test/test_proctor.rb

@@ -17,20 +17,30 @@ class TestProctor < Test::Unit::TestCase
     assert_equal 480, GovDelivery::Proctor.sleep_time('backoff', 600, 30, 4)
   end
 
-  def test_sleep_time_accelerate_iteration_default_to_minimum
-    assert_equal 10, GovDelivery::Proctor.sleep_time('accelerate', 1, 10, 2)
+  def test_sleep_time_accelerate_default_to_limit
+    assert_equal 1, GovDelivery::Proctor.sleep_time('accelerate', 1, 10, 2)
+  end
+
+  def test_sleep_time_accelerate_default_to_limit_with_ActiveSupport_Duration
+    assert_equal 1, GovDelivery::Proctor.sleep_time('accelerate', 1.second, 10.seconds, 2)
   end
 
   def test_sleep_time_accelerate_iteration_one
-    assert_equal 90, GovDelivery::Proctor.sleep_time('accelerate', 600, 10, 1)
+    assert_equal 150, GovDelivery::Proctor.sleep_time('accelerate', 600, 10, 1)
   end
 
   def test_sleep_time_accelerate_iteration_four
-    assert_equal 40, GovDelivery::Proctor.sleep_time('accelerate', 600, 10, 4)
+    assert_equal 60, GovDelivery::Proctor.sleep_time('accelerate', 600, 10, 4)
+  end
+
+  def test_sleep_time_accelerate_respect_increment
+    assert_equal 45, GovDelivery::Proctor.sleep_time('accelerate', 60, 45, 4)
   end
 
-  def test_sleep_time_accelerate_iteration_four_lower_sleep
-    assert_equal 4, GovDelivery::Proctor.sleep_time('accelerate', 600, 1, 4)
+  def test_sleep_time_accelerate_real_world
+    assert_equal 240, GovDelivery::Proctor.sleep_time('accelerate', 8.minutes, 30, 0)
+    assert_equal 120, GovDelivery::Proctor.sleep_time('accelerate', 8.minutes, 30, 1)
+    assert_equal  40, GovDelivery::Proctor.sleep_time('accelerate', 8.minutes, 30, 5)
   end
 
   def test_backoff_check_condition_true
@@ -66,7 +76,7 @@ class TestProctor < Test::Unit::TestCase
         false
       end
     end
-    assert_equal "Backon check has taken too long. Have waited 1 seconds\nlog: ", ex.message
+    assert_equal "Accelerating check has taken too long. Have waited 1 seconds\nlog: ", ex.message
   end
 
   def test_steady_check_condition_false

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: govdelivery-proctor
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: 1.3.1
 platform: ruby
 authors:
 - Bill Bushey
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
+        version: '0'
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: test-unit
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
+        version: '0'
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: activesupport
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '4.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  prerelease: false
+  type: :development
 description: Classes and functions to support feature testing.
 email:
 - bill.bushey@govdelivery.com
@@ -60,6 +88,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -75,7 +105,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,9 +120,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
 specification_version: 4
 summary: Classes and functions to support feature testing.
 test_files: