123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/exact_regexp_match.rb

Overview

Checks for exact regexp match inside Regexp literals.

=~ returns an index and match returns MatchData, so they are only autocorrected when their value is used as a condition. The same goes for safe navigation calls, which return nil for a nil receiver.

Examples:

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

# good
string == 'string'

# bad
string !~ /\Astring\z/

# good
string != 'string'

Constant Summary

::RuboCop::Cop::Base - Inherited

DEPARTMENT_SEVERITIES, EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.
.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.
.badge

Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url

Returns a url to view this cops documentation online.
.exclude_from_registry

Call for abstract Cop classes.
.inherited,
.joining_forces

Override and return the Force class(es) you need to join.
.match?

Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem

Register a version requirement for the given gem name.
.restrict_on_send

Reserved for Commissioner.

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #disabled_autocorrect?,
#preview?

Whether the user opted in to unstable behavior, with --preview or AllCops: Preview.
#processed_source, #project_index, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

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

Whether a correction exists but is skipped because it is unsafe in a safe autocorrect run, while --disable-uncorrectable asks for a todo comment on everything this run cannot correct.
#contextual_autocorrect_held_back?

When LSP is enabled or the --editor-mode option is on, it is considered as editing source code, and autocorrection with AutoCorrect: contextual will not be performed.

Instance Method Summary

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.
#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation

Called before any investigation.
#callbacks_needed

 — grouped under the Commissioner heading above.
#cop_config

Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#name

Alias for Base#cop_name.
#offenses,
#on_investigation_end

Called after all on_…​
#on_new_investigation

Called before all on_…​
#on_other_file

Called instead of all on_…​
#parse

There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready

Called between investigations.
#relevant_file?,
#target_gem_version

Returns the version of a gem in the target, by default its locked version (i.e. from Gemfile.lock or gems.locked).
#target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.
#complete_investigation

Called to complete an investigation.
#correct, #covering_disabled_range, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?,
#enabled_lines?

A multi-line offense is suppressed by a directive on any line of its range, not only its first line, matching the intuition that the directive is attached to the offending code.
#file_name_matches_any?, #find_message, #find_severity, #matches_absolute_include_pattern?, #new_offense, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#suppression_reason

The -- reason on the directive that suppresses offenses on this range, or nil when the directive carries none.
#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#autocorrect(corrector, node, prefer) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 63



def autocorrect(corrector, node, prefer)
  return unless boolean_result?(node) || truthiness_only?(node)

  corrector.replace(node, parenthesize?(node) ? "(#{prefer})" : prefer)
end


  








  

    #boolean_result?(node)  ⇒ Boolean  (private)
  



  

    


=~ returns an index, match returns MatchData and &. can return nil,
so replacing them with == is only safe where the value is used as a condition.



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 71



def boolean_result?(node)
  node.send_type? && BOOLEAN_METHODS.include?(node.method_name)
end


  








  

    #escape_single_quotes(text)   (private)
  



  

    


Escape characters that are special inside a single-quoted string so the
generated literal (e.g. for /\Afoo’bar\z/) stays valid Ruby.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 96



def escape_single_quotes(text)
  text.gsub(/['\\]/) { |char| "\\#{char}" }
end


  








  

    #exact_match_pattern?(parsed_regexp)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 100



def exact_match_pattern?(parsed_regexp)
  tokens = parsed_regexp.map(&:token)
  return false unless tokens[0] == :bos && tokens[1] == :literal && tokens[2] == :eos

  !parsed_regexp[1].quantifier
end


  








  

    #exact_regexp_match(node)  
  



  

    


String#=== is plain equality, so === only matches with the regexp as its receiver.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 38



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


  








  

    #new_method(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 107



def new_method(node)
  node.method?(:!~) ? '!=' : '=='
end


  








  

    #on_csend(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 59



alias on_csend on_send


  








  

    #on_send(node)  
    Also known as: #on_csend
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 45



def on_send(node)
  return unless (receiver = node.receiver)
  return unless (regexp = exact_regexp_match(node))
  return unless (parsed_regexp = parse_regexp(regexp))
  return unless exact_match_pattern?(parsed_regexp)

  string = escape_single_quotes(parsed_regexp[1].text)
  subject = node.method?(:===) ? node.first_argument : receiver
  prefer = "#{subject.source} #{new_method(node)} '#{string}'"

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


  








  

    #parenthesize?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 88



def parenthesize?(node)
  return false unless (parent = node.parent)&.call_type?

  parent.receiver.equal?(node) || (parent.operator_method? && !parent.method?(:[]))
end


  








  

    #truthiness_only?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/exact_regexp_match.rb', line 75



def truthiness_only?(node)
  return true unless node.value_used?

  parent = node.parent
  if parent.type?(:begin, :and, :or)
    truthiness_only?(parent)
  elsif parent.type?(:if, :while, :until)
    parent.condition.equal?(node)
  else
    parent.send_type? && parent.method?(:!)
  end
end