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

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, 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?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_args(node) ⇒ Object 



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

def on_args(node)
  *_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

#validate_config ⇒ Object 



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/rubocop/cop/style/option_hash.rb', line 50

def validate_config
  if target_ruby_version < 2.0
    raise ValidationError, 'The `Style/OptionHash` cop is only ' \
                          'compatible with Ruby 2.0 and up, but the ' \
                          'target Ruby version for your project is ' \
                          "1.9.\nPlease disable this cop or adjust " \
                          'the `TargetRubyVersion` parameter in your ' \
                          'configuration.'
  end
end