Class: RuboCop::Cop::Lint::DeprecatedClassMethods

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

Overview

Checks for uses of the deprecated class method usages.

Examples:


# bad
File.exists?(some_path)
Dir.exists?(some_path)
iterator?
attr :name, true
attr :name, false
ENV.freeze # Calling `Env.freeze` raises `TypeError` since Ruby 2.7.
ENV.clone
ENV.dup # Calling `Env.dup` raises `TypeError` since Ruby 3.1.
Socket.gethostbyname(host)
Socket.gethostbyaddr(host)

# good
File.exist?(some_path)
Dir.exist?(some_path)
block_given?
attr_accessor :name
attr_reader :name
ENV # `ENV.freeze` cannot prohibit changes to environment variables.
ENV.to_h
ENV.to_h # `ENV.dup` cannot dup `ENV`, use `ENV.to_h` to get a copy of `ENV` as a hash.
Addrinfo.getaddrinfo(nodename, service)
Addrinfo.tcp(host, port).getnameinfo

Constant Summary collapse

MSG =
'`%<current>s` is deprecated in favor of `%<prefer>s`.'
RESTRICT_ON_SEND =
%i[
  attr clone dup exists? freeze gethostbyaddr gethostbyname iterator?
].freeze
PREFERRED_METHDOS =
{
  clone: 'to_h',
  dup: 'to_h',
  exists?: 'exist?',
  gethostbyaddr: 'Addrinfo#getnameinfo',
  gethostbyname: 'Addrinfo#getaddrinfo',
  iterator?: 'block_given?'
}.freeze
DIR_ENV_FILE_CONSTANTS =
%i[Dir ENV File].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, 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, 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

#deprecated_class_method?(node) ⇒ Object


53
54
55
56
57
58
59
60
61
# File 'lib/rubocop/cop/lint/deprecated_class_methods.rb', line 53

def_node_matcher :deprecated_class_method?, <<~PATTERN
  {
    (send (const {cbase nil?} {:ENV}) {:clone :dup :freeze})
    (send (const {cbase nil?} {:File :Dir}) :exists? _)
    (send (const {cbase nil?} :Socket) {:gethostbyaddr :gethostbyname} ...)
    (send nil? :attr _ boolean)
    (send nil? :iterator?)
  }
PATTERN

#on_send(node) ⇒ Object


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/rubocop/cop/lint/deprecated_class_methods.rb', line 63

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

  offense_range = offense_range(node)
  prefer = preferred_method(node)
  message = format(MSG, current: offense_range.source, prefer: prefer)

  add_offense(offense_range, message: message) do |corrector|
    next if socket_const?(node.receiver)

    if node.method?(:freeze)
      corrector.replace(node, 'ENV')
    else
      corrector.replace(offense_range, prefer)
    end
  end
end