Class: Protest::Reports::Documentation

Inherits:

Protest::Report

• Object
• Protest::Report
• Protest::Reports::Documentation

Defined in:

lib/protest/reports/documentation.rb

Overview

For each testcase in your suite, this will output the description of the test case (whatever you provide 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.

Instance Attribute Summary

Attributes inherited from Protest::Report

#stream

Method Summary

Methods inherited from Protest::Report

#add_assertion, #assertions, #errors, #failures, #failures_and_errors, #initialize, on, #passes, #pendings, #tests, #time_elapsed, #total_tests

Methods included from Utils::ColorfulOutput

colors, #print, #puts

Methods included from Utils::Summaries

#summarize_errors, #summarize_pending_tests, #summarize_test_totals

Constructor Details

This class inherits a constructor from Protest::Report