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

Inherits:
Cop
  • Object
show all
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.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, 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, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



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

def autocorrect(node)
  lambda do |corrector|
    symbol_content = node.str_content.to_sym.inspect
    corrector.replace(node.source_range, symbol_content)
  end
end

#on_pair(node) ⇒ Object 



33
34
35
36
37
 
# File 'lib/rubocop/cop/style/string_hash_keys.rb', line 33

def on_pair(node)
  return unless string_hash_key?(node)
  return if receive_environments_method?(node)
  add_offense(node.key)
end