Sha256: bb208f0989ebe4b610ebd10cb595d2cdc25a7ef2aadf2c4f1c0d478e099820a3
Contents?: true
Size: 1.97 KB
Versions: 15
Compression:
Stored size: 1.97 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# This cop checks whether the block parameters of a single-line
# method accepting a block match the names specified via configuration.
#
# For instance one can configure `reduce`(`inject`) to use |a, e| as
# parameters.
class SingleLineBlockParams < Cop
def on_block(node)
# we care only for single line blocks
return unless block_length(node).zero?
method_node, args_node, _body_node = *node
receiver, method_name, _method_args = *method_node
# discard other scenarios
return unless receiver
return unless method_names.include?(method_name)
args = *args_node
return if args.empty?
# discard cases with argument destructuring
return true unless args.all?(&:arg_type?)
return if args_match?(method_name, args)
add_offense(args_node, :expression, message(method_name))
end
private
def message(method_name)
args = target_args(method_name).join(', ')
"Name `#{method_name}` block params `|#{args}|`."
end
def methods
cop_config['Methods']
end
def method_names
methods.map { |e| e.keys.first.to_sym }
end
def target_args(method_name)
method_name = method_name.to_s
method_hash = methods.find { |m| m.keys.first == method_name }
method_hash[method_name]
end
def args_match?(method_name, args)
actual_args = args.flat_map(&:to_a)
# Prepending an underscore to mark an unused parameter is allowed, so
# we remove any leading underscores before comparing.
actual_args_no_underscores = actual_args.map do |arg|
arg.to_s.sub(/^_+/, '')
end
actual_args_no_underscores == target_args(method_name)
end
end
end
end
end
Version data entries
15 entries across 15 versions & 2 rubygems