Commit abc9548f authored by Douwe Maan's avatar Douwe Maan
Browse files

Add cop that checks if add_column_with_default is used with up/down methods

parent d35abc21954a
......@@ -3,13 +3,13 @@ module Cop
module Migration
# Cop that checks if columns are added in a way that doesn't require
# downtime.
class ColumnWithDefault < RuboCop::Cop::Cop
class AddColumn < RuboCop::Cop::Cop
include MigrationHelpers
WHITELISTED_TABLES = [:application_settings]
MSG = 'add_column with a default value requires downtime, ' \
'use add_column_with_default instead'
MSG = '`add_column` with a default value requires downtime, ' \
'use `add_column_with_default` instead'
def on_send(node)
return unless in_migration?(node)
......
require_relative '../../migration_helpers'
module RuboCop
module Cop
module Migration
# Cop that checks if `add_column_with_default` is used with `up`/`down` methods
# and not `change`.
class AddColumnWithDefault < RuboCop::Cop::Cop
include MigrationHelpers
MSG = '`add_column_with_default` is not reversible so you must manually define ' \
'the `up` and `down` methods in your migration class, using `remove_column` in `down`'
def on_send(node)
return unless in_migration?(node)
name = node.children[1]
return unless name == :add_column_with_default
node.each_ancestor(:def) do |def_node|
next unless method_name(def_node) == :change
add_offense(def_node, :name)
end
end
def method_name(node)
node.children.first
end
end
end
end
end
......@@ -5,7 +5,7 @@ module Migration
class AddIndex < RuboCop::Cop::Cop
include MigrationHelpers
MSG = 'add_index requires downtime, use add_concurrent_index instead'
MSG = '`add_index` requires downtime, use `add_concurrent_index` instead'
def on_def(node)
return unless in_migration?(node)
......
require_relative 'migration_helpers'
require_relative 'cop/migration/add_index'
require_relative 'cop/migration/column_with_default'
require_relative 'cop/migration/add_column'
require_relative 'cop/migration/add_column_with_default'
require_relative 'cop/gem_fetcher'
require 'spec_helper'
require 'rubocop'
require 'rubocop/rspec/support'
require_relative '../../../../rubocop/cop/migration/add_column_with_default'
describe RuboCop::Cop::Migration::AddColumnWithDefault do
include CopHelper
subject(:cop) { described_class.new }
context 'in migration' do
before do
allow(cop).to receive(:in_migration?).and_return(true)
end
it 'registers an offense when add_column_with_default is used inside a change method' do
inspect_source(cop, 'def change; add_column_with_default :table, :column, default: false; end')
aggregate_failures do
expect(cop.offenses.size).to eq(1)
expect(cop.offenses.map(&:line)).to eq([1])
end
end
it 'registers no offense when add_column_with_default is used inside an up method' do
inspect_source(cop, 'def up; add_column_with_default :table, :column, default: false; end')
expect(cop.offenses.size).to eq(0)
end
end
context 'outside of migration' do
it 'registers no offense' do
inspect_source(cop, 'def change; add_column_with_default :table, :column, default: false; end')
expect(cop.offenses.size).to eq(0)
end
end
end
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment