123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::RegexpLiteral

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::RangeHelp, ::RuboCop::Cop::ConfigurableEnforcedStyle, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/regexp_literal.rb

Overview

Enforces using // or %r around regular expressions.

Note
 The following %r cases using a regexp starts with a blank or = as a method argument allowed to prevent syntax errors. 
do_something %r{ regexp} # `do_something / regexp/` is an invalid syntax.
do_something %r{=regexp} # `do_something /=regexp/` is an invalid syntax.

Examples:

EnforcedStyle: slashes (default)

# bad
snake_case = %r{^[\dA-Z_]+$}

# bad
regex = %r{
  foo
  (bar)
  (baz)
}x

# good
snake_case = /^[\dA-Z_]+$/

# good
regex = /
  foo
  (bar)
  (baz)
/x

EnforcedStyle: percent_r

# bad
snake_case = /^[\dA-Z_]+$/

# bad
regex = /
  foo
  (bar)
  (baz)
/x

# good
snake_case = %r{^[\dA-Z_]+$}

# good
regex = %r{
  foo
  (bar)
  (baz)
}x

EnforcedStyle: mixed

# bad
snake_case = %r{^[\dA-Z_]+$}

# bad
regex = /
  foo
  (bar)
  (baz)
/x

# good
snake_case = /^[\dA-Z_]+$/

# good
regex = %r{
  foo
  (bar)
  (baz)
}x

AllowInnerSlashes: false (default)

# If {false}, the cop will always recommend using {%r} if one or more
# slashes are found in the regexp string.

# bad
x =~ /home\//

# good
x =~ %r{home/}

AllowInnerSlashes: true

# good
x =~ /home\//

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

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

::RuboCop::ExcludeLimit - Extended

exclude_limit

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

Instance Attribute Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

#detected_style, #detected_style=, #no_acceptable_style?, #style_configured?

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #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?

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

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

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #max_line_length,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #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 Attribute Details

#allow_inner_slashes? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 144



def allow_inner_slashes?
  cop_config['AllowInnerSlashes']
end


  







Instance Method Details



  

    #allowed_mixed_percent_r?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 132



def allowed_mixed_percent_r?(node)
  (style == :mixed && node.multiline?) || contains_disallowed_slash?(node)
end


  








  

    #allowed_mixed_slash?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 122



def allowed_mixed_slash?(node)
  style == :mixed && node.single_line? && !contains_disallowed_slash?(node)
end


  








  

    #allowed_omit_parentheses_with_percent_r_literal?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 161



def allowed_omit_parentheses_with_percent_r_literal?(node)
  return false unless node.parent&.call_type?
  return true if node.content.start_with?(' ', '=')

  enforced_style = config.for_cop('Style/MethodCallWithArgsParentheses')['EnforcedStyle']

  enforced_style == 'omit_parentheses'
end


  








  

    #allowed_percent_r_literal?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 126



def allowed_percent_r_literal?(node)
  (style == :slashes && contains_disallowed_slash?(node)) ||
    style == :percent_r ||
    allowed_mixed_percent_r?(node) || allowed_omit_parentheses_with_percent_r_literal?(node)
end


  








  

    #allowed_slash_literal?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 118



def allowed_slash_literal?(node)
  (style == :slashes && !contains_disallowed_slash?(node)) || allowed_mixed_slash?(node)
end


  








  

    #calculate_replacement(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 221



def calculate_replacement(node)
  if slash_literal?(node)
    ['%r', ''].zip(preferred_delimiters).map(&:join)
  else
    %w[/ /]
  end
end


  








  

    #contains_disallowed_slash?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 136



def contains_disallowed_slash?(node)
  !allow_inner_slashes? && contains_slash?(node)
end


  








  

    #contains_slash?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 140



def contains_slash?(node)
  node_body(node).include?('/')
end


  








  

    #correct_delimiters(node, corrector)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 170



def correct_delimiters(node, corrector)
  replacement = calculate_replacement(node)
  corrector.replace(node.loc.begin, replacement.first)
  corrector.replace(node.loc.end, replacement.last)
end


  








  

    #correct_inner_slashes(node, corrector)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 176



def correct_inner_slashes(node, corrector)
  regexp_begin = node.loc.begin.end_pos

  inner_slash_indices(node).each do |index|
    start = regexp_begin + index

    corrector.replace(
      range_between(
        start,
        start + inner_slash_before_correction(node).length
      ),
      inner_slash_after_correction(node)
    )
  end
end


  








  

    #inner_slash_after_correction(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 209



def inner_slash_after_correction(node)
  inner_slash_for(calculate_replacement(node).first)
end


  








  

    #inner_slash_before_correction(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 205



def inner_slash_before_correction(node)
  inner_slash_for(node.loc.begin.source)
end


  








  

    #inner_slash_for(opening_delimiter)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 213



def inner_slash_for(opening_delimiter)
  if ['/', '%r/'].include?(opening_delimiter)
    '\/'
  else
    '/'
  end
end


  








  

    #inner_slash_indices(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 192



def inner_slash_indices(node)
  text    = node_body(node, include_begin_nodes: true)
  pattern = inner_slash_before_correction(node)
  index   = -1
  indices = []

  while (index = text.index(pattern, index + 1))
    indices << index
  end

  indices
end


  








  

    #node_body(node, include_begin_nodes: false)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 148



def node_body(node, include_begin_nodes: false)
  types = include_begin_nodes ? %i[str begin] : %i[str]
  node.each_child_node(*types).map(&:source).join
end


  








  

    #on_regexp(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 101



def on_regexp(node)
  message = if slash_literal?(node)
              MSG_USE_PERCENT_R unless allowed_slash_literal?(node)
            else
              MSG_USE_SLASHES unless allowed_percent_r_literal?(node)
            end

  return unless message

  add_offense(node, message: message) do |corrector|
    correct_delimiters(node, corrector)
    correct_inner_slashes(node, corrector)
  end
end


  








  

    #preferred_delimiters   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 157



def preferred_delimiters
  config.for_cop('Style/PercentLiteralDelimiters') ['PreferredDelimiters']['%r'].chars
end


  








  

    #slash_literal?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/regexp_literal.rb', line 153



def slash_literal?(node)
  node.loc.begin.source == '/'
end