Class: RuboCop::Cop::Style::StringHashKeys

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/string_hash_keys.rb

Overview

This cop checks for the use of strings as keys in hashes. The use of symbols is preferred instead.

Examples:

# bad
{ 'one' => 1, 'two' => 2, 'three' => 3 }

# good
{ one: 1, two: 2, three: 3 }

Constant Summary collapse

MSG =
'Prefer symbols instead of strings as hash keys.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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?, #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_pair(node) ⇒ Object


38
39
40
41
42
43
44
45
46
47
# File 'lib/rubocop/cop/style/string_hash_keys.rb', line 38

def on_pair(node)
  return unless string_hash_key?(node)
  return if receive_environments_method?(node)

  add_offense(node.key) do |corrector|
    symbol_content = node.key.str_content.to_sym.inspect

    corrector.replace(node.key, symbol_content)
  end
end

#receive_environments_method?(node) ⇒ Object


26
27
28
29
30
31
32
33
34
35
36
# File 'lib/rubocop/cop/style/string_hash_keys.rb', line 26

def_node_matcher :receive_environments_method?, <<~PATTERN
  {
    ^^(send (const {nil? cbase} :IO) :popen ...)
    ^^(send (const {nil? cbase} :Open3)
        {:capture2 :capture2e :capture3 :popen2 :popen2e :popen3} ...)
    ^^^(send (const {nil? cbase} :Open3)
        {:pipeline :pipeline_r :pipeline_rw :pipeline_start :pipeline_w} ...)
    ^^(send {nil? (const {nil? cbase} :Kernel)} {:spawn :system} ...)
    ^^(send _ {:gsub :gsub!} ...)
  }
PATTERN

#string_hash_key?(node) ⇒ Object


21
22
23
# File 'lib/rubocop/cop/style/string_hash_keys.rb', line 21

def_node_matcher :string_hash_key?, <<~PATTERN
  (pair (str _) _)
PATTERN