Class: RuboCop::Cop::Layout::SpaceInsideStringInterpolation

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

Overview

This cop checks for whitespace within string interpolations.

Examples:

EnforcedStyle: no_space (default)

# bad
   var = "This is the #{ space } example"

# good
   var = "This is the #{no_space} example"

EnforcedStyle: space

# bad
   var = "This is the #{no_space} example"

# good
   var = "This is the #{ space } example"

Constant Summary collapse

NO_SPACE_MSG = 
'Space inside string interpolation detected.'
SPACE_MSG = 
'Missing space inside string interpolation detected.'

Constants included from SurroundingSpace

SurroundingSpace::NO_SPACE_COMMAND, SurroundingSpace::SINGLE_SPACE_REGEXP, 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 included from Interpolation

#on_dstr, #on_node_with_interpolations

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #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?, #correctable?, #disable_offense, #disable_uncorrectable?, #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(begin_node) ⇒ Object 



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

def autocorrect(begin_node)
  lambda do |corrector|
    delims = delimiters(begin_node)

    if style == :no_space
      SpaceCorrector.remove_space(processed_source, corrector, *delims)
    else
      SpaceCorrector.add_space(processed_source, corrector, *delims)
    end
  end
end

#on_interpolation(begin_node) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/rubocop/cop/layout/space_inside_string_interpolation.rb', line 30

def on_interpolation(begin_node)
  delims = delimiters(begin_node)
  return if empty_brackets?(*delims)

  if style == :no_space
    no_space_offenses(begin_node, *delims, NO_SPACE_MSG)
  else
    space_offenses(begin_node, *delims, SPACE_MSG)
  end
end