Class: RuboCop::Cop::Cop Deprecated

# File 'lib/rubocop/cop/cop.rb', line 25

def self.inherited(_subclass)
  super
  warn Rainbow(<<~WARNING).yellow, uplevel: 1
    Inheriting from `RuboCop::Cop::Cop` is deprecated. Use `RuboCop::Cop::Base` instead.
    For more information, see https://docs.rubocop.org/rubocop/v1_upgrade_notes.html.
  WARNING
end

# File 'lib/rubocop/cop/cop.rb', line 37

def self.joining_forces
  return unless method_defined?(:join_force?)

  cop = new
  Force.all.select { |force_class| cop.join_force?(force_class) }
end

# File 'lib/rubocop/cop/cop.rb', line 65

def self.qualified_cop_name(name, origin)
  warn Rainbow(<<~WARNING).yellow, uplevel: 1
    `Cop.qualified_cop_name` is deprecated. Use `Registry.qualified_cop_name` instead.
  WARNING

  Registry.qualified_cop_name(name, origin)
end

# File 'lib/rubocop/cop/cop.rb', line 47

def self.registry
  warn Rainbow(<<~WARNING).yellow, uplevel: 1
    `Cop.registry` is deprecated. Use `Registry.global` instead.
  WARNING

  Registry.global
end

# File 'lib/rubocop/cop/cop.rb', line 96

def support_autocorrect?
  warn Rainbow(<<~WARNING).yellow, uplevel: 1
    `support_autocorrect?` is deprecated. Use `cop.class.support_autocorrect?`.
  WARNING

  self.class.support_autocorrect?
end

# File 'lib/rubocop/cop/cop.rb', line 147

def apply_correction(corrector)
  suppress_clobbering { super }
end

# File 'lib/rubocop/cop/cop.rb', line 129

def begin_investigation(processed_source, offset: 0, original: processed_source)
  super
  @offenses = current_offenses
  @last_corrector = @current_corrector

  # We need to keep track of the original source and offset,
  # because `processed_source` here may be an embedded code in it.
  @current_offset = offset
  @current_original = original
end

# File 'lib/rubocop/cop/cop.rb', line 143

def callback_argument(_range)
  @v0_argument
end

# File 'lib/rubocop/cop/cop.rb', line 164

def correction_lambda
  return unless self.class.support_autocorrect?

  dedupe_on_node(@v0_argument) { autocorrect(@v0_argument) }
end

# File 'lib/rubocop/cop/cop.rb', line 105

def corrections
  warn Rainbow(<<~WARNING).yellow, uplevel: 1
    `Cop#corrections` is deprecated.
  WARNING

  return [] unless @last_corrector

  Legacy::CorrectionsProxy.new(@last_corrector)
end

# File 'lib/rubocop/cop/cop.rb', line 170

def dedupe_on_node(node)
  @corrected_nodes ||= {}.compare_by_identity
  yield unless @corrected_nodes.key?(node)
ensure
  @corrected_nodes[node] = true
end

# File 'lib/rubocop/cop/cop.rb', line 152

def emulate_v0_callsequence(corrector)
  lambda = correction_lambda
  yield corrector if block_given?
  unless corrector.empty?
    raise 'Your cop must inherit from Cop::Base and extend AutoCorrector'
  end

  return unless lambda

  suppress_clobbering { lambda.call(corrector) }
end

# File 'lib/rubocop/cop/cop.rb', line 90

def find_location(node, loc)
  # Location can be provided as a symbol, e.g.: `:keyword`
  loc.is_a?(Symbol) ? node.loc.public_send(loc) : loc
end

# File 'lib/rubocop/rspec/cop_helper.rb', line 94

def highlights
  offenses.sort.map { |o| o.location.source }
end

# File 'lib/rubocop/rspec/cop_helper.rb', line 90

def messages
  offenses.sort.map(&:message)
end

# File 'lib/rubocop/cop/cop.rb', line 122

def on_investigation_end
  investigate_post_walk(processed_source) if respond_to?(:investigate_post_walk)
  super
end

# File 'lib/rubocop/cop/cop.rb', line 116

def on_new_investigation
  investigate(processed_source) if respond_to?(:investigate)
  super
end

# File 'lib/rubocop/cop/cop.rb', line 183

def range_for_original(range)
  ::Parser::Source::Range.new(
    @current_original.buffer,
    range.begin_pos + @current_offset,
    range.end_pos + @current_offset
  )
end

# File 'lib/rubocop/cop/cop.rb', line 177

def suppress_clobbering
  yield
rescue ::Parser::ClobberingError
  # ignore Clobbering errors
end