Class: RuboCop::Cop::Performance::Casecmp

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/performance/casecmp.rb

Overview

This cop identifies places where a case-insensitive string comparison can better be implemented using ‘casecmp`.

Examples:

@bad
str.downcase == 'abc'
str.upcase.eql? 'ABC'
'abc' == str.downcase
'ABC'.eql? str.upcase
str.downcase == str.downcase

@good
str.casecmp('ABC').zero?
'abc'.casecmp(str).zero?

Constant Summary collapse

MSG = 
'Use `casecmp` instead of `%s %s`.'.freeze
CASE_METHODS = 
%i[downcase upcase].freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #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?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, scrub_string, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/rubocop/cop/performance/casecmp.rb', line 47

def autocorrect(node)
  downcase_eq(node) do
    receiver, method, arg = *node
    variable, = *receiver
    return correction(node, receiver, method, arg, variable)
  end

  eq_downcase(node) do
    arg, method, receiver = *node
    variable, = *receiver
    return correction(node, receiver, method, arg, variable)
  end
end

#on_send(node) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/performance/casecmp.rb', line 38

def on_send(node)
  return if part_of_ignored_node?(node)

  inefficient_comparison(node) do |range, is_other_part, *methods|
    ignore_node(node) if is_other_part
    add_offense(node, range, format(MSG, *methods))
  end
end