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`.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

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