rspec-core 3.12.0 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f573a79d2311b74b6d9cdf7f8694856d70aa84037566289b6834c6ca710ecfd0
-  data.tar.gz: 9ec85ab6c34cf92e45404985f5578241b7a54ebb48a2a13d182493ce9ff31b71
+  metadata.gz: 74e1ccff0acb0f5e68bb6ed4c4552b0313d28e348f414d37e09b5741321c6153
+  data.tar.gz: 017cac1b0c789c1a75dc9bb782a415608284ef2e9fcaba87087e5745040abeb2
 SHA512:
-  metadata.gz: f03be116127209918f11a49536975a5f584185d6b4dd72fb845a8eb270ff0da131ed729a86dc7c8b0205b7d7e6f3a922ff8e01f3118e7a3bfd017d2cdaeea966
-  data.tar.gz: 24bebf24323887a2534c5fdecdcfdd4c269e10947464cab62ed4f702bd025dd4ea2f9f6725c89d2e9b096f9a5424895f80aac6b250113aabff6f92c1662aeed9
+  metadata.gz: e16148576b7e0405cf5de89771fc303a7ae20166250f5d29b5c651bc5a7757a7da183081eccf762050cc85b2e8f2618d7a4104f5957da9e5d6709b17b780d81a
+  data.tar.gz: e8a969ee3e5154e6873a5b180ae71a24cc0ae5c62cf5c2642fafab7be5814c2e37987256cbf908421ee1eacfd0ebe0476f254108845df2cdc921cf2fbebd3741

data/Changelog.md

@@ -1,5 +1,45 @@
 ### Development
-[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.12.0...3-12-maintenance)
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.12.3...main)
+
+### 3.13.0 / 2024-02-04
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.12.3...v3.13.0)
+
+Enhancements:
+
+* Support the `--backtrace` flag when using the JSON formatter. (Matt Larraz, #2980)
+* Ignore commented out lines in CLI config files (e.g. `.rspec`). (Junichi Ito, #2984)
+* Add `pending_failure_output` config option to allow skipping backtraces or
+  muting pending specs output. (Phil Pirozhkov, #2957)
+* Process `--dry-run` before configuration flags that read files so that introspecting
+  it returns the correct value. (Xenor Chang, #3008)
+* Allow specifying custom ordering strategies via `--order`. (Jon Rowe, #3025)
+* Use the improved `syntax_suggest` output for `SyntaxError` when available.
+  (Richard Schneeman, #3015, #3026)
+* Add config option (`RSpec::Core::Configuration#full_cause_backtrace`) to print the
+  entire backtrace of an exception cause. (David Taylor, #3046)
+
+### 3.12.3 / 2024-02-04
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.12.2...v3.12.3)
+
+Bug fixes:
+
+* Use `__send__` in output wrapper to avoid issues with IO objects that implement `send`
+  like `Socket`. (Richard Platel, #3045)
+
+### 3.12.2 / 2023-04-18
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.12.1...v3.12.2)
+
+Bug fixes:
+
+* Remove link to outdated documentation in generated output. (Jon Rowe, #3035)
+
+### 3.12.1 / 2023-02-03
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.12.0...v3.12.1)
+
+Bug fixes:
+
+* Prevent multiple calls to `extra_failure_lines` from adding additional whitespace
+  around them when the lines already contain whitespace. (Jon Rowe, #3006)
 
 ### 3.12.0 / 2022-10-26
 [Full Changelog](http://github.com/rspec/rspec-core/compare/v3.11.0...v3.12.0)

data/README.md

@@ -116,6 +116,11 @@ pretty much the same as `shared_examples` and `include_examples`, providing
 more accurate naming when you share hooks, `let` declarations, helper methods,
 etc, but no examples.
 
+If you want to reuse shared examples or contexts across your RSpec suite you can
+define them in a stand alone _*.rb_ files (_spec/support/shared_examples/definition.rb_
+for example). But you will have to manually `require` them (there is no autoloading of
+_spec/support/_ directory unless you set it up yourself).
+
 ## Metadata
 
 rspec-core stores a metadata hash with every example and group, which
@@ -322,14 +327,14 @@ Failures:
             got: nil
 
        (compared using ==)
-     # ./spec/calcalator_spec.rb:6:in `block (3 levels) in <top (required)>'
+     # ./spec/calculator_spec.rb:6:in `block (3 levels) in <top (required)>'
 
 Finished in 0.00131 seconds (files took 0.10968 seconds to load)
 1 example, 1 failure
 
 Failed examples:
 
-rspec ./spec/calcalator_spec.rb:5 # Calculator#add returns the sum of its arguments
+rspec ./spec/calculator_spec.rb:5 # Calculator#add returns the sum of its arguments
 ```
 
 Implement the simplest solution, by changing the definition of `Calculator#add` to:

data/lib/rspec/core/configuration.rb

@@ -453,11 +453,30 @@ module RSpec
       add_setting :threadsafe
 
       # @macro add_setting
-      # Maximum count of failed source lines to display in the failure reports.
-      # (default `10`).
+      # Maximum count of failed source lines to display in the failure reports
+      # (defaults to `10`).
       # return [Integer]
       add_setting :max_displayed_failure_line_count
 
+      # @macro full_cause_backtrace
+      # Display the full backtrace of an exceptions cause (defaults to `false`).
+      # return [Boolean]
+      add_setting :full_cause_backtrace
+
+      # @macro add_setting
+      # Format the output for pending examples. Can be set to:
+      #  - :full (default) - pending examples appear similarly to failures
+      #  - :no_backtrace - same as above, but with no backtrace
+      #  - :skip - do not show the section at all
+      # return [Symbol]
+      add_read_only_setting :pending_failure_output
+      def pending_failure_output=(mode)
+        raise ArgumentError,
+              "`pending_failure_output` can be set to :full, :no_backtrace, " \
+              "or :skip" unless [:full, :no_backtrace, :skip].include?(mode)
+        @pending_failure_output = mode
+      end
+
       # Determines which bisect runner implementation gets used to run subsets
       # of the suite during a bisection. Your choices are:
       #
@@ -557,8 +576,10 @@ module RSpec
         @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)
         @threadsafe = true
         @max_displayed_failure_line_count = 10
+        @full_cause_backtrace = false
         @world = World::Null
         @shared_context_metadata_behavior = :trigger_inclusion
+        @pending_failure_output = :full
 
         define_built_in_hooks
       end
@@ -678,7 +699,7 @@ module RSpec
       end
 
       # Set regular expressions used to exclude lines in backtrace.
-      # @param patterns [Array<Regexp>] set backtrace_formatter exlusion_patterns
+      # @param patterns [Array<Regexp>] set backtrace_formatter exclusion_patterns
       def backtrace_exclusion_patterns=(patterns)
         @backtrace_formatter.exclusion_patterns = patterns
       end
@@ -1820,7 +1841,7 @@ module RSpec
       #   by not setting `mock_with` or `expect_with` to anything else).
       #
       # @note If the user uses this options with `mock_with :mocha`
-      #   (or similiar) they will still have monkey patching active
+      #   (or similar) they will still have monkey patching active
       #   in their test environment from mocha.
       #
       # @example
@@ -2120,6 +2141,13 @@ module RSpec
         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 SyntaxError => ex
+        relative_file = Metadata.relative_path(file)
+        reporter.notify_non_example_exception(
+          ex,
+          "While loading #{relative_file} a `raise SyntaxError` occurred, RSpec will now quit."
+        )
+        RSpec.world.rspec_is_quitting = 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/configuration_options.rb

@@ -79,6 +79,10 @@ module RSpec
         # deprecation (or otherwise access the reporter).
         :deprecation_stream,
 
+        # In order for `RSpec.configuration.dry_run?` to return `true` during
+        # processing the `requires` option, it must be parsed before it.
+        :dry_run,
+
         # load paths depend on nothing, but must be set before `requires`
         # to support load-path-relative requires.
         :libs,
@@ -169,7 +173,8 @@ module RSpec
       def args_from_options_file(path)
         return [] unless path && File.exist?(path)
         config_string = options_file_as_erb_string(path)
-        FlatMap.flat_map(config_string.split(/\n+/), &:shellsplit)
+        config_lines = config_string.split(/\n+/).reject { |s| s =~ /\A\s*#/ }
+        FlatMap.flat_map(config_lines, &:shellsplit)
       end
 
       def options_file_as_erb_string(path)

data/lib/rspec/core/example_status_persister.rb

@@ -63,7 +63,7 @@ module RSpec
     # were loaded but not executed (due to filtering, `--fail-fast`
     # or whatever) should have a `:status` of `UNKNOWN_STATUS`.
     #
-    # This willl produce a new list that:
+    # This will produce a new list that:
     #   - Will be missing examples from previous runs that we know for sure
     #     no longer exist.
     #   - Will have the latest known status for any examples that either
@@ -164,7 +164,7 @@ module RSpec
       end
 
       def formatted_value_rows
-        @foramtted_value_rows ||= rows.map do |row|
+        @formatted_value_rows ||= rows.map do |row|
           formatted_row_from(row)
         end
       end

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

@@ -56,7 +56,12 @@ module RSpec
               end
 
               unless last_cause.backtrace.nil? || last_cause.backtrace.empty?
-                cause << ("  #{backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata).first}")
+                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)
+                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting
+
+                lines.each do |line|
+                  cause << ("  #{line}")
+                end
               end
             end
 
@@ -175,10 +180,22 @@ module RSpec
         end
 
         # rubocop:disable Lint/RescueException
-        def exception_message_string(exception)
-          exception.message.to_s
-        rescue Exception => other
-          "A #{exception.class} for which `exception.message.to_s` raises #{other.class}."
+        if SyntaxError.instance_methods.include?(:detailed_message)
+          def exception_message_string(exception)
+            case exception
+            when SyntaxError then exception.detailed_message.to_s
+            else
+              exception.message.to_s
+            end
+          rescue Exception => other
+            "A #{exception.class} for which `exception.message.to_s` raises #{other.class}."
+          end
+        else
+          def exception_message_string(exception)
+            exception.message.to_s
+          rescue Exception => other
+            "A #{exception.class} for which `exception.message.to_s` raises #{other.class}."
+          end
         end
         # rubocop:enable Lint/RescueException
 
@@ -197,8 +214,8 @@ module RSpec
           @extra_failure_lines ||= begin
             lines = Array(example.metadata[:extra_failure_lines])
             unless lines.empty?
-              lines.unshift('')
-              lines.push('')
+              lines.unshift('') unless lines.first == ''
+              lines.push('') unless lines.last == ''
             end
             lines
           end
@@ -312,10 +329,14 @@ module RSpec
                 ]
               }
             elsif @execution_result.status == :pending
-              {
+              options = {
                 :message_color    => RSpec.configuration.pending_color,
                 :detail_formatter => PENDING_DETAIL_FORMATTER
               }
+              if RSpec.configuration.pending_failure_output == :no_backtrace
+                options[:backtrace_formatter] = EmptyBacktraceFormatter
+              end
+              options
             end
           end
 

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

@@ -43,7 +43,7 @@ module RSpec
         #
         # @param backtrace [String] the backtrace from a test failure
         # @return [String] highlighted code snippet indicating where the test
-        #   failure occured
+        #   failure occurred
         #
         # @see #post_process
         def snippet(backtrace)
@@ -103,7 +103,7 @@ module RSpec
         #
         # @param highlighted [String] syntax-highlighted snippet surrounding the
         #   offending line of code
-        # @param offending_line [Fixnum] line where failure occured
+        # @param offending_line [Fixnum] line where failure occurred
         # @return [String] completed snippet
         def post_process(highlighted, offending_line)
           new_lines = []

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

@@ -32,15 +32,16 @@ module RSpec
           @output_hash[:summary_line] = summary.totals_line
         end
 
-        def stop(notification)
-          @output_hash[:examples] = notification.examples.map do |example|
-            format_example(example).tap do |hash|
-              e = example.exception
+        def stop(group_notification)
+          @output_hash[:examples] = group_notification.notifications.map do |notification|
+            format_example(notification.example).tap do |hash|
+              e = notification.example.exception
+
               if e
-                hash[:exception] =  {
+                hash[:exception] = {
                   :class => e.class.name,
                   :message => e.message,
-                  :backtrace => e.backtrace,
+                  :backtrace => notification.formatted_backtrace,
                 }
               end
             end

data/lib/rspec/core/metadata_filter.rb

@@ -92,7 +92,7 @@ module RSpec
       #
       # This is ideal for use by a example or example group, which may
       # be updated multiple times with globally configured hooks, etc,
-      # but will not be queried frequently by other examples or examle
+      # but will not be queried frequently by other examples or example
       # groups.
       # @private
       class UpdateOptimized

data/lib/rspec/core/notifications.rb

@@ -120,6 +120,8 @@ module RSpec::Core
       # @return [String] The list of pending examples, fully formatted in the
       #   way that RSpec's built-in formatters emit.
       def fully_formatted_pending_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+        return if RSpec.configuration.pending_failure_output == :skip
+
         formatted = "\nPending: (Failures listed here are expected and do not affect your suite's status)\n".dup
 
         pending_notifications.each_with_index do |notification, index|

data/lib/rspec/core/ordering.rb

@@ -78,6 +78,30 @@ module RSpec
         end
       end
 
+      # @private
+      # A strategy which delays looking up the ordering until needed
+      class Delayed
+        def initialize(registry, name)
+          @registry = registry
+          @name = name
+        end
+
+        def order(list)
+          strategy.order(list)
+        end
+
+        private
+
+        def strategy
+          @strategy ||= lookup_strategy
+        end
+
+        def lookup_strategy
+          raise "Undefined ordering strategy #{@name.inspect}" unless @registry.has_strategy?(@name)
+          @registry.fetch(@name)
+        end
+      end
+
       # @private
       # Stores the different ordering strategies.
       class Registry
@@ -99,6 +123,10 @@ module RSpec
           @strategies.fetch(name, &fallback)
         end
 
+        def has_strategy?(name)
+          @strategies.key?(name)
+        end
+
         def register(sym, strategy)
           @strategies[sym] = strategy
         end
@@ -143,9 +171,20 @@ module RSpec
                             :defined
                           elsif order == 'recently-modified'
                             :recently_modified
+                          else
+                            order.to_sym
                           end
 
-          register_ordering(:global, ordering_registry.fetch(ordering_name)) if ordering_name
+          if ordering_name
+            strategy =
+              if ordering_registry.has_strategy?(ordering_name)
+                ordering_registry.fetch(ordering_name)
+              else
+                Delayed.new(ordering_registry, ordering_name)
+              end
+
+            register_ordering(:global, strategy)
+          end
         end
 
         def force(hash)

data/lib/rspec/core/output_wrapper.rb

@@ -15,13 +15,13 @@ module RSpec
       end
 
       def method_missing(name, *args, &block)
-        output.send(name, *args, &block)
+        output.__send__(name, *args, &block)
       end
 
       # Redirect calls for IO interface methods
       IO.instance_methods(false).each do |method|
         define_method(method) do |*args, &block|
-          output.send(method, *args, &block)
+          output.__send__(method, *args, &block)
         end
       end
     end

data/lib/rspec/core/project_initializer/spec/spec_helper.rb

@@ -61,7 +61,7 @@ RSpec.configure do |config|
 
   # Limits the available syntax to the non-monkey patched syntax that is
   # recommended. For more details, see:
-  # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
   config.disable_monkey_patching!
 
   # This setting enables warnings. It's recommended, but in some cases may

data/lib/rspec/core/reporter.rb

@@ -30,7 +30,7 @@ module RSpec::Core
     # Registers a listener to a list of notifications. The reporter will send
     # notification of events to all registered listeners.
     #
-    # @param listener [Object] An obect that wishes to be notified of reporter
+    # @param listener [Object] An object that wishes to be notified of reporter
     #   events
     # @param notifications [Array] Array of symbols represents the events a
     #   listener wishes to subscribe too

data/lib/rspec/core/runner.rb

@@ -182,7 +182,11 @@ module RSpec
           exit!(1)
         else
           RSpec.world.wants_to_quit = true
-          $stderr.puts "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit."
+
+          $stderr.puts(
+            "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit " \
+            "(warning: at_exit hooks will be skipped if you force quit)."
+          )
         end
       end
 

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.12.0'
+      STRING = '3.13.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-core
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 3.13.0
 platform: ruby
 authors:
 - Steven Baker
@@ -46,7 +46,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2024-02-04 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.12.0
+        version: 3.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 3.13.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.12.0/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-core/blob/v3.13.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
@@ -287,8 +287,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: rspec-core-3.12.0
+summary: rspec-core-3.13.0
 test_files: []