class RuboCop::Cop::Layout::SpaceInsideHashLiteralBraces
Checks that braces used for hash literals have or don't have surrounding space depending on configuration.
@example 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 }
@example 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}
@example 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 }}}
@example EnforcedStyleForEmptyBraces: no_space (default)
# The `no_space` EnforcedStyleForEmptyBraces style enforces that # empty hash braces do not contain spaces. # bad foo = { } bar = { } # good foo = {} bar = {}
@example EnforcedStyleForEmptyBraces: space
# The `space` EnforcedStyleForEmptyBraces style enforces that # empty hash braces contain space. # bad foo = {} # good foo = { } foo = { } foo = { }
Constants
- MSG
Public Instance Methods
autocorrect(range)
click to toggle source
# 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)
click to toggle source
# 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
Private Instance Methods
ambiguous_or_unexpected_style_detected(style, is_match)
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 158 def ambiguous_or_unexpected_style_detected(style, is_match) if is_match ambiguous_style_detected(style, :compact) else unexpected_style_detected(style) end end
check(token1, token2)
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 114 def check(token1, token2) # No offense if line break inside. return if token1.line < token2.line return if token2.comment? # Also indicates there's a line break. is_empty_braces = token1.left_brace? && token2.right_curly_brace? expect_space = expect_space?(token1, token2) if offense?(token1, expect_space) incorrect_style_detected(token1, token2, expect_space, is_empty_braces) else correct_style_detected end end
expect_space?(token1, token2)
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 130 def expect_space?(token1, token2) is_same_braces = token1.type == token2.type is_empty_braces = token1.left_brace? && token2.right_curly_brace? if is_same_braces && style == :compact false elsif is_empty_braces cop_config['EnforcedStyleForEmptyBraces'] != 'no_space' else style != :no_space end end
hash_literal_with_braces(node) { |begin_index, end_index| ... }
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 103 def hash_literal_with_braces(node) tokens = processed_source.tokens begin_index = index_of_first_token(node) return unless tokens[begin_index].left_brace? end_index = index_of_last_token(node) return unless tokens[end_index].right_curly_brace? yield begin_index, end_index end
incorrect_style_detected(token1, token2, expect_space, is_empty_braces)
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 143 def incorrect_style_detected(token1, token2, expect_space, is_empty_braces) brace = (token1.text == '{' ? token1 : token2).pos range = expect_space ? brace : space_range(brace) add_offense( range, location: range, message: message(brace, is_empty_braces, expect_space) ) do style = expect_space ? :no_space : :space ambiguous_or_unexpected_style_detected(style, token1.text == token2.text) end end
message(brace, is_empty_braces, expect_space)
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 171 def message(brace, is_empty_braces, expect_space) inside_what = if is_empty_braces 'empty hash literal braces' else brace.source end problem = expect_space ? 'missing' : 'detected' format(MSG, problem: "#{inside_what} #{problem}") end
offense?(token1, expect_space)
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 166 def offense?(token1, expect_space) has_space = token1.space_after? expect_space ? !has_space : has_space end
range_of_space_to_the_left(range)
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 197 def range_of_space_to_the_left(range) src = range.source_buffer.source begin_pos = range.begin_pos begin_pos -= 1 while src[begin_pos - 1] =~ /[ \t]/ range_between(begin_pos, range.end_pos - 1) end
range_of_space_to_the_right(range)
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 189 def range_of_space_to_the_right(range) src = range.source_buffer.source end_pos = range.end_pos end_pos += 1 while src[end_pos] =~ /[ \t]/ range_between(range.begin_pos + 1, end_pos) end
space_range(token_range)
click to toggle source
# File lib/rubocop/cop/layout/space_inside_hash_literal_braces.rb, line 181 def space_range(token_range) if token_range.source == '{' range_of_space_to_the_right(token_range) else range_of_space_to_the_left(token_range) end end