rubocop-rspec 2.2.0 → 2.3.0

data/lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb

@@ -27,6 +27,7 @@ module RuboCop
           ALLOWED_CONSTANTS = %w[Hash OpenStruct].freeze
           RESTRICT_ON_SEND = %i[factory].freeze
 
+          # @!method class_name(node)
           def_node_matcher :class_name, <<~PATTERN
             (send _ :factory _ (hash <(pair (sym :class) $(const ...)) ...>))
           PATTERN

data/lib/rubocop/cop/rspec/file_path.rb

@@ -61,12 +61,14 @@ module RuboCop
 
         MSG = 'Spec path should end with `%<suffix>s`.'
 
+        # @!method const_described(node)
         def_node_matcher :const_described, <<~PATTERN
           (block
             $(send #rspec? _example_group $(const ...) $...) ...
           )
         PATTERN
 
+        # @!method routing_metadata?(node)
         def_node_search :routing_metadata?, '(pair (sym :type) (sym :routing))'
 
         def on_top_level_example_group(node)

data/lib/rubocop/cop/rspec/focus.rb

@@ -25,6 +25,7 @@ module RuboCop
 
         MSG = 'Focused spec found.'
 
+        # @!method focusable_selector?(node)
         def_node_matcher :focusable_selector?, <<-PATTERN
           {
             #ExampleGroups.regular
@@ -35,11 +36,13 @@ module RuboCop
           }
         PATTERN
 
+        # @!method metadata(node)
         def_node_matcher :metadata, <<-PATTERN
           {(send #rspec? #focusable_selector? <$(sym :focus) ...>)
            (send #rspec? #focusable_selector? ... (hash <$(pair (sym :focus) true) ...>))}
         PATTERN
 
+        # @!method focused_block?(node)
         def_node_matcher :focused_block?,
                          send_pattern(<<~PATTERN)
                            {#ExampleGroups.focused #Examples.focused}

data/lib/rubocop/cop/rspec/hook_argument.rb

@@ -64,10 +64,12 @@ module RuboCop
         IMPLICIT_MSG = 'Omit the default `%<scope>p` argument for RSpec hooks.'
         EXPLICIT_MSG = 'Use `%<scope>p` for RSpec hooks.'
 
+        # @!method scoped_hook(node)
         def_node_matcher :scoped_hook, <<-PATTERN
           (block $(send _ #Hooks.all (sym ${:each :example})) ...)
         PATTERN
 
+        # @!method unscoped_hook(node)
         def_node_matcher :unscoped_hook, '(block $(send _ #Hooks.all) ...)'
 
         def on_block(node)

data/lib/rubocop/cop/rspec/hooks_before_examples.rb

@@ -28,6 +28,7 @@ module RuboCop
 
         MSG = 'Move `%<hook>s` above the examples in the group.'
 
+        # @!method example_or_group?(node)
         def_node_matcher :example_or_group?, <<-PATTERN
           {
             #{block_pattern('{#ExampleGroups.all #Examples.all}')}

data/lib/rubocop/cop/rspec/implicit_block_expectation.rb

@@ -20,6 +20,7 @@ module RuboCop
         MSG = 'Avoid implicit block expectations.'
         RESTRICT_ON_SEND = %i[is_expected should should_not].freeze
 
+        # @!method lambda?(node)
         def_node_matcher :lambda?, <<-PATTERN
           {
             (send (const nil? :Proc) :new)
@@ -27,8 +28,10 @@ module RuboCop
           }
         PATTERN
 
+        # @!method lambda_subject?(node)
         def_node_matcher :lambda_subject?, '(block #lambda? ...)'
 
+        # @!method implicit_expect(node)
         def_node_matcher :implicit_expect, <<-PATTERN
           $(send nil? {:is_expected :should :should_not} ...)
         PATTERN

data/lib/rubocop/cop/rspec/implicit_expect.rb

@@ -30,6 +30,7 @@ module RuboCop
 
         MSG = 'Prefer `%<good>s` over `%<bad>s`.'
 
+        # @!method implicit_expect(node)
         def_node_matcher :implicit_expect, <<-PATTERN
           {
             (send nil? ${:should :should_not} ...)

data/lib/rubocop/cop/rspec/implicit_subject.rb

@@ -33,6 +33,7 @@ module RuboCop
         MSG = "Don't use implicit subject."
         RESTRICT_ON_SEND = %i[is_expected should should_not].freeze
 
+        # @!method implicit_subject?(node)
         def_node_matcher :implicit_subject?, <<-PATTERN
           (send nil? {:should :should_not :is_expected} ...)
         PATTERN

data/lib/rubocop/cop/rspec/instance_spy.rb

@@ -24,6 +24,7 @@ module RuboCop
         MSG = 'Use `instance_spy` when you check your double ' \
               'with `have_received`.'
 
+        # @!method null_double(node)
         def_node_search :null_double, <<-PATTERN
           (lvasgn $_
             (send
@@ -31,6 +32,7 @@ module RuboCop
                 ...) :as_null_object))
         PATTERN
 
+        # @!method have_received_usage(node)
         def_node_search :have_received_usage, <<-PATTERN
           (send
             (send nil? :expect

data/lib/rubocop/cop/rspec/instance_variable.rb

@@ -52,10 +52,12 @@ module RuboCop
         MSG = 'Avoid instance variables – use let, ' \
               'a method call, or a local variable (if possible).'
 
+        # @!method dynamic_class?(node)
         def_node_matcher :dynamic_class?, <<-PATTERN
           (block (send (const nil? :Class) :new ...) ...)
         PATTERN
 
+        # @!method custom_matcher?(node)
         def_node_matcher :custom_matcher?, <<-PATTERN
           (block {
             (send nil? :matcher sym)
@@ -63,8 +65,10 @@ module RuboCop
           } ...)
         PATTERN
 
+        # @!method ivar_usage(node)
         def_node_search :ivar_usage, '$(ivar $_)'
 
+        # @!method ivar_assigned?(node)
         def_node_search :ivar_assigned?, '(ivasgn % ...)'
 
         def on_top_level_group(node)

data/lib/rubocop/cop/rspec/it_behaves_like.rb

@@ -26,6 +26,7 @@ module RuboCop
               'examples in a nested context.'
         RESTRICT_ON_SEND = %i[it_behaves_like it_should_behave_like].freeze
 
+        # @!method example_inclusion_offense(node)
         def_node_matcher :example_inclusion_offense, '(send _ % ...)'
 
         def on_send(node)

data/lib/rubocop/cop/rspec/iterated_expectation.rb

@@ -19,6 +19,7 @@ module RuboCop
         MSG = 'Prefer using the `all` matcher instead ' \
               'of iterating over an array.'
 
+        # @!method each?(node)
         def_node_matcher :each?, <<-PATTERN
           (block
             (send ... :each)
@@ -27,6 +28,7 @@ module RuboCop
           )
         PATTERN
 
+        # @!method expectation?(node)
         def_node_matcher :expectation?, <<-PATTERN
           (send (send nil? :expect (lvar %)) :to ...)
         PATTERN

data/lib/rubocop/cop/rspec/let_before_examples.rb

@@ -35,6 +35,7 @@ module RuboCop
 
         MSG = 'Move `let` before the examples in the group.'
 
+        # @!method example_or_group?(node)
         def_node_matcher :example_or_group?, <<-PATTERN
           {
             #{block_pattern('{#ExampleGroups.all #Examples.all}')}

data/lib/rubocop/cop/rspec/let_setup.rb

@@ -28,6 +28,7 @@ module RuboCop
       class LetSetup < Base
         MSG = 'Do not use `let!` to setup objects not referenced in tests.'
 
+        # @!method example_or_shared_group_or_including?(node)
         def_node_matcher :example_or_shared_group_or_including?,
                          block_pattern(<<~PATTERN)
                            {
@@ -37,6 +38,7 @@ module RuboCop
                            }
                          PATTERN
 
+        # @!method let_bang(node)
         def_node_matcher :let_bang, <<-PATTERN
           {
             (block $(send nil? :let! {(sym $_) (str $_)}) ...)
@@ -44,6 +46,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method method_called?(node)
         def_node_search :method_called?, '(send nil? %)'
 
         def on_block(node)

data/lib/rubocop/cop/rspec/message_expectation.rb

@@ -32,10 +32,12 @@ module RuboCop
         SUPPORTED_STYLES = %w[allow expect].freeze
         RESTRICT_ON_SEND = %i[to].freeze
 
+        # @!method message_expectation(node)
         def_node_matcher :message_expectation, <<-PATTERN
           (send $(send nil? {:expect :allow} ...) :to #receive_message?)
         PATTERN
 
+        # @!method receive_message?(node)
         def_node_search :receive_message?, '(send nil? :receive ...)'
 
         def on_send(node)

data/lib/rubocop/cop/rspec/message_spies.rb

@@ -35,10 +35,12 @@ module RuboCop
 
         SUPPORTED_STYLES = %w[have_received receive].freeze
 
+        # @!method message_expectation(node)
         def_node_matcher :message_expectation, %(
           (send (send nil? :expect $_) #Runners.all ...)
         )
 
+        # @!method receive_message(node)
         def_node_search :receive_message, %(
           $(send nil? {:receive :have_received} ...)
         )

data/lib/rubocop/cop/rspec/mixin/variable.rb

@@ -10,6 +10,7 @@ module RuboCop
         Subjects = RuboCop::RSpec::Language::Subjects
         Helpers = RuboCop::RSpec::Language::Helpers
 
+        # @!method variable_definition?(node)
         def_node_matcher :variable_definition?, <<~PATTERN
           (send nil? {#Subjects.all #Helpers.all}
             $({sym str dsym dstr} ...) ...)

data/lib/rubocop/cop/rspec/multiple_expectations.rb

@@ -53,6 +53,7 @@ module RuboCop
         ANYTHING = ->(_node) { true }
         TRUE = ->(node) { node.true_type? }
 
+        # @!method aggregate_failures?(node)
         def_node_matcher :aggregate_failures?, <<-PATTERN
           (block {
               (send _ _ <(sym :aggregate_failures) ...>)
@@ -60,7 +61,9 @@ module RuboCop
             } ...)
         PATTERN
 
+        # @!method expect?(node)
         def_node_matcher :expect?, send_pattern('#Expectations.all')
+        # @!method aggregate_failures_block?(node)
         def_node_matcher :aggregate_failures_block?, <<-PATTERN
           (block (send nil? :aggregate_failures ...) ...)
         PATTERN

data/lib/rubocop/cop/rspec/named_subject.rb

@@ -44,12 +44,15 @@ module RuboCop
       class NamedSubject < Base
         MSG = 'Name your test subject if you need to reference it explicitly.'
 
+        # @!method example_or_hook_block?(node)
         def_node_matcher :example_or_hook_block?,
                          block_pattern('{#Examples.all #Hooks.all}')
 
+        # @!method shared_example?(node)
         def_node_matcher :shared_example?,
                          block_pattern('#SharedGroups.examples')
 
+        # @!method subject_usage(node)
         def_node_search :subject_usage, '$(send nil? :subject)'
 
         def on_block(node)

data/lib/rubocop/cop/rspec/not_to_not.rb

@@ -22,6 +22,7 @@ module RuboCop
         MSG = 'Prefer `%<replacement>s` over `%<original>s`.'
         RESTRICT_ON_SEND = %i[not_to to_not].freeze
 
+        # @!method not_to_not_offense(node)
         def_node_matcher :not_to_not_offense, '(send _ % ...)'
 
         def on_send(node)

data/lib/rubocop/cop/rspec/overwriting_setup.rb

@@ -24,8 +24,10 @@ module RuboCop
       class OverwritingSetup < Base
         MSG = '`%<name>s` is already defined.'
 
+        # @!method setup?(node)
         def_node_matcher :setup?, block_pattern('{#Helpers.all #Subjects.all}')
 
+        # @!method first_argument_name(node)
         def_node_matcher :first_argument_name, '(send _ _ ({str sym} $_))'
 
         def on_block(node)

data/lib/rubocop/cop/rspec/pending.rb

@@ -34,11 +34,13 @@ module RuboCop
       class Pending < Base
         MSG = 'Pending spec found.'
 
+        # @!method skippable?(node)
         def_node_matcher :skippable?,
                          send_pattern(<<~PATTERN)
                            {#ExampleGroups.regular #Examples.regular}
                          PATTERN
 
+        # @!method skipped_in_metadata?(node)
         def_node_matcher :skipped_in_metadata?, <<-PATTERN
           {
             (send _ _ <#skip_or_pending? ...>)
@@ -46,8 +48,10 @@ module RuboCop
           }
         PATTERN
 
+        # @!method skip_or_pending?(node)
         def_node_matcher :skip_or_pending?, '{(sym :skip) (sym :pending)}'
 
+        # @!method pending_block?(node)
         def_node_matcher :pending_block?,
                          send_pattern(<<~PATTERN)
                            {

data/lib/rubocop/cop/rspec/predicate_matcher.rb

@@ -25,6 +25,7 @@ module RuboCop
           end
         end
 
+        # @!method predicate_in_actual?(node)
         def_node_matcher :predicate_in_actual?, <<-PATTERN
           (send
             (send nil? :expect {
@@ -34,10 +35,12 @@ module RuboCop
             $#boolean_matcher?)
         PATTERN
 
+        # @!method be_bool?(node)
         def_node_matcher :be_bool?, <<-PATTERN
           (send nil? {:be :eq :eql :equal} {true false})
         PATTERN
 
+        # @!method be_boolthy?(node)
         def_node_matcher :be_boolthy?, <<-PATTERN
           (send nil? {:be_truthy :be_falsey :be_falsy :a_truthy_value :a_falsey_value :a_falsy_value})
         PATTERN
@@ -152,6 +155,7 @@ module RuboCop
           end
         end
 
+        # @!method predicate_matcher?(node)
         def_node_matcher :predicate_matcher?, <<-PATTERN
           (send
             (send nil? :expect $!nil?)
@@ -160,6 +164,7 @@ module RuboCop
               (block $(send nil? #predicate_matcher_name? ...) ...)})
         PATTERN
 
+        # @!method predicate_matcher_block?(node)
         def_node_matcher :predicate_matcher_block?, <<-PATTERN
           (block
             (send

data/lib/rubocop/cop/rspec/rails/http_status.rb

@@ -35,6 +35,7 @@ module RuboCop
           include ConfigurableEnforcedStyle
           RESTRICT_ON_SEND = %i[have_http_status].freeze
 
+          # @!method http_status(node)
           def_node_matcher :http_status, <<-PATTERN
             (send nil? :have_http_status ${int sym})
           PATTERN

data/lib/rubocop/cop/rspec/receive_counts.rb

@@ -30,10 +30,12 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[times].freeze
 
+        # @!method receive_counts(node)
         def_node_matcher :receive_counts, <<-PATTERN
           (send $(send _ {:exactly :at_least :at_most} (int {1 2})) :times)
         PATTERN
 
+        # @!method stub?(node)
         def_node_search :stub?, '(send nil? :receive ...)'
 
         def on_send(node)

data/lib/rubocop/cop/rspec/receive_never.rb

@@ -18,6 +18,7 @@ module RuboCop
         MSG = 'Use `not_to receive` instead of `never`.'
         RESTRICT_ON_SEND = %i[never].freeze
 
+        # @!method method_on_stub?(node)
         def_node_search :method_on_stub?, '(send nil? :receive ...)'
 
         def on_send(node)

data/lib/rubocop/cop/rspec/repeated_example_group_body.rb

@@ -46,16 +46,23 @@ module RuboCop
       class RepeatedExampleGroupBody < Base
         MSG = 'Repeated %<group>s block body on line(s) %<loc>s'
 
+        # @!method several_example_groups?(node)
         def_node_matcher :several_example_groups?, <<-PATTERN
           (begin <#example_group_with_body? #example_group_with_body? ...>)
         PATTERN
 
+        # @!method metadata(node)
         def_node_matcher :metadata, '(block (send _ _ _ $...) ...)'
+
+        # @!method body(node)
         def_node_matcher :body, '(block _ args $...)'
+
+        # @!method const_arg(node)
         def_node_matcher :const_arg, '(block (send _ _ $const ...) ...)'
 
+        # @!method skip_or_pending?(node)
         def_node_matcher :skip_or_pending?, <<-PATTERN
-          (block <(send nil? {:skip :pending}) ...>)
+          (block <(send nil? {:skip :pending} ...) ...>)
         PATTERN
 
         def on_begin(node)

data/lib/rubocop/cop/rspec/repeated_example_group_description.rb

@@ -46,18 +46,22 @@ module RuboCop
       class RepeatedExampleGroupDescription < Base
         MSG = 'Repeated %<group>s block description on line(s) %<loc>s'
 
+        # @!method several_example_groups?(node)
         def_node_matcher :several_example_groups?, <<-PATTERN
           (begin <#example_group? #example_group? ...>)
         PATTERN
 
+        # @!method doc_string_and_metadata(node)
         def_node_matcher :doc_string_and_metadata, <<-PATTERN
           (block (send _ _ $_ $...) ...)
         PATTERN
 
+        # @!method skip_or_pending?(node)
         def_node_matcher :skip_or_pending?, <<-PATTERN
           (block <(send nil? {:skip :pending}) ...>)
         PATTERN
 
+        # @!method empty_description?(node)
         def_node_matcher :empty_description?, '(block (send _ _) ...)'
 
         def on_begin(node)