rspec 1.0.0 → 1.3.1

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

@@ -1,22 +1,29 @@
+require 'erb'
+require 'spec/runner/formatter/base_text_formatter'
+require 'spec/runner/formatter/no_op_method_missing'
+
 module Spec
   module Runner
     module Formatter
       class HtmlFormatter < BaseTextFormatter
+        include ERB::Util # for the #h method
+        include NOOPMethodMissing
         
-        def initialize(output)
+        def initialize(options, output)
           super
-          @current_behaviour_number = 0
-          @current_example_number = 0
+          @example_group_number = 0
+          @example_number = 0
+          @header_red = nil
         end
-
-        # The number of the currently running behaviour
-        def current_behaviour_number
-          @current_behaviour_number
+        
+        # The number of the currently running example_group
+        def example_group_number
+          @example_group_number
         end
         
-        # The number of the currently running example
-        def current_example_number
-          @current_example_number
+        # The number of the currently running example (a global counter)
+        def example_number
+          @example_number
         end
         
         def start(example_count)
@@ -27,15 +34,17 @@ module Spec
           @output.flush
         end
 
-        def add_behaviour(name)
-          @current_behaviour_number += 1
-          unless current_behaviour_number == 1
+        def example_group_started(example_group)
+          super
+          @example_group_red = false
+          @example_group_number += 1
+          unless example_group_number == 1
             @output.puts "  </dl>"
             @output.puts "</div>"
           end
-          @output.puts "<div class=\"behaviour\">"
+          @output.puts "<div class=\"example_group\">"
           @output.puts "  <dl>"
-          @output.puts "  <dt id=\"behaviour_#{current_behaviour_number}\">#{escape(name)}</dt>"
+          @output.puts "  <dt id=\"example_group_#{example_group_number}\">#{h(example_group.description)}</dt>"
           @output.flush
         end
 
@@ -45,24 +54,28 @@ module Spec
           @output.flush
         end
 
-        def example_passed(name)
-          @current_example_number += 1
+        def example_started(example)
+          @example_number += 1
+        end
+
+        def example_passed(example)
           move_progress
-          @output.puts "    <dd class=\"spec passed\"><span class=\"passed_spec_name\">#{escape(name)}</span></dd>"
+          @output.puts "    <dd class=\"spec passed\"><span class=\"passed_spec_name\">#{h(example.description)}</span></dd>"
           @output.flush
         end
 
-        def example_failed(name, counter, failure)
+        def example_failed(example, counter, failure)
           extra = extra_failure_content(failure)
-          
-          @current_example_number += 1
-          @output.puts "    <script type=\"text/javascript\">makeRed('rspec-header');</script>"
-          @output.puts "    <script type=\"text/javascript\">makeRed('behaviour_#{current_behaviour_number}');</script>"
+          failure_style = failure.pending_fixed? ? 'pending_fixed' : 'failed'
+          @output.puts "    <script type=\"text/javascript\">makeRed('rspec-header');</script>" unless @header_red
+          @header_red = true
+          @output.puts "    <script type=\"text/javascript\">makeRed('example_group_#{example_group_number}');</script>" unless @example_group_red
+          @example_group_red = true
           move_progress
-          @output.puts "    <dd class=\"spec failed\">"
-          @output.puts "      <span class=\"failed_spec_name\">#{escape(name)}</span>"
+          @output.puts "    <dd class=\"spec #{failure_style}\">"
+          @output.puts "      <span class=\"failed_spec_name\">#{h(example.description)}</span>"
           @output.puts "      <div class=\"failure\" id=\"failure_#{counter}\">"
-          @output.puts "        <div class=\"message\"><pre>#{escape(failure.exception.message)}</pre></div>" unless failure.exception.nil?
+          @output.puts "        <div class=\"message\"><pre>#{h(failure.exception.message)}</pre></div>" unless failure.exception.nil?
           @output.puts "        <div class=\"backtrace\"><pre>#{format_backtrace(failure.exception.backtrace)}</pre></div>" unless failure.exception.nil?
           @output.puts extra unless extra == ""
           @output.puts "      </div>"
@@ -70,40 +83,45 @@ module Spec
           @output.flush
         end
 
-        def example_not_implemented(name)
-          @current_example_number += 1
-          @output.puts "    <script type=\"text/javascript\">makeYellow('rspec-header');</script>"
-          @output.puts "    <script type=\"text/javascript\">makeYellow('behaviour_#{current_behaviour_number}');</script>"
+        def example_pending(example, message, deprecated_pending_location=nil)
+          @output.puts "    <script type=\"text/javascript\">makeYellow('rspec-header');</script>" unless @header_red
+          @output.puts "    <script type=\"text/javascript\">makeYellow('example_group_#{example_group_number}');</script>" unless @example_group_red
           move_progress
-          @output.puts "    <dd class=\"spec not_implemented\"><span class=\"not_implemented_spec_name\">#{escape(name)}</span></dd>"
+          @output.puts "    <dd class=\"spec not_implemented\"><span class=\"not_implemented_spec_name\">#{h(example.description)} (PENDING: #{h(message)})</span></dd>"
           @output.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(failure)
+          require 'spec/runner/formatter/snippet_extractor'
+          @snippet_extractor ||= SnippetExtractor.new
           "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(failure.exception)}</code></pre>"
         end
         
         def move_progress
-          percent_done = @example_count == 0 ? 100.0 : (current_example_number.to_f / @example_count.to_f * 1000).to_i / 10.0
           @output.puts "    <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
           @output.flush
         end
-        
-        def escape(string)
-          string.gsub(/&/n, '&amp;').gsub(/\"/n, '&quot;').gsub(/>/n, '&gt;').gsub(/</n, '&lt;')
+
+        def percent_done
+          result = 100.0
+          if @example_count != 0
+            result = ((example_number).to_f / @example_count.to_f * 1000).to_i / 10.0
+          end
+          result
         end
 
         def dump_failure(counter, failure)
         end
 
-        def dump_summary(duration, example_count, failure_count, not_implemented_count)
-          if @dry_run
+        def dump_summary(duration, example_count, failure_count, pending_count)
+          if dry_run?
             totals = "This was a dry-run"
           else
             totals = "#{example_count} example#{'s' unless example_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
-            totals << ", #{not_implemented_count} not implemented" if not_implemented_count > 0  
+            totals << ", #{pending_count} pending" if pending_count > 0  
           end
           @output.puts "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{duration} seconds</strong>\";</script>"
           @output.puts "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{totals}\";</script>"
@@ -116,33 +134,24 @@ module Spec
 
         def html_header 
           <<-EOF
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?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>RSpec results</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <meta http-equiv="Expires" content="-1" />
   <meta http-equiv="Pragma" content="no-cache" />
   <style type="text/css">
   body {
-    margin: 0; 
+    margin: 0;
     padding: 0;
     background: #fff;
     font-size: 80%;
   }
   </style>
-</head>
-<body>
-EOF
-        end
-
-        def report_header
-          <<-EOF
-<div class="rspec-report">
   <script type="text/javascript">
     // <![CDATA[
 #{global_scripts}
@@ -151,13 +160,23 @@ EOF
   <style type="text/css">
 #{global_styles}
   </style>
+</head>
+<body>
+EOF
+        end
+
+        def report_header
+          <<-EOF
+<div class="rspec-report">
 
 <div id="rspec-header">
-  <h1>RSpec Results</h1>
+  <div id="label">
+    <h1>RSpec Code Examples</h1>
+  </div>
 
   <div id="summary">
-    <p id="duration">&nbsp;</p>
     <p id="totals">&nbsp;</p>
+    <p id="duration">&nbsp;</p>
   </div>
 </div>
 
@@ -172,28 +191,28 @@ function moveProgressBar(percentDone) {
 }
 function makeRed(element_id) {
   document.getElementById(element_id).style.background = '#C40D0D';
-    document.getElementById(element_id).style.color = '#FFFFFF'; 
+  document.getElementById(element_id).style.color = '#FFFFFF';
+}
+
+function makeYellow(element_id) {
+  if (element_id == "rspec-header" && document.getElementById(element_id).style.background != '#C40D0D')
+  {
+    document.getElementById(element_id).style.background = '#FAF834';
+    document.getElementById(element_id).style.color = '#000000';
   }
-    
-  function makeYellow(element_id) {
-    if (element_id == "rspec-header" && document.getElementById(element_id).style.background != '#C40D0D')
-    {
-      document.getElementById(element_id).style.background = '#FAF834';
-      document.getElementById(element_id).style.color = '#000000'; 
-    }
-    else
-    {
-      document.getElementById(element_id).style.background = '#FAF834';
-      document.getElementById(element_id).style.color = '#000000';
-    }
+  else
+  {
+    document.getElementById(element_id).style.background = '#FAF834';
+    document.getElementById(element_id).style.color = '#000000';
   }
+}
 EOF
         end
         
         def global_styles
           <<-EOF
 #rspec-header {
-  background: #65C400; color: #fff;
+  background: #65C400; color: #fff; height: 4em;
 }
 
 .rspec-report h1 {
@@ -201,15 +220,16 @@ EOF
   padding: 10px;
   font-family: "Lucida Grande", Helvetica, sans-serif;
   font-size: 1.8em;
+  position: absolute;
 }
 
 #summary {
   margin: 0; padding: 5px 10px;
   font-family: "Lucida Grande", Helvetica, sans-serif;
   text-align: right;
-  position: absolute;
   top: 0px;
   right: 0px;
+  float:right;
 }
 
 #summary p {
@@ -220,7 +240,7 @@ EOF
   font-size: 1.2em;
 }
 
-.behaviour {
+.example_group {
   margin: 0 10px 5px;
   background: #fff;
 }
@@ -260,6 +280,12 @@ dd.spec.not_implemented {
   background: #FCFB98; color: #131313;
 }
 
+dd.spec.pending_fixed {
+  border-left: 5px solid #0000C2;
+  border-bottom: 1px solid #0000C2;
+  color: #0000C2; background: #D3FBFF;
+}
+
 .backtrace {
   color: #000;
   font-size: 12px;
@@ -299,10 +325,10 @@ a {
 
 .ruby .offending { background-color: gray; }
 .ruby .linenum {
-	width: 75px;
-	padding: 0.1em 1em 0.2em 0;
-	color: #000000;
-	background-color: #FFFBD3;
+  width: 75px;
+  padding: 0.1em 1em 0.2em 0;
+  color: #000000;
+  background-color: #FFFBD3;
 }
 EOF
         end

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

@@ -0,0 +1,50 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class NestedTextFormatter < BaseTextFormatter
+
+        INDENT = '  '
+
+        def initialize(options, where)
+          super
+          @last_nested_descriptions = []
+        end
+
+        def example_group_started(example_group)
+          super
+
+          example_group.nested_descriptions.each_with_index do |nested_description, i|
+            unless example_group.nested_descriptions[0..i] == @last_nested_descriptions[0..i]
+              output.puts "#{INDENT*i}#{nested_description}"
+            end
+          end
+
+          @last_nested_descriptions = example_group.nested_descriptions
+        end
+
+        def example_failed(example, counter, failure)
+          output.puts(red("#{current_indentation}#{example.description} (FAILED - #{counter})"))
+          output.flush
+        end
+
+        def example_passed(example)
+          message = "#{current_indentation}#{example.description}"
+          output.puts green(message)
+          output.flush
+        end
+
+        def example_pending(example, message, deprecated_pending_location=nil)
+          super
+          output.puts yellow("#{current_indentation}#{example.description} (PENDING: #{message})")
+          output.flush
+        end
+
+        def current_indentation
+          INDENT*@last_nested_descriptions.length
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Spec
+  module Runner
+    module Formatter
+      module NOOPMethodMissing
+        def respond_to?(message, include_private = false)
+          if include_private
+            true
+          else
+            !private_methods.any? {|m| [message.to_s, message.to_sym].include?(m)}
+          end
+        end
+
+      private
+        
+        def method_missing(sym, *args)
+          # a no-op
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+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
+      end
+    end
+  end
+end

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

@@ -1,21 +1,24 @@
+require 'spec/runner/formatter/base_text_formatter'
+require 'spec/runner/formatter/no_op_method_missing'
+
 module Spec
   module Runner
     module Formatter
       class ProgressBarFormatter < BaseTextFormatter
-        def add_behaviour(name)
-        end
-      
-        def example_failed(name, counter, failure)
-          @output.print failure.expectation_not_met? ? red('F') : magenta('F')
+        include NOOPMethodMissing
+
+        def example_failed(example, counter, failure)
+          @output.print colorize_failure('F', failure)
           @output.flush
         end
 
-        def example_passed(name)
+        def example_passed(example)
           @output.print green('.')
           @output.flush
         end
       
-        def example_not_implemented(name)
+        def example_pending(example, message, deprecated_pending_location=nil)
+          super
           @output.print yellow('*')
           @output.flush
         end
@@ -27,4 +30,4 @@ module Spec
       end
     end
   end
-end
+end

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

@@ -0,0 +1,10 @@
+require 'spec/runner/formatter/base_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class SilentFormatter < BaseFormatter
+      end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module Spec
       # 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
+        begin; 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])
@@ -49,4 +49,4 @@ module Spec
       end
     end
   end
-end
+end

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

@@ -1,26 +1,31 @@
+require 'spec/runner/formatter/base_text_formatter'
+
 module Spec
   module Runner
     module Formatter
-      class SpecdocFormatter < BaseTextFormatter      
-        def add_behaviour(name)
-          @output.puts
-          @output.puts name
-          @output.flush
+      class SpecdocFormatter < BaseTextFormatter
+        def example_group_started(example_group)
+          super
+          output.puts
+          output.puts example_group.description
+          output.flush
         end
       
-        def example_failed(name, counter, failure)
-          @output.puts failure.expectation_not_met? ? red("- #{name} (FAILED - #{counter})") : magenta("- #{name} (ERROR - #{counter})")
-          @output.flush
+        def example_failed(example, counter, failure)
+          output.puts(red("- #{example.description} (FAILED - #{counter})"))
+          output.flush
         end
-      
-        def example_passed(name)
-          @output.puts green("- #{name}")
-          @output.flush
+        
+        def example_passed(example)
+          message = "- #{example.description}"
+          output.puts green(message)
+          output.flush
         end
         
-        def example_not_implemented(name)
-          @output.puts yellow("- #{name} (NOT IMPLEMENTED)")
-          @output.flush
+        def example_pending(example, message, deprecated_pending_location=nil)
+          super
+          output.puts yellow("- #{example.description} (PENDING: #{message})")
+          output.flush
         end
       end
     end

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

@@ -0,0 +1,16 @@
+require 'spec/runner/formatter/html_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      # Formats backtraces so they're clickable by TextMate
+      class TextMateFormatter < HtmlFormatter
+        def backtrace_line(line)
+          line.gsub(/([^:]*\.rb):(\d*)/) do
+            "<a href=\"txmt://open?url=file://#{File.expand_path($1)}&line=#{$2}\">#{$1}:#{$2}</a> "
+          end
+        end
+      end
+    end
+  end
+end