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.'
MSG_HASH_ROCKETS =
'Always use hash rockets in 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 included from ConfigurableEnforcedStyle

#alternative_style, #both_styles_detected, #correct_style_detected, #opposite_style_detected, #parameter_name, #style, #unrecognized_style_detected

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #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, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 36

def autocorrect(node)
  key = node.children.first.loc.expression
  op = node.loc.operator

  @corrections << lambda do |corrector|
    if style == :ruby19
      range = Parser::Source::Range.new(key.source_buffer,
                                        key.begin_pos, op.end_pos)
      range = range_with_surrounding_space(range, :right)
      corrector.replace(range,
                        range.source.sub(/^:(.*\S)\s*=>\s*$/, '\1: '))
    else
      corrector.insert_after(key, ' => ')
      corrector.insert_before(key, ':')
      corrector.remove(range_with_surrounding_space(op))
    end
  end
end

#hash_rockets_check(node) ⇒ Object


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

def hash_rockets_check(node)
  pairs = *node

  check(pairs, ':', MSG_HASH_ROCKETS)
end

#on_hash(node) ⇒ Object


18
19
20
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 18

def on_hash(node)
  style == :ruby19 ? ruby19_check(node) : hash_rockets_check(node)
end

#ruby19_check(node) ⇒ Object


22
23
24
25
26
27
28
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 22

def ruby19_check(node)
  pairs = *node

  sym_indices = pairs.all? { |p| word_symbol_pair?(p) }

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