rspec-wait 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19bcbef8a8f87e6d9eb2d9f827bbb8482339bd62
-  data.tar.gz: 84dbbd7b44d2df67ce8008ca2a081f9f2b9b3325
+  metadata.gz: cc0b285ada9260eb2da497cdc35c42d3972cb9ac
+  data.tar.gz: 1be11677f7c1f5206dd81fe964abaf1c87d36408
 SHA512:
-  metadata.gz: 390f1c7d712b747322ee45c71ca0fad89e34a9dd2eeb19472b4e378aa63773b5705d7a487549ec6a00a2d2880aa64d009b4445d787ca14afa5da99f2e3c07a4e
-  data.tar.gz: 06f7b337e642e87f7be0bdc525e72bd730333efa5ddc7f9991efdc3b928dc56814d1240b1a22b7ab02e79e1df21118abb7e2de1920d148775abed301332293d2
+  metadata.gz: 20d945d658cd08fc1c8429a94972111c61e33a02221fff55182bd6aa90820a7ef921b96e012c3918113f50422a411fa3bf54fcdc5e429b848edff294825ecbe1
+  data.tar.gz: ae7062b3a49ae41c62cba4dd79628303db9831d86492f38c2bf6ca362b6db7b1c8848a2978846dd77f8c1b85bf1b6b9984a343fe5bc82794e8f9d40dd4572986

data/.gitignore

@@ -1,18 +1,15 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-gemfiles/*.lock
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/gemfiles/*.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -1,3 +1,4 @@
 --color
---format=documentation
---order=random
+--format documentation
+--order random
+--require spec_helper

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.0.4 / 2014-12-18
+
+* [FEATURE] Make RSpec::Wait's timeout and delay values configurable
+* [FEATURE] Add the wait(3.seconds).for { something }.to(happen) syntax sugar
+
+## 0.0.3 / 2014-10-29
+
+* [ENHANCEMENT] Add support for RSpec 3.2
+
 ## 0.0.2 / 2014-06-11
 
 * [ENHANCEMENT] Allow `wait_for` to accept either a value or block target

data/README.md

@@ -79,6 +79,54 @@ end
 RSpec::Wait ties into RSpec's internals so it can take full advantage of any
 non-block matcher that you would use with RSpec's own `expect` method.
 
+### Timeout
+
+By default, RSpec::Wait will wait up to 10 seconds for an assertion to pass.
+That timeout value is configurable in three ways:
+
+#### RSpec Configuration
+
+```ruby
+RSpec.configure do |config|
+  config.wait_timeout = 3 # seconds
+end
+```
+
+#### RSpec Metadata
+
+The timeout can also be specified via options added to a spec's or context's
+`:wait` metadata:
+
+```ruby
+scenario "A user can log in successfully", wait: { timeout: 3 } do
+  visit new_session_path
+
+  fill_in "Email", with: "john@example.com"
+  fill_in "Password", with: "secret"
+  click_button "Log In"
+
+  wait_for { current_path }.to eq(account_path)
+  expect(page).to have_content("Welcome back!")
+end
+```
+
+#### The `wait` Method
+
+On a per-assertion basis, the timeout value can be passed to the `wait` method.
+
+```ruby
+scenario "A user can log in successfully" do
+  visit new_session_path
+
+  fill_in "Email", with: "john@example.com"
+  fill_in "Password", with: "secret"
+  click_button "Log In"
+
+  wait(3.seconds).for { current_path }.to eq(account_path)
+  expect(page).to have_content("Welcome back!")
+end
+```
+
 ## Who wrote RSpec::Wait?
 
 My name is Steve Richert and I wrote RSpec::Wait in April, 2014 with the support

data/lib/rspec/wait.rb

@@ -1,18 +1,49 @@
 require "rspec"
-
 require "rspec/wait/error"
 require "rspec/wait/handler"
+require "rspec/wait/proxy"
 require "rspec/wait/target"
 
 module RSpec
   module Wait
+    module_function
+
     # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/syntax.rb#L72-L74
     def wait_for(value = Target::UndefinedValue, &block)
       Target.for(value, block)
     end
+
+    def wait(timeout = nil, options = {})
+      options[:timeout] = timeout
+      Proxy.new(options)
+    end
+
+    def with_wait(options)
+      original_timeout = RSpec.configuration.wait_timeout
+      original_delay = RSpec.configuration.wait_delay
+
+      RSpec.configuration.wait_timeout = options[:timeout] if options[:timeout]
+      RSpec.configuration.wait_delay = options[:delay] if options[:delay]
+
+      yield
+    ensure
+      RSpec.configuration.wait_timeout = original_timeout
+      RSpec.configuration.wait_delay = original_delay
+    end
   end
 end
 
 RSpec.configure do |config|
   config.include(RSpec::Wait)
+
+  config.add_setting(:wait_timeout, default: 10)
+  config.add_setting(:wait_delay, default: 0.1)
+
+  config.around do |example|
+    if options = example.metadata[:wait]
+      with_wait(options) { example.run }
+    else
+      example.run
+    end
+  end
 end

data/lib/rspec/wait/handler.rb

@@ -1,25 +1,19 @@
-require "rspec"
 require "timeout"
 
-require "rspec/wait/error"
-
 module RSpec
   module Wait
     module Handler
-      TIMEOUT = 10
-      DELAY = 0.1
-
       def handle_matcher(target, *args, &block)
         failure = nil
 
-        Timeout.timeout(TIMEOUT) do
+        Timeout.timeout(RSpec.configuration.wait_timeout) do
           loop do
             begin
               actual = target.respond_to?(:call) ? target.call : target
               super(actual, *args, &block)
               break
             rescue RSpec::Expectations::ExpectationNotMetError => failure
-              sleep DELAY
+              sleep RSpec.configuration.wait_delay
               retry
             end
           end

data/lib/rspec/wait/proxy.rb

@@ -0,0 +1,13 @@
+module RSpec
+  module Wait
+    class Proxy
+      def initialize(options)
+        @options = options
+      end
+
+      def for(value = Target::UndefinedValue, &block)
+        Target.for(value, block, @options)
+      end
+    end
+  end
+end

data/lib/rspec/wait/target.rb

@@ -1,7 +1,3 @@
-require "rspec"
-
-require "rspec/wait/handler"
-
 module RSpec
   module Wait
     class Target < RSpec::Expectations::ExpectationTarget
@@ -9,30 +5,41 @@ module RSpec
       UndefinedValue = Module.new
 
       # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/expectation_target.rb#L30-L41
-      def self.for(value, block)
+      def self.for(value, block, options = {})
         if UndefinedValue.equal?(value)
           unless block
             raise ArgumentError, "You must pass either an argument or a block to `wait_for`."
           end
-          new(block)
+          new(block, options)
         elsif block
           raise ArgumentError, "You cannot pass both an argument and a block to `wait_for`."
         else
-          new(value)
+          new(value, options)
         end
       end
-      #
-      #
+
+      # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/expectation_target.rb#L25-L27
+      def initialize(target, options)
+        @wait_options = options
+        super(target)
+      end
+
       # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/expectation_target.rb#L53-L54
       def to(matcher = nil, message = nil, &block)
         prevent_operator_matchers(:to, matcher) unless matcher
-        PositiveHandler.handle_matcher(@target, matcher, message, &block)
+        with_wait { PositiveHandler.handle_matcher(@target, matcher, message, &block) }
       end
 
       # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/expectation_target.rb#L66-L67
       def not_to(matcher = nil, message = nil, &block)
         prevent_operator_matchers(:not_to, matcher) unless matcher
-        NegativeHandler.handle_matcher(@target, matcher, message, &block)
+        with_wait { NegativeHandler.handle_matcher(@target, matcher, message, &block) }
+      end
+
+      private
+
+      def with_wait
+        Wait.with_wait(@wait_options) { yield }
       end
     end
   end

data/rspec-wait.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name    = "rspec-wait"
-  spec.version = "0.0.3"
+  spec.version = "0.0.4"
 
   spec.author      = "Steve Richert"
   spec.email       = "steve.richert@gmail.com"
@@ -17,5 +17,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rspec", ">= 2.11", "< 3.2"
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rake", "~> 10.4"
 end

data/spec/wait_for_spec.rb

@@ -1,5 +1,3 @@
-require "spec_helper"
-
 describe "wait_for" do
   let!(:progress) { "" }
 
@@ -43,6 +41,25 @@ describe "wait_for" do
       }.to raise_error(RSpec::Wait::TimeoutError)
     end
 
+    it "respects a timeout specified in configuration" do
+      original_timeout = RSpec.configuration.wait_timeout
+      RSpec.configuration.wait_timeout = 3
+
+      begin
+        expect {
+          wait_for { sleep 4; progress }.to eq("..")
+        }.to raise_error(RSpec::Wait::TimeoutError)
+      ensure
+        RSpec.configuration.wait_timeout = original_timeout
+      end
+    end
+
+    it "respects a timeout specified in options", wait: { timeout: 3 } do
+      expect {
+        wait_for { sleep 4; progress }.to eq("..")
+      }.to raise_error(RSpec::Wait::TimeoutError)
+    end
+
     it "raises an error occuring in the block" do
       expect {
         wait_for { raise RuntimeError }.to eq("..")
@@ -93,6 +110,25 @@ describe "wait_for" do
       }.to raise_error(RSpec::Wait::TimeoutError)
     end
 
+    it "respects a timeout specified in configuration" do
+      original_timeout = RSpec.configuration.wait_timeout
+      RSpec.configuration.wait_timeout = 3
+
+      begin
+        expect {
+          wait_for { sleep 4; progress }.not_to eq("..")
+        }.to raise_error(RSpec::Wait::TimeoutError)
+      ensure
+        RSpec.configuration.wait_timeout = original_timeout
+      end
+    end
+
+    it "respects a timeout specified in options", wait: { timeout: 3 } do
+      expect {
+        wait_for { sleep 4; progress }.not_to eq("..")
+      }.to raise_error(RSpec::Wait::TimeoutError)
+    end
+
     it "raises an error occuring in the block" do
       expect {
         wait_for { raise RuntimeError }.not_to eq("")

data/spec/wait_spec.rb

@@ -0,0 +1,170 @@
+describe "wait" do
+  let!(:progress) { "" }
+
+  before do
+    Thread.new do
+      2.times do
+        sleep 1
+        progress << "."
+      end
+    end
+  end
+
+  context "for" do
+    context "to" do
+      it "passes immediately" do
+        expect {
+          wait.for { progress }.to eq("")
+        }.not_to raise_error
+      end
+
+      it "waits for the matcher to pass" do
+        expect {
+          wait.for { progress }.to eq(".")
+        }.not_to raise_error
+      end
+
+      it "re-evaluates the actual value" do
+        expect {
+          wait.for { progress.dup }.to eq(".")
+        }.not_to raise_error
+      end
+
+      it "fails if the matcher never passes" do
+        expect {
+          wait.for { progress }.to eq("...")
+        }.to raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+
+      it "times out if the block never finishes" do
+        expect {
+          wait.for { sleep 11; progress }.to eq("..")
+        }.to raise_error(RSpec::Wait::TimeoutError)
+      end
+
+      it "respects a timeout specified in configuration" do
+        original_timeout = RSpec.configuration.wait_timeout
+        RSpec.configuration.wait_timeout = 3
+
+        begin
+          expect {
+            wait.for { sleep 4; progress }.to eq("..")
+          }.to raise_error(RSpec::Wait::TimeoutError)
+        ensure
+          RSpec.configuration.wait_timeout = original_timeout
+        end
+      end
+
+      it "respects a timeout specified in options", wait: { timeout: 3 } do
+        expect {
+          wait.for { sleep 4; progress }.to eq("..")
+        }.to raise_error(RSpec::Wait::TimeoutError)
+      end
+
+      it "respects a timeout specified as an argument" do
+        expect {
+          wait(3).for { sleep 4; progress }.to eq("..")
+        }.to raise_error(RSpec::Wait::TimeoutError)
+      end
+
+      it "raises an error occuring in the block" do
+        expect {
+          wait.for { raise RuntimeError }.to eq("..")
+        }.to raise_error(RuntimeError)
+      end
+
+      it "prevents operator matchers" do
+        expect {
+          wait.for { progress }.to == "."
+        }.to raise_error(ArgumentError)
+      end
+
+      it "accepts a value rather than a block" do
+        expect {
+          wait.for(progress).to eq(".")
+        }.not_to raise_error
+      end
+    end
+
+    context "not_to" do
+      it "passes immediately" do
+        expect {
+          wait.for { progress }.not_to eq("..")
+        }.not_to raise_error
+      end
+
+      it "waits for the matcher not to pass" do
+        expect {
+          wait.for { progress }.not_to eq("")
+        }.not_to raise_error
+      end
+
+      it "re-evaluates the actual value" do
+        expect {
+          wait.for { progress.dup }.not_to eq("")
+        }.not_to raise_error
+      end
+
+      it "fails if the matcher always passes" do
+        expect {
+          wait.for { progress }.not_to be_a(String)
+        }.to raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+
+      it "times out if the block never finishes" do
+        expect {
+          wait.for { sleep 11; progress }.not_to eq("..")
+        }.to raise_error(RSpec::Wait::TimeoutError)
+      end
+
+      it "respects a timeout specified in configuration" do
+        original_timeout = RSpec.configuration.wait_timeout
+        RSpec.configuration.wait_timeout = 3
+
+        begin
+          expect {
+            wait.for { sleep 4; progress }.not_to eq("..")
+          }.to raise_error(RSpec::Wait::TimeoutError)
+        ensure
+          RSpec.configuration.wait_timeout = original_timeout
+        end
+      end
+
+      it "respects a timeout specified in options", wait: { timeout: 3 } do
+        expect {
+          wait.for { sleep 4; progress }.not_to eq("..")
+        }.to raise_error(RSpec::Wait::TimeoutError)
+      end
+
+      it "respects a timeout specified as an argument" do
+        expect {
+          wait(3).for { sleep 4; progress }.not_to eq("..")
+        }.to raise_error(RSpec::Wait::TimeoutError)
+      end
+
+      it "raises an error occuring in the block" do
+        expect {
+          wait.for { raise RuntimeError }.not_to eq("")
+        }.to raise_error(RuntimeError)
+      end
+
+      it "respects the to_not alias" do
+        expect {
+          wait.for { progress }.to_not eq("..")
+        }.not_to raise_error
+      end
+
+      it "prevents operator matchers" do
+        expect {
+          wait.for { progress }.not_to == ".."
+        }.to raise_error(ArgumentError)
+      end
+
+      it "accepts a value rather than a block" do
+        expect {
+          wait.for(progress).not_to eq("..")
+        }.not_to raise_error
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-wait
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Steve Richert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10.4'
 description: Wait for conditions in RSpec
 email: steve.richert@gmail.com
 executables: []
@@ -82,10 +82,12 @@ files:
 - lib/rspec/wait.rb
 - lib/rspec/wait/error.rb
 - lib/rspec/wait/handler.rb
+- lib/rspec/wait/proxy.rb
 - lib/rspec/wait/target.rb
 - rspec-wait.gemspec
 - spec/spec_helper.rb
 - spec/wait_for_spec.rb
+- spec/wait_spec.rb
 homepage: https://github.com/laserlemon/rspec-wait
 licenses:
 - MIT
@@ -106,10 +108,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Wait for conditions in RSpec
 test_files:
 - spec/spec_helper.rb
 - spec/wait_for_spec.rb
+- spec/wait_spec.rb