rubocop-rspec 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d0bedaa464141123a49b02ad1a31ed8a63b9960304014c0ef5e52f96fb78176
-  data.tar.gz: e310236f596a19629629c70d9f94fcb46a39183c43908b5864860efb2abd7602
+  metadata.gz: 8b1c8f65ec3429d357c99302f307f318750117e2329719e4cffc60123546a356
+  data.tar.gz: 178b52063271fe727162e196b6a364254e86a7343233ee8d15ad2d27f812367d
 SHA512:
-  metadata.gz: 7cd82a374f1cd9362070fe6561f9c04927a2ac33f5e1b5ee97a80bc443b0a4c3c90a75d93778e7bf6f439ff759b60857cdeccc2a7b51bfdc8feebccc519e36c8
-  data.tar.gz: 19bbbdd2d38ef4802be62f44a18e95e83caaf6899c654dff281fe7058fc9bdf6f776cf0491b825b274f67450388a7aef292c2ee51033f6ae96a9d8671829c5e4
+  metadata.gz: fdc010e5813ab0d100c50da5686ce10dfff440fb279c01a0f7c0a99f5066202cea53789cbee6d3792b75cc22ce1574e6f06f216822a7ebb960e39f8ad8994139
+  data.tar.gz: 055a453f761b8d6ebda211002f2d0265deb4cdc2f8b5567d71cf28d25bcba7d34a1be7f88bd3e7768e29671bb278aa9af4bb6bc910e42008ee083c4c33525cc4

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Master (Unreleased)
 
+## 2.11.0 (2022-05-18)
+
+* Drop Ruby 2.5 support. ([@ydah][])
+* Add new `RSpec/ChangeByZero` cop. ([@ydah][])
+* Improve `RSpec/ExpectChange` to detect namespaced and top-level constants. ([@M-Yamashita01][])
+* Introduce an amendment to `Metrics/BlockLength` to exclude spec files. ([@luke-hill][])
+
 ## 2.10.0 (2022-04-19)
 
 * Fix a false positive for `RSpec/EmptyExampleGroup` when expectations in case statement. ([@ydah][])
@@ -681,3 +688,5 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@oshiro3]: https://github.com/oshiro3
 [@ydah]: https://github.com/ydah
 [@t3h2mas]: https://github.com/t3h2mas
+[@M-Yamashita01]: https://github.com/M-Yamashita01
+[@luke-hill]: https://github.com/luke-hill

data/config/default.yml

@@ -110,6 +110,14 @@ RSpec:
       - subject
       - subject!
 
+Metrics/BlockLength:
+  inherit_mode:
+    merge:
+      - Exclude
+  Exclude:
+    - "**/*_spec.rb"
+    - "**/spec/**/*"
+
 RSpec/AlignLeftLetBrace:
   Description: Checks that left braces for adjacent single line lets are aligned.
   Enabled: false
@@ -176,6 +184,12 @@ RSpec/BeforeAfterAll:
   StyleGuide: https://rspec.rubystyle.guide/#avoid-hooks-with-context-scope
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeforeAfterAll
 
+RSpec/ChangeByZero:
+  Description: Prefer negated matchers over `to change.by(0)`.
+  Enabled: pending
+  VersionAdded: 2.11.0
+  Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ChangeByZero
+
 RSpec/ContextMethod:
   Description: "`context` should not be used for specifying methods."
   Enabled: true
@@ -256,7 +270,7 @@ RSpec/DescribedClassModuleWrapping:
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribedClassModuleWrapping
 
 RSpec/Dialect:
-  Description: This cop enforces custom RSpec dialects.
+  Description: Enforces custom RSpec dialects.
   Enabled: false
   PreferredMethods: {}
   VersionAdded: '1.33'
@@ -787,13 +801,13 @@ RSpec/VerifiedDoubles:
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VerifiedDoubles
 
 RSpec/VoidExpect:
-  Description: This cop checks void `expect()`.
+  Description: Checks void `expect()`.
   Enabled: true
   VersionAdded: '1.16'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VoidExpect
 
 RSpec/Yield:
-  Description: This cop checks for calling a block within a stub.
+  Description: Checks for calling a block within a stub.
   Enabled: true
   VersionAdded: '1.32'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Yield

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

@@ -46,7 +46,7 @@ module RuboCop
 
           MSG = 'Use `%<replacement>s` instead of `%<method>s`.'
 
-          # https://git.io/v7Kwr
+          # https://github.com/teamcapybara/capybara/blob/e283c1aeaa72441f5403963577e16333bf111a81/lib/capybara/rspec/features.rb#L31-L36
           MAP = {
             background: :before,
             scenario:   :it,

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Prefer negated matchers over `to change.by(0)`.
+      #
+      # @example
+      #   # bad
+      #   expect { run }.to change(Foo, :bar).by(0)
+      #   expect { run }.to change { Foo.bar }.by(0)
+      #   expect { run }
+      #     .to change(Foo, :bar).by(0)
+      #     .and change(Foo, :baz).by(0)
+      #   expect { run }
+      #     .to change { Foo.bar }.by(0)
+      #     .and change { Foo.baz }.by(0)
+      #
+      #   # good
+      #   expect { run }.not_to change(Foo, :bar)
+      #   expect { run }.not_to change { Foo.bar }
+      #   expect { run }
+      #     .to not_change(Foo, :bar)
+      #     .and not_change(Foo, :baz)
+      #   expect { run }
+      #     .to not_change { Foo.bar }
+      #     .and not_change { Foo.baz }
+      #
+      class ChangeByZero < Base
+        extend AutoCorrector
+        MSG = 'Prefer `not_to change` over `to change.by(0)`.'
+        MSG_COMPOUND = 'Prefer negated matchers with compound expectations ' \
+                          'over `change.by(0)`.'
+        RESTRICT_ON_SEND = %i[change].freeze
+
+        # @!method expect_change_with_arguments(node)
+        def_node_matcher :expect_change_with_arguments, <<-PATTERN
+          (send
+            (send nil? :change ...) :by
+            (int 0))
+        PATTERN
+
+        # @!method expect_change_with_block(node)
+        def_node_matcher :expect_change_with_block, <<-PATTERN
+          (send
+            (block
+              (send nil? :change)
+              (args)
+              (send (...) $_)) :by
+            (int 0))
+        PATTERN
+
+        def on_send(node)
+          expect_change_with_arguments(node.parent) do
+            check_offence(node.parent)
+          end
+
+          expect_change_with_block(node.parent.parent) do
+            check_offence(node.parent.parent)
+          end
+        end
+
+        private
+
+        def check_offence(node)
+          expression = node.loc.expression
+          if compound_expectations?(node)
+            add_offense(expression, message: MSG_COMPOUND)
+          else
+            add_offense(expression) do |corrector|
+              autocorrect(corrector, node)
+            end
+          end
+        end
+
+        def compound_expectations?(node)
+          %i[and or].include?(node.parent.method_name)
+        end
+
+        def autocorrect(corrector, node)
+          corrector.replace(node.parent.loc.selector, 'not_to')
+          range = node.loc.dot.with(end_pos: node.loc.expression.end_pos)
+          corrector.remove(range)
+        end
+      end
+    end
+  end
+end

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

@@ -78,9 +78,8 @@ module RuboCop
         PATTERN
 
         # @!method contains_described_class?(node)
-        def_node_search :contains_described_class?, <<-PATTERN
-          (send nil? :described_class)
-        PATTERN
+        def_node_search :contains_described_class?,
+                        '(send nil? :described_class)'
 
         def on_block(node)
           # In case the explicit style is used, we need to remember what's
@@ -129,17 +128,13 @@ module RuboCop
         end
 
         def scope_change?(node)
-          scope_changing_syntax?(node)          ||
+          scope_changing_syntax?(node) ||
             common_instance_exec_closure?(node) ||
             skippable_block?(node)
         end
 
         def skippable_block?(node)
-          node.block_type? && !rspec_block?(node) && skip_blocks?
-        end
-
-        def skip_blocks?
-          cop_config['SkipBlocks']
+          node.block_type? && !rspec_block?(node) && cop_config['SkipBlocks']
         end
 
         def offensive?(node)
@@ -152,6 +147,7 @@ module RuboCop
 
         def offensive_described_class?(node)
           return unless node.const_type?
+
           # E.g. `described_class::CONSTANT`
           return if contains_described_class?(node)
 
@@ -172,14 +168,13 @@ module RuboCop
         # @return [Array<Symbol>]
         # @example
         #   # nil represents base constant
-        #   collapse_namespace([], :C)                 # => [:C]
-        #   collapse_namespace([:A, :B], [:C)          # => [:A, :B, :C]
-        #   collapse_namespace([:A, :B], [:B, :C)      # => [:A, :B, :C]
-        #   collapse_namespace([:A, :B], [nil, :C)     # => [nil, :C]
-        #   collapse_namespace([:A, :B], [nil, :B, :C) # => [nil, :B, :C]
+        #   collapse_namespace([], [:C])                # => [:C]
+        #   collapse_namespace([:A, :B], [:C])          # => [:A, :B, :C]
+        #   collapse_namespace([:A, :B], [:B, :C])      # => [:A, :B, :C]
+        #   collapse_namespace([:A, :B], [nil, :C])     # => [nil, :C]
+        #   collapse_namespace([:A, :B], [nil, :B, :C]) # => [nil, :B, :C]
         def collapse_namespace(namespace, const)
-          return const if namespace.empty?
-          return const if const.first.nil?
+          return const if namespace.empty? || const.first.nil?
 
           start = [0, (namespace.length - const.length)].max
           max = namespace.length
@@ -196,9 +191,7 @@ module RuboCop
         #   const_name(s(:const, s(:const, nil, :M), :C)) # => [:M, :C]
         #   const_name(s(:const, s(:cbase), :C))          # => [nil, :C]
         def const_name(node)
-          # rubocop:disable InternalAffairs/NodeDestructuring
-          namespace, name = *node
-          # rubocop:enable InternalAffairs/NodeDestructuring
+          namespace, name = *node # rubocop:disable InternalAffairs/NodeDestructuring
           if !namespace
             [name]
           elsif namespace.const_type?

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      # This cop enforces custom RSpec dialects.
+      # Enforces custom RSpec dialects.
       #
       # A dialect can be based on the following RSpec methods:
       #

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

@@ -39,7 +39,7 @@ module RuboCop
 
         # @!method expect_change_with_arguments(node)
         def_node_matcher :expect_change_with_arguments, <<-PATTERN
-          (send nil? :change $_ (sym $_))
+          (send nil? :change $_ ({sym str} $_))
         PATTERN
 
         # @!method expect_change_with_block(node)
@@ -47,7 +47,7 @@ module RuboCop
           (block
             (send nil? :change)
             (args)
-            (send ({const send} nil? $_) $_)
+            (send $_ $_)
           )
         PATTERN
 
@@ -67,9 +67,9 @@ module RuboCop
           return unless style == :method_call
 
           expect_change_with_block(node) do |receiver, message|
-            msg = format(MSG_BLOCK, obj: receiver, attr: message)
+            msg = format(MSG_BLOCK, obj: receiver.source, attr: message)
             add_offense(node, message: msg) do |corrector|
-              replacement = "change(#{receiver}, :#{message})"
+              replacement = "change(#{receiver.source}, :#{message})"
               corrector.replace(node, replacement)
             end
           end

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

@@ -24,7 +24,7 @@ module RuboCop
           # rubocop:disable InternalAffairs/NodeDestructuring
           variable_name, _rhs = *node
           # rubocop:enable InternalAffairs/NodeDestructuring
-          name = variable_name[1..-1]
+          name = variable_name[1..]
           return unless name.eql?('stdout') || name.eql?('stderr')
 
           add_offense(node.loc.name, message: format(MSG, name: name))

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

@@ -47,7 +47,7 @@ module RuboCop
         def correct_variable(variable)
           case variable.type
           when :dsym
-            variable.source[1..-1]
+            variable.source[1..]
           when :sym
             variable.value.to_s.inspect
           else

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      # This cop checks void `expect()`.
+      # Checks void `expect()`.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      # This cop checks for calling a block within a stub.
+      # Checks for calling a block within a stub.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/rspec_cops.rb

@@ -25,6 +25,7 @@ require_relative 'rspec/be_eq'
 require_relative 'rspec/be_eql'
 require_relative 'rspec/be_nil'
 require_relative 'rspec/before_after_all'
+require_relative 'rspec/change_by_zero'
 require_relative 'rspec/context_method'
 require_relative 'rspec/context_wording'
 require_relative 'rspec/describe_class'

data/lib/rubocop/rspec/config_formatter.rb

@@ -8,6 +8,7 @@ module RuboCop
     class ConfigFormatter
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
       SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
+      AMENDMENTS = %(Metrics/BlockLength)
       COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/'
 
       def initialize(config, descriptions)
@@ -18,6 +19,7 @@ module RuboCop
       def dump
         YAML.dump(unified_config)
           .gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
+          .gsub(*AMENDMENTS, "\n\\0")
           .gsub(/^(\s+)- /, '\1  - ')
       end
 
@@ -26,6 +28,7 @@ module RuboCop
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
           next if SUBDEPARTMENTS.include?(cop)
+          next if AMENDMENTS.include?(cop)
 
           unified[cop].merge!(descriptions.fetch(cop))
           unified[cop]['Reference'] = COP_DOC_BASE_URL + cop.sub('RSpec/', '')

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.10.0'
+      STRING = '2.11.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -142,6 +142,7 @@ files:
 - lib/rubocop/cop/rspec/capybara/current_path_expectation.rb
 - lib/rubocop/cop/rspec/capybara/feature_methods.rb
 - lib/rubocop/cop/rspec/capybara/visibility_matcher.rb
+- lib/rubocop/cop/rspec/change_by_zero.rb
 - lib/rubocop/cop/rspec/context_method.rb
 - lib/rubocop/cop/rspec/context_wording.rb
 - lib/rubocop/cop/rspec/describe_class.rb
@@ -262,14 +263,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.1
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files