trick_bag 0.58.1 → 0.59

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bc667fb430486e4cc7923ea12c615bc658cdd7e
-  data.tar.gz: 4db0fde0dd906dda2a46ebacb975908ac18eb154
+  metadata.gz: 80de6b95f6465d84976cfff65217064adab423c6
+  data.tar.gz: 6a91c5d2a35c666f85de817f64d78587978ace2a
 SHA512:
-  metadata.gz: f51ab665365c45131ac6f90932a58c2f33d604ea2ce13ad00cd0eac622b4816ece6e79d0ced9e73d487fed1ff71ec071a485e54f87bb890387b194a08d6d3d68
-  data.tar.gz: 44d8d27beb484babc4be8a78f773129ac0d2c790a989208c23fd2ac233a0634cc79fc5fa055b19f5b7a25cbdac53f3fd1cdb5e3e9710dd9f49add4898b11bdc6
+  metadata.gz: df097a1226f5ba6a5bdcaaf2200050fd8450e7a3cafdcd0827b6766ac15a8bfc5ef4f724b525c6d191891e0a272818348cabbee4a3ae27ed05e018e1f44eb493
+  data.tar.gz: 6f25b512ee5485ee8a7e78c089764420f29519d4abcb6a1fd2fa6faa1c3cde512f7018b4f3cd26589a3e75da057a65be5a04bb2d5457e75e5bf50a065ed8bd10

data/RELEASE_NOTES.md

@@ -1,3 +1,9 @@
+## v0.59
+
+* Timing.retry_until_true_or_timeout now optionally takes a code block instead of a lambda.
+  Also, method signature's parameter order has changed.  This is a breaking change for users
+  of this method. A descriptive error has been provided to explain if this happens.
+
 ## v0.58.1
 
 * For KmgtNumericString, support returning of nil/false on nil input.

data/lib/trick_bag/timing/timing.rb

@@ -4,6 +4,7 @@ require 'benchmark'
 module TrickBag
 module Timing
 
+
   module_function
 
 
@@ -26,31 +27,45 @@ module Timing
   # print "Waiting 10 seconds for true to be returned (but it won't):\n"
   # TrickBag::Timing.retry_until_true_or_timeout(predicate, 1, 10)
   def retry_until_true_or_timeout(
-      predicate, sleep_interval, timeout_secs, output_stream = $stdout)
+      sleep_interval, timeout_secs, output_stream = $stdout, predicate = nil)
+
+
+    # Method signature has changed from:
+    # (predicate, sleep_interval, timeout_secs, output_stream = $stdout)
+    # to:
+    # (sleep_interval, timeout_secs, output_stream = $stdout, predicate = nil)
+    #
+    # Test to see that when old signature is used, a descriptive error is raised.
+    #
+    # This test should be removed when we go to version 1.0.
+    if sleep_interval.respond_to?(:call)
+      raise ArgumentError.new('Sorry, method signature has changed to: ' \
+            '(sleep_interval, timeout_secs, output_stream = $stdout, predicate = nil).' \
+            '  Also a code block can now be provided instead of a lambda.')
+    end
+
+    if block_given? && predicate
+      raise ArgumentError.new('Both a predicate lambda and a code block were specified.' \
+          '  Please specify one or the other but not both.')
+    end
 
     success = false
-    start_time = Time.now
-    end_time = start_time + timeout_secs
-    time_elapsed = nil
+    end_time = Time.now + timeout_secs
     time_to_go = nil
-    text_generator = ->() { "%9.3f   %9.3f" % [time_elapsed, time_to_go] }
+    text_generator = ->() { '%9.3f   %9.3f' % [time_elapsed, time_to_go] }
     status_updater = ::TrickBag::Io::TextModeStatusUpdater.new(text_generator, output_stream)
 
     loop do
-      now = Time.now
-      time_elapsed = now - start_time
-      time_to_go = end_time - now
-      time_up = now >= end_time
 
-      break if time_up
+      break if Time.now >= end_time
 
-      success = !! predicate.()
+      success = !! (block_given? ? yield : predicate.())
       break if success
 
       status_updater.print
       sleep(sleep_interval)
     end
-    print "\n"
+    output_stream.print "\n"
     success
   end
 

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = "0.58.1"
+  VERSION = "0.59"
 end

data/spec/trick_bag/timing/timing_spec.rb

@@ -7,19 +7,50 @@ module TrickBag
   describe Timing do
 
     context '.retry_until_true_or_timeout' do
+
       it 'returns true when the predicate returns true' do
         count = 0
         predicate = ->{ count += 1; count == 3 }
-        return_value = Timing.retry_until_true_or_timeout(predicate, 0, 1, StringIO.new)
+        return_value = Timing.retry_until_true_or_timeout(0, 1, StringIO.new, predicate)
         expect(return_value).to be(true)
         expect(count).to eq(3)
       end
 
+      it 'returns true when the code block returns true' do
+        expect(Timing.retry_until_true_or_timeout(0, 1, StringIO.new) { true }).to eq(true)
+      end
+
       it 'returns false when the predicate fails to return true and a timeout occurs' do
         predicate = -> { false }
-        return_value = Timing.retry_until_true_or_timeout(predicate, 0, 0.1, StringIO.new)
+        return_value = Timing.retry_until_true_or_timeout(0, 0.1, StringIO.new, predicate)
         expect(return_value).to be(false)
       end
+
+      it 'returns false when the code block fails to return true and a timeout occurs' do
+        expect(Timing.retry_until_true_or_timeout(0, 0.1, StringIO.new) { false }).to eq(false)
+      end
+
+      # Method signature has changed from:
+      # (predicate, sleep_interval, timeout_secs, output_stream = $stdout)
+      # to:
+      # (sleep_interval, timeout_secs, output_stream = $stdout, predicate = nil)
+      #
+      # Test to see that when old signature is used, a descriptive error is raised.
+      #
+      # This test (and the error raising functionality it tests) should probably
+      # be removed once this gem goes to version 1.0.
+      it 'raises an ArgumentError when a predicate is passed as the first parameter' do
+        predicate = -> { false }
+        expect { Timing.retry_until_true_or_timeout(predicate, 0, 0.1, StringIO.new) } \
+            .to raise_error(ArgumentError)
+      end
+
+      it 'raises an ArgumentError when both a predicate lambda and code block are specified' do
+        predicate = -> { false }
+        expect do
+          Timing.retry_until_true_or_timeout(0, 0.1, StringIO.new, predicate) { true }
+        end.to raise_error(ArgumentError)
+      end
     end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.58.1
+  version: '0.59'
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os