Doggo

An RSpec formatter that looks like --format documentation, but adds an indication of test number and overall test count at the start of each line.

Example output

Regenerate this with FOR_EXAMPLE=yes bundle exec rspec --order defined:

[   10] Doggo examples
[01/10]   outer passes
[02/10]   FAILED (1) - outer fails

  1) Doggo examples outer fails
     Failure/Error: expect(true).to eql(false)

       expected: false
            got: true

       (compared using eql?)

       Diff:
       @@ -1,2 +1,2 @@
       -false
       +true

     # ./spec/example/doggo_spec.rb:29:in `block (2 levels) in <top (required)>'

[03/10]   PENDING - outer is pending with xit
[04/10]   FAILED (2) - outer is pending with a custom message

  2) Doggo examples outer is pending with a custom message FIXED
     Expected pending 'custom message' to fail. No error was raised.
     # ./spec/example/doggo_spec.rb:35

[   10]   in a context
[   10]     with a nested context
[05/10]       passes
[06/10]       FAILED (3) - fails

  3) Doggo examples in a context with a nested context fails
     Failure/Error: expect(true).to eql(false)

       expected: false
            got: true

       (compared using eql?)

       Diff:
       @@ -1,2 +1,2 @@
       -false
       +true

     # ./spec/example/doggo_spec.rb:12:in `block (4 levels) in <top (required)>'

[07/10]       PENDING - is pending with xit
[08/10]       FAILED (4) - is pending with a custom message

  4) Doggo examples in a context with a nested context is pending with a custom message FIXED
     Expected pending 'custom message' to fail. No error was raised.
     # ./spec/example/doggo_spec.rb:18

[   10]   test count
[09/10]     is taken to 9
[10/10]     is taken to 10, showing leading zero pad formatting

Notable things are:

• Group title entries omit the example number
• Left zero padding to keep column alignment, working for any number of total tests
• FAILED and PENDING states are shown on the left side of the message, not the right as with RSpec's --format documentation, to make them a little easier to see in CI output
• A PENDING default message of Temporarily skipped with xit is suppressed for brevity, but any other message would be shown inline.
• Detailed failure messages are shown inline, so you can start investigating test failures while your test suite continues to run.

Installation

Either:

gem install doggo

...or in a Gemfile:

gem 'doggo', '~> 1.0'

Usage

Drive RSpec with:

rspec --format Doggo

Alternatively, edit your .rspec file:

# .rspec

--format Doggo

...or alter your spec_helper.rb file or equivalent:

RSpec.configure do | config |
  config.add_formatter 'Doggo'
end

Development

Doggo works with Ruby 1.9.3-p551 from November 13th 2011, but needs a far newer RubyGems version in order for its .gemspec file to be processed fully. You will therefore probably want to update RubyGems if you are doing development work on the source code and want to, for example, run bundle update. Assuming you are using rbenv and have automatically (via Doggo's .ruby-version file) or manually (via e.g. running command rbenv local 1.9.3-p551) switched to Ruby 1.9.3-p551, you can safely ensure that the most recent compatible RubyGems version is installed by issuing this command:

gem update --system 2.7.11

According to the release history, 2.7.11 is the last of the v2.x RubyGems releases which still supported Ruby v1.x. Version 2.7.11 was released on December 9th 2020.

If you recreate the Gemfile.lock file, you must:

• Make sure PLATFORMS only contains ruby
• Delete the BUNDLED WITH entry

...else some of the GitHub Actions won't run correctly (the 'build' will fail).