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

Inherits:
Cop
  • 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.'

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, 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

#on_send(node) ⇒ Object 



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

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