waitfor 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-01-24
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/waitfor.rb
+lib/waitfor/fixnum.rb
+lib/waitfor/timer.rb
+lib/waitfor/version.rb
+spec/waitfor_spec.rb
+spec/timer_spec.rb
+spec/fixnum_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.rdoc

@@ -0,0 +1,76 @@
+= waitfor
+
+* http://github.com/jamesbobowski/waitfor
+
+== DESCRIPTION:
+
+Continuously executes a Block until the Block returns true or the time limit is reached, at which point an error is raised.
+Useful for strengthening tests involving asynchronous or non-blocking operations.
+
+== FEATURES/PROBLEMS:
+
+* Accepts arguments of second / seconds or minute / minutes
+* Allows for custom RuntimeError messages
+
+* No custom Error support yet
+* Resolution of delay between Block executions is currently 1 second, not yet configurable
+
+== SYNOPSIS:
+
+This gem is used with asynchronous or non-blocking operations where the action of doing something is separate from whether that action succeeded.
+
+The example below executes an asynchronous operation, then waits for up to 30 seconds for the status of the object to change by continuously checking whether it was successful.
+The Block will continue to be executed until it either returns true or 30 seconds elapses. If the time limit is reached, then a RuntimeError is raised.
+
+    object.some_async_operation
+
+    WaitFor.upto 30.seconds do
+      object.succeeded?
+    end
+
+A custom error message is specified in the example below. ( Custom errors are not yet supported. )
+
+    WaitFor.upto( 2.minutes, "Timeout after 2 minutes!" ) do
+      event.happened?
+    end
+
+Finally, a real world example taken from a FunFX test script I wrote. Here a button is clicked and we want to wait for the new screen to appear before moving on.
+
+    button.click
+
+    WaitFor.upto 1.minute do
+      Check.whether( new_screen ).is :visible
+    end
+
+== REQUIREMENTS:
+
+* Ruby >= 1.8.6
+
+== INSTALL:
+
+    sudo gem install waitfor --source http://gemcutter.org
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 James Bobowski
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/waitfor'
+require './lib/waitfor/version'
+
+Hoe.plugin :newgem
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'waitfor' do
+  self.developer 'James Bobowski', 'james.bobowski@gmail.com'
+  self.rubyforge_name       = self.name
+  self.version              = WaitFor::VERSION::STRING
+  self.description          = "Continuously executes a Block until the Block returns true or the time limit is reached, at which point an error is raised"
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/waitfor/fixnum.rb

@@ -0,0 +1,14 @@
+class Fixnum #:nodoc:
+  def second
+    self.seconds
+  end
+  def seconds
+    self
+  end
+  def minute
+    self.minutes
+  end
+  def minutes
+    self * 60
+  end
+end

data/lib/waitfor/timer.rb

@@ -0,0 +1,13 @@
+class Timer #:nodoc:
+  def initialize( seconds, exception_message = "Timeout Error Waiting for Event" )
+    @seconds           = seconds
+    @exception_message = exception_message
+    @start_time        = Time.now
+  end
+
+  def out_of_time?
+    out_of_time = ( Time.now - @start_time ) > @seconds
+    raise @exception_message if out_of_time
+    out_of_time
+  end
+end

data/lib/waitfor/version.rb

@@ -0,0 +1,9 @@
+module WaitFor #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/waitfor.rb

@@ -0,0 +1,16 @@
+$:.unshift( File.dirname( __FILE__ ) ) unless
+  $:.include?( File.dirname( __FILE__ ) ) || $:.include?( File.expand_path( File.dirname( __FILE__ ) ) )
+
+require 'waitfor/fixnum'
+require 'waitfor/timer'
+
+module WaitFor
+  class << self
+    def upto( length_of_time )
+      timer = Timer.new length_of_time
+      until yield or timer.out_of_time?
+        sleep 1
+      end
+    end
+  end
+end

data/spec/fixnum_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname( __FILE__ ) + '/spec_helper.rb'
+
+describe Fixnum, "Convert Seconds to Seconds" do
+  it "should take the unit of 'second' ( singular ) with the amount of 1 and return 1" do
+    1 == 1.second
+  end
+
+  it "should take the unit of 'seconds' ( plural ) with the amount of 1 and return 1" do
+    1 == 1.seconds
+  end
+
+  it "should take the unit of 'seconds' with the amount of 60 and return 60" do
+    60 == 60.seconds
+  end
+end
+
+describe Fixnum, "Convert Minutes to Seconds" do
+  it "should take the unit of 'minute' ( singular ) with the amount of 1 and return 60" do
+    60 == 1.minute
+  end
+
+  it "should take the unit of 'minutes' ( plural ) with the amount of 1 and return 60" do
+    60 == 1.minutes
+  end
+
+  it "should take the unit of 'minutes' with the amount of 5 and return 300" do
+    300 == 5.minutes
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift( File.dirname( __FILE__ ) + '/../lib' )
+require File.dirname( __FILE__ ) + '/../lib/waitfor.rb'
+require File.dirname( __FILE__ ) + '/../lib/waitfor/fixnum.rb'
+require File.dirname( __FILE__ ) + '/../lib/waitfor/timer.rb'
+
+def timer
+  start_time = Time.now
+  yield
+  Time.now - start_time
+end

data/spec/timer_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Timer do
+  it "should not raise an error when set for two seconds and checked after one second" do
+    timer = Timer.new 2.seconds
+    sleep 1
+    timer.out_of_time?.should be( false )
+  end
+
+  it "should raise an error when set for two seconds and checked after one second" do
+    timer = Timer.new 1.seconds
+    sleep 2
+    lambda {
+      timer.out_of_time?.should be( true )
+    }.should raise_error( RuntimeError, "Timeout Error Waiting for Event" )
+  end
+
+  it "should raise a custom error when set for one second and checked after two second" do
+    timer = Timer.new( 1.seconds, "Custom Error" )
+    sleep 2
+    lambda {
+      timer.out_of_time?.should be( true )
+    }.should raise_error( RuntimeError, "Custom Error" )
+  end
+end

data/spec/waitfor_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname( __FILE__ ) + '/spec_helper.rb'
+
+describe WaitFor do
+  it "should pass in under one second if block returns true immediately" do
+    elapsed_time = timer {
+      WaitFor.upto 1.second do
+        true
+      end
+    }
+
+    elapsed_time.should be < 1.second
+  end
+
+  it "should take at least two seconds before raising an error" do
+    elapsed_time = timer {
+      lambda {
+        WaitFor.upto 2.seconds do
+          false
+        end
+      }.should raise_error
+    }
+    
+    elapsed_time.should be_close( 2, 0.25 )
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: waitfor
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- James Bobowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-24 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: Continuously executes a Block until the Block returns true or the time limit is reached, at which point an error is raised
+email: 
+- james.bobowski@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/waitfor.rb
+- lib/waitfor/fixnum.rb
+- lib/waitfor/timer.rb
+- lib/waitfor/version.rb
+- spec/waitfor_spec.rb
+- spec/timer_spec.rb
+- spec/fixnum_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jamesbobowski/waitfor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: waitfor
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Generic 'wait for' method
+test_files: []
+