rspec-core 3.0.0.beta2 → 3.0.0.rc1

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

@@ -1,8 +1,9 @@
-require 'rspec/core/formatters/base_text_formatter'
+RSpec::Support.require_rspec_core "formatters/base_text_formatter"
 
 module RSpec
   module Core
     module Formatters
+      # @private
       class DocumentationFormatter < BaseTextFormatter
         Formatters.register self, :example_group_started, :example_group_finished,
                                   :example_passed, :example_pending, :example_failed
@@ -13,8 +14,6 @@ module RSpec
         end
 
         def example_group_started(notification)
-          super
-
           output.puts if @group_level == 0
           output.puts "#{current_indentation}#{notification.group.description.strip}"
 
@@ -30,27 +29,25 @@ module RSpec
         end
 
         def example_pending(pending)
-          super
-          output.puts pending_output(pending.example, pending.example.execution_result[:pending_message])
+          output.puts pending_output(pending.example, pending.example.execution_result.pending_message)
         end
 
         def example_failed(failure)
-          super
-          output.puts failure_output(failure.example, failure.example.execution_result[:exception])
+          output.puts failure_output(failure.example, failure.example.execution_result.exception)
         end
 
       private
 
         def passed_output(example)
-          success_color("#{current_indentation}#{example.description.strip}")
+          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip}", :success)
         end
 
         def pending_output(example, message)
-          pending_color("#{current_indentation}#{example.description.strip} (PENDING: #{message})")
+          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} (PENDING: #{message})", :pending)
         end
 
         def failure_output(example, exception)
-          failure_color("#{current_indentation}#{example.description.strip} (FAILED - #{next_failure_index})")
+          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} (FAILED - #{next_failure_index})", :failure)
         end
 
         def next_failure_index

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

@@ -1,21 +1,26 @@
 module RSpec
   module Core
     module Formatters
+      # Formatters helpers
       module Helpers
+
+        # @private
         SUB_SECOND_PRECISION = 5
+
+        # @private
         DEFAULT_PRECISION = 2
 
         # @api private
         #
         # Formats seconds into a human-readable string.
         #
-        # @param [Float, Fixnum] duration in seconds
+        # @param duration [Float, Fixnum] in seconds
         # @return [String] human-readable time
         #
         # @example
         #    format_duration(1) #=>  "1 minute 1 second"
         #    format_duration(135.14) #=> "2 minutes 15.14 seconds"
-        def format_duration(duration)
+        def self.format_duration(duration)
           precision = case
                       when duration < 1;    SUB_SECOND_PRECISION
                       when duration < 120;  DEFAULT_PRECISION
@@ -38,7 +43,7 @@ module RSpec
         # 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
+        # @param float [Float]
         # @return [String] formatted float
         #
         # @example
@@ -49,7 +54,7 @@ module RSpec
         # The precision used is set in {Helpers::SUB_SECOND_PRECISION} and {Helpers::DEFAULT_PRECISION}.
         #
         # @see #strip_trailing_zeroes
-        def 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)
           strip_trailing_zeroes(formatted)
@@ -59,21 +64,22 @@ module RSpec
         #
         # Remove trailing zeros from a string.
         #
-        # @param [String] string string with trailing zeros
+        # @param string [String] string with trailing zeros
         # @return [String] string with trailing zeros removed
-        def strip_trailing_zeroes(string)
+        def self.strip_trailing_zeroes(string)
           stripped = string.sub(/[^1-9]+$/, '')
           stripped.empty? ? "0" : stripped
         end
+        private_class_method :strip_trailing_zeroes
 
         # @api private
         #
         # Pluralize a word based on a count.
         #
-        # @param [Fixnum] count number of objects
-        # @param [String] string word to be pluralized
+        # @param count [Fixnum] number of objects
+        # @param string [String] word to be pluralized
         # @return [String] pluralized word
-        def pluralize(count, string)
+        def self.pluralize(count, string)
           "#{count} #{string}#{'s' unless count.to_f == 1}"
         end
       end

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

@@ -1,9 +1,10 @@
-require 'rspec/core/formatters/base_text_formatter'
-require 'rspec/core/formatters/html_printer'
+RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+RSpec::Support.require_rspec_core "formatters/html_printer"
 
 module RSpec
   module Core
     module Formatters
+      # @private
       class HtmlFormatter < BaseFormatter
         Formatters.register self, :start, :example_group_started, :start_dump,
                                   :example_started, :example_passed, :example_failed,
@@ -11,6 +12,7 @@ module RSpec
 
         def initialize(output)
           super(output)
+          @failed_examples = []
           @example_group_number = 0
           @example_number = 0
           @header_red = nil
@@ -46,13 +48,12 @@ module RSpec
 
         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
 
-        def example_failed(failed)
-          super
-
+        def example_failed(failure)
+          @failed_examples << failure.example
           unless @header_red
             @header_red = true
             @printer.make_header_red
@@ -65,23 +66,23 @@ module RSpec
 
           @printer.move_progress(percent_done)
 
-          example = failed.example
+          example = failure.example
 
-          exception = example.metadata[:execution_result][:exception]
+          exception = failure.exception
           exception_details = if exception
             {
               :message => exception.message,
-              :backtrace => format_backtrace(exception.backtrace, example).join("\n")
+              :backtrace => failure.formatted_backtrace.join("\n")
             }
           else
             false
           end
-          extra = extra_failure_content(exception)
+          extra = extra_failure_content(failure)
 
           @printer.print_example_failed(
-            example.execution_result[:pending_fixed],
+            example.execution_result.pending_fixed,
             example.description,
-            example.execution_result[:run_time],
+            example.execution_result.run_time,
             @failed_examples.size,
             exception_details,
             (extra == "") ? false : extra,
@@ -96,7 +97,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.metadata[:execution_result][:pending_message] )
+          @printer.print_example_pending( example.description, example.execution_result.pending_message )
           @printer.flush
         end
 
@@ -133,9 +134,9 @@ module RSpec
         # 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(exception)
-          require 'rspec/core/formatters/snippet_extractor'
-          backtrace = exception.backtrace.map {|line| configuration.backtrace_formatter.backtrace_line(line)}
+        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.compact!
           @snippet_extractor ||= SnippetExtractor.new
           "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"

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

@@ -3,6 +3,7 @@ require 'erb'
 module RSpec
   module Core
     module Formatters
+      # @private
       class HtmlPrinter
         include ERB::Util # for the #h method
         def initialize(output)

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

@@ -1,12 +1,12 @@
-require 'rspec/core/formatters/base_formatter'
+RSpec::Support.require_rspec_core "formatters/base_formatter"
 require 'json'
 
 module RSpec
   module Core
     module Formatters
+      # @private
       class JsonFormatter < BaseFormatter
-        Formatters.register self, :message, :dump_summary, :stop, :close,
-                                  :dump_profile
+        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :close
 
         attr_reader :output_hash
 
@@ -26,13 +26,11 @@ module RSpec
             :failure_count => summary.failure_count,
             :pending_count => summary.pending_count
           }
-          @output_hash[:summary_line] = summary.summary_line
-
-          dump_profile unless mute_profile_output?(summary.failure_count)
+          @output_hash[:summary_line] = summary.totals_line
         end
 
         def stop(notification)
-          @output_hash[:examples] = examples.map do |example|
+          @output_hash[:examples] = notification.examples.map do |example|
             format_example(example).tap do |hash|
               if e=example.exception
                 hash[:exception] =  {
@@ -50,29 +48,29 @@ module RSpec
           output.close if IO === output && output != $stdout
         end
 
-        def dump_profile
+        def dump_profile(profile)
           @output_hash[:profile] = {}
-          dump_profile_slowest_examples
-          dump_profile_slowest_example_groups
+          dump_profile_slowest_examples(profile)
+          dump_profile_slowest_example_groups(profile)
         end
 
         # @api private
-        def dump_profile_slowest_examples
+        def dump_profile_slowest_examples(profile)
           @output_hash[:profile] = {}
-          sorted_examples = slowest_examples
-          @output_hash[:profile][:examples] = sorted_examples[:examples].map do |example|
+          sorted_examples = profile.slowest_examples
+          @output_hash[:profile][:examples] = sorted_examples.map do |example|
             format_example(example).tap do |hash|
-              hash[:run_time] = example.execution_result[:run_time]
+              hash[:run_time] = example.execution_result.run_time
             end
           end
-          @output_hash[:profile][:slowest] = sorted_examples[:slows]
-          @output_hash[:profile][:total] = sorted_examples[:total]
+          @output_hash[:profile][:slowest] = profile.slow_duration
+          @output_hash[:profile][:total] = profile.duration
         end
 
         # @api private
-        def dump_profile_slowest_example_groups
+        def dump_profile_slowest_example_groups(profile)
           @output_hash[:profile] ||= {}
-          @output_hash[:profile][:groups] = slowest_groups.map do |loc, hash|
+          @output_hash[:profile][:groups] = profile.slowest_groups.map do |loc, hash|
             hash.update(:location => loc)
           end
         end
@@ -83,10 +81,10 @@ module RSpec
           {
             :description => example.description,
             :full_description => example.full_description,
-            :status => example.execution_result[:status],
+            :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
           }
         end
       end

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

@@ -0,0 +1,67 @@
+RSpec::Support.require_rspec_core "formatters/console_codes"
+
+module RSpec
+  module Core
+    module Formatters
+
+      # @api private
+      # Formatter for providing profile output
+      class ProfileFormatter
+        Formatters.register self, :dump_profile
+
+        def initialize(output)
+          @output = output
+        end
+
+        # @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
+        def dump_profile(profile)
+          dump_profile_slowest_examples(profile)
+          dump_profile_slowest_example_groups(profile)
+        end
+
+      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"
+
+          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)}"
+          end
+        end
+
+        def dump_profile_slowest_example_groups(profile)
+          return if profile.slowest_groups.empty?
+
+          @output.puts "\nTop #{profile.slowest_groups.size} slowest example groups:"
+          profile.slowest_groups.each do |loc, hash|
+            average = "#{bold(Helpers.format_seconds(hash[:average]))} #{bold("seconds")} average"
+            total   = "#{Helpers.format_seconds(hash[:total_time])} seconds"
+            count   = Helpers.pluralize(hash[:count], "example")
+            @output.puts "  #{hash[:description]}"
+            @output.puts "    #{average} (#{total} / #{count}) #{loc}"
+          end
+        end
+
+        def format_caller(caller_info)
+          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
+end

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

@@ -1,28 +1,27 @@
-require 'rspec/core/formatters/base_text_formatter'
+RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+
 module RSpec
   module Core
     module Formatters
+      # @private
       class ProgressFormatter < BaseTextFormatter
         Formatters.register self, :example_passed, :example_pending, :example_failed, :start_dump
 
         def example_passed(notification)
-          output.print success_color('.')
+          output.print ConsoleCodes.wrap('.', :success)
         end
 
         def example_pending(notification)
-          super
-          output.print pending_color('*')
+          output.print ConsoleCodes.wrap('*', :pending)
         end
 
         def example_failed(notification)
-          super
-          output.print failure_color('F')
+          output.print ConsoleCodes.wrap('F', :failure)
         end
 
         def start_dump(notification)
           output.puts
         end
-
       end
     end
   end

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

@@ -5,12 +5,14 @@ module RSpec
       #
       # Extracts code snippets by looking at the backtrace of the passed error and applies synax highlighting and line numbers using html.
       class SnippetExtractor
+        # @private
         class NullConverter
           def convert(code)
             %Q(#{code}\n<span class="comment"># Install the coderay gem to get syntax highlighting</span>)
           end
         end
 
+        # @private
         class CoderayConverter
           def convert(code)
             CodeRay.scan(code, :ruby).html(:line_numbers => false)
@@ -28,7 +30,7 @@ module RSpec
         #
         # Extract lines of code corresponding to  a backtrace.
         #
-        # @param [String] backtrace the backtrace from a test failure
+        # @param backtrace [String] the backtrace from a test failure
         # @return [String] highlighted code snippet indicating where the test failure occured
         #
         # @see #post_process
@@ -42,7 +44,7 @@ module RSpec
         #
         # Create a snippet from a line of code.
         #
-        # @param [String] error_line file name with line number (i.e. 'foo_spec.rb:12')
+        # @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
@@ -60,8 +62,8 @@ module RSpec
         #
         # Extract lines of code centered around a particular line within a source file.
         #
-        # @param [String] file filename
-        # @param [Fixnum] line line number
+        # @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)
@@ -82,8 +84,8 @@ module RSpec
         #
         # Adds line numbers to all lines and highlights the line where the failure occurred using html `span` tags.
         #
-        # @param [String] highlighted syntax-highlighted snippet surrounding the offending line of code
-        # @param [Fixnum] offending_line line where failure occured
+        # @param highlighted [String] syntax-highlighted snippet surrounding the offending line of code
+        # @param offending_line [Fixnum] line where failure occured
         # @return [String] completed snippet
         def post_process(highlighted, offending_line)
           new_lines = []