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

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

Overview

This cop checks for options hashes and discourages them if the current Ruby version supports keyword arguments.

Examples:

Instead of:

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

Prefer:

def fry(temperature: 300)
  ...
end

Constant Summary collapse

MSG = 
'Prefer keyword arguments to options hashes.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #display_cop_names?, #display_style_guide?, #excluded_file?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_args(node) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rubocop/cop/style/option_hash.rb', line 25

def on_args(node)
  return unless supports_keyword_arguments?

  *_but_last, last_arg = *node

  # asserting that there was an argument at all
  return unless last_arg

  # asserting last argument is an optional argument
  return unless last_arg.optarg_type?

  arg, default_value = *last_arg

  # asserting default value is a hash
  return unless default_value.hash_type?

  # asserting default value is empty hash
  *key_value_pairs = *default_value
  return unless key_value_pairs.empty?

  # Check for suspicious argument names
  return unless name_in_suspicious_param_names?(arg)

  add_offense(last_arg, :expression, MSG)
end