Geminstaller C0 Coverage Information - RCov

/Users/woolley/.rvm/gems/ruby-1.8.7-p174@geminstaller/gems/rspec-1.3.0/lib/spec/runner/formatter/base_formatter.rb

Name Total Lines Lines of Code Total Coverage Code Coverage
/Users/woolley/.rvm/gems/ruby-1.8.7-p174@geminstaller/gems/rspec-1.3.0/lib/spec/runner/formatter/base_formatter.rb 139 36
97.84%
91.67%

Key

Code reported as executed by Ruby looks like this...and this: this line is also marked as covered.Lines considered as run by rcov, but not reported by Ruby, look like this,and this: these lines were inferred by rcov (using simple heuristics).Finally, here's a line marked as not executed.

Coverage Details

1 module Spec
2   module Runner
3     module Formatter
4       # Formatter base-class, which implements all required methods as no-ops, with the exception
5       class BaseFormatter
6         # Formatters are initialized with <tt>options</tt> and <tt>output</tt>
7         # arguments. RSpec's built-in formatters already expect this, and any
8         # custom formatters should as well.
9         #
10         # ==== Parameters
11         # options::
12         #   A struct containing boolean values for colour, autospec,
13         #   and dry_run
14         # output::
15         #   Used by RSpec's built-in formatters to determine where to
16         #   write the output. Default is <tt>STDOUT</tt>, otherwise a
17         #   filename is expected.
18         #
19         # === Example
20         # If you invoke the <tt>spec</tt> command with:
21         #
22         #   --format progress:progress_report.txt
23         #
24         # ... the value of <tt>output</tt> will be progress_report.txt. If you
25         # don't identify an output destination, the default is STDOUT.
26         def initialize(options, output)
27         end
28         
29         # This method is invoked before any examples are run, right after
30         # they have all been collected. This can be useful for special
31         # formatters that need to provide progress on feedback (graphical ones)
32         #
33         # This method will only be invoked once, and the next one to be invoked
34         # is #example_group_started
35         #
36         # ==== Parameters
37         # example_count:: the total number of examples to be run
38         def start(example_count)
39         end
40 
41         # This method is invoked at the beginning of the execution of each
42         # example_group. The next method to be invoked after this is
43         # #example_started
44         #
45         # ==== Parameters
46         # example_group_proxy:: instance of Spec::Example::ExampleGroupProxy
47         def example_group_started(example_group_proxy)
48         end
49         
50         # Deprecated - use example_group_started instead
51         def add_example_group(example_group_proxy)
52           Spec.deprecate("BaseFormatter#add_example_group", "BaseFormatter#example_group_started")
53           example_group_started(example_group_proxy)
54         end
55 
56         # This method is invoked when an +example+ starts. The next method to be
57         # invoked after this is #example_passed, #example_failed, or
58         # #example_pending
59         #
60         # ==== Parameters
61         # example_proxy:: instance of Spec::Example::ExampleProxy
62         def example_started(example_proxy)
63         end
64 
65         # This method is invoked when an +example+ passes.
66         # +example_proxy+ is the same instance of Spec::Example::ExampleProxy
67         # that was passed to example_started
68         #
69         # ==== Parameters
70         # example_proxy:: instance of Spec::Example::ExampleProxy
71         def example_passed(example_proxy)
72         end
73 
74         # This method is invoked when an +example+ fails, i.e. an exception occurred
75         # inside it (such as a failed should or other exception).
76         #
77         # ==== Parameters
78         # example_proxy::
79         #   The same instance of Spec::Example::ExampleProxy that was passed
80         #   to <tt>example_started</tt>
81         #
82         # counter:: the sequential number of this failure
83         #
84         # failure:: instance of Spec::Runner::Reporter::Failure
85         def example_failed(example_proxy, counter, failure)
86         end
87         
88         # This method is invoked when an example is not yet implemented (i.e. has not
89         # been provided a block), or when an ExamplePendingError is raised.
90         # +message+ is the message from the ExamplePendingError, if it exists, or the
91         # default value of "Not Yet Implemented". +deprecated_pending_location+ is
92         # deprecated - use example_proxy.location instead
93         #
94         # ==== Parameters
95         # example_proxy:: instance of Spec::Example::ExampleProxy
96         # message::
97         #   the message passed to the pending message, or an internal
98         #   default
99         #
100         def example_pending(example_proxy, message, deprecated_pending_location=nil)
101         end
102 
103         # This method is invoked after all of the examples have executed. The next method
104         # to be invoked after this one is #dump_failure (once for each failed example)
105         def start_dump
106         end
107 
108         # Dumps detailed information about an example failure.
109         # This method is invoked for each failed example after all examples have run. +counter+ is the sequence number
110         # of the associated example. +failure+ is a Failure object, which contains detailed
111         # information about the failure.
112         #
113         # ==== Parameters
114         # counter:: the sequential number of this failure
115         # failure:: instance of Spec::Runner::Reporter::Failure
116         def dump_failure(counter, failure)
117         end
118       
119         # This method is invoked after the dumping of examples and failures.
120         #
121         # ==== Parameters
122         # duration:: the total time for the entire run
123         # example_count:: the number of examples run
124         # failure_count:: the number of examples that failed
125         # pending_count:: the number of examples that are pending
126         def dump_summary(duration, example_count, failure_count, pending_count)
127         end
128         
129         # This gets invoked after the summary
130         def dump_pending
131         end
132 
133         # This method is invoked at the very end. Allows the formatter to clean up, like closing open streams.
134         def close
135         end
136       end
137     end
138   end
139 end

Generated on Mon May 10 23:40:28 -0700 2010 with rcov 0.9.8