rspec-core 3.7.1 → 3.9.3

data/lib/rspec/core/configuration_options.rb

@@ -4,8 +4,9 @@ require 'shellwords'
 module RSpec
   module Core
     # Responsible for utilizing externally provided configuration options,
-    # whether via the command line, `.rspec`, `~/.rspec`, `.rspec-local`
-    # or a custom options file.
+    # whether via the command line, `.rspec`, `~/.rspec`,
+    # `$XDG_CONFIG_HOME/rspec/options`, `.rspec-local` or a custom options
+    # file.
     class ConfigurationOptions
       # @param args [Array<String>] command line arguments
       def initialize(args)
@@ -118,7 +119,11 @@ module RSpec
       end
 
       def file_options
-        custom_options_file ? [custom_options] : [global_options, project_options, local_options]
+        if custom_options_file
+          [custom_options]
+        else
+          [global_options, project_options, local_options]
+        end
       end
 
       def env_options
@@ -168,7 +173,11 @@ module RSpec
       end
 
       def options_file_as_erb_string(path)
-        ERB.new(File.read(path), nil, '-').result(binding)
+        if RUBY_VERSION >= '2.6'
+          ERB.new(File.read(path), :trim_mode => '-').result(binding)
+        else
+          ERB.new(File.read(path), nil, '-').result(binding)
+        end
       end
 
       def custom_options_file
@@ -184,6 +193,17 @@ module RSpec
       end
 
       def global_options_file
+        xdg_options_file_if_exists || home_options_file_path
+      end
+
+      def xdg_options_file_if_exists
+        path = xdg_options_file_path
+        if path && File.exist?(path)
+          path
+        end
+      end
+
+      def home_options_file_path
         File.join(File.expand_path("~"), ".rspec")
       rescue ArgumentError
         # :nocov:
@@ -191,6 +211,23 @@ module RSpec
         nil
         # :nocov:
       end
+
+      def xdg_options_file_path
+        xdg_config_home = resolve_xdg_config_home
+        if xdg_config_home
+          File.join(xdg_config_home, "rspec", "options")
+        end
+      end
+
+      def resolve_xdg_config_home
+        File.expand_path(ENV.fetch("XDG_CONFIG_HOME", "~/.config"))
+      rescue ArgumentError
+        # :nocov:
+        # On Ruby 2.4, `File.expand("~")` works even if `ENV['HOME']` is not set.
+        # But on earlier versions, it fails.
+        nil
+        # :nocov:
+      end
     end
   end
 end

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

data/lib/rspec/core/example.rb

@@ -203,10 +203,13 @@ module RSpec
           description, example_block
         )
 
+        config = RSpec.configuration
+        config.apply_derived_metadata_to(@metadata)
+
         # This should perhaps be done in `Metadata::ExampleHash.create`,
         # but the logic there has no knowledge of `RSpec.world` and we
         # want to keep it that way. It's easier to just assign it here.
-        @metadata[:last_run_status] = RSpec.configuration.last_run_statuses[id]
+        @metadata[:last_run_status] = config.last_run_statuses[id]
 
         @example_group_instance = @exception = nil
         @clock = RSpec::Core::Time
@@ -228,8 +231,13 @@ module RSpec
         @example_group_class
       end
 
-      alias_method :pending?, :pending
-      alias_method :skipped?, :skip
+      def pending?
+        !!pending
+      end
+
+      def skipped?
+        !!skip
+      end
 
       # @api private
       # instance_execs the block passed to the constructor in the context of
@@ -393,7 +401,7 @@ module RSpec
         end
       end
 
-      # rubocop:disable Style/AccessorMethodName
+      # rubocop:disable Naming/AccessorMethodName
 
       # @private
       #
@@ -420,7 +428,7 @@ module RSpec
         self.display_exception = exception
       end
 
-      # rubocop:enable Style/AccessorMethodName
+      # rubocop:enable Naming/AccessorMethodName
 
       # @private
       #
@@ -574,7 +582,9 @@ module RSpec
         #   this indicates whether or not it now passes.
         attr_accessor :pending_fixed
 
-        alias pending_fixed? pending_fixed
+        def pending_fixed?
+          !!pending_fixed
+        end
 
         # @return [Boolean] Indicates if the example was completely skipped
         #   (typically done via `:skip` metadata or the `skip` method). Skipped examples
@@ -642,12 +652,12 @@ module RSpec
         @reporter = reporter
       end
 
-      # rubocop:disable Style/AccessorMethodName
+      # rubocop:disable Naming/AccessorMethodName
       def set_exception(exception)
         reporter.notify_non_example_exception(exception, "An error occurred in #{description}.")
         RSpec.world.wants_to_quit = true
       end
-      # rubocop:enable Style/AccessorMethodName
+      # rubocop:enable Naming/AccessorMethodName
     end
   end
 end

data/lib/rspec/core/example_group.rb

@@ -7,7 +7,7 @@ module RSpec
     # ExampleGroup and {Example} are the main structural elements of
     # rspec-core. Consider this example:
     #
-    #     describe Thing do
+    #     RSpec.describe Thing do
     #       it "does something" do
     #       end
     #     end
@@ -90,7 +90,7 @@ module RSpec
       # Returns the class or module passed to the `describe` method (or alias).
       # Returns nil if the subject is not a class or module.
       # @example
-      #     describe Thing do
+      #     RSpec.describe Thing do
       #       it "does something" do
       #         described_class == Thing
       #       end
@@ -107,19 +107,18 @@ module RSpec
       # @private
       # @macro [attach] define_example_method
       #   @!scope class
+      #   @method $1
       #   @overload $1
       #   @overload $1(&example_implementation)
       #     @param example_implementation [Block] The implementation of the example.
-      #   @overload $1(doc_string, *metadata_keys, metadata={})
+      #   @overload $1(doc_string, *metadata)
       #     @param doc_string [String] The example's doc string.
-      #     @param metadata [Hash] Metadata for the example.
-      #     @param metadata_keys [Array<Symbol>] Metadata tags for the example.
-      #       Will be transformed into hash entries with `true` values.
-      #   @overload $1(doc_string, *metadata_keys, metadata={}, &example_implementation)
+      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.
+      #       Symbols will be transformed into hash entries with `true` values.
+      #   @overload $1(doc_string, *metadata, &example_implementation)
       #     @param doc_string [String] The example's doc string.
-      #     @param metadata [Hash] Metadata for the example.
-      #     @param metadata_keys [Array<Symbol>] Metadata tags for the example.
-      #       Will be transformed into hash entries with `true` values.
+      #     @param metadata [Array<Symbol>, Hash] Metadata for the example.
+      #       Symbols will be transformed into hash entries with `true` values.
       #     @param example_implementation [Block] The implementation of the example.
       #   @yield [Example] the example object
       #   @example
@@ -138,6 +137,11 @@ module RSpec
       #     $1 "does something" do |ex|
       #       # ex is the Example object that contains metadata about the example
       #     end
+      #
+      #  @example
+      #     $1 "does something", :slow, :load_factor => 100 do
+      #     end
+      #
       def self.define_example_method(name, extra_options={})
         idempotently_define_singleton_method(name) do |*all_args, &block|
           desc, *args = *all_args
@@ -203,11 +207,10 @@ module RSpec
       #   @overload $1
       #   @overload $1(&example_group_definition)
       #     @param example_group_definition [Block] The definition of the example group.
-      #   @overload $1(doc_string, *metadata_keys, metadata={}, &example_implementation)
+      #   @overload $1(doc_string, *metadata, &example_implementation)
       #     @param doc_string [String] The group's doc string.
-      #     @param metadata [Hash] Metadata for the group.
-      #     @param metadata_keys [Array<Symbol>] Metadata tags for the group.
-      #       Will be transformed into hash entries with `true` values.
+      #     @param metadata [Array<Symbol>, Hash] Metadata for the group.
+      #       Symbols will be transformed into hash entries with `true` values.
       #     @param example_group_definition [Block] The definition of the example group.
       #
       #   Generates a subclass of this example group which inherits
@@ -222,12 +225,21 @@ module RSpec
       #         do_something_before
       #       end
       #
+      #       before(:example, :clean_env) do
+      #         env.clear!
+      #       end
+      #
       #       let(:thing) { Thing.new }
       #
       #       $1 "attribute (of something)" do
       #         # examples in the group get the before hook
       #         # declared above, and can access `thing`
       #       end
+      #
+      #       $1 "needs additional setup", :clean_env, :implementation => JSON do
+      #         # specifies that hooks with matching metadata
+      #         # should be be run additionally
+      #       end
       #     end
       #
       # @see DSL#describe
@@ -423,11 +435,15 @@ module RSpec
           superclass.method(:next_runnable_index_for),
           description, *args, &example_group_block
         )
+
+        config = RSpec.configuration
+        config.apply_derived_metadata_to(@metadata)
+
         ExampleGroups.assign_const(self)
 
         @currently_executing_a_context_hook = false
 
-        RSpec.configuration.configure_group(self)
+        config.configure_group(self)
       end
 
       # @private
@@ -745,8 +761,9 @@ module RSpec
                 "on an example group (e.g. a `describe` or `context` block)."
         end
 
-        super
+        super(name, *args)
       end
+      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
     end
     # rubocop:enable Metrics/ClassLength
 

data/lib/rspec/core/filter_manager.rb

@@ -113,7 +113,7 @@ module RSpec
 
     # @private
     class FilterRules
-      PROC_HEX_NUMBER = /0x[0-9a-f]+@/
+      PROC_HEX_NUMBER = /0x[0-9a-f]+@?/
       PROJECT_DIR = File.expand_path('.')
 
       attr_accessor :opposite

data/lib/rspec/core/formatters.rb

@@ -1,4 +1,5 @@
 RSpec::Support.require_rspec_support "directory_maker"
+
 # ## Built-in Formatters
 #
 # * progress (default) - Prints dots for passing examples, `F` for failures, `*`
@@ -72,8 +73,9 @@ module RSpec::Core::Formatters
   autoload :ProgressFormatter,        'rspec/core/formatters/progress_formatter'
   autoload :ProfileFormatter,         'rspec/core/formatters/profile_formatter'
   autoload :JsonFormatter,            'rspec/core/formatters/json_formatter'
-  autoload :BisectFormatter,          'rspec/core/formatters/bisect_formatter'
+  autoload :BisectDRbFormatter,       'rspec/core/formatters/bisect_drb_formatter'
   autoload :ExceptionPresenter,       'rspec/core/formatters/exception_presenter'
+  autoload :FailureListFormatter,     'rspec/core/formatters/failure_list_formatter'
 
   # Register the formatter class
   # @param formatter_class [Class] formatter class to register
@@ -133,9 +135,6 @@ module RSpec::Core::Formatters
       end
 
       return unless RSpec.configuration.profile_examples?
-
-      @reporter.setup_profiler
-
       return if existing_formatter_implements?(:dump_profile)
 
       add RSpec::Core::Formatters::ProfileFormatter, output_stream
@@ -143,6 +142,13 @@ module RSpec::Core::Formatters
 
     # @private
     def add(formatter_to_use, *paths)
+      # If a formatter instance was passed, we can register it directly,
+      # with no need for any of the further processing that happens below.
+      if Loader.formatters.key?(formatter_to_use.class)
+        register formatter_to_use, notifications_for(formatter_to_use.class)
+        return
+      end
+
       formatter_class = find_formatter(formatter_to_use)
 
       args = paths.map { |p| p.respond_to?(:puts) ? p : open_stream(p) }
@@ -206,8 +212,10 @@ module RSpec::Core::Formatters
         ProgressFormatter
       when 'j', 'json'
         JsonFormatter
-      when 'bisect'
-        BisectFormatter
+      when 'bisect-drb'
+        BisectDRbFormatter
+      when 'f', 'failures'
+        FailureListFormatter
       end
     end
 

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

@@ -0,0 +1,45 @@
+RSpec::Support.require_rspec_core "bisect/utilities"
+
+module RSpec
+  module Core
+    module Formatters
+      # Contains common logic for formatters used by `--bisect` to communicate results
+      # back to the bisect runner.
+      #
+      # Subclasses must define a `notify_results(all_example_ids, failed_example_ids)`
+      # method.
+      # @private
+      class BaseBisectFormatter
+        def self.inherited(formatter)
+          Formatters.register formatter, :start_dump, :example_failed, :example_finished
+        end
+
+        def initialize(expected_failures)
+          @all_example_ids = []
+          @failed_example_ids = []
+          @remaining_failures = expected_failures
+        end
+
+        def example_failed(notification)
+          @failed_example_ids << notification.example.id
+        end
+
+        def example_finished(notification)
+          @all_example_ids << notification.example.id
+          return unless @remaining_failures.include?(notification.example.id)
+          @remaining_failures.delete(notification.example.id)
+
+          status = notification.example.execution_result.status
+          return if status == :failed && !@remaining_failures.empty?
+          RSpec.world.wants_to_quit = true
+        end
+
+        def start_dump(_notification)
+          # `notify_results` is defined in the subclass
+          notify_results(Bisect::ExampleSetDescriptor.new(
+            @all_example_ids, @failed_example_ids))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'drb/drb'
+RSpec::Support.require_rspec_core "formatters/base_bisect_formatter"
+
+module RSpec
+  module Core
+    module Formatters
+      # Used by `--bisect`. When it shells out and runs a portion of the suite, it uses
+      # this formatter as a means to have the status reported back to it, via DRb.
+      #
+      # Note that since DRb calls carry considerable overhead compared to normal
+      # method calls, we try to minimize the number of DRb calls for perf reasons,
+      # opting to communicate only at the start and the end of the run, rather than
+      # after each example.
+      # @private
+      class BisectDRbFormatter < BaseBisectFormatter
+        def initialize(_output)
+          drb_uri = "druby://localhost:#{RSpec.configuration.drb_port}"
+          @bisect_server = DRbObject.new_with_uri(drb_uri)
+          RSpec.configuration.files_or_directories_to_run = @bisect_server.files_or_directories_to_run
+          super(Set.new(@bisect_server.expected_failures))
+        end
+
+        def notify_results(results)
+          @bisect_server.latest_run_results = results
+        end
+      end
+    end
+  end
+end