Class: RuboCop::Cop::Style::IndentHash
- Defined in:
- lib/rubocop/cop/style/indent_hash.rb
Overview
This cops checks the indentation of the first key in a hash literal where the opening brace and the first key are on separate lines. The other keys’ indentations are handled by the AlignHash cop.
By default, Hash literals that are arguments in a method call with parentheses, and where the opening curly brace of the hash is on the same line as the opening parenthesis of the method call, shall have their first key indented one step (two spaces) more than the position inside the opening parenthesis.
Other hash literals shall have their first key indented one step more than the start of the line where the opening curly brace is.
This default style is called ‘special_inside_parentheses’. Alternative styles are ‘consistent’ and ‘align_braces’. Here are examples:
# special_inside_parentheses
hash = {
key: :value
}
but_in_a_method_call({
its_like: :this
})
# consistent
hash = {
key: :value
}
and_in_a_method_call({
no: :difference
})
# align_braces
and_now_for_something = {
completely: :different
}
Constant Summary
Constants included from AutocorrectAlignment
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
Methods included from ArrayHashIndentation
#base_column, #check_expected_style, #check_first, #detected_styles, #detected_styles_for_column, #each_argument_node, #incorrect_style_detected
Methods included from ConfigurableEnforcedStyle
#alternative_style, #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 included from AutocorrectAlignment
#autocorrect, #check_alignment, #configured_indentation_width, #display_column, #indentation, #offset
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?, #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
#on_hash(node) ⇒ Object
46 47 48 |
# File 'lib/rubocop/cop/style/indent_hash.rb', line 46 def on_hash(node) check(node, nil) if node.loc.begin end |
#on_send(node) ⇒ Object
50 51 52 53 54 |
# File 'lib/rubocop/cop/style/indent_hash.rb', line 50 def on_send(node) each_argument_node(node, :hash) do |hash_node, left_parenthesis| check(hash_node, left_parenthesis) end end |