class RuboCop::Cop::Rails::AddColumnIndex

This cop checks for migrations using `add_column` that have an `index` key. `add_column` does not accept `index`, but also does not raise an error for extra keys, so it is possible to mistakenly add the key without realizing it will not actually add an index.

@example

# bad (will not add an index)
add_column :table, :column, :integer, index: true

# good
add_column :table, :column, :integer
add_index :table, :column

Constants

MSG
RESTRICT_ON_SEND

Public Instance Methods

on_send(node) click to toggle source
# File lib/rubocop/cop/rails/add_column_index.rb, line 34
def on_send(node)
  table, column, pair, value = add_column_with_index(node)
  return unless pair

  add_offense(pair) do |corrector|
    corrector.remove(index_range(pair))

    add_index = "add_index #{table.source}, #{column.source}"
    add_index_opts = ''

    if value.hash_type?
      hash = value.loc.expression.adjust(begin_pos: 1, end_pos: -1).source.strip
      add_index_opts = ", #{hash}"
    end

    corrector.insert_after(node, "\n#{add_index}#{add_index_opts}")
  end
end

Private Instance Methods

index_range(pair_node) click to toggle source
# File lib/rubocop/cop/rails/add_column_index.rb, line 55
def index_range(pair_node)
  range_with_surrounding_comma(
    range_with_surrounding_space(range: pair_node.loc.expression, side: :left),
    :left
  )
end