Class: RuboCop::Cop::Layout::SpaceInsideHashLiteralBraces

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle, RangeHelp, SurroundingSpace
Defined in:
lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb

Overview

Checks that braces used for hash literals have or don’t have surrounding space depending on configuration.

Examples:

EnforcedStyle: space (default)

# The `space` style enforces that hash literals have
# surrounding space.

# bad
h = {a: 1, b: 2}

# good
h = { a: 1, b: 2 }

EnforcedStyle: no_space

# The `no_space` style enforces that hash literals have
# no surrounding space.

# bad
h = { a: 1, b: 2 }

# good
h = {a: 1, b: 2}

EnforcedStyle: compact

# The `compact` style normally requires a space inside
# hash braces, with the exception that successive left
# braces or right braces are collapsed together in nested hashes.

# bad
h = { a: { b: 2 } }
foo = { { a: 1 } => { b: { c: 2 } } }

# good
h = { a: { b: 2 }}
foo = {{ a: 1 } => { b: { c: 2 }}}

EnforcedStyleForEmptyBraces: no_space (default)

# The `no_space` EnforcedStyleForEmptyBraces style enforces that
# empty hash braces do not contain spaces.

# bad
foo = { }
bar = {    }

# good
foo = {}
bar = {}

EnforcedStyleForEmptyBraces: space

# The `space` EnforcedStyleForEmptyBraces style enforces that
# empty hash braces contain space.

# bad
foo = {}

# good
foo = { }
foo = {  }
foo = {     }

Constant Summary collapse

MSG = 
'Space inside %<problem>s.'.freeze

Constants included from SurroundingSpace

SurroundingSpace::NO_SPACE_COMMAND, SurroundingSpace::SPACE_COMMAND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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 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?, #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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb', line 84

def autocorrect(range)
  lambda do |corrector|
    # It is possible that BracesAroundHashParameters will remove the
    # braces while this cop inserts spaces. This can lead to unwanted
    # changes to the inspected code. If we replace the brace with a
    # brace plus space (rather than just inserting a space), then any
    # removal of the same brace will give us a clobbering error. This
    # in turn will make RuboCop fall back on cop-by-cop
    # auto-correction. Problem solved.
    case range.source
    when /\s/ then corrector.remove(range)
    when '{' then corrector.replace(range, '{ ')
    else corrector.replace(range, ' }')
    end
  end
end

#on_hash(node) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb', line 73

def on_hash(node)
  tokens = processed_source.tokens

  hash_literal_with_braces(node) do |begin_index, end_index|
    check(tokens[begin_index], tokens[begin_index + 1])
    return if begin_index == end_index - 1

    check(tokens[end_index - 1], tokens[end_index])
  end
end