relevance-rcov 0.8.2.1 → 0.8.3.0

data/lib/rcov/formatters/text_coverage_diff.rb

@@ -0,0 +1,199 @@
+module Rcov
+
+  class TextCoverageDiff < BaseFormatter # :nodoc:
+    FORMAT_VERSION = [0, 1, 0]
+    DEFAULT_OPTS = { :textmode => :coverage_diff, :coverage_diff_mode => :record,
+      :coverage_diff_file => "coverage.info", :diff_cmd => "diff", :comments_run_by_default => true }
+    HUNK_HEADER = /@@ -\d+,\d+ \+(\d+),(\d+) @@/
+  
+    def SERIALIZER
+      # mfp> this was going to be YAML but I caught it failing at basic
+      # round-tripping, turning "\n" into "" and corrupting the data, so
+      # it must be Marshal for now
+      Marshal
+    end
+
+    def initialize(opts = {})
+      options = DEFAULT_OPTS.clone.update(opts)
+      @textmode = options[:textmode]
+      @color = options[:color]
+      @mode = options[:coverage_diff_mode]
+      @state_file = options[:coverage_diff_file]
+      @diff_cmd = options[:diff_cmd]
+      @gcc_output = options[:gcc_output]
+      super(options)
+    end
+
+    def execute
+      case @mode
+      when :record
+        record_state
+      when :compare
+        compare_state
+      else
+        raise "Unknown TextCoverageDiff mode: #{mode.inspect}."
+      end
+    end
+
+    def record_state
+      state = {}
+      each_file_pair_sorted do |filename, fileinfo|
+        state[filename] = {:lines    => SCRIPT_LINES__[filename], :coverage => fileinfo.coverage.to_a,:counts   => fileinfo.counts}
+      end
+      File.open(@state_file, "w") do |f|
+        self.SERIALIZER.dump([FORMAT_VERSION, state], f)
+      end
+    rescue
+      $stderr.puts <<-EOF
+      Couldn't save coverage data to #{@state_file}.
+      EOF
+    end                         # '
+
+    require 'tempfile'
+    def compare_state
+      return unless verify_diff_available
+      begin
+        format, prev_state = File.open(@state_file){|f| self.SERIALIZER.load(f) }
+      rescue
+        $stderr.puts <<-EOF
+        Couldn't load coverage data from #{@state_file}.
+        EOF
+        return              # '
+      end
+      if !(Array === format) or
+        FORMAT_VERSION[0] != format[0] || FORMAT_VERSION[1] < format[1]
+        $stderr.puts <<-EOF
+        Couldn't load coverage data from #{@state_file}.
+        The file is saved in the format  #{format.inspect[0..20]}.
+        This rcov executable understands #{FORMAT_VERSION.inspect}.
+        EOF
+        return              # '
+      end
+      each_file_pair_sorted do |filename, fileinfo|
+        old_data = Tempfile.new("#{mangle_filename(filename)}-old")
+        new_data = Tempfile.new("#{mangle_filename(filename)}-new")
+        if prev_state.has_key? filename
+          old_code, old_cov = prev_state[filename].values_at(:lines, :coverage)
+          old_code.each_with_index do |line, i|
+            prefix = old_cov[i] ? "   " : "!! "
+            old_data.write "#{prefix}#{line}"
+          end
+        else
+          old_data.write ""
+        end
+        old_data.close
+        SCRIPT_LINES__[filename].each_with_index do |line, i|
+          prefix = fileinfo.coverage[i] ? "   " : "!! "
+          new_data.write "#{prefix}#{line}"
+        end
+        new_data.close
+
+        diff = `#{@diff_cmd} -u "#{old_data.path}" "#{new_data.path}"`
+        new_uncovered_hunks = process_unified_diff(filename, diff)
+        old_data.close!
+        new_data.close!
+        display_hunks(filename, new_uncovered_hunks)
+      end
+    end
+
+    def display_hunks(filename, hunks)
+      return if hunks.empty?
+      puts
+      puts "=" * 80
+      puts "!!!!! Uncovered code introduced in #{filename}"
+      
+      hunks.each do |offset, lines|
+        if @gcc_output
+          lines.each_with_index do |line,i|
+            lineno = offset + i
+            flag = (/^!! / !~ line) ? "-" : ":"
+            prefix = "#{filename}#{flag}#{lineno}#{flag}"
+            puts "#{prefix}#{line[3..-1]}"
+          end
+        elsif @color
+          puts "### #{filename}:#{offset}"
+          lines.each do |line|
+            prefix = (/^!! / !~ line) ? "\e[32;40m" : "\e[31;40m"
+            puts "#{prefix}#{line[3..-1].chomp}\e[37;40m"
+          end
+        else
+          puts "### #{filename}:#{offset}"
+          puts lines
+        end
+      end
+    end
+
+    def verify_diff_available
+      old_stderr = STDERR.dup
+      old_stdout = STDOUT.dup
+      # TODO: should use /dev/null or NUL(?), but I don't want to add the
+      # win32 check right now
+      new_stderr = Tempfile.new("rcov_check_diff")
+      STDERR.reopen new_stderr.path
+      STDOUT.reopen new_stderr.path
+
+      retval = system "#{@diff_cmd} --version"
+      unless retval
+old_stderr.puts <<EOF
+
+  The '#{@diff_cmd}' executable seems not to be available.
+  You can specify which diff executable should be used with --diff-cmd.
+  If your system doesn't have one, you might want to use Diff::LCS's:
+  gem install diff-lcs
+  and use --diff-cmd=ldiff.
+EOF
+        return false
+      end
+      true
+    ensure
+      STDOUT.reopen old_stdout
+      STDERR.reopen old_stderr
+      new_stderr.close!
+    end
+
+
+    def process_unified_diff(filename, diff)
+      current_hunk = []
+      current_hunk_start = 0
+      keep_current_hunk = false
+      state = :init
+      interesting_hunks = []
+      diff.each_with_index do |line, i|
+        #puts "#{state} %5d #{line}" % i
+        case state
+        when :init
+          if md = HUNK_HEADER.match(line)
+            current_hunk = []
+            current_hunk_start = md[1].to_i
+            state = :body
+          end
+        when :body
+          case line
+          when HUNK_HEADER
+            new_start = $1.to_i
+            if keep_current_hunk
+              interesting_hunks << [current_hunk_start, current_hunk]
+            end
+            current_hunk_start = new_start
+            current_hunk = []
+            keep_current_hunk = false
+          when /^-/
+            # ignore
+          when /^\+!! /
+            keep_current_hunk = true
+            current_hunk << line[1..-1]
+          else
+            current_hunk << line[1..-1]
+          end
+        end
+      end
+      if keep_current_hunk
+        interesting_hunks << [current_hunk_start, current_hunk]
+      end
+
+      interesting_hunks
+    end
+  
+  end
+
+end

data/lib/rcov/formatters/text_report.rb

@@ -0,0 +1,36 @@
+module Rcov
+
+  class TextReport < TextSummary # :nodoc:
+
+    def execute
+      print_lines
+      print_header
+      print_lines
+
+      each_file_pair_sorted do |fname, finfo|
+        name = fname.size < 52 ? fname : "..." + fname[-48..-1]
+        print_info(name, finfo.num_lines, finfo.num_code_lines,
+        finfo.code_coverage)
+      end
+
+      print_lines
+      print_info("Total", num_lines, num_code_lines, code_coverage)
+      print_lines
+      puts summary
+    end
+
+    def print_info(name, lines, loc, coverage)
+      puts "|%-51s | %5d | %5d | %5.1f%% |" % [name, lines, loc, 100 * coverage]
+    end
+
+    def print_lines
+      puts "+----------------------------------------------------+-------+-------+--------+"
+    end
+
+    def print_header
+      puts "|                  File                              | Lines |  LOC  |  COV   |"
+    end
+
+  end
+
+end

data/lib/rcov/formatters/text_summary.rb

@@ -0,0 +1,15 @@
+module Rcov
+
+  class TextSummary < BaseFormatter # :nodoc:
+
+    def execute
+      puts summary
+    end
+
+    def summary
+      "%.1f%%   %d file(s)   %d Lines   %d LOC" % [code_coverage * 100, @files.size, num_lines, num_code_lines]
+    end
+
+  end
+
+end

data/lib/rcov/formatters.rb

@@ -0,0 +1,14 @@
+require 'rcov/formatters/base_formatter'
+require 'rcov/formatters/text_summary'
+require 'rcov/formatters/text_report'
+require 'rcov/formatters/text_coverage_diff'
+require 'rcov/formatters/full_text_report'
+require 'rcov/formatters/html_coverage'
+
+module Rcov
+  
+  module Formatters
+    
+  end
+  
+end

data/lib/rcov/report.rb

@@ -3,69 +3,6 @@
 
 require 'pathname'
 
-
 module Rcov
-
-# Try to fix bugs in the REXML shipped with Ruby 1.8.6
-# They affect Mac OSX 10.5.1 users and motivates endless bug reports.
-begin
-    require 'rexml/formatters/transitive'
-    require 'rexml/formatter/pretty'
-rescue LoadError
-end
-
-require File.expand_path(File.join(File.dirname(__FILE__), 'rexml_extensions' ))
-
-if (RUBY_VERSION == "1.8.6" || RUBY_VERSION == "1.8.7") && defined? REXML::Formatters::Transitive
-    class REXML::Document
-        remove_method :write rescue nil
-        def write( output=$stdout, indent=-1, trans=false, ie_hack=false )
-            if xml_decl.encoding != "UTF-8" && !output.kind_of?(Output)
-                output = Output.new( output, xml_decl.encoding )
-            end
-            formatter = if indent > -1
-                #if trans
-                    REXML::Formatters::Transitive.new( indent )
-                #else
-                #    REXML::Formatters::Pretty.new( indent, ie_hack )
-                #end
-            else
-                REXML::Formatters::Default.new( ie_hack )
-            end
-            formatter.write( self, output )
-        end
-    end
-
-    class REXML::Formatters::Transitive
-        remove_method :write_element rescue nil
-        def write_element( node, output )
-            output << "<#{node.expanded_name}"
-
-            node.attributes.each_attribute do |attr|
-                output << " "
-                attr.write( output )
-            end unless node.attributes.empty?
-
-            if node.children.empty?
-                output << "/>"
-            else
-                output << ">"
-                # If compact and all children are text, and if the formatted output
-                # is less than the specified width, then try to print everything on
-                # one line
-                skip = false
-                @level += @indentation
-                node.children.each { |child|
-                    write( child, output )
-                }
-                @level -= @indentation
-                output << "</#{node.expanded_name}>"
-            end
-            output << "\n"
-            output << ' '*@level
-        end
-    end
     
 end
-    
-end

data/lib/rcov/templates/detail.html.erb

@@ -0,0 +1,102 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <title><%= title %></title>
+    <link href="screen.css" media="screen" rel="stylesheet" type="text/css" />
+    <script type='text/javascript'>
+    // <![CDATA[
+      function toggleCode( id ) {
+        if ( document.getElementById )
+          elem = document.getElementById( id );
+        else if ( document.all )
+          elem = eval( "document.all." + id );
+        else
+          return false;
+
+        elemStyle = elem.style;
+
+        if ( elemStyle.display != "block" ) {
+          elemStyle.display = "block"
+        } else {
+          elemStyle.display = "none"
+        }
+
+        return true;
+      }
+
+      // Make cross-references hidden by default
+      document.writeln( "<style type=\"text/css\">span.cross-ref { display: none }</style>" )
+      // ]]>
+    </script>
+  </head>
+  <body>
+    <h3><%= title %></h3>
+    <p>Generated on <%= generated_on %> with <a href="<%= rcov::UPSTREAM_URL %>">rcov <%= rcov::VERSION %></a></p>
+    <% if output_threshold != 101 %>
+      <!-- Note: 101 is the default threshold if you don't enter one -->
+      <p>Threshold: <%= output_threshold %>%</p>
+    <% end %>
+    <hr />
+      <pre>
+        <span class='marked'>Code reported as executed by Ruby looks like this...</span><span class='marked1'>and this: this line is also marked as covered.</span><span class='inferred'>Lines considered as run by rcov, but not reported by Ruby, look like this,</span><span class='inferred1'>and this: these lines were inferred by rcov (using simple heuristics).</span><span class='uncovered'>Finally, here&apos;s a line marked as not executed.</span>
+      </pre>
+    <table class='report'>
+      <thead>
+        <tr>
+          <td class='heading'>Name</td>
+          <td class='heading'>Total lines</td>
+          <td class='heading'>Lines of code</td>
+          <td class='heading'>Total coverage</td>
+          <td class='heading'>Code coverage</td>
+        </tr>
+      </thead>
+      <tbody>
+        <!-- alternate light/dark here -->
+        <tr class='light'>
+          <td><%= file.name %></td>
+          <td class='lines_total'><tt><%= file.num_lines %></tt></td>
+          <td class='lines_code'><tt><%= file.num_code_lines %></tt></td>
+          <td>
+            <table cellspacing='0' cellpadding='0' align='right'>
+              <tr>
+                <td><tt class='coverage_total'><%= "%3.2f" % file.total_coverage_for_report %>%</tt>&nbsp;</td>
+                <td>
+                  <table cellspacing='0' class='percent_graph' cellpadding='0' width='100'>
+                    <tr>
+                      <td class='covered' width='<%= file.total_coverage_for_report.round %>'></td>
+                      <td class='uncovered' width='<%= 100 - file.total_coverage_for_report.round %>'></td>
+                    </tr>
+                  </table>
+                </td>
+              </tr>
+            </table>
+          </td>
+          <td>
+            <table cellspacing='0' cellpadding='0' align='right'>
+              <tr>
+                <td><tt class='coverage_code'><%= "%3.2f" % file.code_coverage_for_report %>%</tt>&nbsp;</td>
+                <td>
+                  <table cellspacing='0' class='percent_graph' cellpadding='0' width='100'>
+                    <tr>
+                      <td class='covered' width='<%= file.code_coverage_for_report.round %>'/>
+                      <td class='uncovered' width='<%= 100 - file.code_coverage_for_report.round %>'/>
+                    </tr>
+                  </table>
+                </td>
+              </tr>
+            </table>
+          </td>
+        </tr>
+      <% file.num_lines.times do |i| %>
+        <% line = file.lines[i].chomp %>
+        <% count = file.counts[i] %>
+        <tr class="<%= line_css(i) %>">
+          <td colspan="5"><pre><a name="line<%= i.next %>"></a><%= i.next %> <%= line %></pre></td>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+    <hr/>
+    <p>Generated on <%= generated_on %> with <a href="<%= rcov::UPSTREAM_URL %>">rcov <%= rcov::VERSION %></a></p>
+  </body>
+</html>

data/lib/rcov/templates/index.html.erb

@@ -0,0 +1,100 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <title><%= title %></title>
+    <link href="screen.css" media="screen" rel="stylesheet" type="text/css" />
+    <script type='text/javascript'>
+    // <![CDATA[
+      function toggleCode( id ) {
+        if ( document.getElementById )
+          elem = document.getElementById( id );
+        else if ( document.all )
+          elem = eval( "document.all." + id );
+        else
+          return false;
+
+        elemStyle = elem.style;
+
+        if ( elemStyle.display != "block" ) {
+          elemStyle.display = "block"
+        } else {
+          elemStyle.display = "none"
+        }
+
+        return true;
+      }
+
+      // Make cross-references hidden by default
+      document.writeln( "<style type=\"text/css\">span.cross-ref { display: none }</style>" )
+      // ]]>
+    </script>
+  </head>
+  <body>
+    <h3><%= title %></h3>
+    <p>Generated on <%= generated_on %> with <a href="<%= rcov::UPSTREAM_URL %>">rcov <%= rcov::VERSION %></a></p>
+    <% if output_threshold != 101 %>
+      <!-- Note: 101 is the default threshold if you don't enter one -->
+      <p>Threshold: <%= output_threshold %>%</p>
+    <% end %>
+    <hr />
+    <table class='report'>
+      <thead>
+        <tr>
+          <td class='heading'>Name</td>
+          <td class='heading'>Total lines</td>
+          <td class='heading'>Lines of code</td>
+          <td class='heading'>Total coverage</td>
+          <td class='heading'>Code coverage</td>
+        </tr>
+      </thead>
+      <tbody>
+        <% files.each do |f| %>
+          <!-- alternate light/dark here -->
+          <tr class='light'>
+            <td>
+              <% if f.name == 'TOTAL' %>
+                <%= f.name %>
+              <% else %>
+                <a href="<%= relative_filename(f.name) %>"><%= f.name %></a>
+              <% end %>
+            </td>
+            <td class='lines_total'><tt><%= f.num_lines %></tt></td>
+            <td class='lines_code'><tt><%= f.num_code_lines %></tt></td>
+            <td>
+              <table cellspacing='0' cellpadding='0' align='right'>
+                <tr>
+                  <td><tt class='coverage_total'><%= "%3.2f" % f.total_coverage_for_report %>%</tt>&nbsp;</td>
+                  <td>
+                    <table cellspacing='0' class='percent_graph' cellpadding='0' width='100'>
+                      <tr>
+                        <td class='covered' width='<%= f.total_coverage_for_report.round %>'></td>
+                        <td class='uncovered' width='<%= 100 - f.total_coverage_for_report.round %>'></td>
+                      </tr>
+                    </table>
+                  </td>
+                </tr>
+              </table>
+            </td>
+            <td>
+              <table cellspacing='0' cellpadding='0' align='right'>
+                <tr>
+                  <td><tt class='coverage_code'><%= "%3.2f" % f.code_coverage_for_report %>%</tt>&nbsp;</td>
+                  <td>
+                    <table cellspacing='0' class='percent_graph' cellpadding='0' width='100'>
+                      <tr>
+                        <td class='covered' width='<%= f.code_coverage_for_report.round %>'/>
+                        <td class='uncovered' width='<%= 100 - f.code_coverage_for_report.round %>'/>
+                      </tr>
+                    </table>
+                  </td>
+                </tr>
+              </table>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+    <hr/>
+    <p>Generated on <%= generated_on %> with <a href="<%= rcov::UPSTREAM_URL %>">rcov <%= rcov::VERSION %></a></p>
+  </body>
+</html>

data/lib/rcov/templates/screen.css

@@ -0,0 +1,144 @@
+body { background-color: rgb(240, 240, 245); }
+
+span.cross-ref-title {
+    font-size: 140%;
+}
+span.cross-ref a {
+  text-decoration: none;
+}
+span.cross-ref {
+    background-color:#f3f7fa;
+    border: 1px dashed #333;
+    margin: 1em;
+    padding: 0.5em;
+    overflow: hidden;
+}
+a.crossref-toggle {
+  text-decoration: none;
+}
+pre, code {
+  -x-system-font:none;
+  font-family:Monaco,"Courier New",monospace;
+  font-size:65%;
+  font-size-adjust:none;
+  font-stretch:normal;
+  font-style:normal;
+  font-variant:normal;
+  font-weight:normal;
+}
+
+tr.marked td, span.marked {
+  background-color: rgb(185, 210, 200);
+}
+span.marked1 {
+  background-color: rgb(190, 215, 205);
+  display: block;
+}
+tr.inferred td, span.inferred {
+  background-color: rgb(255, 255, 240);
+}
+span.inferred1 {
+  background-color: rgb(255, 255, 240);
+  display: block;
+}
+tr.uncovered td, span.uncovered {
+  background-color: rgb(225, 110, 110);
+}
+span.uncovered1 {
+  background-color: rgb(235, 120, 120);
+  display: block;
+}
+span.overview {
+  border-bottom: 8px solid black;
+}
+div.overview {
+  border-bottom: 8px solid black;
+}
+body {
+    font-family: verdana, arial, helvetica;
+}
+
+div.footer {
+    font-size: 68%;
+    margin-top: 1.5em;
+}
+
+h1, h2, h3, h4, h5, h6 {
+    margin-bottom: 0.5em;
+}
+
+h5 {
+    margin-top: 0.5em;
+}
+
+.hidden {
+    display: none;
+}
+
+div.separator {
+    height: 10px;
+}
+/* Commented out for better readability, esp. on IE */
+/*
+table tr td, table tr th {
+    font-size: 68%;
+}
+
+td.value table tr td {
+    font-size: 11px;
+}
+*/
+
+table.percent_graph {
+    height: 12px;
+    border: #808080 1px solid;
+    empty-cells: show;
+}
+
+table.percent_graph td.covered {
+    height: 10px;
+    background: #00f000;
+}
+
+table.percent_graph td.uncovered {
+    height: 10px;
+    background: #e00000;
+}
+
+table.percent_graph td.NA {
+    height: 10px;
+    background: #eaeaea;
+}
+
+table.report {
+    border-collapse: collapse;
+    width: 100%;
+}
+
+table.report td.heading {
+    background: #dcecff;
+    border: #d0d0d0 1px solid;
+    font-weight: bold;
+    text-align: center;
+}
+
+table.report td.heading:hover {
+    background: #c0ffc0;
+}
+
+table.report td.text {
+    border: #d0d0d0 1px solid;
+}
+
+table.report td.value,
+table.report td.lines_total,
+table.report td.lines_code {
+    text-align: right;
+    border: #d0d0d0 1px solid;
+}
+table.report tr.light {
+    background-color: rgb(240, 240, 245);
+}
+table.report tr.dark {
+    background-color: rgb(230, 230, 235);
+}

data/lib/rcov/version.rb

@@ -3,9 +3,10 @@
 # See LEGAL and LICENSE for licensing information.
 
 module Rcov
-  VERSION = "0.8.2.1"
-  RELEASE_DATE = "2009-03-17"
+  VERSION = "0.8.3.0"
+  RELEASE_DATE = "2009-05-08"
   RCOVRT_ABI = [2,0,0]
-  UPSTREAM_URL = "http://github.com/spicycode/rcov"
+  UPSTREAM_URL = "http://github.com/relevance/rcov"
+  ROOF_POSITION = 'raised'
 
 end