Class: RuboCop::Cop::Performance::StringReplacement

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

Overview

This cop identifies places where ‘gsub` can be replaced by `tr` or `delete`.

Examples:

@bad
'abc'.gsub('b', 'd')
'abc'.gsub('a', '')
'abc'.gsub(/a/, 'd')
'abc'.gsub!('a', 'd')

@good
'abc'.gsub(/.*/, 'a')
'abc'.gsub(/a+/, 'd')
'abc'.tr('b', 'd')
'a b c'.delete(' ')

Constant Summary collapse

MSG = 
'Use `%s` instead of `%s`.'.freeze
DETERMINISTIC_REGEX = 
/\A(?:#{LITERAL_REGEX})+\Z/
DELETE = 
'delete'.freeze
TR = 
'tr'.freeze
BANG = 
'!'.freeze
SINGLE_QUOTE = 
"'".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?, #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 



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

def autocorrect(node)
  _string, _method, first_param, second_param = *node
  first_source, = first_source(first_param)
  second_source, = *second_param

  unless first_param.str_type?
    first_source = interpret_string_escapes(first_source)
  end

  replacement_method =
    replacement_method(node, first_source, second_source)

  replace_method(node, first_source, second_source, first_param,
                 replacement_method)
end

#on_send(node) ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'lib/rubocop/cop/performance/string_replacement.rb', line 35

def on_send(node)
  string_replacement?(node) do |first_param, second_param|
    return if accept_second_param?(second_param)
    return if accept_first_param?(first_param)

    offense(node, first_param, second_param)
  end
end

#replace_method(node, first, second, first_param, replacement) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/rubocop/cop/performance/string_replacement.rb', line 60

def replace_method(node, first, second, first_param, replacement)
  lambda do |corrector|
    corrector.replace(node.loc.selector, replacement)
    unless first_param.str_type?
      corrector.replace(first_param.source_range,
                        to_string_literal(first))
    end

    if second.empty? && first.length == 1
      remove_second_param(corrector, node, first_param)
    end
  end
end