Contents

require_relative '../../migration_helpers'

module Gitlab
  module Styles
    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
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
gitlab-styles-1.0.0	lib/gitlab/styles/rubocop/cop/migration/reversible_add_column_with_default.rb
gitlab-styles-0.1.0	lib/gitlab/styles/rubocop/cop/migration/reversible_add_column_with_default.rb