Class: RuboCop::Cop::Style::RedundantRegexpEscape

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

Overview

Checks for redundant escapes inside Regexp literals.

Examples:

# bad
%r{foo\/bar}

# good
%r{foo/bar}

# good
/foo\/bar/

# good
%r/foo\/bar/

# good
%r!foo\!bar!

# bad
/a\-b/

# good
/a-b/

# bad
/[\+\-]\d/

# good
/[+\-]\d/

Constant Summary collapse

MSG_REDUNDANT_ESCAPE = 
'Redundant escape inside regexp literal'
ALLOWED_ALWAYS_ESCAPES = 
" \n[]^\\#".chars.freeze
ALLOWED_WITHIN_CHAR_CLASS_METACHAR_ESCAPES = 
'-'.chars.freeze
ALLOWED_OUTSIDE_CHAR_CLASS_METACHAR_ESCAPES = 
'.*+?{}()|$'.chars.freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

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

#on_regexp(node) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rubocop/cop/style/redundant_regexp_escape.rb', line 45

def on_regexp(node)
  each_escape(node) do |char, index, within_character_class|
    next if char.valid_encoding? && allowed_escape?(node, char, index,
                                                    within_character_class)

    location = escape_range_at_index(node, index)

    add_offense(location, message: MSG_REDUNDANT_ESCAPE) do |corrector|
      corrector.remove_leading(escape_range_at_index(node, index), 1)
    end
  end
end