Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change RSpec/ContextWording cop to always report an offense when both Prefixes and AllowedPatterns are empty #1982

Merged
merged 1 commit into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Master (Unreleased)

- Change `RSpec/ContextWording` cop to always report an offense when both `Prefixes` and `AllowedPatterns` are empty. ([@ydah])

## 3.1.0 (2024-10-01)

- Add `RSpec/StringAsInstanceDoubleConstant` to check for and correct strings used as instance_doubles. ([@corsonknowles])
Expand Down
3 changes: 3 additions & 0 deletions docs/modules/ROOT/pages/cops_rspec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,9 @@ the configuration to meet project needs. Other acceptable prefixes may
include `if`, `unless`, `for`, `before`, `after`, or `during`.
They may consist of multiple words if desired.

If both `Prefixes` and `AllowedPatterns` are empty, this cop will always
report an offense. So you need to set at least one of them.

This cop can be customized allowed context description pattern
with `AllowedPatterns`. By default, there are no checking by pattern.

Expand Down
24 changes: 15 additions & 9 deletions lib/rubocop/cop/rspec/context_wording.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ module RSpec
#
# @see http://www.betterspecs.org/#contexts
#
# If both `Prefixes` and `AllowedPatterns` are empty, this cop will always
# report an offense. So you need to set at least one of them.
#
# @example `Prefixes` configuration
# # .rubocop.yml
# # RSpec/ContextWording:
Expand Down Expand Up @@ -58,7 +61,9 @@ module RSpec
class ContextWording < Base
include AllowedPattern

MSG = 'Context description should match %<patterns>s.'
MSG_MATCH = 'Context description should match %<patterns>s.'
MSG_ALWAYS = 'Current settings will always report an offense. Please ' \
'add allowed words to `Prefixes` or `AllowedPatterns`.'

# @!method context_wording(node)
def_node_matcher :context_wording, <<~PATTERN
Expand All @@ -67,8 +72,7 @@ class ContextWording < Base

def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
context_wording(node) do |context|
if bad_pattern?(context)
message = format(MSG, patterns: expect_patterns)
unless matches_allowed_pattern?(description(context))
add_offense(context, message: message)
end
end
Expand All @@ -84,12 +88,6 @@ def prefix_regexes
@prefix_regexes ||= prefixes.map { |pre| /^#{Regexp.escape(pre)}\b/ }
end

def bad_pattern?(node)
return false if allowed_patterns.empty?

!matches_allowed_pattern?(description(node))
end

def description(context)
if context.xstr_type?
context.value.value
Expand All @@ -98,6 +96,14 @@ def description(context)
end
end

def message
if allowed_patterns.empty?
MSG_ALWAYS
else
format(MSG_MATCH, patterns: expect_patterns)
end
end

def expect_patterns
inspected = allowed_patterns.map do |pattern|
pattern.inspect.gsub(/\A"|"\z/, '/')
Expand Down
7 changes: 4 additions & 3 deletions spec/rubocop/cop/rspec/context_wording_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,10 @@
{ 'Prefixes' => [], 'AllowedPatterns' => [] }
end

it 'skips any description' do
expect_no_offenses(<<~RUBY)
context 'arbitrary text' do
it 'always registers an offense' do
expect_offense(<<~RUBY)
context 'this is an incorrect context' do
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Current settings will always report an offense. Please add allowed words to `Prefixes` or `AllowedPatterns`.
end
RUBY
end
Expand Down