rspec-core 3.10.2 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c462ef57abbfae97ff1b4fa21937c229704f11d76d98f9d364cac49845421ad
-  data.tar.gz: 96a6cff188d2268a7c3ee96a64d5d12bbc3fca390e821b1f155d7e963745ea79
+  metadata.gz: c9793ccaf293fdd1820e28574b1b6db9999ee75618d8abfe3238d3bcaaffcd95
+  data.tar.gz: 767dee6f32f9d5c84df489e7a92ecc13ccf0b5becee1ce350b9250e1c994a763
 SHA512:
-  metadata.gz: 62f270716ca47f5ee3388a95f89d71d4b0e9bdf0fd1f7c6806332af2a9191028c6694b38e9792e8ad1c791fb277161b29ba4f92486303eaf6c2b986ae7616b3b
-  data.tar.gz: 5eaf0e7f745c9885d9fba59bf26303588632a4294ea004131bca55496121a60185154848492e5b31eafc9186f19c7903365da829fbcf8334f043ad707263076c
+  metadata.gz: 88fbe10e6f8e2ce1a4ba1c3e72283990e4dbf4dbf897067e297f7b3084e42f65e752c8c4381761b630ebef42c204e897208392b1421163eb645351d511249750
+  data.tar.gz: 6759b7780dfe8b1e5fedf1d55f864acda4d9ad635013e885ae2457c4c1c37ea28ed3d141e358966da290c3ff4a7de50da8e794933778a393e383c25cbcd95d82

data/Changelog.md

@@ -1,5 +1,18 @@
 ### Development
-[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.10.2...3-10-maintenance)
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.11.0...3-11-maintenance)
+
+### 3.11.0 / 2022-02-09
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.10.2...v3.11.0)
+
+Enhancements:
+
+* Improve pluralisation of words ending with `s` (like process). (Joshua Pinter, #2779)
+* Add ordering by file modification time (most recent first). (Matheus Richard, #2778)
+* Add `to_s` to reserved names for #let and #subject. (Nick Flückiger, #2886)
+* Introduce `RSpec.current_scope` to expose the current scope in which
+  RSpec is executing. e.g. `:before_example_hook`, `:example` etc. (@odinhb, #2895)
+* Add named bold colours as options for custom colours. (#2913, #2914)
+* Warn when (but not prevent) a `SystemExit` occurs. (Jared Beck, #2926)
 
 ### 3.10.2 / 2022-01-27
 [Full Changelog](http://github.com/rspec/rspec-core/compare/v3.10.1...v3.10.2)

data/README.md

@@ -1,4 +1,4 @@
-# rspec-core [![Build Status](https://github.com/rspec/rspec-core/workflows/RSpec%20CI/badge.svg?branch=3-10-maintenance)](https://github.com/rspec/rspec-core/actions) [![Code Climate](https://codeclimate.com/github/rspec/rspec-core.svg)](https://codeclimate.com/github/rspec/rspec-core)
+# rspec-core [![Build Status](https://github.com/rspec/rspec-core/workflows/RSpec%20CI/badge.svg)](https://github.com/rspec/rspec-core/actions) [![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

data/lib/rspec/core/configuration.rb

@@ -2063,10 +2063,13 @@ module RSpec
         return yield if dry_run?
 
         begin
+          RSpec.current_scope = :before_suite_hook
           run_suite_hooks("a `before(:suite)` hook", @before_suite_hooks)
           yield
         ensure
+          RSpec.current_scope = :after_suite_hook
           run_suite_hooks("an `after(:suite)` hook", @after_suite_hooks)
+          RSpec.current_scope = :suite
         end
       end
 
@@ -2119,6 +2122,14 @@ module RSpec
         relative_file = Metadata.relative_path(file)
         reporter.notify_non_example_exception(ex, "An error occurred while loading #{relative_file}.")
         RSpec.world.wants_to_quit = true
+      rescue SystemExit => ex
+        relative_file = Metadata.relative_path(file)
+        reporter.notify_non_example_exception(
+          ex,
+          "While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit."
+        )
+        RSpec.world.rspec_is_quitting = true
+        raise ex
       end
 
       def handle_suite_hook(scope, meta)

data/lib/rspec/core/example.rb

@@ -259,6 +259,7 @@ module RSpec
             with_around_and_singleton_context_hooks do
               begin
                 run_before_example
+                RSpec.current_scope = :example
                 @example_group_instance.instance_exec(self, &@example_block)
 
                 if pending?
@@ -278,6 +279,7 @@ module RSpec
               rescue AllExceptionsExcludingDangerousOnesOnRubiesThatAllowIt => e
                 set_exception(e)
               ensure
+                RSpec.current_scope = :after_example_hook
                 run_after_example
               end
             end
@@ -462,6 +464,7 @@ module RSpec
       end
 
       def with_around_example_hooks
+        RSpec.current_scope = :before_example_hook
         hooks.run(:around, :example, self) { yield }
       rescue Support::AllExceptionsExceptOnesWeMustNotRescue => e
         set_exception(e)

data/lib/rspec/core/example_group.rb

@@ -602,6 +602,7 @@ module RSpec
 
         should_run_context_hooks = descendant_filtered_examples.any?
         begin
+          RSpec.current_scope = :before_context_hook
           run_before_context_hooks(new('before(:context) hook')) if should_run_context_hooks
           result_for_this_group = run_examples(reporter)
           results_for_descendants = ordering_strategy.order(children).map { |child| child.run(reporter) }.all?
@@ -614,6 +615,7 @@ module RSpec
           RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?
           false
         ensure
+          RSpec.current_scope = :after_context_hook
           run_after_context_hooks(new('after(:context) hook')) if should_run_context_hooks
           reporter.example_group_finished(self)
         end

data/lib/rspec/core/formatters/console_codes.rb

@@ -7,15 +7,23 @@ module RSpec
         # @private
         VT100_CODES =
           {
-            :black   => 30,
-            :red     => 31,
-            :green   => 32,
-            :yellow  => 33,
-            :blue    => 34,
-            :magenta => 35,
-            :cyan    => 36,
-            :white   => 37,
-            :bold    => 1,
+            :black         => 30,
+            :red           => 31,
+            :green         => 32,
+            :yellow        => 33,
+            :blue          => 34,
+            :magenta       => 35,
+            :cyan          => 36,
+            :white         => 37,
+            :bold_black   => '1;30',
+            :bold_red     => '1;31',
+            :bold_green   => '1;32',
+            :bold_yellow  => '1;33',
+            :bold_blue    => '1;34',
+            :bold_magenta => '1;35',
+            :bold_cyan    => '1;36',
+            :bold_white   => '1;37',
+            :bold          => 1,
           }
         # @private
         VT100_CODE_VALUES = VT100_CODES.invert

data/lib/rspec/core/formatters/helpers.rb

@@ -86,7 +86,15 @@ module RSpec
         # @param string [String] word to be pluralized
         # @return [String] pluralized word
         def self.pluralize(count, string)
-          "#{count} #{string}#{'s' unless count.to_f == 1}"
+          pluralized_string = if count.to_f == 1
+                                string
+                              elsif string.end_with?('s') # e.g. "process"
+                                "#{string}es" # e.g. "processes"
+                              else
+                                "#{string}s"
+                              end
+
+          "#{count} #{pluralized_string}"
         end
 
         # @api private

data/lib/rspec/core/memoized_helpers.rb

@@ -78,6 +78,7 @@ module RSpec
       # @note If you are using RSpec's newer expect-based syntax you may
       #       want to use `is_expected.to` instead of `should`.
       def should(matcher=nil, message=nil)
+        enforce_value_expectation(matcher, 'should')
         RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)
       end
 
@@ -97,6 +98,7 @@ module RSpec
       # @note If you are using RSpec's newer expect-based syntax you may
       #       want to use `is_expected.to_not` instead of `should_not`.
       def should_not(matcher=nil, message=nil)
+        enforce_value_expectation(matcher, 'should_not')
         RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)
       end
 
@@ -144,6 +146,26 @@ module RSpec
                       end
       end
 
+      # @private
+      def enforce_value_expectation(matcher, method_name)
+        return if matcher_supports_value_expectations?(matcher)
+
+        RSpec.deprecate(
+          "#{method_name} #{RSpec::Support::ObjectFormatter.format(matcher)}",
+          :message =>
+            "The implicit block expectation syntax is deprecated, you should pass " \
+            "a block to `expect` to use the provided block expectation matcher " \
+            "(#{RSpec::Support::ObjectFormatter.format(matcher)}), " \
+            "or the matcher must implement `supports_value_expectations?`."
+        )
+      end
+
+      def matcher_supports_value_expectations?(matcher)
+        matcher.supports_value_expectations?
+      rescue
+        true
+      end
+
       # @private
       class ThreadsafeMemoized
         def initialize
@@ -285,9 +307,13 @@ EOS
           # We have to pass the block directly to `define_method` to
           # allow it to use method constructs like `super` and `return`.
           raise "#let or #subject called without a block" if block.nil?
-          raise(
-            "#let or #subject called with a reserved name #initialize"
-          ) if :initialize == name
+
+          # A list of reserved words that can't be used as a name for a memoized helper
+          # Matches for both symbols and passed strings
+          if [:initialize, :to_s].include?(name.to_sym)
+            raise ArgumentError, "#let or #subject called with reserved name `#{name}`"
+          end
+
           our_module = MemoizedHelpers.module_for(self)
 
           # If we have a module clash in our helper module

data/lib/rspec/core/option_parser.rb

@@ -58,10 +58,11 @@ module RSpec::Core
         end
 
         parser.on('--order TYPE[:SEED]', 'Run examples by the specified order type.',
-                  '  [defined] examples and groups are run in the order they are defined',
-                  '  [rand]    randomize the order of groups and examples',
-                  '  [random]  alias for rand',
-                  '  [random:SEED] e.g. --order random:123') do |o|
+                  '  [defined]           examples and groups are run in the order they are defined',
+                  '  [rand]              randomize the order of groups and examples',
+                  '  [random]            alias for rand',
+                  '  [random:SEED]       e.g. --order random:123',
+                  '  [recently-modified] run the most recently modified files first') do |o|
           options[:order] = o
         end
 

data/lib/rspec/core/ordering.rb

@@ -58,6 +58,14 @@ module RSpec
         MAX_32_BIT = 4_294_967_295
       end
 
+      # @private
+      # Orders items by modification time (most recent modified first).
+      class RecentlyModified
+        def order(list)
+          list.sort_by { |item| -File.mtime(item.metadata[:absolute_file_path]).to_i }
+        end
+      end
+
       # @private
       # Orders items based on a custom block.
       class Custom
@@ -77,7 +85,8 @@ module RSpec
           @configuration = configuration
           @strategies    = {}
 
-          register(:random,  Random.new(configuration))
+          register(:random, Random.new(configuration))
+          register(:recently_modified, RecentlyModified.new)
 
           identity = Identity.new
           register(:defined, identity)
@@ -132,6 +141,8 @@ module RSpec
                             :random
                           elsif order == 'defined'
                             :defined
+                          elsif order == 'recently-modified'
+                            :recently_modified
                           end
 
           register_ordering(:global, ordering_registry.fetch(ordering_name)) if ordering_name

data/lib/rspec/core/version.rb

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec Core.
     module Version
       # Current version of RSpec Core, in semantic versioning format.
-      STRING = '3.10.2'
+      STRING = '3.11.0'
     end
   end
 end

data/lib/rspec/core/world.rb

@@ -10,6 +10,13 @@ module RSpec
       # Used internally to determine what to do when a SIGINT is received.
       attr_accessor :wants_to_quit
 
+      # Used internally to signify that a SystemExit occurred in
+      # `Configuration#load_file_handling_errors`, and thus examples cannot
+      # be counted accurately. Specifically, we cannot accurately report
+      # "No examples found".
+      # @private
+      attr_accessor :rspec_is_quitting
+
       # Used internally to signal that a failure outside of an example
       # has occurred, and that therefore the exit status should indicate
       # the run failed.
@@ -18,6 +25,7 @@ module RSpec
 
       def initialize(configuration=RSpec.configuration)
         @wants_to_quit = false
+        @rspec_is_quitting = false
         @configuration = configuration
         configuration.world = self
         @example_groups = []
@@ -184,10 +192,12 @@ module RSpec
         return unless example_count.zero?
 
         example_groups.clear
-        if filter_manager.empty?
-          report_filter_message("No examples found.")
-        elsif exclusion_filter.empty? || inclusion_filter.empty?
-          report_filter_message(everything_filtered_message)
+        unless rspec_is_quitting
+          if filter_manager.empty?
+            report_filter_message("No examples found.")
+          elsif exclusion_filter.empty? || inclusion_filter.empty?
+            report_filter_message(everything_filtered_message)
+          end
         end
       end
 

data/lib/rspec/core.rb

@@ -129,6 +129,32 @@ module RSpec
     RSpec::Support.thread_local_data[:current_example] = example
   end
 
+  # Set the current scope rspec is executing in
+  # @api private
+  def self.current_scope=(scope)
+    RSpec::Support.thread_local_data[:current_scope] = scope
+  end
+  RSpec.current_scope = :suite
+
+  # Get the current RSpec execution scope
+  #
+  # Returns (in order of lifecycle):
+  #   * `:suite` as an initial value, this is outside of the test lifecycle.
+  #   * `:before_suite_hook` during `before(:suite)` hooks.
+  #   * `:before_context_hook` during `before(:context)` hooks.
+  #   * `:before_example_hook` during `before(:example)` hooks and `around(:example)` before `example.run`.
+  #   * `:example` within the example run.
+  #   * `:after_example_hook` during `after(:example)` hooks and `around(:example)` after `example.run`.
+  #   * `:after_context_hook` during `after(:context)` hooks.
+  #   * `:after_suite_hook` during `after(:suite)` hooks.
+  #   * `:suite` as a final value, again this is outside of the test lifecycle.
+  #
+  # Reminder, `:context` hooks have `:all` alias and `:example` hooks have `:each` alias.
+  # @return [Symbol]
+  def self.current_scope
+    RSpec::Support.thread_local_data[:current_scope]
+  end
+
   # @private
   # Internal container for global non-configuration data.
   def self.world

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-core
 version: !ruby/object:Gem::Version
-  version: 3.10.2
+  version: 3.11.0
 platform: ruby
 authors:
 - Steven Baker
@@ -46,7 +46,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-support
@@ -54,14 +54,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -267,7 +267,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rspec/rspec-core/issues
-  changelog_uri: https://github.com/rspec/rspec-core/blob/v3.10.2/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-core/blob/v3.11.0/Changelog.md
   documentation_uri: https://rspec.info/documentation/
   mailing_list_uri: https://groups.google.com/forum/#!forum/rspec
   source_code_uri: https://github.com/rspec/rspec-core
@@ -290,5 +290,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: rspec-core-3.10.2
+summary: rspec-core-3.11.0
 test_files: []