123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::DuplicateRegexpCharacterClassElement

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

Overview

Checks for duplicate elements in Regexp character classes.

Examples:

# bad
r = /[xyx]/

# bad
r = /[0-9x0-9]/

# good
r = /[xy]/

# good
r = /[0-9x]/

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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

#each_repeated_character_class_element_loc(node)

[ GitHub ] 

  


# File 'lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb', line 37



def each_repeated_character_class_element_loc(node)
  node.parsed_tree&.each_expression do |expr|
    next if skip_expression?(expr)

    seen = Set.new
    group_expressions(node, expr.expressions) do |group|
      group_source = group.map(&:to_s).join

      yield source_range(group) if seen.include?(group_source)

      seen << group_source
    end
  end
end


  








  

    #escaped_octal?(string)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb', line 102



def escaped_octal?(string)
  string.length == 2 && string[0] == '\\' && octal?(string[1])
end


  








  

    #group_expressions(node, expressions)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb', line 54



def group_expressions(node, expressions)
  # Create a mutable list to simplify state tracking while we iterate.
  expressions = expressions.to_a

  until expressions.empty?
    # With we may need to compose a group of multiple expressions.
    group = [expressions.shift]
    next if within_interpolation?(node, group.first)

    # With regexp_parser < 2.7 escaped octal sequences may be up to 3
    # separate expressions ("\\0", "0", "1").
    pop_octal_digits(group, expressions) if escaped_octal?(group.first.to_s)

    yield(group)
  end
end


  








  

    #interpolation_locs(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb', line 110



def interpolation_locs(node)
  @interpolation_locs ||= {}

  # Cache by loc, not by regexp content, as content can be repeated in multiple patterns
  key = node.loc

  @interpolation_locs[key] ||= node.children.select(&:begin_type?).map(&:source_range)
end


  








  

    #octal?(char)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb', line 106



def octal?(char)
  ('0'..'7').cover?(char)
end


  








  

    #on_regexp(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb', line 29



def on_regexp(node)
  each_repeated_character_class_element_loc(node) do |loc|
    add_offense(loc, message: MSG_REPEATED_ELEMENT) do |corrector|
      corrector.remove(loc)
    end
  end
end


  








  

    #pop_octal_digits(current_child, expressions)   (private)
  

  [ GitHub ]


  

  


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



def pop_octal_digits(current_child, expressions)
  OCTAL_DIGITS_AFTER_ESCAPE.times do
    next_child = expressions.first
    break unless octal?(next_child.to_s)

    current_child << expressions.shift
  end
end


  








  

    #skip_expression?(expr)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb', line 89



def skip_expression?(expr)
  expr.type != :set || expr.token == :intersection
end


  








  

    #source_range(children)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb', line 80



def source_range(children)
  return children.first.expression if children.size == 1

  range_between(
    children.first.expression.begin_pos,
    children.last.expression.begin_pos + children.last.to_s.length
  )
end


  








  

    #within_interpolation?(node, child)  ⇒ Boolean  (private)
  



  

    


Since we blank interpolations with a space for every char of the interpolation, we would
mark every space (except the first) as duplicate if we do not skip regexp_parser nodes
that are within an interpolation.



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb', line 96



def within_interpolation?(node, child)
  parse_tree_child_loc = child.expression

  interpolation_locs(node).any? { |il| il.overlaps?(parse_tree_child_loc) }
end