Class: RuboCop::Cop::Layout::SpaceBeforeBlockBraces

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

Overview

Checks that block braces have or don’t have a space before the opening brace depending on configuration.

Examples:

EnforcedStyle: space (default)

# bad
foo.map{ |a|
  a.bar.to_s
}

# good
foo.map { |a|
  a.bar.to_s
}

EnforcedStyle: no_space

# bad
foo.map { |a|
  a.bar.to_s
}

# good
foo.map{ |a|
  a.bar.to_s
}

Constant Summary collapse

MISSING_MSG = 
'Space missing to the left of {.'
DETECTED_MSG = 
'Space detected to the left of {.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Class Method Summary collapse

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, 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, 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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



37
38
39
 
# File 'lib/rubocop/cop/layout/space_before_block_braces.rb', line 37

def self.autocorrect_incompatible_with
  [Style::SymbolProc]
end

Instance Method Details

#autocorrect(range) ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'lib/rubocop/cop/layout/space_before_block_braces.rb', line 56

def autocorrect(range)
  lambda do |corrector|
    case range.source
    when /\s/ then corrector.remove(range)
    else           corrector.insert_before(range, ' ')
    end
  end
end

#on_block(node) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/rubocop/cop/layout/space_before_block_braces.rb', line 41

def on_block(node)
  return if node.keywords?

  left_brace = node.loc.begin
  space_plus_brace = range_with_surrounding_space(range: left_brace)
  used_style =
    space_plus_brace.source.start_with?('{') ? :no_space : :space

  if empty_braces?(node.loc)
    check_empty(left_brace, space_plus_brace, used_style)
  else
    check_non_empty(left_brace, space_plus_brace, used_style)
  end
end