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.

Specify the ‘default’ key to set all preferred delimiters at once. You can continue to specify individual preferred delimiters to override the default.

Examples:

# Style/PercentLiteralDelimiters:
#   PreferredDelimiters:
#     default: '[]'
#     '%i':    '()'

# good
%w[alpha beta] + %i(gamma delta)

# bad
%W(alpha #{beta})

# bad
%I(alpha beta)

Constant Summary

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?, #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

#autocorrect(node) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 58

def autocorrect(node)
  type = type(node)

  opening_delimiter, closing_delimiter = preferred_delimiters_for(type)

  lambda do |corrector|
    corrector.replace(node.loc.begin, "#{type}#{opening_delimiter}")
    corrector.replace(node.loc.end, closing_delimiter)
  end
end

#message(node) ⇒ Object 



50
51
52
53
54
55
56
 
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 50

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

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

#on_array(node) ⇒ Object 



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

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

#on_regexp(node) ⇒ Object 



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

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

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



37
38
39
 
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 37

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

#on_sym(node) ⇒ Object 



42
43
44
 
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 42

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

#on_xstr(node) ⇒ Object 



46
47
48
 
# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 46

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