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

Inherits:
Base
  • 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.

In addition it checks whether different formats are used in the same format string. Do not mix numbered, unnumbered, and named formats in the same format string.

Examples:


# bad

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

# good

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

# bad

format('Unnumbered format: %s and numbered: %2$s', a_value, another)

# good

format('Numbered format: %1$s and numbered %2$s', a_value, another)

Constant Summary collapse

MSG =
"Number of arguments (%<arg_num>i) to `%<method>s` doesn't " \
'match the number of fields (%<field_num>i).'
MSG_INVALID =
'Format string is invalid because formatting sequence types ' \
'(numbered, named or unnumbered) are mixed.'
KERNEL =
'Kernel'
SHOVEL =
'<<'
STRING_TYPES =
%i[str dstr].freeze
RESTRICT_ON_SEND =
%i[format sprintf %].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, 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, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#on_send(node) ⇒ Object


49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/rubocop/cop/lint/format_parameter_mismatch.rb', line 49

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

  if invalid_format_string?(node)
    add_offense(node.loc.selector, message: MSG_INVALID)
    return
  end

  return unless offending_node?(node)

  add_offense(node.loc.selector, message: message(node))
end