For each testcase in your suite, this will output the description of the test case (whatever you provide Protest::TestCase.context), followed by the name of each test in that context, one per line. For example:
Protest.context "A user" do test "has a name" do ... end test "has an email" do ... end context "validations" do test "ensure the email can't be blank" do ... end end end
Will output, when run with the :documentation
report:
A user - has a name - has an email A user validations - ensure the email can't be blank
This is based on the specdoc runner in rspec.
Set the stream where the report will be written to. STDOUT by default.
# File lib/protest/reports/documentation.rb, line 39 def initialize(stream=STDOUT) @stream = stream end