rspec-core 3.0.4 → 3.1.0

data/lib/rspec/core/formatters.rb

@@ -1,3 +1,4 @@
+RSpec::Support.require_rspec_support "directory_maker"
 # ## Built-in Formatters
 #
 # * progress (default) - prints dots for passing examples, `F` for failures, `*` for pending
@@ -110,15 +111,15 @@ module RSpec::Core::Formatters
 
     # @private
     def setup_default(output_stream, deprecation_stream)
-      if @formatters.empty?
-        add default_formatter, output_stream
-      end
+      add default_formatter, output_stream if @formatters.empty?
+
       unless @formatters.any? { |formatter| DeprecationFormatter === formatter }
         add DeprecationFormatter, deprecation_stream, output_stream
       end
-      if RSpec.configuration.profile_examples? && !existing_formatter_implements?(:dump_profile)
-        add RSpec::Core::Formatters::ProfileFormatter, output_stream
-      end
+
+      return unless RSpec.configuration.profile_examples? && !existing_formatter_implements?(:dump_profile)
+
+      add RSpec::Core::Formatters::ProfileFormatter, output_stream
     end
 
     # @private
@@ -138,11 +139,11 @@ module RSpec::Core::Formatters
         if line
           call_site = "Formatter added at: #{line}"
         else
-          call_site = "The formatter was added via command line flag or your "+
+          call_site = "The formatter was added via command line flag or your "\
                       "`.rspec` file."
         end
 
-        RSpec.warn_deprecation <<-WARNING.gsub(/\s*\|/,' ')
+        RSpec.warn_deprecation <<-WARNING.gsub(/\s*\|/, ' ')
           |The #{formatter_class} formatter uses the deprecated formatter
           |interface not supported directly by RSpec 3.
           |
@@ -201,9 +202,9 @@ module RSpec::Core::Formatters
         formatter_ref
       elsif string_const?(formatter_ref)
         begin
-          formatter_ref.gsub(/^::/,'').split('::').inject(Object) { |const,string| const.const_get string }
+          formatter_ref.gsub(/^::/, '').split('::').inject(Object) { |a, e| a.const_get e }
         rescue NameError
-          require( path_for(formatter_ref) ) ? retry : raise
+          require(path_for(formatter_ref)) ? retry : raise
         end
       end
     end
@@ -224,15 +225,15 @@ module RSpec::Core::Formatters
     def underscore(camel_cased_word)
       word = camel_cased_word.to_s.dup
       word.gsub!(/::/, '/')
-      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
       word.tr!("-", "_")
       word.downcase!
       word
     end
 
     def file_at(path)
-      FileUtils.mkdir_p(File.dirname(path))
+      RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(path))
       File.new(path, 'w')
     end
   end

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

@@ -4,23 +4,20 @@ 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::BaseTextFormatter.
       #
       # @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
         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 +25,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 +34,17 @@ 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`
+        # @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)
+        # @see RSpec::Core::Formatters::Protocol#close
+        def close(_notification)
           restore_sync_output
         end
 
@@ -159,13 +55,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

@@ -4,15 +4,14 @@ 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.
       #
       # @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
@@ -65,13 +64,12 @@ module RSpec
         # up resources, e.g. open streams, etc.
         #
         # @param notification [NullNotification]
-        def close(notification)
+        def close(_notification)
           return unless IO === output
           return if output.closed? || output == $stdout
 
           output.close
         end
-
       end
     end
   end

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

@@ -30,7 +30,7 @@ module RSpec
         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)
+          elsif VT100_CODE_VALUES.key?(code_or_symbol)
             code_or_symbol
           else
             VT100_CODES.fetch(code_or_symbol) do
@@ -58,7 +58,6 @@ module RSpec
         def configuration_color(code)
           RSpec.configuration.__send__(:"#{code}_color")
         end
-
       end
     end
   end

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

@@ -37,7 +37,7 @@ module RSpec
           @seen_deprecations << notification
         end
 
-        def deprecation_summary(notification)
+        def deprecation_summary(_notification)
           printer.deprecation_summary
         end
 
@@ -57,7 +57,7 @@ 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."
 
         SpecifiedDeprecationMessage = Struct.new(:type) do
@@ -213,7 +213,6 @@ module RSpec
             puts RAISE_ERROR_CONFIG_NOTICE
           end
         end
-
       end
     end
 

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

@@ -6,7 +6,7 @@ module RSpec
       # @private
       class DocumentationFormatter < BaseTextFormatter
         Formatters.register self, :example_group_started, :example_group_finished,
-                                  :example_passed, :example_pending, :example_failed
+                            :example_passed, :example_pending, :example_failed
 
         def initialize(output)
           super
@@ -20,7 +20,7 @@ module RSpec
           @group_level += 1
         end
 
-        def example_group_finished(notification)
+        def example_group_finished(_notification)
           @group_level -= 1
         end
 
@@ -46,7 +46,7 @@ module RSpec
           ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} (PENDING: #{message})", :pending)
         end
 
-        def failure_output(example, exception)
+        def failure_output(example, _exception)
           ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} (FAILED - #{next_failure_index})", :failure)
         end
 
@@ -62,7 +62,6 @@ module RSpec
         def example_group_chain
           example_group.parent_groups.reverse
         end
-
       end
     end
   end

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

@@ -3,7 +3,6 @@ module RSpec
     module Formatters
       # Formatters helpers
       module Helpers
-
         # @private
         SUB_SECOND_PRECISION = 5
 
@@ -22,9 +21,9 @@ module RSpec
         #    format_duration(135.14) #=> "2 minutes 15.14 seconds"
         def self.format_duration(duration)
           precision = case
-                      when duration < 1;    SUB_SECOND_PRECISION
-                      when duration < 120;  DEFAULT_PRECISION
-                      when duration < 300;  1
+                      when duration < 1 then    SUB_SECOND_PRECISION
+                      when duration < 120 then  DEFAULT_PRECISION
+                      when duration < 300 then  1
                       else                  0
                       end
 
@@ -54,9 +53,9 @@ module RSpec
         # The precision used is set in {Helpers::SUB_SECOND_PRECISION} and {Helpers::DEFAULT_PRECISION}.
         #
         # @see #strip_trailing_zeroes
-        def self.format_seconds(float, precision = nil)
+        def self.format_seconds(float, precision=nil)
           precision ||= (float < 1) ? SUB_SECOND_PRECISION : DEFAULT_PRECISION
-          formatted = sprintf("%.#{precision}f", float)
+          formatted = "%.#{precision}f" % float
           strip_trailing_zeroes(formatted)
         end
 

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

@@ -7,8 +7,8 @@ module RSpec
       # @private
       class HtmlFormatter < BaseFormatter
         Formatters.register self, :start, :example_group_started, :start_dump,
-                                  :example_started, :example_passed, :example_failed,
-                                  :example_pending, :dump_summary
+                            :example_started, :example_passed, :example_failed,
+                            :example_pending, :dump_summary
 
         def initialize(output)
           super(output)
@@ -30,25 +30,23 @@ module RSpec
           @example_group_red = false
           @example_group_number += 1
 
-          unless example_group_number == 1
-            @printer.print_example_group_end
-          end
-          @printer.print_example_group_start( example_group_number, notification.group.description, notification.group.parent_groups.size )
+          @printer.print_example_group_end unless example_group_number == 1
+          @printer.print_example_group_start(example_group_number, notification.group.description, notification.group.parent_groups.size)
           @printer.flush
         end
 
-        def start_dump(notification)
+        def start_dump(_notification)
           @printer.print_example_group_end
           @printer.flush
         end
 
-        def example_started(notification)
+        def example_started(_notification)
           @example_number += 1
         end
 
         def example_passed(passed)
           @printer.move_progress(percent_done)
-          @printer.print_example_passed( passed.example.description, passed.example.execution_result.run_time )
+          @printer.print_example_passed(passed.example.description, passed.example.execution_result.run_time)
           @printer.flush
         end
 
@@ -70,13 +68,13 @@ module RSpec
 
           exception = failure.exception
           exception_details = if exception
-            {
-              :message => exception.message,
-              :backtrace => failure.formatted_backtrace.join("\n")
-            }
-          else
-            false
-          end
+                                {
+                                  :message => exception.message,
+                                  :backtrace => failure.formatted_backtrace.join("\n")
+                                }
+                              else
+                                false
+                              end
           extra = extra_failure_content(failure)
 
           @printer.print_example_failed(
@@ -97,7 +95,7 @@ module RSpec
           @printer.make_header_yellow unless @header_red
           @printer.make_example_group_header_yellow(example_group_number) unless @example_group_red
           @printer.move_progress(percent_done)
-          @printer.print_example_pending( example.description, example.execution_result.pending_message )
+          @printer.print_example_pending(example.description, example.execution_result.pending_message)
           @printer.flush
         end
 
@@ -113,6 +111,9 @@ module RSpec
 
       private
 
+        # If these methods are declared with attr_reader Ruby will issue a warning because they are private
+        # rubocop:disable Style/TrivialAccessors
+
         # The number of the currently running example_group
         def example_group_number
           @example_group_number
@@ -122,6 +123,7 @@ module RSpec
         def example_number
           @example_number
         end
+        # rubocop:enable Style/TrivialAccessors
 
         def percent_done
           result = 100.0
@@ -136,12 +138,11 @@ module RSpec
         #
         def extra_failure_content(failure)
           RSpec::Support.require_rspec_core "formatters/snippet_extractor"
-          backtrace = failure.exception.backtrace.map {|line| RSpec.configuration.backtrace_formatter.backtrace_line(line)}
+          backtrace = failure.exception.backtrace.map { |line| RSpec.configuration.backtrace_formatter.backtrace_line(line) }
           backtrace.compact!
           @snippet_extractor ||= SnippetExtractor.new
           "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
         end
-
       end
     end
   end