Class: RuboCop::Cop::Lint::UriEscapeUnescape

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/lint/uri_escape_unescape.rb

Overview

This cop identifies places where `URI.escape` can be replaced by `CGI.escape`, `URI.encode_www_form`, or `URI.encode_www_form_component` depending on your specific use case. Also this cop identifies places where `URI.unescape` can be replaced by `CGI.unescape`, `URI.decode_www_form`, or `URI.decode_www_form_component` depending on your specific use case.

Examples:

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

# good
CGI.escape('http://example.com')
URI.encode_www_form([['example', 'param'], ['lang', 'en']])
URI.encode_www_form(page: 10, locale: 'en')
URI.encode_www_form_component('http://example.com')

# bad
URI.unescape(enc_uri)
URI.decode(enc_uri)

# good
CGI.unescape(enc_uri)
URI.decode_www_form(enc_uri)
URI.decode_www_form_component(enc_uri)

Constant Summary collapse

ALTERNATE_METHODS_OF_URI_ESCAPE =
%w[
  CGI.escape
  URI.encode_www_form
  URI.encode_www_form_component
].freeze
ALTERNATE_METHODS_OF_URI_UNESCAPE =
%w[
  CGI.unescape
  URI.decode_www_form
  URI.decode_www_form_component
].freeze
MSG =
'`%<uri_method>s` method is obsolete and should not be used. ' \
'Instead, use %<replacements>s depending on your specific use ' \
'case.'
METHOD_NAMES =
%i[escape encode unescape decode].freeze
RESTRICT_ON_SEND =
METHOD_NAMES

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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?, #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


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/rubocop/cop/lint/uri_escape_unescape.rb', line 57

def on_send(node)
  uri_escape_unescape?(node) do |top_level, obsolete_method|
    replacements = if %i[escape encode].include?(obsolete_method)
                     ALTERNATE_METHODS_OF_URI_ESCAPE
                   else
                     ALTERNATE_METHODS_OF_URI_UNESCAPE
                   end

    double_colon = top_level ? '::' : ''

    message = format(
      MSG, uri_method: "#{double_colon}URI.#{obsolete_method}",
           replacements: "`#{replacements[0]}`, `#{replacements[1]}` " \
                         "or `#{replacements[2]}`"
    )

    add_offense(node, message: message)
  end
end

#uri_escape_unescape?(node) ⇒ Object


51
52
53
54
55
# File 'lib/rubocop/cop/lint/uri_escape_unescape.rb', line 51

def_node_matcher :uri_escape_unescape?, <<~PATTERN
  (send
    (const ${nil? cbase} :URI) ${:#{METHOD_NAMES.join(' :')}}
    ...)
PATTERN