rubocop-rspec 2.0.0 → 2.4.0

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

@@ -15,18 +15,12 @@ module RuboCop
       #
       class MessageChain < Base
         MSG = 'Avoid stubbing using `%<method>s`.'
-
-        def_node_matcher :message_chain, <<-PATTERN
-          (send _ {:receive_message_chain :stub_chain} ...)
-        PATTERN
+        RESTRICT_ON_SEND = %i[receive_message_chain stub_chain].freeze
 
         def on_send(node)
-          message_chain(node) do
-            add_offense(
-              node.loc.selector,
-              message: format(MSG, method: node.method_name)
-            )
-          end
+          add_offense(
+            node.loc.selector, message: format(MSG, method: node.method_name)
+          )
         end
       end
     end

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

@@ -30,11 +30,14 @@ module RuboCop
         MSG = 'Prefer `%<style>s` for setting message expectations.'
 
         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

@@ -29,16 +29,18 @@ module RuboCop
 
         MSG_RECEIVE = 'Prefer `receive` for setting message expectations.'
 
-        MSG_HAVE_RECEIVED = 'Prefer `have_received` for setting message '\
-                            'expectations. Setup `%<source>s` as a spy using '\
+        MSG_HAVE_RECEIVED = 'Prefer `have_received` for setting message ' \
+                            'expectations. Setup `%<source>s` as a spy using ' \
                             '`allow` or `instance_spy`.'
 
         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/comments_help.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Help methods for working with nodes containing comments.
+      module CommentsHelp
+        include FinalEndLocation
+
+        def source_range_with_comment(node)
+          begin_pos = begin_pos_with_comment(node).begin_pos
+          end_pos = end_line_position(node).end_pos
+
+          Parser::Source::Range.new(buffer, begin_pos, end_pos)
+        end
+
+        def begin_pos_with_comment(node)
+          first_comment = processed_source.ast_with_comments[node].first
+
+          start_line_position(first_comment || node)
+        end
+
+        def start_line_position(node)
+          buffer.line_range(node.loc.line)
+        end
+
+        def end_line_position(node)
+          end_line = buffer.line_for_position(final_end_location(node).end_pos)
+          buffer.line_range(end_line)
+        end
+
+        def buffer
+          processed_source.buffer
+        end
+      end
+    end
+  end
+end

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_describes.rb

@@ -25,8 +25,7 @@ module RuboCop
       class MultipleDescribes < Base
         include TopLevelGroup
 
-        MSG = 'Do not use multiple top-level example groups - '\
-              'try to nest them.'
+        MSG = 'Do not use multiple top-level example groups - try to nest them.'
 
         def on_top_level_group(node)
           top_level_example_groups =

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

@@ -20,7 +20,9 @@ module RuboCop
         include ConfigurableEnforcedStyle
 
         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/avoid_setup_hook.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Rails
+        # Checks that tests use RSpec `before` hook over Rails `setup` method.
+        #
+        # @example
+        #
+        #   # bad
+        #   setup do
+        #     allow(foo).to receive(:bar)
+        #   end
+        #
+        #   # good
+        #   before do
+        #     allow(foo).to receive(:bar)
+        #   end
+        #
+        class AvoidSetupHook < Base
+          extend AutoCorrector
+
+          MSG = 'Use `before` instead of `setup`.'
+
+          # @!method setup_call(node)
+          def_node_matcher :setup_call, <<-PATTERN
+            (block
+              $(send nil? :setup)
+              (args) _)
+          PATTERN
+
+          def on_block(node)
+            setup_call(node) do |setup|
+              add_offense(node) do |corrector|
+                corrector.replace setup, 'before'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -33,7 +33,9 @@ module RuboCop
         class HttpStatus < Base
           extend AutoCorrector
           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

@@ -28,10 +28,14 @@ module RuboCop
 
         MSG = 'Use `%<alternative>s` instead of `%<original>s`.'
 
+        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

@@ -16,7 +16,9 @@ module RuboCop
       class ReceiveNever < Base
         extend AutoCorrector
         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)

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

@@ -50,13 +50,16 @@ module RuboCop
         MSG = 'Repeated include of shared_examples %<name>s ' \
           'on line(s) %<repeat>s'
 
+        # @!method several_include_examples?(node)
         def_node_matcher :several_include_examples?, <<-PATTERN
           (begin <#include_examples? #include_examples? ...>)
         PATTERN
 
+        # @!method include_examples?(node)
         def_node_matcher :include_examples?,
                          send_pattern('#Includes.examples')
 
+        # @!method shared_examples_name(node)
         def_node_matcher :shared_examples_name, <<-PATTERN
           (send _ #Includes.examples $_ ...)
         PATTERN

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

@@ -39,9 +39,15 @@ module RuboCop
 
         MSG_AND_RETURN = 'Use `and_return` for static values.'
         MSG_BLOCK = 'Use block for static values.'
+        RESTRICT_ON_SEND = %i[and_return].freeze
 
+        # @!method contains_stub?(node)
         def_node_search :contains_stub?, '(send nil? :receive (...))'
+
+        # @!method stub_with_block?(node)
         def_node_matcher :stub_with_block?, '(block #contains_stub? ...)'
+
+        # @!method and_return_value(node)
         def_node_search :and_return_value, <<-PATTERN
           $(send _ :and_return $(...))
         PATTERN

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

@@ -23,7 +23,7 @@ module RuboCop
       #   end
       #
       class ScatteredSetup < Base
-        MSG = 'Do not define multiple `%<hook_name>s` hooks in the same '\
+        MSG = 'Do not define multiple `%<hook_name>s` hooks in the same ' \
               'example group (also defined on %<lines>s).'
 
         def on_block(node)

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

@@ -53,15 +53,14 @@ module RuboCop
       class SharedContext < Base
         extend AutoCorrector
 
-        MSG_EXAMPLES = "Use `shared_examples` when you don't "\
-                       'define context.'
-
-        MSG_CONTEXT  = "Use `shared_context` when you don't "\
-                       'define examples.'
+        MSG_EXAMPLES = "Use `shared_examples` when you don't define context."
+        MSG_CONTEXT  = "Use `shared_context` when you don't define examples."
 
+        # @!method examples?(node)
         def_node_search :examples?,
                         send_pattern('{#Includes.examples #Examples.all}')
 
+        # @!method context?(node)
         def_node_search :context?, <<-PATTERN
           (
             send #rspec? {
@@ -73,8 +72,10 @@ module RuboCop
           )
         PATTERN
 
+        # @!method shared_context(node)
         def_node_matcher :shared_context,
                          block_pattern('#SharedGroups.context')
+        # @!method shared_example(node)
         def_node_matcher :shared_example,
                          block_pattern('#SharedGroups.examples')