rubocop-hq/rubocop

# frozen_string_literal: true

module RuboCop
  module Cop
    module Naming
      # Checks block parameter names for how descriptive they
      # are. It is highly configurable.
      #
      # The `MinNameLength` config option takes an integer. It represents
      # the minimum amount of characters the name must be. Its default is 1.
      # The `AllowNamesEndingInNumbers` config option takes a boolean. When
      # set to false, this cop will register offenses for names ending with
      # numbers. Its default is false. The `AllowedNames` config option
      # takes an array of permitted names that will never register an
      # offense. The `ForbiddenNames` config option takes an array of
      # restricted names that will always register an offense.
      #
      # @example
      #   # bad
      #   bar do |varOne, varTwo|
      #     varOne + varTwo
      #   end
      #
      #   # With `AllowNamesEndingInNumbers` set to false
      #   foo { |num1, num2| num1 * num2 }
      #
      #   # With `MinNameLength` set to number greater than 1
      #   baz { |a, b, c| do_stuff(a, b, c) }
      #
      #   # good
      #   bar do |thud, fred|
      #     thud + fred
      #   end
      #
      #   foo { |speed, distance| speed * distance }
      #
      #   baz { |age, height, gender| do_stuff(age, height, gender) }
      class BlockParameterName < Base
        include UncommunicativeName

        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
          return unless node.arguments?

          check(node, node.arguments)
        end
      end
    end
  end
end