rcov 0.9.11 → 1.0.0

data/BLURB

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

data/LICENSE

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

@@ -1,103 +0,0 @@
-$:.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.ruby_opts << "--debug"
-    t.test_files = FileList['test/*_test.rb']
-    t.verbose = true
-  end
-
-  file "lib/rcovrt.jar" => FileList["ext/java/**/*.java"] do |t|
-    rm_f "lib/rcovrt.jar"
-    mkdir_p "pkg/classes"
-    sh "javac -classpath #{Java::JavaLang::System.getProperty('java.class.path')} -d pkg/classes #{t.prerequisites.join(' ')}"
-    sh "jar cf #{t.name} -C pkg/classes ."
-  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
-
-begin
-  %w{sdoc sdoc-helpers rdiscount}.each { |name| gem name }
-  require 'sdoc_helpers'
-rescue LoadError => ex
-  puts "sdoc support not enabled:"
-  puts ex.inspect
-end
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ''
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rcov #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/THANKS

@@ -1,110 +0,0 @@
-Jay McGaffigan:
-* JRuby support integrated from original rcov4j
-
-Aaron Bedra:
-* major refactoring
-* added threshold testing
-* Took on the task of keeping RCov going
-
-Corey Ehmke (Bantik):
-* redesigned index and detail XHTML
-* added sortable columns in coverage table
-* added file and coverage threshold filters to index XHTML
-* added print-specific style sheet
-* added support for custom CSS for XHTML output
-
-Tom Dolbilin:
- * identified and fixed backslash problem on win32 for generated filenames
-
-Andrew Kreiling:
-* made the index XHTML compliant
-* consolidate multiple references to the same underlying .rb file
-
-Robert Feldt:
-* pointed me to dynamic uses of the tracing hooks, provided the inspiration
-  for RCOV__.run_hooked
-* helped to refine the color scheme
-
-Andre Nathan:
-* identified a bug in the heuristics: missing propagation for lines
-  with only }, ), ]
-
-David Roberts: 
-* reported confusing behavior when all files are ignored because they match
-  a regexp in the reject list
-* tested the RubyGems package for win32
-
-John-Mason Shackelford:
-* reported an important bug in the pure-Ruby tracer module, which broke it
-  altogether in 0.4.0
-* suggested a change in the CSS to make XHTML reports more readable under IE
-
-Dave Burt:
-* reported an issue with text reports under cmd.exe (should use < 80 cols)
-
-Alex Wayne:
-* reported problem with heredocs: they were not being marked as a whole if
-  the "header" wasn't reported by Ruby.
-* reported problem with the last line of literal data structs not being
-  covered if there was stuff after the end delimiter
-
-Coda Hale:
-* reported problem with blocks were the first line is not being marked
-  and ditto for the last line when end/} is followed by more stuff
-
-Tim Shadel:
-* reported that the last comment block was not being marked even when
-  it was the last thing in the file
-
-Thomas Leitner:
-* reported that the SCRIPT_LINES__ workaround did not always work
-* fixed the bug which broke differential reports for filenames with
-  special characters
-
-Assaph Mehr:
-* beta-tested 0.7.0 and found a bug in --aggregate (missing files)
-
-Ryan Kinderman:
-* suggested that -Ipath be passed to ruby instead of rcov in RcovTasks
-
-Jan Svitok:
-* reported typo in rcovtask.rb's RDoc
-
-rubikitch:
-* implemented --annotate mode
-* implemented --gcc option
-* superior emacs support
-* testing, refactoring...
-* many other things, see darcs changes
-
-Zed A. Shaw:
-* reported and fixed segfault triggered by rspec
-
-Lee Marlow:
-* patch allowing to run rcov against a data file with no input code
-
-Kurt Stephens:
-* patch to rethrow any exceptions generated by the traced scripts after
-  report generation; notably SystemExit, allowing to use the exit code from
-  test runners under rake.
-
-Brian Candler:
-* found compatibility issues with the REXML lib included in ruby-1.8.6-p110
-  and provided a workaround
-
-Mat Schaffer:
-* reported missing line colorization on Safari and probably other browsers,
-  owing to self-closing <a> not being handled properly despite being valid
-  XHTML 1.0.
-
-Sam Granieri:
-* tested workaround for REXML bug
-
-Kosmas Schütz, Daniel Berger, François Beausoleil, Bil Kleb:
-* provided information about the ruby-1.8.6-p11[01] REXML problems
-
-Chad Humphries:
-* indicated that Spec::DSL::Example has changed in RSpec trunk
-
-Jeremy Hinegardner:
-* more info about REXML's bugs in 1.8.6-p11[01]

data/doc/readme_for_api.markdown

@@ -1,22 +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 explanatory.  If you want to automate the execution of RCov via Rake take a look at [readme for rake]("http://github.com/relevance/rcov/blob/master/doc/readme_for_rake.markdown").  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/doc/readme_for_emacs.markdown

@@ -1,52 +0,0 @@
-# rcov.el
-
-`rcov.el` allows you to use rcov from Emacs conveniently.
-
-* Run unit tests and jump to uncovered code by <code>C-x `</code>
-* 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 will display RCov window, whose `major-mode` is `compilation-mode`.  This allow you to jump to uncovered code using C-x `. 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 `--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. 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 a `coverage` directory and many `*.rb` files in it.  Filenames of these Ruby scripts are converted from original path.  You can browse them by normally `C-x C-f`.  You can think of `-a` option as `--xrefs` 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.
-
-* `Tab` and `M-Tab` goes forward/backward links.
-* `Ret` follows selected link.
-
-This feature is useful to read third-party code or to follow control flow.