rcov 0.8.1.2.0 → 0.9.3

data/README.rake

@@ -1,62 +0,0 @@
-
-== Code coverage analysis automation with Rake
-
-Since 0.4.0, <tt>rcov</tt> features a <tt>Rcov::RcovTask</tt> task for rake
-which can be used to automate test coverage analysis.  Basic usage is as
-follows:
-
- 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
-
-This will create by default a task named <tt>rcov</tt>, and also a task to
-remove the output directory where the XHTML report is generated.
-The latter will be named <tt>clobber_rcob</tt>, and will be added to the main
-<tt>clobber</tt> target.
-
-=== Passing command line options to <tt>rcov</tt>
-
-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
-<tt>rcov</tt>:
-
- 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
-
-That will generate a <tt>coverage</tt> task and the associated
-<tt>clobber_coverage</tt> task to remove the directory the report is dumped
-to ("<tt>coverage</tt>" by default).
-
-You can specify a different destination directory, which comes handy if you
-have several <tt>RcovTask</tt>s; the <tt>clobber_*</tt> will take care of
-removing that directory:
-
- 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
-
-=== Options passed through the <tt>rake</tt> 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/README.rant

@@ -1,68 +0,0 @@
-
-== Code coverage analysis automation with Rant
-
-Since 0.5.0, <tt>rcov</tt> features a <tt>Rcov</tt> generator for eant
-which can be used to automate test coverage analysis.  Basic usage is as
-follows:
-
-  require 'rcov/rant'
- 
-  desc "Create a cross-referenced code coverage report."
-  gen Rcov do |g|
-    g.test_files = sys['test/test*.rb']
-  end
-
-This will create by default a task named <tt>rcov</tt>.
-
-=== Passing command line options to <tt>rcov</tt>
-
-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
-<tt>rcov</tt>:
-
-  desc "Create cross-referenced code coverage report."
-  gen Rcov, :coverage do |g|
-    g.test_files = sys['test/test*.rb']
-    g.rcov_opts << "--threshold 80" << "--callsites"
-  end
-
-That will generate a <tt>coverage</tt> task.
-
-You can specify a different destination directory, which comes handy if you
-have several rcov tasks:
-
-  desc "Analyze code coverage for the FileStatistics class."
-  gen Rcov, :rcov_sourcefile do |g|
-    g.libs << "ext/rcovrt"
-    g.test_files = sys['test/test_FileStatistics.rb']
-    g.rcov_opts << "--test-unit-only"
-    g.output_dir = "coverage.sourcefile"
-  end
-
-  desc "Analyze code coverage for CodeCoverageAnalyzer."
-  gen Rcov, :rcov_ccanalyzer do |g|
-    g.libs << "ext/rcovrt"
-    g.test_files = sys['test/test_CodeCoverageAnalyzer.rb']
-    g.rcov_opts << "--test-unit-only"
-    g.output_dir = "coverage.ccanalyzer"
-  end
-
-=== Options specified passed to the generator 
-
-The +Rcov+ generator recognizes the following options:
-+libs+:: directories to be added to the <tt>$LOAD_PATH</tt>
-+rcov_opts+:: array of options to be passed to rcov
-+test_files+:: files to execute
-+test_dirs+:: directories where to look for test files automatically
-+pattern+:: pattern for automatic discovery of unit tests to be executed
-+output_dir+:: directory where to leave the generated reports
-
-+test_files+ overrides the combination of +test_dirs+ and +pattern+.
-
-
-=== Options passed through the <tt>rake</tt> command line
-
-You can override the options defined in the Rcov tasks by specifying them 
-using environment variables at the time rant is executed.
-  RCOVPATH=/my/modified/rcov rant rcov       # use the specified rcov executable
-  RCOVOPTS="--no-callsites -x foo" rant rcov # pass those options to rcov

data/README.vim

@@ -1,47 +0,0 @@
-
-<tt>rcov.vim</tt> 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 <tt>rcov.vim</tt> to the appropriate "compiler" directory (typically
-<tt>$HOME/.vim/compiler</tt>).
-
-== Usage
-
-=== 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.
-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.rake[link:files/README_rake.html] 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.
-
---------
-# vim: ft=text :

data/Rantfile

@@ -1,76 +0,0 @@
-# This Rantfile serves as an example of how to use the Rcov generator.
-# Take a look at the RDoc documentation (or README.rant) for further
-# information.
-
-$:.unshift "lib" if File.directory? "lib"
-
-import %w(rubytest rubydoc autoclean)
-require 'rcov/rant'
-
-task :default => :test
-
-# Use the specified rcov executable instead of the one in $PATH
-# (this way we get a sort of informal functional test).
-# This could also be specified from the command like, e.g.
-#   rake rcov RCOVPATH=/path/to/myrcov
-ENV["RCOVPATH"] = "bin/rcov"
-
-desc "Create a cross-referenced code coverage report."
-gen Rcov do |g|
-  g.libs << "ext/rcovrt"
-  g.test_files = sys['test/test*.rb']
-  g.rcov_opts << "--callsites"  # comment to disable cross-references
-end
-
-desc "Analyze code coverage for the FileStatistics class."
-gen Rcov, :rcov_sourcefile do |g|
-  g.libs << "ext/rcovrt"
-  g.test_files = sys['test/test_FileStatistics.rb']
-  g.rcov_opts << "--test-unit-only"
-  g.output_dir = "coverage.sourcefile"
-end
-
-desc "Analyze code coverage for CodeCoverageAnalyzer."
-gen Rcov, :rcov_ccanalyzer do |g|
-  g.libs << "ext/rcovrt"
-  g.test_files = sys['test/test_CodeCoverageAnalyzer.rb']
-  g.rcov_opts << "--test-unit-only"
-  g.output_dir = "coverage.ccanalyzer"
-end
-
-desc "Run the unit tests, both rcovrt and pure-Ruby modes"
-task :test => [:test_rcovrt, :test_pure_ruby]
-
-desc "Run the unit tests with rcovrt."
-gen RubyTest, :test_rcovrt => %w[ext/rcovrt/rcovrt.so] do |g|
-  g.libs << "ext/rcovrt"
-  g.test_files = sys['test/test*.rb']
-  g.verbose = true
-end
-
-file "ext/rcovrt/rcovrt.so" => "ext/rcovrt/rcov.c" do
-  sys "ruby setup.rb config"
-  sys "ruby setup.rb setup"
-end
-
-desc "Run the unit tests in pure-Ruby mode."
-gen RubyTest, :test_pure_ruby do |g|
-    g.libs << "ext/rcovrt"
-    g.test_files = sys['test/turn_off_rcovrt.rb', 'test/test*.rb']
-    g.verbose = true
-end
-
-desc "Generate documentation."
-gen RubyDoc, :rdoc do |g|
-    g.verbose = true
-    g.dir = "doc"
-    g.files = sys["README.API", "README.rake", "README.rant", "README.vim", 
-                  "lib/**/*.rb"]
-    g.opts = %w(--line-numbers --inline-source --title rcov --main README.API)
-end
-
-desc "Remove autogenerated files."
-gen AutoClean, :clean
-var[:clean].include %w(InstalledFiles .config coverage coverage.* )
-
-# vim: set sw=2 ft=ruby:

data/ext/rcovrt/callsite.c

@@ -1,242 +0,0 @@
-#include <ruby.h>
-#include <env.h>
-#include <node.h>
-#include <st.h>
-#include <stdlib.h>
-
-
-static char callsite_hook_set_p;
-
-typedef struct {
-        char *sourcefile;
-        unsigned int sourceline;
-        VALUE curr_meth;
-} type_def_site;       
-static VALUE caller_info = 0;
-static VALUE method_def_site_info = 0;
-
-static caller_stack_len = 1;
-
-/*
- *
- * callsite hook and associated functions
- *
- * */
-
-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);
-  /*
-  printf("CALLSITE: %s -> %s   %d\n", RSTRING(rb_inspect(curr_meth))->ptr,
-                  RSTRING(rb_inspect(caller_ary))->ptr, FIX2INT(count));
-  */
-
-  return Qnil;
-}
-
-
-static VALUE
-record_method_def_site(VALUE args)
-{
-  type_def_site *pargs = (type_def_site *)args;
-  VALUE def_site_info;
-  VALUE hash;
-
-  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);
-  /*
-  printf("DEFSITE: %s:%d  for %s\n", pargs->sourcefile, pargs->sourceline+1,
-                  RSTRING(rb_inspect(pargs->curr_meth))->ptr);
-  */
-  
-  return Qnil;
-}
-
-static VALUE
-callsite_custom_backtrace(int lev)
-{
-  struct FRAME *frame = ruby_frame;
-  VALUE ary;
-  NODE *n;
-  VALUE level;
-  VALUE klass;
-
-  ary = rb_ary_new();
-  if (frame->last_func == ID_ALLOCATOR) {
-          frame = frame->prev;
-  }
-  for (; frame && (n = frame->node); frame = frame->prev) {
-          if (frame->prev && frame->prev->last_func) {
-                  if (frame->prev->node == n) continue;
-                  level = rb_ary_new();
-                  klass = frame->prev->last_class ? frame->prev->last_class : Qnil;
-                  if(TYPE(klass) == T_ICLASS) {
-                          klass = CLASS_OF(klass);
-                  }
-                  rb_ary_push(level, klass);
-                  rb_ary_push(level, ID2SYM(frame->prev->last_func));
-                  rb_ary_push(level, rb_str_new2(n->nd_file));
-                  rb_ary_push(level, INT2NUM(nd_line(n)));
-          }
-          else {
-                  level = rb_ary_new();
-                  rb_ary_push(level, Qnil);
-                  rb_ary_push(level, Qnil);
-                  rb_ary_push(level, rb_str_new2(n->nd_file));
-                  rb_ary_push(level, INT2NUM(nd_line(n)));
-          }
-          rb_ary_push(ary, level);
-          if(--lev == 0)
-                  break;
-  }
-
-  return ary;
-}
-  
-static void
-coverage_event_callsite_hook(rb_event_t event, NODE *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);
-
- if(TYPE(klass) == T_ICLASS) {
-         klass = CLASS_OF(klass);
- }
- curr_meth = rb_ary_new();
- rb_ary_push(curr_meth, klass);
- 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 && node) {
-         type_def_site args;        
-         
-         args.sourcefile = node->nd_file;
-         args.sourceline = nd_line(node) - 1;
-         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;
-          rb_add_event_hook(coverage_event_callsite_hook, 
-                          RUBY_EVENT_CALL);
-          
-          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);
-}
-/* vim: set sw=8 expandtab: */