class RuboCop::Cop::Style::FormatString
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.
@example EnforcedStyle: format (default)
# bad puts sprintf('%10s', 'hoge') puts '%10s' % 'hoge' # good puts format('%10s', 'hoge')
@example EnforcedStyle: sprintf
# bad puts format('%10s', 'hoge') puts '%10s' % 'hoge' # good puts sprintf('%10s', 'hoge')
@example EnforcedStyle: percent
# bad puts format('%10s', 'hoge') puts sprintf('%10s', 'hoge') # good puts '%10s' % 'hoge'
Constants
- MSG
Public Instance Methods
autocorrect(node)
click to toggle source
# File lib/rubocop/cop/style/format_string.rb, line 76 def autocorrect(node) return if variable_argument?(node) lambda do |corrector| case node.method_name 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)
click to toggle source
# File lib/rubocop/cop/style/format_string.rb, line 66 def message(detected_style) format(MSG, prefer: method_name(style), current: method_name(detected_style)) end
method_name(style_name)
click to toggle source
# File lib/rubocop/cop/style/format_string.rb, line 72 def method_name(style_name) style_name == :percent ? 'String#%' : style_name end
on_send(node)
click to toggle source
# File lib/rubocop/cop/style/format_string.rb, line 55 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
Private Instance Methods
autocorrect_from_percent(corrector, node)
click to toggle source
# File lib/rubocop/cop/style/format_string.rb, line 96 def autocorrect_from_percent(corrector, node) args = if %i[array hash].include?(node.first_argument.type) node.first_argument.children.map(&:source).join(', ') else node.first_argument.source end corrected = "#{style}(#{node.receiver.source}, #{args})" corrector.replace(node.loc.expression, corrected) end
autocorrect_to_percent(corrector, node)
click to toggle source
# File lib/rubocop/cop/style/format_string.rb, line 108 def autocorrect_to_percent(corrector, node) format = node.first_argument.source args = if node.arguments.size == 2 arg = node.arguments.last arg.hash_type? ? "{ #{arg.source} }" : arg.source else "[#{node.arguments[1..-1].map(&:source).join(', ')}]" end corrector.replace(node.loc.expression, "#{format} % #{args}") end