123456789_123456789_123456789_123456789_123456789_

Module: RuboCop::Cop::SpaceBeforePunctuation

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Layout::SpaceBeforeComma, Layout::SpaceBeforeSemicolon
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, RangeHelp
Defined in: lib/rubocop/cop/mixin/space_before_punctuation.rb

Overview

Common functionality for cops checking for space before punctuation.

Constant Summary

RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Instance Attribute Summary

Instance Method Summary

RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

Instance Attribute Details

#space_required_after_lcurly? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/mixin/space_before_punctuation.rb', line 42



def space_required_after_lcurly?
  cfg = config.for_cop('Layout/SpaceInsideBlockBraces')
  style = cfg['EnforcedStyle'] || 'space'
  style == 'space'
end


  







Instance Method Details



  

    #each_missing_space(tokens)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/space_before_punctuation.rb', line 22



def each_missing_space(tokens)
  tokens.each_cons(2) do |token1, token2|
    next unless kind(token2)
    next unless space_missing?(token1, token2)
    next if space_required_after?(token1)

    pos_before_punctuation = range_between(token1.end_pos, token2.begin_pos)

    yield token2, pos_before_punctuation
  end
end


  








  

    #on_new_investigation  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/space_before_punctuation.rb', line 12



def on_new_investigation
  each_missing_space(processed_source.sorted_tokens) do |token, pos_before|
    add_offense(pos_before, message: format(MSG, token: kind(token))) do |corrector|
      PunctuationCorrector.remove_space(corrector, pos_before)
    end
  end
end


  








  

    #space_missing?(token1, token2)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/space_before_punctuation.rb', line 34



def space_missing?(token1, token2)
  same_line?(token1, token2) && token2.begin_pos > token1.end_pos
end


  








  

    #space_required_after?(token)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/space_before_punctuation.rb', line 38



def space_required_after?(token)
  (token.left_curly_brace? || token.type == :tLAMBEG) && space_required_after_lcurly?
end