dchelimsky-rspec 1.1.10

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

@@ -0,0 +1,65 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class NestedTextFormatter < BaseTextFormatter
+        attr_reader :previous_nested_example_groups
+        def initialize(options, where)
+          super
+          @previous_nested_example_groups = []
+        end
+
+        def add_example_group(example_group)
+          super
+
+          current_nested_example_groups = described_example_group_chain
+          current_nested_example_groups.each_with_index do |nested_example_group, i|
+            unless nested_example_group == previous_nested_example_groups[i]
+              output.puts "#{'  ' * i}#{nested_example_group.description_args}"
+            end
+          end
+
+          @previous_nested_example_groups = described_example_group_chain
+        end
+
+        def example_failed(example, counter, failure)
+          message = if failure.expectation_not_met?
+            "#{current_indentation}#{example.description} (FAILED - #{counter})"
+          else
+            "#{current_indentation}#{example.description} (ERROR - #{counter})"
+          end
+
+          output.puts(failure.expectation_not_met? ? red(message) : magenta(message))
+          output.flush
+        end
+
+        def example_passed(example)
+          message = "#{current_indentation}#{example.description}"
+          output.puts green(message)
+          output.flush
+        end
+
+        def example_pending(example, message, pending_caller)
+          super
+          output.puts yellow("#{current_indentation}#{example.description} (PENDING: #{message})")
+          output.flush
+        end
+
+        def current_indentation
+          '  ' * previous_nested_example_groups.length
+        end
+
+        def described_example_group_chain
+          example_group_chain = []
+          example_group.__send__(:each_ancestor_example_group_class) do |example_group_class|
+            unless example_group_class.description_args.empty?
+              example_group_chain << example_group_class
+            end
+          end
+          example_group_chain
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+require 'spec/runner/formatter/progress_bar_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class ProfileFormatter < ProgressBarFormatter
+        
+        def initialize(options, where)
+          super
+          @example_times = []
+        end
+        
+        def start(count)
+          @output.puts "Profiling enabled."
+        end
+        
+        def example_started(example)
+          @time = Time.now
+        end
+        
+        def example_passed(example)
+          super
+          @example_times << [
+            example_group.description,
+            example.description,
+            Time.now - @time
+          ]
+        end
+        
+        def start_dump
+          super
+          @output.puts "\n\nTop 10 slowest examples:\n"
+          
+          @example_times = @example_times.sort_by do |description, example, time|
+            time
+          end.reverse
+          
+          @example_times[0..9].each do |description, example, time|
+            @output.print red(sprintf("%.7f", time))
+            @output.puts " #{description} #{example}"
+          end
+          @output.flush
+        end
+        
+        def method_missing(sym, *args)
+          # ignore
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class ProgressBarFormatter < BaseTextFormatter
+        def example_failed(example, counter, failure)
+          @output.print colourise('F', failure)
+          @output.flush
+        end
+
+        def example_passed(example)
+          @output.print green('.')
+          @output.flush
+        end
+      
+        def example_pending(example, message, pending_caller)
+          super
+          @output.print yellow('*')
+          @output.flush
+        end
+        
+        def start_dump
+          @output.puts
+          @output.flush
+        end
+        
+        def method_missing(sym, *args)
+          # ignore
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Spec
+  module Runner
+    module Formatter
+      # This class extracts code snippets by looking at the backtrace of the passed error
+      class SnippetExtractor #:nodoc:
+        class NullConverter; def convert(code, pre); code; end; end #:nodoc:
+        begin; require 'rubygems'; require 'syntax/convertors/html'; @@converter = Syntax::Convertors::HTML.for_syntax "ruby"; rescue LoadError => e; @@converter = NullConverter.new; end
+        
+        def snippet(error)
+          raw_code, line = snippet_for(error.backtrace[0])
+          highlighted = @@converter.convert(raw_code, false)
+          highlighted << "\n<span class=\"comment\"># gem install syntax to get syntax highlighting</span>" if @@converter.is_a?(NullConverter)
+          post_process(highlighted, line)
+        end
+        
+        def snippet_for(error_line)
+          if error_line =~ /(.*):(\d+)/
+            file = $1
+            line = $2.to_i
+            [lines_around(file, line), line]
+          else
+            ["# Couldn't get snippet for #{error_line}", 1]
+          end
+        end
+        
+        def lines_around(file, line)
+          if File.file?(file)
+            lines = File.open(file).read.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
+        end
+        
+        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/spec/runner/formatter/specdoc_formatter.rb

@@ -0,0 +1,39 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class SpecdocFormatter < BaseTextFormatter
+        def add_example_group(example_group)
+          super
+          output.puts
+          output.puts example_group.description
+          output.flush
+        end
+      
+        def example_failed(example, counter, failure)
+          message = if failure.expectation_not_met?
+            "- #{example.description} (FAILED - #{counter})"
+          else
+            "- #{example.description} (ERROR - #{counter})"
+          end
+          
+          output.puts(failure.expectation_not_met? ? red(message) : magenta(message))
+          output.flush
+        end
+        
+        def example_passed(example)
+          message = "- #{example.description}"
+          output.puts green(message)
+          output.flush
+        end
+        
+        def example_pending(example, message, pending_caller)
+          super
+          output.puts yellow("- #{example.description} (PENDING: #{message})")
+          output.flush
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,174 @@
+require 'erb'
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      module Story
+        class HtmlFormatter < BaseTextFormatter
+          include ERB::Util
+          
+          def initialize(options, where)
+            super
+            @previous_type = nil
+            @scenario_text = ""
+            @story_text = ""
+            @scenario_failed = false
+            @story_failed = false
+          end
+          
+          def run_started(count)
+            @output.puts <<-EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html 
+  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>Stories</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta http-equiv="Expires" content="-1" />
+    <meta http-equiv="Pragma" content="no-cache" />
+    <script src="javascripts/prototype.js" type="text/javascript"></script>
+    <script src="javascripts/scriptaculous.js" type="text/javascript"></script>
+    <script src="javascripts/rspec.js" type="text/javascript"></script>
+    <link href="stylesheets/rspec.css" rel="stylesheet" type="text/css" />
+  </head>
+  <body>
+    <div id="container">
+EOF
+          end
+
+          def collected_steps(steps)
+            unless steps.empty?
+              @output.puts "      <ul id=\"stock_steps\" style=\"display: none;\">"
+              steps.each do |step|
+                @output.puts "        <li>#{step}</li>"
+              end
+              @output.puts "      </ul>"
+            end
+          end
+
+          def run_ended
+            @output.puts <<-EOF
+    </div>
+  </body>
+</head>
+EOF
+          end
+          
+          def story_started(title, narrative)
+            @story_failed = false
+            @story_text = <<-EOF 
+        <dt>Story: #{h title}</dt>
+        <dd>
+          <p>
+            #{h(narrative).split("\n").join("<br />")}
+          </p>
+EOF
+          end
+
+          def story_ended(title, narrative)     
+            if @story_failed
+              @output.puts <<-EOF
+      <dl class="story failed">
+EOF
+            else
+              @output.puts <<-EOF
+      <dl class="story passed">
+EOF
+            end
+              @output.puts <<-EOF
+#{@story_text}
+        </dd>
+      </dl>
+EOF
+          end
+     
+          def scenario_started(story_title, scenario_name)
+            @previous_type = nil
+            @scenario_failed = false
+            @scenario_text = <<-EOF
+              <dt>Scenario: #{h scenario_name}</dt>
+              <dd>
+                <ul class="steps">
+EOF
+          end
+
+          def scenario_ended
+            if @scenario_failed
+              @story_text += <<-EOF
+            <dl class="failed">
+EOF
+            else
+              @story_text += <<-EOF
+            <dl class="passed">
+EOF
+            end
+            
+            @story_text += <<-EOF
+#{@scenario_text}
+                </ul>
+              </dd>
+            </dl>
+EOF
+          end
+          
+          def found_scenario(type, description)
+          end
+
+          def scenario_succeeded(story_title, scenario_name)
+            scenario_ended
+          end
+
+          def scenario_pending(story_title, scenario_name, reason)
+            scenario_ended
+          end
+
+          def scenario_failed(story_title, scenario_name, err)
+            @scenario_failed = true
+            @story_failed = true
+            scenario_ended
+          end
+
+          def step_upcoming(type, description, *args)
+          end
+
+          def step_succeeded(type, description, *args)
+            print_step('passed', type, description, *args) # TODO: uses succeeded CSS class
+          end
+
+          def step_pending(type, description, *args)
+            print_step('pending', type, description, *args)
+          end
+
+          def step_failed(type, description, *args)
+            print_step('failed', type, description, *args)
+          end
+          
+          def print_step(klass, type, description, *args)
+            spans = args.map { |arg| "<span class=\"param\">#{arg}</span>" }
+            desc_string = description.step_name
+            arg_regexp = description.arg_regexp           
+            inner = if(type == @previous_type)
+              "And "
+            else
+              "#{type.to_s.capitalize} "
+            end
+            i = -1
+            inner += desc_string.gsub(arg_regexp) { |param| spans[i+=1] }
+            
+            @scenario_text += "                  <li class=\"#{klass}\">#{inner}</li>\n"
+            
+            if type == :'given scenario'
+              @previous_type = :given
+            else
+              @previous_type = type
+            end
+            
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,194 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      module Story
+        class PlainTextFormatter < BaseTextFormatter
+          def initialize(options, where)
+            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 
+            
+            @scenario_body_text = ""
+            @story_body_text = ""
+            
+            @scenario_head_text = ""
+            @story_head_text = ""
+                  
+            @scenario_failed = false
+            @story_failed = false
+          end
+        
+          def run_started(count)
+            @count = count
+            @output.puts "Running #@count scenarios\n\n"
+          end
+
+          def story_started(title, narrative)
+            @pre_story_pending_count = @pending_scenario_count
+            @pre_story_successful_count = @successful_scenario_count
+            
+            @current_story_title = title
+            @story_failed = false
+            @story_body_text = ""
+            @story_head_text = "Story: #{title}\n\n"
+
+            narrative.each_line do |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
+
+          def scenario_started(story_title, scenario_name)
+            @current_scenario_name = scenario_name
+            @scenario_already_failed = false
+            @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
+            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|
+                story_name, scenario_name, msg = pending
+                @output.puts "#{i+1}) #{story_name} (#{scenario_name}): #{msg}"
+              end
+            end
+            unless @failed_scenarios.empty?
+              @output.print "\nFAILURES:"
+              @failed_scenarios.each_with_index do |failure, i|
+                title, scenario_name, err = failure
+                @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
+
+          def step_upcoming(type, description, *args)
+          end
+                  
+          def step_succeeded(type, description, *args)
+            found_step(type, description, false, false, *args)
+          end
+        
+          def step_pending(type, description, *args)
+            found_step(type, description, false, true, *args)
+            @pending_steps << [@current_story_title, @current_scenario_name, description]
+            @scenario_body_text +=  yellow(" (PENDING)")
+            @scenario_pending = true
+            @scenario_ok = false
+          end
+        
+          def step_failed(type, description, *args)
+            found_step(type, description, true, @scenario_pending, *args)
+            if @scenario_pending
+              @scenario_body_text +=  yellow(" (SKIPPED)")
+            else
+              @scenario_body_text +=  red(@scenario_ok ? " (FAILED)" : " (SKIPPED)")
+            end
+            @scenario_ok = false
+          end
+          
+          def collected_steps(steps)
+          end
+          
+          def method_missing(sym, *args, &block) #:nodoc:
+            # noop - ignore unknown messages
+          end
+
+        private
+
+          def found_step(type, description, failed, pending, *args)
+            desc_string = description.step_name
+            arg_regexp = description.arg_regexp
+            text = if(type == @previous_type)
+              "\n    And "
+            else
+              "\n\n    #{type.to_s.capitalize} "
+            end
+            i = -1
+            text << desc_string.gsub(arg_regexp) { |param| args[i+=1] }
+            if pending
+              @scenario_body_text += yellow(text)
+            else
+              @scenario_body_text += (failed ? red(text) : green(text))
+            end
+
+            if type == :'given scenario'
+              @previous_type = :given
+            else
+              @previous_type = type
+            end
+          end
+        end
+      end
+    end
+  end
+end