Class: RuboCop::Cop::Layout::ExtraSpacing

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 133

def force_equal_sign_alignment?
  cop_config['ForceEqualSignAlignment']
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 147

def align_equal_sign(corrector, token, align_to)
  return unless @corrected.add?(token)

  diff = align_to - token.pos.last_column

  if diff.positive?
    corrector.insert_before(token.pos, ' ' * diff)
  elsif diff.negative?
    corrector.remove_preceding(token.pos, -diff)
  end
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 137

def align_equal_signs(range, corrector)
  lines  = all_relevant_assignment_lines(range.line)
  tokens = assignment_tokens.select { |t| lines.include?(t.line) }

  columns  = tokens.map { |t| align_column(t) }
  align_to = columns.max

  tokens.each { |token| align_equal_sign(corrector, token, align_to) }
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 52

def aligned_locations(locs)
  return [] if locs.empty?

  aligned = Set.new
  locs.each_cons(2) do |loc1, loc2|
    aligned << loc1.line << loc2.line if loc1.column == loc2.column
  end
  aligned
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 103

def aligned_tok?(token)
  if token.comment?
    @aligned_comments.include?(token.line)
  else
    aligned_with_something?(token.pos)
  end
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 159

def all_relevant_assignment_lines(line_number)
  last_line_number = processed_source.lines.size

  (
    relevant_assignment_lines(line_number.downto(1)) +
    relevant_assignment_lines(line_number.upto(last_line_number))
  )
    .uniq
    .sort
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 72

def check_assignment(token)
  return unless aligned_with_preceding_equals_operator(token) == :no

  message = format(MSG_UNALIGNED_ASGN, location: 'preceding')
  add_offense(token.pos, message: message) do |corrector|
    align_equal_signs(token.pos, corrector)
  end
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 81

def check_other(token1, token2, ast)
  return false if allow_for_trailing_comments? && token2.text.start_with?('#')

  extra_space_range(token1, token2) do |range|
    next if ignored_range?(ast, range.begin_pos)

    add_offense(range, message: MSG_UNNECESSARY) { |corrector| corrector.remove(range) }
  end
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 62

def check_tokens(ast, token1, token2)
  return if token2.type == :tNL

  if force_equal_sign_alignment? && assignment_tokens.include?(token2)
    check_assignment(token2)
  else
    check_other(token1, token2, ast)
  end
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 91

def extra_space_range(token1, token2)
  return if token1.line != token2.line

  start_pos = token1.end_pos
  end_pos = token2.begin_pos - 1
  return if end_pos <= start_pos

  return if allow_for_alignment? && aligned_tok?(token2)

  yield range_between(start_pos, end_pos)
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 111

def ignored_range?(ast, start_pos)
  ignored_ranges(ast).any? { |r| r.include?(start_pos) }
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 118

def ignored_ranges(ast)
  return [] unless ast

  @ignored_ranges ||= begin
    ranges = []
    on_node(:pair, ast) do |pair|
      next if pair.parent.single_line?

      key, value = *pair
      ranges << (key.source_range.end_pos...value.source_range.begin_pos)
    end
    ranges
  end
end

# File 'lib/rubocop/cop/layout/extra_spacing.rb', line 39

def on_new_investigation
  return if processed_source.blank?

  @aligned_comments = aligned_locations(processed_source.comments.map(&:loc))
  @corrected = Set.new if force_equal_sign_alignment?

  processed_source.tokens.each_cons(2) do |token1, token2|
    check_tokens(processed_source.ast, token1, token2)
  end
end