rubocop-rspec 2.2.0 → 2.6.0

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

@@ -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)

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

@@ -41,8 +41,13 @@ module RuboCop
         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/shared_context.rb

@@ -56,9 +56,11 @@ module RuboCop
         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? {
@@ -70,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')
 

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

@@ -23,6 +23,7 @@ module RuboCop
       class SharedExamples < Base
         extend AutoCorrector
 
+        # @!method shared_examples(node)
         def_node_matcher :shared_examples,
                          send_pattern(
                            '{#SharedGroups.all #Includes.all}'

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

@@ -23,10 +23,12 @@ module RuboCop
               '`%<called>s` with a single argument.'
         RESTRICT_ON_SEND = %i[receive_message_chain stub_chain].freeze
 
+        # @!method message_chain(node)
         def_node_matcher :message_chain, <<-PATTERN
           (send _ {:receive_message_chain :stub_chain} $_)
         PATTERN
 
+        # @!method single_key_hash?(node)
         def_node_matcher :single_key_hash?, '(hash pair)'
 
         def on_send(node)

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

@@ -39,6 +39,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method configured_response?(node)
         def_node_matcher :configured_response?, <<~PATTERN
           { :and_return :and_raise :and_throw :and_yield
             :and_call_original :and_wrap_original }

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Ensure that subject is defined using subject helper.
+      #
+      # @example
+      #
+      #   # bad
+      #   let(:subject) { foo }
+      #   let!(:subject) { foo }
+      #   subject(:subject) { foo }
+      #   subject!(:subject) { foo }
+      #
+      #   # bad
+      #   block = -> {}
+      #   let(:subject, &block)
+      #
+      #   # good
+      #   subject(:test_subject) { foo }
+      #
+      class SubjectDeclaration < Base
+        MSG_LET = 'Use subject explicitly rather than using let'
+        MSG_REDUNDANT = 'Ambiguous declaration of subject'
+
+        # @!method offensive_subject_declaration?(node)
+        def_node_matcher :offensive_subject_declaration?, <<~PATTERN
+          (send nil? ${#Subjects.all #Helpers.all} {(sym :subject) (str "subject")} ...)
+        PATTERN
+
+        def on_send(node)
+          offense = offensive_subject_declaration?(node)
+          return unless offense
+
+          add_offense(node, message: message_for(offense))
+        end
+
+        private
+
+        def message_for(offense)
+          Helpers.all(offense) ? MSG_LET : MSG_REDUNDANT
+        end
+      end
+    end
+  end
+end

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

@@ -81,6 +81,7 @@ module RuboCop
           )
         PATTERN
 
+        # @!method message_expectation_matcher?(node)
         def_node_search :message_expectation_matcher?, <<-PATTERN
           (send nil? {
             :receive :receive_messages :receive_message_chain :have_received

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

@@ -34,6 +34,7 @@ module RuboCop
         MSG = 'Specify the exception being captured'
         RESTRICT_ON_SEND = %i[to].freeze
 
+        # @!method empty_raise_error_or_exception(node)
         def_node_matcher :empty_raise_error_or_exception, <<-PATTERN
           (send
             (block

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

@@ -23,6 +23,7 @@ module RuboCop
       #   subject('user') { create_user }
       #   let('user_name') { 'Adam' }
       class VariableDefinition < Base
+        extend AutoCorrector
         include ConfigurableEnforcedStyle
         include Variable
 
@@ -30,14 +31,30 @@ module RuboCop
 
         def on_send(node)
           variable_definition?(node) do |variable|
-            if style_violation?(variable)
-              add_offense(variable, message: format(MSG, style: style))
+            next unless style_violation?(variable)
+
+            add_offense(
+              variable,
+              message: format(MSG, style: style)
+            ) do |corrector|
+              corrector.replace(variable, correct_variable(variable))
             end
           end
         end
 
         private
 
+        def correct_variable(variable)
+          case variable.type
+          when :dsym
+            variable.source[1..-1]
+          when :sym
+            variable.value.to_s.inspect
+          else
+            variable.value.to_sym.inspect
+          end
+        end
+
         def style_violation?(variable)
           style == :symbols && string?(variable) ||
             style == :strings && symbol?(variable)

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

@@ -26,6 +26,7 @@ module RuboCop
         MSG = 'Prefer using verifying doubles over normal doubles.'
         RESTRICT_ON_SEND = %i[double spy].freeze
 
+        # @!method unverified_double(node)
         def_node_matcher :unverified_double, <<-PATTERN
           {(send nil? {:double :spy} $...)}
         PATTERN

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

@@ -16,10 +16,12 @@ module RuboCop
               'Chain the methods or remove it.'
         RESTRICT_ON_SEND = %i[expect].freeze
 
+        # @!method expect?(node)
         def_node_matcher :expect?, <<-PATTERN
           (send nil? :expect ...)
         PATTERN
 
+        # @!method expect_block?(node)
         def_node_matcher :expect_block?, <<-PATTERN
           (block #expect? (args) _body)
         PATTERN

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

@@ -17,10 +17,13 @@ module RuboCop
 
         MSG = 'Use `.and_yield`.'
 
+        # @!method method_on_stub?(node)
         def_node_search :method_on_stub?, '(send nil? :receive ...)'
 
+        # @!method block_arg(node)
         def_node_matcher :block_arg, '(args (blockarg $_))'
 
+        # @!method block_call?(node)
         def_node_matcher :block_call?, '(send (lvar %) :call ...)'
 
         def on_block(node)

data/lib/rubocop/cop/rspec_cops.rb

@@ -8,6 +8,7 @@ require_relative 'rspec/factory_bot/attribute_defined_statically'
 require_relative 'rspec/factory_bot/create_list'
 require_relative 'rspec/factory_bot/factory_class_name'
 
+require_relative 'rspec/rails/avoid_setup_hook'
 begin
   require_relative 'rspec/rails/http_status'
 rescue LoadError
@@ -39,6 +40,7 @@ require_relative 'rspec/empty_line_after_subject'
 require_relative 'rspec/example_length'
 require_relative 'rspec/example_without_description'
 require_relative 'rspec/example_wording'
+require_relative 'rspec/excessive_docstring_spacing'
 require_relative 'rspec/expect_actual'
 require_relative 'rspec/expect_change'
 require_relative 'rspec/expect_in_hook'
@@ -47,6 +49,7 @@ require_relative 'rspec/file_path'
 require_relative 'rspec/focus'
 require_relative 'rspec/hook_argument'
 require_relative 'rspec/hooks_before_examples'
+require_relative 'rspec/identical_equality_assertion'
 require_relative 'rspec/implicit_block_expectation'
 require_relative 'rspec/implicit_expect'
 require_relative 'rspec/implicit_subject'
@@ -86,6 +89,7 @@ require_relative 'rspec/shared_context'
 require_relative 'rspec/shared_examples'
 require_relative 'rspec/single_argument_message_chain'
 require_relative 'rspec/stubbed_mock'
+require_relative 'rspec/subject_declaration'
 require_relative 'rspec/subject_stub'
 require_relative 'rspec/unspecified_exception'
 require_relative 'rspec/variable_definition'

data/lib/rubocop/rspec/align_let_brace.rb

@@ -5,6 +5,7 @@ module RuboCop
     # Shared behavior for aligning braces for single line lets
     class AlignLetBrace
       include RuboCop::RSpec::Language
+      include RuboCop::Cop::Util
 
       def initialize(root, token)
         @root  = root
@@ -34,7 +35,7 @@ module RuboCop
       def let_group_for(let)
         adjacent_let_chunks.detect do |chunk|
           chunk.any? do |member|
-            member == let && member.loc.line == let.loc.line
+            member == let && same_line?(member, let)
           end
         end
       end

data/lib/rubocop/rspec/config_formatter.rb

@@ -7,6 +7,7 @@ module RuboCop
     # Builds a YAML config file from two config hashes
     class ConfigFormatter
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
+      SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
       STYLE_GUIDE_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/'
 
       def initialize(config, descriptions)
@@ -24,6 +25,8 @@ module RuboCop
 
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
+          next if SUBDEPARTMENTS.include?(cop)
+
           unified[cop] = config.fetch(cop)
             .merge(descriptions.fetch(cop))
             .merge('StyleGuide' => STYLE_GUIDE_BASE_URL + cop.sub('RSpec/', ''))

data/lib/rubocop/rspec/example.rb

@@ -4,8 +4,13 @@ module RuboCop
   module RSpec
     # Wrapper for RSpec examples
     class Example < Concept
+      # @!method extract_doc_string(node)
       def_node_matcher :extract_doc_string,     '(send _ _ $_ ...)'
+
+      # @!method extract_metadata(node)
       def_node_matcher :extract_metadata,       '(send _ _ _ $...)'
+
+      # @!method extract_implementation(node)
       def_node_matcher :extract_implementation, '(block send args $_)'
 
       def doc_string

data/lib/rubocop/rspec/hook.rb

@@ -4,6 +4,7 @@ module RuboCop
   module RSpec
     # Wrapper for RSpec hook
     class Hook < Concept
+      # @!method extract_metadata(node)
       def_node_matcher :extract_metadata, <<~PATTERN
         (block
           (send _ _ #valid_scope? ? $...) ...

data/lib/rubocop/rspec/language.rb

@@ -19,23 +19,31 @@ module RuboCop
         attr_accessor :config
       end
 
+      # @!method rspec?(node)
       def_node_matcher :rspec?, '{(const {nil? cbase} :RSpec) nil?}'
 
+      # @!method example_group?(node)
       def_node_matcher :example_group?, block_pattern('#ExampleGroups.all')
 
+      # @!method shared_group?(node)
       def_node_matcher :shared_group?, block_pattern('#SharedGroups.all')
 
+      # @!method spec_group?(node)
       def_node_matcher :spec_group?,
                        block_pattern('{#SharedGroups.all #ExampleGroups.all}')
 
+      # @!method example_group_with_body?(node)
       def_node_matcher :example_group_with_body?, <<-PATTERN
         (block #{send_pattern('#ExampleGroups.all')} args !nil?)
       PATTERN
 
+      # @!method example?(node)
       def_node_matcher :example?, block_pattern('#Examples.all')
 
+      # @!method hook?(node)
       def_node_matcher :hook?, block_pattern('#Hooks.all')
 
+      # @!method let?(node)
       def_node_matcher :let?, <<-PATTERN
         {
           #{block_pattern('#Helpers.all')}
@@ -43,6 +51,7 @@ module RuboCop
         }
       PATTERN
 
+      # @!method include?(node)
       def_node_matcher :include?, <<-PATTERN
         {
           #{send_pattern('#Includes.all')}
@@ -50,6 +59,7 @@ module RuboCop
         }
       PATTERN
 
+      # @!method subject?(node)
       def_node_matcher :subject?, block_pattern('#Subjects.all')
 
       module ExampleGroups # :nodoc:

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '2.2.0'
+      STRING = '2.6.0'
     end
   end
 end