Class: RuboCop::Cop::Style::StringMethods

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Style::StringMethods

Includes:

MethodPreference

Defined in:

lib/rubocop/cop/style/string_methods.rb

Overview

This cop enforces the use of consistent method names from the String class.

Constant Summary

MSG =

'Prefer `%s` over `%s`.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #autocorrect(node) ⇒ Object
• #on_send(node) ⇒ Object

Methods included from MethodPreference

#default_cop_config, #preferred_method, #preferred_methods

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #display_cop_names?, #display_style_guide?, #excluded_file?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object

# File 'lib/rubocop/cop/style/string_methods.rb', line 23

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(node.loc.selector,
                      preferred_method(node.loc.selector.source))
  end
end

#on_send(node) ⇒ Object

# File 'lib/rubocop/cop/style/string_methods.rb', line 13

def on_send(node)
  _receiver, method_name, *_args = *node
  return unless preferred_methods[method_name]
  add_offense(node, :selector,
              format(MSG,
                     preferred_method(method_name),
                     method_name)
             )
end