Class: RuboCop::Cop::Style::PercentLiteralDelimiters

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

Overview

This cop enforces the consistent usage of %-literal delimiters.

Constant Summary

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from PercentLiteral

#begin_source, #percent_literal?, #process, #type

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#message(node) ⇒ Object


31
32
33
34
35
36
37
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 31

def message(node)
  type = type(node)
  delimiters = preferred_delimiters(type)

  "`#{type}`-literals should be delimited by " \
  "`#{delimiters[0]}` and `#{delimiters[1]}`."
end

#on_array(node) ⇒ Object


10
11
12
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 10

def on_array(node)
  process(node, '%w', '%W', '%i')
end

#on_regexp(node) ⇒ Object


14
15
16
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 14

def on_regexp(node)
  process(node, '%r')
end

#on_str(node) ⇒ Object Also known as: on_dstr


18
19
20
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 18

def on_str(node)
  process(node, '%', '%Q', '%q')
end

#on_sym(node) ⇒ Object


23
24
25
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 23

def on_sym(node)
  process(node, '%s')
end

#on_xstr(node) ⇒ Object


27
28
29
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 27

def on_xstr(node)
  process(node, '%x')
end