rspec-core 3.1.7 → 3.2.0

data/lib/rspec/core/minitest_assertions_adapter.rb

@@ -1,9 +1,9 @@
 begin
-  # Only the minitest 5.x gem includes the minitest.rb and assertions.rb files
+  # Only the minitest 5.x gem includes the minitest.rb and assertions.rb files.
   require 'minitest'
   require 'minitest/assertions'
 rescue LoadError
-  # We must be using Ruby Core's MiniTest or the Minitest gem 4.x
+  # We must be using Ruby Core's MiniTest or the Minitest gem 4.x.
   require 'minitest/unit'
   Minitest = MiniTest
 end
@@ -13,6 +13,9 @@ module RSpec
     # @private
     module MinitestAssertionsAdapter
       include ::Minitest::Assertions
+      # Need to forcefully include Pending after Minitest::Assertions
+      # to make sure our own #skip method beats Minitest's.
+      include ::RSpec::Core::Pending
 
       # Minitest 5.x requires this accessor to be available. See
       # https://github.com/seattlerb/minitest/blob/38f0a5fcbd9c37c3f80a3eaad4ba84d3fc9947a0/lib/minitest/assertions.rb#L8

data/lib/rspec/core/mocking_adapters/flexmock.rb

@@ -15,7 +15,7 @@ module RSpec
         end
 
         def setup_mocks_for_rspec
-          # No setup required
+          # No setup required.
         end
 
         def verify_mocks_for_rspec

data/lib/rspec/core/mocking_adapters/mocha.rb

@@ -2,22 +2,22 @@
 # hoops here.
 #
 # mocha >= '0.13.0':
-#   require 'mocha/api' is required
-#   require 'mocha/object' raises a LoadError b/c the file no longer exists
+#   require 'mocha/api' is required.
+#   require 'mocha/object' raises a LoadError b/c the file no longer exists.
 # mocha < '0.13.0', >= '0.9.7'
-#   require 'mocha/api' is required
-#   require 'mocha/object' is required
+#   require 'mocha/api' is required.
+#   require 'mocha/object' is required.
 # mocha < '0.9.7':
-#   require 'mocha/api' raises a LoadError b/c the file does not yet exist
-#   require 'mocha/standalone' is required
-#   require 'mocha/object' is required
+#   require 'mocha/api' raises a LoadError b/c the file does not yet exist.
+#   require 'mocha/standalone' is required.
+#   require 'mocha/object' is required.
 begin
   require 'mocha/api'
 
   begin
     require 'mocha/object'
   rescue LoadError
-    # Mocha >= 0.13.0 no longer contains this file nor needs it to be loaded
+    # Mocha >= 0.13.0 no longer contains this file nor needs it to be loaded.
   end
 rescue LoadError
   require 'mocha/standalone'

data/lib/rspec/core/notifications.rb

@@ -32,17 +32,25 @@ module RSpec::Core
     #   end
     #
     # @attr example [RSpec::Core::Example] the current example
-    ExampleNotification = Struct.new(:example) do
+    ExampleNotification = Struct.new(:example)
+    class ExampleNotification
       # @private
       def self.for(example)
-        if example.execution_result.pending_fixed?
+        execution_result = example.execution_result
+
+        if execution_result.pending_fixed?
           PendingExampleFixedNotification.new(example)
-        elsif example.execution_result.status == :failed
+        elsif execution_result.example_skipped?
+          SkippedExampleNotification.new(example)
+        elsif execution_result.status == :pending
+          PendingExampleFailedAsExpectedNotification.new(example)
+        elsif execution_result.status == :failed
           FailedExampleNotification.new(example)
         else
           new(example)
         end
       end
+
       private_class_method :new
     end
 
@@ -59,35 +67,42 @@ module RSpec::Core
         @reporter = reporter
       end
 
-      # @return [Array(RSpec::Core::Example)] list of examples
+      # @return [Array<RSpec::Core::Example>] list of examples
       def examples
         @reporter.examples
       end
 
-      # @return [Array(RSpec::Core::Example)] list of failed examples
+      # @return [Array<RSpec::Core::Example>] list of failed examples
       def failed_examples
         @reporter.failed_examples
       end
 
-      # @return [Array(RSpec::Core::Example)] list of pending examples
+      # @return [Array<RSpec::Core::Example>] list of pending examples
       def pending_examples
         @reporter.pending_examples
       end
 
-      # @return [Array(Rspec::Core::Notifications::ExampleNotification]
+      # @return [Array<RSpec::Core::Notifications::ExampleNotification>]
       #         returns examples as notifications
       def notifications
         @notifications ||= format_examples(examples)
       end
 
-      # @return [Array(Rspec::Core::Notifications::FailedExampleNotification]
+      # @return [Array<RSpec::Core::Notifications::FailedExampleNotification>]
       #         returns failed examples as notifications
       def failure_notifications
         @failed_notifications ||= format_examples(failed_examples)
       end
 
-      # @return [String] The list of failed examples, fully formatted in the way that
-      #   RSpec's built-in formatters emit.
+      # @return [Array<RSpec::Core::Notifications::SkippedExampleNotification,
+      #                 RSpec::Core::Notifications::PendingExampleFailedAsExpectedNotification>]
+      #         returns pending examples as notifications
+      def pending_notifications
+        @pending_notifications ||= format_examples(pending_examples)
+      end
+
+      # @return [String] The list of failed examples, fully formatted in the way
+      #   that RSpec's built-in formatters emit.
       def fully_formatted_failed_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
         formatted = "\nFailures:\n"
 
@@ -98,18 +113,13 @@ module RSpec::Core
         formatted
       end
 
-      # @return [String] The list of pending examples, fully formatted in the way that
-      #   RSpec's built-in formatters emit.
+      # @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)
-        formatted = "\nPending:\n"
-
-        pending_examples.each do |example|
-          formatted_caller = RSpec.configuration.backtrace_formatter.backtrace_line(example.location)
+        formatted = "\nPending: (Failures listed here are expected and do not affect your suite's status)\n"
 
-          formatted <<
-            "  #{colorizer.wrap(example.full_description, :pending)}\n" \
-            "    # #{colorizer.wrap(example.execution_result.pending_message, :detail)}\n" \
-            "    # #{colorizer.wrap(formatted_caller, :detail)}\n"
+        pending_notifications.each_with_index do |notification, index|
+          formatted << notification.fully_formatted(index.next, colorizer)
         end
 
         formatted
@@ -151,24 +161,24 @@ module RSpec::Core
 
       # Returns the message generated for this failure line by line.
       #
-      # @return [Array(String)] The example failure message
+      # @return [Array<String>] The example failure message
       def message_lines
-        add_shared_group_line(failure_lines, NullColorizer)
+        add_shared_group_lines(failure_lines, NullColorizer)
       end
 
       # Returns the message generated for this failure colorized line by line.
       #
       # @param colorizer [#wrap] An object to colorize the message_lines by
-      # @return [Array(String)] The example failure message colorized
+      # @return [Array<String>] The example failure message colorized
       def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        add_shared_group_line(failure_lines, colorizer).map do |line|
-          colorizer.wrap line, RSpec.configuration.failure_color
+        add_shared_group_lines(failure_lines, colorizer).map do |line|
+          colorizer.wrap line, message_color
         end
       end
 
       # Returns the failures formatted backtrace.
       #
-      # @return [Array(String)] the examples backtrace lines
+      # @return [Array<String>] the examples backtrace lines
       def formatted_backtrace
         backtrace_formatter.format_backtrace(exception.backtrace, example.metadata)
       end
@@ -176,7 +186,7 @@ module RSpec::Core
       # Returns the failures colorized formatted backtrace.
       #
       # @param colorizer [#wrap] An object to colorize the message_lines by
-      # @return [Array(String)] the examples colorized backtrace lines
+      # @return [Array<String>] the examples colorized backtrace lines
       def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
         formatted_backtrace.map do |backtrace_info|
           colorizer.wrap "# #{backtrace_info}", RSpec.configuration.detail_color
@@ -186,17 +196,7 @@ module RSpec::Core
       # @return [String] The failure information fully formatted in the way that
       #   RSpec's built-in formatters emit.
       def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        formatted = "\n  #{failure_number}) #{description}\n"
-
-        colorized_message_lines(colorizer).each do |line|
-          formatted << RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
-        end
-
-        colorized_formatted_backtrace(colorizer).each do |line|
-          formatted << RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
-        end
-
-        formatted
+        "\n  #{failure_number}) #{description}\n#{formatted_message_and_backtrace(colorizer)}"
       end
 
     private
@@ -232,29 +232,12 @@ module RSpec::Core
           end
       end
 
-      def add_shared_group_line(lines, colorizer)
-        unless shared_group_line == ""
-          lines << colorizer.wrap(shared_group_line, RSpec.configuration.default_color)
+      def add_shared_group_lines(lines, colorizer)
+        example.metadata[:shared_group_inclusion_backtrace].each do |frame|
+          lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)
         end
-        lines
-      end
-
-      def shared_group
-        @shared_group ||= group_and_parent_groups.find { |group| group.metadata[:shared_group_name] }
-      end
 
-      def shared_group_line
-        @shared_group_line ||=
-          if shared_group
-            "Shared Example Group: \"#{shared_group.metadata[:shared_group_name]}\"" \
-             " called from #{backtrace_formatter.backtrace_line(shared_group.location)}"
-          else
-            ""
-          end
-      end
-
-      def group_and_parent_groups
-        example.example_group.parent_groups + [example.example_group]
+        lines
       end
 
       def read_failed_line
@@ -276,11 +259,29 @@ module RSpec::Core
       end
 
       def find_failed_line
-        path = File.expand_path(example.file_path)
+        example_path = example.metadata[:absolute_file_path].downcase
         exception.backtrace.find do |line|
-          match = line.match(/(.+?):(\d+)(|:\d+)/)
-          match && match[1].downcase == path.downcase
+          next unless (line_path = line[/(.+?):(\d+)(|:\d+)/, 1])
+          File.expand_path(line_path).downcase == example_path
+        end
+      end
+
+      def formatted_message_and_backtrace(colorizer)
+        formatted = ""
+
+        colorized_message_lines(colorizer).each do |line|
+          formatted << RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
         end
+
+        colorized_formatted_backtrace(colorizer).each do |line|
+          formatted << RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
+        end
+
+        formatted
+      end
+
+      def message_color
+        RSpec.configuration.failure_color
       end
     end
 
@@ -292,7 +293,7 @@ module RSpec::Core
     class PendingExampleFixedNotification < FailedExampleNotification
       public_class_method :new
 
-      # Returns the examples description
+      # Returns the examples description.
       #
       # @return [String] The example description
       def description
@@ -301,7 +302,7 @@ module RSpec::Core
 
       # Returns the message generated for this failure line by line.
       #
-      # @return [Array(String)] The example failure message
+      # @return [Array<String>] The example failure message
       def message_lines
         ["Expected pending '#{example.execution_result.pending_message}' to fail. No Error was raised."]
       end
@@ -309,15 +310,70 @@ module RSpec::Core
       # Returns the message generated for this failure colorized line by line.
       #
       # @param colorizer [#wrap] An object to colorize the message_lines by
-      # @return [Array(String)] The example failure message colorized
+      # @return [Array<String>] The example failure message colorized
       def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
         message_lines.map { |line| colorizer.wrap(line, RSpec.configuration.fixed_color) }
       end
     end
 
-    # The `GroupNotification` represents notifications sent by the reporter which
-    # contain information about the currently running (or soon to be) example group
-    # It is used by formatters to access information about that group.
+    # @private
+    module PendingExampleNotificationMethods
+    private
+
+      def fully_formatted_header(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+        colorizer.wrap("\n  #{pending_number}) #{example.full_description}\n", :pending) <<
+        colorizer.wrap("     # #{example.execution_result.pending_message}\n", :detail)
+      end
+    end
+
+    # The `PendingExampleFailedAsExpectedNotification` extends `FailedExampleNotification` with
+    # things useful for pending specs that fail as expected.
+    #
+    # @attr [RSpec::Core::Example] example the current example
+    # @see ExampleNotification
+    class PendingExampleFailedAsExpectedNotification < FailedExampleNotification
+      include PendingExampleNotificationMethods
+      public_class_method :new
+
+      # @return [Exception] The exception that occurred while the pending example was executed
+      def exception
+        example.execution_result.pending_exception
+      end
+
+      # @return [String] The pending detail fully formatted in the way that
+      #   RSpec's built-in formatters emit.
+      def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+        fully_formatted_header(pending_number, colorizer) << formatted_message_and_backtrace(colorizer)
+      end
+
+    private
+
+      def message_color
+        RSpec.configuration.pending_color
+      end
+    end
+
+    # The `SkippedExampleNotification` extends `ExampleNotification` with
+    # things useful for specs that are skipped.
+    #
+    # @attr [RSpec::Core::Example] example the current example
+    # @see ExampleNotification
+    class SkippedExampleNotification < ExampleNotification
+      include PendingExampleNotificationMethods
+      public_class_method :new
+
+      # @return [String] The pending detail fully formatted in the way that
+      #   RSpec's built-in formatters emit.
+      def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+        formatted_caller = RSpec.configuration.backtrace_formatter.backtrace_line(example.location)
+        fully_formatted_header(pending_number, colorizer) << colorizer.wrap("     # #{formatted_caller}\n", :detail)
+      end
+    end
+
+    # The `GroupNotification` represents notifications sent by the reporter
+    # which contain information about the currently running (or soon to be)
+    # example group. It is used by formatters to access information about that
+    # group.
     #
     # @example
     #   def example_group_started(notification)
@@ -333,11 +389,12 @@ module RSpec::Core
     MessageNotification = Struct.new(:message)
 
     # The `SeedNotification` holds the seed used to randomize examples and
-    # wether that seed has been used or not.
+    # whether that seed has been used or not.
     #
     # @attr seed [Fixnum] the seed used to randomize ordering
-    # @attr used [Boolean] wether the seed has been used or not
-    SeedNotification = Struct.new(:seed, :used) do
+    # @attr used [Boolean] whether the seed has been used or not
+    SeedNotification = Struct.new(:seed, :used)
+    class SeedNotification
       # @api
       # @return [Boolean] has the seed been used?
       def seed_used?
@@ -348,7 +405,7 @@ module RSpec::Core
       # @return [String] The seed information fully formatted in the way that
       #   RSpec's built-in formatters emit.
       def fully_formatted
-        "\nRandomized with seed #{seed}\n\n"
+        "\nRandomized with seed #{seed}\n"
       end
     end
 
@@ -357,13 +414,13 @@ module RSpec::Core
     # of the test run.
     #
     # @attr duration [Float] the time taken (in seconds) to run the suite
-    # @attr examples [Array(RSpec::Core::Example)] the examples run
-    # @attr failed_examples [Array(RSpec::Core::Example)] the failed examples
-    # @attr pending_examples [Array(RSpec::Core::Example)] the pending examples
+    # @attr examples [Array<RSpec::Core::Example>] the examples run
+    # @attr failed_examples [Array<RSpec::Core::Example>] the failed examples
+    # @attr pending_examples [Array<RSpec::Core::Example>] the pending examples
     # @attr load_time [Float] the number of seconds taken to boot RSpec
     #                         and load the spec files
-    SummaryNotification = Struct.new(:duration, :examples, :failed_examples, :pending_examples, :load_time) do
-
+    SummaryNotification = Struct.new(:duration, :examples, :failed_examples, :pending_examples, :load_time)
+    class SummaryNotification
       # @api
       # @return [Fixnum] the number of examples run
       def example_count
@@ -420,18 +477,19 @@ module RSpec::Core
       def colorized_rerun_commands(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
         "\nFailed examples:\n\n" +
         failed_examples.map do |example|
-          colorizer.wrap("rspec #{example.location}",     RSpec.configuration.failure_color) + " " +
-          colorizer.wrap("# #{example.full_description}", RSpec.configuration.detail_color)
+          colorizer.wrap("rspec #{example.rerun_argument}", RSpec.configuration.failure_color) + " " +
+          colorizer.wrap("# #{example.full_description}",   RSpec.configuration.detail_color)
         end.join("\n")
       end
 
-      # @return [String] a formatted version of the time it took to run the suite
+      # @return [String] a formatted version of the time it took to run the
+      #   suite
       def formatted_duration
         Formatters::Helpers.format_duration(duration)
       end
 
-      # @return [String] a formatted version of the time it took to boot RSpec and
-      #   load the spec files
+      # @return [String] a formatted version of the time it took to boot RSpec
+      #   and load the spec files
       def formatted_load_time
         Formatters::Helpers.format_duration(load_time)
       end
@@ -451,16 +509,16 @@ module RSpec::Core
       end
     end
 
-    # The `ProfileNotification` holds information about the results of running
-    # a test suite when profiling is enabled. It is used by formatters to provide
+    # The `ProfileNotification` holds information about the results of running a
+    # test suite when profiling is enabled. It is used by formatters to provide
     # information at the end of the test run for profiling information.
     #
     # @attr duration [Float] the time taken (in seconds) to run the suite
-    # @attr examples [Array(RSpec::Core::Example)] the examples run
+    # @attr examples [Array<RSpec::Core::Example>] the examples run
     # @attr number_of_examples [Fixnum] the number of examples to profile
-    ProfileNotification = Struct.new(:duration, :examples, :number_of_examples) do
-
-      # @return [Array(RSpec::Core::Example)] the slowest examples
+    ProfileNotification = Struct.new(:duration, :examples, :number_of_examples)
+    class ProfileNotification
+      # @return [Array<RSpec::Core::Example>] the slowest examples
       def slowest_examples
         @slowest_examples ||=
           examples.sort_by do |example|
@@ -485,7 +543,7 @@ module RSpec::Core
           end
       end
 
-      # @return [Array(RSpec::Core::Example)] the slowest example groups
+      # @return [Array<RSpec::Core::Example>] the slowest example groups
       def slowest_groups
         @slowest_groups ||= calculate_slowest_groups
       end
@@ -517,14 +575,17 @@ module RSpec::Core
     end
 
     # The `DeprecationNotification` is issued by the reporter when a deprecated
-    # part of RSpec is encountered. It represents information about the deprecated
-    # call site.
+    # part of RSpec is encountered. It represents information about the
+    # deprecated call site.
     #
     # @attr message [String] A custom message about the deprecation
-    # @attr deprecated [String] A custom message about the deprecation (alias of message)
+    # @attr deprecated [String] A custom message about the deprecation (alias of
+    #   message)
     # @attr replacement [String] An optional replacement for the deprecation
-    # @attr call_site [String] An optional call site from which the deprecation was issued
-    DeprecationNotification = Struct.new(:deprecated, :message, :replacement, :call_site) do
+    # @attr call_site [String] An optional call site from which the deprecation
+    #   was issued
+    DeprecationNotification = Struct.new(:deprecated, :message, :replacement, :call_site)
+    class DeprecationNotification
       private_class_method :new
 
       # @api