rspec-core 3.13.5 → 4.0.0.beta1

data/lib/rspec/core/configuration_options.rb

@@ -58,7 +58,7 @@ module RSpec
 
       UNFORCED_OPTIONS = Set.new([
         :requires, :profile, :drb, :libs, :files_or_directories_to_run,
-        :full_description, :full_backtrace, :tty
+        :full_description, :full_backtrace
       ])
 
       UNPROCESSABLE_OPTIONS = Set.new([:formatters])
@@ -111,7 +111,7 @@ module RSpec
       ]
 
       def process_options_into(config)
-        opts = options.reject { |k, _| UNPROCESSABLE_OPTIONS.include? k }
+        opts = options.except(*UNPROCESSABLE_OPTIONS)
 
         order(opts.keys).each do |key|
           force?(key) ? config.force(key => opts[key]) : config.__send__("#{key}=", opts[key])
@@ -174,18 +174,12 @@ module RSpec
         return [] unless path && File.exist?(path)
         config_string = options_file_as_erb_string(path)
         config_lines = config_string.split(/\n+/).reject { |s| s =~ /\A\s*#/ }
-        FlatMap.flat_map(config_lines, &:shellsplit)
+        config_lines.flat_map(&:shellsplit)
       end
 
-      # :nocov:
       def options_file_as_erb_string(path)
-        if RUBY_VERSION >= '2.6'
-          ERB.new(File.read(path), :trim_mode => '-').result(binding)
-        else
-          ERB.new(File.read(path), nil, '-').result(binding)
-        end
+        ERB.new(File.read(path), :trim_mode => '-').result(binding)
       end
-      # :nocov:
 
       def custom_options_file
         command_line_options[:custom_options_file]
@@ -228,12 +222,6 @@ module RSpec
 
       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

data/lib/rspec/core/drb.rb

@@ -40,12 +40,10 @@ 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]
         argv << "--fail-fast"    if @submitted_options[:fail_fast]
         argv << "--options"      << @submitted_options[:custom_options_file] if @submitted_options[:custom_options_file]
         argv << "--order"        << @submitted_options[:order]               if @submitted_options[:order]
@@ -86,11 +84,8 @@ module RSpec
         end
       end
 
-      CONDITIONAL_FILTERS = [:if, :unless]
-
       def add_filter(argv, name, hash)
         hash.each_pair do |k, v|
-          next if CONDITIONAL_FILTERS.include?(k)
           tag = name == :inclusion ? k.to_s.dup : "~#{k}".dup
           tag << ":#{v}" if v.is_a?(String)
           argv << "--tag" << tag

data/lib/rspec/core/dsl.rb

@@ -1,9 +1,7 @@
 module RSpec
   module Core
     # DSL defines methods to group examples, most notably `describe`,
-    # and exposes them as class methods of {RSpec}. They can also be
-    # exposed globally (on `main` and instances of `Module`) through
-    # the {Configuration} option `expose_dsl_globally`.
+    # and exposes them as class methods of {RSpec}.
     #
     # By default the methods `describe`, `context` and `example_group`
     # are exposed. These methods define a named context for one or
@@ -28,11 +26,6 @@ module RSpec
         @example_group_aliases ||= []
       end
 
-      # @private
-      def self.exposed_globally?
-        @exposed_globally ||= false
-      end
-
       # @private
       def self.expose_example_group_alias(name)
         return if example_group_aliases.include?(name)
@@ -44,55 +37,17 @@ module RSpec
           RSpec.world.record(group)
           group
         end
-
-        expose_example_group_alias_globally(name) if exposed_globally?
       end
 
       class << self
         # @private
         attr_accessor :top_level
       end
-
-      # Adds the describe method to Module and the top level binding.
-      # @api private
-      def self.expose_globally!
-        return if exposed_globally?
-
-        example_group_aliases.each do |method_name|
-          expose_example_group_alias_globally(method_name)
-        end
-
-        @exposed_globally = true
-      end
-
-      # Removes the describe method from Module and the top level binding.
-      # @api private
-      def self.remove_globally!
-        return unless exposed_globally?
-
-        example_group_aliases.each do |method_name|
-          change_global_dsl { undef_method method_name }
-        end
-
-        @exposed_globally = false
-      end
-
-      # @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
-
-      # @private
-      def self.change_global_dsl(&changes)
-        (class << top_level; self; end).class_exec(&changes)
-        Module.class_exec(&changes)
-      end
     end
   end
 end
 
 # Capture main without an eval.
+# rubocop:disable Style/RedundantConstantBase
 ::RSpec::Core::DSL.top_level = self
+# rubocop:enable Style/RedundantConstantBase

data/lib/rspec/core/example.rb

@@ -1,3 +1,5 @@
+RSpec::Support.require_rspec_support 'ruby_features'
+
 module RSpec
   module Core
     # Wrapper for an instance of a subclass of {ExampleGroup}. An instance of
@@ -34,7 +36,7 @@ module RSpec
     #     shared_examples "auditable" do
     #       it "does something" do
     #         log "#{example.full_description}: #{auditable.inspect}"
-    #         auditable.should do_something
+    #         expect(auditable).to do_something
     #       end
     #     end
     #
@@ -103,15 +105,6 @@ module RSpec
         end
       end
 
-      # Returns the location-based argument that can be passed to the `rspec` command to rerun this example.
-      #
-      # @deprecated Use {#location_rerun_argument} instead.
-      # @note If there are multiple examples identified by this location, they will use {#id}
-      #   to rerun instead, but this method will still return the location (that's why it is deprecated!).
-      def rerun_argument
-        location_rerun_argument
-      end
-
       # @return [String] the unique id of this example. Pass
       #   this at the command line to re-run this exact example.
       def id
@@ -296,7 +289,7 @@ module RSpec
         RSpec.current_example = nil
       end
 
-      if RSpec::Support::Ruby.jruby? || RUBY_VERSION.to_f < 1.9
+      if RSpec::Support::Ruby.jruby?
         # :nocov:
         # For some reason, rescuing `Support::AllExceptionsExceptOnesWeMustNotRescue`
         # in place of `Exception` above can cause the exit status to be the wrong
@@ -544,7 +537,7 @@ module RSpec
         RSpec::Matchers.generated_description
       rescue Support::AllExceptionsExceptOnesWeMustNotRescue => e
         location_description + " (Got an error when generating description " \
-          "from matcher: #{e.class}: #{e.message} -- #{e.backtrace.first})"
+                               "from matcher: #{e.class}: #{e.message} -- #{e.backtrace.first})"
       end
 
       def location_description
@@ -552,10 +545,7 @@ module RSpec
       end
 
       # Represents the result of executing an example.
-      # Behaves like a hash for backwards compatibility.
       class ExecutionResult
-        include HashImitatable
-
         # @return [Symbol] `:passed`, `:failed` or `:pending`.
         attr_accessor :status
 
@@ -617,32 +607,6 @@ module RSpec
           self.finished_at = finished_at
           self.run_time    = (finished_at - started_at).to_f
         end
-
-        # For backwards compatibility we present `status` as a string
-        # when presenting the legacy hash interface.
-        def hash_for_delegation
-          super.tap do |hash|
-            hash[:status] &&= status.to_s
-          end
-        end
-
-        def set_value(name, value)
-          value &&= value.to_sym if name == :status
-          super(name, value)
-        end
-
-        def get_value(name)
-          if name == :status
-            status.to_s if status
-          else
-            super
-          end
-        end
-
-        def issue_deprecation(_method_name, *_args)
-          RSpec.deprecate("Treating `metadata[:execution_result]` as a hash",
-                          :replacement => "the attributes methods to access the data")
-        end
       end
     end
 

data/lib/rspec/core/example_group.rb

@@ -321,12 +321,12 @@ module RSpec
       #     @return [RSpec::Core::ExampleGroup]
       #
       #   @see SharedExampleGroup
-      def self.define_nested_shared_group_method(new_name, report_label="it should behave like")
+      def self.define_nested_shared_group_method(new_name, report_label="behaves like")
         idempotently_define_singleton_method(new_name) do |name, *args, &customization_block|
           # Pass :caller so the :location metadata is set properly.
           # Otherwise, it'll be set to the next line because that's
           # the block's source_location.
-          group = example_group("#{report_label} #{name}", :caller => (the_caller = caller)) do
+          group = example_group("#{report_label} #{name}", :caller => (the_caller = caller(1, 1))) do
             find_and_eval_shared("examples", name, the_caller.first, *args, &customization_block)
           end
           group.metadata[:shared_group_name] = name
@@ -336,10 +336,7 @@ module RSpec
 
       # Generates a nested example group and includes the shared content
       # mapped to `name` in the nested group.
-      define_nested_shared_group_method :it_behaves_like, "behaves like"
-      # Generates a nested example group and includes the shared content
-      # mapped to `name` in the nested group.
-      define_nested_shared_group_method :it_should_behave_like
+      define_nested_shared_group_method :it_behaves_like
 
       # Includes shared content mapped to `name` directly in the group in which
       # it is declared, as opposed to `it_behaves_like`, which creates a nested
@@ -347,8 +344,10 @@ module RSpec
       # context.
       #
       # @see SharedExampleGroup
-      def self.include_context(name, *args, &block)
-        find_and_eval_shared("context", name, caller.first, *args, &block)
+      def self.include_context(name, *args)
+        issue_block_inclusion_error!("include_context") if block_given?
+
+        find_and_eval_shared("context", name, caller(1, 1).first, *args)
       end
 
       # Includes shared content mapped to `name` directly in the group in which
@@ -357,8 +356,10 @@ module RSpec
       # context.
       #
       # @see SharedExampleGroup
-      def self.include_examples(name, *args, &block)
-        find_and_eval_shared("examples", name, caller.first, *args, &block)
+      def self.include_examples(name, *args)
+        issue_block_inclusion_error!("include_examples") if block_given?
+
+        find_and_eval_shared("examples", name, caller(1, 1).first, *args)
       end
 
       # Clear memoized values when adding/removing examples
@@ -396,6 +397,15 @@ module RSpec
         )
       end
 
+      # @private
+      def self.issue_block_inclusion_error!(method)
+        raise ArgumentError,
+              "Do not pass a block to `#{method}`. " \
+              "Either use `it_behaves_like` to wrap the block " \
+              "contents in a context, or place the block content " \
+              "within the parent context."
+      end
+
       # @!endgroup
 
       # @private
@@ -415,14 +425,15 @@ module RSpec
 
       # @private
       def self.set_it_up(description, args, registration_collection, &example_group_block)
-        # Ruby 1.9 has a bug that can lead to infinite recursion and a
-        # SystemStackError if you include a module in a superclass after
+        # Historically Ruby had a bug that could lead to infinite recursion and a
+        # SystemStackError if you included a module in a superclass after
         # including it in a subclass: https://gist.github.com/845896
-        # To prevent this, we must include any modules in
-        # RSpec::Core::ExampleGroup before users create example groups and have
-        # a chance to include the same module in a subclass of
-        # RSpec::Core::ExampleGroup. So we need to configure example groups
-        # here.
+        #
+        # To prevent this, we included any modules in RSpec::Core::ExampleGroup
+        # before users create example groups and have a chance to include the same module
+        # in a subclass of RSpec::Core::ExampleGroup.
+        #
+        # This may be changed if a better use case comes up in future.
         ensure_example_groups_are_configured
 
         # Register the example with the group before creating the metadata hash.
@@ -466,7 +477,7 @@ module RSpec
       # @private
       def self.descendant_filtered_examples
         @descendant_filtered_examples ||= filtered_examples +
-          FlatMap.flat_map(children, &:descendant_filtered_examples)
+          children.flat_map(&:descendant_filtered_examples)
       end
 
       # @private
@@ -508,7 +519,7 @@ module RSpec
 
       # @private
       def self.descendants
-        @_descendants ||= [self] + FlatMap.flat_map(children, &:descendants)
+        @_descendants ||= [self] + children.flat_map(&:descendants)
       end
 
       ## @private
@@ -564,28 +575,9 @@ module RSpec
         @currently_executing_a_context_hook = false
       end
 
-      if RUBY_VERSION.to_f >= 1.9
-        # @private
-        def self.superclass_before_context_ivars
-          superclass.before_context_ivars
-        end
-      else # 1.8.7
-        # :nocov:
-        # @private
-        def self.superclass_before_context_ivars
-          if superclass.respond_to?(:before_context_ivars)
-            superclass.before_context_ivars
-          else
-            # `self` must be the singleton class of an ExampleGroup instance.
-            # On 1.8.7, the superclass of a singleton class of an instance of A
-            # is A's singleton class. On 1.9+, it's A. On 1.8.7, the first ancestor
-            # is A, so we can mirror 1.8.7's behavior here. Note that we have to
-            # search for the first that responds to `before_context_ivars`
-            # in case a module has been included in the singleton class.
-            ancestors.find { |a| a.respond_to?(:before_context_ivars) }.before_context_ivars
-          end
-        end
-        # :nocov:
+      # @private
+      def self.superclass_before_context_ivars
+        superclass.before_context_ivars
       end
 
       # @private
@@ -674,7 +666,7 @@ module RSpec
       def self.declaration_locations
         @declaration_locations ||= [Metadata.location_tuple_from(metadata)] +
           examples.map { |e| Metadata.location_tuple_from(e.metadata) } +
-          FlatMap.flat_map(children, &:declaration_locations)
+          children.flat_map(&:declaration_locations)
       end
 
       # @return [String] the unique id of this example group. Pass
@@ -693,20 +685,10 @@ module RSpec
         ivars.each { |name, value| instance.instance_variable_set(name, value) }
       end
 
-      if RUBY_VERSION.to_f < 1.9
-        # :nocov:
-        # @private
-        INSTANCE_VARIABLE_TO_IGNORE = '@__inspect_output'.freeze
-        # :nocov:
-      else
-        # @private
-        INSTANCE_VARIABLE_TO_IGNORE = :@__inspect_output
-      end
-
       # @private
       def self.each_instance_variable_for_example(group)
         group.instance_variables.each do |ivar|
-          yield ivar unless ivar == INSTANCE_VARIABLE_TO_IGNORE
+          yield ivar unless ivar == :@__inspect_output
         end
       end
 
@@ -721,15 +703,6 @@ module RSpec
         "#<#{self.class} #{@__inspect_output}>"
       end
 
-      unless method_defined?(:singleton_class) # for 1.8.7
-        # :nocov:
-        # @private
-        def singleton_class
-          class << self; self; end
-        end
-        # :nocov:
-      end
-
       # @private
       def self.update_inherited_metadata(updates)
         metadata.update(updates) do |key, existing_group_value, new_inherited_value|
@@ -811,7 +784,7 @@ module RSpec
       #   RSpec's built-in formatters.
       def description
         @description ||= "Shared Example Group: #{shared_group_name.inspect} " \
-          "called from #{formatted_inclusion_location}"
+                         "called from #{formatted_inclusion_location}"
       end
 
       # @private
@@ -887,18 +860,6 @@ module RSpec
       name
     end
 
-    if RUBY_VERSION == '1.9.2'
-      # :nocov:
-      class << self
-        alias _base_name_for base_name_for
-        def base_name_for(group)
-          _base_name_for(group) + '_'
-        end
-      end
-      private_class_method :_base_name_for
-      # :nocov:
-    end
-
     def self.disambiguate(name, const_scope)
       return name unless const_defined_on?(const_scope, name)
 

data/lib/rspec/core/filter_manager.rb

@@ -39,8 +39,6 @@ module RSpec
         # `examples` will be empty.
         return examples if examples.empty?
 
-        examples = prune_conditionally_filtered_examples(examples)
-
         if inclusions.standalone?
           examples.select { |e| inclusions.include_example?(e) }
         else
@@ -48,7 +46,7 @@ module RSpec
 
           examples.select do |ex|
             file_scoped_include?(ex.metadata, ids, locations) do
-              !exclusions.include_example?(ex) && non_scoped_inclusions.include_example?(ex)
+              (exclusions.empty? || !exclusions.include_example?(ex)) && non_scoped_inclusions.include_example?(ex)
             end
           end
         end
@@ -86,13 +84,6 @@ module RSpec
         inclusions.add(filter_key => filter)
       end
 
-      def prune_conditionally_filtered_examples(examples)
-        examples.reject do |ex|
-          meta = ex.metadata
-          !meta.fetch(:if, true) || meta[:unless]
-        end
-      end
-
       # When a user specifies a particular spec location, that takes priority
       # over any exclusion filters (such as if the spec is tagged with `:slow`
       # and there is a `:slow => true` exclusion filter), but only for specs
@@ -175,7 +166,7 @@ module RSpec
       end
 
       def include_example?(example)
-        MetadataFilter.apply?(:any?, @rules, example.metadata)
+        MetadataFilter.apply?(@rules, example.metadata)
       end
     end
 

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

@@ -58,15 +58,15 @@ module RSpec
         EOS
 
         DEPRECATION_STREAM_NOTICE = "Pass `--deprecation-out` or set " \
-          "`config.deprecation_stream` to a file for full output."
+                                    "`config.deprecation_stream` to a file for full output."
         TOO_MANY_WARNINGS_NOTICE  = "Too many similar deprecation messages " \
-          "reported, disregarding further reports. #{DEPRECATION_STREAM_NOTICE}"
+                                    "reported, disregarding further reports. #{DEPRECATION_STREAM_NOTICE}"
 
         # @private
         SpecifiedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @message = data.message
-            super deprecation_type_for(data)
+            super(deprecation_type_for(data))
           end
 
           def to_s
@@ -94,7 +94,7 @@ module RSpec
         GeneratedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @data = data
-            super data.deprecated
+            super(data.deprecated)
           end
 
           def to_s

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 RSpec::Support.require_rspec_core "formatters/console_codes"
 RSpec::Support.require_rspec_core "formatters/snippet_extractor"
 RSpec::Support.require_rspec_core 'formatters/syntax_highlighter'
@@ -11,8 +10,10 @@ module RSpec
       class ExceptionPresenter
         attr_reader :exception, :example, :description, :message_color,
                     :detail_formatter, :extra_detail_formatter, :backtrace_formatter
-        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter
 
+        # We want private attr_reader but that issues a warning on older rubies, refactor later
+        #
+        private :message_color, :detail_formatter, :extra_detail_formatter, :backtrace_formatter
         def initialize(exception, example, options={})
           @exception               = exception
           @example                 = example
@@ -41,38 +42,30 @@ module RSpec
             formatted_cause(exception)
         end
 
-        if RSpec::Support::RubyFeatures.supports_exception_cause?
-          def formatted_cause(exception)
-            last_cause = final_exception(exception, [exception])
-            cause = []
+        def formatted_cause(exception)
+          last_cause = final_exception(exception, [exception])
+          cause = []
 
-            if exception.cause
-              cause << '------------------'
-              cause << '--- Caused by: ---'
-              cause << "#{exception_class_name(last_cause)}:" unless exception_class_name(last_cause) =~ /RSpec/
+          if exception.cause
+            cause << '------------------'
+            cause << '--- Caused by: ---'
+            cause << "#{exception_class_name(last_cause)}:" unless exception_class_name(last_cause) =~ /RSpec/
 
-              encoded_string(exception_message_string(last_cause)).split("\n").each do |line|
-                cause << "  #{line}"
-              end
+            encoded_string(exception_message_string(last_cause)).split("\n").each do |line|
+              cause << "  #{line}"
+            end
 
-              unless last_cause.backtrace.nil? || last_cause.backtrace.empty?
-                lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)
-                lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace # rubocop:disable Metrics/BlockNesting
+            unless last_cause.backtrace.nil? || last_cause.backtrace.empty?
+              lines = backtrace_formatter.format_backtrace(last_cause.backtrace, example.metadata)
+              lines = [lines[0]] unless RSpec.configuration.full_cause_backtrace
 
-                lines.each do |line|
-                  cause << ("  #{line}")
-                end
+              lines.each do |line|
+                cause << ("  #{line}")
               end
             end
-
-            cause
-          end
-        else
-          # :nocov:
-          def formatted_cause(_)
-            []
           end
-          # :nocov:
+
+          cause
         end
 
         def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
@@ -112,23 +105,12 @@ module RSpec
           end
         end
 
-        if String.method_defined?(:encoding)
-          def encoding_of(string)
-            string.encoding
-          end
-
-          def encoded_string(string)
-            RSpec::Support::EncodedString.new(string, Encoding.default_external)
-          end
-        else # for 1.8.7
-          # :nocov:
-          def encoding_of(_string)
-          end
+        def encoding_of(string)
+          string.encoding
+        end
 
-          def encoded_string(string)
-            RSpec::Support::EncodedString.new(string)
-          end
-          # :nocov:
+        def encoded_string(string)
+          RSpec::Support::EncodedString.new(string, Encoding.default_external)
         end
 
         def indent_lines(lines, failure_number)
@@ -181,7 +163,7 @@ module RSpec
 
         # rubocop:disable Lint/RescueException
         # :nocov:
-        if SyntaxError.instance_methods.include?(:detailed_message)
+        if SyntaxError.method_defined?(:detailed_message)
           def exception_message_string(exception)
             case exception
             when SyntaxError then exception.detailed_message.to_s
@@ -253,10 +235,6 @@ module RSpec
           ["Unable to find #{file_path} to read failed line"]
         rescue SnippetExtractor::NoSuchLineError
           ["Unable to find matching line in #{file_path}"]
-        rescue SecurityError
-          # :nocov: - SecurityError is no longer produced starting in ruby 2.7
-          ["Unable to read failed line"]
-          # :nocov:
         end
 
         def find_failed_line
@@ -283,17 +261,9 @@ module RSpec
           end
         end
 
-        if  String.method_defined?(:encoding)
-          def encoded_description(description)
-            return if description.nil?
-            encoded_string(description)
-          end
-        else # for 1.8.7
-          # :nocov:
-          def encoded_description(description)
-            description
-          end
-          # :nocov:
+        def encoded_description(description)
+          return if description.nil?
+          encoded_string(description)
         end
 
         def exception_backtrace
@@ -392,7 +362,7 @@ module RSpec
             common_backtrace_truncater = CommonBacktraceTruncater.new(exception)
 
             lambda do |failure_number, colorizer|
-              FlatMap.flat_map(exception.all_exceptions.each_with_index) do |failure, index|
+              exception.all_exceptions.each_with_index.flat_map do |failure, index|
                 options = with_multiple_error_options_as_needed(
                   failure,
                   :description             => nil,