rubocop-rspec 2.1.0 → 2.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +44 -0
- data/README.md +2 -2
- data/config/default.yml +36 -1
- data/lib/rubocop/cop/rspec/any_instance.rb +6 -10
- data/lib/rubocop/cop/rspec/around_block.rb +2 -0
- data/lib/rubocop/cop/rspec/be.rb +1 -0
- data/lib/rubocop/cop/rspec/be_eql.rb +2 -0
- data/lib/rubocop/cop/rspec/before_after_all.rb +3 -0
- data/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb +5 -0
- data/lib/rubocop/cop/rspec/capybara/feature_methods.rb +3 -0
- data/lib/rubocop/cop/rspec/capybara/visibility_matcher.rb +4 -0
- data/lib/rubocop/cop/rspec/context_method.rb +1 -0
- data/lib/rubocop/cop/rspec/context_wording.rb +7 -1
- data/lib/rubocop/cop/rspec/describe_class.rb +3 -0
- data/lib/rubocop/cop/rspec/describe_method.rb +1 -0
- data/lib/rubocop/cop/rspec/describe_symbol.rb +2 -0
- data/lib/rubocop/cop/rspec/described_class.rb +6 -1
- data/lib/rubocop/cop/rspec/described_class_module_wrapping.rb +2 -1
- data/lib/rubocop/cop/rspec/dialect.rb +1 -0
- data/lib/rubocop/cop/rspec/empty_hook.rb +5 -1
- data/lib/rubocop/cop/rspec/example_length.rb +26 -12
- data/lib/rubocop/cop/rspec/example_without_description.rb +1 -0
- data/lib/rubocop/cop/rspec/example_wording.rb +1 -0
- data/lib/rubocop/cop/rspec/excessive_docstring_spacing.rb +96 -0
- data/lib/rubocop/cop/rspec/expect_actual.rb +1 -0
- data/lib/rubocop/cop/rspec/expect_change.rb +6 -3
- data/lib/rubocop/cop/rspec/expect_in_hook.rb +1 -0
- data/lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb +3 -0
- data/lib/rubocop/cop/rspec/factory_bot/create_list.rb +4 -0
- data/lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb +2 -0
- data/lib/rubocop/cop/rspec/file_path.rb +13 -9
- data/lib/rubocop/cop/rspec/focus.rb +3 -0
- data/lib/rubocop/cop/rspec/hook_argument.rb +3 -1
- data/lib/rubocop/cop/rspec/hooks_before_examples.rb +1 -0
- data/lib/rubocop/cop/rspec/identical_equality_assertion.rb +38 -0
- data/lib/rubocop/cop/rspec/implicit_block_expectation.rb +4 -0
- data/lib/rubocop/cop/rspec/implicit_expect.rb +1 -0
- data/lib/rubocop/cop/rspec/implicit_subject.rb +19 -1
- data/lib/rubocop/cop/rspec/instance_spy.rb +2 -0
- data/lib/rubocop/cop/rspec/instance_variable.rb +4 -0
- data/lib/rubocop/cop/rspec/it_behaves_like.rb +2 -0
- data/lib/rubocop/cop/rspec/iterated_expectation.rb +4 -0
- data/lib/rubocop/cop/rspec/let_before_examples.rb +1 -0
- data/lib/rubocop/cop/rspec/let_setup.rb +3 -0
- data/lib/rubocop/cop/rspec/message_chain.rb +4 -10
- data/lib/rubocop/cop/rspec/message_expectation.rb +3 -0
- data/lib/rubocop/cop/rspec/message_spies.rb +2 -0
- data/lib/rubocop/cop/rspec/mixin/comments_help.rb +38 -0
- data/lib/rubocop/cop/rspec/mixin/variable.rb +1 -0
- data/lib/rubocop/cop/rspec/multiple_expectations.rb +3 -0
- data/lib/rubocop/cop/rspec/named_subject.rb +3 -0
- data/lib/rubocop/cop/rspec/nested_groups.rb +1 -1
- data/lib/rubocop/cop/rspec/not_to_not.rb +2 -0
- data/lib/rubocop/cop/rspec/overwriting_setup.rb +2 -0
- data/lib/rubocop/cop/rspec/pending.rb +4 -0
- data/lib/rubocop/cop/rspec/predicate_matcher.rb +5 -0
- data/lib/rubocop/cop/rspec/rails/avoid_setup_hook.rb +44 -0
- data/lib/rubocop/cop/rspec/rails/http_status.rb +2 -0
- data/lib/rubocop/cop/rspec/receive_counts.rb +4 -0
- data/lib/rubocop/cop/rspec/receive_never.rb +2 -0
- data/lib/rubocop/cop/rspec/repeated_example_group_body.rb +8 -1
- data/lib/rubocop/cop/rspec/repeated_example_group_description.rb +4 -0
- data/lib/rubocop/cop/rspec/repeated_include_example.rb +3 -0
- data/lib/rubocop/cop/rspec/return_from_stub.rb +6 -0
- data/lib/rubocop/cop/rspec/shared_context.rb +4 -0
- data/lib/rubocop/cop/rspec/shared_examples.rb +1 -0
- data/lib/rubocop/cop/rspec/single_argument_message_chain.rb +3 -0
- data/lib/rubocop/cop/rspec/stubbed_mock.rb +1 -0
- data/lib/rubocop/cop/rspec/subject_declaration.rb +47 -0
- data/lib/rubocop/cop/rspec/subject_stub.rb +1 -0
- data/lib/rubocop/cop/rspec/unspecified_exception.rb +2 -0
- data/lib/rubocop/cop/rspec/verified_doubles.rb +2 -0
- data/lib/rubocop/cop/rspec/void_expect.rb +3 -0
- data/lib/rubocop/cop/rspec/yield.rb +3 -0
- data/lib/rubocop/cop/rspec_cops.rb +4 -0
- data/lib/rubocop/rspec/corrector/move_node.rb +6 -9
- data/lib/rubocop/rspec/example.rb +5 -0
- data/lib/rubocop/rspec/hook.rb +1 -0
- data/lib/rubocop/rspec/language.rb +10 -0
- data/lib/rubocop/rspec/version.rb +1 -1
- data/lib/rubocop-rspec.rb +1 -0
- metadata +30 -25
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 22b3b217241494fa4c167f2e15e07a19d360d5807d0278d58b0a5504c9268b8d
|
4
|
+
data.tar.gz: 9111683fcaefd7c78675ce0549fa7e2a6a0c06a1b41e99b98472bd92b7459d03
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4276ab19bc2cbaad8649d0380b77be083d3afb21397ea63614b1a6275fc47b615c1f418d3ebbdf44e4bd674d3d663c896d74863798a1c2b208d06d5ac248e777
|
7
|
+
data.tar.gz: 0b95a2233468bd4cd06596fe0a7c37d1f36e9481815cda16aa287eb8d479274e0aac813ceb2eede688853506fb023e7e469292713e4288271049573536ccbe94
|
data/CHANGELOG.md
CHANGED
@@ -2,6 +2,39 @@
|
|
2
2
|
|
3
3
|
## Master (Unreleased)
|
4
4
|
|
5
|
+
## 2.5.0 (2021-09-21)
|
6
|
+
|
7
|
+
* Declare autocorrect as unsafe for `ExpectChange`. ([@francois-ferrandis][])
|
8
|
+
* Fix each example for `RSpec/HookArgument`. ([@lokhi][])
|
9
|
+
* Exclude unrelated Rails directories from `RSpec/DescribeClass`. ([@MothOnMars][])
|
10
|
+
* Add `RSpec/ExcessiveDocstringSpacing` cop. ([@G-Rath][])
|
11
|
+
* Add `RSpec/SubjectDeclaration` cop. ([@dswij][])
|
12
|
+
* Fix excessive whitespace removal in `RSpec/EmptyHook` autocorrection. ([@pirj][])
|
13
|
+
* Bump RuboCop requirement to v1.19.0. ([@pirj][])
|
14
|
+
* Fix false positive in `RSpec/IteratedExpectation` when there is single, non-expectation statement in the block body. ([@Darhazer][])
|
15
|
+
|
16
|
+
## 2.4.0 (2021-06-09)
|
17
|
+
|
18
|
+
* Update `RSpec/FilePath` to check suffix when given a non-constant top-level node (e.g. features). ([@topalovic][])
|
19
|
+
* Add missing documentation for `single_statement_only` style of `RSpec/ImplicitSubject` cop. ([@tejasbubane][])
|
20
|
+
* Fix an exception in `DescribedClass` when accessing a constant on a variable in a spec that is nested in a namespace. ([@rrosenblum][])
|
21
|
+
* Add new `RSpec/IdenticalEqualityAssertion` cop. ([@tejasbubane][])
|
22
|
+
* Add `RSpec/Rails/AvoidSetupHook` cop. ([@paydaylight][])
|
23
|
+
* Fix false negative in `RSpec/ExpectChange` cop with block style and chained method call. ([@tejasbubane][])
|
24
|
+
|
25
|
+
## 2.3.0 (2021-04-28)
|
26
|
+
|
27
|
+
* Allow `RSpec/ContextWording` to accept multi-word prefixes. ([@hosamaly][])
|
28
|
+
* Drop support for ruby 2.4. ([@bquorning][])
|
29
|
+
* Add `CountAsOne` configuration option to `RSpec/ExampleLength`. ([@stephannv][])
|
30
|
+
* Fix a false positive for `RSpec/RepeatedExampleGroupBody` when `pending` or `skip` have argument(s). ([@Tietew][])
|
31
|
+
|
32
|
+
## 2.2.0 (2021-02-02)
|
33
|
+
|
34
|
+
* Fix `HooksBeforeExamples`, `LeadingSubject`, `LetBeforeExamples` and `ScatteredLet` autocorrection to take into account inline comments and comments immediately before the moved node. ([@Darhazer][])
|
35
|
+
* Improve rubocop-rspec performance. ([@Darhazer][], [@bquorning][])
|
36
|
+
* Include `Enabled: true` to prevent a mismatched configuration parameter warning when `RSpec` cops are explicitly enabled in the user configuration. ([@pirj][])
|
37
|
+
|
5
38
|
## 2.1.0 (2020-12-17)
|
6
39
|
|
7
40
|
* Fix `RSpec/FilePath` false positive for relative file path runs with long namespaces. ([@ahukkanen][])
|
@@ -597,3 +630,14 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
|
|
597
630
|
[@sl4vr]: https://github.com/sl4vr
|
598
631
|
[@ahukkanen]: https://github.com/ahukkanen
|
599
632
|
[@dvandersluis]: https://github.com/dvandersluis
|
633
|
+
[@hosamaly]: https://github.com/hosamaly
|
634
|
+
[@stephannv]: https://github.com/stephannv
|
635
|
+
[@Tietew]: https://github.com/Tietew
|
636
|
+
[@rrosenblum]: https://github.com/rrosenblum
|
637
|
+
[@paydaylight]: https://github.com/paydaylight
|
638
|
+
[@topalovic]: https://github.com/topalovic
|
639
|
+
[@lokhi]: https://github.com/lokhi
|
640
|
+
[@MothOnMars]: https://github.com/MothOnMars
|
641
|
+
[@G-Rath]: https://github.com/G-Rath
|
642
|
+
[@dswij]: https://github.com/dswij
|
643
|
+
[@francois-ferrandis]: https://github.com/francois-ferrandis
|
data/README.md
CHANGED
@@ -2,12 +2,12 @@
|
|
2
2
|
|
3
3
|
[![Join the chat at https://gitter.im/rubocop-rspec/Lobby](https://badges.gitter.im/rubocop-rspec/Lobby.svg)](https://gitter.im/rubocop-rspec/Lobby)
|
4
4
|
[![Gem Version](https://badge.fury.io/rb/rubocop-rspec.svg)](https://rubygems.org/gems/rubocop-rspec)
|
5
|
-
[![CircleCI](https://circleci.com/gh/rubocop
|
5
|
+
[![CircleCI](https://circleci.com/gh/rubocop/rubocop-rspec.svg?style=svg)](https://circleci.com/gh/rubocop/rubocop-rspec)
|
6
6
|
[![Test Coverage](https://api.codeclimate.com/v1/badges/8ffaabf633c968c22bdd/test_coverage)](https://codeclimate.com/github/rubocop-hq/rubocop-rspec/test_coverage)
|
7
7
|
[![Maintainability](https://api.codeclimate.com/v1/badges/8ffaabf633c968c22bdd/maintainability)](https://codeclimate.com/github/rubocop-hq/rubocop-rspec/maintainability)
|
8
8
|
|
9
9
|
RSpec-specific analysis for your projects, as an extension to
|
10
|
-
[RuboCop](https://github.com/rubocop
|
10
|
+
[RuboCop](https://github.com/rubocop/rubocop).
|
11
11
|
|
12
12
|
## Installation
|
13
13
|
|
data/config/default.yml
CHANGED
@@ -1,5 +1,6 @@
|
|
1
1
|
---
|
2
2
|
RSpec:
|
3
|
+
Enabled: true
|
3
4
|
Include:
|
4
5
|
- "**/*_spec.rb"
|
5
6
|
- "**/spec/**/*"
|
@@ -147,6 +148,12 @@ RSpec/ContextWording:
|
|
147
148
|
RSpec/DescribeClass:
|
148
149
|
Description: Check that the first argument to the top-level describe is a constant.
|
149
150
|
Enabled: true
|
151
|
+
Exclude:
|
152
|
+
- "**/spec/features/**/*"
|
153
|
+
- "**/spec/requests/**/*"
|
154
|
+
- "**/spec/routing/**/*"
|
155
|
+
- "**/spec/system/**/*"
|
156
|
+
- "**/spec/views/**/*"
|
150
157
|
IgnoredMetadata:
|
151
158
|
type:
|
152
159
|
- channel
|
@@ -163,7 +170,7 @@ RSpec/DescribeClass:
|
|
163
170
|
- mailbox
|
164
171
|
- aruba
|
165
172
|
VersionAdded: '1.0'
|
166
|
-
VersionChanged: '
|
173
|
+
VersionChanged: '2.5'
|
167
174
|
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribeClass
|
168
175
|
|
169
176
|
RSpec/DescribeMethod:
|
@@ -252,7 +259,9 @@ RSpec/ExampleLength:
|
|
252
259
|
Description: Checks for long examples.
|
253
260
|
Enabled: true
|
254
261
|
Max: 5
|
262
|
+
CountAsOne: []
|
255
263
|
VersionAdded: '1.5'
|
264
|
+
VersionChanged: '2.3'
|
256
265
|
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleLength
|
257
266
|
|
258
267
|
RSpec/ExampleWithoutDescription:
|
@@ -266,6 +275,12 @@ RSpec/ExampleWithoutDescription:
|
|
266
275
|
VersionAdded: '1.22'
|
267
276
|
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleWithoutDescription
|
268
277
|
|
278
|
+
RSpec/ExcessiveDocstringSpacing:
|
279
|
+
Description: Checks for excessive whitespace in example descriptions.
|
280
|
+
Enabled: pending
|
281
|
+
VersionAdded: '2.5'
|
282
|
+
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExcessiveDocstringSpacing
|
283
|
+
|
269
284
|
RSpec/ExampleWording:
|
270
285
|
Description: Checks for common mistakes in example descriptions.
|
271
286
|
Enabled: true
|
@@ -294,7 +309,9 @@ RSpec/ExpectChange:
|
|
294
309
|
SupportedStyles:
|
295
310
|
- method_call
|
296
311
|
- block
|
312
|
+
SafeAutoCorrect: false
|
297
313
|
VersionAdded: '1.22'
|
314
|
+
VersionChanged: '2.5'
|
298
315
|
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectChange
|
299
316
|
|
300
317
|
RSpec/ExpectInHook:
|
@@ -348,6 +365,12 @@ RSpec/HooksBeforeExamples:
|
|
348
365
|
VersionAdded: '1.29'
|
349
366
|
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/HooksBeforeExamples
|
350
367
|
|
368
|
+
RSpec/IdenticalEqualityAssertion:
|
369
|
+
Description: Checks for equality assertions with identical expressions on both sides.
|
370
|
+
Enabled: pending
|
371
|
+
VersionAdded: '2.4'
|
372
|
+
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/IdenticalEqualityAssertion
|
373
|
+
|
351
374
|
RSpec/ImplicitBlockExpectation:
|
352
375
|
Description: Check that implicit block expectation syntax is not used.
|
353
376
|
Enabled: true
|
@@ -634,6 +657,12 @@ RSpec/StubbedMock:
|
|
634
657
|
VersionAdded: '1.44'
|
635
658
|
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/StubbedMock
|
636
659
|
|
660
|
+
RSpec/SubjectDeclaration:
|
661
|
+
Description: Ensure that subject is defined using subject helper.
|
662
|
+
Enabled: pending
|
663
|
+
VersionAdded: '2.5'
|
664
|
+
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SubjectDeclaration
|
665
|
+
|
637
666
|
RSpec/SubjectStub:
|
638
667
|
Description: Checks for stubbed test subjects.
|
639
668
|
Enabled: true
|
@@ -750,6 +779,12 @@ RSpec/FactoryBot/FactoryClassName:
|
|
750
779
|
VersionChanged: '2.0'
|
751
780
|
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/FactoryClassName
|
752
781
|
|
782
|
+
RSpec/Rails/AvoidSetupHook:
|
783
|
+
Description: Checks that tests use RSpec `before` hook over Rails `setup` method.
|
784
|
+
Enabled: pending
|
785
|
+
VersionAdded: '2.4'
|
786
|
+
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Rails/AvoidSetupHook
|
787
|
+
|
753
788
|
RSpec/Rails/HttpStatus:
|
754
789
|
Description: Enforces use of symbolic or numeric value to describe HTTP status.
|
755
790
|
Enabled: true
|
@@ -24,18 +24,14 @@ module RuboCop
|
|
24
24
|
# end
|
25
25
|
class AnyInstance < Base
|
26
26
|
MSG = 'Avoid stubbing using `%<method>s`.'
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
27
|
+
RESTRICT_ON_SEND = %i[
|
28
|
+
any_instance
|
29
|
+
allow_any_instance_of
|
30
|
+
expect_any_instance_of
|
31
|
+
].freeze
|
31
32
|
|
32
33
|
def on_send(node)
|
33
|
-
|
34
|
-
add_offense(
|
35
|
-
node,
|
36
|
-
message: format(MSG, method: method)
|
37
|
-
)
|
38
|
-
end
|
34
|
+
add_offense(node, message: format(MSG, method: node.method_name))
|
39
35
|
end
|
40
36
|
end
|
41
37
|
end
|
@@ -30,10 +30,12 @@ module RuboCop
|
|
30
30
|
MSG_UNUSED_ARG = 'You should call `%<arg>s.call` ' \
|
31
31
|
'or `%<arg>s.run`.'
|
32
32
|
|
33
|
+
# @!method hook(node)
|
33
34
|
def_node_matcher :hook, <<-PATTERN
|
34
35
|
(block (send nil? :around sym ?) (args $...) ...)
|
35
36
|
PATTERN
|
36
37
|
|
38
|
+
# @!method find_arg_usage(node)
|
37
39
|
def_node_search :find_arg_usage, <<-PATTERN
|
38
40
|
{(send $... {:call :run}) (send _ _ $...) (yield $...) (block-pass $...)}
|
39
41
|
PATTERN
|
data/lib/rubocop/cop/rspec/be.rb
CHANGED
@@ -39,7 +39,9 @@ module RuboCop
|
|
39
39
|
extend AutoCorrector
|
40
40
|
|
41
41
|
MSG = 'Prefer `be` over `eql`.'
|
42
|
+
RESTRICT_ON_SEND = %i[to].freeze
|
42
43
|
|
44
|
+
# @!method eql_type_with_identity(node)
|
43
45
|
def_node_matcher :eql_type_with_identity, <<-PATTERN
|
44
46
|
(send _ :to $(send nil? :eql {true false int float sym nil_type?}))
|
45
47
|
PATTERN
|
@@ -29,6 +29,9 @@ module RuboCop
|
|
29
29
|
'`use_transactional_fixtures` is enabled, then records created ' \
|
30
30
|
'in `%<hook>s` are not automatically rolled back.'
|
31
31
|
|
32
|
+
RESTRICT_ON_SEND = %i[before after].freeze
|
33
|
+
|
34
|
+
# @!method before_or_after_all(node)
|
32
35
|
def_node_matcher :before_or_after_all, <<-PATTERN
|
33
36
|
$(send _ {:before :after} (sym {:all :context}))
|
34
37
|
PATTERN
|
@@ -30,17 +30,22 @@ module RuboCop
|
|
30
30
|
'Capybara feature specs - instead, use the ' \
|
31
31
|
'`have_current_path` matcher on `page`'
|
32
32
|
|
33
|
+
RESTRICT_ON_SEND = %i[expect].freeze
|
34
|
+
|
35
|
+
# @!method expectation_set_on_current_path(node)
|
33
36
|
def_node_matcher :expectation_set_on_current_path, <<-PATTERN
|
34
37
|
(send nil? :expect (send {(send nil? :page) nil?} :current_path))
|
35
38
|
PATTERN
|
36
39
|
|
37
40
|
# Supported matchers: eq(...) / match(/regexp/) / match('regexp')
|
41
|
+
# @!method as_is_matcher(node)
|
38
42
|
def_node_matcher :as_is_matcher, <<-PATTERN
|
39
43
|
(send
|
40
44
|
#expectation_set_on_current_path $#Runners.all
|
41
45
|
${(send nil? :eq ...) (send nil? :match (regexp ...))})
|
42
46
|
PATTERN
|
43
47
|
|
48
|
+
# @!method regexp_str_matcher(node)
|
44
49
|
def_node_matcher :regexp_str_matcher, <<-PATTERN
|
45
50
|
(send
|
46
51
|
#expectation_set_on_current_path $#Runners.all
|
@@ -55,16 +55,19 @@ module RuboCop
|
|
55
55
|
feature: :describe
|
56
56
|
}.freeze
|
57
57
|
|
58
|
+
# @!method capybara_speak(node)
|
58
59
|
def_node_matcher :capybara_speak, <<-PATTERN
|
59
60
|
{#{MAP.keys.map(&:inspect).join(' ')}}
|
60
61
|
PATTERN
|
61
62
|
|
63
|
+
# @!method spec?(node)
|
62
64
|
def_node_matcher :spec?, <<-PATTERN
|
63
65
|
(block
|
64
66
|
(send #rspec? {:describe :feature} ...)
|
65
67
|
...)
|
66
68
|
PATTERN
|
67
69
|
|
70
|
+
# @!method feature_method(node)
|
68
71
|
def_node_matcher :feature_method, <<-PATTERN
|
69
72
|
(block
|
70
73
|
$(send #rspec? $#capybara_speak ...)
|
@@ -44,10 +44,14 @@ module RuboCop
|
|
44
44
|
have_content
|
45
45
|
].freeze
|
46
46
|
|
47
|
+
RESTRICT_ON_SEND = CAPYBARA_MATCHER_METHODS
|
48
|
+
|
49
|
+
# @!method visible_true?(node)
|
47
50
|
def_node_matcher :visible_true?, <<~PATTERN
|
48
51
|
(send nil? #capybara_matcher? ... (hash <$(pair (sym :visible) true) ...>))
|
49
52
|
PATTERN
|
50
53
|
|
54
|
+
# @!method visible_false?(node)
|
51
55
|
def_node_matcher :visible_false?, <<~PATTERN
|
52
56
|
(send nil? #capybara_matcher? ... (hash <$(pair (sym :visible) false) ...>))
|
53
57
|
PATTERN
|
@@ -8,6 +8,7 @@ module RuboCop
|
|
8
8
|
# The default list of prefixes is minimal. Users are encouraged to tailor
|
9
9
|
# the configuration to meet project needs. Other acceptable prefixes may
|
10
10
|
# include `if`, `unless`, `for`, `before`, `after`, or `during`.
|
11
|
+
# They may consist of multiple words if desired.
|
11
12
|
#
|
12
13
|
# @see https://rspec.rubystyle.guide/#context-descriptions
|
13
14
|
# @see http://www.betterspecs.org/#contexts
|
@@ -37,6 +38,7 @@ module RuboCop
|
|
37
38
|
class ContextWording < Base
|
38
39
|
MSG = 'Start context description with %<prefixes>s.'
|
39
40
|
|
41
|
+
# @!method context_wording(node)
|
40
42
|
def_node_matcher :context_wording, <<-PATTERN
|
41
43
|
(block (send #rspec? { :context :shared_context } $(str #bad_prefix?) ...) ...)
|
42
44
|
PATTERN
|
@@ -51,7 +53,7 @@ module RuboCop
|
|
51
53
|
private
|
52
54
|
|
53
55
|
def bad_prefix?(description)
|
54
|
-
!
|
56
|
+
!prefix_regex.match?(description)
|
55
57
|
end
|
56
58
|
|
57
59
|
def joined_prefixes
|
@@ -65,6 +67,10 @@ module RuboCop
|
|
65
67
|
def prefixes
|
66
68
|
cop_config['Prefixes'] || []
|
67
69
|
end
|
70
|
+
|
71
|
+
def prefix_regex
|
72
|
+
/^#{Regexp.union(prefixes)}\b/
|
73
|
+
end
|
68
74
|
end
|
69
75
|
end
|
70
76
|
end
|
@@ -40,14 +40,17 @@ module RuboCop
|
|
40
40
|
MSG = 'The first argument to describe should be ' \
|
41
41
|
'the class or module being tested.'
|
42
42
|
|
43
|
+
# @!method example_group_with_ignored_metadata?(node)
|
43
44
|
def_node_matcher :example_group_with_ignored_metadata?, <<~PATTERN
|
44
45
|
(send #rspec? :describe ... (hash <#ignored_metadata? ...>))
|
45
46
|
PATTERN
|
46
47
|
|
48
|
+
# @!method not_a_const_described(node)
|
47
49
|
def_node_matcher :not_a_const_described, <<~PATTERN
|
48
50
|
(send #rspec? :describe $[!const !#string_constant?] ...)
|
49
51
|
PATTERN
|
50
52
|
|
53
|
+
# @!method sym_pair(node)
|
51
54
|
def_node_matcher :sym_pair, <<~PATTERN
|
52
55
|
(pair $sym $sym)
|
53
56
|
PATTERN
|
@@ -22,6 +22,7 @@ module RuboCop
|
|
22
22
|
MSG = 'The second argument to describe should be the method ' \
|
23
23
|
"being tested. '#instance' or '.class'."
|
24
24
|
|
25
|
+
# @!method second_argument(node)
|
25
26
|
def_node_matcher :second_argument, <<~PATTERN
|
26
27
|
(block
|
27
28
|
(send #rspec? :describe _first_argument $(str _) ...) ...
|
@@ -19,7 +19,9 @@ module RuboCop
|
|
19
19
|
# @see https://github.com/rspec/rspec-core/issues/1610
|
20
20
|
class DescribeSymbol < Base
|
21
21
|
MSG = 'Avoid describing symbols.'
|
22
|
+
RESTRICT_ON_SEND = %i[describe].freeze
|
22
23
|
|
24
|
+
# @!method describe_symbol?(node)
|
23
25
|
def_node_matcher :describe_symbol?, <<-PATTERN
|
24
26
|
(send #rspec? :describe $sym ...)
|
25
27
|
PATTERN
|
@@ -61,18 +61,23 @@ module RuboCop
|
|
61
61
|
DESCRIBED_CLASS = 'described_class'
|
62
62
|
MSG = 'Use `%<replacement>s` instead of `%<src>s`.'
|
63
63
|
|
64
|
+
# @!method common_instance_exec_closure?(node)
|
64
65
|
def_node_matcher :common_instance_exec_closure?, <<-PATTERN
|
65
66
|
(block (send (const nil? {:Class :Module :Struct}) :new ...) ...)
|
66
67
|
PATTERN
|
67
68
|
|
69
|
+
# @!method rspec_block?(node)
|
68
70
|
def_node_matcher :rspec_block?, block_pattern('#ALL.all')
|
69
71
|
|
72
|
+
# @!method scope_changing_syntax?(node)
|
70
73
|
def_node_matcher :scope_changing_syntax?, '{def class module}'
|
71
74
|
|
75
|
+
# @!method described_constant(node)
|
72
76
|
def_node_matcher :described_constant, <<-PATTERN
|
73
77
|
(block (send _ :describe $(const ...) ...) (args) $_)
|
74
78
|
PATTERN
|
75
79
|
|
80
|
+
# @!method contains_described_class?(node)
|
76
81
|
def_node_search :contains_described_class?, <<-PATTERN
|
77
82
|
(send nil? :described_class)
|
78
83
|
PATTERN
|
@@ -198,7 +203,7 @@ module RuboCop
|
|
198
203
|
[name]
|
199
204
|
elsif namespace.const_type?
|
200
205
|
[*const_name(namespace), name]
|
201
|
-
elsif
|
206
|
+
elsif %i[lvar cbase send].include?(namespace.type)
|
202
207
|
[nil, name]
|
203
208
|
end
|
204
209
|
end
|
@@ -18,10 +18,11 @@ module RuboCop
|
|
18
18
|
# # ...
|
19
19
|
# end
|
20
20
|
#
|
21
|
-
# @see https://github.com/rubocop
|
21
|
+
# @see https://github.com/rubocop/rubocop-rspec/issues/735
|
22
22
|
class DescribedClassModuleWrapping < Base
|
23
23
|
MSG = 'Avoid opening modules and defining specs within them.'
|
24
24
|
|
25
|
+
# @!method find_rspec_blocks(node)
|
25
26
|
def_node_search :find_rspec_blocks, block_pattern('#ExampleGroups.all')
|
26
27
|
|
27
28
|
def on_module(node)
|
@@ -28,6 +28,7 @@ module RuboCop
|
|
28
28
|
|
29
29
|
MSG = 'Empty hook detected.'
|
30
30
|
|
31
|
+
# @!method empty_hook?(node)
|
31
32
|
def_node_matcher :empty_hook?, <<~PATTERN
|
32
33
|
(block $#{send_pattern('#Hooks.all')} _ nil?)
|
33
34
|
PATTERN
|
@@ -35,7 +36,10 @@ module RuboCop
|
|
35
36
|
def on_block(node)
|
36
37
|
empty_hook?(node) do |hook|
|
37
38
|
add_offense(hook) do |corrector|
|
38
|
-
range = range_with_surrounding_space(
|
39
|
+
range = range_with_surrounding_space(
|
40
|
+
range: node.loc.expression,
|
41
|
+
side: :left
|
42
|
+
)
|
39
43
|
corrector.remove(range)
|
40
44
|
end
|
41
45
|
end
|
@@ -25,29 +25,43 @@ module RuboCop
|
|
25
25
|
# result = service.call
|
26
26
|
# expect(result).to be(true)
|
27
27
|
# end
|
28
|
+
#
|
29
|
+
# You can set literals you want to fold with `CountAsOne`.
|
30
|
+
# Available are: 'array', 'hash', and 'heredoc'. Each literal
|
31
|
+
# will be counted as one line regardless of its actual size.
|
32
|
+
#
|
33
|
+
# @example CountAsOne: ['array', 'heredoc']
|
34
|
+
#
|
35
|
+
# it do
|
36
|
+
# array = [ # +1
|
37
|
+
# 1,
|
38
|
+
# 2
|
39
|
+
# ]
|
40
|
+
#
|
41
|
+
# hash = { # +3
|
42
|
+
# key: 'value'
|
43
|
+
# }
|
44
|
+
#
|
45
|
+
# msg = <<~HEREDOC # +1
|
46
|
+
# Heredoc
|
47
|
+
# content.
|
48
|
+
# HEREDOC
|
49
|
+
# end # 5 points
|
28
50
|
class ExampleLength < Base
|
29
51
|
include CodeLength
|
30
52
|
|
31
|
-
|
53
|
+
LABEL = 'Example'
|
32
54
|
|
33
55
|
def on_block(node)
|
34
56
|
return unless example?(node)
|
35
57
|
|
36
|
-
|
37
|
-
|
38
|
-
return unless length > max_length
|
39
|
-
|
40
|
-
add_offense(node, message: message(length))
|
58
|
+
check_code_length(node)
|
41
59
|
end
|
42
60
|
|
43
61
|
private
|
44
62
|
|
45
|
-
def
|
46
|
-
|
47
|
-
end
|
48
|
-
|
49
|
-
def message(length)
|
50
|
-
format(MSG, total: length, max: max_length)
|
63
|
+
def cop_label
|
64
|
+
LABEL
|
51
65
|
end
|
52
66
|
end
|
53
67
|
end
|
@@ -0,0 +1,96 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module RuboCop
|
4
|
+
module Cop
|
5
|
+
module RSpec
|
6
|
+
# Checks for excessive whitespace in example descriptions.
|
7
|
+
#
|
8
|
+
# @example
|
9
|
+
# # bad
|
10
|
+
# it ' has excessive spacing ' do
|
11
|
+
# end
|
12
|
+
#
|
13
|
+
# # good
|
14
|
+
# it 'has excessive spacing' do
|
15
|
+
# end
|
16
|
+
#
|
17
|
+
# @example
|
18
|
+
# # bad
|
19
|
+
# context ' when a condition is met ' do
|
20
|
+
# end
|
21
|
+
#
|
22
|
+
# # good
|
23
|
+
# context 'when a condition is met' do
|
24
|
+
# end
|
25
|
+
class ExcessiveDocstringSpacing < Base
|
26
|
+
extend AutoCorrector
|
27
|
+
|
28
|
+
MSG = 'Excessive whitespace.'
|
29
|
+
|
30
|
+
# @!method example_description(node)
|
31
|
+
def_node_matcher :example_description, <<-PATTERN
|
32
|
+
(send _ {#Examples.all #ExampleGroups.all} ${
|
33
|
+
$str
|
34
|
+
$(dstr ({str dstr `sym} ...) ...)
|
35
|
+
} ...)
|
36
|
+
PATTERN
|
37
|
+
|
38
|
+
def on_send(node)
|
39
|
+
example_description(node) do |description_node, message|
|
40
|
+
text = text(message)
|
41
|
+
|
42
|
+
return unless excessive_whitespace?(text)
|
43
|
+
|
44
|
+
add_whitespace_offense(description_node, text)
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
private
|
49
|
+
|
50
|
+
# @param text [String]
|
51
|
+
def excessive_whitespace?(text)
|
52
|
+
text.start_with?(' ') || text.include?(' ') || text.end_with?(' ')
|
53
|
+
end
|
54
|
+
|
55
|
+
# @param text [String]
|
56
|
+
def strip_excessive_whitespace(text)
|
57
|
+
text.strip.gsub(/ +/, ' ')
|
58
|
+
end
|
59
|
+
|
60
|
+
# @param node [RuboCop::AST::Node]
|
61
|
+
# @param text [String]
|
62
|
+
def add_whitespace_offense(node, text)
|
63
|
+
docstring = docstring(node)
|
64
|
+
corrected = strip_excessive_whitespace(text)
|
65
|
+
|
66
|
+
add_offense(docstring) do |corrector|
|
67
|
+
corrector.replace(docstring, corrected)
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
def docstring(node)
|
72
|
+
expr = node.loc.expression
|
73
|
+
|
74
|
+
Parser::Source::Range.new(
|
75
|
+
expr.source_buffer,
|
76
|
+
expr.begin_pos + 1,
|
77
|
+
expr.end_pos - 1
|
78
|
+
)
|
79
|
+
end
|
80
|
+
|
81
|
+
# Recursive processing is required to process nested dstr nodes
|
82
|
+
# that is the case for \-separated multiline strings with interpolation.
|
83
|
+
def text(node)
|
84
|
+
case node.type
|
85
|
+
when :dstr
|
86
|
+
node.node_parts.map { |child_node| text(child_node) }.join
|
87
|
+
when :str, :sym
|
88
|
+
node.value
|
89
|
+
when :begin
|
90
|
+
node.source
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|