newbamboo-rspec 1.1.12

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

@@ -0,0 +1,340 @@
+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>
+  <script type="text/javascript">
+    // <![CDATA[
+#{global_scripts}
+    // ]]>
+  </script>
+  <style type="text/css">
+#{global_styles}
+  </style>
+</head>
+<body>
+EOF
+        end
+
+        def report_header
+          <<-EOF
+<div class="rspec-report">
+
+<div id="rspec-header">
+  <div id="label">
+    <h1>RSpec Results</h1>
+  </div>
+
+  <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; height: 42px;
+}
+
+.rspec-report h1 {
+  margin: 0px 10px 0px 10px;
+  padding: 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  font-size: 1.8em;
+  float: left;
+}
+
+#summary {
+  margin: 0; padding: 5px 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  text-align: right;
+  top: 0px;
+  right: 0px;
+  float:right;
+}
+
+#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

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.join}"
+            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__(:example_group_hierarchy).each 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/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

data/lib/spec/runner/heckle_runner.rb

@@ -0,0 +1,74 @@
+unless Spec::Ruby.version.to_f == 1.9
+  begin
+    require 'rubygems'
+    require 'heckle'
+  rescue LoadError ; raise "You must gem install heckle to use --heckle" ; end
+
+  module Spec
+    module Runner
+      # Creates a new Heckler configured to heckle all methods in the classes
+      # whose name matches +filter+
+      class HeckleRunner
+        def initialize(filter, heckle_class=Heckler)
+          @filter = filter
+          @heckle_class = heckle_class
+        end
+      
+        # Runs all the example groups held by +rspec_options+ once for each of the
+        # methods in the matched classes.
+        def heckle_with
+          if @filter =~ /(.*)[#\.](.*)/
+            heckle_method($1, $2)
+          else
+            heckle_class_or_module(@filter)
+          end
+        end
+      
+        def heckle_method(class_name, method_name)
+          verify_constant(class_name)
+          heckle = @heckle_class.new(class_name, method_name, Spec::Runner.options)
+          heckle.validate
+        end
+      
+        def heckle_class_or_module(class_or_module_name)
+          verify_constant(class_or_module_name)
+          pattern = /^#{class_or_module_name}/
+          classes = []
+          ObjectSpace.each_object(Class) do |klass|
+            classes << klass if klass.name =~ pattern
+          end
+        
+          classes.each do |klass|
+            klass.instance_methods(false).each do |method_name|
+              heckle = @heckle_class.new(klass.name, method_name, Spec::Runner.options)
+              heckle.validate
+            end
+          end
+        end
+      
+        def verify_constant(name)
+          begin
+            # This is defined in Heckle
+            name.to_class
+          rescue
+            raise "Heckling failed - \"#{name}\" is not a known class or module"
+          end
+        end
+      end
+    
+      #Supports Heckle 1.2 and prior (earlier versions used Heckle::Base)
+      class Heckler < (Heckle.const_defined?(:Base) ? Heckle::Base : Heckle)
+        def initialize(klass_name, method_name, rspec_options)
+          super(klass_name, method_name)
+          @rspec_options = rspec_options
+        end
+
+        def tests_pass?
+          success = @rspec_options.run_examples
+          success
+        end
+
+      end
+    end
+  end
+end

data/lib/spec/runner/heckle_runner_unsupported.rb

@@ -0,0 +1,10 @@
+module Spec
+  module Runner
+    # Dummy implementation for Windows that just fails (Heckle is not supported on Windows)
+    class HeckleRunner
+      def initialize(filter)
+        raise "Heckle not supported on Windows"
+      end
+    end
+  end
+end