rcov 0.8.1.2.0 → 0.9.3

data/lib/rcov/formatters/html_erb_template.rb

@@ -0,0 +1,62 @@
+module Rcov
+  module Formatters
+    class HtmlErbTemplate
+      attr_accessor :local_variables
+
+      def initialize(template_file, locals={})
+        require "erb"
+
+        template_path = File.expand_path("#{File.dirname(__FILE__)}/../templates/#{template_file}")
+        @template = ERB.new(File.read(template_path))
+        @local_variables = locals
+        @path_relativizer = Hash.new{|h,base|
+          h[base] = Pathname.new(base).cleanpath.to_s.gsub(%r{^\w:[/\\]}, "").gsub(/\./, "_").gsub(/[\\\/]/, "-") + ".html"
+        }
+      end
+
+      def render
+        @template.result(get_binding)
+      end
+
+      def coverage_threshold_classes(percentage)
+        return 110 if percentage == 100
+        return (1..10).find_all{|i| i * 10 > percentage}.map{|i| i.to_i * 10} * " " 
+      end
+      
+      def code_coverage_html(code_coverage_percentage, is_total=false)
+        %{<div class="percent_graph_legend"><tt class='#{ is_total ? 'coverage_total' : ''}'>#{ "%3.2f" % code_coverage_percentage }%</tt></div>
+          <div class="percent_graph">
+            <div class="covered" style="width:#{ code_coverage_percentage.round }px"></div>
+            <div class="uncovered" style="width:#{ 100 - code_coverage_percentage.round }px"></div>
+          </div>}
+      end
+
+      def file_filter_classes(file_path)
+        file_path.split('/')[0..-2] * " "
+      end
+      
+      def relative_filename(path)
+        @path_relativizer[path]
+      end
+    
+      def line_css(line_number)
+        case fileinfo.coverage[line_number]
+        when true
+          "marked"
+        when :inferred
+          "inferred"
+        else
+          "uncovered"
+        end
+      end
+
+      def method_missing(key, *args)
+        local_variables.has_key?(key) ? local_variables[key] : super
+      end
+
+      def get_binding
+        binding 
+      end
+    end
+  end
+end

data/lib/rcov/formatters/text_coverage_diff.rb

@@ -0,0 +1,193 @@
+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
+      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,32 @@
+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,11 @@
+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/lowlevel.rb

@@ -6,15 +6,16 @@ require 'rcov/version'
 
 module Rcov
 
-  # RCOV__ performs the low-level tracing of the execution, gathering code
-  # coverage information in the process. The C core made available through the
-  # rcovrt extension will be used if possible. Otherwise the functionality
-  # will be emulated using set_trace_func, but this is very expensive and
-  # will fail if other libraries (e.g. breakpoint) change the trace_func.
-  #
-  # Do not use this module; it is very low-level and subject to frequent
-  # changes. Rcov::CodeCoverageAnalyzer offers a much more convenient and
-  # stable interface.
+# RCOV__ performs the low-level tracing of the execution, gathering code
+# coverage information in the process. The C core made available through the
+# rcovrt extension will be used if possible. Otherwise the functionality
+# will be emulated using set_trace_func, but this is very expensive and
+# will fail if other libraries (e.g. breakpoint) change the trace_func.
+#
+# Do not use this module; it is very low-level and subject to frequent
+# changes. Rcov::CodeCoverageAnalyzer offers a much more convenient and
+# stable interface.
+
 module RCOV__
   COVER = {}
   CALLSITES = {}
@@ -59,19 +60,19 @@ One Click Installer and mswin32 builds) at http://eigenclass.org/hiki.rb?rcov .
     (methods & sklass.instance_methods).each do |meth|
       sklass.class_eval{ remove_method meth }
     end
-    
+
     @coverage_hook_activated = @callsite_hook_activated = false
 
     def self.install_coverage_hook # :nodoc:
       install_common_hook
       @coverage_hook_activated = true
     end
-    
+
     def self.install_callsite_hook # :nodoc:
       install_common_hook
       @callsite_hook_activated = true
     end
-    
+
     def self.install_common_hook # :nodoc:
       set_trace_func lambda {|event, file, line, id, binding, klass|
         next unless SCRIPT_LINES__.has_key? file
@@ -109,7 +110,7 @@ One Click Installer and mswin32 builds) at http://eigenclass.org/hiki.rb?rcov .
       @coverage_hook_activated = false
       set_trace_func(nil) if !@callsite_hook_activated
     end
-    
+
     def self.remove_callsite_hook # :nodoc:
       @callsite_hook_activated = false
       set_trace_func(nil) if !@coverage_hook_activated
@@ -140,8 +141,6 @@ One Click Installer and mswin32 builds) at http://eigenclass.org/hiki.rb?rcov .
       end
     end
   end
-end # RCOV__
-
-end # Rcov
+end 
 
-# vi: set sw=2:
+end 

data/lib/rcov/rcovtask.rb

@@ -12,9 +12,9 @@ module Rcov
   # coverage reports.
   #
   # Example:
-  #   
+  #
   #   require 'rcov/rcovtask'
-  #   
+  #
   #   Rcov::RcovTask.new do |t|
   #     t.libs << "test"
   #     t.test_files = FileList['test/test*.rb']
@@ -103,27 +103,27 @@ module Rcov
           (@name==:rcov ? "" : " for #{actual_name}")
       end
       task @name do
-	run_code = ''
-	RakeFileUtils.verbose(@verbose) do
-	  run_code =
-	    case rcov_path
-	    when nil, ''
-              "-S rcov"
-            else %!"#{rcov_path}"!
-	    end
+        run_code = ''
+        RakeFileUtils.verbose(@verbose) do
+          run_code =
+          case rcov_path
+          when nil, ''
+            "-S rcov"
+          else %!"#{rcov_path}"!
+          end
           ruby_opts = @ruby_opts.clone
           ruby_opts.push( "-I#{lib_path}" )
           ruby_opts.push run_code
-	  ruby_opts.push( "-w" ) if @warning
-	  ruby ruby_opts.join(" ") + " " + option_list +
-            %[ -o "#{@output_dir}" ] +
-	    file_list.collect { |fn| %["#{fn}"] }.join(' ')
-	end
+          ruby_opts.push( "-w" ) if @warning
+          ruby ruby_opts.join(" ") + " " + option_list +
+          %[ -o "#{@output_dir}" ] +
+          file_list.collect { |fn| %["#{fn}"] }.join(' ')
+        end
       end
 
       desc "Remove rcov products for #{actual_name}"
       task paste("clobber_", actual_name) do
-	rm_r @output_dir rescue nil
+        rm_r @output_dir rescue nil
       end
 
       clobber_task = paste("clobber_", actual_name)
@@ -143,14 +143,13 @@ module Rcov
 
     def file_list # :nodoc:
       if ENV['TEST']
-	FileList[ ENV['TEST'] ]
+        FileList[ ENV['TEST'] ]
       else
-	result = []
-	result += @test_files.to_a if @test_files
-	result += FileList[ @pattern ].to_a if @pattern
-	FileList[result]
+        result = []
+        result += @test_files.to_a if @test_files
+        result += FileList[ @pattern ].to_a if @pattern
+        FileList[result]
       end
     end
   end
 end
-

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

@@ -0,0 +1,64 @@
+<!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><%= page_title %></title>
+    <link href="screen.css" media="all" rel="stylesheet" type="text/css" />
+    <link href="print.css" media="print" rel="stylesheet" type="text/css" />
+    <% if css %><link href="custom.css" media="all" rel="stylesheet" type="text/css" /><% end %>
+    <meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
+    <script type="text/javascript" src="rcov.js"></script>
+  </head>
+  <body>
+    <h1><%= "#{project_name} C0 Coverage Information - RCov" %></h1>
+    <h2><%= page_title %></h2>
+
+    <% if output_threshold != 101 %>
+      <!-- Note: 101 is the default threshold if you don't enter one -->
+      <p>Threshold: <%= output_threshold %>%</p>
+    <% end %>
+
+    <div class="report_table_wrapper">
+      <table class='report' id='report_table'>
+        <thead>
+          <tr>
+            <th class="left_align">Name</th>
+            <th class="right_align">Total Lines</th>
+            <th class="right_align">Lines of Code</th>
+            <th class="left_align">Total Coverage</th>
+            <th class="left_align">Code Coverage</th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr>
+            <td class="left_align"><a href="<%= relative_filename(fileinfo.name) %>"><%= fileinfo.name %></a></td>
+            <td class='right_align'><tt><%= fileinfo.num_lines %></tt></td>
+            <td class='right_align'><tt><%= fileinfo.num_code_lines %></tt></td>
+            <td class="left_align"><%= code_coverage_html(fileinfo.total_coverage_for_report) %></td>
+            <td class="left_align"><%= code_coverage_html(fileinfo.code_coverage_for_report) %></td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+    
+    <h3>Key</h3>
+    
+    <div class="key"><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's a line marked as not executed.</span></pre></div>
+
+    <h3>Coverage Details</h3>
+
+    <table class="details">
+      <tbody>
+        <% fileinfo.num_lines.times do |i| %>
+          <% line = fileinfo.lines[i].chomp %>
+          <% count = fileinfo.counts[i] %>
+          <tr class="<%= line_css(i) %>">
+            <td><pre><a name="line<%= i.next %>"><%= i.next %></a> <%= CGI::escapeHTML(line) %></pre></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+
+    <p>Generated on <%= generated_on %> with <a href="<%= rcov::UPSTREAM_URL %>">rcov <%= rcov::VERSION %></a></p>
+
+  </body>
+</html>