Sha256: 5fb953483035006e3f8ae86586cd1edf487ed55f4a1392e48dc45e1b2edf4c98

Contents?: true

Size: 1.63 KB

Versions: 19

Compression:

Stored size: 1.63 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module InternalAffairs
      # This cop enforces the use of `same_line?` instead of location line comparison for equality.
      #
      # @example
      #   # bad
      #   node.loc.line == node.parent.loc.line
      #
      #   # bad
      #   node.loc.first_line == node.parent.loc.first_line
      #
      #   # good
      #   same_line?(node, node.parent)
      #
      class LocationLineEqualityComparison < Base
        extend AutoCorrector

        MSG = 'Use `%<preferred>s`.'

        # @!method line_send(node)
        def_node_matcher :line_send, <<~PATTERN
          {
            (send (send _ {:loc :source_range}) {:line :first_line})
            (send _ :first_line)
          }
        PATTERN

        # @!method location_line_equality_comparison?(node)
        def_node_matcher :location_line_equality_comparison?, <<~PATTERN
          (send #line_send :== #line_send)
        PATTERN

        def on_send(node)
          return unless location_line_equality_comparison?(node)

          lhs, _op, rhs = *node

          lhs_receiver = extract_receiver(lhs)
          rhs_receiver = extract_receiver(rhs)
          preferred = "same_line?(#{lhs_receiver}, #{rhs_receiver})"

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

        private

        def extract_receiver(node)
          receiver = node.receiver
          receiver = receiver.receiver if receiver.method?(:loc) || receiver.method?(:source_range)
          receiver.source
        end
      end
    end
  end
end

Version data entries

19 entries across 19 versions & 4 rubygems

Version Path
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.29.1 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.29.0 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.28.2 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.28.1 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.28.0 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.27.0 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.26.1 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
op_connect-0.1.2 vendor/bundle/ruby/3.1.0/gems/rubocop-1.26.0/lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.26.0 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.25.1 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.25.0 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
phillipug-foodie-0.1.0 .vendor/ruby/3.0.0/gems/rubocop-1.24.0/lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.24.1 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.24.0 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.23.0 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.22.3 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
rubocop-1.22.2 lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb