rspec-core 3.0.0.beta1 → 3.0.0.beta2

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

@@ -5,6 +5,8 @@ module RSpec
   module Core
     module Formatters
       class DeprecationFormatter
+        Formatters.register self, :deprecation, :deprecation_summary
+
         attr_reader :count, :deprecation_stream, :summary_stream
 
         def initialize(deprecation_stream, summary_stream)
@@ -13,30 +15,33 @@ module RSpec
           @seen_deprecations = Set.new
           @count = 0
         end
+        alias :output :deprecation_stream
 
         def printer
           @printer ||= case deprecation_stream
-                       when File, RaiseErrorStream
+                       when File
+                         ImmediatePrinter.new(FileStream.new(deprecation_stream), summary_stream, self)
+                       when RaiseErrorStream
                          ImmediatePrinter.new(deprecation_stream, summary_stream, self)
                        else
                          DelayedPrinter.new(deprecation_stream, summary_stream, self)
                        end
         end
 
-        def deprecation(data)
-          return if @seen_deprecations.include?(data)
+        def deprecation(notification)
+          return if @seen_deprecations.include? notification
 
           @count += 1
-          printer.print_deprecation_message data
-          @seen_deprecations << data
+          printer.print_deprecation_message notification
+          @seen_deprecations << notification
         end
 
-        def deprecation_summary
+        def deprecation_summary(notification)
           printer.deprecation_summary
         end
 
         def deprecation_message_for(data)
-          if data[:message]
+          if data.message
             SpecifiedDeprecationMessage.new(data)
           else
             GeneratedDeprecationMessage.new(data)
@@ -53,7 +58,7 @@ module RSpec
 
         SpecifiedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
-            @message = data[:message]
+            @message = data.message
             super deprecation_type_for(data)
           end
 
@@ -70,20 +75,20 @@ module RSpec
           private
 
           def deprecation_type_for(data)
-            data[:message].gsub(/(\w+\/)+\w+\.rb:\d+/, '')
+            data.message.gsub(/(\w+\/)+\w+\.rb:\d+/, '')
           end
         end
 
         GeneratedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @data = data
-            super data[:deprecated]
+            super data.deprecated
           end
 
           def to_s
-            msg =  "#{@data[:deprecated]} is deprecated."
-            msg << " Use #{@data[:replacement]} instead." if @data[:replacement]
-            msg << " Called from #{@data[:call_site]}." if @data[:call_site]
+            msg =  "#{@data.deprecated} is deprecated."
+            msg << " Use #{@data.replacement} instead." if @data.replacement
+            msg << " Called from #{@data.call_site}." if @data.call_site
             msg
           end
 
@@ -95,19 +100,11 @@ module RSpec
         end
 
         class ImmediatePrinter
-          include ::RSpec::Core::Formatters::Helpers
-
           attr_reader :deprecation_stream, :summary_stream, :deprecation_formatter
 
           def initialize(deprecation_stream, summary_stream, deprecation_formatter)
             @deprecation_stream = deprecation_stream
 
-            # In one of my test suites, I got lots of duplicate output in the
-            # deprecation file (e.g. 200 of the same deprecation, even though
-            # the `puts` below was only called 6 times). Setting `sync = true`
-            # fixes this (but we really have no idea why!).
-            @deprecation_stream.sync = true
-
             @summary_stream = summary_stream
             @deprecation_formatter = deprecation_formatter
           end
@@ -118,10 +115,8 @@ module RSpec
           end
 
           def deprecation_summary
-            if deprecation_formatter.count > 0
-              summary_stream.puts "\n#{pluralize(deprecation_formatter.count, 'deprecation')} logged to #{deprecation_stream.path}"
-              deprecation_stream.puts RAISE_ERROR_CONFIG_NOTICE
-            end
+            return if deprecation_formatter.count.zero?
+            deprecation_stream.summarize(summary_stream, deprecation_formatter.count)
           end
         end
 
@@ -176,12 +171,38 @@ module RSpec
 
         # Not really a stream, but is usable in place of one.
         class RaiseErrorStream
+          include ::RSpec::Core::Formatters::Helpers
+
           def puts(message)
             raise DeprecationError, message
           end
 
-          def sync=(value)
-            # no-op
+          def summarize(summary_stream, deprecation_count)
+            summary_stream.puts "\n#{pluralize(deprecation_count, 'deprecation')} found."
+          end
+        end
+
+        # Wraps a File object and provides file-specific operations.
+        class FileStream
+          include ::RSpec::Core::Formatters::Helpers
+
+          def initialize(file)
+            @file = file
+
+            # In one of my test suites, I got lots of duplicate output in the
+            # deprecation file (e.g. 200 of the same deprecation, even though
+            # the `puts` below was only called 6 times). Setting `sync = true`
+            # fixes this (but we really have no idea why!).
+            @file.sync = true
+          end
+
+          def puts(*args)
+            @file.puts(*args)
+          end
+
+          def summarize(summary_stream, deprecation_count)
+            summary_stream.puts "\n#{pluralize(deprecation_count, 'deprecation')} logged to #{@file.path}"
+            puts RAISE_ERROR_CONFIG_NOTICE
           end
         end
 

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

@@ -4,47 +4,42 @@ module RSpec
   module Core
     module Formatters
       class DocumentationFormatter < BaseTextFormatter
+        Formatters.register self, :example_group_started, :example_group_finished,
+                                  :example_passed, :example_pending, :example_failed
+
         def initialize(output)
-          super(output)
+          super
           @group_level = 0
         end
 
-        def example_group_started(example_group)
-          super(example_group)
+        def example_group_started(notification)
+          super
 
           output.puts if @group_level == 0
-          output.puts "#{current_indentation}#{example_group.description.strip}"
+          output.puts "#{current_indentation}#{notification.group.description.strip}"
 
           @group_level += 1
         end
 
-        def example_group_finished(example_group)
+        def example_group_finished(notification)
           @group_level -= 1
         end
 
-        def example_passed(example)
-          super(example)
-          output.puts passed_output(example)
-        end
-
-        def example_pending(example)
-          super(example)
-          output.puts pending_output(example, example.execution_result[:pending_message])
+        def example_passed(passed)
+          output.puts passed_output(passed.example)
         end
 
-        def example_failed(example)
-          super(example)
-          output.puts failure_output(example, example.execution_result[:exception])
+        def example_pending(pending)
+          super
+          output.puts pending_output(pending.example, pending.example.execution_result[:pending_message])
         end
 
-        def failure_output(example, exception)
-          failure_color("#{current_indentation}#{example.description.strip} (FAILED - #{next_failure_index})")
+        def example_failed(failure)
+          super
+          output.puts failure_output(failure.example, failure.example.execution_result[:exception])
         end
 
-        def next_failure_index
-          @next_failure_index ||= 0
-          @next_failure_index += 1
-        end
+      private
 
         def passed_output(example)
           success_color("#{current_indentation}#{example.description.strip}")
@@ -54,6 +49,15 @@ module RSpec
           pending_color("#{current_indentation}#{example.description.strip} (PENDING: #{message})")
         end
 
+        def failure_output(example, exception)
+          failure_color("#{current_indentation}#{example.description.strip} (FAILED - #{next_failure_index})")
+        end
+
+        def next_failure_index
+          @next_failure_index ||= 0
+          @next_failure_index += 1
+        end
+
         def current_indentation
           '  ' * @group_level
         end
@@ -61,6 +65,7 @@ module RSpec
         def example_group_chain
           example_group.parent_groups.reverse
         end
+
       end
     end
   end

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

@@ -4,7 +4,10 @@ require 'rspec/core/formatters/html_printer'
 module RSpec
   module Core
     module Formatters
-      class HtmlFormatter < BaseTextFormatter
+      class HtmlFormatter < BaseFormatter
+        Formatters.register self, :start, :example_group_started, :start_dump,
+                                  :example_started, :example_passed, :example_failed,
+                                  :example_pending, :dump_summary
 
         def initialize(output)
           super(output)
@@ -14,61 +17,41 @@ module RSpec
           @printer = HtmlPrinter.new(output)
         end
 
-        private
-        def method_missing(m, *a, &b)
-          # no-op
-        end
-
-        public
-        def message(message)
-        end
-
-        # 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)
-        def example_number
-          @example_number
-        end
-
-        def start(example_count)
-          super(example_count)
+        def start(notification)
+          super
           @printer.print_html_start
           @printer.flush
         end
 
-        def example_group_started(example_group)
-          super(example_group)
+        def example_group_started(notification)
+          super
           @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, example_group.description, example_group.parent_groups.size )
+          @printer.print_example_group_start( example_group_number, notification.group.description, notification.group.parent_groups.size )
           @printer.flush
         end
 
-        def start_dump
+        def start_dump(notification)
           @printer.print_example_group_end
           @printer.flush
         end
 
-        def example_started(example)
-          super(example)
+        def example_started(notification)
           @example_number += 1
         end
 
-        def example_passed(example)
+        def example_passed(passed)
           @printer.move_progress(percent_done)
-          @printer.print_example_passed( example.description, example.execution_result[:run_time] )
+          @printer.print_example_passed( passed.example.description, passed.example.execution_result[:run_time] )
           @printer.flush
         end
 
-        def example_failed(example)
-          super(example)
+        def example_failed(failed)
+          super
 
           unless @header_red
             @header_red = true
@@ -82,6 +65,8 @@ module RSpec
 
           @printer.move_progress(percent_done)
 
+          example = failed.example
+
           exception = example.metadata[:execution_result][:exception]
           exception_details = if exception
             {
@@ -105,7 +90,8 @@ module RSpec
           @printer.flush
         end
 
-        def example_pending(example)
+        def example_pending(pending)
+          example = pending.example
 
           @printer.make_header_yellow unless @header_red
           @printer.make_example_group_header_yellow(example_group_number) unless @example_group_red
@@ -114,15 +100,26 @@ module RSpec
           @printer.flush
         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.
-        #
-        def extra_failure_content(exception)
-          require 'rspec/core/formatters/snippet_extractor'
-          backtrace = exception.backtrace.map {|line| configuration.backtrace_formatter.backtrace_line(line)}
-          backtrace.compact!
-          @snippet_extractor ||= SnippetExtractor.new
-          "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
+        def dump_summary(summary)
+          @printer.print_summary(
+            summary.duration,
+            summary.example_count,
+            summary.failure_count,
+            summary.pending_count
+          )
+          @printer.flush
+        end
+
+      private
+
+        # 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)
+        def example_number
+          @example_number
         end
 
         def percent_done
@@ -133,22 +130,17 @@ module RSpec
           result
         end
 
-        def dump_failures
-        end
-
-        def dump_pending
+        # 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)}
+          backtrace.compact!
+          @snippet_extractor ||= SnippetExtractor.new
+          "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
         end
 
-        def dump_summary(duration, example_count, failure_count, pending_count)
-          @printer.print_summary(
-            dry_run?,
-            duration,
-            example_count,
-            failure_count,
-            pending_count
-          )
-          @printer.flush
-        end
       end
     end
   end

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

@@ -19,18 +19,18 @@ module RSpec
           @output.puts "</div>"
         end
 
-        def print_example_group_start( group_id, description, number_of_parents  )
+        def print_example_group_start(group_id, description, number_of_parents)
           @output.puts "<div id=\"div_group_#{group_id}\" class=\"example_group passed\">"
           @output.puts "  <dl #{indentation_style(number_of_parents)}>"
           @output.puts "  <dt id=\"example_group_#{group_id}\" class=\"passed\">#{h(description)}</dt>"
         end
 
-        def print_example_passed( description, run_time )
+        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>"
         end
 
-        def print_example_failed( pending_fixed, description, run_time, failure_id, exception, extra_content, escape_backtrace = false )
+        def print_example_failed(pending_fixed, description, run_time, failure_id, exception, extra_content, escape_backtrace = false)
           formatted_run_time = sprintf("%.5f", run_time)
 
           @output.puts "    <dd class=\"example #{pending_fixed ? 'pending_fixed' : 'failed'}\">"
@@ -50,19 +50,14 @@ module RSpec
           @output.puts "    </dd>"
         end
 
-        def print_example_pending( description, pending_message )
+        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>"
         end
 
-        def print_summary( was_dry_run, duration, example_count, failure_count, pending_count )
-          # TODO - kill dry_run?
-          if was_dry_run
-            totals = "This was a dry-run"
-          else
-            totals =  "#{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
-          end
+        def print_summary(duration, example_count, failure_count, pending_count)
+          totals =  "#{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)
 
@@ -78,7 +73,7 @@ module RSpec
           @output.flush
         end
 
-        def move_progress( percent_done )
+        def move_progress(percent_done)
           @output.puts "    <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
           @output.flush
         end
@@ -101,14 +96,12 @@ module RSpec
           @output.puts "    <script type=\"text/javascript\">makeYellow('example_group_#{group_id}');</script>"
         end
 
+      private
 
-        private
-
-        def indentation_style( number_of_parents )
+        def indentation_style(number_of_parents)
           "style=\"margin-left: #{(number_of_parents - 1) * 15}px;\""
         end
 
-
         REPORT_HEADER = <<-EOF
 <div class="rspec-report">