rspec-wait 0.0.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f26caeca0b3d18669805db3143077ac97f408e129fbd36c2bc8d5dac9bb709
-  data.tar.gz: b7a60846e5c5459e75acb628f10e8daaf2a1276fbb15956d32a90dc64f9b5474
+  metadata.gz: d1e5feca07bca8e8ce594d6d548a4b4cd898e2366ce601c28ec6ddd152a47a01
+  data.tar.gz: eeab28ab6433f33f3c33eb83f2b1b086a403ae988950af63a4d963b595c76b63
 SHA512:
-  metadata.gz: a8ff555f454d246bb4412ba9197e3bd3ddde4609cfe82d1fc0bff50578f9fe86e756b23fd208fa914da4dba49e7cb72cf307d9be334317a88b1833eb3313ab84
-  data.tar.gz: 8ad28a71663a471032f65912731c3081bc96c84007385354312931595d126db14c9da0bf2139a63d8ec3f3eb707b495efb57932d681db949c0ac4eaa942e7c87
+  metadata.gz: f23e94176e14b0d5e03794e79f25cfc721a83cfd1f097c4902dea2a90974184fa9beefe4c4c2c1c7528c9a0a19bb38872421982c1bb98cfb9505d6ddf34c0373
+  data.tar.gz: 51cbbf77176c670bae9d7446cdfb2e90813f11ca4bd7de31608228197d7ba4bc2e0d6398a987da0f4342cbcd6791e9d7e09ef4f81e2ac2a338dd45957c715e89

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2014 Steve Richert
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2014 Steve Richert
 
-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:
+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 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.
+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

@@ -2,11 +2,9 @@
 
 Wait for conditions in RSpec
 
-[![Gem Version](https://img.shields.io/gem/v/rspec-wait.svg?style=flat-square)](https://rubygems.org/gems/rspec-wait)
-[![Build Status](https://img.shields.io/travis/laserlemon/rspec-wait/master.svg?style=flat-square)](https://travis-ci.org/laserlemon/rspec-wait)
-[![Code Climate](https://img.shields.io/codeclimate/github/laserlemon/rspec-wait.svg?style=flat-square)](https://codeclimate.com/github/laserlemon/rspec-wait)
-[![Coverage Status](https://img.shields.io/codeclimate/coverage/github/laserlemon/rspec-wait.svg?style=flat-square)](https://codeclimate.com/github/laserlemon/rspec-wait)
-[![Dependency Status](https://img.shields.io/gemnasium/laserlemon/rspec-wait.svg?style=flat-square)](https://gemnasium.com/laserlemon/rspec-wait)
+[![Gem Version](https://img.shields.io/gem/v/rspec-wait)](http://rubygems.org/gems/rspec-wait)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/laserlemon/rspec-wait/rake.yml)](https://github.com/laserlemon/rspec-wait/actions/workflows/rake.yml)
+[![License](https://img.shields.io/github/license/laserlemon/rspec-wait)](https://github.com/laserlemon/rspec-wait/blob/-/LICENSE.txt)
 
 ## Why does RSpec::Wait exist?
 
@@ -24,16 +22,15 @@ syntactic sugar that you already know and love.
 
 RSpec::Wait will keep trying until your assertion passes or times out.
 
-### Example
+### Examples
 
 RSpec::Wait's `wait_for` assertions are nearly drop-in replacements for RSpec's
-`expect` assertions. The major difference is that the `wait_for` method only
-works with non-block matchers. However, `wait_for` will still accept a block
-because it may need to evaluate the content of that block multiple times while
-waiting.
+`expect` assertions. The major difference is that the `wait_for` method
+requires a block because it may need to evaluate the content of that block
+multiple times while it's waiting.
 
 ```ruby
-describe Ticker do
+RSpec.describe Ticker do
   subject(:ticker) { Ticker.new("foo") }
 
   describe "#start" do
@@ -41,21 +38,21 @@ describe Ticker do
       ticker.start
     end
 
-    it "starts a blank tape" do
+    it "starts with 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("··-· --- ---")
+    it "sends the message in Morse code 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.
+RSpec::Wait can be especially useful for testing user interfaces with tricky
+timing elements like JavaScript interactions or remote requests.
 
 ```ruby
 feature "User Login" do
@@ -74,31 +71,117 @@ feature "User Login" do
 end
 ```
 
+## Compatibility
+
+### Ruby Support
+
+RSpec::Wait is tested against all [non-EOL Ruby versions](https://www.ruby-lang.org/en/downloads/branches/),
+which as of this writing are versions 3.1, 3.2, and 3.3. If you find that
+RSpec::Wait does not work or [is not tested](https://github.com/laserlemon/rspec-wait/blob/-/.github/workflows/rake.yml)
+for a maintained Ruby version, please [open an issue](https://github.com/laserlemon/rspec-wait/issues/new)
+or pull request to add support.
+
+Additionally, RSpec::Wait is tested against Ruby head to surface future
+compatibility issues, but no guarantees are made that RSpec::Wait will
+function as expected on Ruby head. Proceed with caution!
+
+### RSpec Support
+
+RSpec::Wait is tested against several [versions of RSpec](https://rubygems.org/gems/rspec/versions),
+which as of this writing are versions 3.4 through 3.13. If you find that
+RSpec::Wait does not work or [is not tested](https://github.com/laserlemon/rspec-wait/blob/-/.github/workflows/rake.yml)
+for a newer RSpec version, please [open an issue](https://github.com/laserlemon/rspec-wait/issues/new)
+or pull request to add support.
+
+Additionally, RSpec::Wait is tested against unbounded RSpec to surface future
+compatibility issues, but no guarantees are made that RSpec::Wait will
+function as expected on any RSpec version that's not explicitly [tested](https://github.com/laserlemon/rspec-wait/blob/-/.github/workflows/rake.yml).
+Proceed with caution!
+
 ### Matchers
 
 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.
+matcher that you would use with RSpec's own `expect` method.
 
-### Timeout
+If you discover a matcher that works with `expect` but not with `wait_for`,
+please [open an issue](https://github.com/laserlemon/rspec-wait/issues/new)
+and I'd be happy to take a look!
 
-By default, RSpec::Wait will wait up to 10 seconds for an assertion to pass.
-That timeout value is configurable in three ways:
+## Installation
 
-#### RSpec Configuration
+To get started with RSpec::Wait, simply add the dependency to your `Gemfile`
+and `bundle install`:
+
+```ruby
+gem "rspec-wait", "~> 1.0"
+```
+
+If your codebase calls `Bundler.require` at boot time, you're all set and the
+`wait_for` method is already available in your RSpec suite.
+
+If you encounter the following error:
+
+```
+NoMethodError:
+  undefined method `wait_for'
+```
+
+You will need to explicitly require RSpec::Wait at boot time in your test
+environment:
+
+```ruby
+require "rspec/wait"
+```
+
+### Upgrading from v0
+
+RSpec::Wait v1 is very similar in syntax to v0 but does have a few breaking
+changes that you should be aware of when upgrading from any 0.x version:
+
+1. RSpec::Wait v1 requires Ruby 3.0 or greater and RSpec 3.4 or greater.
+2. The `wait_for` and `wait.for` methods no longer accept arguments, only
+   blocks.
+3. RSpec::Wait no longer uses Ruby's problematic `Timeout.timeout` method,
+   which means it will no longer raise a `RSpec::Wait::TimeoutError`.
+   RSpec::Wait v1 never interrupts the block given to `wait_for` mid-call
+   so make every effort to reasonably limit the block's individual call time.
+
+## Configuration
+
+RSpec::Wait has three available configuration values:
+
+- `wait_timeout` - The maximum amount of time (in seconds) that RSpec::Wait
+  will continue to retry a failing assertion. Default: `10.0`
+- `wait_delay` - How long (in seconds) RSpec::Wait will pause between retries.
+  Default: `0.1`
+- `clone_wait_matcher` - Whether each retry will `clone` the given RSpec
+  matcher instance for each evaluation. Set to `true` if you have trouble with
+  a matcher holding onto stale state. Default: `false`
+
+RSpec::Wait configurations can be set in three ways:
+
+- Globally via `RSpec.configure`
+- Per example or context via RSpec metadata
+- Per assertion via the `wait` method
+
+### Global Configuration
 
 ```ruby
 RSpec.configure do |config|
   config.wait_timeout = 3 # seconds
+  config.wait_delay = 0.5 # seconds
+  config.clone_wait_matcher = true
 end
 ```
 
-#### RSpec Metadata
+### RSpec Metadata
 
-The timeout can also be specified via options added to a spec's or context's
-`:wait` metadata:
+Any of RSpec::Wait's three configurations can be set on a per-example or
+per-context basis using `wait` metadata. Provide a hash containing any
+number of shorthand keys and values for RSpec::Wait's configurations.
 
 ```ruby
-scenario "A user can log in successfully", wait: { timeout: 3 } do
+scenario "A user can log in successfully", wait: { timeout: 3, delay: 0.5, clone_wait_matcher: true } do
   visit new_session_path
 
   fill_in "Email", with: "john@example.com"
@@ -110,9 +193,12 @@ scenario "A user can log in successfully", wait: { timeout: 3 } do
 end
 ```
 
-#### The `wait` Method
+### The `wait` Method
 
-On a per-assertion basis, the timeout value can be passed to the `wait` method.
+And on a per-assertion basis, the `wait` method accepts a hash of shorthand
+keys and values for RSpec::Wait's configurations. The `wait` method must be
+chained to the `for` method and aside from the ability to set RSpec::Wait
+configuration for the single assertion, it behaves identically to `wait_for`.
 
 ```ruby
 scenario "A user can log in successfully" do
@@ -122,12 +208,47 @@ scenario "A user can log in successfully" do
   fill_in "Password", with: "secret"
   click_button "Log In"
 
-  wait(3.seconds).for { current_path }.to eq(account_path)
+  wait(timeout: 3).for { current_path }.to eq(account_path)
   expect(page).to have_content("Welcome back!")
 end
 ```
 
-### Use with Cucumber
+The `wait` method will also accept `timeout` as a positional argument for
+improved readability:
+
+```ruby
+wait(3.seconds).for { current_path }.to eq(account_path)
+```
+
+## Use with RuboCop
+
+If you use `rubocop` and `rubocop-rspec` in your codebase, an RSpec example
+with a single `wait_for` assertion may cause RuboCop to complain:
+
+```
+RSpec/NoExpectationExample: No expectation found in this example.
+```
+
+By default, RuboCop sees only `expect*` and `assert*` methods as expectations.
+You can configure RuboCop to recognize `wait_for` and `wait.for` as
+expectations (in addition to the defaults) in your RuboCop configuration:
+
+```yaml
+RSpec/NoExpectationExample:
+  AllowedPatterns:
+  - ^assert_
+  - ^expect_
+  - ^wait(_for)?$
+```
+
+Of course, you can always disable this cop entirely:
+
+```yaml
+RSpec/NoExpectationExample:
+  Enabled: false
+```
+
+## Use with Cucumber
 
 To enable RSpec::Wait in your Cucumber step definitions, add the following to
 `features/support/env.rb`:
@@ -147,7 +268,7 @@ 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!**
+**Thank you!** :yellow_heart:
 
 ## How can I help?
 
@@ -156,3 +277,6 @@ No contribution is too small.
 
 See RSpec::Wait's [contribution guidelines](CONTRIBUTING.md) for more
 information.
+
+If you're enjoying RSpec::Wait, please consider [sponsoring](https://github.com/sponsors/laserlemon)
+my [open source work](https://github.com/laserlemon)! :green_heart:

data/lib/rspec/wait/handler.rb

@@ -1,31 +1,42 @@
-require "timeout"
+# frozen_string_literal: true
 
 module RSpec
   module Wait
+    # The RSpec::Wait::Handler module is common functionality shared between
+    # the RSpec::Wait::PositiveHandler and RSpec::Wait::NegativeHandler classes
+    # defined below. The module overrides RSpec's handle_matcher method,
+    # allowing a block target to be repeatedly evaluated until the underlying
+    # matcher passes or the configured timeout elapses.
     module Handler
-      def handle_matcher(target, *args, &block)
-        failure = nil
+      def handle_matcher(target, initial_matcher, message, &block)
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
-        Timeout.timeout(RSpec.configuration.wait_timeout) do
-          begin
-            actual = target.respond_to?(:call) ? target.call : target
-            super(actual, *args, &block)
-          rescue RSpec::Expectations::ExpectationNotMetError => failure
-            sleep RSpec.configuration.wait_delay
-            retry
+        begin
+          matcher = RSpec.configuration.clone_wait_matcher ? initial_matcher.clone : initial_matcher
+
+          if matcher.supports_block_expectations?
+            super(target, matcher, message, &block)
+          else
+            super(target.call, matcher, message, &block)
           end
+        rescue RSpec::Expectations::ExpectationNotMetError
+          raise if RSpec.world.wants_to_quit
+
+          elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
+          raise if elapsed_time > RSpec.configuration.wait_timeout
+
+          sleep RSpec.configuration.wait_delay
+          retry
         end
-      rescue Timeout::Error
-        raise failure || TimeoutError
       end
     end
 
-    # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/handler.rb#L44-L63
+    # From: https://github.com/rspec/rspec-expectations/blob/v3.4.0/lib/rspec/expectations/handler.rb#L46-L65
     class PositiveHandler < RSpec::Expectations::PositiveExpectationHandler
       extend Handler
     end
 
-    # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/handler.rb#L66-L93
+    # From: https://github.com/rspec/rspec-expectations/blob/v3.4.0/lib/rspec/expectations/handler.rb#L68-L95
     class NegativeHandler < RSpec::Expectations::NegativeExpectationHandler
       extend Handler
     end

data/lib/rspec/wait/proxy.rb

@@ -1,12 +1,24 @@
+# frozen_string_literal: true
+
 module RSpec
   module Wait
+    # The RSpec::Wait::Proxy class is capable of creating a small container
+    # object for RSpec::Wait options, returned by the top-level wait method,
+    # which allows chaining wait and for methods for more expectations that
+    # read more naturally, like:
+    #
+    #   wait(3.seconds).for { this }.to eq(that)
+    #
     class Proxy
-      def initialize(options)
+      def initialize(**options)
         @options = options
       end
 
-      def for(value = Target::UndefinedValue, &block)
-        Target.for(value, block, @options)
+      def for(*args, &block)
+        raise ArgumentError, "The `wait.for` method only accepts a block." if args.any?
+        raise ArgumentError, "The `wait.for` method requires a block." unless block
+
+        Target.new(block, @options)
       end
     end
   end

data/lib/rspec/wait/target.rb

@@ -1,41 +1,30 @@
+# frozen_string_literal: true
+
 module RSpec
   module Wait
+    # The RSpec::Wait::Target class inherits from RSpec's internal
+    # RSpec::Expectations::ExpectationTarget class and allows the inclusion of
+    # RSpec::Wait options via RSpec::Wait::Proxy.
     class Target < RSpec::Expectations::ExpectationTarget
-      # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/expectation_target.rb#L22
-      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, options = {})
-        if UndefinedValue.equal?(value)
-          raise ArgumentError, "You must pass either an argument or a block to `wait_for`." unless block
-
-          new(block, options)
-        elsif block
-          raise ArgumentError, "You cannot pass both an argument and a block to `wait_for`."
-        else
-          warn "[DEPRECATION] As of rspec-wait version 1.0, " \
-            "neither wait_for nor wait.for will accept an argument, only a block."
-          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)
+      # From: https://github.com/rspec/rspec-expectations/blob/v3.4.0/lib/rspec/expectations/expectation_target.rb#L25-L27
+      def initialize(block, options = {})
         @wait_options = options
-        super(target)
+        super(block)
       end
 
-      # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/expectation_target.rb#L53-L54
+      # From: https://github.com/rspec/rspec-expectations/blob/v3.4.0/lib/rspec/expectations/expectation_target.rb#L52-L55
       def to(matcher = nil, message = nil, &block)
         prevent_operator_matchers(:to) unless matcher
+
         with_wait do
           PositiveHandler.handle_matcher(@target, matcher, message, &block)
         end
       end
 
-      # From: https://github.com/rspec/rspec-expectations/blob/v3.0.0/lib/rspec/expectations/expectation_target.rb#L66-L67
+      # From: https://github.com/rspec/rspec-expectations/blob/v3.4.0/lib/rspec/expectations/expectation_target.rb#L65-L68
       def not_to(matcher = nil, message = nil, &block)
         prevent_operator_matchers(:not_to) unless matcher
+
         with_wait do
           NegativeHandler.handle_matcher(@target, matcher, message, &block)
         end
@@ -46,7 +35,7 @@ module RSpec
       private
 
       def with_wait(&block)
-        Wait.with_wait(@wait_options, &block)
+        Wait.with_wait(**@wait_options, &block)
       end
     end
   end

data/lib/rspec/wait/version.rb

@@ -1,9 +1,7 @@
+# frozen_string_literal: true
+
 module RSpec
   module Wait
-    VERSION = ::Gem::Version.new("0.0.10")
-
-    def self.version
-      VERSION
-    end
+    VERSION = ::Gem::Version.new("1.0.0")
   end
 end

data/lib/rspec/wait.rb

@@ -1,35 +1,48 @@
+# frozen_string_literal: true
+
 require "rspec"
-require "rspec/wait/error"
-require "rspec/wait/handler"
-require "rspec/wait/proxy"
-require "rspec/wait/target"
-require "rspec/wait/version"
+
+require_relative "wait/handler"
+require_relative "wait/proxy"
+require_relative "wait/target"
+require_relative "wait/version"
 
 module RSpec
+  # The RSpec::Wait module is included into RSpec's example environment, making
+  # the wait_for, wait, and with_wait methods available inside each spec.
   module Wait
+    DEFAULT_TIMEOUT = 10.0
+    DEFAULT_DELAY = 0.1
+    DEFAULT_CLONE_MATCHER = false
+
     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)
+    # From: https://github.com/rspec/rspec-expectations/blob/v3.4.0/lib/rspec/expectations/syntax.rb#L72-L74
+    def wait_for(*args, &block)
+      raise ArgumentError, "The `wait_for` method only accepts a block." if args.any?
+      raise ArgumentError, "The `wait_for` method requires a block." unless block
+
+      Target.new(block)
     end
 
-    def wait(timeout = nil, options = {})
-      options[:timeout] = timeout
-      Proxy.new(options)
+    def wait(arg = nil, timeout: arg, delay: nil, clone_matcher: nil)
+      Proxy.new(timeout: timeout, delay: delay, clone_matcher: clone_matcher)
     end
 
-    def with_wait(options)
+    def with_wait(timeout: nil, delay: nil, clone_matcher: nil)
       original_timeout = RSpec.configuration.wait_timeout
       original_delay = RSpec.configuration.wait_delay
+      original_clone_matcher = RSpec.configuration.clone_wait_matcher
 
-      RSpec.configuration.wait_timeout = options[:timeout] if options[:timeout]
-      RSpec.configuration.wait_delay = options[:delay] if options[:delay]
+      RSpec.configuration.wait_timeout = timeout unless timeout.nil?
+      RSpec.configuration.wait_delay = delay unless delay.nil?
+      RSpec.configuration.clone_wait_matcher = clone_matcher unless clone_matcher.nil?
 
       yield
     ensure
       RSpec.configuration.wait_timeout = original_timeout
       RSpec.configuration.wait_delay = original_delay
+      RSpec.configuration.clone_wait_matcher = original_clone_matcher
     end
   end
 end
@@ -37,14 +50,12 @@ 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.add_setting(:wait_timeout, default: RSpec::Wait::DEFAULT_TIMEOUT)
+  config.add_setting(:wait_delay, default: RSpec::Wait::DEFAULT_DELAY)
+  config.add_setting(:clone_wait_matcher, default: RSpec::Wait::DEFAULT_CLONE_MATCHER)
 
-  config.around do |example|
-    if (options = example.metadata[:wait])
-      with_wait(options) { example.run }
-    else
-      example.run
-    end
+  config.around(wait: {}) do |example|
+    options = example.metadata.fetch(:wait)
+    with_wait(**options) { example.run }
   end
 end

data/lib/rspec-wait.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rspec/wait"

data/rspec-wait.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
     "source_code_uri" => "https://github.com/laserlemon/rspec-wait",
   }
 
-  spec.required_ruby_version = ">= 2.2"
-  spec.add_dependency "rspec", ">= 3.0"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.required_ruby_version = ">= 3.0"
+  spec.add_dependency "rspec", ">= 3.4"
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rake", ">= 13.0"
 
   spec.files = Dir.glob([
     "rspec-wait.gemspec",
@@ -34,9 +34,4 @@ Gem::Specification.new do |spec|
   ])
 
   spec.extra_rdoc_files = ["README.md"]
-
-  spec.post_install_message = <<-MSG
-[rspec-wait] RSpec::Wait 1.0 has arrived! Please upgrade for the latest and greatest.
-[rspec-wait] See what's changed here: https://github.com/laserlemon/rspec-wait/blob/-/CHANGELOG.md
-  MSG
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rspec-wait
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 1.0.0
 platform: ruby
 authors:
 - Steve Richert
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-26 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,42 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 description: RSpec::Wait enables time-resilient expectations in your RSpec test suite.
 email: steve.richert@hey.com
 executables: []
@@ -61,8 +60,8 @@ extra_rdoc_files:
 files:
 - LICENSE.txt
 - README.md
+- lib/rspec-wait.rb
 - lib/rspec/wait.rb
-- lib/rspec/wait/error.rb
 - lib/rspec/wait/handler.rb
 - lib/rspec/wait/proxy.rb
 - lib/rspec/wait/target.rb
@@ -78,9 +77,6 @@ metadata:
   homepage_uri: https://github.com/laserlemon/rspec-wait
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/laserlemon/rspec-wait
-post_install_message: |
-  [rspec-wait] RSpec::Wait 1.0 has arrived! Please upgrade for the latest and greatest.
-  [rspec-wait] See what's changed here: https://github.com/laserlemon/rspec-wait/blob/-/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -88,15 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Wait for conditions in RSpec
 test_files: []

data/lib/rspec/wait/error.rb

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