Class: RuboCop::Cop::Style::YAMLFileRead

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

Overview

Checks for the use of ‘YAML.load`, `YAML.safe_load`, and `YAML.parse` with `File.read` argument.

NOTE: ‘YAML.safe_load_file` was introduced in Ruby 3.0.

Examples:


# bad
YAML.load(File.read(path))
YAML.parse(File.read(path))

# good
YAML.load_file(path)
YAML.parse_file(path)

# bad
YAML.safe_load(File.read(path)) # Ruby 3.0 and newer

# good
YAML.safe_load_file(path)       # Ruby 3.0 and newer

Constant Summary collapse

MSG =
'Use `%<prefer>s` instead.'
RESTRICT_ON_SEND =
%i[load safe_load parse].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 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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/rubocop/cop/style/yaml_file_read.rb', line 41

def on_send(node)
  return if node.method?(:safe_load) && target_ruby_version <= 2.7
  return unless (file_path, rest_arguments = yaml_file_read?(node))

  range = offense_range(node)
  rest_arguments = if rest_arguments.empty?
                     ''
                   else
                     ", #{rest_arguments.map(&:source).join(', ')}"
                   end
  prefer = "#{node.method_name}_file(#{file_path.source}#{rest_arguments})"

  add_offense(range, message: format(MSG, prefer: prefer)) do |corrector|
    corrector.replace(range, prefer)
  end
end

#yaml_file_read?(node) ⇒ Object



34
35
36
37
38
39
# File 'lib/rubocop/cop/style/yaml_file_read.rb', line 34

def_node_matcher :yaml_file_read?, <<~PATTERN
  (send
    (const {cbase nil?} :YAML) _
    (send
      (const {cbase nil?} :File) :read $_) $...)
PATTERN