Class: RuboCop::Cop::Style::OptionalBooleanParameter

Inherits:
Base
  • Object
show all
Includes:
AllowedMethods
Defined in:
lib/rubocop/cop/style/optional_boolean_parameter.rb

Overview

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.

Examples:

# 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

AllowedMethods: [‘some_method’]

# good
def some_method(bar = false)
  puts bar
end

Constant Summary collapse

MSG = 
'Prefer keyword arguments for arguments with a boolean default value; ' \
'use `%<replacement>s` instead of `%<original>s`.'

Instance Method Summary collapse

Instance Method Details

#on_def(node) ⇒ Object Also known as: on_defs 



43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/style/optional_boolean_parameter.rb', line 43

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