relevance-rcov 0.8.2.1

data/BLURB

@@ -0,0 +1,149 @@
+
+Source code, additional information, screenshots... available at 
+    http://eigenclass.org/hiki/rcov
+
+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.
+
+Overview
+========
+rcov is a code coverage tool for Ruby. It is commonly used for viewing overall
+test coverage of target code. It features:
+* fast execution: 20-300 times faster than previous tools
+* multiple analysis modes: standard, bogo-profile, "intentional testing",
+  dependency analysis...
+* detection of uncovered code introduced since the last run ("differential
+  code coverage")
+* fairly accurate coverage information through code linkage inference using 
+  simple heuristics
+* cross-referenced XHTML and several kinds of text reports
+* support for easy automation with Rake
+* colorblind-friendliness
+
+How do I use it?
+================
+
+In the common scenario, your tests are under test/ and the target code
+(whose coverage you want) is in lib/. In that case, all you have to do is
+use rcov to run the tests (instead of testrb), and a number of XHTML files
+with the code coverage information will be generated, e.g.
+
+    rcov -Ilib test/*.rb
+
+will execute all the .rb files under test/ and generate the code coverage
+report for the target code (i.e. for the files in lib/) under coverage/. The
+target code needs not be under lib/; rcov will detect is as long as it is
+require()d by the tests. rcov is smart enough to ignore "uninteresting"
+files: the tests themselves, files installed in Ruby's standard locations,
+etc.  See  rcov --help  for the list of regexps rcov matches filenames
+against.
+
+rcov can also be used from Rake; see readme_for_rake or the RDoc documentation
+for more information.
+
+rcov can output information in several formats, and perform different kinds
+of analyses in addition to plain code coverage.  See  rcov --help  for a
+description of the available options.
+
+Sample output
+=============
+
+See http://eigenclass.org/hiki.rb?rcov (once again) for screenshots.
+
+The text report (also used by default in RcovTasks) resembles
+
+
++-----------------------------------------------------+-------+-------+--------+
+|                  File                               | Lines |  LOC  |  COV   |
++-----------------------------------------------------+-------+-------+--------+
+|lib/rcov.rb                                          |   572 |   358 |  91.3% |
++-----------------------------------------------------+-------+-------+--------+
+|Total                                                |   572 |   358 |  91.3% |
++-----------------------------------------------------+-------+-------+--------+
+91.3%   1 file(s)   572 Lines   358 LOC
+
+
+
+The (undecorated) textual output with execution count information looks like this:
+
+ $ rcov --no-html --text-counts b.rb 
+ ================================================================================
+ ./b.rb
+ ================================================================================
+                                                                       |      2
+ a, b, c = (1..3).to_a                                                 |      2
+ 10.times do                                                           |      1
+   a += 1                                                              |     10
+   20.times do |i|                                                     |     10
+     b += i                                                            |    200
+     b.times do                                                        |    200
+       c += (j = (b-a).abs) > 0 ? j : 0                                | 738800
+     end                                                               |      0
+   end                                                                 |      0
+ end                                                                   |      0
+
+
+rcov can detect when you've added code that was not covered by your unit
+tests:
+
+    $ rcov --text-coverage-diff --no-color test/*.rb
+    Started
+    .......................................
+    Finished in 1.163085 seconds.
+    
+    39 tests, 415 assertions, 0 failures, 0 errors
+    
+    ================================================================================
+    !!!!! Uncovered code introduced in lib/rcov.rb
+    
+    ### lib/rcov.rb:207
+       
+	 def precompute_coverage(comments_run_by_default = true)
+	   changed = false
+	   lastidx = lines.size - 1
+	   if (!is_code?(lastidx) || /^__END__$/ =~ @lines[-1]) && !@coverage[lastidx]
+    !!       # mark the last block of comments
+    !!       @coverage[lastidx] ||= :inferred
+    !!       (lastidx-1).downto(0) do |i|
+    !!         break if is_code?(i)
+    !!         @coverage[i] ||= :inferred
+    !!       end
+    !!     end
+	   (0...lines.size).each do |i|
+	     next if @coverage[i]
+	     line = @lines[i]
+
+
+
+License
+-------
+rcov is released under the terms of Ruby's license.
+rcov includes xx 0.1.0, which is subject to the following conditions:
+
+ePark Labs Public License version 1
+Copyright (c) 2005, ePark Labs, Inc. and contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  1. Redistributions of source code must retain the above copyright notice, this
+     list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright notice,
+     this list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+  3. Neither the name of ePark Labs nor the names of its contributors may be
+     used to endorse or promote products derived from this software without
+     specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/CHANGES

@@ -0,0 +1,177 @@
+
+User-visible changes.
+
+Since 0.8.1.1 (2007-11-20)
+==========================
+Bugfixes
+--------
+* REXML from 1.8.6-p11[01] is more broken than anticipated; more invasive
+  workarounds. Tested on 1.8.6-p110 and 1.8.5. Note that code using REXML to
+  generate XML will behave differently under rcov in 1.8.6-p11[01] (to begin
+  with, it won't crash in REXML::Document#write).
+
+Since 0.8.1 (2007-11-19)
+========================
+Bugfixes
+--------
+* REXML workaround incorrectly applied to 1.8.6 < p110
+* --spec-only should work with RSpec trunk and detect when it cannot work
+
+Since 0.8.0 (2007-02-28)
+========================
+Features
+--------
+* you can use an existent data file to generate coverage reports without
+  having to execute your code again
+* --spec-only: only consider cover code executed inside a spec
+  (tested with RSpec 1.0.5, 1.0.8)
+* --charset can be used to specify the charset in the Content-Type declaration
+
+Bugfixes
+--------
+* workaround for bugs in Safari, IE (self-closing anchors break colorization)
+* workaround for bugs in REXML shipped with 1.8.6-p110
+* rethrow exceptions generated by traced scripts
+* compatibility with Ruby < 1.8.5
+
+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
+--------
+* coverage/callsite data from multiple runs can be aggregated (--aggregate) 
+
+Bugfixes
+--------
+* the SCRIPT_LINES__ workaround works better
+* fixed silly bug in coverage data acquisition (line after the correct one
+  marked in some situations)
+* avoid problems with repeated path separators in default ignore list, based
+  on rbconfig's data
+
+
+Minor enhancements
+------------------
+
+Since 0.5.0 (2006-05-30)
+========================
+Features
+--------
+* differential coverage report: --text-coverage-diff (-D) and --save
+  Tells you when you've added new code that was not covered by the tests and
+  when code that used to be covered isn't anymore. Integration with vim
+  (contributions for other editors/IDEs welcome).
+* fully cross-referenced reports, indicating where methods are called from
+  and which methods were called for each line (--xrefs)
+* cross-referenced report generation is now over 4 times faster for
+  applications with deep call stacks (such as Rails apps)
+
+Bugfixes
+--------
+* comments at EOF are marked now
+* better handling of multiline hashes/arrays
+* better handling of end/}: support chained method calls and more expressions
+  on the same line
+* better handling of heredocs with interpolation
+
+Minor enhancements
+------------------
+* more readable --text-coverage
+* set whether comments are "run" by default instead of attaching them to
+  the following block of code (--[no-]comments)
+* --report-cov-bug can be used to report bugs in the coverage analysis 
+
+Since 0.4.0 (2006-05-22)
+========================
+Features
+--------
+* ability to create cross-referenced reports, indicating where methods are
+  called from (--callsites)
+* more refinements in the heuristics: now several kinds of multi-line quoted
+  strings are handled properly
+* --include-file to specify files not to be ignored in the report(s)
+* implemented a task generator for Rant
+
+Bugfixes
+--------
+* corrected the LOC counts in the XHTML summaries
+* pure-Ruby tracing module works again; was broken in 0.4.0
+* RcovTask#ruby_opts fixed; they were being passed to rcov instead of ruby
+* solved the DOCTYPE issue (it'd get put at the end of the file under some
+  Ruby versions)
+
+Minor enhancements
+------------------
+* slightly more readable XHTML reports, esp. for IE
+* text reports fit in 79 columns so they look OK with cmd.exe
+* try to guide the user when all files were considered "uninteresting" by rcov
+* the output_dir is preserved in RcovTasks when the user specifies --profile
+  via the RCOVOPTS env. var.
+
+Since 0.3.0 (2006-05-05)
+========================
+
+Features
+--------
+* easy automation via Rake using the bundled Rcov::RcovTask
+* better heuristics: supports heredocs at last, including variants your editor
+  is probably unable to handle, and =begin/=end comments
+* --rails option to ignore files under vendor/, enviroment/ and config/
+* parts of the runtime exposed and documented for external use
+* new color scheme, with alternating shades of the base colors
+* -w to set $VERBOSE=true (turns on warnings)
+* --text-report and --text-summary
+* --sort and --sort-reverse for the summaries and reports
+* --threshold and --only-uncovered
+* --replace-progname
+
+Backwards incompatible changes
+------------------------------
+* renamed --text to --text-counts and --rich-text to --text-coverage: they
+  were misnamed to begin with
+* changed the meaning of -t and -T (--text-summary and --text-report)
+* $0 is not changed by default for each loaded file anymore; the old 
+  behavior (modulo a small bugfix) can be reproduced with --replace-progname
+
+Since 0.2.0 (2006-02-25)
+========================
+
+Features
+--------
+* --exclude-only
+* consolidate multiple references to the same underlying .rb file
+  (much needed for Rails)
+* --test-unit-only
+
+Fixes
+-----
+* consider and/op operators
+* honor --no-color in (rich) text mode 
+* output valid XHTML indices
+
+Since 0.1.0
+===========
+Tons. Better output, MUCH faster (two orders of magnitude), better command
+line...

data/LEGAL

@@ -0,0 +1,36 @@
+
+LEGAL NOTICE
+------------
+
+rcov itself is subject to the terms specified in LICENSE.
+
+rcov includes xx-0.1.0, which can be redistributed and used under the
+following conditions:
+
+
+ePark Labs Public License version 1
+Copyright (c) 2005, ePark Labs, Inc. and contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  1. Redistributions of source code must retain the above copyright notice, this
+     list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright notice,
+     this list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+  3. Neither the name of ePark Labs nor the names of its contributors may be
+     used to endorse or promote products derived from this software without
+     specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/LICENSE

@@ -0,0 +1,56 @@
+rcov is copyrighted free software by Mauricio Fernandez <mfp@acm.org>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see the file GPL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/Rakefile

@@ -0,0 +1,93 @@
+# This Rakefile serves as an example of how to use Rcov::RcovTask.
+# Take a look at the RDoc documentation (or readme_for_rake) for further
+# information.
+
+$:.unshift "lib" if File.directory? "lib"
+require 'rcov/rcovtask'
+require 'rcov/version'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/clean'
+
+# 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"
+
+# The following task is largely equivalent to:
+# Rcov::RcovTask.new
+desc "Create a cross-referenced code coverage report."
+Rcov::RcovTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts << "-Ilib:ext/rcovrt" # in order to use this rcov
+  t.rcov_opts << "--xrefs"  # comment to disable cross-references
+  t.verbose = true
+end
+
+desc "Analyze code coverage for the FileStatistics class."
+Rcov::RcovTask.new(:rcov_sourcefile) do |t|
+  t.test_files = FileList['test/file_statistics_test.rb']
+  t.verbose = true
+  t.rcov_opts << "--test-unit-only"
+  t.ruby_opts << "-Ilib:ext/rcovrt" # in order to use this rcov
+  t.output_dir = "coverage.sourcefile"
+end
+
+Rcov::RcovTask.new(:rcov_ccanalyzer) do |t|
+  t.test_files = FileList['test/code_coverage_analyzer_test.rb']
+  t.verbose = true
+  t.rcov_opts << "--test-unit-only"
+  t.ruby_opts << "-Ilib:ext/rcovrt" # in order to use this rcov
+  t.output_dir = "coverage.ccanalyzer"
+end
+
+desc "Run the unit tests with rcovrt."
+if RUBY_PLATFORM == 'java'
+  Rake::TestTask.new(:test_rcovrt => ["lib/rcovrt.jar"]) do |t|
+    t.libs << "lib"
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose = true
+  end
+else
+  Rake::TestTask.new(:test_rcovrt => ["ext/rcovrt/rcovrt.so"]) do |t|
+    system("cd ext/rcovrt && make clean && rm Makefile")
+    t.libs << "ext/rcovrt"
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose = true
+  end
+end
+
+file "ext/rcovrt/rcovrt.so" => FileList["ext/rcovrt/*.c"] do
+  ruby "setup.rb config"
+  ruby "setup.rb setup"
+end
+
+desc "Run the unit tests in pure-Ruby mode ."
+Rake::TestTask.new(:test_pure_ruby) do |t|
+  t.libs << "ext/rcovrt"
+  t.test_files = FileList['test/turn_off_rcovrt.rb', 'test/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run the unit tests"
+task :test => [:test_rcovrt]
+
+desc "install by setup.rb"
+task :install do
+  sh "sudo ruby setup.rb install"
+end
+
+task :default => :test
+
+desc "Generate rdoc documentation for the rcov library"
+Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "rcov"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include('doc/readme_for_api')
+  rdoc.rdoc_files.include('doc/readme_for_rake')
+  rdoc.rdoc_files.include('doc/readme_for_vim')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}