Class: RuboCop::Cop::Rails::LinkToBlank

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/rails/link_to_blank.rb

Overview

This cop checks for calls to ‘link_to` that contain a `target: ’_blank’‘ but no `rel: ’noopener’‘. This can be a security risk as the loaded page will have control over the previous page and could change its location for phishing purposes.

The option ‘rel: ’noreferrer’‘ also blocks this behavior and removes the http-referrer header.

Examples:

# bad
link_to 'Click here', url, target: '_blank'

# good
link_to 'Click here', url, target: '_blank', rel: 'noopener'

# good
link_to 'Click here', url, target: '_blank', rel: 'noreferrer'

Constant Summary collapse

MSG = 
'Specify a `:rel` option containing noopener.'

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

#autocorrect(node) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rubocop/cop/rails/link_to_blank.rb', line 51

def autocorrect(node)
  lambda do |corrector|
    send_node = node.parent.parent

    option_nodes = send_node.each_child_node(:hash)
    rel_node = nil
    option_nodes.map(&:children).each do |options|
      rel_node ||= options.find { |o| rel_node?(o) }
    end

    if rel_node
      append_to_rel(rel_node, corrector)
    else
      add_rel(send_node, node, corrector)
    end
  end
end

#on_send(node) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rubocop/cop/rails/link_to_blank.rb', line 38

def on_send(node)
  return unless node.method?(:link_to)

  option_nodes = node.each_child_node(:hash)

  option_nodes.map(&:children).each do |options|
    blank = options.find { |o| blank_target?(o) }
    if blank && options.none? { |o| includes_noopener?(o) }
      add_offense(blank)
    end
  end
end