rspec-core 3.0.4 → 3.12.2

data/lib/rspec/core/configuration_options.rb

@@ -1,12 +1,12 @@
 require 'erb'
 require 'shellwords'
-require 'set'
 
 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)
@@ -36,34 +36,39 @@ module RSpec
       # @return [Hash] the final merged options, drawn from all external sources
       attr_reader :options
 
+      # @return [Array<String>] the original command-line arguments
+      attr_reader :args
+
     private
 
       def organize_options
         @filter_manager_options = []
 
-        @options = (file_options << command_line_options << env_options).each { |opts|
+        @options = (file_options << command_line_options << env_options).each do |opts|
           @filter_manager_options << [:include, opts.delete(:inclusion_filter)] if opts.key?(:inclusion_filter)
           @filter_manager_options << [:exclude, opts.delete(:exclusion_filter)] if opts.key?(:exclusion_filter)
-        }.inject(:libs => [], :requires => []) { |hash, opts|
-          hash.merge(opts) { |key, oldval, newval|
+        end
+
+        @options = @options.inject(:libs => [], :requires => []) do |hash, opts|
+          hash.merge(opts) do |key, oldval, newval|
             [:libs, :requires].include?(key) ? oldval + newval : newval
-          }
-        }
+          end
+        end
       end
 
-      UNFORCED_OPTIONS = [
+      UNFORCED_OPTIONS = Set.new([
         :requires, :profile, :drb, :libs, :files_or_directories_to_run,
         :full_description, :full_backtrace, :tty
-      ].to_set
+      ])
 
-      UNPROCESSABLE_OPTIONS = [:formatters].to_set
+      UNPROCESSABLE_OPTIONS = Set.new([:formatters])
 
       def force?(key)
         !UNFORCED_OPTIONS.include?(key)
       end
 
       def order(keys)
-        OPTIONS_ORDER.reverse.each do |key|
+        OPTIONS_ORDER.reverse_each do |key|
           keys.unshift(key) if keys.delete(key)
         end
         keys
@@ -80,17 +85,24 @@ module RSpec
 
         # `files_or_directories_to_run` uses `default_path` so it must be
         # set before it.
-        :default_path,
-
-        # These must be set before `requires` to support checking `config.files_to_run`
-        # from within `spec_helper.rb` when a `-rspec_helper` option is used.
-        :files_or_directories_to_run, :pattern,
-
-        # In general, we want to require the specified files as early as possible.
-        # The `--require` option is specifically intended to allow early requires.
-        # For later requires, they can just put the require in their spec files, but
-        # `--require` provides a unique opportunity for users to instruct RSpec to
-        # load an extension file early for maximum flexibility.
+        :default_path, :only_failures,
+
+        # These must be set before `requires` to support checking
+        # `config.files_to_run` from within `spec_helper.rb` when a
+        # `-rspec_helper` option is used.
+        :files_or_directories_to_run, :pattern, :exclude_pattern,
+
+        # Necessary so that the `--seed` option is applied before requires,
+        # in case required files do something with the provided seed.
+        # (such as seed global randomization with it).
+        :order,
+
+        # In general, we want to require the specified files as early as
+        # possible. The `--require` option is specifically intended to allow
+        # early requires. For later requires, they can just put the require in
+        # their spec files, but `--require` provides a unique opportunity for
+        # users to instruct RSpec to load an extension file early for maximum
+        # flexibility.
         :requires
       ]
 
@@ -107,15 +119,24 @@ 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
-        ENV["SPEC_OPTS"] ? Parser.parse(Shellwords.split(ENV["SPEC_OPTS"])) : {}
+        return {} unless ENV['SPEC_OPTS']
+
+        parse_args_ignoring_files_or_dirs_to_run(
+          Shellwords.split(ENV["SPEC_OPTS"]),
+          "ENV['SPEC_OPTS']"
+        )
       end
 
       def command_line_options
-        @command_line_options ||= Parser.parse(@args).merge :files_or_directories_to_run => @args
+        @command_line_options ||= Parser.parse(@args)
       end
 
       def custom_options
@@ -135,7 +156,14 @@ module RSpec
       end
 
       def options_from(path)
-        Parser.parse(args_from_options_file(path))
+        args = args_from_options_file(path)
+        parse_args_ignoring_files_or_dirs_to_run(args, path)
+      end
+
+      def parse_args_ignoring_files_or_dirs_to_run(args, source)
+        options = Parser.parse(args, source)
+        options.delete(:files_or_directories_to_run)
+        options
       end
 
       def args_from_options_file(path)
@@ -145,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
@@ -153,21 +185,49 @@ module RSpec
       end
 
       def project_options_file
-        ".rspec"
+        "./.rspec"
       end
 
       def local_options_file
-        ".rspec-local"
+        "./.rspec-local"
       end
 
       def global_options_file
-        begin
-          File.join(File.expand_path("~"), ".rspec")
-        rescue ArgumentError
-          RSpec.warning "Unable to find ~/.rspec because the HOME environment variable is not set"
-          nil
+        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:
+        RSpec.warning "Unable to find ~/.rspec because the HOME environment variable is not set"
+        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/drb.rb

@@ -41,6 +41,8 @@ module RSpec
       def options
         argv = []
         argv << "--color"        if @submitted_options[:color]
+        argv << "--force-color"  if @submitted_options[:color_mode] == :on
+        argv << "--no-color"     if @submitted_options[:color_mode] == :off
         argv << "--profile"      if @submitted_options[:profile_examples]
         argv << "--backtrace"    if @submitted_options[:full_backtrace]
         argv << "--tty"          if @submitted_options[:tty]
@@ -49,6 +51,7 @@ module RSpec
         argv << "--order"        << @submitted_options[:order]               if @submitted_options[:order]
 
         add_failure_exit_code(argv)
+        add_error_exit_code(argv)
         add_full_description(argv)
         add_filter(argv, :inclusion, @filter_manager.inclusions)
         add_filter(argv, :exclusion, @filter_manager.exclusions)
@@ -60,20 +63,26 @@ module RSpec
       end
 
       def add_failure_exit_code(argv)
-        if @submitted_options[:failure_exit_code]
-          argv << "--failure-exit-code" << @submitted_options[:failure_exit_code].to_s
-        end
+        return unless @submitted_options[:failure_exit_code]
+
+        argv << "--failure-exit-code" << @submitted_options[:failure_exit_code].to_s
+      end
+
+      def add_error_exit_code(argv)
+        return unless @submitted_options[:error_exit_code]
+
+        argv << "--error-exit-code" << @submitted_options[:error_exit_code].to_s
       end
 
       def add_full_description(argv)
-        if @submitted_options[:full_description]
-          # The argument to --example is regexp-escaped before being stuffed
-          # into a regexp when received for the first time (see OptionParser).
-          # Hence, merely grabbing the source of this regexp will retain the
-          # backslashes, so we must remove them.
-          @submitted_options[:full_description].each do |description|
-            argv << "--example" << description.source.delete('\\')
-          end
+        return unless @submitted_options[:full_description]
+
+        # The argument to --example is regexp-escaped before being stuffed
+        # into a regexp when received for the first time (see OptionParser).
+        # Hence, merely grabbing the source of this regexp will retain the
+        # backslashes, so we must remove them.
+        @submitted_options[:full_description].each do |description|
+          argv << "--example" << description.source.delete('\\')
         end
       end
 
@@ -82,7 +91,7 @@ module RSpec
       def add_filter(argv, name, hash)
         hash.each_pair do |k, v|
           next if CONDITIONAL_FILTERS.include?(k)
-          tag = name == :inclusion ? k.to_s : "~#{k}"
+          tag = name == :inclusion ? k.to_s : "~#{k}".dup
           tag << ":#{v}" if v.is_a?(String)
           argv << "--tag" << tag
         end unless hash.empty?

data/lib/rspec/core/dsl.rb

@@ -8,7 +8,7 @@ module RSpec
     # By default the methods `describe`, `context` and `example_group`
     # are exposed. These methods define a named context for one or
     # more examples. The given block is evaluated in the context of
-    # a generated subclass of {RSpec::Core::ExampleGroup}
+    # a generated subclass of {RSpec::Core::ExampleGroup}.
     #
     # ## Examples:
     #
@@ -35,10 +35,14 @@ module RSpec
 
       # @private
       def self.expose_example_group_alias(name)
+        return if example_group_aliases.include?(name)
+
         example_group_aliases << name
 
         (class << RSpec; self; end).__send__(:define_method, name) do |*args, &example_group_block|
-          RSpec.world.register RSpec::Core::ExampleGroup.__send__(name, *args, &example_group_block)
+          group = RSpec::Core::ExampleGroup.__send__(name, *args, &example_group_block)
+          RSpec.world.record(group)
+          group
         end
 
         expose_example_group_alias_globally(name) if exposed_globally?
@@ -49,7 +53,7 @@ module RSpec
         attr_accessor :top_level
       end
 
-      # Adds the describe method to Module and the top level binding
+      # Adds the describe method to Module and the top level binding.
       # @api private
       def self.expose_globally!
         return if exposed_globally?
@@ -61,7 +65,7 @@ module RSpec
         @exposed_globally = true
       end
 
-      # Removes the describe method from Module and the top level binding
+      # Removes the describe method from Module and the top level binding.
       # @api private
       def self.remove_globally!
         return unless exposed_globally?
@@ -76,6 +80,7 @@ module RSpec
       # @private
       def self.expose_example_group_alias_globally(method_name)
         change_global_dsl do
+          remove_method(method_name) if method_defined?(method_name)
           define_method(method_name) { |*a, &b| ::RSpec.__send__(method_name, *a, &b) }
         end
       end
@@ -85,10 +90,9 @@ module RSpec
         (class << top_level; self; end).class_exec(&changes)
         Module.class_exec(&changes)
       end
-
     end
   end
 end
 
-# capture main without an eval
+# Capture main without an eval.
 ::RSpec::Core::DSL.top_level = self