Update Rspec/ContextWording list

[colinbruce]

We are implementing the rubocop-govuk gem in a couple of repos and are having some linguistic issues with tests that exercise delayed jobs.

We have a number of tests where the nested contexts are:

context 'when submission errors' do
  context 'with a generic error' do
   	# setup
    context 'before the final retry' do
      # setup
      # test
    end
    context 'when the retry is at the max retries' do
      # setup
      # test
    end
  end
end

Rewording the tests in line with the required words (and the final retry has not started) makes them harder to understand!
As the rubocop documenttation also lists before and after as acceptable prefixes, how do you feel about this extension?

[kevindew]

Hey @colinbruce thanks for opening a PR here, I appreciate the contribution. Unfortunately this isn't something we'd like to accept.

The reasons for this are:

• We discourage the use of nested contexts - we allow "and" and "but" mostly to work with our existing code patterns that were established prior to discouragement. More info: Add more prefixes for RSpec/ContextWording #87
• Although the suggestions you've listed are in the docs they aren't part of the default rubocop-rspec configuration. See: Add more prefixes for RSpec/ContextWording #87

The course of action I'd suggest is to refactor your tests to cut out the nested contexts - I know, based on our past, it's easier said than done if you've got heavy use of them - but, also based on our ex, they can be really complex to follow.

I.e for the example you've given I'd prefer to read code like:

context 'when a submission error occurs before the final retry' do
  # setup
  # test
end

context 'when an error occurs and there are no more retries' do
  # setup
  # test
end

Hope this helps

[colinbruce]

Thanks for responding @kevindew