rcov 0.7.0.1 → 0.8.0.0

data/BLURB

@@ -2,7 +2,7 @@
 Source code, additional information, screenshots... available at 
     http://eigenclass.org/hiki.rb?rcov
 Release information:
-    http://eigenclass.org/hiki.rb?rcov+0.7.0
+    http://eigenclass.org/hiki.rb?rcov+0.8.0
 
 If you're on win32, you can also find a pre-built rcovrt.so (which makes
 code coverage analysis >100 times faster) in the above-mentioned pages.

data/CHANGES

@@ -1,6 +1,29 @@
 
 User-visible changes.
 
+Since 0.7.0 (2006-08-04)
+========================
+Features
+--------
+* --annotate mode, which dumps annotated source code which can be used to
+  follow the control flow (very useful when reading third-party code)
+* --gcc option to display uncovered lines in GCC error format
+* superior Emacs support: running rcov, jumping to uncovered code, navigate
+  through cross-referenced annotated code
+* --[no-]validator-links
+
+Bugfixes
+--------
+* differential code coverage reports work with filenames containing special
+  characters
+* fixed recent segfaults happening with rspec
+* more care name mangling
+
+Minor enhancements
+------------------
+* relevant summary values are identified using separate CSS classes 
+  (microformat-style)
+
 Since 0.6.0 (2006-06-12)
 ========================
 Features

data/README.emacs

@@ -0,0 +1,64 @@
+
+<tt>rcov.el</tt> allows you to use rcov from Emacs conveniently.
+* Run unit tests and jump to uncovered code by <tt>C-x `</tt>.
+* Run unit tests and save the current coverage status.
+* Run unit tests and jump to uncovered code introduced since the last run.
+* View cross-reference annotated code.
+
+== Installation
+
+Copy <tt>rcov.el</tt> to the appropriate directory, which is in load-path.
+Then require it.
+  (require 'rcov)
+
+
+== Usage
+
+There are some commands to run rcov in Emacs.
+All of them displays +rcov+ window, whose major-mode is compilation-mode.
+Therefore you can jump to uncovered code by <tt>C-x `</tt>.
+
++rcov-command-line+, +rcovsave-command-line+, and +rcovdiff-command-line+ define
+command line to run rcov.
+If you do not use +rcov+ from Rake, you must modify them.
+
+=== Finding uncovered code
+
+Type the following while editing your program:
+  M-x rcov
+  
+=== Setting the reference point
+
++rcov+'s <tt>--text-coverage-diff</tt> mode compares the current coverage status against
+the saved one. It therefore needs that information to be recorded
+before you write new code (typically right after you perform a commit) in
+order to have something to compare against.
+
+You can save the current status with the <tt>--save</tt> option.
+
+Type the following to save the current status in Emacs:
+  M-x rcovsave
+If you do not use +rcov+ from Rake, you must modify +rcovsave-command-line+ variable.
+
+=== Finding new uncovered code
+
+Type the following to save the current status in Emacs:
+  M-x rcovdiff
+
+=== Viewing cross-reference annotated code
+
+If you read cross-reference annotated code, issue
+  rake rcov RCOVOPTS='-a'
+at the beginning.
+This command creates +coverage+ directory and many *.rb files in it.
+Filenames of these Ruby scripts are converted from original path.
+You can browse them by normally <tt>C-x C-f</tt>.
+You can think of <tt>-a</tt> option as <tt>--xrefs</tt> option and output format is Ruby script.
+
+After find-file-ed annotated script, the major-mode is rcov-xref-mode,
+which is derived from ruby-mode and specializes navigation.
+
+<tt>Tab</tt> and <tt>M-Tab</tt> goes forward/backward links.
+<tt>Ret</tt> follows selected link.
+
+This feature is useful to read third-party code or to follow control flow.

data/Rakefile

@@ -60,11 +60,16 @@ Rake::TestTask.new(:test_pure_ruby) do |t|
   t.verbose = true
 end
 
-desc "Run the unit tests, both rcovrt and pure-Ruby modes"
-task :test => [:test_rcovrt, :test_pure_ruby]
+desc "Run the unit tests"
+task :test => [:test_rcovrt]
 
 task :default => :test
 
+desc "install by setup.rb"
+task :install do
+  sh "sudo ruby setup.rb install"
+end
+
 desc "Generate rdoc documentation for the rcov library"
 Rake::RDocTask.new("rdoc") { |rdoc|
   rdoc.rdoc_dir = 'doc'
@@ -82,7 +87,7 @@ Rake::RDocTask.new("rdoc") { |rdoc|
 
 require 'rcov/version'
 
-PKG_REVISION = ".1"
+PKG_REVISION = ".0"
 PKG_FILES = FileList[
 "bin/rcov",
 "lib/**/*.rb",
@@ -90,7 +95,7 @@ PKG_FILES = FileList[
 "ext/rcovrt/*.c",
 "ext/rcovrt/*.h",
 "LEGAL", "LICENSE", "Rakefile", "Rantfile", "README.*", "THANKS", "test/*.rb",
-"mingw-rbconfig.rb", "rcov.vim",
+"mingw-rbconfig.rb", "rcov.vim", "rcov.el",
 "setup.rb", "BLURB", "CHANGES"
 ]
 

data/THANKS

@@ -44,9 +44,25 @@ Tim Shadel:
 
 Thomas Leitner:
 * reported that the SCRIPT_LINES__ workaround did not always work
+* fixed the bug which broke differential reports for filenames with
+  special characters
 
 Assaph Mehr:
 * beta-tested 0.7.0 and found a bug in --aggregate (missing files)
 
 Ryan Kinderman:
 * suggested that -Ipath be passed to ruby instead of rcov in RcovTasks
+
+Jan Svitok:
+* reported typo in rcovtask.rb's RDoc
+
+rubikitch:
+* implemented --annotate mode
+* implemented --gcc option
+* superior emacs support
+* testing, refactoring...
+* many other things, see darcs changes
+
+
+Zed A. Shaw:
+* reported and fixed segfault triggered by rspec

data/bin/rcov

@@ -1,4 +1,4 @@
-#! /home/batsman/usr/bin/ruby
+#!/usr/bin/env ruby
 # rcov Copyright (c) 2004-2006 Mauricio Fernandez <mfp@acm.org>
 #
 # rcov originally based on 
@@ -57,6 +57,8 @@ options.coverage_diff_save = false
 options.diff_cmd = "diff"
 options.report_cov_bug_for = nil
 options.aggregate_file = nil
+options.gcc_output = false
+options.show_validator_links = true
 
 EXTRA_HELP = <<-EOF
 
@@ -152,6 +154,15 @@ EOF
             "Color scale range for profiling info (dB).") do |val|
         options.range = val
     end
+    opts.on("-a", "--annotate",
+            "Generate annotated source code.") do
+        options.html = false
+        options.textmode = :annotate
+        options.crossrefs = true
+        options.callsites = true
+        options.skip = [ %r!/test/unit/! ]
+    end
+
     opts.on("-T", "--text-report", "Dump detailed plain-text report to stdout.",
             "(filename, LoC, total lines, coverage)") do
         options.textmode = :report
@@ -166,6 +177,9 @@ EOF
             "ANSI color sequences unless -n.") do
         options.textmode = :coverage
     end
+    opts.on("--gcc", "Dump uncovered line in GCC error format.") do
+        options.gcc_output = true
+    end
     opts.on("--aggregate FILE", "Aggregate data from previous runs",
                                 "in FILE. Overwrites FILE with the",
                                 "merged data. FILE is created if",
@@ -216,6 +230,10 @@ EOF
         end
         options.output_threshold = threshold
     end
+    opts.on("--[no-]validator-links", "Add link to W3C's validation services.",
+           "(default: true)") do |show_validator_links|
+        options.show_validator_links = show_validator_links
+    end
     opts.on("--only-uncovered", "Same as --threshold 100") do
         options.output_threshold = 100
     end
@@ -296,6 +314,7 @@ options.loadpaths.reverse_each{|x| $:.unshift x}
 require 'rcov'
 
 options.callsites = true if options.report_cov_bug_for
+options.textmode = :gcc if !options.textmode and options.gcc_output
 
 def rcov_load_aggregate_data(file)
     require 'zlib'
@@ -344,7 +363,9 @@ make_formatter = lambda do |klass|
               :callsites => options.callsites, 
               :cross_references => options.crossrefs,
               :diff_cmd => options.diff_cmd,
-              :comments_run_by_default => options.comments_run_by_default
+              :comments_run_by_default => options.comments_run_by_default,
+              :gcc_output => options.gcc_output,
+              :validator_links => options.show_validator_links
              )
 end
 
@@ -357,6 +378,8 @@ if options.html
 end
 textual_formatters = {:counts => Rcov::FullTextReport, 
                       :coverage => Rcov::FullTextReport,
+                      :gcc => Rcov::FullTextReport,
+                      :annotate => Rcov::RubyAnnotation,
                       :summary => Rcov::TextSummary, :report => Rcov::TextReport,
                       :coverage_diff => Rcov::TextCoverageDiff}
 
@@ -1258,3 +1281,7 @@ if __FILE__ == $0
 
 end
 # vi: set sw=4: 
+# Here is Emacs setting. DO NOT REMOVE!
+# Local Variables:
+# ruby-indent-level: 4
+# End:

data/ext/rcovrt/rcovrt.c

@@ -4,6 +4,7 @@
 #include <node.h>
 #include <st.h>
 #include <stdlib.h>
+#include <assert.h>
 
 #define COVERAGE_DEBUG_EVENTS 0
 
@@ -34,12 +35,15 @@ static char *cached_file = 0;
  * */
 
 static struct cov_array *
-coverage_increase_counter_uncached(char *sourcefile, int sourceline,
+coverage_increase_counter_uncached(char *sourcefile, unsigned int sourceline,
                                    char mark_only)
 {
-  struct cov_array *carray;
-  
-  if(!st_lookup(coverinfo, (st_data_t)sourcefile, (st_data_t*)&carray)) {
+  struct cov_array *carray = NULL;
+ 
+  if(sourcefile == NULL) {
+          /* "can't happen", just ignore and avoid segfault */
+          return NULL;
+  } else if(!st_lookup(coverinfo, (st_data_t)sourcefile, (st_data_t*)&carray)) {
           VALUE arr;
 
           arr = rb_hash_aref(oSCRIPT_LINES__, rb_str_new2(sourcefile));
@@ -51,7 +55,11 @@ coverage_increase_counter_uncached(char *sourcefile, int sourceline,
           carray->len = RARRAY(arr)->len;
           st_insert(coverinfo, (st_data_t)strdup(sourcefile), 
                           (st_data_t) carray);
+  } else {
+          /* recovered carray, sanity check */
+          assert(carray && "failed to create valid carray");
   }
+
   if(mark_only) {
           if(!carray->ptr[sourceline])
                   carray->ptr[sourceline] = 1;
@@ -74,7 +82,9 @@ coverage_mark_caller()
   }
   for (; frame && (n = frame->node); frame = frame->prev) {
           if (frame->prev && frame->prev->last_func) {
-                  if (frame->prev->node == n) continue;
+                  if (frame->prev->node == n) {
+                          if (frame->prev->last_func == frame->last_func) continue;
+                  }
                   coverage_increase_counter_uncached(n->nd_file, nd_line(n) - 1, 1);
           }
           else {

data/lib/rcov/rcovtask.rb

@@ -42,7 +42,7 @@ module Rcov
   #
   class RcovTask < Rake::TaskLib
 
-    # Name of test task. (default is :test)
+    # Name of test task. (default is :rcov)
     attr_accessor :name
 
     # List of directories to added to $LOAD_PATH before running the

data/lib/rcov/report.rb

@@ -1,6 +1,7 @@
 # rcov Copyright (c) 2004-2006 Mauricio Fernandez <mfp@acm.org>
 # See LEGAL and LICENSE for additional licensing information.
 
+require 'pathname'
 module Rcov
 
 class Formatter # :nodoc:
@@ -30,6 +31,10 @@ class Formatter # :nodoc:
         @callsite_analyzer = options[:callsite_analyzer]
         @comments_run_by_default = options[:comments_run_by_default]
         @callsite_index = nil
+
+        @mangle_filename = Hash.new{|h,base|
+            h[base] = Pathname(base).cleanpath.to_s.gsub(%r{^\w:[/\\]}, "").gsub(/\./, "_").gsub(/[\\\/]/, "-") + ".html"
+        }
     end
 
     def add_file(filename, lines, coverage, counts)
@@ -53,7 +58,7 @@ class Formatter # :nodoc:
     end
 
     def mangle_filename(base)
-        base.gsub(%r{^\w:[/\\]}, "").gsub(/\./, "_").gsub(/[\\\/]/, "-") + ".html"
+        @mangle_filename[base]
     end
 
     def each_file_pair_sorted(&b)
@@ -142,6 +147,29 @@ class Formatter # :nodoc:
         end
         index
     end
+
+    class XRefHelper < Struct.new(:file, :line, :klass, :mid, :count) # :nodoc:
+    end
+
+    def _get_defsites(ref_blocks, filename, lineno, linetext, label, &format_call_ref)
+        if @do_cross_references and 
+           (rev_xref = reverse_cross_references_for(filename, lineno))
+            refs = rev_xref.map do |classname, methodname, defsite, count|
+                XRefHelper.new(defsite.file, defsite.line, classname, methodname, count)
+            end.sort_by{|r| r.count}.reverse
+            ref_blocks << [refs, label, format_call_ref]
+        end
+    end
+
+    def _get_callsites(ref_blocks, filename, lineno, linetext, label, &format_called_ref)
+        if @do_callsites and
+           (refs = cross_references_for(filename, lineno))
+            refs = refs.sort_by{|k,count| count}.map do |ref, count|
+                XRefHelper.new(ref.file, ref.line, ref.calling_class, ref.calling_method, count)
+            end.reverse
+            ref_blocks << [refs, label, format_called_ref]
+        end
+    end
 end
 
 class TextSummary < Formatter # :nodoc:
@@ -202,6 +230,8 @@ class FullTextReport < Formatter # :nodoc:
                 case @textmode
                 when :counts
                     puts "%-70s| %6d" % [line.chomp[0,70], fileinfo.counts[i]]
+                when :gcc
+                    puts "%s:%d:%s" % [filename, i+1, line.chomp] unless fileinfo.coverage[i]
                 when :coverage
                     if @color
                         prefix = fileinfo.coverage[i] ? "\e[32;40m" : "\e[31;40m"
@@ -236,7 +266,8 @@ class TextCoverageDiff < Formatter # :nodoc:
         @mode = options[:coverage_diff_mode]
         @state_file = options[:coverage_diff_file]
         @diff_cmd = options[:diff_cmd]
-        super(options)
+        @gcc_output = options[:gcc_output]
+       super(options)
     end
 
     def execute
@@ -264,7 +295,7 @@ class TextCoverageDiff < Formatter # :nodoc:
         $stderr.puts <<-EOF
 Couldn't save coverage data to #{@state_file}.
 EOF
-    end
+    end                         # '
 
     require 'tempfile'
     def compare_state
@@ -275,7 +306,7 @@ EOF
             $stderr.puts <<-EOF
 Couldn't load coverage data from #{@state_file}.
 EOF
-            return
+            return              # '
         end
         if !(Array === format) or
             FORMAT_VERSION[0] != format[0] || FORMAT_VERSION[1] < format[1]
@@ -284,7 +315,7 @@ 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
+            return              # '
         end
         each_file_pair_sorted do |filename, fileinfo|
             old_data = Tempfile.new("#{mangle_filename(filename)}-old")
@@ -305,7 +336,7 @@ EOF
             end
             new_data.close
 
-            diff = `#{@diff_cmd} -u #{old_data.path} #{new_data.path}`
+            diff = `#{@diff_cmd} -u "#{old_data.path}" "#{new_data.path}"`
             new_uncovered_hunks = process_unified_diff(filename, diff)
             old_data.close!
             new_data.close!
@@ -322,13 +353,21 @@ EOF
 
 EOF
         hunks.each do |offset, lines|
-            puts "### #{filename}:#{offset}"
-            if @color
+            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
@@ -561,7 +600,9 @@ table.report td.text {
     border: #d0d0d0 1px solid;
 }
 
-table.report td.value {
+table.report td.value,
+table.report td.lines_total,
+table.report td.lines_code {
     text-align: right;
     border: #d0d0d0 1px solid;
 }
@@ -574,7 +615,9 @@ table.report tr.dark {
 EOS
 
     DEFAULT_OPTS = {:color => false, :fsr => 30, :destdir => "coverage",
-                    :callsites => false, :cross_references => false}
+                    :callsites => false, :cross_references => false,
+                    :validator_links => true 
+                   }
     def initialize(opts = {})
         options = DEFAULT_OPTS.clone.update(opts)
         super(options)
@@ -584,6 +627,7 @@ EOS
         @do_callsites = options[:callsites]
         @do_cross_references = options[:cross_references]
         @span_class_index = 0
+        @show_validator_links = options[:validator_links]
     end
 
     def execute
@@ -647,16 +691,18 @@ EOS
                                     a_(:href => mangle_filename(f.name)){ t_ { f.name } } 
                                 end
                             }
-                            [f.num_lines, f.num_code_lines].each do |value| 
-                                td_(:class => "value") { tt_{ value } }
+                            [[f.num_lines, "lines_total"], 
+                             [f.num_code_lines, "lines_code"]].each do |value, css_class| 
+                                td_(:class => css_class) { tt_{ value } }
                             end
-                            [f.total_coverage, f.code_coverage].each do |value|
+                            [[f.total_coverage, "coverage_total"],
+                             [f.code_coverage, "coverage_code"]].each do |value, css_class|
                                 value *= 100
                                 td_ { 
                                     table_(:cellpadding => 0, :cellspacing => 0, :align => "right") { 
                                         tr_ { 
                                             td_ {
-                                                 tt_ { "%3.1f%%" % value } 
+                                                 tt_(:class => css_class) { "%3.1f%%" % value } 
                                                  x_ "&nbsp;"
                                             }
                                             ivalue = value.round
@@ -712,17 +758,20 @@ EOS
                 x_{ format_overview(*files) }
                 hr_
                 x_{ blurb }
-                p_ {
-                    a_(:href => "http://validator.w3.org/check/referer") {
-                    img_(:src => "http://www.w3.org/Icons/valid-xhtml11",
-                         :alt => "Valid XHTML 1.1!", :height => 31, :width => 88)
-                    }
-                    a_(:href => "http://jigsaw.w3.org/css-validator/check/referer") {
-                        img_(:style => "border:0;width:88px;height:31px",
-                             :src => "http://jigsaw.w3.org/css-validator/images/vcss",
-                             :alt => "Valid CSS!")
+
+                if @show_validator_links
+                    p_ {
+                        a_(:href => "http://validator.w3.org/check/referer") {
+                            img_(:src => "http://www.w3.org/Icons/valid-xhtml11",
+                                 :alt => "Valid XHTML 1.1!", :height => 31, :width => 88)
+                        }
+                        a_(:href => "http://jigsaw.w3.org/css-validator/check/referer") {
+                            img_(:style => "border:0;width:88px;height:31px",
+                                 :src => "http://jigsaw.w3.org/css-validator/images/vcss",
+                                 :alt => "Valid CSS!")
+                        }
                     }
-                }
+                end
             }
         } }
         lines = output.pretty.to_a
@@ -760,41 +809,23 @@ EOS
         "<pre>#{result}</pre>"
     end
 
-    class XRefHelper < Struct.new(:file, :line, :klass, :mid, :count) # :nodoc:
-    end
-
     def create_cross_refs(filename, lineno, linetext)
         return linetext unless @callsite_analyzer && @do_callsites
-        ret = ""
         ref_blocks = []
-        if @do_cross_references and 
-           (rev_xref = reverse_cross_references_for(filename, lineno))
-            refs = rev_xref.map do |classname, methodname, defsite, count|
-                XRefHelper.new(defsite.file, defsite.line, classname, methodname, count)
-            end.sort_by{|r| r.count}.reverse
-            format_call_ref = lambda do |ref|
-                if ref.file
-                    where = "at #{normalize_filename(ref.file)}:#{ref.line}"
-                else
-                    where = "(C extension/core)"
-                end
-                CGI.escapeHTML("%7d   %s" % 
-                               [ref.count, "#{ref.klass}##{ref.mid} " + where])
+        _get_defsites(ref_blocks, filename, lineno, "Calls", linetext) do |ref|
+            if ref.file
+                where = "at #{normalize_filename(ref.file)}:#{ref.line}"
+            else
+                where = "(C extension/core)"
             end
-            ref_blocks << [refs, "Calls", format_call_ref]
+            CGI.escapeHTML("%7d   %s" % 
+                               [ref.count, "#{ref.klass}##{ref.mid} " + where])
         end
-        if @do_callsites and
-           (refs = cross_references_for(filename, lineno))
-            refs = refs.sort_by{|k,count| count}.map do |ref, count|
-                XRefHelper.new(ref.file, ref.line, ref.calling_class, ref.calling_method, count)
-            end.reverse
-            format_called_ref = lambda do |ref|
-                r = "%7d   %s" % [ref.count, 
-                    "#{normalize_filename(ref.file||'C code')}:#{ref.line} " +
+        _get_callsites(ref_blocks, filename, lineno, "Called by", linetext) do |ref|
+            r = "%7d   %s" % [ref.count, 
+                "#{normalize_filename(ref.file||'C code')}:#{ref.line} " +
                     "in '#{ref.klass}##{ref.mid}'"]
-                CGI.escapeHTML(r)
-            end
-            ref_blocks << [refs, "Called by", format_called_ref]
+            CGI.escapeHTML(r)
         end
         
         create_cross_reference_block(linetext, ref_blocks)
@@ -874,17 +905,20 @@ EOS
                 x_{ body }
                 hr_
                 x_ { blurb }
-                p_ {
-                    a_(:href => "http://validator.w3.org/check/referer") {
-                    img_(:src => "http://www.w3.org/Icons/valid-xhtml10",
-                         :alt => "Valid XHTML 1.0!", :height => 31, :width => 88)
-                    }
-                    a_(:href => "http://jigsaw.w3.org/css-validator/check/referer") {
-                        img_(:style => "border:0;width:88px;height:31px",
-                             :src => "http://jigsaw.w3.org/css-validator/images/vcss",
-                             :alt => "Valid CSS!")
+
+                if @show_validator_links
+                    p_ {
+                        a_(:href => "http://validator.w3.org/check/referer") {
+                            img_(:src => "http://www.w3.org/Icons/valid-xhtml10",
+                                 :alt => "Valid XHTML 1.0!", :height => 31, :width => 88)
+                        }
+                        a_(:href => "http://jigsaw.w3.org/css-validator/check/referer") {
+                            img_(:style => "border:0;width:88px;height:31px",
+                                 :src => "http://jigsaw.w3.org/css-validator/images/vcss",
+                                 :alt => "Valid CSS!")
+                        }
                     }
-                }
+                end
             }
         } }
         # .pretty needed to make sure DOCTYPE is in a separate line
@@ -1006,6 +1040,119 @@ class HTMLProfiling < HTMLCoverage # :nodoc:
     end
 end
 
+class RubyAnnotation < Formatter # :nodoc:
+    DEFAULT_OPTS = { :destdir => "coverage" }
+    def initialize(opts = {})
+        options = DEFAULT_OPTS.clone.update(opts)
+        super(options)
+        @dest = options[:destdir]
+        @do_callsites = true
+        @do_cross_references = true
+
+        @mangle_filename = Hash.new{|h,base|
+            h[base] = Pathname(base).cleanpath.to_s.gsub(%r{^\w:[/\\]}, "").gsub(/\./, "_").gsub(/[\\\/]/, "-") + ".rb"
+        }
+    end
+
+    def execute
+        return if @files.empty?
+        FileUtils.mkdir_p @dest
+        each_file_pair_sorted do |filename, fileinfo|
+            create_file(File.join(@dest, mangle_filename(filename)), fileinfo)
+        end
+    end
+
+    private
+
+    def format_lines(file)
+        result = ""
+        format_line = "%#{file.num_lines.to_s.size}d"
+        file.num_lines.times do |i|
+            line = file.lines[i].chomp
+            marked = file.coverage[i]
+            count = file.counts[i]
+            result << create_cross_refs(file.name, i+1, line, marked) + "\n"
+        end
+        result
+    end
+
+    def create_cross_refs(filename, lineno, linetext, marked)
+        return linetext unless @callsite_analyzer && @do_callsites
+        ref_blocks = []
+        _get_defsites(ref_blocks, filename, lineno, linetext, ">>") do |ref|
+            ref.file.sub!(%r!^./!, '')
+            if ref.file
+                where = "at #{mangle_filename(ref.file)}:#{ref.line}"
+            else
+                where = "(C extension/core)"
+            end
+            "#{ref.klass}##{ref.mid} " + where + ""
+        end
+        _get_callsites(ref_blocks, filename, lineno, linetext, "<<") do |ref| # "
+            ref.file.sub!(%r!^./!, '')
+            "#{mangle_filename(ref.file||'C code')}:#{ref.line} " +
+                "in #{ref.klass}##{ref.mid}"
+        end
+        
+        create_cross_reference_block(linetext, ref_blocks, marked)
+    end
+
+    def create_cross_reference_block(linetext, ref_blocks, marked)
+        codelen = 75
+        if ref_blocks.empty?
+            if marked
+                return "%-#{codelen}s #o" % linetext
+            else
+                return linetext
+            end
+        end
+        ret = ""
+        @cross_ref_idx ||= 0
+        @known_files ||= sorted_file_pairs.map{|fname, finfo| normalize_filename(fname)}
+        ret << "%-#{codelen}s # " % linetext
+        ref_blocks.each do |refs, toplabel, label_proc|
+            unless !toplabel || toplabel.empty?
+                ret << toplabel << " "
+            end
+            refs.each do |dst|
+                dstfile = normalize_filename(dst.file) if dst.file
+                dstline = dst.line
+                label = label_proc.call(dst)
+                if dst.file && @known_files.include?(dstfile)
+                    ret << "[[" << label << "]], "
+                else
+                    ret << label << ", "
+                end
+            end
+        end
+        
+        ret
+    end
+    
+    def create_file(destfile, fileinfo)
+        #$stderr.puts "Generating #{destfile.inspect}"
+        body = format_lines(fileinfo)
+        File.open(destfile, "w") do |f|
+            f.puts body
+            f.puts footer(fileinfo)
+        end
+    end
+
+    def footer(fileinfo)
+        s  = "# Total lines    : %d\n" % fileinfo.num_lines
+        s << "# Lines of code  : %d\n" % fileinfo.num_code_lines
+        s << "# Total coverage : %3.1f%%\n" % [ fileinfo.total_coverage*100 ]
+        s << "# Code coverage  : %3.1f%%\n\n" % [ fileinfo.code_coverage*100 ]
+        # prevents false positives on Emacs
+        s << "# Local " "Variables:\n" "# mode: " "rcov-xref\n" "# End:\n"
+    end
+end
+
+
 end # Rcov
 
 # vi: set sw=4:
+# Here is Emacs setting. DO NOT REMOVE!
+# Local Variables:
+# ruby-indent-level: 4
+# End:

data/lib/rcov/version.rb

@@ -4,8 +4,8 @@
 
 module Rcov
 
-VERSION = "0.7.0"
-RELEASE_DATE = "2006/08/04"
+VERSION = "0.8.0"
+RELEASE_DATE = "2007-02-28"
 RCOVRT_ABI = [2,0,0]
 UPSTREAM_URL = "http://eigenclass.org/hiki.rb?rcov"
 

data/rcov.el

@@ -0,0 +1,131 @@
+;;; rcov.el -- Ruby Coverage Analysis Tool
+
+;;; Copyright (c) 2006 rubikitch <rubikitch@ruby-lang.org>
+;;;
+;;; Use and distribution subject to the terms of the rcov license.
+
+(defvar rcov-xref-before-visit-source-hook nil
+  "Hook executed before jump.")
+(defvar rcov-xref-after-visit-source-hook nil
+  "Hook executed after jump.")
+(defvar rcov-command-line "rake rcov RCOVOPTS='--gcc --no-html'"
+  "Rcov command line to find uncovered code.
+It is good to use rcov with Rake because it `cd's appropriate directory.
+`--gcc' option is strongly recommended because `rcov' uses compilation-mode.")
+(defvar rcovsave-command-line "rake rcov RCOVOPTS='--gcc --no-html --save=coverage.info'"
+  "Rcov command line to save coverage status. See also `rcov-command-line'.")
+(defvar rcovdiff-command-line "rake rcov RCOVOPTS='-D --gcc --no-html'"
+  "Rcov command line to find new uncovered code. See also `rcov-command-line'.")
+
+;;;; rcov-xref-mode
+(define-derived-mode rcov-xref-mode ruby-mode "Rxref"
+  "Major mode for annotated Ruby scripts (coverage/*.rb) by rcov."
+  (setq truncate-lines t)
+  ;; ruby-electric-mode / pabbrev-mode hijacks TAB binding.
+  (and ruby-electric-mode (ruby-electric-mode -1))
+  (and (boundp 'pabbrev-mode) pabbrev-mode (pabbrev-mode -1))
+  (suppress-keymap rcov-xref-mode-map)
+  (define-key rcov-xref-mode-map "\C-i" 'rcov-xref-next-tag)
+  (define-key rcov-xref-mode-map "\M-\C-i" 'rcov-xref-previous-tag)
+  (define-key rcov-xref-mode-map "\C-m" 'rcov-xref-visit-source)
+  (set (make-local-variable 'automatic-hscrolling) nil)
+  )
+  
+(defvar rcov-xref-tag-regexp "\\[\\[\\(.*?\\)\\]\\]")
+
+(defun rcov-xref-next-tag (n)
+  "Go to next LINK."
+  (interactive "p")
+  (when (looking-at rcov-xref-tag-regexp)
+    (goto-char (match-end 0)))
+  (when (re-search-forward rcov-xref-tag-regexp nil t n)
+    (goto-char (match-beginning 0)))
+  (rcov-xref-show-link))
+
+(defun rcov-xref-previous-tag (n)
+  "Go to previous LINK."
+  (interactive "p")
+  (re-search-backward rcov-xref-tag-regexp nil t n)
+  (rcov-xref-show-link))
+
+(defvar rcov-xref-link-tempbuffer " *rcov-link*")
+(defun rcov-xref-show-link ()
+  "Follow current LINK."
+  (let ((link (match-string 1))
+        (eol (point-at-eol)))
+    (save-excursion
+      (when (and link
+                 (re-search-backward "# \\(>>\\|<<\\) " (point-at-bol) t))
+        (while (re-search-forward rcov-xref-tag-regexp eol t)
+          (let ((matched (match-string 1)))
+            (when (string= link matched)
+              (add-text-properties 0 (length matched) '(face highlight) matched))
+            (with-current-buffer (get-buffer-create rcov-xref-link-tempbuffer)
+              (insert matched "\n"))))
+        (let (message-log-max)          ; inhibit *Messages*
+          (message "%s" (with-current-buffer rcov-xref-link-tempbuffer
+                          (substring (buffer-string) 0 -1)))) ; chomp
+        (kill-buffer rcov-xref-link-tempbuffer)))))
+
+
+;; copied from jw-visit-source
+(defun rcov-xref-extract-file-lines (line)
+  "Extract a list of file/line pairs from the given line of text."
+  (let*
+      ((unix_fn "[^ \t\n\r\"'([<{]+")
+       (dos_fn  "[a-zA-Z]:[^ \t\n\r\"'([<{]+")
+       (flre (concat "\\(" unix_fn "\\|" dos_fn "\\):\\([0-9]+\\)"))
+       (start nil)
+       (result nil))
+    (while (string-match flre line start)
+      (setq start (match-end 0))
+      (setq result
+            (cons (list
+                   (substring line (match-beginning 1) (match-end 1))
+                   (string-to-int (substring line (match-beginning 2) (match-end 2))))
+                  result)))
+    result))
+
+(defun rcov-xref-select-file-line (candidates)
+  "Select a file/line candidate that references an existing file."
+  (cond ((null candidates) nil)
+        ((file-readable-p (caar candidates)) (car candidates))
+        (t (rcov-xref-select-file-line (cdr candidates))) ))
+
+(defun rcov-xref-visit-source ()
+  "If the current line contains text like '../src/program.rb:34', visit
+  that file in the other window and position point on that line."
+  (interactive)
+  (let* ((line (progn (looking-at rcov-xref-tag-regexp) (match-string 1)))
+         (candidates (rcov-xref-extract-file-lines line))
+         (file-line (rcov-xref-select-file-line candidates)))
+    (cond (file-line
+           (run-hooks 'rcov-xref-before-visit-source-hook)
+           (find-file (car file-line))
+           (goto-line (cadr file-line))
+           (run-hooks 'rcov-xref-after-visit-source-hook))
+          (t
+           (error "No source location on line.")) )))
+
+;;;; Running rcov with various options.
+(defun rcov-internal (cmdline)
+  "Run rcov with various options."
+  (compile-internal cmdline ""
+                    nil nil nil (lambda (x) "*rcov*")))
+
+(defun rcov ()
+  "Run rcov to find uncovered code."
+  (interactive)
+  (rcov-internal rcov-command-line))
+
+(defun rcovsave ()
+  "Run rcov to save coverage status."
+  (interactive)
+  (rcov-internal rcovsave-command-line))
+
+(defun rcovdiff ()
+  "Run rcov to find new uncovered code."
+  (interactive)
+  (rcov-internal rcovdiff-command-line))
+
+(provide 'rcov)

data/test/sample_04.rb

@@ -0,0 +1,10 @@
+$: << File.dirname(__FILE__)
+require 'sample_03'
+
+klass = Rcov::Test::Temporary::Sample03
+obj = klass.new
+obj.f1
+obj.f2
+obj.f3
+#klass.g1 uncovered
+klass.g2

data/test/sample_05-new.rb

@@ -0,0 +1,17 @@
+def d(x)
+  4*x
+end
+
+def a
+  b 10
+end
+
+def b(x)
+  x*10
+end
+
+def c(x)
+  3*x
+end
+
+a()

data/test/sample_05-old.rb

@@ -0,0 +1,13 @@
+def a
+  b 10
+end
+
+def b(x)
+  x*10
+end
+
+def c(x)
+  3*x
+end
+
+a()

data/test/sample_05.rb

@@ -0,0 +1,17 @@
+def d(x)
+  4*x
+end
+
+def a
+  b 10
+end
+
+def b(x)
+  x*10
+end
+
+def c(x)
+  3*x
+end
+
+a()

data/test/test_functional.rb

@@ -0,0 +1,105 @@
+require 'test/unit'
+require 'pathname'
+require 'fileutils'
+
+=begin
+Updating functional testdata automatically is DANGEROUS, so I do manually.
+
+== update functional test
+cd ~/src/rcov/test
+rcov="ruby ../bin/rcov -I../lib:../ext/rcovrt -o expected_coverage"
+
+$rcov -a sample_04.rb
+$rcov sample_04.rb
+$rcov --gcc --include-file=sample --exclude=rcov sample_04.rb > expected_coverage/gcc-text.out
+
+cp sample_05-old.rb sample_05.rb
+$rcov --no-html --gcc --include-file=sample --exclude=rcov --save=coverage.info sample_05.rb > expected_coverage/diff-gcc-original.out
+cp sample_05-new.rb sample_05.rb
+$rcov --no-html --gcc -D --include-file=sample --exclude=rcov sample_05.rb > expected_coverage/diff-gcc-diff.out
+$rcov --no-html -D --include-file=sample --exclude=rcov sample_05.rb > expected_coverage/diff.out
+$rcov --no-html --no-color -D --include-file=sample --exclude=rcov sample_05.rb > expected_coverage/diff-no-color.out
+$rcov --no-html --gcc --include-file=sample --exclude=rcov sample_05.rb > expected_coverage/diff-gcc-all.out
+  
+=end
+
+class TestFunctional < Test::Unit::TestCase
+  @@dir = Pathname(__FILE__).expand_path.dirname
+
+  def strip_time(str)
+    str.sub(/Generated on.+$/, '')
+  end
+
+  def cmp(file)
+    content = lambda{|dir| strip_time(File.read(@@dir+dir+file))}
+    assert_equal(content["expected_coverage"], content["actual_coverage"])
+  end
+
+  def with_testdir(&block)
+    Dir.chdir(@@dir, &block)
+  end
+
+  def run_rcov(opts, script="sample_04.rb", opts_tail="")
+    rcov = @@dir+"../bin/rcov"
+    ruby_opts = "-I../lib:../ext/rcovrt"
+    with_testdir do
+      `cd #{@@dir}; ruby #{ruby_opts} #{rcov} #{opts} -o actual_coverage #{script} #{opts_tail}`
+      yield if block_given?
+    end
+  end
+
+  def test_annotation
+    run_rcov("-a") do
+      cmp "sample_04_rb.rb"
+      cmp "sample_03_rb.rb"
+    end
+  end
+
+  def test_html
+    run_rcov("") do
+      cmp "sample_04_rb.html"
+      cmp "sample_03_rb.html"
+    end
+  end
+
+  @@selection = "--include-file=sample --exclude=rcov"
+  def test_text_gcc
+    run_rcov("--gcc #{@@selection}",
+             "sample_04.rb",
+             "> actual_coverage/gcc-text.out") do
+      cmp "gcc-text.out"
+    end
+  end
+
+  def test_diff
+    with_testdir { FileUtils.cp "sample_05-old.rb", "sample_05.rb" }
+    run_rcov("--no-html --gcc #{@@selection} --save=coverage.info", "sample_05.rb",
+             "> actual_coverage/diff-gcc-original.out") do
+      cmp "diff-gcc-original.out"
+    end
+
+    with_testdir { FileUtils.cp "sample_05-new.rb", "sample_05.rb" }
+    run_rcov("--no-html -D --gcc #{@@selection}", "sample_05.rb",
+             "> actual_coverage/diff-gcc-diff.out") do
+      cmp "diff-gcc-diff.out"
+    end
+
+    run_rcov("--no-html -D #{@@selection}", "sample_05.rb",
+             "> actual_coverage/diff.out") do
+      cmp "diff.out"
+    end
+
+    run_rcov("--no-html --no-color -D #{@@selection}", "sample_05.rb",
+             "> actual_coverage/diff-no-color.out") do
+      cmp "diff-no-color.out"
+    end
+
+    run_rcov("--no-html --gcc #{@@selection}", "sample_05.rb",
+             "> actual_coverage/diff-gcc-all.out") do
+      cmp "diff-gcc-all.out"
+    end
+
+    
+  end
+
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.1
 specification_version: 1
 name: rcov
 version: !ruby/object:Gem::Version 
-  version: 0.7.0.1
-date: 2006-08-04 00:00:00 +02:00
+  version: 0.8.0.0
+date: 2007-02-28 00:00:00 +01:00
 summary: Code coverage analysis tool for Ruby
 require_paths: 
 - lib
@@ -48,16 +48,23 @@ files:
 - README.API
 - README.vim
 - README.rant
+- README.emacs
 - THANKS
 - test/sample_02.rb
 - test/sample_01.rb
 - test/sample_03.rb
+- test/sample_04.rb
 - test/test_CodeCoverageAnalyzer.rb
 - test/test_FileStatistics.rb
 - test/turn_off_rcovrt.rb
 - test/test_CallSiteAnalyzer.rb
+- test/sample_05.rb
+- test/test_functional.rb
+- test/sample_05-new.rb
+- test/sample_05-old.rb
 - mingw-rbconfig.rb
 - rcov.vim
+- rcov.el
 - setup.rb
 - BLURB
 - CHANGES
@@ -65,6 +72,7 @@ test_files:
 - test/test_CodeCoverageAnalyzer.rb
 - test/test_FileStatistics.rb
 - test/test_CallSiteAnalyzer.rb
+- test/test_functional.rb
 rdoc_options: 
 - --main
 - README.API