Sha256: 5d002aaa054795e075a5154716837224fbb449dc0a57c5aa8c0e5094142543b5
Contents?: true
Size: 1.72 KB
Versions: 10
Compression:
Stored size: 1.72 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# This cop checks for places where keyword arguments can be used instead of
# boolean arguments when defining methods. `respond_to_missing?` method is allowed by default.
# These are customizable with `AllowedMethods` option.
#
# @safety
# This cop is unsafe because changing a method signature will
# implicitly change behaviour.
#
# @example
# # bad
# def some_method(bar = false)
# puts bar
# end
#
# # bad - common hack before keyword args were introduced
# def some_method(options = {})
# bar = options.fetch(:bar, false)
# puts bar
# end
#
# # good
# def some_method(bar: false)
# puts bar
# end
#
# @example AllowedMethods: ['some_method']
# # good
# def some_method(bar = false)
# puts bar
# end
#
class OptionalBooleanParameter < Base
include AllowedMethods
MSG = 'Prefer keyword arguments for arguments with a boolean default value; ' \
'use `%<replacement>s` instead of `%<original>s`.'
def on_def(node)
return if allowed_method?(node.method_name)
node.arguments.each do |arg|
next unless arg.optarg_type?
add_offense(arg, message: format_message(arg)) if arg.default_value.boolean_type?
end
end
alias on_defs on_def
private
def format_message(argument)
source = argument.source
format(MSG, original: source, replacement: source.sub(/\s+=/, ':'))
end
end
end
end
end
Version data entries
10 entries across 10 versions & 2 rubygems