Class: RuboCop::Cop::InternalAffairs::ProcessedSourceBufferName

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

Overview

Enforces the use of processed_source.file_path instead of processed_source.buffer.name.

Examples:


# bad
processed_source.buffer.name

# good
processed_source.file_path

Constant Summary collapse

MSG =
'Use `file_path` instead.'
RESTRICT_ON_SEND =
%i[name].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, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #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, #ready, #relevant_file?, 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



30
31
32
33
34
35
36
37
38
# File 'lib/rubocop/cop/internal_affairs/processed_source_buffer_name.rb', line 30

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

  offense_range = node.children.first.loc.selector.begin.join(node.source_range.end)

  add_offense(offense_range) do |corrector|
    corrector.replace(offense_range, 'file_path')
  end
end

#processed_source_buffer_name?(node) ⇒ Object



24
25
26
27
28
# File 'lib/rubocop/cop/internal_affairs/processed_source_buffer_name.rb', line 24

def_node_matcher :processed_source_buffer_name?, <<~PATTERN
  (send
    (send
      {(lvar :processed_source) (send nil? :processed_source)} :buffer) :name)
PATTERN