rspec-wait 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8de02581ff92b52a5e1bb18a295912344b2fc87c
+  data.tar.gz: ce87d11fd20e6b19ecd4f5792a2836c0f0e55967
+SHA512:
+  metadata.gz: 172c31ce4a7d6eb87832d2a55f4642e029ff9ab90457163a42ceef008d0080b1a8d50271df0ae1f0b826da864c50b04f45bc9c424058f12889e064ae0fbda8d2
+  data.tar.gz: bc4abe75a8f37f274e92ba924e82b85afc9bd145f92d102891cbc4a54783d64f9f09985c5b0403801d7d54254479a80698b7ce7a1b60d90737c01a8cc099ffea

data/.gitignore

@@ -0,0 +1,18 @@
+*.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

data/.travis.yml

@@ -0,0 +1,29 @@
+before_install:
+  - gem update bundler
+branches:
+  only:
+    - master
+gemfile:
+  - gemfiles/rspec_2_11.gemfile
+  - gemfiles/rspec_2_12.gemfile
+  - gemfiles/rspec_2_13.gemfile
+  - gemfiles/rspec_2_14.gemfile
+  - gemfiles/rspec_3_0.gemfile
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  include:
+    - env:
+        secure: | # CODECLIMATE_REPO_TOKEN
+          lK3tYDk/63jRamEfGKbC27mPAoV7XsebCurx6doeisv1r4926lyPY4B9ZoSu
+          OeVmjXQWHX9U7IgPH1C+zoIh1wVHVA8h5FVuqlGUMlA6IJi2xaI+ChEo3WeD
+          FRlk1Q5fGhgp1mt59sMn3GZZ/mv31v+sd9iYC3AVIM0KrlMGGZQ=
+      gemfile: Gemfile
+      rvm: "2.1"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - "2.1"
+  - ruby-head
+script: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 / 2014-04-18
+
+* Initial release!

data/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to RSpec::Wait
+
+RSpec::Wait is open source and contributions from the community are encouraged!
+No contribution is too small.
+
+Please consider:
+
+* Adding a feature
+* Squashing a bug
+* Writing documentation
+* Fixing a typo
+* Correcting [style](https://github.com/styleguide/ruby)
+
+## How do I contribute?
+
+For the best chance of having your changes merged, please:
+
+1. [Fork](https://github.com/laserlemon/rspec-wait/fork) the project.
+2. [Write](http://en.wikipedia.org/wiki/Test-driven_development) a failing test.
+3. [Commit](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) changes that fix the tests.
+4. [Submit](https://github.com/laserlemon/rspec-wait/pulls) a pull request with *at least* one animated GIF.
+5. Be patient.
+
+If your proposed changes only affect documentation, include the following on a
+new line in each of your commit messages:
+
+```
+[ci skip]
+```
+
+This will signal [Travis](https://travis-ci.org) that running the test suite is
+not necessary for these changes.
+
+## Bug Reports
+
+If you are experiencing unexpected behavior and, after having read RSpec::Wait's
+documentation, are convinced this behavior is a bug, please:
+
+1. [Search](https://github.com/laserlemon/rspec-wait/issues) existing issues.
+2. Collect enough information to reproduce the issue:
+  * RSpec::Wait version
+  * Ruby version
+  * RSpec version
+  * Specific setup conditions
+  * Description of expected behavior
+  * Description of actual behavior
+3. [Submit](https://github.com/laserlemon/rspec-wait/issues/new) an issue.
+4. Be patient.

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "codeclimate-test-reporter", require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Steve Richert
+
+MIT License
+
+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,96 @@
+# RSpec::Wait
+
+Wait for conditions in RSpec
+
+[![Gem Version](https://img.shields.io/gem/v/rspec-wait.svg)](http://badge.fury.io/rb/rspec-wait)
+[![Build Status](https://img.shields.io/travis/laserlemon/rspec-wait/master.svg)](https://travis-ci.org/laserlemon/rspec-wait)
+[![Code Climate](https://img.shields.io/codeclimate/github/laserlemon/rspec-wait.svg)](https://codeclimate.com/github/laserlemon/rspec-wait)
+[![Coverage Status](https://img.shields.io/codeclimate/coverage/github/laserlemon/rspec-wait.svg)](https://codeclimate.com/github/laserlemon/rspec-wait)
+[![Dependency Status](https://img.shields.io/gemnasium/laserlemon/rspec-wait.svg)](https://gemnasium.com/laserlemon/rspec-wait)
+
+## Why does RSpec::Wait exist?
+
+Timing is hard.
+
+Timing problems and race conditions can plague your test suite. As your test
+suite slowly becomes less reliable, development speed and quality suffer.
+
+RSpec::Wait strives to make it easier to test asynchronous or slow interactions.
+
+## How does RSpec::Wait work?
+
+RSpec::Wait allows you to wait for an assertion to pass, using the RSpec
+syntactic sugar that you already know and love.
+
+RSpec::Wait will keep trying until your assertion passes or times out.
+
+### Example
+
+RSpec::Wait's `wait_for` assertions are drop-in replacements for RSpec's
+`expect` assertions.
+
+```ruby
+describe Ticker do
+  subject(:ticker) { Ticker.new("foo") }
+
+  describe "#start" do
+    before do
+      ticker.start
+    end
+
+    it "starts a blank tape" do
+      expect(ticker.tape).to eq("")
+    end
+
+    it "writes the message one letter at a time" do
+      wait_for(ticker.tape).to eq("··-·")
+      wait_for(ticker.tape).to eq("··-· ---")
+      wait_for(ticker.tape).to eq("··-· --- ---")
+    end
+  end
+end
+```
+
+This can be especially useful for testing user interfaces with tricky timing
+elements like JavaScript interactions or remote requests.
+
+```ruby
+feature "User Login" do
+  let!(:user) { create(:user, name: "John Doe", email: "john@example.com", password: "secret") }
+
+  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_for { current_path }.to eq(account_path)
+    expect(page).to have_content("John Doe")
+  end
+end
+```
+
+### Matchers
+
+RSpec::Wait ties into RSpec's internals so it can take full advantage of any
+matcher that you would use with RSpec's own `expect` method.
+
+## Who wrote RSpec::Wait?
+
+My name is Steve Richert and I wrote RSpec::Wait in April, 2014 with the support
+of my employer, [Collective Idea](http://www.collectiveidea.com). RSpec::Wait
+owes its current and future success entirely to [inspiration](https://github.com/laserlemon/rspec-wait/issues)
+and [contribution](https://github.com/laserlemon/rspec-wait/graphs/contributors)
+from the Ruby community, especially the [authors and maintainers](https://github.com/rspec/rspec-core/graphs/contributors)
+of RSpec.
+
+**Thank you!**
+
+## How can I help?
+
+RSpec::Wait is open source and contributions from the community are encouraged!
+No contribution is too small.
+
+See RSpec::Wait's [contribution guidelines](CONTRIBUTING.md) for more
+information.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/gemfiles/rspec_2_11.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rspec", "~> 2.11.0"

data/gemfiles/rspec_2_12.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rspec", "~> 2.12.0"

data/gemfiles/rspec_2_13.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rspec", "~> 2.13.0"

data/gemfiles/rspec_2_14.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rspec", "~> 2.14.0"

data/gemfiles/rspec_3_0.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rspec", "~> 3.0.0.beta"

data/lib/rspec/wait.rb

@@ -0,0 +1,20 @@
+require "rspec"
+
+require "rspec/wait/error"
+require "rspec/wait/handler"
+require "rspec/wait/target"
+
+module RSpec
+  module Wait
+    # From: https://github.com/rspec/rspec-expectations/blob/v2.14.5/lib/rspec/expectations/syntax.rb#L83-L87
+    def wait_for(*target, &target_block)
+      target << target_block if block_given?
+      raise ArgumentError.new("You must pass an argument or a block to #wait_for but not both.") unless target.size == 1
+      Target.new(target.first)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(RSpec::Wait)
+end

data/lib/rspec/wait/error.rb

@@ -0,0 +1,7 @@
+module RSpec
+  module Wait
+    class Error < StandardError; end
+
+    class TimeoutError < Error; end
+  end
+end

data/lib/rspec/wait/handler.rb

@@ -0,0 +1,42 @@
+require "rspec"
+require "timeout"
+
+require "rspec/wait/error"
+
+module RSpec
+  module Wait
+    module Handler
+      TIMEOUT = 10
+      DELAY = 0.1
+
+      # From: https://github.com/rspec/rspec-expectations/blob/v2.14.5/lib/rspec/expectations/handler.rb#L16-L64
+      def handle_matcher(actual, *)
+        failure = nil
+
+        Timeout.timeout(TIMEOUT) do
+          loop do
+            actual = actual.call if actual.respond_to?(:call)
+
+            begin
+              super
+              break
+            rescue RSpec::Expectations::ExpectationNotMetError => failure
+              sleep DELAY
+              retry
+            end
+          end
+        end
+      rescue Timeout::Error
+        raise failure || TimeoutError
+      end
+    end
+
+    class PositiveHandler < RSpec::Expectations::PositiveExpectationHandler
+      extend Handler
+    end
+
+    class NegativeHandler < RSpec::Expectations::NegativeExpectationHandler
+      extend Handler
+    end
+  end
+end

data/lib/rspec/wait/target.rb

@@ -0,0 +1,21 @@
+require "rspec"
+
+require "rspec/wait/handler"
+
+module RSpec
+  module Wait
+    class Target < RSpec::Expectations::ExpectationTarget
+      # From: https://github.com/rspec/rspec-expectations/blob/v2.14.5/lib/rspec/expectations/expectation_target.rb#L32-L35
+      def to(matcher = nil, message = nil, &block)
+        prevent_operator_matchers(:to, matcher)
+        PositiveHandler.handle_matcher(@target, matcher, message, &block)
+      end
+
+      # From: https://github.com/rspec/rspec-expectations/blob/v2.14.5/lib/rspec/expectations/expectation_target.rb#L45-L48
+      def not_to(matcher = nil, message = nil, &block)
+        prevent_operator_matchers(:not_to, matcher)
+        NegativeHandler.handle_matcher(@target, matcher, message, &block)
+      end
+    end
+  end
+end

data/rspec-wait.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name    = "rspec-wait"
+  spec.version = "0.0.1"
+
+  spec.author      = "Steve Richert"
+  spec.email       = "steve.richert@gmail.com"
+  spec.summary     = "Wait for conditions in RSpec"
+  spec.description = spec.summary
+  spec.homepage    = "https://github.com/laserlemon/rspec-wait"
+  spec.license     = "MIT"
+
+  spec.files      = `git ls-files -z`.split("\x0")
+  spec.test_files = spec.files.grep(/^spec/)
+
+  spec.add_dependency "rspec", ">= 2.11", "< 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+if ENV["CODECLIMATE_REPO_TOKEN"]
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require "rspec/wait"
+
+Dir[File.expand_path("../support/*.rb", __FILE__)].each { |f| require f }

data/spec/support/random.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.order = "random"
+end

data/spec/wait_for_spec.rb

@@ -0,0 +1,96 @@
+require "spec_helper"
+
+describe "wait_for" do
+  let!(:progress) { "" }
+
+  before do
+    Thread.new do
+      2.times do
+        sleep 1
+        progress << "."
+      end
+    end
+  end
+
+  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 "accepts a block" do
+      expect {
+        wait_for { progress }.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 "raises an error occuring in the block" do
+      expect {
+        wait_for { raise RuntimeError }.to eq("..")
+      }.to raise_error(RuntimeError)
+    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 "accepts a block" do
+      expect {
+        wait_for { progress }.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 "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
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rspec-wait
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steve Richert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: Wait for conditions in RSpec
+email: steve.richert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rspec_2_11.gemfile
+- gemfiles/rspec_2_12.gemfile
+- gemfiles/rspec_2_13.gemfile
+- gemfiles/rspec_2_14.gemfile
+- gemfiles/rspec_3_0.gemfile
+- lib/rspec/wait.rb
+- lib/rspec/wait/error.rb
+- lib/rspec/wait/handler.rb
+- lib/rspec/wait/target.rb
+- rspec-wait.gemspec
+- spec/spec_helper.rb
+- spec/support/random.rb
+- spec/wait_for_spec.rb
+homepage: https://github.com/laserlemon/rspec-wait
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Wait for conditions in RSpec
+test_files:
+- spec/spec_helper.rb
+- spec/support/random.rb
+- spec/wait_for_spec.rb