wait_until 0.0.1 → 0.1.0

data/lib/wait_until/version.rb

@@ -1,3 +1,3 @@
 module WaitUntil
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/wait_until/wait.rb

@@ -5,17 +5,18 @@ module WaitUntil
 
       attr_accessor :default_timeout_in_seconds
 
-      def until_true!(description, &block)
+      def until_true!(description, options={}, &block)
+        timeout_in_seconds = options[:timeout_in_seconds] || self.default_timeout_in_seconds
         start_time = Time.now
         last_exc = nil
-        while true
+        loop do
           begin
             return if block.call
           rescue => exc
             last_exc = exc
           end
           elapsed_time = Time.now - start_time
-          if elapsed_time >= self.default_timeout_in_seconds
+          if elapsed_time >= timeout_in_seconds
             failure_message = "Timed-out waiting until '#{description}'"
             failure_message << ".  Last observed exception: #{last_exc}" if last_exc
             raise failure_message
@@ -23,12 +24,12 @@ module WaitUntil
         end
       end
 
-      def until_false!(description, &block)
-        until_true!(description) { !block.call }
+      def until_false!(description, options={}, &block)
+        until_true!(description, options) { !block.call }
       end
 
-      def until!(description, &block)
-        until_true!(description) do
+      def until!(description, options={}, &block)
+        until_true!(description, options) do
           block.call
           true
         end

data/spec/lib/wait_until/wait_spec.rb

@@ -9,25 +9,49 @@ describe WaitUntil::Wait do
 
   describe ".until_true!" do
 
-    describe "when the block returns true" do
+    context "when the block returns true" do
+
+      let(:block) do
+        lambda { WaitUntil::Wait.until_true!("some operation") { true } }
+      end
 
       it "should execute without error" do
-        lambda { WaitUntil::Wait.until_true!("some operation") { true } }.should_not raise_error
+        block.should_not raise_error
       end
 
     end
 
-    describe "when the blocks always returns false" do
+    context "when the blocks always returns false" do
 
-      it "should raise an error indicating the operation timed-out" do
+      let(:timeout_in_seconds) { nil }
+      let(:block) do
         lambda do
-          WaitUntil::Wait.until_true!("another operation finishes") { false }
-        end.should raise_error(/Timed-out waiting until 'another operation finishes'/i)
+          WaitUntil::Wait.until_true!("another operation finishes", timeout_in_seconds: timeout_in_seconds) { false }
+        end
+      end
+
+      it "should raise an error indicating the operation timed-out" do
+        block.should raise_error(/Timed-out waiting until 'another operation finishes'/i)
+      end
+
+      context "and a timeout is provided" do
+
+        let(:timeout_in_seconds) { 2 }
+
+        it "should wait until at least a period of time matching the timeout before raising an error" do
+          start_time = Time.now
+
+          block.should raise_error
+
+          period_of_time_waited = (Time.now - start_time)
+          period_of_time_waited.should be >= timeout_in_seconds
+        end
+
       end
 
     end
 
-    describe "when the block eventually returns true" do
+    context "when the block eventually returns true" do
 
       it "should execute without error" do
         invocation_count = 0
@@ -45,25 +69,49 @@ describe WaitUntil::Wait do
 
   describe ".until_false!" do
 
-    describe "when the block returns false" do
+    context "when the block returns false" do
+
+      let(:block) do
+        lambda { WaitUntil::Wait.until_false!("some operation") { false } }
+      end
 
       it "should execute without error" do
-        lambda { WaitUntil::Wait.until_false!("some operation") { false } }.should_not raise_error
+        block.should_not raise_error
       end
 
     end
 
-    describe "when the blocks always returns true" do
+    context "when the blocks always returns true" do
 
-      it "should raise an error indicating the operation timed-out" do
+      let(:timeout_in_seconds) { nil }
+      let(:block) do
         lambda do
-          WaitUntil::Wait.until_false!("another operation finishes") { true }
-        end.should raise_error(/Timed-out waiting until 'another operation finishes'/i)
+          WaitUntil::Wait.until_false!("another operation finishes", timeout_in_seconds: timeout_in_seconds) { true }
+        end
+      end
+
+      it "should raise an error indicating the operation timed-out" do
+        block.should raise_error(/Timed-out waiting until 'another operation finishes'/i)
+      end
+
+      context "and a timeout is provided" do
+
+        let(:timeout_in_seconds) { 2 }
+
+        it "should wait until at least a period of time matching the timeout before raising an error" do
+          start_time = Time.now
+
+          block.should raise_error
+
+          period_of_time_waited = (Time.now - start_time)
+          period_of_time_waited.should be >= timeout_in_seconds
+        end
+
       end
 
     end
 
-    describe "when the block eventually returns false" do
+    context "when the block eventually returns false" do
 
       it "should execute without error" do
         invocation_count = 0
@@ -81,27 +129,51 @@ describe WaitUntil::Wait do
 
   describe ".until!" do
 
-    describe "when the block executes without error" do
+    context "when the block executes without error" do
+
+      let(:block) do
+        lambda { WaitUntil::Wait.until!("some operation") { } }
+      end
 
       it "should execute without error" do
-        lambda { WaitUntil::Wait.until!("some operation") { } }.should_not raise_error
+        block.should_not raise_error
       end
 
     end
 
-    describe "when the block raises an error indefinitely" do
+    context "when the block raises an error indefinitely" do
 
-      it "should raise an error indicating the operation timed-out" do
+      let(:timeout_in_seconds) { nil }
+      let(:block) do
         lambda do
-          WaitUntil::Wait.until!("some operation finishes") do
+          WaitUntil::Wait.until!("some operation finishes", timeout_in_seconds: timeout_in_seconds) do
             raise "forced error"
           end
-        end.should raise_error(/Timed-out waiting until 'some operation finishes'/i)
+        end
+      end
+
+      it "should raise an error indicating the operation timed-out" do
+        block.should raise_error(/Timed-out waiting until 'some operation finishes'/i)
+      end
+
+      context "and a timeout is provided" do
+
+        let(:timeout_in_seconds) { 2 }
+
+        it "should wait until at least a period of time matching the timeout before raising an error" do
+          start_time = Time.now
+
+          block.should raise_error
+
+          period_of_time_waited = (Time.now - start_time)
+          period_of_time_waited.should be >= timeout_in_seconds
+        end
+
       end
 
     end
 
-    describe "when the block eventually executes without error" do
+    context "when the block eventually executes without error" do
 
       it "should execute without error" do
         invocation_count = 0

data/spec/spec_helper.rb

@@ -1,14 +1,11 @@
 require 'simplecov'
 SimpleCov.start do
   add_filter "/spec/"
+  add_filter "/vendor/"
   minimum_coverage 100
   refuse_coverage_drop
 end if ENV["coverage"]
 
 require_relative "../lib/wait_until"
 
-require 'rubygems'
-require 'bundler'
-Bundler.require(:test)
-
 Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |file| require file }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wait_until
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: travis-lint
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,15 +26,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: metric_fu
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '4.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,15 +42,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '4.4'
 - !ruby/object:Gem::Dependency
-  name: flog
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,15 +58,31 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: travis-lint
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +90,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '0.7'
 description: Suspends execution until state changes via ::Wait.until! methods, timing-out
   after a configured period of time
 email: matthew.ueckerman@myob.com