123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Performance::StringInclude

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, AutoCorrector, Base
Instance Chain:
self, Base
Inherits: Base
  • Object
Defined in: lib/rubocop/cop/performance/string_include.rb

Overview

Identifies unnecessary use of a regex where String#include? would suffice.

Examples:

# bad
str.match?(/ab/)
/ab/.match?(str)
str =~ /ab/
/ab/ =~ str
str.match(/ab/)
/ab/.match(str)
/ab/ === str

# good
str.include?('ab')

Cop Safety Information:

  • This cop’s offenses are not safe to autocorrect if a receiver is nil or a Symbol.

Constant Summary

Instance Method Summary

Instance Method Details

#literal?(regex_str) ⇒ Boolean (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/performance/string_include.rb', line 59



def literal?(regex_str)
  regex_str.match?(/\A#{Util::LITERAL_REGEX}+\z/o)
end


  








  

    #on_csend(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/performance/string_include.rb', line 54



alias on_csend on_send


  








  

    #on_match_with_lvasgn(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/performance/string_include.rb', line 55



alias on_match_with_lvasgn on_send


  








  

    #on_send(node)  
    Also known as: #on_csend, #on_match_with_lvasgn
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/performance/string_include.rb', line 37



def on_send(node)
  return unless (receiver, regex_str = redundant_regex?(node))

  negation = node.send_type? && node.method?(:!~)
  message = format(MSG, negation: ('!' if negation))

  add_offense(node, message: message) do |corrector|
    receiver, regex_str = regex_str, receiver if receiver.is_a?(String)
    regex_str = interpret_string_escapes(regex_str)
    dot = node.loc.dot ? node.loc.dot.source : '.'

    new_source = "#{'!' if negation}#{receiver.source}#{dot}include?(#{to_string_literal(regex_str)})"

    corrector.replace(node, new_source)
  end
end