Class: RuboCop::Cop::InternalAffairs::RedundantSourceRange

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/internal_affairs/redundant_source_range.rb

Overview

Checks for redundant ‘source_range`.

Examples:


# bad
node.source_range.source

# good
node.source

# bad
add_offense(node.source_range)

# good
add_offense(node)

# bad
add_offense(node) { |corrector| corrector.replace(node.source_range, prefer) }
add_offense(node) { |corrector| corrector.insert_before(node.source_range, prefer) }
add_offense(node) { |corrector| corrector.insert_before_multi(node.source_range, prefer) }
add_offense(node) { |corrector| corrector.insert_after(node.source_range, prefer) }
add_offense(node) { |corrector| corrector.insert_after_multi(node.source_range, prefer) }
add_offense(node) { |corrector| corrector.swap(node.source_range, before, after) }

# good
add_offense(node) { |corrector| corrector.replace(node, prefer) }
add_offense(node) { |corrector| corrector.insert_before(node, prefer) }
add_offense(node) { |corrector| corrector.insert_before_multi(node, prefer) }
add_offense(node) { |corrector| corrector.insert_after(node, prefer) }
add_offense(node) { |corrector| corrector.insert_after_multi(node, prefer) }
add_offense(node) { |corrector| corrector.swap(node, before, after) }

Constant Summary collapse

MSG = 
'Remove the redundant `source_range`.'
RESTRICT_ON_SEND = 
%i[
  source add_offense
  replace remove insert_before insert_before_multi insert_after insert_after_multi swap
].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from RuboCop::Cop::IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#on_send(node) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rubocop/cop/internal_affairs/redundant_source_range.rb', line 60

def on_send(node)
  return unless (source_range = redundant_source_range(node))
  return if source_range.receiver.send_type? && source_range.receiver.method?(:buffer)

  selector = source_range.loc.selector

  add_offense(selector) do |corrector|
    corrector.remove(source_range.loc.dot.join(selector))
  end
end

#redundant_source_range(node) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/rubocop/cop/internal_affairs/redundant_source_range.rb', line 48

def_node_matcher :redundant_source_range, <<~PATTERN
  {
    (send $(send _ :source_range) :source)
    (send nil? :add_offense $(send _ :source_range) ...)
    (send _ {
      :replace :insert_before :insert_before_multi :insert_after :insert_after_multi
    } $(send _ :source_range) _)
    (send _ :remove $(send _ :source_range))
    (send _ :swap $(send _ :source_range) _ _)
  }
PATTERN