rcov 0.5.0.1

data/BLURB

@@ -0,0 +1,117 @@
+
+Source code, additional information, screenshots... available at 
+    http://eigenclass.org/hiki.rb?rcov
+Release information:
+    http://eigenclass.org/hiki.rb?rcov+0.5.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.
+
+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...
+* 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 and Rant
+* 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.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
+
+
+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,75 @@
+
+User-visible changes.
+
+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 (in the DATA area) 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/README.API

@@ -0,0 +1,42 @@
+
+= +rcov+
+
++rcov+ is a:
+1. tool for code coverage analysis for Ruby
+2. library for collecting code coverage and execution count information
+   introspectively
+
+If you want to use the command line tool, the output from
+ rcov -h
+is self-explicative.
+
+If you want to automate the execution of +rcov+ via Rake or Rant, take a look at
+README.rake[link:files/README_rake.html] or
+README.rant[link:files/README_rant.html], respectively.
+
+If you want to use the associated library, read on.
+
+== Usage of the +rcov+ runtime/library
+
++rcov+ is primarily a tool for code coverage analysis, but since 0.4.0 it
+exposes some of its code so that you can build on top of its heuristics for
+code analysis and its capabilities for coverage information and execution
+count gathering.
+
+The main classes of interest are Rcov::FileStatistics,
+Rcov::CodeCoverageAnalyzer and Rcov::CallSiteAnalyzer. 
+
+Rcov::FileStatistics can use some heuristics to determine
+which parts of the file are executable and which are mere comments.
+
+Rcov::CodeCoverageAnalyzer is used to gather code coverage and execution
+count information inside a running Ruby program.
+
+Rcov::CallSiteAnalyzer is used to obtain information about where methods are
+defined and who calls them.
+
+The parts of +rcov+'s runtime meant to be reused (i.e. the external API) are
+documented with RDoc. Those not meant to be used are clearly marked as so or
+were deliberately removed from the present documentation.
+
+

data/README.en

@@ -0,0 +1,128 @@
+rcov  copyright (c) 2004-2006 Mauricio Fernandez <mfp@acm.org>
+rcov includes xx 0.1.0, copyright (c) 2005, ePark Labs, Inc. and contributors 
+
+rcov README
+============
+
+  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...
+  * 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 and Rant
+  * colorblind-friendliness
+
+Requirements
+------------
+
+  * Ruby 1.8
+  * (recommended) C compiler: you can also use rcov without the rcovrt
+    extension but rcov will be two orders of magnitude slower. The extension
+    requires Ruby 1.8.3 or later.
+    If you're on win32, you can find a pre-built rcovrt extension at
+	 http://eigenclass.org/hiki.rb?rcov
+
+
+Normal install
+--------------
+
+  De-compress the archive and enter its top directory.
+  Then type:
+
+   ($ su)
+    # ruby setup.rb
+
+  This simple step installs rcov under the default location for Ruby
+  libraries.  You can also customize the installation by supplying some
+  options to setup.rb.
+  Try "ruby setup.rb --help".
+
+  A normal (rcovrt-enabled) install requires Ruby >= 1.8.3 and a working C
+  toolchain; if you cannot compile Ruby extensions proceed as described below.
+  
+  If you're on win32, you can find a pre-built rcovrt extension at
+	 http://eigenclass.org/hiki.rb?rcov
+
+  You might have to install a "development package" (often named ruby-dev or
+  ruby1.8-dev), or alternatively build ruby from the sources, if the compiler
+  cannot find the headers (ruby.h and friends).
+
+Install without the rcovrt extension
+------------------------------------
+
+  ($su )
+  # ruby setup.rb all --without-ext
+
+  will install rcov without building the rcovrt extension.
+  
+Usage
+-----
+
+  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.rake or the RDoc documentation
+  for more information.  The Rakefile included in rcov's sources holds a few
+  tasks that run rcov on itself, producing a number of reports. You can try
+    rake rcov
+  preferably after a full install or
+    ruby setup.rb config
+    ruby setup.rb setup
+  so that the rcovrt extension can be used to speed up the process.
+  This will generate a cross-referenced XHTML report under coverage/.
+ 
+  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.
+
+License
+-------
+
+  rcov is licensed under the same terms as Ruby. See LICENSE.
+  rcov includes a copy of the xx library, which carries the following
+  copyright notice:
+
+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.
+
+
+Mauricio Fernandez <mfp@acm.org>