Class: RuboCop::Cop::Style::OptionHash

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

Overview

Checks for options hashes and discourages them if the current Ruby version supports keyword arguments.

Examples:


# bad
def fry(options = {})
  temperature = options.fetch(:temperature, 300)
  # ...
end

# good
def fry(temperature: 300)
  # ...
end

Constant Summary collapse

MSG = 
'Prefer keyword arguments to options hashes.'

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_args(node) ⇒ Object 



30
31
32
33
34
35
 
# File 'lib/rubocop/cop/style/option_hash.rb', line 30

def on_args(node)
  return if super_used?(node)
  return if allowlist.include?(node.parent.method_name.to_s)

  option_hash(node) { |options| add_offense(options) }
end

#option_hash(node) ⇒ Object 



26
27
28
 
# File 'lib/rubocop/cop/style/option_hash.rb', line 26

def_node_matcher :option_hash, <<~PATTERN
  (args ... $(optarg [#suspicious_name? _] (hash)))
PATTERN