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

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp, RegexpLiteralHelp
Defined in:
lib/rubocop/cop/style/redundant_regexp_escape.rb

Overview

This cop checks for redundant escapes inside Regexp literals.

Examples:

# bad
%r{foo\/bar}

# good
%r{foo/bar}

# good
/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 = 
' []^\\#'.chars.freeze
ALLOWED_WITHIN_CHAR_CLASS_METACHAR_ESCAPES = 
'-'.chars.freeze
ALLOWED_OUTSIDE_CHAR_CLASS_METACHAR_ESCAPES = 
'.*+?{}()|$'.chars.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'lib/rubocop/cop/style/redundant_regexp_escape.rb', line 54

def autocorrect(node)
  lambda do |corrector|
    each_escape(node) do |char, index, within_character_class|
      next if allowed_escape?(node, char, within_character_class)

      corrector.remove_leading(escape_range_at_index(node, index), 1)
    end
  end
end

#on_regexp(node) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/rubocop/cop/style/redundant_regexp_escape.rb', line 42

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

    add_offense(
      node,
      location: escape_range_at_index(node, index),
      message: MSG_REDUNDANT_ESCAPE
    )
  end
end