Class: RuboCop::Cop::Style::HashSyntax

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

Overview

This cop checks hash literal syntax.

It can enforce either the use of the class hash rocket syntax or the use of the newer Ruby 1.9 syntax (when applicable).

A separate offense is registered for each problematic pair.

Constant Summary collapse

MSG_19 = 
'Use the new Ruby 1.9 hash syntax.'.freeze
MSG_RUBY19_NO_MIXED_KEYS = 
"Don't mix styles in the same hash.".freeze
MSG_HASH_ROCKETS = 
'Use hash rockets syntax.'.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, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #supported_styles, #unexpected_style_detected

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?, inherited, #initialize, #join_force?, lint?, match?, #message, 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?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, 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?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#alternative_style ⇒ Object 



73
74
75
76
77
78
79
80
 
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 73

def alternative_style
  case style
  when :hash_rockets then
    :ruby19
  when :ruby19, :ruby19_no_mixed_keys then
    :hash_rockets
  end
end

#autocorrect(node) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 61

def autocorrect(node)
  lambda do |corrector|
    if style == :hash_rockets || @force_hash_rockets
      autocorrect_hash_rockets(corrector, node)
    elsif style == :ruby19_no_mixed_keys
      autocorrect_ruby19_no_mixed_keys(corrector, node)
    else
      autocorrect_ruby19(corrector, node)
    end
  end
end

#hash_rockets_check(node) ⇒ Object 



43
44
45
46
47
 
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 43

def hash_rockets_check(node)
  pairs = *node

  check(pairs, ':', MSG_HASH_ROCKETS)
end

#on_hash(node) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 22

def on_hash(node)
  if cop_config['UseHashRocketsWithSymbolValues']
    pairs = *node
    @force_hash_rockets = pairs.any? { |p| symbol_value?(p) }
  end

  if style == :hash_rockets || @force_hash_rockets
    hash_rockets_check(node)
  elsif style == :ruby19_no_mixed_keys
    ruby19_no_mixed_keys_check(node)
  else
    ruby19_check(node)
  end
end

#ruby19_check(node) ⇒ Object 



37
38
39
40
41
 
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 37

def ruby19_check(node)
  pairs = *node

  check(pairs, '=>', MSG_19) if sym_indices?(pairs)
end

#ruby19_no_mixed_keys_check(node) ⇒ Object 



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

def ruby19_no_mixed_keys_check(node)
  pairs = *node

  if @force_hash_rockets
    check(pairs, ':', MSG_HASH_ROCKETS)
  elsif sym_indices?(pairs)
    check(pairs, '=>', MSG_19)
  else
    check(pairs, ':', MSG_RUBY19_NO_MIXED_KEYS)
  end
end