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

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/deprecated_class_methods.rb

Overview

This cop checks for uses of the deprecated class method usages.

Examples:


# bad

File.exists?(some_path)
Dir.exists?(some_path)
iterator?

# good

File.exist?(some_path)
Dir.exist?(some_path)
block_given?

Defined Under Namespace

Classes: DeprecatedClassMethod

Constant Summary collapse

MSG = 
'`%<current>s` is deprecated in favor of `%<prefer>s`.'
DEPRECATED_METHODS_OBJECT = 
[
  DeprecatedClassMethod.new(deprecated: :exists?,
                            replacement: :exist?,
                            class_constant: :File),
  DeprecatedClassMethod.new(deprecated: :exists?,
                            replacement: :exist?,
                            class_constant: :Dir),
  DeprecatedClassMethod.new(deprecated: :iterator?,
                            replacement: :block_given?)
].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object 



72
73
74
75
76
77
78
79
 
# File 'lib/rubocop/cop/lint/deprecated_class_methods.rb', line 72

def autocorrect(node)
  lambda do |corrector|
    check(node) do |data|
      corrector.replace(node.loc.selector,
                        data.replacement_method.to_s)
    end
  end
end

#on_send(node) ⇒ Object 



63
64
65
66
67
68
69
70
 
# File 'lib/rubocop/cop/lint/deprecated_class_methods.rb', line 63

def on_send(node)
  check(node) do |data|
    message = format(MSG, current: deprecated_method(data),
                          prefer: replacement_method(data))

    add_offense(node, location: :selector, message: message)
  end
end