Feature rspec failed with reason

[inkstak]

What is the purpose of this pull request?

As suggested in this discussion #271, it allows to match reasons when using RSpec DSL

PR checklist:

• Tests included
• Documentation updated
• Changelog entry added

[coveralls-official]

coverage: 93.691% (-0.1%) from 93.79%
when pulling da6daa6 on inkstak:feature-rspec_failed_with_reason
into 6927ad5 on palkan:master.

[palkan]

Thanks!

Left some suggestions in the comments.

[palkan]

Failure/Error: failed "when user is not an admin", reason: a_hash_including(user: anything)
  `anything` is not available on an example group (e.g. a `describe` or `context` block). It is only available from within individual examples (e.g. `it` blocks) or from constructs that run in the scope of an example (e.g. `before`, `let`, etc).

Oh, I see. That's the problem with this kind of DSL and a good indicator that we should find a better API.

@inkstak What about smth like that:

failed "when user is not an admin" do
  # it could be an alias for `let(:failure_reason)` and we can define the default (`nil`) in the shared example
  failure_reason { a_hash_including(user: anything) }
end

WDYT?

P.S. The more I work with this DSL today, the more I think if we should deprecate it 🤔. It looks cool and fancy for simple use cases but not for complex policies and requirements.