rspec-core 3.8.2 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f10137b78862f926840a5956452d1def7be1715745bb73edab35b73af27cd801
-  data.tar.gz: 7d2c59eea23bd759487efb177c7e9de131a416d832ee6467b4849813d759832c
+  metadata.gz: 0117b5c68702f84872a6b528a286040ebad81a5201912cf75add518b16391fd8
+  data.tar.gz: 6a744e765c464099b304f42223079af2133ee5e278ffa3f3f3c5118f0ccdae54
 SHA512:
-  metadata.gz: a4344a9bdf65524dc82da9368cc8d844ed1da304aa139f2a95d5a6f1c177534d95ebbf7ecd3a488c2fa65221706cf0f4afdfbfdc3d0b6846f18ffaff1b9cda17
-  data.tar.gz: 063aee16e467179dd13d1f94a98b57fbc135d93ab9b46cf0d860903ca8a5ce130579830e6f561b288a78f642da976ac56be5ccf3ec4753d8754e2d508e650cb0
+  metadata.gz: d659433a8e529d32ef874d0e6c6d100a5482f1dbb1bcc00a65daccbdfd23fd16307f6938b01fada58609ea828f7215992574dd7fda7f1c2873763f9abbf77574
+  data.tar.gz: bdec2aae3e9a5a0c34ccba2bb97a3f4480fa8400f605bb0625b609ebb90a3abf77bfcdbe247f0137d00a2d69f26c3e9ee1565a7a653afe3d14376b3eb97f6ac4

data/Changelog.md

@@ -1,3 +1,77 @@
+### 3.10.0 / 2020-10-30
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.9.3...v3.10.0)
+
+Enhancements:
+
+* Memoize `RSpec::Core::Formatters::ExceptionPresenter#exception_lines` to improve performance
+  with slow exception messages. (Maxime Lapointe, #2743)
+* Add configuration for an error exit code (to disambiguate errored builds from failed builds
+  by exit status). (Dana Sherson, #2749)
+
+# 3.9.3 / 2020-09-30
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.9.2...v3.9.3)
+
+Bug Fixes:
+
+* Declare `ruby2_keywords` on `method_missing` for other gems. (Jon Rowe, #2731)
+* Ensure custom error codes are returned from bisect runs. (Jon Rowe, #2732)
+* Ensure `RSpec::Core::Configuration` predicate config methods return booleans.
+  (Marc-André Lafortune, #2736)
+* Prevent `rspec --bisect` from generating zombie processes while executing
+  bisect runs. (Benoit Tigeot, Jon Rowe, #2739)
+* Predicates for pending examples, (in `RSpec::Core::Example`, `#pending?`, `#skipped?` and
+  `#pending_fixed?`) now return boolean values rather than truthy values.
+  (Marc-André Lafortune, #2756, #2758)
+* Exceptions which have a message which cannot be cast to a string will no longer
+  cause a crash. (Jon Rowe, #2761)
+
+### 3.9.2 / 2020-05-02
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.9.1...v3.9.2)
+
+Bug Fixes:
+
+* Emit a warning when `around` hook is used with `:context` scope
+  (Phil Pirozhkov, #2687)
+* Prevent invalid implementations of `Exception#cause` from being treated as a
+  valid cause (and causing strange errors) in `RSpec::Core::Formatters::ExceptionPresenter`.
+  (Jon Rowe, #2703)
+* Correctly detect patterns when `rspec_opts` is an array in `RSpec::Core::RakeTask`.
+  (Marc-André Lafortune, #2704)
+* Make `RSpec.clear_examples` reset example counts for example groups. This fixes
+  an issue with re-running specs not matching ids. (Agis Anastasopoulos, #2723)
+
+### 3.9.1 / 2019-12-28
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.9.0...v3.9.1)
+
+Bug Fixes:
+
+* Prevent bisect command from blocking when number of specs exceeds file
+  descriptor limit on OSX or Linux. (Benoit Tigeot, #2669)
+* Prevent warnings being issued on Ruby 2.7.0. (Jon Rowe, #2680)
+
+### 3.9.0 / 2019-10-07
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.8.2...v3.9.0)
+
+Enhancements:
+
+* Improve the handling of errors during loading support files, if a file
+  errors before loading specs, RSpec will now skip loading the specs.
+  (David Rodríguez, #2568)
+* Add support for --example-matches to run examples by regular expression.
+  (Sam Joseph, Matt Rider, @okothkongo1, #2586)
+* Add `did_you_mean` suggestions for file names encountering a `LoadError`
+  outside of examples. (@obromios, #2601)
+* Add a minimalist quick fix style formatter, only outputs failures as
+  `file:line:message`. (Romain Tartière, #2614)
+* Convert string number values to integer when used for `RSpec::Configuration#fail_fast`
+  (Viktor Fonic, #2634)
+* Issue warning when invalid values are used for `RSpec::Configuration#fail_fast`
+  (Viktor Fonic, #2634)
+* Add support for running the Rake task in a clean environment.
+  (Jon Rowe, #2632)
+* Indent messages by there example group / example in the documentation formatter.
+  (Samuel Williams, #2649)
+
 ### 3.8.2 / 2019-06-29
 [Full Changelog](http://github.com/rspec/rspec-core/compare/v3.8.1...v3.8.2)
 
@@ -8,7 +82,7 @@ Bug Fixes:
   (Myron Marston, #2635).
 
 ### 3.8.1 / 2019-06-13
-[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.8.0...3.8.1)
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.8.0...v3.8.1)
 
 Bug Fixes:
 
@@ -2097,6 +2171,7 @@ Bug fixes
 [Full Changelog](http://github.com/rspec/rspec-core/compare/v2.2.0...v2.2.1)
 
 Bug fixes
+
 * alias_method instead of override Kernel#method_missing (John Wilger)
 * changed --autotest to --tty in generated command (MIKAMI Yoshiyuki)
 * revert change to debugger (had introduced conflict with Rails)

data/README.md

@@ -1,4 +1,4 @@
-# rspec-core [![Build Status](https://secure.travis-ci.org/rspec/rspec-core.svg?branch=master)](http://travis-ci.org/rspec/rspec-core) [![Code Climate](https://codeclimate.com/github/rspec/rspec-core.svg)](https://codeclimate.com/github/rspec/rspec-core)
+# rspec-core [![Build Status](https://secure.travis-ci.org/rspec/rspec-core.svg?branch=main)](http://travis-ci.org/rspec/rspec-core) [![Code Climate](https://codeclimate.com/github/rspec/rspec-core.svg)](https://codeclimate.com/github/rspec/rspec-core)
 
 rspec-core provides the structure for writing executable examples of how your
 code should behave, and an `rspec` command with tools to constrain which
@@ -10,12 +10,12 @@ examples get run and tailor the output.
     gem install rspec-core # for rspec-core only
     rspec --help
 
-Want to run against the `master` branch? You'll need to include the dependent
+Want to run against the `main` branch? You'll need to include the dependent
 RSpec repos as well. Add the following to your `Gemfile`:
 
 ```ruby
 %w[rspec rspec-core rspec-expectations rspec-mocks rspec-support].each do |lib|
-  gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => 'master'
+  gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => 'main'
 end
 ```
 
@@ -53,7 +53,7 @@ context of an _instance_ of that class.
 
 ## Nested Groups
 
-You can also declare nested nested groups using the `describe` or `context`
+You can also declare nested groups using the `describe` or `context`
 methods:
 
 ```ruby

data/lib/rspec/core.rb

@@ -139,6 +139,7 @@ module RSpec
   module Core
     autoload :ExampleStatusPersister, "rspec/core/example_status_persister"
     autoload :Profiler,               "rspec/core/profiler"
+    autoload :DidYouMean,             "rspec/core/did_you_mean"
 
     # @private
     # This avoids issues with reporting time caused by examples that

data/lib/rspec/core/bisect/fork_runner.rb

@@ -6,7 +6,7 @@ module RSpec
   module Core
     module Bisect
       # A Bisect runner that runs requested subsets of the suite by forking
-      # sub-processes. The master process bootstraps RSpec and the application
+      # sub-processes. The main process bootstraps RSpec and the application
       # environment (including preloading files specified via `--require`) so
       # that the individual spec runs do not have to re-pay that cost.  Each
       # spec run happens in a forked process, ensuring that the spec files are
@@ -92,7 +92,11 @@ module RSpec
 
           def dispatch_specs(run_descriptor)
             pid = fork { run_specs(run_descriptor) }
-            Process.waitpid(pid)
+            # We don't use Process.waitpid here as it was causing bisects to
+            # block due to the file descriptor limit on OSX / Linux. We need
+            # to detach the process to avoid having zombie processes
+            # consuming slots in the kernel process table during bisect runs.
+            Process.detach(pid)
           end
 
         private

data/lib/rspec/core/bisect/server.rb

@@ -33,7 +33,7 @@ module RSpec
 
         def start
           # Only allow remote DRb requests from this machine.
-          DRb.install_acl ACL.new(%w[ deny all allow localhost allow 127.0.0.1 ])
+          DRb.install_acl ACL.new(%w[ deny all allow localhost allow 127.0.0.1 allow ::1 ])
 
           # We pass `nil` as the first arg to allow it to pick a DRb port.
           @drb = DRb.start_service(nil, self)

data/lib/rspec/core/configuration.rb

@@ -67,15 +67,17 @@ module RSpec
       end
 
       # @private
-      def self.define_aliases(name, alias_name)
+      def self.define_alias(name, alias_name)
         alias_method alias_name, name
         alias_method "#{alias_name}=", "#{name}="
-        define_predicate_for alias_name
+        define_predicate alias_name
       end
 
       # @private
-      def self.define_predicate_for(*names)
-        names.each { |name| alias_method "#{name}?", name }
+      def self.define_predicate(name)
+        define_method "#{name}?" do
+          !!send(name)
+        end
       end
 
       # @private
@@ -88,7 +90,7 @@ module RSpec
         add_read_only_setting name
 
         Array(opts[:alias_with]).each do |alias_name|
-          define_aliases(name, alias_name)
+          define_alias(name, alias_name)
         end
       end
 
@@ -98,7 +100,7 @@ module RSpec
       def self.add_read_only_setting(name, opts={})
         raise "Use the instance add_setting method if you want to set a default" if opts.key?(:default)
         define_reader name
-        define_predicate_for name
+        define_predicate name
       end
 
       # @macro [attach] add_setting
@@ -202,10 +204,33 @@ module RSpec
         only_failures? && !example_status_persistence_file_path
       end
 
-      # @macro add_setting
+      # @macro define_reader
       # If specified, indicates the number of failures required before cleaning
-      # up and exit (default: `nil`).
-      add_setting :fail_fast
+      # up and exit (default: `nil`). Can also be `true` to fail and exit on first
+      # failure
+      define_reader :fail_fast
+
+      # @see fail_fast
+      def fail_fast=(value)
+        case value
+        when true, 'true'
+          @fail_fast = true
+        when false, 'false', 0
+          @fail_fast = false
+        when nil
+          @fail_fast = nil
+        else
+          @fail_fast = value.to_i
+
+          if value.to_i == 0
+            # TODO: in RSpec 4, consider raising an error here.
+            RSpec.warning "Cannot set `RSpec.configuration.fail_fast`" \
+              " to `#{value.inspect}`. Only `true`, `false`, `nil` and integers" \
+              " are valid values."
+            @fail_fast = true
+          end
+        end
+      end
 
       # @macro add_setting
       # Prints the formatter output of your suite without running any
@@ -217,6 +242,11 @@ module RSpec
       # @return [Integer]
       add_setting :failure_exit_code
 
+      # @macro add_setting
+      # The exit code to return if there are any errors outside examples (default: failure_exit_code)
+      # @return [Integer]
+      add_setting :error_exit_code
+
       # @macro add_setting
       # Whether or not to fail when there are no RSpec examples (default: false).
       # @return [Boolean]
@@ -289,7 +319,8 @@ module RSpec
       # Report the times for the slowest examples (default: `false`).
       # Use this to specify the number of examples to include in the profile.
       # @return [Boolean]
-      add_setting :profile_examples
+      attr_writer :profile_examples
+      define_predicate :profile_examples
 
       # @macro add_setting
       # Run all examples if none match the configured filters
@@ -497,6 +528,7 @@ module RSpec
         @pattern = '**{,/*/**}/*_spec.rb'
         @exclude_pattern = ''
         @failure_exit_code = 1
+        @error_exit_code = nil # so it can be overridden by failure exit code
         @fail_if_no_examples = false
         @spec_files_loaded = false
 
@@ -1106,7 +1138,7 @@ module RSpec
       #
       #   # This lets you do this:
       #
-      #   describe Thing do
+      #   RSpec.describe Thing do
       #     pending "does something" do
       #       thing = Thing.new
       #     end
@@ -1114,7 +1146,7 @@ module RSpec
       #
       #   # ... which is the equivalent of
       #
-      #   describe Thing do
+      #   RSpec.describe Thing do
       #     it "does something", :pending => true do
       #       thing = Thing.new
       #     end
@@ -1167,7 +1199,7 @@ module RSpec
       #
       #   # allows the user to include a shared example group like:
       #
-      #   describe Entity do
+      #   RSpec.describe Entity do
       #     it_has_behavior 'sortability' do
       #       let(:sortable) { Entity.new }
       #     end
@@ -1327,6 +1359,12 @@ module RSpec
       #       end
       #     end
       #
+      #     module PreferencesHelpers
+      #       def preferences(user, preferences = {})
+      #         # ...
+      #       end
+      #     end
+      #
       #     module UserHelpers
       #       def users(username)
       #         # ...
@@ -1335,12 +1373,17 @@ module RSpec
       #
       #     RSpec.configure do |config|
       #       config.include(UserHelpers) # included in all groups
+      #
+      #       # included in examples with `:preferences` metadata
+      #       config.include(PreferenceHelpers, :preferences)
+      #
+      #       # included in examples with `:type => :request` metadata
       #       config.include(AuthenticationHelpers, :type => :request)
       #     end
       #
-      #     describe "edit profile", :type => :request do
+      #     describe "edit profile", :preferences, :type => :request do
       #       it "can be viewed by owning user" do
-      #         login_as users(:jdoe)
+      #         login_as preferences(users(:jdoe), :lang => 'es')
       #         get "/profiles/jdoe"
       #         assert_select ".username", :text => 'jdoe'
       #       end
@@ -1368,17 +1411,21 @@ module RSpec
       #
       # @example
       #
-      #     RSpec.shared_context "example users" do
+      #     RSpec.shared_context "example admin user" do
       #       let(:admin_user) { create_user(:admin) }
+      #     end
+      #
+      #     RSpec.shared_context "example guest user" do
       #       let(:guest_user) { create_user(:guest) }
       #     end
       #
       #     RSpec.configure do |config|
-      #       config.include_context "example users", :type => :request
+      #       config.include_context "example guest user", :type => :request
+      #       config.include_context "example admin user", :admin, :type => :request
       #     end
       #
       #     RSpec.describe "The admin page", :type => :request do
-      #       it "can be viewed by admins" do
+      #       it "can be viewed by admins", :admin do
       #         login_with admin_user
       #         get "/admin"
       #         expect(response).to be_ok
@@ -1420,12 +1467,20 @@ module RSpec
       #       end
       #     end
       #
+      #     module PermissionHelpers
+      #       def define_permissions
+      #         # ...
+      #       end
+      #     end
+      #
       #     RSpec.configure do |config|
       #       config.extend(UiHelpers, :type => :request)
+      #       config.extend(PermissionHelpers, :with_permissions, :type => :request)
       #     end
       #
-      #     describe "edit profile", :type => :request do
+      #     describe "edit profile", :with_permissions, :type => :request do
       #       run_in_browser
+      #       define_permissions
       #
       #       it "does stuff in the client" do
       #         # ...
@@ -1718,7 +1773,7 @@ module RSpec
       #     rspec.expose_current_running_example_as :example
       #   end
       #
-      #   describe MyClass do
+      #   RSpec.describe MyClass do
       #     before do
       #       # `example` can be used here because of the above config.
       #       do_something if example.metadata[:type] == "foo"
@@ -1883,7 +1938,8 @@ module RSpec
       #
       # This method differs from {Hooks#before} in only one way: it supports
       # the `:suite` scope. Hooks with the `:suite` scope will be run once before
-      # the first example of the entire suite is executed.
+      # the first example of the entire suite is executed. Conditions passed along
+      # with `:suite` are effectively ignored.
       #
       # @see #prepend_before
       # @see #after
@@ -1912,7 +1968,8 @@ module RSpec
       #
       # This method differs from {Hooks#prepend_before} in only one way: it supports
       # the `:suite` scope. Hooks with the `:suite` scope will be run once before
-      # the first example of the entire suite is executed.
+      # the first example of the entire suite is executed. Conditions passed along
+      # with `:suite` are effectively ignored.
       #
       # @see #before
       # @see #after
@@ -1936,7 +1993,8 @@ module RSpec
       #
       # This method differs from {Hooks#after} in only one way: it supports
       # the `:suite` scope. Hooks with the `:suite` scope will be run once after
-      # the last example of the entire suite is executed.
+      # the last example of the entire suite is executed. Conditions passed along
+      # with `:suite` are effectively ignored.
       #
       # @see #append_after
       # @see #before
@@ -1965,7 +2023,8 @@ module RSpec
       #
       # This method differs from {Hooks#append_after} in only one way: it supports
       # the `:suite` scope. Hooks with the `:suite` scope will be run once after
-      # the last example of the entire suite is executed.
+      # the last example of the entire suite is executed. Conditions passed along
+      # with `:suite` are effectively ignored.
       #
       # @see #append_after
       # @see #before
@@ -2051,6 +2110,11 @@ module RSpec
 
       def load_file_handling_errors(method, file)
         __send__(method, file)
+      rescue LoadError => ex
+        relative_file = Metadata.relative_path(file)
+        suggestions = DidYouMean.new(relative_file).call
+        reporter.notify_non_example_exception(ex, "An error occurred while loading #{relative_file}.#{suggestions}")
+        RSpec.world.wants_to_quit = true
       rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex
         relative_file = Metadata.relative_path(file)
         reporter.notify_non_example_exception(ex, "An error occurred while loading #{relative_file}.")

data/lib/rspec/core/did_you_mean.rb

@@ -0,0 +1,46 @@
+module RSpec
+  module Core
+    # @private
+    # Wrapper around Ruby's `DidYouMean::SpellChecker` when available to provide file name suggestions.
+    class DidYouMean
+      attr_reader :relative_file_name
+
+      def initialize(relative_file_name)
+        @relative_file_name = relative_file_name
+      end
+
+      if defined?(::DidYouMean::SpellChecker)
+        # provide probable suggestions
+        def call
+          checker = ::DidYouMean::SpellChecker.new(:dictionary => Dir["spec/**/*.rb"])
+          probables = checker.correct(relative_file_name.sub('./', ''))[0..2]
+          return '' unless probables.any?
+
+          formats probables
+        end
+      else
+        # return a hint if API for ::DidYouMean::SpellChecker not supported
+        def call
+          "\nHint: Install the `did_you_mean` gem in order to provide suggestions for similarly named files."
+        end
+      end
+
+      private
+
+      def formats(probables)
+        rspec_format = probables.map { |s, _| "rspec ./#{s}" }
+        red_font(top_and_tail rspec_format)
+      end
+
+      def top_and_tail(rspec_format)
+        spaces = ' ' * 20
+        rspec_format.insert(0, ' - Did you mean?').join("\n#{spaces}") + "\n"
+      end
+
+      def red_font(mytext)
+        colorizer = ::RSpec::Core::Formatters::ConsoleCodes
+        colorizer.wrap mytext, :failure
+      end
+    end
+  end
+end