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?
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?
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

Defined Under Namespace

Classes: DeprecatedClassMethod, Replacement

Constant Summary collapse

MSG = 
'`%<current>s` is deprecated in favor of `%<prefer>s`.'
DEPRECATED_METHODS_OBJECT = 
{
  DeprecatedClassMethod.new(:exists?, class_constant: :File) =>
    Replacement.new(:exist?, class_constant: :File),

  DeprecatedClassMethod.new(:exists?, class_constant: :Dir) =>
    Replacement.new(:exist?, class_constant: :Dir),

  DeprecatedClassMethod.new(:iterator?) => Replacement.new(:block_given?),

  DeprecatedClassMethod.new(:freeze, class_constant: :ENV) =>
    Replacement.new(nil, class_constant: :ENV),

  DeprecatedClassMethod.new(:clone, class_constant: :ENV) =>
    Replacement.new(:to_h, class_constant: :ENV),

  DeprecatedClassMethod.new(:dup, class_constant: :ENV) =>
    Replacement.new(:to_h, class_constant: :ENV),

  DeprecatedClassMethod.new(:gethostbyaddr, class_constant: :Socket, correctable: false) =>
    Replacement.new(:getnameinfo, class_constant: :Addrinfo, instance_method: true),

  DeprecatedClassMethod.new(:gethostbyname, class_constant: :Socket, correctable: false) =>
    Replacement.new(:getaddrinfo, class_constant: :Addrinfo, instance_method: true)
}.freeze
RESTRICT_ON_SEND = 
DEPRECATED_METHODS_OBJECT.keys.map(&:method).freeze
CLASS_METHOD_DELIMITER = 
'.'
INSTANCE_METHOD_DELIMITER = 
'#'

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

#on_send(node) ⇒ Object 


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/rubocop/cop/lint/deprecated_class_methods.rb', line 132

def on_send(node)
  check(node) do |deprecated|
    prefer = replacement(deprecated)
    message = format(MSG, current: deprecated, prefer: prefer)
    current_method = node.loc.selector

    add_offense(current_method, message: message) do |corrector|
      next unless deprecated.correctable?

      if (preferred_method = prefer.method)
        corrector.replace(current_method, preferred_method)
      else
        corrector.remove(node.loc.dot)
        corrector.remove(current_method)
      end
    end
  end
end