rubocop-rspec 2.29.1 → 3.5.0

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    module Cop
+      # Source and spec generator for new cops
+      #
+      # This generator will take a cop name and generate a source file
+      # and spec file when given a valid qualified cop name.
+      # @api private
+      class Generator < RuboCop::Cop::Generator
+        def todo
+          <<~TODO
+            Do 4 steps:
+              1. Modify the description of #{badge} in config/default.yml
+              2. Implement your new cop in the generated file!
+              3. Add an entry about new cop to CHANGELOG.md
+              4. Commit your new cop with a message such as
+                 e.g. "Add new `#{badge}` cop"
+          TODO
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/description_extractor.rb

@@ -62,8 +62,8 @@ module RuboCop
         end
 
         def cop_subclass?
-          yardoc.superclass.path == RSPEC_COP_CLASS_NAME ||
-            yardoc.superclass.path == RUBOCOP_COP_CLASS_NAME
+          [RSPEC_COP_CLASS_NAME,
+           RUBOCOP_COP_CLASS_NAME].include?(yardoc.superclass.path)
         end
 
         def abstract?

data/lib/rubocop/rspec/hook.rb

@@ -45,7 +45,7 @@ module RuboCop
       private
 
       def valid_scope?(node)
-        node&.sym_type? && Language::HookScopes.all(node.value)
+        node.sym_type? && Language::HookScopes.all(node.value)
       end
 
       def transform_metadata(meta)

data/lib/rubocop/rspec/language.rb

@@ -13,7 +13,6 @@ module RuboCop
     # using the configured aliases.
     module Language
       extend RuboCop::NodePattern::Macros
-      extend NodePattern
 
       class << self
         attr_accessor :config

data/lib/rubocop/rspec/node.rb

@@ -9,7 +9,7 @@ module RuboCop
       def recursive_literal_or_const?
         case type
         when :begin, :pair, *AST::Node::COMPOSITE_LITERALS
-          children.all?(&:recursive_literal_or_const?)
+          children.compact.all?(&:recursive_literal_or_const?)
         else
           literal? || const_type?
         end

data/lib/rubocop/rspec/plugin.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module RSpec
+    # A plugin that integrates RuboCop RSpec with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      # :nocov:
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-rspec',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-rspec',
+          description: 'Code style checking for RSpec files.'
+        )
+      end
+      # :nocov:
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        ConfigObsoletion.files << project_root.join('config', 'obsoletion.yml')
+
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: project_root.join('config/default.yml')
+        )
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ RSpec.shared_context 'with default RSpec/Language config' do
     when Array
       object.map { |item| deep_dup(item) }
     when Hash
-      object.transform_values(&method(:deep_dup))
+      object.transform_values { |value| deep_dup(value) }
     else
       object # only collections undergo modifications and need duping
     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.29.1'
+      STRING = '3.5.0'
     end
   end
 end

data/lib/rubocop/rspec/wording.rb

@@ -4,10 +4,10 @@ module RuboCop
   module RSpec
     # RSpec example wording rewriter
     class Wording
-      SHOULDNT_PREFIX    = /\Ashould(?:n't| not)\b/i.freeze
+      SHOULDNT_PREFIX    = /\Ashould(?:n't|n’t| not)\b/i.freeze
       SHOULDNT_BE_PREFIX = /#{SHOULDNT_PREFIX} be\b/i.freeze
       WILL_NOT_PREFIX    = /\Awill not\b/i.freeze
-      WONT_PREFIX        = /\Awon't\b/i.freeze
+      WONT_PREFIX        = /\Awo(?:n't|n’t)\b/i.freeze
       ES_SUFFIX_PATTERN  = /(?:o|s|x|ch|sh|z)\z/i.freeze
       IES_SUFFIX_PATTERN = /[^aeou]y\z/i.freeze
 
@@ -17,7 +17,6 @@ module RuboCop
         @replacements = replace
       end
 
-      # rubocop:disable Metrics/MethodLength
       def rewrite
         case text
         when SHOULDNT_BE_PREFIX
@@ -32,7 +31,6 @@ module RuboCop
           remove_should_and_pluralize
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/rubocop/rspec.rb

@@ -3,12 +3,5 @@
 module RuboCop
   # RuboCop RSpec project namespace
   module RSpec
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-
-    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config',
-                                                           'obsoletion.yml')
   end
 end

data/lib/rubocop-rspec.rb

@@ -4,19 +4,14 @@ require 'pathname'
 require 'yaml'
 
 require 'rubocop'
-require 'rubocop-capybara'
-require 'rubocop-factory_bot'
 
 require_relative 'rubocop/rspec'
-require_relative 'rubocop/rspec/inject'
-require_relative 'rubocop/rspec/language/node_pattern'
+require_relative 'rubocop/rspec/language'
 require_relative 'rubocop/rspec/node'
+require_relative 'rubocop/rspec/plugin'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/wording'
 
-# Dependent on `RuboCop::RSpec::Language::NodePattern`.
-require_relative 'rubocop/rspec/language'
-
 require_relative 'rubocop/cop/rspec/mixin/file_help'
 require_relative 'rubocop/cop/rspec/mixin/final_end_location'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
@@ -39,11 +34,6 @@ require_relative 'rubocop/rspec/example'
 require_relative 'rubocop/rspec/example_group'
 require_relative 'rubocop/rspec/hook'
 
-# need after `require 'rubocop/cop/rspec/base'``
-require 'rubocop-rspec_rails'
-
-RuboCop::RSpec::Inject.defaults!
-
 require_relative 'rubocop/cop/rspec_cops'
 
 # We have to register our autocorrect incompatibilities in RuboCop's cops
@@ -58,12 +48,4 @@ RuboCop::Cop::Layout::ExtraSpacing.singleton_class.prepend(
   end
 )
 
-RuboCop::Cop::Style::TrailingCommaInArguments.singleton_class.prepend(
-  Module.new do
-    def autocorrect_incompatible_with
-      super.push(RuboCop::Cop::RSpec::Capybara::CurrentPathExpectation)
-    end
-  end
-)
-
 RuboCop::AST::Node.include(RuboCop::RSpec::Node)

metadata

@@ -1,73 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.29.1
+  version: 3.5.0
 platform: ruby
 authors:
 - John Backus
 - Ian MacLeod
 - Nils Gemeinhardt
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2025-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: lint_roller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.40'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.40'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop-capybara
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.17'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.17'
-- !ruby/object:Gem::Dependency
-  name: rubocop-factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '1.72'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.22'
+        version: 1.72.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.22'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.28'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '1.72'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.28'
+        version: 1.72.1
 description: |
   Code style checking for RSpec files.
   A plugin for the RuboCop code style enforcing & linting tool.
@@ -99,14 +76,6 @@ files:
 - lib/rubocop/cop/rspec/be_eql.rb
 - lib/rubocop/cop/rspec/be_nil.rb
 - lib/rubocop/cop/rspec/before_after_all.rb
-- lib/rubocop/cop/rspec/capybara/current_path_expectation.rb
-- lib/rubocop/cop/rspec/capybara/feature_methods.rb
-- lib/rubocop/cop/rspec/capybara/match_style.rb
-- lib/rubocop/cop/rspec/capybara/negation_matcher.rb
-- lib/rubocop/cop/rspec/capybara/specific_actions.rb
-- lib/rubocop/cop/rspec/capybara/specific_finders.rb
-- lib/rubocop/cop/rspec/capybara/specific_matcher.rb
-- lib/rubocop/cop/rspec/capybara/visibility_matcher.rb
 - lib/rubocop/cop/rspec/change_by_zero.rb
 - lib/rubocop/cop/rspec/class_check.rb
 - lib/rubocop/cop/rspec/contain_exactly.rb
@@ -136,14 +105,8 @@ files:
 - lib/rubocop/cop/rspec/expect_actual.rb
 - lib/rubocop/cop/rspec/expect_change.rb
 - lib/rubocop/cop/rspec/expect_in_hook.rb
+- lib/rubocop/cop/rspec/expect_in_let.rb
 - lib/rubocop/cop/rspec/expect_output.rb
-- lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb
-- lib/rubocop/cop/rspec/factory_bot/consistent_parentheses_style.rb
-- lib/rubocop/cop/rspec/factory_bot/create_list.rb
-- lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb
-- lib/rubocop/cop/rspec/factory_bot/factory_name_style.rb
-- lib/rubocop/cop/rspec/factory_bot/syntax_methods.rb
-- lib/rubocop/cop/rspec/file_path.rb
 - lib/rubocop/cop/rspec/focus.rb
 - lib/rubocop/cop/rspec/hook_argument.rb
 - lib/rubocop/cop/rspec/hooks_before_examples.rb
@@ -167,6 +130,7 @@ files:
 - lib/rubocop/cop/rspec/message_spies.rb
 - lib/rubocop/cop/rspec/metadata_style.rb
 - lib/rubocop/cop/rspec/missing_example_group_argument.rb
+- lib/rubocop/cop/rspec/missing_expectation_target_method.rb
 - lib/rubocop/cop/rspec/mixin/comments_help.rb
 - lib/rubocop/cop/rspec/mixin/empty_line_separation.rb
 - lib/rubocop/cop/rspec/mixin/file_help.rb
@@ -190,13 +154,6 @@ files:
 - lib/rubocop/cop/rspec/pending.rb
 - lib/rubocop/cop/rspec/pending_without_reason.rb
 - lib/rubocop/cop/rspec/predicate_matcher.rb
-- lib/rubocop/cop/rspec/rails/avoid_setup_hook.rb
-- lib/rubocop/cop/rspec/rails/have_http_status.rb
-- lib/rubocop/cop/rspec/rails/http_status.rb
-- lib/rubocop/cop/rspec/rails/inferred_spec_type.rb
-- lib/rubocop/cop/rspec/rails/minitest_assertions.rb
-- lib/rubocop/cop/rspec/rails/negation_be_valid.rb
-- lib/rubocop/cop/rspec/rails/travel_around.rb
 - lib/rubocop/cop/rspec/receive_counts.rb
 - lib/rubocop/cop/rspec/receive_messages.rb
 - lib/rubocop/cop/rspec/receive_never.rb
@@ -235,15 +192,15 @@ files:
 - lib/rubocop/rspec/align_let_brace.rb
 - lib/rubocop/rspec/concept.rb
 - lib/rubocop/rspec/config_formatter.rb
+- lib/rubocop/rspec/cop/generator.rb
 - lib/rubocop/rspec/corrector/move_node.rb
 - lib/rubocop/rspec/description_extractor.rb
 - lib/rubocop/rspec/example.rb
 - lib/rubocop/rspec/example_group.rb
 - lib/rubocop/rspec/hook.rb
-- lib/rubocop/rspec/inject.rb
 - lib/rubocop/rspec/language.rb
-- lib/rubocop/rspec/language/node_pattern.rb
 - lib/rubocop/rspec/node.rb
+- lib/rubocop/rspec/plugin.rb
 - lib/rubocop/rspec/shared_contexts/default_rspec_language_config_context.rb
 - lib/rubocop/rspec/version.rb
 - lib/rubocop/rspec/wording.rb
@@ -254,7 +211,7 @@ metadata:
   changelog_uri: https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-rspec/
   rubygems_mfa_required: 'true'
-post_install_message: 
+  default_lint_roller_plugin: RuboCop::RSpec::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -269,8 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Checks that no expectations are set on Capybara's `current_path`.
-        #   #
-        #   # The
-        #   # https://www.rubydoc.info/github/teamcapybara/capybara/master/Capybara/RSpecMatchers#have_current_path-instance_method[`have_current_path` matcher]
-        #   # should be used on `page` to set expectations on Capybara's
-        #   # current path, since it uses
-        #   # https://github.com/teamcapybara/capybara/blob/master/README.md#asynchronous-javascript-ajax-and-friends[Capybara's waiting functionality]
-        #   # which ensures that preceding actions (like `click_link`) have
-        #   # completed.
-        #   #
-        #   # This cop does not support autocorrection in some cases.
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   expect(current_path).to eq('/callback')
-        #   #
-        #   #   # good
-        #   #   expect(page).to have_current_path('/callback')
-        #   #
-        #   #   # bad (does not support autocorrection)
-        #   #   expect(page.current_path).to match(variable)
-        #   #
-        #   #   # good
-        #   #   expect(page).to have_current_path('/callback')
-        #   #
-        #   class CurrentPathExpectation < ::RuboCop::Cop::Base; end
-        CurrentPathExpectation =
-          ::RuboCop::Cop::Capybara::CurrentPathExpectation
-      end
-    end
-  end
-end

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

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # Checks for consistent method usage in feature specs.
-        #
-        # By default, the cop disables all Capybara-specific methods that have
-        # the same native RSpec method (e.g. are just aliases). Some teams
-        # however may prefer using some of the Capybara methods (like `feature`)
-        # to make it obvious that the test uses Capybara, while still disable
-        # the rest of the methods, like `given` (alias for `let`), `background`
-        # (alias for `before`), etc. You can configure which of the methods to
-        # be enabled by using the EnabledMethods configuration option.
-        #
-        # @example
-        #   # bad
-        #   feature 'User logs in' do
-        #     given(:user) { User.new }
-        #
-        #     background do
-        #       visit new_session_path
-        #     end
-        #
-        #     scenario 'with OAuth' do
-        #       # ...
-        #     end
-        #   end
-        #
-        #   # good
-        #   describe 'User logs in' do
-        #     let(:user) { User.new }
-        #
-        #     before do
-        #       visit new_session_path
-        #     end
-        #
-        #     it 'with OAuth' do
-        #       # ...
-        #     end
-        #   end
-        #
-        class FeatureMethods < Base
-          extend AutoCorrector
-          include InsideExampleGroup
-
-          MSG = 'Use `%<replacement>s` instead of `%<method>s`.'
-
-          # https://github.com/teamcapybara/capybara/blob/e283c1aeaa72441f5403963577e16333bf111a81/lib/capybara/rspec/features.rb#L31-L36
-          MAP = {
-            background: :before,
-            scenario:   :it,
-            xscenario:  :xit,
-            given:      :let,
-            given!:     :let!,
-            feature:    :describe
-          }.freeze
-
-          # @!method capybara_speak(node)
-          def_node_matcher :capybara_speak, <<~PATTERN
-            {#{MAP.keys.map(&:inspect).join(' ')}}
-          PATTERN
-
-          # @!method feature_method(node)
-          def_node_matcher :feature_method, <<~PATTERN
-            (block
-              $(send #rspec? $#capybara_speak ...)
-            ...)
-          PATTERN
-
-          def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
-            return unless inside_example_group?(node)
-
-            feature_method(node) do |send_node, match|
-              next if enabled?(match)
-
-              add_offense(send_node.loc.selector) do |corrector|
-                corrector.replace(send_node.loc.selector, MAP[match].to_s)
-              end
-            end
-          end
-
-          def message(range)
-            name = range.source.to_sym
-            format(MSG, method: name, replacement: MAP[name])
-          end
-
-          private
-
-          def enabled?(method_name)
-            enabled_methods.include?(method_name)
-          end
-
-          def enabled_methods
-            cop_config
-              .fetch('EnabledMethods', [])
-              .map(&:to_sym)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Checks for usage of deprecated style methods.
-        #   #
-        #   # @example when using `assert_style`
-        #   #   # bad
-        #   #   page.find(:css, '#first').assert_style(display: 'block')
-        #   #
-        #   #   # good
-        #   #   page.find(:css, '#first').assert_matches_style(display: 'block')
-        #   #
-        #   # @example when using `has_style?`
-        #   #   # bad
-        #   #   expect(page.find(:css, 'first')
-        #   #     .has_style?(display: 'block')).to be true
-        #   #
-        #   #   # good
-        #   #   expect(page.find(:css, 'first')
-        #   #     .matches_style?(display: 'block')).to be true
-        #   #
-        #   # @example when using `have_style`
-        #   #   # bad
-        #   #   expect(page).to have_style(display: 'block')
-        #   #
-        #   #   # good
-        #   #   expect(page).to match_style(display: 'block')
-        #   #
-        #   class MatchStyle < ::RuboCop::Cop::Base; end
-        MatchStyle = ::RuboCop::Cop::Capybara::MatchStyle
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Enforces use of `have_no_*` or `not_to` for negated expectations.
-        #   #
-        #   # @example EnforcedStyle: not_to (default)
-        #   #   # bad
-        #   #   expect(page).to have_no_selector
-        #   #   expect(page).to have_no_css('a')
-        #   #
-        #   #   # good
-        #   #   expect(page).not_to have_selector
-        #   #   expect(page).not_to have_css('a')
-        #   #
-        #   # @example EnforcedStyle: have_no
-        #   #   # bad
-        #   #   expect(page).not_to have_selector
-        #   #   expect(page).not_to have_css('a')
-        #   #
-        #   #   # good
-        #   #   expect(page).to have_no_selector
-        #   #   expect(page).to have_no_css('a')
-        #   #
-        #   class NegationMatcher < ::RuboCop::Cop::Base; end
-        NegationMatcher = ::RuboCop::Cop::Capybara::NegationMatcher
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Checks for there is a more specific actions offered by Capybara.
-        #   #
-        #   # @example
-        #   #
-        #   #   # bad
-        #   #   find('a').click
-        #   #   find('button.cls').click
-        #   #   find('a', exact_text: 'foo').click
-        #   #   find('div button').click
-        #   #
-        #   #   # good
-        #   #   click_link
-        #   #   click_button(class: 'cls')
-        #   #   click_link(exact_text: 'foo')
-        #   #   find('div').click_button
-        #   #
-        #   class SpecificActions < ::RuboCop::Cop::Base; end
-        SpecificActions = ::RuboCop::Cop::Capybara::SpecificActions
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Checks if there is a more specific finder offered by Capybara.
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   find('#some-id')
-        #   #   find('[visible][id=some-id]')
-        #   #
-        #   #   # good
-        #   #   find_by_id('some-id')
-        #   #   find_by_id('some-id', visible: true)
-        #   #
-        #   class SpecificFinders < ::RuboCop::Cop::Base; end
-        SpecificFinders = ::RuboCop::Cop::Capybara::SpecificFinders
-      end
-    end
-  end
-end