waiter_ 0.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd0325695fdeaf22e3e8d68315874f9f4dbaeb83
-  data.tar.gz: 16016830d0702876aa84c58755dfcb415b2384a7
+  metadata.gz: 6e268b47f92c2f681a1574ce1fe621c31a391fed
+  data.tar.gz: e5361387d097b61bd4a7cb16690c3e56c69579b5
 SHA512:
-  metadata.gz: e44261b1a34d9e14053a2dc6b557f00d4fe75a9ac416073c7faf3494b59c1ac2353c975a9e9043e13e8b0bcc68b9959d927e58b161ae2d6fca37f973f9f74880
-  data.tar.gz: 42c81f41bf86dcbb66d4f29f4a181f4fa5c01192b6dd8a6f45f229ff9abf3dcd4e1e8189b888df8280a03141e34b5e0161a9190c3bf6b0d8bc0a484d95106f70
+  metadata.gz: a3a8c53b6dc3e0173a4d839eed61ae4ff286c23fe9556a0a5e3737d087fcb14c58dc4c9b9604eff16e5da52159aac0b4147efcbe5bebd53b40a5ce6c021a814f
+  data.tar.gz: 01dde6fe0567b1af0abb61c6caaec4bfac818715ca7ddd69929b22bbb734b98a8c73736c4b333451f2ff259a4ae16b5f02ce6a0296945e28cb04f926f2ea13bd

data/README.md

@@ -7,7 +7,7 @@ A simple wait/polling gem.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'waiter', git: 'git@github.atl.pdrop.net:dmcneil/waiter.git'
+gem 'waiter_'
 ```
 
 And then execute:
@@ -19,29 +19,30 @@ And then execute:
 Just `include Waiter` and the following APIs will be available.
 
 ```ruby
-wait('foo').to eq 'foo' # Will pass.
-wait('foo').to eq 'bar' # Will throw exception.
-wait('foo').to_not eq 'bar' # Will pass.
-wait('foo').to_not eq 'foo' # Will fail.
+wait.for('foo').to eq 'foo' # Will pass.
+wait.for('foo').to eq 'bar' # Will throw exception.
+wait.for('foo').to_not eq 'bar' # Will pass.
+wait.for('foo').to_not eq 'foo' # Will fail.
 ```
 
 To adjust the timeout/polling, simple chain methods are supported.
 
-The *for* method accepts an Integer and adjusts the timeout. Use the *every* method with an Integer to adjust the polling time.
+The *up_to* method accepts an Integer and adjusts the timeout.
+Use the *every* method with an Integer to adjust the polling time.
 
 ```ruby
 # Wait for 30 seconds, polling every 2 second.
-wait('foo').every(2).for(30).to eq 'foo'
+wait.every(2).up_to(30).for('foo').to eq 'foo'
 ```
 
 You do *not* have to use both methods, you can adjust one or the other. They can also be used in any order.
 
 ```ruby
 # Wait for 30 seconds, using the default 1 second poll.
-wait('foo').for(30).to eq 'foo'
+wait.for('foo').up_to(30).to eq 'foo'
 
 # Wait for the default 15 seconds, polling every 5 seconds.
-wait('foo').every(5).to eq 'foo'
+wait.for('foo').every(5).to eq 'foo'
 ```
 
 You can also pass a block to be evaluated, using *until*, until it is true.
@@ -49,8 +50,7 @@ You can also pass a block to be evaluated, using *until*, until it is true.
 ```ruby
 wait.until { true == true }
 
-wait.every(5).for(30).until {
+wait.every(5).up_to(30).until {
   true == true
 }
 ```
-

data/lib/timeout_error.rb

@@ -0,0 +1,4 @@
+module Waiter
+  class TimeoutError < StandardError
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Waiter
-  VERSION = '0.0.1'
+  VERSION = '1.0.2'
 end

data/lib/waiter.rb

@@ -1,5 +1,7 @@
 require 'rspec/expectations'
 
+require_relative 'timeout_error'
+
 module Waiter
   # Wrapper for RSpec expectations that allows waiting/polling.
   #
@@ -7,20 +9,20 @@ module Waiter
   #
   # @example
   #
-  #   wait('foo').to eq 'foo' # Will pass.
-  #   wait('foo').to eq 'bar' # Will throw exception.
-  #   wait('foo').to_not eq 'bar' # Will pass.
-  #   wait('foo').to_not eq 'foo' # Will fail.
+  #   wait.for('foo').to eq 'foo' # Will pass.
+  #   wait.for('foo').to eq 'bar' # Will throw exception.
+  #   wait.for('foo').to_not eq 'bar' # Will pass.
+  #   wait.for('foo').to_not eq 'foo' # Will fail.
   #
   # To adjust the timeout/polling, simple chain methods are supported.
   #
-  # The *for* method accepts an Integer and adjusts the timeout.
+  # The *up_to* method accepts an Integer and adjusts the timeout.
   # Use the *every* method with an Integer to adjust the polling time.
   #
   # @example
   #
   #   # Wait for 30 seconds, polling every 2 second.
-  #   wait('foo').every(2).for(30).to eq 'foo'
+  #   wait.every(2).up_to(30).for('foo').to eq 'foo'
   #
   # You do *not* have to use both methods, you can adjust one or the other.
   # They can also be used in any order.
@@ -28,10 +30,10 @@ module Waiter
   # @example
   #
   #   # Wait for 30 seconds, using the default 1 second poll.
-  #   wait('foo').for(30).to eq 'foo'
+  #   wait.for('foo').up_to(30).to eq 'foo'
   #
   #   # Wait for the default 15 seconds, polling every 5 seconds.
-  #   wait('foo').every(5).to eq 'foo'
+  #   wait.for('foo').every(5).to eq 'foo'
   #
   # You can also pass a block to be evaluated, using *until*, until it is true.
   #
@@ -39,40 +41,72 @@ module Waiter
   #
   #   wait.until { true == true }
   #
-  #   wait.every(5).for(30).until {
+  #   wait.every(5).up_to(30).until {
   #     true == true
   #   }
   #
   # @author Derek McNeil <dmcneil@pindrop.com>
-  def wait(value=true, &block)
-    WaitExpectationTarget.for(value, block)
+  def wait(opts = {}, &block)
+    ChainableWait.new(opts)
   end
 
-  alias_method :wait_for, :wait
-
-  class WaitExpectationTarget < RSpec::Expectations::ExpectationTarget
+  class ChainableWait
     attr_reader :target
     attr_accessor :timeout, :polling, :message
 
     DEFAULT_TIMEOUT = 15
     DEFAULT_POLLING = 1
 
-    def initialize(value)
-      @target = value
-      @timeout = DEFAULT_TIMEOUT
-      @polling = DEFAULT_POLLING
+    def initialize(opts = {})
+      @timeout = opts[:timeout] || DEFAULT_TIMEOUT
+      @polling = opts[:polling] || DEFAULT_POLLING
+      @failure_message = opts[:failure_message] || build_error
+    end
+
+    def for(value = nil, &block)
+      if value
+        @target = value
+      elsif block_given?
+        @target = block
+      end
+
+      self
+    end
+
+    def up_to(seconds)
+      @timeout = seconds
+      self
+    end
+
+    def every(seconds)
+      @polling = seconds
+      self
+    end
+    alias_method :polling_every, :every
+
+    def to(matcher = nil, &block)
+      WaitExpectationTarget.new(@target).to(self, matcher, &block)
     end
 
-    def wait(message=nil, &block)
+    def not_to(matcher = nil, &block)
+      WaitExpectationTarget.new(@target).not_to(self, matcher, &block)
+    end
+    alias_method :to_not, :not_to
+
+    def until(&block)
       unless @timeout > @polling
         raise ArgumentError, 'Timeout must be a higher value than polling.'
       end
 
-      @message = message || default_failure_message
+      current_timeout = @timeout
+
+      while current_timeout > 0 && current_timeout > @polling
+        trap('SIGINT') { break }
 
-      while @timeout > 0 && @timeout > @polling
         @result = begin
           block.call
+        rescue SystemExit, Interrupt
+          break
         rescue Exception => error
           @error = error
           false
@@ -80,52 +114,64 @@ module Waiter
 
         break if @result
         sleep @polling
-        @timeout = @timeout - @polling
+        current_timeout = current_timeout - @polling
       end
 
       unless @result
         if @error
-          @error.message.prepend @message
+          @error = Waiter::TimeoutError.new(build_error(@error))
         else
-          @error = RuntimeError.new @message
+          @error = Waiter::TimeoutError.new(build_error)
         end
 
         raise @error
       end
     end
 
-    alias_method :until, :wait
-
-    def every(seconds)
-      @polling = seconds
-      self
-    end
+    private
 
-    def for(seconds)
-      @timeout = seconds
-      self
+    def build_error(error = nil)
+      [
+        "Timed out after waiting for #{@timeout}s.",
+        "Polled for #{@polling}s.",
+        error
+      ].join("\n")
     end
+  end
 
-    def to(matcher=nil, message=nil, &block)
+  class WaitExpectationTarget < RSpec::Expectations::ExpectationTarget
+    def to(waiter, matcher = nil, &block)
       prevent_operator_matchers(:to) unless matcher
-      wait(message) do
-        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(target, matcher, message, &block)
+      waiter.until do
+        target = handle_target(waiter.target)
+        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(target,
+                                                                       matcher,
+                                                                       &block)
+
+        return target
       end
-      @target
     end
 
-    def not_to(matcher=nil, message=nil, &block)
+    def not_to(waiter, matcher = nil, &block)
       prevent_operator_matchers(:not_to) unless matcher
-      wait(message) do
-        RSpec::Expectations::NegativeExpectationHandler.handle_matcher(target, matcher, message, &block)
+      waiter.until do
+        target = handle_target(waiter.target)
+        RSpec::Expectations::NegativeExpectationHandler.handle_matcher(target,
+                                                                       matcher,
+                                                                       &block)
+
+        return target
       end
-      @target
     end
 
-    alias_method :to_not, :not_to
+    private
 
-    def default_failure_message
-      "Timed out after waiting for #{@timeout} seconds, polling every #{@polling} second.\n"
+    def handle_target(target)
+      if target.respond_to?(:call)
+        target.call
+      else
+        target
+      end
     end
   end
 end

data/waiter.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'rspec-expectations', '~> 3.5.0'
+
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: waiter_
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Derek McNeil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +78,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- lib/timeout_error.rb
 - lib/version.rb
 - lib/waiter.rb
 - waiter.gemspec
@@ -86,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple polling gem.