Class: RuboCop::Cop::Lint::UriRegexp

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/lint/uri_regexp.rb

Overview

Identifies places where ‘URI.regexp` is obsolete and should not be used.

For Ruby 3.3 or lower, use ‘URI::DEFAULT_PARSER.make_regexp`. For Ruby 3.4 or higher, use `URI::RFC2396_PARSER.make_regexp`.

NOTE: If you need to support both Ruby 3.3 and lower as well as Ruby 3.4 and higher, consider manually changing the code as follows:

source,ruby

defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER

Examples:

# bad
URI.regexp('http://example.com')

# good - Ruby 3.3 or lower
URI::DEFAULT_PARSER.make_regexp('http://example.com')

# good - Ruby 3.4 or higher
URI::RFC2396_PARSER.make_regexp('http://example.com')

Constant Summary collapse

MSG = 
'`%<current>s` is obsolete and should not be used. Instead, use `%<preferred>s`.'
RESTRICT_ON_SEND = 
%i[regexp].freeze

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_send(node) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/rubocop/cop/lint/uri_regexp.rb', line 40

def on_send(node)
  return unless uri_constant?(node.receiver)

  parser = target_ruby_version >= 3.4 ? 'RFC2396_PARSER' : 'DEFAULT_PARSER'
  argument = node.first_argument ? "(#{node.first_argument.source})" : ''

  preferred_method = "#{node.receiver.source}::#{parser}.make_regexp#{argument}"
  message = format(MSG, current: node.source, preferred: preferred_method)

  add_offense(node.loc.selector, message: message) do |corrector|
    corrector.replace(node, preferred_method)
  end
end

#uri_constant?(node) ⇒ Object 



36
37
38
 
# File 'lib/rubocop/cop/lint/uri_regexp.rb', line 36

def_node_matcher :uri_constant?, <<~PATTERN
  (const {cbase nil?} :URI)
PATTERN