Class: RuboCop::Cop::Lint::FormatParameterMismatch

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/format_parameter_mismatch.rb

Overview

This lint sees if there is a mismatch between the number of expected fields for format/sprintf/#% and what is actually passed as arguments.

Examples:


# bad

format('A value: %s and another: %i', a_value)

# good

format('A value: %s and another: %i', a_value, another)

Constant Summary collapse

MSG =

rubular.com/r/CvpbxkcTzy

"Number of arguments (%<arg_num>i) to `%<method>s` doesn't " \
'match the number of fields (%<field_num>i).'.freeze
FIELD_REGEX = 
/(%(([\s#+-0\*]*)(\d*)?(\.\d+)?[bBdiouxXeEfgGaAcps]|%))/.freeze
NAMED_FIELD_REGEX = 
/%\{[_a-zA-Z][_a-zA-Z]+\}/.freeze
KERNEL = 
'Kernel'.freeze
SHOVEL = 
'<<'.freeze
PERCENT = 
'%'.freeze
PERCENT_PERCENT = 
'%%'.freeze
DIGIT_DOLLAR_FLAG = 
/%(\d+)\$/.freeze
STRING_TYPES = 
%i[str dstr].freeze
NAMED_INTERPOLATION = 
/%(?:<\w+>|\{\w+\})/.freeze

Constants included from Util

Util::LITERAL_REGEX

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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, 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_send(node) ⇒ Object 



36
37
38
39
40
 
# File 'lib/rubocop/cop/lint/format_parameter_mismatch.rb', line 36

def on_send(node)
  return unless offending_node?(node)

  add_offense(node, location: :selector)
end