123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::AmbiguousRegexpLiteral

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:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/ambiguous_regexp_literal.rb

Overview

Checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

Examples:

# bad

# This is interpreted as a method invocation with a regexp literal,
# but it could possibly be `/` method invocations.
# (i.e. `do_something./(pattern)./(i)`)
do_something /pattern/i
# good

# With parentheses, there's no ambiguity.
do_something(/pattern/i)

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::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 an 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

::RuboCop::ExcludeLimit - Extended

exclude_limit

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

transform

Instance Attribute Summary

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,
#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_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#find_offense_node(node, regexp_receiver) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_regexp_literal.rb', line 56

def find_offense_node(node, regexp_receiver)
  return node if first_argument_is_regexp?(node) || !node.parent

  if (node.parent.send_type? && node.receiver) ||
     method_chain_to_regexp_receiver?(node, regexp_receiver)
    node = find_offense_node(node.parent, regexp_receiver)
  end

  node
end

#find_offense_node_by(diagnostic) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_regexp_literal.rb', line 49

def find_offense_node_by(diagnostic)
  node = processed_source.ast.each_node(:regexp).find do |regexp_node|
    regexp_node.source_range.begin_pos == diagnostic.location.begin_pos
  end
  find_offense_node(node.parent, node)
end

#first_argument_is_regexp?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_regexp_literal.rb', line 67

def first_argument_is_regexp?(node)
  node.send_type? && node.first_argument&.regexp_type?
end

#method_chain_to_regexp_receiver?(node, regexp_receiver) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_regexp_literal.rb', line 71

def method_chain_to_regexp_receiver?(node, regexp_receiver)
  return false unless (parent = node.parent)
  return false unless (parent_receiver = parent.receiver)

  parent.parent && parent_receiver.receiver == regexp_receiver
end

#on_new_investigation

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_regexp_literal.rb', line 31

def on_new_investigation
  processed_source.diagnostics.each do |diagnostic|
    if target_ruby_version >= 3.0
      next unless diagnostic.reason == :ambiguous_regexp
    else
      next unless diagnostic.reason == :ambiguous_literal
    end

    offense_node = find_offense_node_by(diagnostic)

    add_offense(diagnostic.location, severity: diagnostic.level) do |corrector|
      add_parentheses(offense_node, corrector)
    end
  end
end