summaryrefslogtreecommitdiff
path: root/rubocop/cop/migration/reversible_add_column_with_default.rb
blob: f413f06f39b96ca8f997f8f4b9b3d48dc1da2dac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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 ReversibleAddColumnWithDefault < RuboCop::Cop::Cop
        include MigrationHelpers

        def_node_matcher :add_column_with_default?, <<~PATTERN
          (send nil :add_column_with_default $...)
        PATTERN

        def_node_matcher :defines_change?, <<~PATTERN
          (def :change ...)
        PATTERN

        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`'.freeze

        def on_send(node)
          return unless in_migration?(node)
          return unless add_column_with_default?(node)

          node.each_ancestor(:def) do |def_node|
            next unless defines_change?(def_node)

            add_offense(def_node, :name)
          end
        end
      end
    end
  end
end