Sha256: 7b76e8dc6c2678ba83543b60641d03533e8b341a85b7b82244dd65fe48a5ef71

Contents?: true

Size: 1.35 KB

Versions: 16

Compression:

Stored size: 1.35 KB

Contents

= +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 take a look at
readme_for_rake[link:files/README_rake.html].

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.


Version data entries

16 entries across 16 versions & 4 rubygems

Version Path
jruby-rcov-0.8.2.1-java doc/readme_for_api
jruby-rcov-0.8.2.2-java doc/readme_for_api
jruby-rcov-0.8.2.3-java doc/readme_for_api
jruby-rcov-0.8.2.4-java doc/readme_for_api
mchung-rcov-0.8.3.3 doc/readme_for_api
relevance-rcov-0.8.2.1 doc/readme_for_api
relevance-rcov-0.8.3.0 doc/readme_for_api
relevance-rcov-0.8.3.1 doc/readme_for_api
relevance-rcov-0.8.3.2 doc/readme_for_api
relevance-rcov-0.8.3.3 doc/readme_for_api
relevance-rcov-0.8.3.4 doc/readme_for_api
relevance-rcov-0.8.3.5 doc/readme_for_api
relevance-rcov-0.8.3.6 doc/readme_for_api
relevance-rcov-0.8.3.8 doc/readme_for_api
relevance-rcov-0.8.3.9 doc/readme_for_api
valo-rcov-0.8.3.4 doc/readme_for_api