Sha256: fb41eadd76fcbb3a5192f938017cf3090c3d9c2e779ea2a9f002f102fd6d9761

Contents?: true

Size: 1.69 KB

Versions: 174

Compression:

Stored size: 1.69 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module InternalAffairs
      # Enforces the use of `node.single_line?` instead of
      # comparing `first_line` and `last_line` for equality.
      #
      # @example
      #   # bad
      #   node.loc.first_line == node.loc.last_line
      #
      #   # bad
      #   node.loc.last_line == node.loc.first_line
      #
      #   # bad
      #   node.loc.line == node.loc.last_line
      #
      #   # bad
      #   node.loc.last_line == node.loc.line
      #
      #   # bad
      #   node.first_line == node.last_line
      #
      #   # good
      #   node.single_line?
      #
      class SingleLineComparison < Base
        extend AutoCorrector

        MSG = 'Use `%<preferred>s`.'
        RESTRICT_ON_SEND = %i[== !=].freeze

        # @!method single_line_comparison(node)
        def_node_matcher :single_line_comparison, <<~PATTERN
          {
            (send (send $_receiver {:line :first_line}) {:== :!=} (send _receiver :last_line))
            (send (send $_receiver :last_line) {:== :!=} (send _receiver {:line :first_line}))
          }
        PATTERN

        def on_send(node)
          return unless (receiver = single_line_comparison(node))

          bang = node.method?(:!=) ? '!' : ''
          preferred = "#{bang}#{extract_receiver(receiver)}.single_line?"

          add_offense(node, message: format(MSG, preferred: preferred)) do |corrector|
            corrector.replace(node, preferred)
          end
        end

        private

        def extract_receiver(node)
          node = node.receiver if node.send_type? && %i[loc source_range].include?(node.method_name)
          node.source
        end
      end
    end
  end
end

Version data entries

174 entries across 169 versions & 17 rubygems

Version Path
rubocop-1.68.0 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.67.0 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.66.1 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.66.0 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.65.1 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.65.0 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/internal_affairs/single_line_comparison.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/internal_affairs/single_line_comparison.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/internal_affairs/single_line_comparison.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-1.64.1/lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.64.1 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.63.4 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.63.3 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.63.2 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
harbr-2.8.1 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.63.1 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.63.0 lib/rubocop/cop/internal_affairs/single_line_comparison.rb
bison-0.1.0 vendor/bundle/ruby/3.2.0/gems/rubocop-1.62.1/lib/rubocop/cop/internal_affairs/single_line_comparison.rb
rubocop-1.62.1 lib/rubocop/cop/internal_affairs/single_line_comparison.rb