rubocop-rspec 2.14.1 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 740118ee4ac02188e4bc7a4f62e03b31a6dda33ab3017377d954718cb7b356b1
-  data.tar.gz: 7f17bb68eb575fb53dd8f0d2662afff8057bde7faeb19b6d94b0c3f1cb62f73d
+  metadata.gz: 1e120f8d06ef760cbe4f3a3d077ca6cd8ceeb274a26042a6e1469fe9a280c969
+  data.tar.gz: 0c80cc155e8f64b03a97de1327e454d9ff2efb1a75b02e3b098f868afed30d17
 SHA512:
-  metadata.gz: 18fa9f2be3305f4e6388756e5223ccabdd85e951534f64e881c31a96d77a37f435c06197cd39a7808fb1690f56825ba442386668cfabe4335e784879f57d6ef2
-  data.tar.gz: 1dd7abd8c281bb4c7ad6dd41bdb56c2de9be9e322935ae14d820863e7a64e2b39ad5f31e9603a88b77d52fb0ead146bae0c96297b2487831c2e263fe029244ec
+  metadata.gz: e982f97a23de2473c5cae6cd20bb653bcbcee806abddf0dda09c7b30692193858fc105c7b46ce3c004f28a7f680d1b3a475298c7b10d0e1499d5b80333fde504
+  data.tar.gz: c3b79b39a2c98d9103cb4edbf6c2d8e2cc957790fd8fa617e1fdece172f3dfaaf652bf482e7236a1da663f3b9afae943c17efee1e4a5f0293acc771bbc1c3c43

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Master (Unreleased)
 
+## 2.15.0 (2022-11-03)
+
+- Fix a false positive for `RSpec/RepeatedDescription` when different its block expectations are used. ([@ydah])
+- Add `named_only` style to `RSpec/NamedSubject`. ([@kuahyeow])
+- Fix `RSpec/FactoryBot/ConsistentParenthesesStyle` to ignore calls without the first positional argument. ([@pirj])
+- Fix `RSpec/FactoryBot/ConsistentParenthesesStyle` to ignore calls inside a Hash or an Array. ([@pirj])
+- Fix `RSpec/NestedGroups` to correctly use `AllowedGroups` config. ([@samrjenkins])
+- Remove `Runners` and `HookScopes` RSpec DSL elements from configuration. ([@pirj])
+- Add `with default RSpec/Language config` helper to `lib` (under `rubocop/rspec/shared_contexts/default_rspec_language_config_context`), to allow use for downstream cops based on `RuboCop::Cop::RSpec::Base`. ([@smcgivern])
+
+## 2.14.2 (2022-10-25)
+
+- Fix an incorrect autocorrect for `FactoryBot/ConsistentParenthesesStyle` with `omit_parentheses` option when method name and first argument are not on same line. ([@ydah])
+- Fix autocorrection loop in `RSpec/ExampleWording` for insufficient example wording. ([@pirj])
+- Fix `RSpec/SortMetadata` not to reorder arguments of `include_`/`it_behaves_like`. ([@pirj])
+- Fix a false positive for `RSpec/NoExpectationExample` when allowed pattern methods with arguments. ([@ydah])
+- Change `RSpec/FilePath` so that it only checks suffix when path is under spec/routing or type is defined as routing. ([@r7kamura])
+
 ## 2.14.1 (2022-10-24)
 
 - Fix an error for `RSpec/Rails/InferredSpecType` with redundant type before other Hash metadata. ([@ydah])
@@ -716,6 +734,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@jtannas]: https://github.com/jtannas
 [@kellysutton]: https://github.com/kellysutton
 [@koic]: https://github.com/koic
+[@kuahyeow]: https://github.com/kuahyeow
 [@lazycoder9]: https://github.com/lazycoder9
 [@leoarnold]: https://github.com/leoarnold
 [@liberatys]: https://github.com/Liberatys
@@ -752,9 +771,11 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@rrosenblum]: https://github.com/rrosenblum
 [@rspeicher]: https://github.com/rspeicher
 [@rst-j]: https://github.com/RST-J
+[@samrjenkins]: https://github.com/samrjenkins
 [@schmijos]: https://github.com/schmijos
 [@seanpdoyle]: https://github.com/seanpdoyle
 [@sl4vr]: https://github.com/sl4vr
+[@smcgivern]: https://github.com/smcgivern
 [@stephannv]: https://github.com/stephannv
 [@t3h2mas]: https://github.com/t3h2mas
 [@tdeo]: https://github.com/tdeo

data/config/default.yml

@@ -12,8 +12,6 @@ RSpec:
         - Expectations
         - Helpers
         - Hooks
-        - HookScopes
-        - Runners
         - Subjects
     ExampleGroups:
       inherit_mode:
@@ -81,12 +79,6 @@ RSpec:
       - prepend_after
       - after
       - append_after
-    HookScopes:
-      - each
-      - example
-      - context
-      - all
-      - suite
     Includes:
       inherit_mode:
         merge:
@@ -98,10 +90,6 @@ RSpec:
         - include_examples
       Context:
         - include_context
-    Runners:
-      - to
-      - to_not
-      - not_to
     SharedGroups:
       inherit_mode:
         merge:
@@ -624,8 +612,13 @@ RSpec/MultipleSubjects:
 RSpec/NamedSubject:
   Description: Checks for explicitly referenced test subjects.
   Enabled: true
+  EnforcedStyle: always
+  SupportedStyles:
+    - always
+    - named_only
   IgnoreSharedExamples: true
   VersionAdded: 1.5.3
+  VersionChanged: '2.15'
   StyleGuide: https://rspec.rubystyle.guide/#use-subject
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/NamedSubject
 

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

@@ -68,20 +68,15 @@ module RuboCop
               add_wording_offense(description_node, MSG_SHOULD)
             elsif message.match?(IT_PREFIX)
               add_wording_offense(description_node, MSG_IT)
-            else
-              check_and_handle_insufficient_examples(description_node)
+            elsif insufficient_docstring?(description_node)
+              add_offense(docstring(description_node),
+                          message: MSG_INSUFFICIENT_DESCRIPTION)
             end
           end
         end
 
         private
 
-        def check_and_handle_insufficient_examples(description)
-          if insufficient_examples.include?(preprocess(text(description)))
-            add_wording_offense(description, MSG_INSUFFICIENT_DESCRIPTION)
-          end
-        end
-
         def add_wording_offense(node, message)
           docstring = docstring(node)
 
@@ -137,6 +132,10 @@ module RuboCop
           cop_config.fetch('IgnoredWords', [])
         end
 
+        def insufficient_docstring?(description_node)
+          insufficient_examples.include?(preprocess(text(description_node)))
+        end
+
         def insufficient_examples
           examples = cop_config.fetch('DisallowedExamples', [])
           examples.map! { |example| preprocess(example) }

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

@@ -30,6 +30,16 @@ module RuboCop
         #   create :login
         #   create :login
         #
+        #   # also good
+        #   # when method name and first argument are not on same line
+        #   create(
+        #     :user
+        #   )
+        #   build(
+        #     :user,
+        #     name: 'foo'
+        #   )
+        #
         class ConsistentParenthesesStyle < Base
           extend AutoCorrector
           include ConfigurableEnforcedStyle
@@ -45,15 +55,18 @@ module RuboCop
 
           FACTORY_CALLS = RuboCop::RSpec::FactoryBot::Language::METHODS
 
+          RESTRICT_ON_SEND = FACTORY_CALLS
+
           # @!method factory_call(node)
           def_node_matcher :factory_call, <<-PATTERN
-              (send
-                ${#factory_bot? nil?} %FACTORY_CALLS
-              $...)
+            (send
+              {#factory_bot? nil?} %FACTORY_CALLS
+              {sym str send lvar} _*
+            )
           PATTERN
 
           def on_send(node)
-            return if nested_call?(node) # prevent from nested matching
+            return if ambiguous_without_parentheses?(node)
 
             factory_call(node) do
               if node.parenthesized?
@@ -66,6 +79,7 @@ module RuboCop
 
           def process_with_parentheses(node)
             return unless style == :omit_parentheses
+            return unless same_line?(node, node.first_argument)
 
             add_offense(node.loc.selector,
                         message: MSG_OMIT_PARENS) do |corrector|
@@ -82,8 +96,10 @@ module RuboCop
             end
           end
 
-          def nested_call?(node)
-            node.parent&.send_type?
+          def ambiguous_without_parentheses?(node)
+            node.parent&.send_type? ||
+              node.parent&.pair_type? ||
+              node.parent&.array_type?
           end
 
           private

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

@@ -76,8 +76,6 @@ module RuboCop
           return unless top_level_groups.one?
 
           example_group(node) do |send_node, example_group, arguments|
-            next if routing_spec?(arguments)
-
             ensure_correct_file_path(send_node, example_group, arguments)
           end
         end
@@ -85,7 +83,7 @@ module RuboCop
         private
 
         def ensure_correct_file_path(send_node, example_group, arguments)
-          pattern = pattern_for(example_group, arguments.first)
+          pattern = pattern_for(example_group, arguments)
           return if filename_ends_with?(pattern)
 
           # For the suffix shown in the offense message, modify the regular
@@ -97,11 +95,13 @@ module RuboCop
         end
 
         def routing_spec?(args)
-          args.any?(&method(:routing_metadata?))
+          args.any?(&method(:routing_metadata?)) || routing_spec_path?
         end
 
-        def pattern_for(example_group, method_name)
-          if spec_suffix_only? || !example_group.const_type?
+        def pattern_for(example_group, arguments)
+          method_name = arguments.first
+          if spec_suffix_only? || !example_group.const_type? ||
+              routing_spec?(arguments)
             return pattern_for_spec_suffix_only
           end
 
@@ -149,8 +149,7 @@ module RuboCop
         end
 
         def filename_ends_with?(pattern)
-          filename = File.expand_path(processed_source.buffer.name)
-          filename.match?("#{pattern}$")
+          expanded_file_path.match?("#{pattern}$")
         end
 
         def relevant_rubocop_rspec_file?(_file)
@@ -160,6 +159,14 @@ module RuboCop
         def spec_suffix_only?
           cop_config['SpecSuffixOnly']
         end
+
+        def routing_spec_path?
+          expanded_file_path.include?('spec/routing/')
+        end
+
+        def expanded_file_path
+          File.expand_path(processed_source.buffer.name)
+        end
       end
     end
   end

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

@@ -12,11 +12,11 @@ module RuboCop
       # should be the most important object in your tests so they deserve
       # a descriptive name.
       #
-      # This cop can be configured in your configuration using the
-      # `IgnoreSharedExamples` which will not report offenses for implicit
+      # This cop can be configured in your configuration using `EnforcedStyle`,
+      # and `IgnoreSharedExamples` which will not report offenses for implicit
       # subjects in shared example groups.
       #
-      # @example
+      # @example `EnforcedStyle: always` (default)
       #   # bad
       #   RSpec.describe User do
       #     subject { described_class.new }
@@ -27,7 +27,7 @@ module RuboCop
       #   end
       #
       #   # good
-      #   RSpec.describe Foo do
+      #   RSpec.describe User do
       #     subject(:user) { described_class.new }
       #
       #     it 'is valid' do
@@ -36,13 +36,49 @@ module RuboCop
       #   end
       #
       #   # also good
-      #   RSpec.describe Foo do
+      #   RSpec.describe User do
+      #     subject(:user) { described_class.new }
+      #
+      #     it { is_expected.to be_valid }
+      #   end
+      #
+      # @example `EnforcedStyle: named_only`
+      #   # bad
+      #   RSpec.describe User do
+      #     subject(:user) { described_class.new }
+      #
+      #     it 'is valid' do
+      #       expect(subject.valid?).to be(true)
+      #     end
+      #   end
+      #
+      #   # good
+      #   RSpec.describe User do
       #     subject(:user) { described_class.new }
       #
+      #     it 'is valid' do
+      #       expect(user.valid?).to be(true)
+      #     end
+      #   end
+      #
+      #   # also good
+      #   RSpec.describe User do
+      #     subject { described_class.new }
+      #
       #     it { is_expected.to be_valid }
       #   end
       #
+      #   # acceptable
+      #   RSpec.describe User do
+      #     subject { described_class.new }
+      #
+      #     it 'is valid' do
+      #       expect(subject.valid?).to be(true)
+      #     end
+      #   end
       class NamedSubject < Base
+        include ConfigurableEnforcedStyle
+
         MSG = 'Name your test subject if you need to reference it explicitly.'
 
         # @!method example_or_hook_block?(node)
@@ -62,14 +98,53 @@ module RuboCop
           end
 
           subject_usage(node) do |subject_node|
-            add_offense(subject_node.loc.selector)
+            check_explicit_subject(subject_node)
           end
         end
 
+        private
+
         def ignored_shared_example?(node)
           cop_config['IgnoreSharedExamples'] &&
             node.each_ancestor(:block).any?(&method(:shared_example?))
         end
+
+        def check_explicit_subject(node)
+          return if allow_explicit_subject?(node)
+
+          add_offense(node.loc.selector)
+        end
+
+        def allow_explicit_subject?(node)
+          !always? && !named_only?(node)
+        end
+
+        def always?
+          style == :always
+        end
+
+        def named_only?(node)
+          style == :named_only &&
+            subject_definition_is_named?(node)
+        end
+
+        def subject_definition_is_named?(node)
+          subject = nearest_subject(node)
+
+          subject&.send_node&.arguments?
+        end
+
+        def nearest_subject(node)
+          node
+            .each_ancestor(:block)
+            .lazy
+            .map { |block_node| find_subject(block_node) }
+            .find(&:itself)
+        end
+
+        def find_subject(block_node)
+          block_node.body.child_nodes.find { |send_node| subject?(send_node) }
+        end
       end
     end
   end

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

@@ -133,7 +133,7 @@ module RuboCop
         def count_up_nesting?(node, example_group)
           example_group &&
             (node.block_type? &&
-            !allowed_groups.include?(node.method_name))
+            !allowed_groups.include?(node.method_name.to_s))
         end
 
         def message(nesting)

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

@@ -77,7 +77,7 @@ module RuboCop
         def_node_search :includes_expectation?, <<~PATTERN
           {
             #{send_pattern('#Expectations.all')}
-            (send nil? `#matches_allowed_pattern?)
+            (send nil? `#matches_allowed_pattern? ...)
           }
         PATTERN
 

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

@@ -45,8 +45,12 @@ module RuboCop
         def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group?(node)
 
-          repeated_descriptions(node).each do |repeated_description|
-            add_offense(repeated_description)
+          repeated_descriptions(node).each do |description|
+            add_offense(description)
+          end
+
+          repeated_its(node).each do |its|
+            add_offense(its)
           end
         end
 
@@ -57,6 +61,7 @@ module RuboCop
           grouped_examples =
             RuboCop::RSpec::ExampleGroup.new(node)
               .examples
+              .reject { |n| n.definition.method?(:its) }
               .group_by { |example| example_signature(example) }
 
           grouped_examples
@@ -66,9 +71,27 @@ module RuboCop
             .map(&:definition)
         end
 
+        def repeated_its(node)
+          grouped_its =
+            RuboCop::RSpec::ExampleGroup.new(node)
+              .examples
+              .select { |n| n.definition.method?(:its) }
+              .group_by { |example| its_signature(example) }
+
+          grouped_its
+            .select { |signatures, group| signatures.any? && group.size > 1 }
+            .values
+            .flatten
+            .map(&:to_node)
+        end
+
         def example_signature(example)
           [example.metadata, example.doc_string]
         end
+
+        def its_signature(example)
+          [example.doc_string, example]
+        end
       end
     end
   end

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

@@ -26,8 +26,7 @@ module RuboCop
         def_node_matcher :rspec_metadata, <<~PATTERN
           (block
             (send
-              #rspec? {#Examples.all #ExampleGroups.all #SharedGroups.all #Hooks.all #Includes.all}
-              _ ${send str sym}* (hash $...)?)
+              #rspec? {#Examples.all #ExampleGroups.all #SharedGroups.all #Hooks.all} _ ${send str sym}* (hash $...)?)
             ...)
         PATTERN
 

data/lib/rubocop/rspec/language.rb

@@ -135,8 +135,9 @@ module RuboCop
       end
 
       module HookScopes # :nodoc:
+        ALL = %i[each example context all suite].freeze
         def self.all(element)
-          Language.config['HookScopes'].include?(element.to_s)
+          ALL.include?(element)
         end
       end
 
@@ -158,8 +159,9 @@ module RuboCop
       end
 
       module Runners # :nodoc:
+        ALL = %i[to to_not not_to].freeze
         def self.all(element)
-          Language.config['Runners'].include?(element.to_s)
+          ALL.include?(element)
         end
       end
 

data/lib/rubocop/rspec/shared_contexts/default_rspec_language_config_context.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'with default RSpec/Language config' do
+  include_context 'config'
+
+  # Deep duplication is needed to prevent config leakage between examples
+  let(:other_cops) do
+    default_language = RuboCop::ConfigLoader
+      .default_configuration['RSpec']['Language']
+    default_include = RuboCop::ConfigLoader
+      .default_configuration['RSpec']['Include']
+    { 'RSpec' =>
+      {
+        'Include' => default_include,
+        'Language' => deep_dup(default_language)
+      } }
+  end
+
+  def deep_dup(object)
+    case object
+    when Array
+      object.map { |item| deep_dup(item) }
+    when Hash
+      object.transform_values(&method(:deep_dup))
+    else
+      object # only collections undergo modifications and need duping
+    end
+  end
+end

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.14.1'
+      STRING = '2.15.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.14.1
+  version: 2.15.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -178,6 +178,7 @@ files:
 - lib/rubocop/rspec/language.rb
 - lib/rubocop/rspec/language/node_pattern.rb
 - lib/rubocop/rspec/node.rb
+- lib/rubocop/rspec/shared_contexts/default_rspec_language_config_context.rb
 - lib/rubocop/rspec/version.rb
 - lib/rubocop/rspec/wording.rb
 homepage: https://github.com/rubocop/rubocop-rspec