rcov 0.9.11 → 1.0.0

data/doc/readme_for_rake.markdown

@@ -1,51 +0,0 @@
-# Code coverage analysis automation with Rake
-
-Since 0.4.0, RCov features a `Rcov::RcovTask` task for rake
-which can be used to automate test coverage analysis.  Basic usage is as
-follows:
-<pre><code>
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |t|
-  t.test_files = FileList['test/test*.rb']
-  # t.verbose = true     # uncomment to see the executed command
-end
-</pre></code>
-
-This will create by default a task named `rcov`, and also a task to remove the output directory where the XHTML report is generated.  The latter will be named `clobber_rcov`, and will be added to the main `clobber` target.
-
-## Passing command line options to RCov
-
-You can provide a description, change the name of the generated tasks (the one used to generate the report(s) and the `clobber_` one) and pass options to RCov:
-<pre><code>
-desc "Analyze code coverage of the unit tests."
-Rcov::RcovTask.new(:coverage) do |t|
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
-  ## get a text report on stdout when rake is run:
-  t.rcov_opts << "--text-report"  
-  ## only report files under 80% coverage
-  t.rcov_opts << "--threshold 80"
-end
-</pre></code>
-
-This will generate a `coverage` task and the associated `clobber_coverage` task to remove the directory the report is dumped to (`coverage` by default).  You can specify a different destination directory, which comes handy if you have several `RcovTask`s; the `clobber_*` will take care of removing that directory:
-<pre><code>
-desc "Analyze code coverage for the FileStatistics class."
-Rcov::RcovTask.new(:rcov_sourcefile) do |t|
-  t.test_files = FileList['test/test_FileStatistics.rb']
-  t.verbose = true
-  t.rcov_opts << "--test-unit-only"
-  t.output_dir = "coverage.sourcefile"
-end
- 
-Rcov::RcovTask.new(:rcov_ccanalyzer) do |t|
-  t.test_files = FileList['test/test_CodeCoverageAnalyzer.rb']
-  t.verbose = true
-  t.rcov_opts << "--test-unit-only"
-  t.output_dir = "coverage.ccanalyzer"
-end
-</pre></code>
-
-## Options passed through the `rake` command line
-
-You can override the options defined in the RcovTask by passing the new options at the time you invoke rake. The documentation for the `Rcov::RcovTask` explains how this can be done.

data/doc/readme_for_vim.markdown

@@ -1,34 +0,0 @@
-# rcov.vim
-
-`rcov.vim` allows you to run unit tests from vim and enter quickfix mode in order to jump to uncovered code introduced since the last run.
-
-## Installation
-Copy `rcov.vim` to the appropriate `compiler` directory (typically `$HOME/.vim/compiler`).
-
-### Usage
-
-#### Setting the reference point
-
-RCov's `--text-coverage-diff` 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 `--save` option.  If you're running RCov from Rake, you can do something like
-  
-`rake rcov_units RCOVOPTS="-T --save --rails"`
-
-in order to take the current status as the reference point.
-
-#### Finding new uncovered code
-
-Type the following in command mode while editing your program:
-  
-`:compiler rcov`
-
-`rcov.vim` assumes RCov can be invoked with a rake task (see  [readme for rake]("http://github.com/relevance/rcov/blob/master/doc/readme_for_rake.markdown") for information on how to create it). 
-
-You can then execute +rcov+ and enter quickfix mode by typing
-
-`:make <taskname>`
-
-where taskname is the +rcov+ task you want to use; if you didn't override the default name in the Rakefile, just
-  
-`:make rcov`
-
-will do.  Vim will then enter quickfix mode, allowing you to jump to the areas that were not covered since the last time you saved the coverage data.

data/editor-extensions/rcov.el

@@ -1,131 +0,0 @@
-;;; 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/editor-extensions/rcov.vim

@@ -1,38 +0,0 @@
-" Vim compiler file
-" Language:	Ruby
-" Function:	Code coverage information with rcov
-" Maintainer:	Mauricio Fernandez <mfp at acm dot org>
-" Info:		
-" URL:		http://eigenclass.org/hiki.rb?rcov
-" ----------------------------------------------------------------------------
-"
-" Changelog:
-" 0.1:	initial version, shipped with rcov 0.6.0
-"
-" Comments:
-" Initial attempt. 
-" ----------------------------------------------------------------------------
-
-if exists("current_compiler")
-  finish
-endif
-let current_compiler = "rcov"
-
-if exists(":CompilerSet") != 2		" older Vim always used :setlocal
-  command -nargs=* CompilerSet setlocal <args>
-endif
-
-let s:cpo_save = &cpo
-set cpo-=C
-
-CompilerSet makeprg=rake\ $*\ RCOVOPTS=\"-D\ --no-html\ --no-color\"\ $*
-
-CompilerSet errorformat=
-     \%+W\#\#\#\ %f:%l\,
-     \%-C\ \ \ ,
-     \%-C!!\ 
-
-let &cpo = s:cpo_save
-unlet s:cpo_save
-
-" vim: nowrap sw=2 sts=2 ts=8 ff=unix :

data/ext/rcovrt/1.9/callsite.c

@@ -1,234 +0,0 @@
-#include <ruby.h>
-#include <ruby/st.h>
-#include <stdlib.h>
-
-#define DEBUG 0
-
-static char callsite_hook_set_p;
-
-typedef struct {
-  const char *sourcefile;
-  unsigned int sourceline;
-  VALUE curr_meth;
-} type_def_site;       
-
-static VALUE caller_info = 0;
-static VALUE method_def_site_info = 0;
-
-static int caller_stack_len = 1;
-
-static VALUE record_callsite_info(VALUE args) {
-  VALUE caller_ary;
-  VALUE curr_meth;
-  VALUE count_hash;
-  VALUE count;
-  VALUE *pargs = (VALUE *)args;
-
-  caller_ary = pargs[0];
-  curr_meth = pargs[1];
-  count_hash = rb_hash_aref(caller_info, curr_meth);
-  
-  if(TYPE(count_hash) != T_HASH) { 
-    /* Qnil, anything else should be impossible unless somebody's been
-     * messing with ObjectSpace */
-    count_hash = rb_hash_new();
-    rb_hash_aset(caller_info, curr_meth, count_hash);
-  }
-  
-  count = rb_hash_aref(count_hash, caller_ary);
-  
-  if(count == Qnil) 
-    count = INT2FIX(0);
-  
-  count = INT2FIX(FIX2UINT(count) + 1);
-  rb_hash_aset(count_hash, caller_ary, count);
-
-  if(DEBUG == 1)
-    printf("CALLSITE: %s -> %s   %d\n", RSTRING_PTR(rb_inspect(curr_meth)), RSTRING_PTR(rb_inspect(caller_ary)), FIX2INT(count));
-
-  return Qnil;
-}
-
-static VALUE record_method_def_site(VALUE args) {
-  type_def_site *pargs = (type_def_site *)args;
-  VALUE def_site_info;
-
-  if( RTEST(rb_hash_aref(method_def_site_info, pargs->curr_meth)) )
-    return Qnil;
-  
-  def_site_info = rb_ary_new();
-  rb_ary_push(def_site_info, rb_str_new2(pargs->sourcefile));
-  rb_ary_push(def_site_info, INT2NUM(pargs->sourceline+1));
-  rb_hash_aset(method_def_site_info, pargs->curr_meth, def_site_info);
-
-  if(DEBUG == 1)
-    printf("DEFSITE: %s:%d  for %s\n", pargs->sourcefile, pargs->sourceline+1, RSTRING_PTR(rb_inspect(pargs->curr_meth)));
-  
-  return Qnil;
-}
-
-static VALUE callsite_custom_backtrace(int lev) {
-  ID id;
-  VALUE klass;
-  VALUE klass_path;
-  VALUE eval_string;
-  
-  rb_frame_method_id_and_class(&id, &klass);
-  
-  if (id == ID_ALLOCATOR)
-    return Qnil;
-  
-  if (klass) {
-    if (TYPE(klass) == T_ICLASS) {
-      klass = RBASIC(klass)->klass;
-    }
-    else if (FL_TEST(klass, FL_SINGLETON)) {
-      klass = rb_iv_get(klass, "__attached__");
-    }
-  }
-  // rb_sprintf("\"#<Class:%s>\"", RSTRING_PTR(klass_path))
-  
-  /*
-  klass = class << klass; self end unless klass === eval("self", binding)
-  */
-  
-  klass_path = rb_class_path(klass);
-  VALUE reciever = rb_funcall(rb_binding_new(), rb_intern("eval"), 1, rb_str_new2("self"));
-  
-  if (rb_funcall(klass, rb_intern("=="), 1, reciever) == Qtrue) {
-    klass_path = rb_sprintf("\"#<Class:%s>\"", RSTRING_PTR(klass_path));
-    OBJ_FREEZE(klass_path);
-  }
-  
-  eval_string = rb_sprintf("caller[%d, 1].map do |line|\nmd = /^([^:]*)(?::(\\d+)(?::in `(?:block in )?(.*)'))?/.match(line)\nraise \"Bad backtrace format\" unless md\n[%s, md[3] ? md[3].to_sym : nil, md[1], (md[2] || '').to_i]\nend", lev, RSTRING_PTR(klass_path));
-  return rb_eval_string(RSTRING_PTR(eval_string));
-}
-
-static void coverage_event_callsite_hook(rb_event_flag_t event, VALUE node,  VALUE self, ID mid, VALUE klass) {
-  VALUE caller_ary;
-  VALUE curr_meth;
-  VALUE args[2];
-  int status;
-
-  caller_ary = callsite_custom_backtrace(caller_stack_len);
-
-  VALUE klass_path;
-  curr_meth = rb_ary_new();
-   
-  rb_frame_method_id_and_class(&mid, &klass);
-  
-  if (mid == ID_ALLOCATOR)
-    return; //Qnil;
-  if (klass) {
-    if (TYPE(klass) == T_ICLASS) {
-      klass = RBASIC(klass)->klass;
-    }
-    else if (FL_TEST(klass, FL_SINGLETON)) {
-      klass = rb_iv_get(klass, "__attached__");
-    }
-  }
-  
-  /*
-  klass = class << klass; self end unless klass === eval("self", binding)
-  */
-  
-  klass_path = rb_class_path(klass);
-  VALUE reciever = rb_funcall(rb_binding_new(), rb_intern("eval"), 1, rb_str_new2("self"));
-
-  if (rb_funcall(klass, rb_intern("=="), 1, reciever) == Qtrue) {
-    klass_path = rb_sprintf("#<Class:%s>", RSTRING_PTR(klass_path));
-    OBJ_FREEZE(klass_path);
-  }
-    
-  rb_ary_push(curr_meth, klass_path);
-  rb_ary_push(curr_meth, ID2SYM(mid));
-
-  args[0] = caller_ary;
-  args[1] = curr_meth;
-  rb_protect(record_callsite_info, (VALUE)args, &status);
-
-  if(!status) {
-    type_def_site args;
-
-    args.sourcefile = rb_sourcefile();
-    args.sourceline = rb_sourceline();
-    args.curr_meth = curr_meth;
-    rb_protect(record_method_def_site, (VALUE)&args, NULL);
-  }
-
-  if(status)
-    rb_gv_set("$!", Qnil);
-}
-
-static VALUE cov_install_callsite_hook(VALUE self) {
-  if(!callsite_hook_set_p) {
-    if(TYPE(caller_info) != T_HASH)
-      caller_info = rb_hash_new();
-    callsite_hook_set_p = 1;
-    VALUE something = 0;
-    rb_add_event_hook(coverage_event_callsite_hook, 
-                      RUBY_EVENT_CALL, something);
-    return Qtrue;
-  } 
-  else
-    return Qfalse;
-}
-
-static VALUE cov_remove_callsite_hook(VALUE self) {
-  if(!callsite_hook_set_p) 
-    return Qfalse;
-  else {
-    rb_remove_event_hook(coverage_event_callsite_hook);
-    callsite_hook_set_p = 0;
-    return Qtrue;
-  }
-}
-
-static VALUE cov_generate_callsite_info(VALUE self) {
-  VALUE ret;
-
-  ret = rb_ary_new();
-  rb_ary_push(ret, caller_info);
-  rb_ary_push(ret, method_def_site_info);
-  return ret;
-}
-
-static VALUE cov_reset_callsite(VALUE self) {
-  if(callsite_hook_set_p) {
-    rb_raise(rb_eRuntimeError, "Cannot reset the callsite info in the middle of a traced run.");
-    return Qnil;
-  }
-  
-  caller_info = rb_hash_new();
-  method_def_site_info = rb_hash_new();
-  return Qnil;
-}
-
-void Init_rcov_callsite() {
-  VALUE mRcov;
-  VALUE mRCOV__;
-  ID id_rcov = rb_intern("Rcov");
-  ID id_coverage__ = rb_intern("RCOV__");
-  // ID id_script_lines__ = rb_intern("SCRIPT_LINES__");
-  
-  if(rb_const_defined(rb_cObject, id_rcov)) 
-    mRcov = rb_const_get(rb_cObject, id_rcov);
-  else
-    mRcov = rb_define_module("Rcov");
-  
-  if(rb_const_defined(mRcov, id_coverage__))
-    mRCOV__ = rb_const_get_at(mRcov, id_coverage__);
-  else
-    mRCOV__ = rb_define_module_under(mRcov, "RCOV__");
-
-  callsite_hook_set_p = 0;
-  caller_info = rb_hash_new();
-  method_def_site_info = rb_hash_new();
-  rb_gc_register_address(&caller_info);
-  rb_gc_register_address(&method_def_site_info);
-  
-  rb_define_singleton_method(mRCOV__, "install_callsite_hook", cov_install_callsite_hook, 0);
-  rb_define_singleton_method(mRCOV__, "remove_callsite_hook", cov_remove_callsite_hook, 0);
-  rb_define_singleton_method(mRCOV__, "generate_callsite_info", cov_generate_callsite_info, 0);
-  rb_define_singleton_method(mRCOV__, "reset_callsite", cov_reset_callsite, 0);
-}