Add a cop to enforce aggregating examples #726
Closed
Commits on Apr 24, 2019
-
Add a cop to enforce aggregating examples
The "one expectation per example" rule has been relaxed and allows for several expectations to be set in the same example. https://github.com/rubocop-hq/rspec-style-guide#expectations-per-example In cases the examples don't have any setup, metadata, or even a docstring, and may be aggregated into one thus saving on sometimes expensive context setup. The cop still does report the cases when the examples might be aggregated, but with some risk, e.g. when matchers with side effects are used. It makes sense to do so, since eventually those matchers might be fixed to leave the subject in its original state. Block expectation syntax is deliberately not supported due to: - `subject { -> { ... } }` syntax being hard to detect - aggregation should use composition with `.and` - aggregation of the `not_to` is barely possible when a matcher doesn't provide a negated variant - aggregation of block syntax with non-block syntax should be in a specific order Known caveats: The usages if `its` that are testing private methods/readers will result in spec failure. It's up to the user whether to replace with `__send__`, or test only public interface. Original idea and initial implementation: https://github.com/palkan/test-prof/blob/master/lib/test_prof/cops/rspec/aggregate_failures.rb
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Apply suggestions from code review
Improve wording, fix punctuation errors. Co-Authored-By: pirj <pirj@users.noreply.github.com>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Detect side effect matcher with qualifiers
Matchers with side effects with qualifiers were still aggregated, e.g.: is_expected.to allow_value('green').for(:color) -
Do not pretend to correct uncorrectable offenses
Previously, auto-correct run pretended it corrected the offenses, even though they were not.
-
-
-
[DO NOT SQUASH] Add support for adding docs from modules
Due to yard's override of docs when the docs are defined in several files for the same class ([see this issue](lsegal/yard#1173)), it's impossible to spread the docs to several files so that they are compiled into one document (e.g. a manual). Comparison using: RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge makes it impossible to put the docs on the included module level without filtering out those modules for which a badge can't be inferred, because `RuboCop::Cop::Badge.for` raises an error.
-
-
-
-
-
-
-
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.