wait_until 0.0.1

data/lib/wait_until.rb

@@ -0,0 +1,3 @@
+require_relative "wait_until/wait"
+
+Wait = WaitUntil::Wait

data/lib/wait_until/version.rb

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

data/lib/wait_until/wait.rb

@@ -0,0 +1,42 @@
+module WaitUntil
+  class Wait
+
+    class << self
+
+      attr_accessor :default_timeout_in_seconds
+
+      def until_true!(description, &block)
+        start_time = Time.now
+        last_exc = nil
+        while true
+          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
+            failure_message = "Timed-out waiting until '#{description}'"
+            failure_message << ".  Last observed exception: #{last_exc}" if last_exc
+            raise failure_message
+          end
+        end
+      end
+
+      def until_false!(description, &block)
+        until_true!(description) { !block.call }
+      end
+
+      def until!(description, &block)
+        until_true!(description) do
+          block.call
+          true
+        end
+      end
+
+    end
+
+    self.default_timeout_in_seconds = ENV["timeout"] ? ENV["timeout"].to_i : 20
+
+  end
+end

data/spec/lib/wait_until/wait_spec.rb

@@ -0,0 +1,120 @@
+describe WaitUntil::Wait do
+
+  before(:all) do
+    @initial_default_timeout = WaitUntil::Wait.default_timeout_in_seconds
+    WaitUntil::Wait.default_timeout_in_seconds = 1
+  end
+
+  after(:all) { WaitUntil::Wait.default_timeout_in_seconds = @initial_default_timeout }
+
+  describe ".until_true!" do
+
+    describe "when the block returns true" do
+
+      it "should execute without error" do
+        lambda { WaitUntil::Wait.until_true!("some operation") { true } }.should_not raise_error
+      end
+
+    end
+
+    describe "when the blocks always returns false" do
+
+      it "should raise an error indicating the operation timed-out" do
+        lambda do
+          WaitUntil::Wait.until_true!("another operation finishes") { false }
+        end.should raise_error(/Timed-out waiting until 'another operation finishes'/i)
+      end
+
+    end
+
+    describe "when the block eventually returns true" do
+
+      it "should execute without error" do
+        invocation_count = 0
+        lambda do
+          WaitUntil::Wait.until_true!("some operation") do
+            invocation_count += 1
+            invocation_count == 3
+          end
+        end.should_not raise_error
+      end
+
+    end
+
+  end
+
+  describe ".until_false!" do
+
+    describe "when the block returns false" do
+
+      it "should execute without error" do
+        lambda { WaitUntil::Wait.until_false!("some operation") { false } }.should_not raise_error
+      end
+
+    end
+
+    describe "when the blocks always returns true" do
+
+      it "should raise an error indicating the operation timed-out" do
+        lambda do
+          WaitUntil::Wait.until_false!("another operation finishes") { true }
+        end.should raise_error(/Timed-out waiting until 'another operation finishes'/i)
+      end
+
+    end
+
+    describe "when the block eventually returns false" do
+
+      it "should execute without error" do
+        invocation_count = 0
+        lambda do
+          WaitUntil::Wait.until_false!("some operation") do
+            invocation_count += 1
+            invocation_count < 3
+          end
+        end.should_not raise_error
+      end
+
+    end
+
+  end
+
+  describe ".until!" do
+
+    describe "when the block executes without error" do
+
+      it "should execute without error" do
+        lambda { WaitUntil::Wait.until!("some operation") { } }.should_not raise_error
+      end
+
+    end
+
+    describe "when the block raises an error indefinitely" do
+
+      it "should raise an error indicating the operation timed-out" do
+        lambda do
+          WaitUntil::Wait.until!("some operation finishes") do
+            raise "forced error"
+          end
+        end.should raise_error(/Timed-out waiting until 'some operation finishes'/i)
+      end
+
+    end
+
+    describe "when the block eventually executes without error" do
+
+      it "should execute without error" do
+        invocation_count = 0
+        lambda do
+          WaitUntil::Wait.until!("some operation") do
+            invocation_count += 1
+            raise "forced error" if invocation_count < 3
+          end
+        end.should_not raise_error
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/wait_until/wait_until_spec.rb

@@ -0,0 +1,11 @@
+describe WaitUntil do
+
+  describe "when loaded" do
+
+    it "should define the global Wait class as the WaitUntil::Wait class" do
+      Wait.should eql(WaitUntil::Wait)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+  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

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: wait_until
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Ueckerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+description: Suspends execution until state changes via ::Wait.until! methods, timing-out
+  after a configured period of time
+email: matthew.ueckerman@myob.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./lib/wait_until/version.rb
+- ./lib/wait_until/wait.rb
+- ./lib/wait_until.rb
+- ./spec/lib/wait_until/wait_spec.rb
+- ./spec/lib/wait_until/wait_until_spec.rb
+- ./spec/spec_helper.rb
+homepage: http://github.com/MYOB-Technology/wait_until
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: wait_until
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Suspends execution until state changes via ::Wait.until! methods
+test_files:
+- ./spec/lib/wait_until/wait_spec.rb
+- ./spec/lib/wait_until/wait_until_spec.rb
+- ./spec/spec_helper.rb