rubocop-rspec 2.1.0 → 2.5.0

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/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

@@ -21,11 +21,14 @@ module RuboCop
 
         MSG = 'Use `%<recommended>s` instead of calling ' \
               '`%<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

@@ -32,7 +32,9 @@ module RuboCop
       #     expect { do_something }.not_to raise_error
       class UnspecifiedException < Base
         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/verified_doubles.rb

@@ -24,7 +24,9 @@ module RuboCop
       #   end
       class VerifiedDoubles < Base
         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

@@ -14,11 +14,14 @@ module RuboCop
       class VoidExpect < Base
         MSG = 'Do not use `expect()` without `.to` or `.not_to`. ' \
               '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/corrector/move_node.rb

@@ -6,6 +6,7 @@ module RuboCop
       # Helper methods to move a node
       class MoveNode
         include RuboCop::Cop::RangeHelp
+        include RuboCop::Cop::RSpec::CommentsHelp
         include RuboCop::Cop::RSpec::FinalEndLocation
 
         attr_reader :original, :corrector, :processed_source
@@ -17,20 +18,16 @@ module RuboCop
         end
 
         def move_before(other)
-          position = other.loc.expression
-          indent = ' ' * other.loc.column
-          newline_indent = "\n#{indent}"
+          position = start_line_position(other)
 
-          corrector.insert_before(position, source(original) + newline_indent)
+          corrector.insert_before(position, "#{source(original)}\n")
           corrector.remove(node_range_with_surrounding_space(original))
         end
 
         def move_after(other)
-          position = final_end_location(other)
-          indent = ' ' * other.loc.column
-          newline_indent = "\n#{indent}"
+          position = end_line_position(other)
 
-          corrector.insert_after(position, newline_indent + source(original))
+          corrector.insert_after(position, "\n#{source(original)}")
           corrector.remove(node_range_with_surrounding_space(original))
         end
 
@@ -41,7 +38,7 @@ module RuboCop
         end
 
         def node_range(node)
-          node.loc.expression.with(end_pos: final_end_location(node).end_pos)
+          source_range_with_comment(node)
         end
 
         def node_range_with_surrounding_space(node)

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.1.0'
+      STRING = '2.5.0'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -15,6 +15,7 @@ require_relative 'rubocop/rspec/language'
 require_relative 'rubocop/cop/rspec/mixin/top_level_group'
 require_relative 'rubocop/cop/rspec/mixin/variable'
 require_relative 'rubocop/cop/rspec/mixin/final_end_location'
+require_relative 'rubocop/cop/rspec/mixin/comments_help'
 require_relative 'rubocop/cop/rspec/mixin/empty_line_separation'
 
 require_relative 'rubocop/rspec/concept'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.5.0
 platform: ruby
 authors:
 - John Backus
 - Ian MacLeod
 - Nils Gemeinhardt
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,28 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-ast
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +82,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,7 @@ files:
 - lib/rubocop/cop/rspec/example_length.rb
 - lib/rubocop/cop/rspec/example_without_description.rb
 - lib/rubocop/cop/rspec/example_wording.rb
+- lib/rubocop/cop/rspec/excessive_docstring_spacing.rb
 - lib/rubocop/cop/rspec/expect_actual.rb
 - lib/rubocop/cop/rspec/expect_change.rb
 - lib/rubocop/cop/rspec/expect_in_hook.rb
@@ -183,6 +184,7 @@ files:
 - lib/rubocop/cop/rspec/focus.rb
 - lib/rubocop/cop/rspec/hook_argument.rb
 - lib/rubocop/cop/rspec/hooks_before_examples.rb
+- lib/rubocop/cop/rspec/identical_equality_assertion.rb
 - lib/rubocop/cop/rspec/implicit_block_expectation.rb
 - lib/rubocop/cop/rspec/implicit_expect.rb
 - lib/rubocop/cop/rspec/implicit_subject.rb
@@ -198,6 +200,7 @@ files:
 - lib/rubocop/cop/rspec/message_expectation.rb
 - lib/rubocop/cop/rspec/message_spies.rb
 - lib/rubocop/cop/rspec/missing_example_group_argument.rb
+- lib/rubocop/cop/rspec/mixin/comments_help.rb
 - lib/rubocop/cop/rspec/mixin/empty_line_separation.rb
 - lib/rubocop/cop/rspec/mixin/final_end_location.rb
 - lib/rubocop/cop/rspec/mixin/top_level_group.rb
@@ -212,6 +215,7 @@ files:
 - lib/rubocop/cop/rspec/overwriting_setup.rb
 - lib/rubocop/cop/rspec/pending.rb
 - lib/rubocop/cop/rspec/predicate_matcher.rb
+- lib/rubocop/cop/rspec/rails/avoid_setup_hook.rb
 - lib/rubocop/cop/rspec/rails/http_status.rb
 - lib/rubocop/cop/rspec/receive_counts.rb
 - lib/rubocop/cop/rspec/receive_never.rb
@@ -227,6 +231,7 @@ files:
 - lib/rubocop/cop/rspec/shared_examples.rb
 - lib/rubocop/cop/rspec/single_argument_message_chain.rb
 - lib/rubocop/cop/rspec/stubbed_mock.rb
+- lib/rubocop/cop/rspec/subject_declaration.rb
 - lib/rubocop/cop/rspec/subject_stub.rb
 - lib/rubocop/cop/rspec/unspecified_exception.rb
 - lib/rubocop/cop/rspec/variable_definition.rb
@@ -250,13 +255,13 @@ files:
 - lib/rubocop/rspec/node.rb
 - lib/rubocop/rspec/version.rb
 - lib/rubocop/rspec/wording.rb
-homepage: https://github.com/rubocop-hq/rubocop-rspec
+homepage: https://github.com/rubocop/rubocop-rspec
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/rubocop-hq/rubocop-rspec/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-rspec/
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -264,15 +269,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.2
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []