rspec-core 3.0.4 → 3.12.2

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

@@ -4,23 +4,22 @@ require 'stringio'
 module RSpec
   module Core
     module Formatters
-      # RSpec's built-in formatters are all subclasses of RSpec::Core::Formatters::BaseTextFormatter,
-      # but the BaseTextFormatter documents all of the notifications implemented as part of the standard
-      # interface. The reporter will issue these during a normal test suite run, but a formatter will
-      # only receive those notifications it has registered itself to receive.
+      # RSpec's built-in formatters are all subclasses of
+      # RSpec::Core::Formatters::BaseFormatter.
       #
       # @see RSpec::Core::Formatters::BaseTextFormatter
       # @see RSpec::Core::Reporter
+      # @see RSpec::Core::Formatters::Protocol
       class BaseFormatter
-
-        # all formatters inheriting from this formatter will receive these notifications
+        # All formatters inheriting from this formatter will receive these
+        # notifications.
         Formatters.register self, :start, :example_group_started, :close
         attr_accessor :example_group
         attr_reader :output
 
         # @api public
-        #
         # @param output [IO] the formatter output
+        # @see RSpec::Core::Formatters::Protocol#initialize
         def initialize(output)
           @output = output || StringIO.new
           @example_group = nil
@@ -28,14 +27,8 @@ module RSpec
 
         # @api public
         #
-        # This method is invoked before any examples are run, right after
-        # they have all been collected. This can be useful for special
-        # formatters that need to provide progress on feedback (graphical ones).
-        #
-        # This will only be invoked once, and the next one to be invoked
-        # is {#example_group_started}.
-        #
         # @param notification [StartNotification]
+        # @see RSpec::Core::Formatters::Protocol#start
         def start(notification)
           start_sync_output
           @example_count = notification.count
@@ -43,112 +36,18 @@ module RSpec
 
         # @api public
         #
-        # This method is invoked at the beginning of the execution of each example group.
-        #
-        # The next method to be invoked after this is {#example_passed},
-        # {#example_pending}, or {#example_group_finished}.
-        #
-        # @param notification [GroupNotification] containing example_group subclass of `RSpec::Core::ExampleGroup`
+        # @param notification [GroupNotification] containing example_group
+        #   subclass of `RSpec::Core::ExampleGroup`
+        # @see RSpec::Core::Formatters::Protocol#example_group_started
         def example_group_started(notification)
           @example_group = notification.group
         end
 
-        # @method example_group_finished
-        # @api public
-        #
-        # Invoked at the end of the execution of each example group.
-        #
-        # @param notification [GroupNotification] containing example_group subclass of `RSpec::Core::ExampleGroup`
-
-        # @method example_started
-        # @api public
-        #
-        # Invoked at the beginning of the execution of each example.
-        #
-        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
-
-        # @method example_passed
-        # @api public
-        #
-        # Invoked when an example passes.
-        #
-        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
-
-        # @method example_pending
-        # Invoked when an example is pending.
-        #
-        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
-
-        # @method example_failed
-        # @api public
-        #
-        # Invoked when an example fails.
-        #
-        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
-
-        # @method message
-        # @api public
-        #
-        # Used by the reporter to send messages to the output stream.
-        #
-        # @param notification [MessageNotification] containing message
-
-        # @method stop
-        # @api public
-        #
-        # Invoked after all examples have executed, before dumping post-run reports.
-        #
-        # @param notification [NullNotification]
-
-        # @method start_dump
-        # @api public
-        #
-        # This method is invoked after all of the examples have executed. The next method
-        # to be invoked after this one is {#dump_failures}
-        # (BaseTextFormatter then calls {#dump_failure} once for each failed example.)
-        #
-        # @param notification [NullNotification]
-
-        # @method dump_failures
         # @api public
         #
-        # Dumps detailed information about each example failure.
-        #
-        # @param notification [NullNotification]
-
-        # @method dump_summary
-        # @api public
-        #
-        # This method is invoked after the dumping of examples and failures. Each parameter
-        # is assigned to a corresponding attribute.
-        #
-        # @param summary [SummaryNotification] containing duration, example_count,
-        #                                      failure_count and pending_count
-
-        # @method dump_profile
-        # @api public
-        #
-        # This method is invoked after the dumping the summary if profiling is
-        # enabled.
-        #
-        # @param profile [ProfileNotification] containing duration, slowest_examples
-        #                                      and slowest_example_groups
-
-        # @method dump_pending
-        # @api public
-        #
-        # Outputs a report of pending examples.  This gets invoked
-        # after the summary if option is set to do so.
-        #
-        # @param notification [NullNotification]
-
-        # @api public
-        #
-        # Invoked at the very end, `close` allows the formatter to clean
-        # up resources, e.g. open streams, etc.
-        #
-        # @param notification [NullNotification]
-        def close(notification)
+        # @param _notification [NullNotification] (Ignored)
+        # @see RSpec::Core::Formatters::Protocol#close
+        def close(_notification)
           restore_sync_output
         end
 
@@ -159,13 +58,12 @@ module RSpec
         end
 
         def restore_sync_output
-          output.sync = @old_sync if output_supports_sync and !output.closed?
+          output.sync = @old_sync if output_supports_sync && !output.closed?
         end
 
         def output_supports_sync
           output.respond_to?(:sync=)
         end
-
       end
     end
   end

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

@@ -1,20 +1,18 @@
 RSpec::Support.require_rspec_core "formatters/base_formatter"
-RSpec::Support.require_rspec_core "formatters/console_codes"
 
 module RSpec
   module Core
     module Formatters
-
-      # Base for all of RSpec's built-in formatters. See RSpec::Core::Formatters::BaseFormatter
-      # to learn more about all of the methods called by the reporter.
+      # Base for all of RSpec's built-in formatters. See
+      # RSpec::Core::Formatters::BaseFormatter to learn more about all of the
+      # methods called by the reporter.
       #
       # @see RSpec::Core::Formatters::BaseFormatter
       # @see RSpec::Core::Reporter
       class BaseTextFormatter < BaseFormatter
-        Formatters.register self, :message, :dump_summary, :dump_failures,
-                                  :dump_pending, :seed
+        Formatters.register self,
+                            :message, :dump_summary, :dump_failures, :dump_pending, :seed
 
-        # @method message
         # @api public
         #
         # Used by the reporter to send messages to the output stream.
@@ -24,7 +22,6 @@ module RSpec
           output.puts notification.message
         end
 
-        # @method dump_failures
         # @api public
         #
         # Dumps detailed information about each example failure.
@@ -35,14 +32,13 @@ module RSpec
           output.puts notification.fully_formatted_failed_examples
         end
 
-        # @method dump_summary
         # @api public
         #
-        # This method is invoked after the dumping of examples and failures. Each parameter
-        # is assigned to a corresponding attribute.
+        # This method is invoked after the dumping of examples and failures.
+        # Each parameter is assigned to a corresponding attribute.
         #
-        # @param summary [SummaryNotification] containing duration, example_count,
-        #                                      failure_count and pending_count
+        # @param summary [SummaryNotification] containing duration,
+        #   example_count, failure_count and pending_count
         def dump_summary(summary)
           output.puts summary.fully_formatted
         end
@@ -61,17 +57,18 @@ module RSpec
 
         # @api public
         #
-        # Invoked at the very end, `close` allows the formatter to clean
-        # up resources, e.g. open streams, etc.
+        # Invoked at the end of a suite run. Allows the formatter to do any
+        # tidying up, but be aware that formatter output streams may be used
+        # elsewhere so don't actually close them.
         #
-        # @param notification [NullNotification]
-        def close(notification)
-          return unless IO === output
-          return if output.closed? || output == $stdout
+        # @param _notification [NullNotification] (Ignored)
+        def close(_notification)
+          return if output.closed?
 
-          output.close
-        end
+          output.puts
 
+          output.flush
+        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

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

@@ -0,0 +1,157 @@
+RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+
+module RSpec
+  module Core
+    module Formatters
+      # @private
+      # Produces progress output while bisecting.
+      class BisectProgressFormatter < BaseTextFormatter
+        def initialize(output, bisect_runner)
+          super(output)
+          @bisect_runner = bisect_runner
+        end
+
+        def bisect_starting(notification)
+          @round_count = 0
+          output.puts bisect_started_message(notification)
+          output.print "Running suite to find failures..."
+        end
+
+        def bisect_original_run_complete(notification)
+          failures     = Helpers.pluralize(notification.failed_example_ids.size, "failing example")
+          non_failures = Helpers.pluralize(notification.non_failing_example_ids.size, "non-failing example")
+
+          output.puts " (#{Helpers.format_duration(notification.duration)})"
+          output.puts "Starting bisect with #{failures} and #{non_failures}."
+        end
+
+        def bisect_dependency_check_started(_notification)
+          output.print "Checking that failure(s) are order-dependent.."
+        end
+
+        def bisect_dependency_check_passed(_notification)
+          output.puts " failure appears to be order-dependent"
+        end
+
+        def bisect_dependency_check_failed(_notification)
+          output.puts " failure(s) do not require any non-failures to run first"
+
+          if @bisect_runner == :fork
+            output.puts
+            output.puts "=" * 80
+            output.puts "NOTE: this bisect run used `config.bisect_runner = :fork`, which generally"
+            output.puts "provides significantly faster bisection runs than the old shell-based runner,"
+            output.puts "but may inaccurately report that no non-failures are required. If this result"
+            output.puts "is unexpected, consider setting `config.bisect_runner = :shell` and trying again."
+            output.puts "=" * 80
+          end
+        end
+
+        def bisect_round_started(notification, include_trailing_space=true)
+          @round_count += 1
+          range_desc = notification.candidate_range.description
+
+          output.print "\nRound #{@round_count}: bisecting over non-failing #{range_desc}"
+          output.print " " if include_trailing_space
+        end
+
+        def bisect_round_ignoring_ids(notification)
+          range_desc = notification.ignore_range.description
+
+          output.print " ignoring #{range_desc}"
+          output.print " (#{Helpers.format_duration(notification.duration)})"
+        end
+
+        def bisect_round_detected_multiple_culprits(notification)
+          output.print " multiple culprits detected - splitting candidates"
+          output.print " (#{Helpers.format_duration(notification.duration)})"
+        end
+
+        def bisect_individual_run_complete(_)
+          output.print '.'
+        end
+
+        def bisect_complete(notification)
+          output.puts "\nBisect complete! Reduced necessary non-failing examples " \
+                      "from #{notification.original_non_failing_count} to " \
+                      "#{notification.remaining_count} in " \
+                      "#{Helpers.format_duration(notification.duration)}."
+        end
+
+        def bisect_repro_command(notification)
+          output.puts "\nThe minimal reproduction command is:\n  #{notification.repro}"
+        end
+
+        def bisect_failed(notification)
+          output.puts "\nBisect failed! #{notification.failure_explanation}"
+        end
+
+        def bisect_aborted(notification)
+          output.puts "\n\nBisect aborted!"
+          output.puts "\nThe most minimal reproduction command discovered so far is:\n  #{notification.repro}"
+        end
+
+      private
+
+        def bisect_started_message(notification)
+          options = notification.original_cli_args.join(' ')
+          "Bisect started using options: #{options.inspect}"
+        end
+      end
+
+      # @private
+      # Produces detailed debug output while bisecting. Used when bisect is
+      # performed with `--bisect=verbose`. Designed to provide details for
+      # us when we need to troubleshoot bisect bugs.
+      class BisectDebugFormatter < BisectProgressFormatter
+        def bisect_original_run_complete(notification)
+          output.puts " (#{Helpers.format_duration(notification.duration)})"
+
+          output.puts " - #{describe_ids 'Failing examples', notification.failed_example_ids}"
+          output.puts " - #{describe_ids 'Non-failing examples', notification.non_failing_example_ids}"
+        end
+
+        def bisect_individual_run_start(notification)
+          output.print "\n - Running: #{notification.command}"
+        end
+
+        def bisect_individual_run_complete(notification)
+          output.print " (#{Helpers.format_duration(notification.duration)})"
+        end
+
+        def bisect_dependency_check_passed(_notification)
+          output.print "\n - Failure appears to be order-dependent"
+        end
+
+        def bisect_dependency_check_failed(_notification)
+          output.print "\n - Failure is not order-dependent"
+        end
+
+        def bisect_round_started(notification)
+          super(notification, false)
+        end
+
+        def bisect_round_ignoring_ids(notification)
+          output.print "\n - #{describe_ids 'Examples we can safely ignore', notification.ids_to_ignore}"
+          output.print "\n - #{describe_ids 'Remaining non-failing examples', notification.remaining_ids}"
+        end
+
+        def bisect_round_detected_multiple_culprits(_notification)
+          output.print "\n - Multiple culprits detected - splitting candidates"
+        end
+
+      private
+
+        def describe_ids(description, ids)
+          organized_ids = Formatters::Helpers.organize_ids(ids)
+          formatted_ids = organized_ids.map { |id| "    - #{id}" }.join("\n")
+          "#{description} (#{ids.size}):\n#{formatted_ids}"
+        end
+
+        def bisect_started_message(notification)
+          "#{super} and bisect runner: #{notification.bisect_runner.inspect}"
+        end
+      end
+    end
+  end
+end

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

@@ -7,30 +7,47 @@ module RSpec
         # @private
         VT100_CODES =
           {
-            :black   => 30,
-            :red     => 31,
-            :green   => 32,
-            :yellow  => 33,
-            :blue    => 34,
-            :magenta => 35,
-            :cyan    => 36,
-            :white   => 37,
-            :bold    => 1,
+            :black         => 30,
+            :red           => 31,
+            :green         => 32,
+            :yellow        => 33,
+            :blue          => 34,
+            :magenta       => 35,
+            :cyan          => 36,
+            :white         => 37,
+            :bold_black   => '1;30',
+            :bold_red     => '1;31',
+            :bold_green   => '1;32',
+            :bold_yellow  => '1;33',
+            :bold_blue    => '1;34',
+            :bold_magenta => '1;35',
+            :bold_cyan    => '1;36',
+            :bold_white   => '1;37',
+            :bold          => 1,
           }
         # @private
         VT100_CODE_VALUES = VT100_CODES.invert
 
         module_function
 
+        # @private
+        def config_colors_to_methods
+          @config_colors_to_methods ||=
+            Configuration.instance_methods.grep(/_color\z/).inject({}) do |hash, method|
+              hash[method.to_s.sub(/_color\z/, '').to_sym] = method
+              hash
+            end
+        end
+
         # Fetches the correct code for the supplied symbol, or checks
         # that a code is valid. Defaults to white (37).
         #
         # @param code_or_symbol [Symbol, Fixnum] Symbol or code to check
         # @return [Fixnum] a console code
         def console_code_for(code_or_symbol)
-          if RSpec.configuration.respond_to?(:"#{code_or_symbol}_color")
-            console_code_for configuration_color(code_or_symbol)
-          elsif VT100_CODE_VALUES.has_key?(code_or_symbol)
+          if (config_method = config_colors_to_methods[code_or_symbol])
+            console_code_for RSpec.configuration.__send__(config_method)
+          elsif VT100_CODE_VALUES.key?(code_or_symbol)
             code_or_symbol
           else
             VT100_CODES.fetch(code_or_symbol) do
@@ -53,12 +70,6 @@ module RSpec
             text
           end
         end
-
-        # @private
-        def configuration_color(code)
-          RSpec.configuration.__send__(:"#{code}_color")
-        end
-
       end
     end
   end

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

@@ -1,5 +1,4 @@
 RSpec::Support.require_rspec_core "formatters/helpers"
-require 'set'
 
 module RSpec
   module Core
@@ -21,7 +20,8 @@ module RSpec
         def printer
           @printer ||= case deprecation_stream
                        when File
-                         ImmediatePrinter.new(FileStream.new(deprecation_stream), summary_stream, self)
+                         ImmediatePrinter.new(FileStream.new(deprecation_stream),
+                                              summary_stream, self)
                        when RaiseErrorStream
                          ImmediatePrinter.new(deprecation_stream, summary_stream, self)
                        else
@@ -37,7 +37,7 @@ module RSpec
           @seen_deprecations << notification
         end
 
-        def deprecation_summary(notification)
+        def deprecation_summary(_notification)
           printer.deprecation_summary
         end
 
@@ -57,9 +57,12 @@ module RSpec
           |deprecation warnings into errors, giving you the full backtrace.
         EOS
 
-        DEPRECATION_STREAM_NOTICE = "Pass `--deprecation-out` or set " +
+        DEPRECATION_STREAM_NOTICE = "Pass `--deprecation-out` or set " \
           "`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}"
 
+        # @private
         SpecifiedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @message = data.message
@@ -71,16 +74,14 @@ module RSpec
           end
 
           def too_many_warnings_message
-            msg = "Too many similar deprecation messages reported, disregarding further reports. "
-            msg << DEPRECATION_STREAM_NOTICE
-            msg
+            TOO_MANY_WARNINGS_NOTICE
           end
 
           private
 
           def output_formatted(str)
             return str unless str.lines.count > 1
-            separator = "#{'-' * 80}"
+            separator = '-' * 80
             "#{separator}\n#{str.chomp}\n#{separator}"
           end
 
@@ -89,6 +90,7 @@ module RSpec
           end
         end
 
+        # @private
         GeneratedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @data = data
@@ -96,16 +98,14 @@ module RSpec
           end
 
           def to_s
-            msg =  "#{@data.deprecated} is deprecated."
+            msg = String.new("#{@data.deprecated} is deprecated.")
             msg << " Use #{@data.replacement} instead." if @data.replacement
-            msg << " Called from #{@data.call_site}." if @data.call_site
+            msg << " Called from #{@data.call_site}."   if @data.call_site
             msg
           end
 
           def too_many_warnings_message
-            msg = "Too many uses of deprecated '#{type}'. "
-            msg << DEPRECATION_STREAM_NOTICE
-            msg
+            "Too many uses of deprecated '#{type}'. #{DEPRECATION_STREAM_NOTICE}"
           end
         end
 
@@ -209,15 +209,15 @@ module RSpec
           end
 
           def summarize(summary_stream, deprecation_count)
-            summary_stream.puts "\n#{Helpers.pluralize(deprecation_count, 'deprecation')} logged to #{@file.path}"
+            path = @file.respond_to?(:path) ? @file.path : @file.inspect
+            summary_stream.puts "\n#{Helpers.pluralize(deprecation_count, 'deprecation')} logged to #{path}"
             puts RAISE_ERROR_CONFIG_NOTICE
           end
         end
-
       end
     end
 
-    # Deprecation Error
+    # Deprecation Error.
     DeprecationError = Class.new(StandardError)
   end
 end