Class: RuboCop::Cop::Lint::NestedPercentLiteral

Inherits:
Cop
  • Object
show all
Includes:
PercentLiteral
Defined in:
lib/rubocop/cop/lint/nested_percent_literal.rb

Overview

This cop checks for nested percent literals.

Examples:


# bad

# The percent literal for nested_attributes is parsed as four tokens,
# yielding the array [:name, :content, :"%i[incorrectly", :"nested]"].
attributes = {
  valid_attributes: %i[name content],
  nested_attributes: %i[name content %i[incorrectly nested]]
}

Constant Summary collapse

MSG = 
'Within percent literals, nested percent literals do not ' \
'function and may be unwanted in the result.'.freeze
REGEXES =

The array of regular expressions representing percent literals that, if found within a percent literal expression, will cause a NestedPercentLiteral violation to be emitted.

PercentLiteral::PERCENT_LITERAL_TYPES.map do |percent_literal|
  /\A#{percent_literal}\W/
end.freeze

Constants included from PercentLiteral

PercentLiteral::PERCENT_LITERAL_TYPES

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

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, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#on_array(node) ⇒ Object 



31
32
33
 
# File 'lib/rubocop/cop/lint/nested_percent_literal.rb', line 31

def on_array(node)
  process(node, *PercentLiteral::PERCENT_LITERAL_TYPES)
end

#on_percent_literal(node) ⇒ Object 



35
36
37
 
# File 'lib/rubocop/cop/lint/nested_percent_literal.rb', line 35

def on_percent_literal(node)
  add_offense(node) if contains_percent_literals?(node)
end