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

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

def force_equal_sign_alignment?
  cop_config['ForceEqualSignAlignment']
end

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

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 239

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 53

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 136

def aligned_on_other_column?(token, lines)
  line_set = Set.new(lines)
  by_column, = group_profile(token.line)

  by_column.any? do |column, entries|
    next false if column == token.pos.column

    shared = entries.filter_map { |line, spacing| spacing if line_set.include?(line) }
    shared.uniq.size > 1
  end
end

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

def aligned_tok?(previous_token, token)
  if token.comment?
    @aligned_comments.include?(token.line)
  else
    aligned_with_something?(token.pos) &&
      (ASSIGNMENT_OR_COMPARISON_TOKENS.include?(token.type) ||
       spacing_varies?(previous_token, token))
  end
end

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

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 158

def build_group_profile(group)
  by_column = Hash.new { |hash, key| hash[key] = [] }
  typed = Hash.new { |hash, key| hash[key] = [[], []] }

  group.each { |line| record_line_spacings(by_column, typed, line) }

  [by_column, typed]
end

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

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 82

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 63

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 148

def distinct_spacings(entries)
  entries.map(&:last).uniq
end

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

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?(token1, token2)

  yield range_between(start_pos, end_pos)
end

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

def group_profile(line_number)
  group = alignment_lines(line_number)

  @group_profiles[group] ||= build_group_profile(group)
end

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

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 220

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 187

def nearest_spacing_differs?(line_numbers, token, spacing)
  line_numbers.each do |line|
    break if definition_boundary_lines.include?(line)
    next if aligned_comment_lines.include?(line)

    other_spacing = spacing_before_token_at(line, token.pos.column)
    return other_spacing != spacing if other_spacing
  end

  false
end

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

def nearest_spacing_varies?(previous_token, token)
  spacing = token.begin_pos - previous_token.end_pos
  line_ranges = [(token.line - 1).downto(1),
                 (token.line + 1).upto(processed_source.lines.length)]

  line_ranges.any? do |line_numbers|
    nearest_spacing_differs?(line_numbers, token, spacing)
  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?
  prepare_alignment_data

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

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

def prepare_alignment_data
  @group_profiles = {}.compare_by_identity
  @alignment_verdicts = {}.compare_by_identity
  @tokens_by_line = processed_source.tokens.group_by(&:line)
end

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

def record_line_spacings(by_column, typed, line)
  @tokens_by_line[line]&.each_cons(2) do |previous_token, token|
    spacing = token.begin_pos - previous_token.end_pos
    by_column[token.pos.column] << [line, spacing]
    lines, spacings = typed[[token.pos.column, token.type]]
    lines << line
    spacings << spacing
  end
end

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

def spacing_before_token_at(line_number, column)
  tokens = @tokens_by_line[line_number]
  index = tokens&.index { |token| token.pos.column == column }
  return unless index&.positive?

  tokens[index].begin_pos - tokens[index - 1].end_pos
end

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

def spacing_varies?(previous_token, token)
  by_column, typed = group_profile(token.line)
  column = token.pos.column
  lines, spacings = typed[[column, token.type]]
  entries = by_column[column]

  if lines.size > 1
    uniform_alignment_allowed?(token, lines, spacings)
  elsif entries.size > 1
    distinct_spacings(entries).size > 1
  else
    nearest_spacing_varies?(previous_token, token)
  end
end

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

def uniform_alignment_allowed?(token, lines, spacings)
  return @alignment_verdicts[lines] if @alignment_verdicts.key?(lines)

  @alignment_verdicts[lines] =
    spacings.uniq.size > 1 || aligned_on_other_column?(token, lines)
end