rspec-eventually 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 992247ed8e9a18a6a7e7f9f29c7a280f85a47661
+  data.tar.gz: e953bbb93dacf3c94e34b094c193323a44b49c82
+SHA512:
+  metadata.gz: a71003af10bfc2782af1320b628c4bf3ed81af1ff9d2edf032b52fbcbbb9ab60f5e73522ceb25332748ea948e6bdf05a2cc7669291c3a81dd47c7f4ff555c1dc
+  data.tar.gz: 91de91764868bbbca2ccf45e2bd19c508d06ea0f6c1a54dcc8a304a50179720ca264cdba092920a4e7e5b19723bb307b131cf7a672e351accf45ba73518596fa

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format doc

data/.rubocop.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-08 10:47:58 -0800 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+#
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  Enabled: true
+  EnforcedStyle: trailing

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.9.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-eventually.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Hawk Newton
+
+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,52 @@
+[![Build Status](https://travis-ci.org/hawknewton/rspec-eventually.svg?branch=master)](https://travis-ci.org/hawknewton/rspec-eventually)
+# Rspec::Eventually
+
+I want to be able to do something like this:
+
+```ruby
+  it 'eventually matches' do
+    value = 0
+    Thread.new do
+      sleep 1
+      value = 1
+    end
+
+    expect { value }.to eventually eq 1
+    expect { value }.to eventually_not eq 0
+
+    # Ignore errors raised by the block and retry
+    expect { client.get 'ABC' }.to eventually(eq 1).by_suppressing_errors
+
+    # Change the timeout
+    expect { client.get 'ZYX' }.to eventually(eq 1).within 5
+
+  end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-eventually'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-eventually
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rspec-eventually/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/rspec/eventually/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Eventually
+    VERSION = '0.0.1'
+  end
+end

data/lib/rspec/eventually.rb

@@ -0,0 +1,90 @@
+require 'rspec/eventually/version'
+require 'rspec'
+
+module Rspec
+  module Eventually
+    class << self
+      attr_accessor :timeout
+    end
+    self.timeout = 5
+
+    class FailedMatcherError < StandardError; end
+
+    class Eventually
+      def by_suppressing_errors
+        tap { @suppress_errors = true }
+      end
+
+      def initialize(target)
+        @target = target
+        @tries = 0
+        @negative = false
+      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')
+      end
+
+      def does_not_match?
+        fail 'Use eventually_not instead of expect(...).to_not'
+      end
+
+      def failure_message
+        "After #{@tries} tries, the last failure message was:\n#{@target.failure_message}"
+      end
+
+      def not
+        tap { @negative = true }
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      def suppress_errors
+        @suppress_errors || false
+      end
+
+      def within(timeout)
+        tap { @timeout = timeout }
+      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
+          @tries += 1
+          retry
+        else
+          raise
+        end
+      end
+
+      def target_matches?(expected_block)
+        result = @target.matches? expected_block.call
+        @negative ? !result : result
+      end
+
+      def timeout
+        @timeout || Rspec::Eventually.timeout
+      end
+    end
+
+    def eventually(target)
+      Eventually.new target
+    end
+
+    def eventually_not(target)
+      Eventually.new(target).not
+    end
+
+    RSpec.configure do |config|
+      config.include ::Rspec::Eventually
+    end
+  end
+end

data/rspec-eventually.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/eventually/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-eventually'
+  spec.version       = Rspec::Eventually::VERSION
+  spec.authors       = ['Hawk Newton']
+  spec.email         = ['hawk.newton@gmail.com']
+  spec.summary       = 'Make your matchers match eventually'
+  spec.description   = 'Enhances rspec DSL to include `eventually` and `eventually_not`'
+  spec.homepage      = 'https://github.com/hawknewton/rspec-eventually'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.27.1'
+end

data/spec/eventually_spec.rb

@@ -0,0 +1,102 @@
+module Rspec
+  module Eventually
+    describe Eventually do
+
+      it 'eventually matches' do
+        value = 0
+        Thread.new do
+          sleep 0.5
+          value = 1
+        end
+
+        expect(Eventually.new(eq 1).matches? -> { value }).to be true
+      end
+
+      it 'eventually_not matches' do
+        value = 0
+        Thread.new do
+          sleep 0.5
+          value = 1
+        end
+
+        expect(Eventually.new(eq 0).not.matches? -> { value }).to be true
+      end
+
+      it 'eventually fails' do
+        expect(Eventually.new(eq 1).matches? -> { 0 }).to be false
+      end
+
+      it 'eventually_not fails' do
+        expect(Eventually.new(eq 1).not.matches? -> { 1 }).to be false
+      end
+
+      it 'has a configurable default timeout' do
+        begin
+          ::Rspec::Eventually.timeout = 1
+          expect(::Rspec::Eventually.timeout).to eq 1
+
+          before = Time.now
+          Eventually.new(eq 1).matches? -> { 0 }
+          took = Time.now - before
+          expect(took).to be_within(0.5).of 1
+        ensure
+          ::Rspec::Eventually.timeout = 5
+        end
+      end
+
+      it 'can have a specific timeout' do
+        before = Time.now
+        Eventually.new(eq 1).within(0.5).matches? -> { 0 }
+        took = Time.now - before
+        expect(took).to be_within(0.1).of 0.5
+      end
+
+      it 'raises errors by default' do
+        block = lambda do
+          Eventually.new(eq 1).matches? -> { fail 'I am throwing an error' }
+        end
+
+        expect { block.call }.to raise_error(/I am throwing an error/)
+      end
+
+      it 'can suppress errors' do
+        first = false
+        block = lambda do
+
+          one_eventually = lambda do
+            if first
+              first = false
+              fail 'I am throwing an error'
+            end
+            1
+          end
+
+          Eventually.new(eq 1).by_suppressing_errors.matches? one_eventually
+        end
+
+        expect { block.call }.to_not raise_error
+        expect(block.call).to be true
+      end
+
+      it 'produces a coherent failure message' do
+        (matcher = Eventually.new(eq 1).within(0.5)).matches? -> { 0 }
+        message = matcher.failure_message
+        expect(message).to match(/After [0-9]+ tries, the last failure message was/)
+        expect(message).to match(/expected: 1/)
+        expect(message).to match(/got: 0/)
+      end
+
+      it 'raises an error when negated' do
+        expect { Eventually.new(eq 1).does_not_match? }.to raise_error(/Use eventually_not/)
+      end
+
+      it 'raises an error when timeout occurs before the first evaluation' do
+        block = lambda do
+          Eventually.new(eq 1).within(0.5).matches? -> { sleep 5 }
+        end
+
+        expect { block.call }.to raise_error(/Timeout before first evaluation/)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'rspec/eventually'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rspec-eventually
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hawk Newton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+description: Enhances rspec DSL to include `eventually` and `eventually_not`
+email:
+- hawk.newton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/eventually.rb
+- lib/rspec/eventually/version.rb
+- rspec-eventually.gemspec
+- spec/eventually_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hawknewton/rspec-eventually
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Make your matchers match eventually
+test_files:
+- spec/eventually_spec.rb
+- spec/spec_helper.rb