rspec-eventually 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0572070062aed5c336c449433d973c8db9e1726
-  data.tar.gz: 4fb01d14e5b1001849134c0a0e5234a407907c39
+  metadata.gz: ac1a8c6c27ec5d59a5b7d129296693c2d21dbb89
+  data.tar.gz: dc5f9cf13500fe274b2d828047e73a930d825c3b
 SHA512:
-  metadata.gz: 3fda5e0da10d7062ba4826de7a4233616bbf20c87666da2105121974f103e51ef1352030791d9f9da2a79c4d8ced7a4c4312448b006cdf86119bb7ed9aa9ec58
-  data.tar.gz: e7ace1dd7399e3bacfbaf2a497e35dd789428d2701810ab1c09b5e9de6b8d1df71befff629e1f0f5be1e38fd6d38f5eb660e88019224870238f72567dc6f147d
+  metadata.gz: bc83c071364e151e0d1c66b13afa6ad3c68bae7bc95c0f256d34dfe18cfaa2996299dfeb899edc1b17673f33492f0faeccbaaf659e5583b4e3aa40943cef9663
+  data.tar.gz: d3c7cc383897c3f8c5cb8b3d3eefe6061e2e29e2bd4920b918461bc1b3c307834ba21bd5eb4912dfdd1b976ca8407f326b31d4b8cb69fb0ef76ce33f9d0d41fb

data/README.md

@@ -20,6 +20,9 @@ I want to be able to do something like this:
     # Change the timeout
     expect { client.get 'ZYX' }.to eventually(eq 1).within 5
 
+    # Change the pause between retries
+    expect { client.get 'ZYX' }.to eventually(eq 1).pause_for 1.5
+
   end
 ```
 

data/lib/rspec/eventually.rb

@@ -4,9 +4,10 @@ require 'rspec/core'
 module Rspec
   module Eventually
     class << self
-      attr_accessor :timeout
+      attr_accessor :timeout, :pause
     end
     self.timeout = 5
+    self.pause = 0.1
 
     class FailedMatcherError < StandardError; end
 
@@ -20,12 +21,14 @@ module Rspec
         @tries = 0
         @negative = false
         @custom_msg = custom_msg
+        @pause = pause
       end
 
       def matches?(expected_block)
         Timeout.timeout(timeout) { eventually_matches? expected_block }
       rescue Timeout::Error
-        @tries == 0 && raise('Timeout before first evaluation, use a longer `eventually` timeout')
+        @tries == 0 && raise('Timeout before first evaluation, use a longer `eventually` timeout \
+          or shorter `eventually` pause')
       end
 
       def does_not_match?
@@ -53,13 +56,17 @@ module Rspec
         tap { @timeout = timeout }
       end
 
+      def pause_for(pause)
+        tap { @pause = pause }
+      end
+
       private
 
       def eventually_matches?(expected_block)
         target_matches?(expected_block) || fail(FailedMatcherError)
       rescue => e
         if suppress_errors || e.is_a?(FailedMatcherError)
-          sleep 0.1
+          sleep pause
           @tries += 1
           retry
         else
@@ -75,6 +82,10 @@ module Rspec
       def timeout
         @timeout || Rspec::Eventually.timeout
       end
+
+      def pause
+        @pause || Rspec::Eventually.pause
+      end
     end
 
     def eventually(target, custom_msg = nil)

data/lib/rspec/eventually/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module Eventually
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/spec/eventually_spec.rb

@@ -51,6 +51,45 @@ module Rspec
         expect(took).to be_within(0.1).of 0.5
       end
 
+      it 'has a configurable default pause' do
+        begin
+          ::Rspec::Eventually.pause = 0.5
+          expect(::Rspec::Eventually.pause).to eq 0.5
+
+          matcher = Eventually.new(eq 1)
+          matcher.matches? -> { 0 }
+
+          expect(matcher.instance_variable_get('@tries')).to eq 9
+
+        ensure
+          ::Rspec::Eventually.pause = 0.1
+        end
+      end
+
+      it 'can have a specific pause' do
+        matcher = Eventually.new(eq 1)
+        matcher.pause_for(1.5).matches? -> { 0 }
+
+        expect(matcher.instance_variable_get('@tries')).to eq 3
+      end
+
+      it 'can have a specific pause and timeout' do
+        matcher = Eventually.new(eq 1)
+        matcher.pause_for(1).within(3).matches? -> { 0 }
+
+        expect(matcher.instance_variable_get('@tries')).to eq 2
+      end
+
+      it 'it will not pause when evaluation is true' do
+        before = Time.now
+        matcher = Eventually.new(eq 1)
+        matcher.pause_for(1).matches? -> { 1 }
+        took = Time.now - before
+
+        expect(matcher.instance_variable_get('@tries')).to eq 0
+        expect(took).to be < 1
+      end
+
       it 'raises errors by default' do
         block = lambda do
           Eventually.new(eq 1).matches? -> { fail 'I am throwing an error' }
@@ -98,6 +137,14 @@ module Rspec
         expect { block.call }.to raise_error(/Timeout before first evaluation/)
       end
 
+      it 'raises an error when timeout occurs before the first evaluation due to long pause' do
+        block = lambda do
+          Eventually.new(eq 1).pause_for(1).within(0.5).matches? -> { sleep 5 }
+        end
+
+        expect { block.call }.to raise_error(/Timeout before first evaluation/)
+      end
+
       it 'supports custom error messages' do
         (matcher = Eventually.new(eq(1), '0 is not within 0.5 of 1').within(0.5)).matches? -> { 0 }
         message = matcher.failure_message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-eventually
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hawk Newton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Make your matchers match eventually