dchelimsky-rspec 1.1.10

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

@@ -0,0 +1,79 @@
+module Spec
+  module Runner
+    module Formatter
+      # Baseclass for formatters that implements all required methods as no-ops. 
+      class BaseFormatter
+        attr_accessor :example_group, :options, :where
+        def initialize(options, where)
+          @options = options
+          @where = where
+        end
+        
+        # This method is invoked before any examples are run, right after
+        # they have all been collected. This can be useful for special
+        # 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_example_group
+        def start(example_count)
+        end
+
+        # This method is invoked at the beginning of the execution of each example_group.
+        # +example_group+ is the example_group.
+        #
+        # The next method to be invoked after this is #example_failed or #example_finished
+        def add_example_group(example_group)
+          @example_group = example_group
+        end
+
+        # This method is invoked when an +example+ starts.
+        def example_started(example)
+        end
+
+        # This method is invoked when an +example+ passes.
+        def example_passed(example)
+        end
+
+        # This method is invoked when an +example+ fails, i.e. an exception occurred
+        # inside it (such as a failed should or other exception). +counter+ is the 
+        # sequence number of the failure (starting at 1) and +failure+ is the associated 
+        # Failure object.
+        def example_failed(example, counter, failure)
+        end
+        
+        # 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"
+        # +pending_caller+ is the file and line number of the spec which
+        # has called the pending method
+        def example_pending(example, message, pending_caller)
+        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),
+        def start_dump
+        end
+
+        # Dumps detailed information about an example failure.
+        # 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.
+        def dump_failure(counter, failure)
+        end
+      
+        # This method is invoked after the dumping of examples and failures.
+        def dump_summary(duration, example_count, failure_count, pending_count)
+        end
+        
+        # This gets invoked after the summary if option is set to do so.
+        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
+end

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

@@ -0,0 +1,126 @@
+require 'spec/runner/formatter/base_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      # Baseclass for text-based formatters. Can in fact be used for
+      # non-text based ones too - just ignore the +output+ constructor
+      # argument.
+      class BaseTextFormatter < BaseFormatter
+        attr_reader :output, :pending_examples
+        # Creates a new instance that will write to +where+. If +where+ 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(options, where)
+          super
+          if where.is_a?(String)
+            @output = File.open(where, 'w')
+          else
+            @output = where
+          end
+          @pending_examples = []
+        end
+        
+        def example_pending(example, message, pending_caller)
+          @pending_examples << [example.__full_description, message, pending_caller]
+        end
+        
+        def dump_failure(counter, failure)
+          @output.puts
+          @output.puts "#{counter.to_s})"
+          @output.puts colourise("#{failure.header}\n#{failure.exception.message}", failure)
+          @output.puts format_backtrace(failure.exception.backtrace)
+          @output.flush
+        end
+        
+        def colourise(s, failure)
+          if(failure.expectation_not_met?)
+            red(s)
+          elsif(failure.pending_fixed?)
+            blue(s)
+          else
+            magenta(s)
+          end
+        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 << ", #{pending_count} pending" if pending_count > 0  
+
+          if failure_count == 0
+            if pending_count > 0
+              @output.puts yellow(summary)
+            else
+              @output.puts green(summary)
+            end
+          else
+            @output.puts red(summary)
+          end
+          @output.flush
+        end
+
+        def dump_pending
+          unless @pending_examples.empty?
+            @output.puts
+            @output.puts "Pending:"
+            @pending_examples.each do |pending_example|
+              @output.puts "#{pending_example[0]} (#{pending_example[1]})" 
+              @output.puts "  Called from #{pending_example[2]}"
+            end
+          end
+          @output.flush
+        end
+        
+        def close
+          if IO === @output && @output != $stdout
+            @output.close 
+          end
+        end
+        
+        def format_backtrace(backtrace)
+          return "" if backtrace.nil?
+          backtrace.map { |line| backtrace_line(line) }.join("\n")
+        end
+      
+      protected
+
+        def colour?
+          @options.colour ? true : false
+        end
+
+        def dry_run?
+          @options.dry_run ? true : false
+        end
+        
+        def backtrace_line(line)
+          line.sub(/\A([^:]+:\d+)$/, '\\1:')
+        end
+
+        def colour(text, colour_code)
+          return text unless colour? && output_to_tty?
+          "#{colour_code}#{text}\e[0m"
+        end
+
+        def output_to_tty?
+          begin
+            @output.tty? || ENV.has_key?("AUTOTEST")
+          rescue NoMethodError
+            false
+          end
+        end
+        
+        def green(text); colour(text, "\e[32m"); end
+        def red(text); colour(text, "\e[31m"); end
+        def magenta(text); colour(text, "\e[35m"); end
+        def yellow(text); colour(text, "\e[33m"); end
+        def blue(text); colour(text, "\e[34m"); end
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+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
+            description_parts = @example_group.description_parts.collect do |description|
+              description =~ /(.*) \(druby.*\)$/ ? $1 : description
+            end
+            @output.puts ::Spec::Example::ExampleGroupMethods.description_text(*description_parts)
+
+            @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

@@ -0,0 +1,20 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class FailingExamplesFormatter < BaseTextFormatter      
+        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, pending_count)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,337 @@
+require 'erb'
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class HtmlFormatter < BaseTextFormatter
+        include ERB::Util # for the #h method
+        
+        def initialize(options, output)
+          super
+          @example_group_number = 0
+          @example_number = 0
+        end
+        
+        def method_missing(sym, *args)
+          # no-op
+        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)
+          @example_count = example_count
+
+          @output.puts html_header
+          @output.puts report_header
+          @output.flush
+        end
+
+        def add_example_group(example_group)
+          super
+          @example_group_red = false
+          @example_group_red = false
+          @example_group_number += 1
+          unless example_group_number == 1
+            @output.puts "  </dl>"
+            @output.puts "</div>"
+          end
+          @output.puts "<div class=\"example_group\">"
+          @output.puts "  <dl>"
+          @output.puts "  <dt id=\"example_group_#{example_group_number}\">#{h(example_group.description)}</dt>"
+          @output.flush
+        end
+
+        def start_dump
+          @output.puts "  </dl>"
+          @output.puts "</div>"
+          @output.flush
+        end
+
+        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\">#{h(example.description)}</span></dd>"
+          @output.flush
+        end
+
+        def example_failed(example, counter, failure)
+          extra = extra_failure_content(failure)
+          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 #{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>#{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>"
+          @output.puts "    </dd>"
+          @output.flush
+        end
+
+        def example_pending(example, message, pending_caller)
+          @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\">#{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
+          @output.puts "    <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
+          @output.flush
+        end
+
+        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, 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 << ", #{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>"
+          @output.puts "</div>"
+          @output.puts "</div>"
+          @output.puts "</body>"
+          @output.puts "</html>"
+          @output.flush
+        end
+
+        def html_header 
+          <<-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>RSpec results</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" />
+  <style type="text/css">
+  body {
+    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}
+    // ]]>
+  </script>
+  <style type="text/css">
+#{global_styles}
+  </style>
+
+<div id="rspec-header">
+  <h1>RSpec Results</h1>
+
+  <div id="summary">
+    <p id="totals">&nbsp;</p>
+    <p id="duration">&nbsp;</p>
+  </div>
+</div>
+
+<div class="results">
+EOF
+        end
+
+        def global_scripts
+          <<-EOF
+function moveProgressBar(percentDone) {
+  document.getElementById("rspec-header").style.width = percentDone +"%";
+}
+function makeRed(element_id) {
+  document.getElementById(element_id).style.background = '#C40D0D';
+  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';
+  }
+  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;
+}
+
+.rspec-report h1 {
+  margin: 0px 10px 0px 10px;
+  padding: 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  font-size: 1.8em;
+}
+
+#summary {
+  margin: 0; padding: 5px 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  text-align: right;
+  position: absolute;
+  top: 0px;
+  right: 0px;
+}
+
+#summary p {
+  margin: 0 0 0 2px;
+}
+
+#summary #totals {
+  font-size: 1.2em;
+}
+
+.example_group {
+  margin: 0 10px 5px;
+  background: #fff;
+}
+
+dl {
+  margin: 0; padding: 0 0 5px;
+  font: normal 11px "Lucida Grande", Helvetica, sans-serif;
+}
+
+dt {
+  padding: 3px;
+  background: #65C400;
+  color: #fff;
+  font-weight: bold;
+}
+
+dd {
+  margin: 5px 0 5px 5px;
+  padding: 3px 3px 3px 18px;
+}
+
+dd.spec.passed {
+  border-left: 5px solid #65C400;
+  border-bottom: 1px solid #65C400;
+  background: #DBFFB4; color: #3D7700;
+}
+
+dd.spec.failed {
+  border-left: 5px solid #C20000;
+  border-bottom: 1px solid #C20000;
+  color: #C20000; background: #FFFBD3;
+}
+
+dd.spec.not_implemented {
+  border-left: 5px solid #FAF834;
+  border-bottom: 1px solid #FAF834;
+  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;
+}
+
+a {
+  color: #BE5C00;
+}
+
+/* Ruby code, style similar to vibrant ink */
+.ruby {
+  font-size: 12px;
+  font-family: monospace;
+  color: white;
+  background-color: black;
+  padding: 0.1em 0 0.2em 0;
+}
+
+.ruby .keyword { color: #FF6600; }
+.ruby .constant { color: #339999; }
+.ruby .attribute { color: white; }
+.ruby .global { color: white; }
+.ruby .module { color: white; }
+.ruby .class { color: white; }
+.ruby .string { color: #66FF00; }
+.ruby .ident { color: white; }
+.ruby .method { color: #FFCC00; }
+.ruby .number { color: white; }
+.ruby .char { color: white; }
+.ruby .comment { color: #9933CC; }
+.ruby .symbol { color: white; }
+.ruby .regex { color: #44B4CC; }
+.ruby .punct { color: white; }
+.ruby .escape { color: white; }
+.ruby .interp { color: white; }
+.ruby .expr { color: white; }
+
+.ruby .offending { background-color: gray; }
+.ruby .linenum {
+  width: 75px;
+  padding: 0.1em 1em 0.2em 0;
+  color: #000000;
+  background-color: #FFFBD3;
+}
+EOF
+        end
+      end
+    end
+  end
+end