RSpec/SpecFilePathFormat allow multiple values for same key in IgnoreMetadata #2076
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
April 10, 2025 11:16
…reMetadata values to ignore for each key
bquorning
reviewed
Apr 10, 2025
There was a problem hiding this comment.
I wonder if we should change the default config to use an array:
IgnoreMetadata:
- type: routing
+ type:
+ - routing
VersionAdded: '2.24'
pirj
requested changes
Apr 10, 2025
|
I think the current approach will lead to ambiguous configuration, and we should do this differently. I haven’t heard counter arguments, so I’m setting a block until we figure out how to proceed. |
pirj
changed the title
pirj
requested changes
Apr 10, 2025
| # @example `IgnoreMetadata: {type=>[routing,models]}` (default) | ||
| # # good | ||
| # whatever_spec.rb # describe MyClass, type: :routing do; end | ||
| # whatever_spec.rb # describe MyClass, type: :models do; end |
There was a problem hiding this comment.
What if the metadata's value IS an array?
RSpec.describe Airplane, prepare: [:fuel] doHow do we define IgnoreMetadata in YAML?
| # @example `IgnoreMetadata: {type=>[routing,models]}` (default) | ||
| # # good | ||
| # whatever_spec.rb # describe MyClass, type: :routing do; end | ||
| # whatever_spec.rb # describe MyClass, type: :models do; end |
There was a problem hiding this comment.
I propose:
IgnoreMetadata:
- prepare # ignore by presence of a key
- type: model # ignore one value
- type: routing # and another, too
- skip: [database] # ignore when the value is an array of specific valuesLuckily enough, YAML allows to mix all that, and to cover all ignored cases unambiguously.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Retry of PR #2070 - I seem to have fat-fingered the rebase to master in the previous PR. So here is a fresh PR based off of the current master with all the change requests of the original included.
Description of original PR:
RSpec/SpecFilePathFormat allows ignoring certain values in rspec metadata through the IgnoreMetadata option, as given in the documentation:
However the current implementation does not seem to allow supplying multiple values for the same key - e.g. if you have some specs marked
type: controller, others astype: :modeletc, only one ofcontroller,model, ... can be supplied to be ignored.This is probably due to an oversight (or me not being able to figure out how to properly supply an array of values to be ignored).
The PR allows for either an array or a single value to be given for a key in the IgnoreMetadata option.
While it would also be desirable to give a
truevalue to ignore all metadata, in the format thatIgnoreMethodsuse, this should probably be part of a different PR.