Class: RuboCop::Cop::Style::HashSyntax
- 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.
The supported styles are:
-
ruby19 - forces use of the 1.9 syntax (e.g. 1) when hashes have all symbols for keys
-
hash_rockets - forces use of hash rockets for all hashes
-
no_mixed_keys - simply checks for hashes with mixed syntaxes
-
ruby19_no_mixed_keys - forces use of ruby 1.9 syntax and forbids mixed syntax hashes
Constant Summary collapse
- MSG_19 =
'Use the new Ruby 1.9 hash syntax.'.freeze
- MSG_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::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
- #alternative_style ⇒ Object
- #autocorrect(node) ⇒ Object
- #hash_rockets_check(pairs) ⇒ Object
- #no_mixed_keys_check(pairs) ⇒ Object
- #on_hash(node) ⇒ Object
- #ruby19_check(pairs) ⇒ Object
- #ruby19_no_mixed_keys_check(pairs) ⇒ Object
Methods included from ConfigurableEnforcedStyle
#alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected
Methods inherited from Cop
#add_offense, all, 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_ruby_version
Methods included from AST::Sexp
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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, 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
#alternative_style ⇒ Object
126 127 128 129 130 131 132 133 |
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 126 def alternative_style case style when :hash_rockets then :ruby19 when :ruby19, :ruby19_no_mixed_keys then :hash_rockets end end |
#autocorrect(node) ⇒ Object
114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 114 def autocorrect(node) lambda do |corrector| if style == :hash_rockets || @force_hash_rockets autocorrect_hash_rockets(corrector, node) elsif style == :ruby19_no_mixed_keys || style == :no_mixed_keys autocorrect_no_mixed_keys(corrector, node) else autocorrect_ruby19(corrector, node) end end end |
#hash_rockets_check(pairs) ⇒ Object
92 93 94 |
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 92 def hash_rockets_check(pairs) check(pairs, ':', MSG_HASH_ROCKETS) end |
#no_mixed_keys_check(pairs) ⇒ Object
106 107 108 109 110 111 112 |
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 106 def no_mixed_keys_check(pairs) if !sym_indices?(pairs) check(pairs, ':', MSG_NO_MIXED_KEYS) else check(pairs, pairs.first.inverse_delimiter, MSG_NO_MIXED_KEYS) end end |
#on_hash(node) ⇒ Object
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 72 def on_hash(node) return if node.pairs.empty? @force_hash_rockets = force_hash_rockets?(node.pairs) if style == :hash_rockets || @force_hash_rockets hash_rockets_check(node.pairs) elsif style == :ruby19_no_mixed_keys ruby19_no_mixed_keys_check(node.pairs) elsif style == :no_mixed_keys no_mixed_keys_check(node.pairs) else ruby19_check(node.pairs) end end |
#ruby19_check(pairs) ⇒ Object
88 89 90 |
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 88 def ruby19_check(pairs) check(pairs, '=>', MSG_19) if sym_indices?(pairs) end |
#ruby19_no_mixed_keys_check(pairs) ⇒ Object
96 97 98 99 100 101 102 103 104 |
# File 'lib/rubocop/cop/style/hash_syntax.rb', line 96 def ruby19_no_mixed_keys_check(pairs) if @force_hash_rockets check(pairs, ':', MSG_HASH_ROCKETS) elsif sym_indices?(pairs) check(pairs, '=>', MSG_19) else check(pairs, ':', MSG_NO_MIXED_KEYS) end end |