Class: RuboCop::Cop::Style::RedundantRegexpArgument
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::StringLiteralsHelp ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/redundant_regexp_argument.rb |
Overview
Identifies places where argument can be replaced from a deterministic regexp to a string.
Constant Summary
-
DETERMINISTIC_REGEX =
# File 'lib/rubocop/cop/style/redundant_regexp_argument.rb', line 43/\A(?:#{LITERAL_REGEX})+\Z/.freeze
-
MSG =
# File 'lib/rubocop/cop/style/redundant_regexp_argument.rb', line 39'Use string `%<prefer>s` as argument instead of regexp `%<current>s`.'
-
RESTRICT_ON_SEND =
# File 'lib/rubocop/cop/style/redundant_regexp_argument.rb', line 40%i[ byteindex byterindex gsub gsub! partition rpartition scan split start_with? sub sub! ].freeze
-
STR_SPECIAL_CHARS =
# File 'lib/rubocop/cop/style/redundant_regexp_argument.rb', line 44%w[ \a \c \C \e \f \M \n \" \' \\\\ \t \b \f \r \u \v \x \0 \1 \2 \3 \4 \5 \6 \7 ].freeze
::RuboCop::Cop::Base
- Inherited
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 |
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::StringLiteralsHelp
- Included
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
-
#on_csend(node)
Alias for #on_send.
- #on_send(node) (also: #on_csend)
- #determinist_regexp?(regexp_node) ⇒ Boolean private
- #preferred_argument(regexp_node) private
- #replacement(regexp_node) private
::RuboCop::Cop::StringLiteralsHelp
- Included
::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 |
#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
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#determinist_regexp?(regexp_node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_regexp_argument.rb', line 65
def determinist_regexp?(regexp_node) DETERMINISTIC_REGEX.match?(regexp_node.source) end
#on_csend(node)
Alias for #on_send.
# File 'lib/rubocop/cop/style/redundant_regexp_argument.rb', line 61
alias on_csend on_send
#on_send(node) Also known as: #on_csend
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_regexp_argument.rb', line 48
def on_send(node) return unless (regexp_node = node.first_argument) return unless regexp_node.regexp_type? return if !regexp_node.regopt.children.empty? || regexp_node.content == ' ' return unless determinist_regexp?(regexp_node) prefer = preferred_argument(regexp_node) = format(MSG, prefer: prefer, current: regexp_node.source) add_offense(regexp_node, message: ) do |corrector| corrector.replace(regexp_node, prefer) end end
#preferred_argument(regexp_node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_regexp_argument.rb', line 69
def preferred_argument(regexp_node) new_argument = replacement(regexp_node) if new_argument.include?('"') new_argument.gsub!("'", "\\\\'") new_argument.gsub!('\"', '"') quote = "'" elsif new_argument.include?('\\') quote = '"' else quote = enforce_double_quotes? ? '"' : "'" end "#{quote}#{new_argument}#{quote}" end
#replacement(regexp_node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_regexp_argument.rb', line 85
def replacement(regexp_node) regexp_content = regexp_node.content stack = [] chars = regexp_content.chars.each_with_object([]) do |char, strings| if stack.empty? && char == '\\' stack.push(char) else strings << "#{stack.pop}#{char}" end end chars.map do |char| char = char.dup char.delete!('\\') unless STR_SPECIAL_CHARS.include?(char) char end.join end