Class: RuboCop::Cop::Style::FormatString

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/style/format_string.rb

Overview

This cop enforces the use of a single string formatting utility. Valid options include Kernel#format, Kernel#sprintf and String#%.

The detection of String#% cannot be implemented in a reliable manner for all cases, so only two scenarios are considered - if the first argument is a string literal and if the second argument is an array literal.

Examples:

EnforcedStyle: format (default)

# bad
puts sprintf('%10s', 'hoge')
puts '%10s' % 'hoge'

# good
puts format('%10s', 'hoge')

EnforcedStyle: sprintf

# bad
puts format('%10s', 'hoge')
puts '%10s' % 'hoge'

# good
puts sprintf('%10s', 'hoge')

EnforcedStyle: percent

# bad
puts format('%10s', 'hoge')
puts sprintf('%10s', 'hoge')

# good
puts '%10s' % 'hoge'

Constant Summary collapse

MSG = 
'Favor `%<prefer>s` over `%<current>s`.'.freeze

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 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

#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 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/rubocop/cop/style/format_string.rb', line 72

def autocorrect(node)
  lambda do |corrector|
    _receiver, detected_method = *node

    case detected_method
    when :%
      autocorrect_from_percent(corrector, node)
    when :format, :sprintf
      case style
      when :percent
        autocorrect_to_percent(corrector, node)
      when :format, :sprintf
        corrector.replace(node.loc.selector, style.to_s)
      end
    end
  end
end

#message(detected_style) ⇒ Object 



62
63
64
65
66
 
# File 'lib/rubocop/cop/style/format_string.rb', line 62

def message(detected_style)
  format(MSG,
         prefer: method_name(style),
         current: method_name(detected_style))
end

#method_name(style_name) ⇒ Object 



68
69
70
 
# File 'lib/rubocop/cop/style/format_string.rb', line 68

def method_name(style_name)
  style_name == :percent ? 'String#%' : style_name
end

#on_send(node) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rubocop/cop/style/format_string.rb', line 51

def on_send(node)
  formatter(node) do |selector|
    detected_style = selector == :% ? :percent : selector

    return if detected_style == style

    add_offense(node, location: :selector,
                      message: message(detected_style))
  end
end