rspec 1.0.0 → 1.3.1

data/lib/spec/runner/formatter/base_formatter.rb

@@ -1,10 +1,29 @@
 module Spec
   module Runner
     module Formatter
-      # Baseclass for formatters that implements all required methods as no-ops. 
+      # Formatter base-class, which implements all required methods as no-ops, with the exception
       class BaseFormatter
-        def initialize(where)
-          @where = where
+        # Formatters are initialized with <tt>options</tt> and <tt>output</tt>
+        # arguments. RSpec's built-in formatters already expect this, and any
+        # custom formatters should as well.
+        #
+        # ==== Parameters
+        # options::
+        #   A struct containing boolean values for colour, autospec,
+        #   and dry_run
+        # output::
+        #   Used by RSpec's built-in formatters to determine where to
+        #   write the output. Default is <tt>STDOUT</tt>, otherwise a
+        #   filename is expected.
+        #
+        # === Example
+        # If you invoke the <tt>spec</tt> command with:
+        #
+        #   --format progress:progress_report.txt
+        #
+        # ... the value of <tt>output</tt> will be progress_report.txt. If you
+        # don't identify an output destination, the default is STDOUT.
+        def initialize(options, output)
         end
         
         # This method is invoked before any examples are run, right after
@@ -12,42 +31,77 @@ module Spec
         # formatters that need to provide progress on feedback (graphical ones)
         #
         # This method will only be invoked once, and the next one to be invoked
-        # is #add_behaviour
+        # is #example_group_started
+        #
+        # ==== Parameters
+        # example_count:: the total number of examples to be run
         def start(example_count)
         end
 
-        # This method is invoked at the beginning of the execution of each context.
-        # +name+ is the name of the context and +first+ is true if it is the
-        # first context - otherwise it's false.
+        # This method is invoked at the beginning of the execution of each
+        # example_group. The next method to be invoked after this is
+        # #example_started
         #
-        # The next method to be invoked after this is #example_failed or #example_finished
-        def add_behaviour(name)
+        # ==== Parameters
+        # example_group_proxy:: instance of Spec::Example::ExampleGroupProxy
+        def example_group_started(example_group_proxy)
+        end
+        
+        # Deprecated - use example_group_started instead
+        def add_example_group(example_group_proxy)
+          Spec.deprecate("BaseFormatter#add_example_group", "BaseFormatter#example_group_started")
+          example_group_started(example_group_proxy)
         end
 
-        # This method is invoked when an example starts. +name+ is the name of the
-        # example.
-        def example_started(name)
+        # This method is invoked when an +example+ starts. The next method to be
+        # invoked after this is #example_passed, #example_failed, or
+        # #example_pending
+        #
+        # ==== Parameters
+        # example_proxy:: instance of Spec::Example::ExampleProxy
+        def example_started(example_proxy)
         end
 
-        # This method is invoked when an example passes. +name+ is the name of the
-        # example.
-        def example_passed(name)
+        # This method is invoked when an +example+ passes.
+        # +example_proxy+ is the same instance of Spec::Example::ExampleProxy
+        # that was passed to example_started
+        #
+        # ==== Parameters
+        # example_proxy:: instance of Spec::Example::ExampleProxy
+        def example_passed(example_proxy)
         end
 
-        # This method is invoked when an example fails, i.e. an exception occurred
-        # inside it (such as a failed should or other exception). +name+ is the name
-        # of the example. +counter+ is the sequence number of the failure
-        # (starting at 1) and +failure+ is the associated Failure object.
-        def example_failed(name, counter, failure)
+        # This method is invoked when an +example+ fails, i.e. an exception occurred
+        # inside it (such as a failed should or other exception).
+        #
+        # ==== Parameters
+        # example_proxy::
+        #   The same instance of Spec::Example::ExampleProxy that was passed
+        #   to <tt>example_started</tt>
+        #
+        # counter:: the sequential number of this failure
+        #
+        # failure:: instance of Spec::Runner::Reporter::Failure
+        def example_failed(example_proxy, counter, failure)
         end
         
-        # This method is invoked when an example is not yet implemented (i.e. has not been provided a block). 
-        # +name+ is the name of the example.
-        def example_not_implemented(name)
+        # This method is invoked when an example is not yet implemented (i.e. has not
+        # been provided a block), or when an ExamplePendingError is raised.
+        # +message+ is the message from the ExamplePendingError, if it exists, or the
+        # default value of "Not Yet Implemented". +deprecated_pending_location+ is
+        # deprecated - use example_proxy.location instead
+        #
+        # ==== Parameters
+        # example_proxy:: instance of Spec::Example::ExampleProxy
+        # message::
+        #   the message passed to the pending message, or an internal
+        #   default
+        #
+        def example_pending(example_proxy, message, deprecated_pending_location=nil)
         end
 
         # This method is invoked after all of the examples have executed. The next method
-        # to be invoked after this one is #dump_failure (once for each failed example),
+        # to be invoked after this one is #dump_failure (once for each failed example)
         def start_dump
         end
 
@@ -55,13 +109,30 @@ module Spec
         # This method is invoked for each failed example after all examples have run. +counter+ is the sequence number
         # of the associated example. +failure+ is a Failure object, which contains detailed
         # information about the failure.
+        #
+        # ==== Parameters
+        # counter:: the sequential number of this failure
+        # failure:: instance of Spec::Runner::Reporter::Failure
         def dump_failure(counter, failure)
         end
       
-        # This method is invoked at the very end.
-        def dump_summary(duration, example_count, failure_count, not_implemented_count)
+        # This method is invoked after the dumping of examples and failures.
+        #
+        # ==== Parameters
+        # duration:: the total time for the entire run
+        # example_count:: the number of examples run
+        # failure_count:: the number of examples that failed
+        # pending_count:: the number of examples that are pending
+        def dump_summary(duration, example_count, failure_count, pending_count)
+        end
+        
+        # This gets invoked after the summary
+        def dump_pending
         end
 
+        # This method is invoked at the very end. Allows the formatter to clean up, like closing open streams.
+        def close
+        end
       end
     end
   end

data/lib/spec/runner/formatter/base_text_formatter.rb

@@ -1,3 +1,6 @@
+require 'spec/runner/formatter/base_formatter'
+require 'fileutils'
+
 module Spec
   module Runner
     module Formatter
@@ -5,58 +8,58 @@ module Spec
       # non-text based ones too - just ignore the +output+ constructor
       # argument.
       class BaseTextFormatter < BaseFormatter
-        attr_writer :dry_run
-        
-        # Creates a new instance that will write to +where+. If +where+ is a
+        attr_reader :output, :example_group
+        # Creates a new instance that will write to +output+. If +output+ is a
         # String, output will be written to the File with that name, otherwise
-        # +where+ is exected to be an IO (or an object that responds to #puts and #write).
-        def initialize(where)
-          super(where)
-          if where.is_a?(String)
-            @output = File.open(where, 'w')
-          elsif where == STDOUT
-            @output = Kernel
-            def @output.flush
-              STDOUT.flush
-            end
+        # +output+ is exected to be an IO (or an object that responds to #puts
+        # and #write).
+        def initialize(options, output)
+          @options = options
+          if String === output
+            FileUtils.mkdir_p(File.dirname(output))
+            @output = File.open(output, 'w')
           else
-            @output = where
+            @output = output
           end
-          @colour = false
-          @dry_run = false
-          @snippet_extractor = SnippetExtractor.new
+          @pending_examples = []
         end
-        
-        def colour=(colour)
-          @colour = colour
-          begin ; require 'Win32/Console/ANSI' if @colour && PLATFORM =~ /win32/ ; rescue LoadError ; raise "You must gem install win32console to use colour on Windows" ; end
-	      end
 
+        def example_group_started(example_group_proxy)
+          @example_group = example_group_proxy
+        end
+        
+        def example_pending(example, message, deprecated_pending_location=nil)
+          @pending_examples << ["#{@example_group.description} #{example.description}", message, example.location]
+        end
+        
         def dump_failure(counter, failure)
           @output.puts
           @output.puts "#{counter.to_s})"
-          if(failure.expectation_not_met?)
-            @output.puts red(failure.header)
-            @output.puts red(failure.exception.message)
-          else
-            @output.puts magenta(failure.header)
-            @output.puts magenta(failure.exception.message)
-          end
+          @output.puts colorize_failure("#{failure.header}\n#{failure.exception.message}", failure)
           @output.puts format_backtrace(failure.exception.backtrace)
           @output.flush
         end
-      
-        def dump_summary(duration, example_count, failure_count, not_implemented_count)
-          return if @dry_run
+        
+        def colorize_failure(message, failure)
+          failure.pending_fixed? ? blue(message) : red(message)
+        end
+        
+        def colourise(message, failure)
+          Spec::deprecate("BaseTextFormatter#colourise", "colorize_failure")
+          colorize_failure(message, failure)
+        end
+        
+        def dump_summary(duration, example_count, failure_count, pending_count)
+          return if dry_run?
           @output.puts
           @output.puts "Finished in #{duration} seconds"
           @output.puts
 
           summary = "#{example_count} example#{'s' unless example_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
-          summary << ", #{not_implemented_count} not implemented" if not_implemented_count > 0  
+          summary << ", #{pending_count} pending" if pending_count > 0  
 
           if failure_count == 0
-            if not_implemented_count > 0
+            if pending_count > 0
               @output.puts yellow(summary)
             else
               @output.puts green(summary)
@@ -67,35 +70,72 @@ module Spec
           @output.flush
         end
 
+        def dump_pending
+          unless @pending_examples.empty?
+            @output.puts
+            @output.puts "Pending:"
+            @pending_examples.each do |pending_example|
+              @output.puts "\n#{pending_example[0]} (#{pending_example[1]})"
+              @output.puts "#{pending_example[2]}\n"
+            end
+          end
+          @output.flush
+        end
+        
+        def close
+          @output.close  if (IO === @output) & (@output != $stdout)
+        end
+        
         def format_backtrace(backtrace)
           return "" if backtrace.nil?
           backtrace.map { |line| backtrace_line(line) }.join("\n")
         end
       
       protected
-      
+
+        def colour?
+          !!@options.colour
+        end
+
+        def dry_run?
+          !!@options.dry_run
+        end
+        
+        def autospec?
+          !!@options.autospec || ENV.has_key?("AUTOTEST")
+        end
+        
         def backtrace_line(line)
           line.sub(/\A([^:]+:\d+)$/, '\\1:')
         end
 
         def colour(text, colour_code)
-          return text unless @colour && output_to_tty?
+          return text if output_to_file?
+          return text unless ENV['RSPEC_COLOR'] || (colour? & (autospec? || output_to_tty?)) 
           "#{colour_code}#{text}\e[0m"
         end
 
+        def output_to_file?
+          File === @output
+        end
+        
         def output_to_tty?
           begin
-            @output == Kernel || @output.tty?
+            @output.tty?
           rescue NoMethodError
             false
           end
         end
         
-        def red(text); colour(text, "\e[31m"); end
         def green(text); colour(text, "\e[32m"); end
-        def magenta(text); colour(text, "\e[35m"); end
+        def red(text); colour(text, "\e[31m"); end
         def yellow(text); colour(text, "\e[33m"); end
+        def blue(text); colour(text, "\e[34m"); end
         
+        def magenta(text)
+          Spec::deprecate("BaseTextFormatter#magenta")
+          red(text)
+        end
       end
     end
   end

data/lib/spec/runner/formatter/failing_example_groups_formatter.rb

@@ -0,0 +1,25 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class FailingExampleGroupsFormatter < BaseTextFormatter
+        def example_failed(example, counter, failure)
+          if @example_group
+            @output.puts @example_group.description.gsub(/ \(druby.*\)/,"")
+
+            @output.flush
+            @example_group = nil
+          end
+        end
+        
+        def dump_failure(counter, failure)
+        end
+
+        def dump_summary(duration, example_count, failure_count, pending_count)
+        end
+        
+      end
+    end
+  end
+end

data/lib/spec/runner/formatter/failing_examples_formatter.rb

@@ -1,22 +1,20 @@
+require 'spec/runner/formatter/base_text_formatter'
+
 module Spec
   module Runner
     module Formatter
       class FailingExamplesFormatter < BaseTextFormatter      
-        def add_behaviour(behaviour_name)
-          @behaviour_name = behaviour_name
-        end
-      
-        def example_failed(name, counter, failure)
-          @output.puts "#{@behaviour_name} #{name}"
+        def example_failed(example, counter, failure)
+          @output.puts "#{example_group.description} #{example.description}"
           @output.flush
         end
 
         def dump_failure(counter, failure)
         end
 
-        def dump_summary(duration, example_count, failure_count, not_implemented_count)
+        def dump_summary(duration, example_count, failure_count, pending_count)
         end
       end
     end
   end
-end
+end