123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::AlignmentCorrector

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Alignment, RangeHelp
Inherits: Object
Defined in: lib/rubocop/cop/correctors/alignment_corrector.rb

Overview

This class does autocorrection of nodes that should just be moved to the left or to the right, amount being determined by the instance variable column_delta.

Class Attribute Summary

Alignment - Extended

column_delta

Class Method Summary

Alignment - Extended

check_alignment, configured_indentation_width, display_column, each_bad_alignment, end_of_line_comment, indentation, offset, register_offense, within?

RangeHelp - Extended

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

Class Attribute Details

.processed_source (readonly)

[ GitHub ] 

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 13



attr_reader :processed_source


  







Class Method Details



  

    .align_end(corrector, processed_source, node, align_to)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 29



def align_end(corrector, processed_source, node, align_to)
  @processed_source = processed_source
  whitespace = whitespace_range(node)
  return false unless whitespace.source.strip.empty?

  column = alignment_column(align_to)
  corrector.replace(whitespace, ' ' * column)
end


  








  

    .alignment_column(align_to)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 124



def alignment_column(align_to)
  if !align_to
    0
  elsif align_to.respond_to?(:loc)
    align_to.source_range.column
  else
    align_to.column
  end
end


  








  

    .autocorrect_line(corrector, line_begin_pos, expr, column_delta, taboo_ranges)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 40



def autocorrect_line(corrector, line_begin_pos, expr, column_delta,
                     taboo_ranges)
  range = calculate_range(expr, line_begin_pos, column_delta)
  # We must not change indentation of heredoc strings or inside other
  # string literals
  return if taboo_ranges.any? { |t| within?(range, t) }

  if column_delta.positive? && range.resize(1).source != "\n"
    corrector.insert_before(range, ' ' * column_delta)
  elsif /\A[ \t]+\z/.match?(range.source)
    remove(range, corrector)
  end
end


  








  

    .block_comment_within?(expr)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 81



def block_comment_within?(expr)
  processed_source.comments.select(&:document?).any? do |c|
    within?(c.source_range, expr)
  end
end


  








  

    .calculate_range(expr, line_begin_pos, column_delta)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 87



def calculate_range(expr, line_begin_pos, column_delta)
  return range_between(line_begin_pos, line_begin_pos) if column_delta.positive?

  starts_with_space = expr.source_buffer.source[line_begin_pos].start_with?(' ')

  if starts_with_space
    range_between(line_begin_pos, line_begin_pos + column_delta.abs)
  else
    range_between(line_begin_pos - column_delta.abs, line_begin_pos)
  end
end


  








  

    .correct(corrector, processed_source, node, column_delta)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 15



def correct(corrector, processed_source, node, column_delta)
  return unless node

  @processed_source = processed_source
  expr = node.respond_to?(:loc) ? node.source_range : node
  return if block_comment_within?(expr)

  taboo_ranges = inside_string_ranges(node)

  each_line(expr) do |line_begin_pos|
    autocorrect_line(corrector, line_begin_pos, expr, column_delta, taboo_ranges)
  end
end


  








  

    .delimited_string_literal?(node)  ⇒ Boolean  (private)
  



  

    


Some special kinds of string literals are not composed of literal
characters between two delimiters:
- The source map of ?a responds to :begin and :end but its end is
  nil.
- The source map of FILE responds to neither :begin nor :end.



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 75



def delimited_string_literal?(node)
  loc = node.location

  loc.respond_to?(:begin) && loc.begin && loc.respond_to?(:end) && loc.end
end


  








  

    .each_line(expr)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 110



def each_line(expr)
  line_begin_pos = expr.begin_pos
  expr.source.each_line do |line|
    yield line_begin_pos
    line_begin_pos += line.length
  end
end


  








  

    .inside_string_range(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 60



def inside_string_range(node)
  loc = node.location

  if node.heredoc?
    loc.heredoc_body.join(loc.heredoc_end)
  elsif delimited_string_literal?(node)
    loc.begin.end.join(loc.end.begin)
  end
end


  








  

    .inside_string_ranges(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 54



def inside_string_ranges(node)
  return [] unless node.is_a?(Parser::AST::Node)

  node.each_node(:str, :dstr, :xstr).filter_map { |n| inside_string_range(n) }
end


  








  

    .remove(range, corrector)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 99



def remove(range, corrector)
  original_stderr = $stderr
  $stderr = StringIO.new # Avoid error messages on console
  corrector.remove(range)
rescue RuntimeError
  range = range_between(range.begin_pos + 1, range.end_pos + 1)
  retry if /^ +$/.match?(range.source)
ensure
  $stderr = original_stderr
end


  








  

    .whitespace_range(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/correctors/alignment_corrector.rb', line 118



def whitespace_range(node)
  begin_pos = node.loc.end.begin_pos

  range_between(begin_pos - node.loc.end.column, begin_pos)
end