rspec 1.1.4 → 1.1.5

data/lib/spec/runner/formatter/story/plain_text_formatter.rb

@@ -9,9 +9,22 @@ module Spec
             super
             @successful_scenario_count = 0
             @pending_scenario_count = 0
+            
+            @pre_story_pending_count = 0
+            @pre_story_successful_count = 0
+            
             @failed_scenarios = []
             @pending_steps = []
-            @previous_type = nil
+            @previous_type = nil 
+            
+            @scenario_body_text = ""
+            @story_body_text = ""
+            
+            @scenario_head_text = ""
+            @story_head_text = ""
+                  
+            @scenario_failed = false
+            @story_failed = false
           end
         
           def run_started(count)
@@ -20,15 +33,30 @@ module Spec
           end
 
           def story_started(title, narrative)
+            @pre_story_pending_count = @pending_scenario_count
+            @pre_story_successful_count = @successful_scenario_count
+            
             @current_story_title = title
-            @output.puts "Story: #{title}\n\n"
+            @story_failed = false
+            @story_body_text = ""
+            @story_head_text = "Story: #{title}\n\n"
+
             narrative.each_line do |line|
-              @output.print "  "
-              @output.print line
+              @story_head_text += "  "
+              @story_head_text += line
             end
           end
         
           def story_ended(title, narrative)
+            if @story_failed
+              @output.print red(@story_head_text)
+            elsif @pre_story_successful_count == @successful_scenario_count && 
+                  @pending_scenario_count >= @pre_story_pending_count
+              @output.print yellow(@story_head_text)
+            else              
+              @output.print green(@story_head_text)
+            end
+            @output.print @story_body_text
             @output.puts
             @output.puts
           end
@@ -36,29 +64,54 @@ module Spec
           def scenario_started(story_title, scenario_name)
             @current_scenario_name = scenario_name
             @scenario_already_failed = false
-            @output.print "\n\n  Scenario: #{scenario_name}"
+            @scenario_head_text = "\n\n  Scenario: #{scenario_name}"
+            @scenario_body_text = ""
             @scenario_ok = true
             @scenario_pending = false
+            @scenario_failed = false
           end
         
           def scenario_succeeded(story_title, scenario_name)
             @successful_scenario_count += 1
+            scenario_ended
           end
         
           def scenario_failed(story_title, scenario_name, err)
             @options.backtrace_tweaker.tweak_backtrace(err)
             @failed_scenarios << [story_title, scenario_name, err] unless @scenario_already_failed
             @scenario_already_failed = true
+            @story_failed = true
+            @scenario_failed = true
+            scenario_ended
           end
         
           def scenario_pending(story_title, scenario_name, msg)
             @pending_scenario_count += 1 unless @scenario_already_failed
             @scenario_pending = true
             @scenario_already_failed = true
+            scenario_ended
           end
         
+          def scenario_ended
+            if @scenario_failed
+              @story_body_text += red(@scenario_head_text)
+            elsif @scenario_pending
+              @story_body_text += yellow(@scenario_head_text)
+            else
+              @story_body_text += green(@scenario_head_text)
+            end
+            @story_body_text += @scenario_body_text
+          end
+          
           def run_ended
-            @output.puts "#@count scenarios: #@successful_scenario_count succeeded, #{@failed_scenarios.size} failed, #@pending_scenario_count pending"
+            summary_text = "#@count scenarios: #@successful_scenario_count succeeded, #{@failed_scenarios.size} failed, #@pending_scenario_count pending"
+            if !@failed_scenarios.empty?
+              @output.puts red(summary_text)
+            elsif !@pending_steps.empty?
+              @output.puts yellow(summary_text)
+            else
+              @output.puts green(summary_text)
+            end
             unless @pending_steps.empty?
               @output.puts "\nPending Steps:"
               @pending_steps.each_with_index do |pending, i|
@@ -70,11 +123,10 @@ module Spec
               @output.print "\nFAILURES:"
               @failed_scenarios.each_with_index do |failure, i|
                 title, scenario_name, err = failure
-                @output.print %[
-    #{i+1}) #{title} (#{scenario_name}) FAILED
-    #{err.class}: #{err.message}
-    #{err.backtrace.join("\n")}
-]
+                @output.print "\n    #{i+1}) "
+                @output.print red("#{title} (#{scenario_name}) FAILED")
+                @output.print red("\n    #{err.class}: #{err.message}")
+                @output.print "\n    #{err.backtrace.join("\n")}\n"
               end
             end            
           end
@@ -89,7 +141,7 @@ module Spec
           def step_pending(type, description, *args)
             found_step(type, description, false, true, *args)
             @pending_steps << [@current_story_title, @current_scenario_name, description]
-            @output.print yellow(" (PENDING)")
+            @scenario_body_text +=  yellow(" (PENDING)")
             @scenario_pending = true
             @scenario_ok = false
           end
@@ -97,9 +149,9 @@ module Spec
           def step_failed(type, description, *args)
             found_step(type, description, true, @scenario_pending, *args)
             if @scenario_pending
-              @output.print yellow(" (SKIPPED)")
+              @scenario_body_text +=  yellow(" (SKIPPED)")
             else
-              @output.print red(@scenario_ok ? " (FAILED)" : " (SKIPPED)")
+              @scenario_body_text +=  red(@scenario_ok ? " (FAILED)" : " (SKIPPED)")
             end
             @scenario_ok = false
           end
@@ -124,9 +176,9 @@ module Spec
             i = -1
             text << desc_string.gsub(arg_regexp) { |param| args[i+=1] }
             if pending
-              @output.print yellow(text)
+              @scenario_body_text += yellow(text)
             else
-              @output.print(failed ? red(text) : green(text))
+              @scenario_body_text += (failed ? red(text) : green(text))
             end
 
             if type == :'given scenario'

data/lib/spec/runner/formatter/story/progress_bar_formatter.rb

@@ -0,0 +1,42 @@
+require 'spec/runner/formatter/story/plain_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      module Story
+        class ProgressBarFormatter < PlainTextFormatter
+
+          def story_started(title, narrative) end
+          def story_ended(title, narrative) end
+
+          def run_started(count)
+            @start_time = Time.now
+            super
+          end
+          
+          def run_ended
+            @output.puts
+            @output.puts
+            @output.puts "Finished in %f seconds" % (Time.now - @start_time)
+            @output.puts
+            super
+          end
+
+          def scenario_ended
+            if @scenario_failed
+              @output.print red('F')
+              @output.flush
+            elsif @scenario_pending
+              @output.print yellow('P')
+              @output.flush
+            else
+              @output.print green('.')
+              @output.flush
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/spec/runner/heckle_runner.rb

@@ -25,7 +25,7 @@ module Spec
       
       def heckle_method(class_name, method_name)
         verify_constant(class_name)
-        heckle = @heckle_class.new(class_name, method_name, rspec_options)
+        heckle = @heckle_class.new(class_name, method_name, Spec::Runner.options)
         heckle.validate
       end
       
@@ -39,7 +39,7 @@ module Spec
         
         classes.each do |klass|
           klass.instance_methods(false).each do |method_name|
-            heckle = @heckle_class.new(klass.name, method_name, rspec_options)
+            heckle = @heckle_class.new(klass.name, method_name, Spec::Runner.options)
             heckle.validate
           end
         end

data/lib/spec/runner/option_parser.rb

@@ -54,6 +54,7 @@ module Spec
                                                     "Builtin formats for stories: ",
                                                     "plain|p              : Plain Text",
                                                     "html|h               : A nice HTML report",
+                                                    "progress|r           : Text progress",
                                                     " ",
                                                     "FORMAT can also be the name of a custom formatter class",
                                                     "(in which case you should also specify --require to load it)"],
@@ -186,7 +187,7 @@ module Spec
       end
 
       def parse_version
-        @out_stream.puts ::Spec::VERSION::DESCRIPTION
+        @out_stream.puts ::Spec::VERSION::SUMMARY
         exit if stdout?
       end
 

data/lib/spec/runner/options.rb

@@ -24,10 +24,13 @@ module Spec
       }
 
       STORY_FORMATTERS = {
-        'plain' => ['spec/runner/formatter/story/plain_text_formatter', 'Formatter::Story::PlainTextFormatter'],
-            'p' => ['spec/runner/formatter/story/plain_text_formatter', 'Formatter::Story::PlainTextFormatter'],
-         'html' => ['spec/runner/formatter/story/html_formatter',       'Formatter::Story::HtmlFormatter'],
-            'h' => ['spec/runner/formatter/story/html_formatter',       'Formatter::Story::HtmlFormatter']
+        'plain' => ['spec/runner/formatter/story/plain_text_formatter',   'Formatter::Story::PlainTextFormatter'],
+            'p' => ['spec/runner/formatter/story/plain_text_formatter',   'Formatter::Story::PlainTextFormatter'],
+         'html' => ['spec/runner/formatter/story/html_formatter',         'Formatter::Story::HtmlFormatter'],
+            'h' => ['spec/runner/formatter/story/html_formatter',         'Formatter::Story::HtmlFormatter'],
+     'progress' => ['spec/runner/formatter/story/progress_bar_formatter', 'Formatter::Story::ProgressBarFormatter'],
+            'r' => ['spec/runner/formatter/story/progress_bar_formatter', 'Formatter::Story::ProgressBarFormatter']
+            
       }
 
       attr_accessor(
@@ -54,7 +57,7 @@ module Spec
         :argv
       )
       attr_reader :colour, :differ_class, :files, :example_groups
-
+      
       def initialize(error_stream, output_stream)
         @error_stream = error_stream
         @output_stream = output_stream
@@ -89,9 +92,6 @@ module Spec
         return true unless examples_should_be_run?
         success = true
         begin
-          before_suite_parts.each do |part|
-            part.call
-          end
           runner = custom_runner || ExampleGroupRunner.new(self)
 
           unless @files_loaded
@@ -99,6 +99,15 @@ module Spec
             @files_loaded = true
           end
 
+          # TODO - this has to happen after the files get loaded,
+          # otherwise the before_suite_parts are not populated
+          # from the configuration. There is no spec for this
+          # directly, but stories/configuration/before_blocks.story
+          # will fail if this happens before the files are loaded.
+          before_suite_parts.each do |part|
+            part.call
+          end
+
           if example_groups.empty?
             true
           else
@@ -125,7 +134,7 @@ module Spec
 
       def colour=(colour)
         @colour = colour
-        if @colour && RUBY_PLATFORM =~ /win32/ ;\
+        if @colour && RUBY_PLATFORM =~ /mswin|mingw/ ;\
           begin ;\
             require 'rubygems' ;\
             require 'Win32/Console/ANSI' ;\

data/lib/spec/runner/reporter.rb

@@ -26,7 +26,7 @@ module Spec
         if error.nil?
           example_passed(example)
         elsif Spec::Example::ExamplePendingError === error
-          example_pending(example, error.message)
+          example_pending(example, error.pending_caller, error.message)
         else
           example_failed(example, error)
         end
@@ -103,14 +103,34 @@ module Spec
       def example_passed(example)
         formatters.each{|f| f.example_passed(example)}
       end
+
+      EXAMPLE_PENDING_DEPRECATION_WARNING = <<-WARNING
+        DEPRECATION NOTICE: RSpec's formatters have changed example_pending
+        to accept three arguments instead of just two. Please see the rdoc
+        for Spec::Runner::Formatter::BaseFormatter#example_pending
+        for more information.
+          
+        Please update any custom formatters to accept the third argument
+        to example_pending. Support for example_pending with two arguments
+        and this warning message will be removed after the RSpec 1.1.5 release.
+      WARNING
       
-      def example_pending(example, message="Not Yet Implemented")
+      def example_pending(example, pending_caller, message="Not Yet Implemented")
         @pending_count += 1
-        formatters.each do |f|
-          f.example_pending(example, message)
+        formatters.each do |formatter|
+          if formatter_uses_deprecated_example_pending_method?(formatter)
+            Kernel.warn EXAMPLE_PENDING_DEPRECATION_WARNING
+            formatter.example_pending(example, message)
+          else
+            formatter.example_pending(example, message, pending_caller)
+          end
         end
       end
       
+      def formatter_uses_deprecated_example_pending_method?(formatter)
+        formatter.method(:example_pending).arity == 2
+      end
+      
       class Failure
         attr_reader :example, :exception
         

data/lib/spec/runner/spec_parser.rb

@@ -11,7 +11,7 @@ module Spec
       def spec_name_for(file, line_number)
         best_match.clear
         file = File.expand_path(file)
-        rspec_options.example_groups.each do |example_group|
+        Spec::Runner.options.example_groups.each do |example_group|
           consider_example_groups_for_best_match example_group, file, line_number
 
           example_group.examples.each do |example|

data/lib/spec/story/runner.rb

@@ -10,8 +10,7 @@ module Spec
     module Runner
       class << self
         def run_options # :nodoc:
-          rspec_options
-          # @run_options ||= ::Spec::Runner::OptionParser.parse(ARGV, $stderr, $stdout)
+          Spec::Runner.options
         end
         
         def story_runner # :nodoc:

data/lib/spec/story/runner/story_mediator.rb

@@ -38,6 +38,14 @@
           current_scenario.add_step Step.new('Then', name)
         end
         
+        def last_step
+          current_scenario.last_step
+        end
+        
+        def add_to_last(name)
+          last_step.name << name
+        end
+        
         def run_stories
           stories.each { |story| @runner.instance_eval(&story) }
         end
@@ -100,9 +108,15 @@
           def add_step(step)
             @steps << step
           end
+          
+          def last_step
+            @steps.last
+          end
         end
         
         class Step
+          attr_reader :name
+          
           def initialize(type, name)
             @type = type
             @name = name

data/lib/spec/story/runner/story_parser.rb

@@ -26,6 +26,7 @@ module Spec
         def process_line(line)
           line.strip!
           case line
+          when /^#/                 then @state.comment(line)
           when /^Story: /           then @state.story(line)
           when /^Scenario: /        then @state.scenario(line)
           when /^Given:? /          then @state.given(line)
@@ -72,6 +73,10 @@ module Spec
         def create_then(name)
           @story_mediator.create_then(name)
         end
+        
+        def add_to_last(line)
+          @story_mediator.add_to_last("\n#{line}")
+        end
 
         def transition_to(key)
           @state = states[key]
@@ -136,6 +141,9 @@ module Spec
           def other(line)
             # no-op - supports header text before the first story in a file
           end
+          
+          def comment(line)
+          end
         end
         
         class StartingState < State
@@ -199,6 +207,10 @@ module Spec
           def given(line)
             @parser.create_given(remove_tag_from(:given, line))
           end
+          
+          def other(line)
+            @parser.add_to_last(line)
+          end
         end
         
         class WhenState < State
@@ -209,6 +221,10 @@ module Spec
           def event(line)
             @parser.create_when(remove_tag_from(:when ,line))
           end
+
+          def other(line)
+            @parser.add_to_last(line)
+          end
         end
 
         class ThenState < State
@@ -219,6 +235,10 @@ module Spec
           def outcome(line)
             @parser.create_then(remove_tag_from(:then ,line))
           end
+
+          def other(line)
+            @parser.add_to_last(line)
+          end
         end
 
       end