rspec-core 3.0.4 → 3.12.2

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

@@ -1,9 +1,10 @@
+RSpec::Support.require_rspec_core "shell_escape"
+
 module RSpec
   module Core
     module Formatters
-      # Formatters helpers
+      # Formatters helpers.
       module Helpers
-
         # @private
         SUB_SECOND_PRECISION = 5
 
@@ -22,15 +23,15 @@ 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
 
           if duration > 60
-            minutes = (duration.to_i / 60).to_i
-            seconds = duration - minutes * 60
+            minutes = (duration.round / 60).to_i
+            seconds = (duration - minutes * 60)
 
             "#{pluralize(minutes, 'minute')} #{pluralize(format_seconds(seconds, precision), 'second')}"
           else
@@ -40,8 +41,9 @@ module RSpec
 
         # @api private
         #
-        # Formats seconds to have 5 digits of precision with trailing zeros removed if the number
-        # is less than 1 or with 2 digits of precision if the number is greater than zero.
+        # Formats seconds to have 5 digits of precision with trailing zeros
+        # removed if the number is less than 1 or with 2 digits of precision if
+        # the number is greater than zero.
         #
         # @param float [Float]
         # @return [String] formatted float
@@ -51,12 +53,14 @@ module RSpec
         #    format_seconds(0.020000) #=> "0.02"
         #    format_seconds(1.00000000001) #=> "1"
         #
-        # The precision used is set in {Helpers::SUB_SECOND_PRECISION} and {Helpers::DEFAULT_PRECISION}.
+        # 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)
+          return '0' if float < 0
           precision ||= (float < 1) ? SUB_SECOND_PRECISION : DEFAULT_PRECISION
-          formatted = sprintf("%.#{precision}f", float)
+          formatted = "%.#{precision}f" % float
           strip_trailing_zeroes(formatted)
         end
 
@@ -64,11 +68,13 @@ module RSpec
         #
         # Remove trailing zeros from a string.
         #
+        # Only remove trailing zeros after a decimal place.
+        # see: http://rubular.com/r/ojtTydOgpn
+        #
         # @param string [String] string with trailing zeros
         # @return [String] string with trailing zeros removed
         def self.strip_trailing_zeroes(string)
-          stripped = string.sub(/[^1-9]+$/, '')
-          stripped.empty? ? "0" : stripped
+          string.sub(/(?:(\..*[^0])0+|\.0+)$/, '\1')
         end
         private_class_method :strip_trailing_zeroes
 
@@ -80,7 +86,31 @@ module RSpec
         # @param string [String] word to be pluralized
         # @return [String] pluralized word
         def self.pluralize(count, string)
-          "#{count} #{string}#{'s' unless count.to_f == 1}"
+          pluralized_string = if count.to_f == 1
+                                string
+                              elsif string.end_with?('s') # e.g. "process"
+                                "#{string}es" # e.g. "processes"
+                              else
+                                "#{string}s"
+                              end
+
+          "#{count} #{pluralized_string}"
+        end
+
+        # @api private
+        # Given a list of example ids, organizes them into a compact, ordered list.
+        def self.organize_ids(ids)
+          grouped = ids.inject(Hash.new { |h, k| h[k] = [] }) do |hash, id|
+            file, id = Example.parse_id(id)
+            hash[file] << id
+            hash
+          end
+
+          grouped.sort_by(&:first).map do |file, grouped_ids|
+            grouped_ids = grouped_ids.sort_by { |id| id.split(':').map(&:to_i) }
+            id = Metadata.id_from(:rerun_file_path => file, :scoped_id => grouped_ids.join(','))
+            ShellEscape.conditionally_quote(id)
+          end
         end
       end
     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,25 @@ 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
 
@@ -69,14 +69,14 @@ module RSpec
           example = failure.example
 
           exception = failure.exception
+          message_lines = failure.fully_formatted_lines(nil, RSpec::Core::Notifications::NullColorizer)
           exception_details = if exception
-            {
-              :message => exception.message,
-              :backtrace => failure.formatted_backtrace.join("\n")
-            }
-          else
-            false
-          end
+                                {
+                                  # drop 2 removes the description (regardless of newlines) and leading blank line
+                                  :message => message_lines.drop(2).join("\n"),
+                                  :backtrace => failure.formatted_backtrace.join("\n"),
+                                }
+                              end
           extra = extra_failure_content(failure)
 
           @printer.print_example_failed(
@@ -85,8 +85,7 @@ module RSpec
             example.execution_result.run_time,
             @failed_examples.size,
             exception_details,
-            (extra == "") ? false : extra,
-            true
+            (extra == "") ? false : extra
           )
           @printer.flush
         end
@@ -97,7 +96,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,15 +112,20 @@ module RSpec
 
       private
 
-        # The number of the currently running example_group
+        # 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
         end
 
-        # The number of the currently running example (a global counter)
+        # The number of the currently running example (a global counter).
         def example_number
           @example_number
         end
+        # rubocop:enable Style/TrivialAccessors
 
         def percent_done
           result = 100.0
@@ -131,17 +135,18 @@ module RSpec
           result
         end
 
-        # Override this method if you wish to output extra HTML for a failed spec. For example, you
-        # could output links to images or other files produced during the specs.
-        #
+        # Override this method if you wish to output extra HTML for a failed
+        # spec. For example, you could output links to images or other files
+        # produced during the specs.
         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)}
+          RSpec::Support.require_rspec_core "formatters/html_snippet_extractor"
+          backtrace = (failure.exception.backtrace || []).map do |line|
+            RSpec.configuration.backtrace_formatter.backtrace_line(line)
+          end
           backtrace.compact!
-          @snippet_extractor ||= SnippetExtractor.new
+          @snippet_extractor ||= HtmlSnippetExtractor.new
           "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
         end
-
       end
     end
   end

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

@@ -5,7 +5,7 @@ module RSpec
     module Formatters
       # @private
       class HtmlPrinter
-        include ERB::Util # for the #h method
+        include ERB::Util # For the #h method.
         def initialize(output)
           @output = output
         end
@@ -27,12 +27,15 @@ module RSpec
         end
 
         def print_example_passed(description, run_time)
-          formatted_run_time = sprintf("%.5f", run_time)
-          @output.puts "    <dd class=\"example passed\"><span class=\"passed_spec_name\">#{h(description)}</span><span class='duration'>#{formatted_run_time}s</span></dd>"
+          formatted_run_time = "%.5f" % run_time
+          @output.puts "    <dd class=\"example passed\">" \
+            "<span class=\"passed_spec_name\">#{h(description)}</span>" \
+            "<span class='duration'>#{formatted_run_time}s</span></dd>"
         end
 
-        def print_example_failed(pending_fixed, description, run_time, failure_id, exception, extra_content, escape_backtrace = false)
-          formatted_run_time = sprintf("%.5f", run_time)
+        def print_example_failed(pending_fixed, description, run_time, failure_id,
+                                 exception, extra_content)
+          formatted_run_time = "%.5f" % run_time
 
           @output.puts "    <dd class=\"example #{pending_fixed ? 'pending_fixed' : 'failed'}\">"
           @output.puts "      <span class=\"failed_spec_name\">#{h(description)}</span>"
@@ -40,11 +43,7 @@ module RSpec
           @output.puts "      <div class=\"failure\" id=\"failure_#{failure_id}\">"
           if exception
             @output.puts "        <div class=\"message\"><pre>#{h(exception[:message])}</pre></div>"
-            if escape_backtrace
-              @output.puts "        <div class=\"backtrace\"><pre>#{h exception[:backtrace]}</pre></div>"
-            else
-              @output.puts "        <div class=\"backtrace\"><pre>#{exception[:backtrace]}</pre></div>"
-            end
+            @output.puts "        <div class=\"backtrace\"><pre>#{h exception[:backtrace]}</pre></div>"
           end
           @output.puts extra_content if extra_content
           @output.puts "      </div>"
@@ -52,18 +51,25 @@ module RSpec
         end
 
         def print_example_pending(description, pending_message)
-          @output.puts "    <dd class=\"example not_implemented\"><span class=\"not_implemented_spec_name\">#{h(description)} (PENDING: #{h(pending_message)})</span></dd>"
+          @output.puts "    <dd class=\"example not_implemented\">" \
+            "<span class=\"not_implemented_spec_name\">#{h(description)} " \
+            "(PENDING: #{h(pending_message)})</span></dd>"
         end
 
         def print_summary(duration, example_count, failure_count, pending_count)
-          totals =  "#{example_count} example#{'s' unless example_count == 1}, "
+          totals = String.new(
+            "#{example_count} example#{'s' unless example_count == 1}, "
+          )
           totals << "#{failure_count} failure#{'s' unless failure_count == 1}"
           totals << ", #{pending_count} pending" if pending_count > 0
 
-          formatted_duration = sprintf("%.5f", duration)
+          formatted_duration = "%.5f" % duration
 
-          @output.puts "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{formatted_duration} seconds</strong>\";</script>"
-          @output.puts "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{totals}\";</script>"
+          @output.puts "<script type=\"text/javascript\">" \
+            "document.getElementById('duration').innerHTML = \"Finished in " \
+            "<strong>#{formatted_duration} seconds</strong>\";</script>"
+          @output.puts "<script type=\"text/javascript\">" \
+            "document.getElementById('totals').innerHTML = \"#{totals}\";</script>"
           @output.puts "</div>"
           @output.puts "</div>"
           @output.puts "</body>"
@@ -88,13 +94,17 @@ module RSpec
         end
 
         def make_example_group_header_red(group_id)
-          @output.puts "    <script type=\"text/javascript\">makeRed('div_group_#{group_id}');</script>"
-          @output.puts "    <script type=\"text/javascript\">makeRed('example_group_#{group_id}');</script>"
+          @output.puts "    <script type=\"text/javascript\">" \
+                       "makeRed('div_group_#{group_id}');</script>"
+          @output.puts "    <script type=\"text/javascript\">" \
+                       "makeRed('example_group_#{group_id}');</script>"
         end
 
         def make_example_group_header_yellow(group_id)
-          @output.puts "    <script type=\"text/javascript\">makeYellow('div_group_#{group_id}');</script>"
-          @output.puts "    <script type=\"text/javascript\">makeYellow('example_group_#{group_id}');</script>"
+          @output.puts "    <script type=\"text/javascript\">" \
+                       "makeYellow('div_group_#{group_id}');</script>"
+          @output.puts "    <script type=\"text/javascript\">" \
+                       "makeYellow('example_group_#{group_id}');</script>"
         end
 
       private
@@ -203,6 +213,7 @@ function assign_display_style_for_group(classname, display_flag, subgroup_flag)
   }
 }
 EOF
+        # rubocop:enable Layout/LineLength
 
         GLOBAL_STYLES = <<-EOF
 #rspec-header {
@@ -395,7 +406,6 @@ EOF
 </head>
 <body>
 EOF
-
       end
     end
   end

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

@@ -0,0 +1,120 @@
+module RSpec
+  module Core
+    module Formatters
+      # @api private
+      #
+      # Extracts code snippets by looking at the backtrace of the passed error
+      # and applies synax highlighting and line numbers using html.
+      class HtmlSnippetExtractor
+        # @private
+        module NullConverter
+          def self.convert(code)
+            %Q(#{code}\n<span class="comment"># Install the coderay gem to get syntax highlighting</span>)
+          end
+        end
+
+        # @private
+        module CoderayConverter
+          def self.convert(code)
+            CodeRay.scan(code, :ruby).html(:line_numbers => false)
+          end
+        end
+
+        # rubocop:disable Style/ClassVars
+        # @private
+        @@converter = NullConverter
+
+        begin
+          require 'coderay'
+          RSpec::Support.require_rspec_core 'formatters/syntax_highlighter'
+          RSpec::Core::Formatters::SyntaxHighlighter.attempt_to_add_rspec_terms_to_coderay_keywords
+          @@converter = CoderayConverter
+          # rubocop:disable Lint/HandleExceptions
+        rescue LoadError
+          # it'll fall back to the NullConverter assigned above
+          # rubocop:enable Lint/HandleExceptions
+        end
+
+        # rubocop:enable Style/ClassVars
+
+        # @api private
+        #
+        # Extract lines of code corresponding to  a backtrace.
+        #
+        # @param backtrace [String] the backtrace from a test failure
+        # @return [String] highlighted code snippet indicating where the test
+        #   failure occurred
+        #
+        # @see #post_process
+        def snippet(backtrace)
+          raw_code, line = snippet_for(backtrace[0])
+          highlighted = @@converter.convert(raw_code)
+          post_process(highlighted, line)
+        end
+        # rubocop:enable Style/ClassVars
+
+        # @api private
+        #
+        # Create a snippet from a line of code.
+        #
+        # @param error_line [String] file name with line number (i.e.
+        #   'foo_spec.rb:12')
+        # @return [String] lines around the target line within the file
+        #
+        # @see #lines_around
+        def snippet_for(error_line)
+          if error_line =~ /(.*):(\d+)/
+            file = Regexp.last_match[1]
+            line = Regexp.last_match[2].to_i
+            [lines_around(file, line), line]
+          else
+            ["# Couldn't get snippet for #{error_line}", 1]
+          end
+        end
+
+        # @api private
+        #
+        # Extract lines of code centered around a particular line within a
+        # source file.
+        #
+        # @param file [String] filename
+        # @param line [Fixnum] line number
+        # @return [String] lines around the target line within the file (2 above
+        #   and 1 below).
+        def lines_around(file, line)
+          if File.file?(file)
+            lines = File.read(file).split("\n")
+            min = [0, line - 3].max
+            max = [line + 1, lines.length - 1].min
+            selected_lines = []
+            selected_lines.join("\n")
+            lines[min..max].join("\n")
+          else
+            "# Couldn't get snippet for #{file}"
+          end
+        rescue SecurityError
+          "# Couldn't get snippet for #{file}"
+        end
+
+        # @api private
+        #
+        # Adds line numbers to all lines and highlights the line where the
+        # failure occurred using html `span` tags.
+        #
+        # @param highlighted [String] syntax-highlighted snippet surrounding the
+        #   offending line of code
+        # @param offending_line [Fixnum] line where failure occurred
+        # @return [String] completed snippet
+        def post_process(highlighted, offending_line)
+          new_lines = []
+          highlighted.split("\n").each_with_index do |line, i|
+            new_line = "<span class=\"linenum\">#{offending_line + i - 2}</span>#{line}"
+            new_line = "<span class=\"offending\">#{new_line}</span>" if i == 2
+            new_lines << new_line
+          end
+          new_lines.join("\n")
+        end
+      end
+    end
+  end
+end

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

@@ -6,13 +6,15 @@ module RSpec
     module Formatters
       # @private
       class JsonFormatter < BaseFormatter
-        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :close
+        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :seed, :close
 
         attr_reader :output_hash
 
         def initialize(output)
           super
-          @output_hash = {}
+          @output_hash = {
+            :version => RSpec::Core::Version::STRING
+          }
         end
 
         def message(notification)
@@ -24,7 +26,8 @@ module RSpec
             :duration => summary.duration,
             :example_count => summary.example_count,
             :failure_count => summary.failure_count,
-            :pending_count => summary.pending_count
+            :pending_count => summary.pending_count,
+            :errors_outside_of_examples_count => summary.errors_outside_of_examples_count
           }
           @output_hash[:summary_line] = summary.totals_line
         end
@@ -32,7 +35,8 @@ module RSpec
         def stop(notification)
           @output_hash[:examples] = notification.examples.map do |example|
             format_example(example).tap do |hash|
-              if e=example.exception
+              e = example.exception
+              if e
                 hash[:exception] =  {
                   :class => e.class.name,
                   :message => e.message,
@@ -43,9 +47,13 @@ module RSpec
           end
         end
 
-        def close(notification)
+        def seed(notification)
+          return unless notification.seed_used?
+          @output_hash[:seed] = notification.seed
+        end
+
+        def close(_notification)
           output.write @output_hash.to_json
-          output.close if IO === output && output != $stdout
         end
 
         def dump_profile(profile)
@@ -57,8 +65,7 @@ module RSpec
         # @api private
         def dump_profile_slowest_examples(profile)
           @output_hash[:profile] = {}
-          sorted_examples = profile.slowest_examples
-          @output_hash[:profile][:examples] = sorted_examples.map do |example|
+          @output_hash[:profile][:examples] = profile.slowest_examples.map do |example|
             format_example(example).tap do |hash|
               hash[:run_time] = example.execution_result.run_time
             end
@@ -79,12 +86,14 @@ module RSpec
 
         def format_example(example)
           {
+            :id => example.id,
             :description => example.description,
             :full_description => example.full_description,
             :status => example.execution_result.status.to_s,
             :file_path => example.metadata[:file_path],
             :line_number  => example.metadata[:line_number],
-            :run_time => example.execution_result.run_time
+            :run_time => example.execution_result.run_time,
+            :pending_message => example.execution_result.pending_message,
           }
         end
       end

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

@@ -3,9 +3,8 @@ RSpec::Support.require_rspec_core "formatters/console_codes"
 module RSpec
   module Core
     module Formatters
-
       # @api private
-      # Formatter for providing profile output
+      # Formatter for providing profile output.
       class ProfileFormatter
         Formatters.register self, :dump_profile
 
@@ -16,14 +15,13 @@ module RSpec
         # @private
         attr_reader :output
 
-        # @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
+        # @param profile [ProfileNotification] containing duration,
+        #   slowest_examples and slowest_example_groups
         def dump_profile(profile)
           dump_profile_slowest_examples(profile)
           dump_profile_slowest_example_groups(profile)
@@ -32,11 +30,14 @@ module RSpec
       private
 
         def dump_profile_slowest_examples(profile)
-          @output.puts "\nTop #{profile.slowest_examples.size} slowest examples (#{Helpers.format_seconds(profile.slow_duration)} seconds, #{profile.percentage}% of total time):\n"
+          @output.puts "\nTop #{profile.slowest_examples.size} slowest " \
+            "examples (#{Helpers.format_seconds(profile.slow_duration)} " \
+            "seconds, #{profile.percentage}% of total time):\n"
 
           profile.slowest_examples.each do |example|
             @output.puts "  #{example.full_description}"
-            @output.puts "    #{bold(Helpers.format_seconds(example.execution_result.run_time))} #{bold("seconds")} #{format_caller(example.location)}"
+            @output.puts "    #{bold(Helpers.format_seconds(example.execution_result.run_time))} " \
+                         "#{bold("seconds")} #{format_caller(example.location)}"
           end
         end
 
@@ -54,13 +55,13 @@ module RSpec
         end
 
         def format_caller(caller_info)
-          RSpec.configuration.backtrace_formatter.backtrace_line(caller_info.to_s.split(':in `block').first)
+          RSpec.configuration.backtrace_formatter.backtrace_line(
+            caller_info.to_s.split(':in `block').first)
         end
 
         def bold(text)
           ConsoleCodes.wrap(text, :bold)
         end
-
       end
     end
   end

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

@@ -1,4 +1,5 @@
 RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+RSpec::Support.require_rspec_core "formatters/console_codes"
 
 module RSpec
   module Core
@@ -7,19 +8,19 @@ module RSpec
       class ProgressFormatter < BaseTextFormatter
         Formatters.register self, :example_passed, :example_pending, :example_failed, :start_dump
 
-        def example_passed(notification)
+        def example_passed(_notification)
           output.print ConsoleCodes.wrap('.', :success)
         end
 
-        def example_pending(notification)
+        def example_pending(_notification)
           output.print ConsoleCodes.wrap('*', :pending)
         end
 
-        def example_failed(notification)
+        def example_failed(_notification)
           output.print ConsoleCodes.wrap('F', :failure)
         end
 
-        def start_dump(notification)
+        def start_dump(_notification)
           output.puts
         end
       end