Class: RuboCop::Cop::Style::ExactRegexpMatch

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/exact_regexp_match.rb

Overview

Checks for exact regexp match inside Regexp literals.

Examples:


# bad
string =~ /\Astring\z/
string === /\Astring\z/
string.match(/\Astring\z/)
string.match?(/\Astring\z/)

# good
string == 'string'

# bad
string !~ /\Astring\z/

# good
string != 'string'

Constant Summary collapse

MSG = 
'Use `%<prefer>s`.'
RESTRICT_ON_SEND = 
%i[=~ === !~ match match?].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#exact_regexp_match(node) ⇒ Object 



32
33
34
35
36
37
38
 
# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 32

def_node_matcher :exact_regexp_match, <<~PATTERN
  (call
    _ {:=~ :=== :!~ :match :match?}
    (regexp
      (str $_)
      (regopt)))
PATTERN

#on_send(node) ⇒ Object Also known as: on_csend 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 40

def on_send(node)
  return unless (receiver = node.receiver)
  return unless (regexp = exact_regexp_match(node))

  parsed_regexp = begin
    Regexp::Parser.parse(regexp)
  rescue Regexp::Parser::Error
    # Upon encountering an invalid regular expression,
    # we aim to proceed and identify any remaining potential offenses.
  end

  return unless parsed_regexp && exact_match_pattern?(parsed_regexp)

  prefer = "#{receiver.source} #{new_method(node)} '#{parsed_regexp[1].text}'"

  add_offense(node, message: format(MSG, prefer: prefer)) do |corrector|
    corrector.replace(node, prefer)
  end
end