rcov 0.8.1.2.0 → 0.9.3

data/CHANGES

@@ -1,177 +0,0 @@
-
-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

@@ -1,36 +0,0 @@
-
-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/README.API

@@ -1,42 +0,0 @@
-
-= +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.emacs

@@ -1,64 +0,0 @@
-
-<tt>rcov.el</tt> allows you to use rcov from Emacs conveniently.
-* Run unit tests and jump to uncovered code by <tt>C-x `</tt>.
-* Run unit tests and save the current coverage status.
-* Run unit tests and jump to uncovered code introduced since the last run.
-* View cross-reference annotated code.
-
-== Installation
-
-Copy <tt>rcov.el</tt> to the appropriate directory, which is in load-path.
-Then require it.
-  (require 'rcov)
-
-
-== Usage
-
-There are some commands to run rcov in Emacs.
-All of them displays +rcov+ window, whose major-mode is compilation-mode.
-Therefore you can jump to uncovered code by <tt>C-x `</tt>.
-
-+rcov-command-line+, +rcovsave-command-line+, and +rcovdiff-command-line+ define
-command line to run rcov.
-If you do not use +rcov+ from Rake, you must modify them.
-
-=== Finding uncovered code
-
-Type the following while editing your program:
-  M-x rcov
-  
-=== 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.
-
-Type the following to save the current status in Emacs:
-  M-x rcovsave
-If you do not use +rcov+ from Rake, you must modify +rcovsave-command-line+ variable.
-
-=== Finding new uncovered code
-
-Type the following to save the current status in Emacs:
-  M-x rcovdiff
-
-=== Viewing cross-reference annotated code
-
-If you read cross-reference annotated code, issue
-  rake rcov RCOVOPTS='-a'
-at the beginning.
-This command creates +coverage+ directory and many *.rb files in it.
-Filenames of these Ruby scripts are converted from original path.
-You can browse them by normally <tt>C-x C-f</tt>.
-You can think of <tt>-a</tt> option as <tt>--xrefs</tt> option and output format is Ruby script.
-
-After find-file-ed annotated script, the major-mode is rcov-xref-mode,
-which is derived from ruby-mode and specializes navigation.
-
-<tt>Tab</tt> and <tt>M-Tab</tt> goes forward/backward links.
-<tt>Ret</tt> follows selected link.
-
-This feature is useful to read third-party code or to follow control flow.

data/README.en

@@ -1,130 +0,0 @@
-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...
-  * 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 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>