fire_poll 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+doc
+.yardoc

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --readme README.md

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fire_poll.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+(the MIT license)
+Copyright 2011 by Atomic Object
+
+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/README.md

@@ -0,0 +1,77 @@
+Description
+===========
+`FirePoll.poll` is a method for knowing when something is ready. When your block yields true, execution continues. When your block yields false, poll keeps trying until it gives up and raises an error.
+
+Examples
+--------
+I'm writing a system test for a web application. My test simulates uploading a large file, which isn't instantaneous. I need to know when the file has finished uploading so I can start making assertions.
+    def wait_for_file(filename)
+      FirePoll.poll do
+        FileStore.file_ready?(filename)
+      end
+    end
+    
+    def test_files_are_saved
+      upload_file "blue.txt"
+      assert_nothing_raised { wait_for_file "blue.txt" }
+      assert_equal "blue is the best color", read_saved_file("blue.txt")
+    end
+
+I just fired up a fake web service to respond to my client application. I want to know when the service is online before I start the client tests. I'm willing to wait 10 seconds before giving up.
+    class TestHelper
+      include FirePoll
+
+      def wait_for_server
+        poll("server didn't come online quick enough", 10) do
+          begin
+            TCPSocket.new(SERVER_IP, SERVER_PORT)
+            true
+          rescue Exception
+            false
+          end
+        end
+      end
+    end
+
+Usage
+-----
+Pass a block to `FirePoll.poll`. Return `true` when your need is met. Return `false` when it isn't. `poll` will raise an exception after too many failed attempts.
+
+The `poll` method takes two optional parameters: a specific message to raise on failure and the number of seconds to wait. By default, `poll` will try for two seconds. `poll` runs every tenth of a second.
+    FirePoll.poll { ... } # raises an error after two seconds
+    FirePoll.poll("new data hasn't arrived from the device") { ... } # raises a friendlier error message
+    FirePoll.poll("waited for too long!", 7) { ... } # raises an error after seven seconds with a specific error message
+    FirePoll.poll(nil, 88) { ... } # raises an error after eighty-eight seconds with the generic error message
+
+The `FirePoll` module may be mixed into your class; this makes it a little faster to type the method name.
+    class TestHelper
+      include FirePoll
+      def helper_method
+        poll do
+          ...
+        end
+      end
+    end
+
+Implementation
+--------------
+`FirePoll.poll`'s implementation isn't partcilarly accurate with respect to time. The method will run your block (number of seconds * 10) times. It sleeps for a tenth of a second between attempts. Since it doesn't keep track of time, if your timing needs require accuracy, you'll need to look elsewhere.
+
+Motivation
+----------
+We frequently need to wait for something to happen - usually in tests. And we usually don't have any strict time requirements - as long as something happens in _about_ [x] seconds, we're happy. `FirePoll.poll` meets our need nicely.
+
+On a related note, `Timer::Timeout` is known to be [busted](http://ph7spot.com/musings/system-timer) and [unreliable](http://blog.headius.com/2008/02/rubys-threadraise-threadkill-timeoutrb.html). `FirePoll.poll` doesn't employ any threads or timers, so we don't worry about whether it will work or not.
+
+TODO
+----
+* Nice to have: hook into Test::Unit and RSpec instead of raising a Ruby exception
+* Nice to have: pass options as a hash instead of two parameters. This will look nice with Ruby 1.9's hash syntax.
+
+Authors
+=======
+* Matt Fletcher (fletcher@atomicobject.com)
+* David Crosby (crosby@atomicobject.com)
+* Micah Alles (alles@atomicobject.com)
+* © 2011 [Atomic Object](http://www.atomicobject.com/)
+* More Atomic Object [open source](http://www.atomicobject.com/pages/Software+Commons) projects

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler"
+require "rake/testtask"
+require "rake/clean"
+require "yard"
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/test*.rb"]
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = %w[ lib/fire_poll.rb ]
+end
+
+CLEAN.include "pkg"
+CLEAN.include "doc"
+CLEAN.include ".yardoc"
+
+task :default => :test

data/fire_poll.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fire_poll/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fire_poll"
+  s.version     = FirePoll::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matt Fletcher", "David Crosby", "Micah Alles"]
+  s.email       = ["fletcher@atomicobject.com", "crosby@atomicobject.com", "alles@atomicobject.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple, brute-force method for knowing when something is ready}
+  s.description = %q{Simple, brute-force method for knowing when something is ready}
+
+  s.rubyforge_project = "fire_poll"
+
+  s.add_development_dependency("bundler", ">= 1.0.0")
+  s.add_development_dependency("rake", ">= 0.8.0")
+  s.add_development_dependency("yard", "~> 0.6.4")
+  s.add_development_dependency("bluecloth", "~> 2.0.11")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/fire_poll.rb

@@ -0,0 +1,22 @@
+# see the {file:README.md README file} for instruction on how to use this library
+module FirePoll
+  # @param [String] msg a custom message raised when polling fails
+  # @param [Numeric] seconds number of seconds to poll
+  # @yield a block that determines whether polling should continue
+  # @yieldreturn false if polling should continue
+  # @yieldreturn true if polling is complete
+  # @raise [RuntimeError] when polling fails
+  # @return [NilClass]
+  # @since 1.0.0
+  def poll(msg=nil, seconds=2.0) 
+    (seconds * 10).to_i.times do 
+      return if yield
+      sleep 0.1
+    end
+    msg ||= "polling failed after #{seconds} seconds" 
+    raise msg
+    nil
+  end
+
+  module_function :poll
+end

data/lib/fire_poll/version.rb

@@ -0,0 +1,3 @@
+module FirePoll
+  VERSION = "1.0.0"
+end

data/test/test_fire_poll.rb

@@ -0,0 +1,67 @@
+require "test/unit"
+require "fire_poll"
+
+class FirePollTest < Test::Unit::TestCase
+  def test_raises_when_block_does_not_yield_true
+    assert_raise RuntimeError do
+      FirePoll.poll { false }
+    end
+  end
+
+  def test_does_not_raise_when_block_yields_true
+    assert_nothing_raised do
+      FirePoll.poll { true }
+    end
+  end
+
+  def test_does_not_raise_when_block_eventually_yields_true
+    assert_nothing_raised do
+      count = 0
+      FirePoll.poll do
+        count += 1
+        count > 5 ? true : false
+      end
+    end
+  end
+
+  def test_can_take_an_optional_number_of_seconds_to_poll
+    # default 2 seconds = 20 calls to the block
+    assert_nothing_raised do
+      count1 = 0
+      FirePoll.poll do
+        count1 += 1
+        count1 > 11 ? true : false
+      end
+    end
+
+    # 1 second = 10 calls to the block
+    assert_raise RuntimeError do
+      count = 0
+      FirePoll.poll(nil, 1) do
+        count += 1
+        count > 11 ? true : false
+      end
+    end
+  end
+
+  def test_can_take_an_optional_message
+    # anyone know a better way to do this with straight-up Test::Unit?
+    begin
+      FirePoll.poll("custom message") { false }
+    rescue RuntimeError => ex
+      assert_equal "custom message", ex.message
+      return
+    end
+    flunk "should have raised"
+  end
+end
+
+class TestFirePollMixin < Test::Unit::TestCase
+  include FirePoll
+  
+  def test_can_be_mixed_in
+    assert_nothing_raised do
+      poll { true }
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: fire_poll
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Matt Fletcher
+- David Crosby
+- Micah Alles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 0
+        version: 0.8.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 4
+        version: 0.6.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 11
+        version: 2.0.11
+  type: :development
+  version_requirements: *id004
+description: Simple, brute-force method for knowing when something is ready
+email: 
+- fletcher@atomicobject.com
+- crosby@atomicobject.com
+- alles@atomicobject.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fire_poll.gemspec
+- lib/fire_poll.rb
+- lib/fire_poll/version.rb
+- test/test_fire_poll.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: fire_poll
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple, brute-force method for knowing when something is ready
+test_files: 
+- test/test_fire_poll.rb