Class: RuboCop::Cop::Style::FormatStringToken
- Includes:
- ConfigurableEnforcedStyle
- Defined in:
- lib/rubocop/cop/style/format_string_token.rb
Overview
Use a consistent style for named format string tokens.
Note: ‘unannotated` style cop only works for strings which are passed as arguments to those methods: `sprintf`, `format`, `%`. The reason is that unannotated format is very similar to encoded URLs or Date/Time formatting strings.
Constant Summary collapse
- FIELD_CHARACTERS =
Regexp.union(%w[A B E G X a b c d e f g i o p s u x])
- FORMAT_STRING_METHODS =
%i[sprintf format %].freeze
- STYLE_PATTERNS =
{ annotated: /(?<token>%<[^>]+>#{FIELD_CHARACTERS})/, template: /(?<token>%\{[^\}]+\})/, unannotated: /(?<token>%#{FIELD_CHARACTERS})/ }.freeze
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods included from ConfigurableEnforcedStyle
#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected
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
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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#on_str(node) ⇒ Object
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/rubocop/cop/style/format_string_token.rb', line 53 def on_str(node) return if placeholder_argument?(node) return if node.each_ancestor(:xstr, :regexp).any? tokens(node) do |detected_style, token_range| if detected_style == style || unannotated_format?(node, detected_style) correct_style_detected else style_detected(detected_style) add_offense(node, location: token_range, message: (detected_style)) end end end |