Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module RSpec
      # Checks for redundant predicate matcher.
      #
      # @example
      #   # bad
      #   expect(foo).to be_exist(bar)
      #   expect(foo).not_to be_include(bar)
      #
      #   # good
      #   expect(foo).to exist(bar)
      #   expect(foo).not_to include(bar)
      #
      class RedundantPredicateMatcher < Base
        extend AutoCorrector

        MSG = 'Use `%<good>s` instead of `%<bad>s`.'
        RESTRICT_ON_SEND =
          %i[be_all be_cover be_end_with be_eql be_equal
             be_exist be_exists be_include be_match
             be_respond_to be_start_with].freeze

        def on_send(node)
          return if node.parent.block_type? || node.arguments.empty?
          return unless replacable_arguments?(node)

          method_name = node.method_name.to_s
          replaced = replaced_method_name(method_name)
          add_offense(node, message: message(method_name,
                                             replaced)) do |corrector|
            unless node.method?(:be_all)
              corrector.replace(node.loc.selector, replaced)
            end
          end
        end

        private

        def message(bad_method, good_method)
          format(MSG, bad: bad_method, good: good_method)
        end

        def replacable_arguments?(node)
          if node.method?(:be_all)
            node.first_argument.send_type?
          else
            true
          end
        end

        def replaced_method_name(method_name)
          name = method_name.to_s.delete_prefix('be_')
          if name == 'exists'
            'exist'
          else
            name
          end
        end
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 2 rubygems

Version	Path
mlh-rubocop-config-1.0.3	vendor/bundle/ruby/3.2.0/gems/rubocop-rspec-2.26.1/lib/rubocop/cop/rspec/redundant_predicate_matcher.rb
rubocop-rspec-2.26.1	lib/rubocop/cop/rspec/redundant_predicate_matcher.rb
rubocop-rspec-2.26.0	lib/rubocop/cop/rspec/redundant_predicate_matcher.rb