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::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

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, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#message(node) ⇒ Object 



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

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 



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

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

#on_regexp(node) ⇒ Object 



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

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

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



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

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

#on_sym(node) ⇒ Object 



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

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

#on_xstr(node) ⇒ Object 



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

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