rubocop-rspec 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb3dfbd46088f3d66b1af6e41c171aac15d8b28e5aae7f5c1eb43f770b47f423
-  data.tar.gz: 59ff08781d18888d37c3776209d3f90f0d7eee582a9cc03521048044c2ccf007
+  metadata.gz: c1531e973244c7aac66856335d340dee502696e988f9816bf74e7f5555d80d90
+  data.tar.gz: b634d15c53e126f497928eca6adfa6fae08b095ccb1a93f3d906826bca56efd4
 SHA512:
-  metadata.gz: 1446d96d3c63a526712f611a283bdf4758e39b7be63ae3c49e8aa66f916b55e4e495a5fae7bdd3ec5974189a1f6a5b4db211da58c031c2f5984703dff5f12cc3
-  data.tar.gz: c3ebd0c0cbc31647165384f04433fd62644d16aebf83ce1036770705900288cc0fda9c64ff6902f2ac36e23700862f420ef38d8693f641a86ee0dbed44733e34
+  metadata.gz: e91e8656f9f82f02fa041d5795d01eba023460aad4e3c06b55167b3f92fc0d22324250e1d116eb63c3b60e915240347f0a36cbe14c8b3752f7c6a63ea9949bd4
+  data.tar.gz: 8c470782145e23962f3653beb13b4543d461a3de9bbea201d5fb0c66fc8bfebb5695afad7bc545b37dba664362dee8edb0f579441f0bafcd963ab86f503b0415

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Master (Unreleased)
 
+## 2.2.0 (2021-02-02)
+
+* Fix `HooksBeforeExamples`, `LeadingSubject`, `LetBeforeExamples` and `ScatteredLet` autocorrection to take into account inline comments and comments immediately before the moved node. ([@Darhazer][])
+* Improve rubocop-rspec performance. ([@Darhazer][], [@bquorning][])
+* Include `Enabled: true` to prevent a mismatched configuration parameter warning when `RSpec` cops are explicitly enabled in the user configuration. ([@pirj][])
+
 ## 2.1.0 (2020-12-17)
 
 * Fix `RSpec/FilePath` false positive for relative file path runs with long namespaces. ([@ahukkanen][])

data/config/default.yml

@@ -1,5 +1,6 @@
 ---
 RSpec:
+  Enabled: true
   Include:
     - "**/*_spec.rb"
     - "**/spec/**/*"

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'

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

@@ -24,18 +24,14 @@ module RuboCop
       #   end
       class AnyInstance < Base
         MSG = 'Avoid stubbing using `%<method>s`.'
-
-        def_node_matcher :disallowed_stub, <<-PATTERN
-          (send _ ${:any_instance :allow_any_instance_of :expect_any_instance_of} ...)
-        PATTERN
+        RESTRICT_ON_SEND = %i[
+          any_instance
+          allow_any_instance_of
+          expect_any_instance_of
+        ].freeze
 
         def on_send(node)
-          disallowed_stub(node) do |method|
-            add_offense(
-              node,
-              message: format(MSG, method: method)
-            )
-          end
+          add_offense(node, message: format(MSG, method: node.method_name))
         end
       end
     end

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

@@ -39,6 +39,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Prefer `be` over `eql`.'
+        RESTRICT_ON_SEND = %i[to].freeze
 
         def_node_matcher :eql_type_with_identity, <<-PATTERN
           (send _ :to $(send nil? :eql {true false int float sym nil_type?}))

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

@@ -29,6 +29,8 @@ module RuboCop
               '`use_transactional_fixtures` is enabled, then records created ' \
               'in `%<hook>s` are not automatically rolled back.'
 
+        RESTRICT_ON_SEND = %i[before after].freeze
+
         def_node_matcher :before_or_after_all, <<-PATTERN
           $(send _ {:before :after} (sym {:all :context}))
         PATTERN

data/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb

@@ -30,6 +30,8 @@ module RuboCop
                 'Capybara feature specs - instead, use the ' \
                 '`have_current_path` matcher on `page`'
 
+          RESTRICT_ON_SEND = %i[expect].freeze
+
           def_node_matcher :expectation_set_on_current_path, <<-PATTERN
             (send nil? :expect (send {(send nil? :page) nil?} :current_path))
           PATTERN

data/lib/rubocop/cop/rspec/capybara/visibility_matcher.rb

@@ -44,6 +44,8 @@ module RuboCop
             have_content
           ].freeze
 
+          RESTRICT_ON_SEND = CAPYBARA_MATCHER_METHODS
+
           def_node_matcher :visible_true?, <<~PATTERN
             (send nil? #capybara_matcher? ... (hash <$(pair (sym :visible) true) ...>))
           PATTERN

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

@@ -19,6 +19,7 @@ module RuboCop
       # @see https://github.com/rspec/rspec-core/issues/1610
       class DescribeSymbol < Base
         MSG = 'Avoid describing symbols.'
+        RESTRICT_ON_SEND = %i[describe].freeze
 
         def_node_matcher :describe_symbol?, <<-PATTERN
           (send #rspec? :describe $sym ...)

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

@@ -35,6 +35,7 @@ module RuboCop
 
         MSG_BLOCK = 'Prefer `change(%<obj>s, :%<attr>s)`.'
         MSG_CALL = 'Prefer `change { %<obj>s.%<attr>s }`.'
+        RESTRICT_ON_SEND = %i[change].freeze
 
         def_node_matcher :expect_change_with_arguments, <<-PATTERN
           (send nil? :change ({const send} nil? $_) (sym $_))

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

@@ -30,6 +30,7 @@ module RuboCop
 
           MSG_CREATE_LIST = 'Prefer create_list.'
           MSG_N_TIMES = 'Prefer %<number>s.times.'
+          RESTRICT_ON_SEND = %i[create_list].freeze
 
           def_node_matcher :n_times_block_without_arg?, <<-PATTERN
             (block

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

@@ -25,6 +25,7 @@ module RuboCop
           MSG = "Pass '%<class_name>s' string instead of `%<class_name>s` " \
                 'constant.'
           ALLOWED_CONSTANTS = %w[Hash OpenStruct].freeze
+          RESTRICT_ON_SEND = %i[factory].freeze
 
           def_node_matcher :class_name, <<~PATTERN
             (send _ :factory _ (hash <(pair (sym :class) $(const ...)) ...>))

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

@@ -18,6 +18,7 @@ module RuboCop
       #   end
       class ImplicitBlockExpectation < Base
         MSG = 'Avoid implicit block expectations.'
+        RESTRICT_ON_SEND = %i[is_expected should should_not].freeze
 
         def_node_matcher :lambda?, <<-PATTERN
           {

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

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

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

@@ -24,6 +24,7 @@ module RuboCop
 
         MSG = 'Prefer `%<replacement>s` over `%<original>s` when including ' \
               'examples in a nested context.'
+        RESTRICT_ON_SEND = %i[it_behaves_like it_should_behave_like].freeze
 
         def_node_matcher :example_inclusion_offense, '(send _ % ...)'
 

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,6 +30,7 @@ module RuboCop
         MSG = 'Prefer `%<style>s` for setting message expectations.'
 
         SUPPORTED_STYLES = %w[allow expect].freeze
+        RESTRICT_ON_SEND = %i[to].freeze
 
         def_node_matcher :message_expectation, <<-PATTERN
           (send $(send nil? {:expect :allow} ...) :to #receive_message?)

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/not_to_not.rb

@@ -20,6 +20,7 @@ module RuboCop
         include ConfigurableEnforcedStyle
 
         MSG = 'Prefer `%<replacement>s` over `%<original>s`.'
+        RESTRICT_ON_SEND = %i[not_to to_not].freeze
 
         def_node_matcher :not_to_not_offense, '(send _ % ...)'
 

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

@@ -33,6 +33,7 @@ module RuboCop
         class HttpStatus < Base
           extend AutoCorrector
           include ConfigurableEnforcedStyle
+          RESTRICT_ON_SEND = %i[have_http_status].freeze
 
           def_node_matcher :http_status, <<-PATTERN
             (send nil? :have_http_status ${int sym})

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

@@ -28,6 +28,8 @@ module RuboCop
 
         MSG = 'Use `%<alternative>s` instead of `%<original>s`.'
 
+        RESTRICT_ON_SEND = %i[times].freeze
+
         def_node_matcher :receive_counts, <<-PATTERN
           (send $(send _ {:exactly :at_least :at_most} (int {1 2})) :times)
         PATTERN

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

@@ -16,6 +16,7 @@ module RuboCop
       class ReceiveNever < Base
         extend AutoCorrector
         MSG = 'Use `not_to receive` instead of `never`.'
+        RESTRICT_ON_SEND = %i[never].freeze
 
         def_node_search :method_on_stub?, '(send nil? :receive ...)'
 

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

@@ -39,6 +39,7 @@ 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
 
         def_node_search :contains_stub?, '(send nil? :receive (...))'
         def_node_matcher :stub_with_block?, '(block #contains_stub? ...)'

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

@@ -21,6 +21,7 @@ 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
 
         def_node_matcher :message_chain, <<-PATTERN
           (send _ {:receive_message_chain :stub_chain} $_)

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

@@ -32,6 +32,7 @@ module RuboCop
       #     expect { do_something }.not_to raise_error
       class UnspecifiedException < Base
         MSG = 'Specify the exception being captured'
+        RESTRICT_ON_SEND = %i[to].freeze
 
         def_node_matcher :empty_raise_error_or_exception, <<-PATTERN
           (send

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

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

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

@@ -14,6 +14,7 @@ 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
 
         def_node_matcher :expect?, <<-PATTERN
           (send nil? :expect ...)

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/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.2.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -198,6 +198,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