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

Inherits:
Base
  • 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]]
}

# good

# Neither is incompatible with the bad case, but probably the intended code.
attributes = {
  valid_attributes: %i[name content],
  nested_attributes: [:name, :content, %i[incorrectly nested]]
}

attributes = {
  valid_attributes: %i[name content],
  nested_attributes: [:name, :content, [:incorrectly, :nested]]
}

Constant Summary collapse

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

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

PreferredDelimiters::PERCENT_LITERAL_TYPES
REGEXES =
PERCENT_LITERAL_TYPES.map { |percent_literal| /\A#{percent_literal}\W/ }.freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

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


44
45
46
# File 'lib/rubocop/cop/lint/nested_percent_literal.rb', line 44

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

#on_percent_literal(node) ⇒ Object


48
49
50
# File 'lib/rubocop/cop/lint/nested_percent_literal.rb', line 48

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