74 lines
2.7 KiB
Ruby
74 lines
2.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require_relative '../../migration_helpers'
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Migration
|
|
class VersionedMigrationClass < RuboCop::Cop::Base
|
|
include MigrationHelpers
|
|
|
|
ENFORCED_SINCE = 2025_04_27_00_00_00
|
|
CURRENT_MIGRATION_VERSION = 2.3 # Should be the same value as Gitlab::Database::Migration.current_version
|
|
DOC_LINK = "https://docs.gitlab.com/ee/development/migration_style_guide.html#migration-helpers-and-versioning"
|
|
|
|
MSG_INHERIT = "Don't inherit from ActiveRecord::Migration or old versions of Gitlab::Database::Migration. " \
|
|
"Use Gitlab::Database::Migration[#{CURRENT_MIGRATION_VERSION}] instead. See #{DOC_LINK}.".freeze
|
|
|
|
MSG_INCLUDE = "Don't include migration helper modules directly. " \
|
|
"Inherit from Gitlab::Database::Migration[#{CURRENT_MIGRATION_VERSION}] instead. See #{DOC_LINK}."
|
|
.freeze
|
|
|
|
GITLAB_MIGRATION_CLASS = 'Gitlab::Database::Migration'
|
|
ACTIVERECORD_MIGRATION_CLASS = 'ActiveRecord::Migration'
|
|
|
|
def_node_search :includes_helpers?, <<~PATTERN
|
|
(send nil? :include
|
|
(const
|
|
(const
|
|
(const nil? :Gitlab) :Database) :MigrationHelpers))
|
|
PATTERN
|
|
|
|
def on_class(node)
|
|
return unless relevant_migration?(node)
|
|
return unless activerecord_migration_class?(node) || old_version_migration_class?(node)
|
|
|
|
add_offense(node, message: MSG_INHERIT)
|
|
end
|
|
|
|
def on_send(node)
|
|
return unless relevant_migration?(node)
|
|
|
|
add_offense(node, message: MSG_INCLUDE) if includes_helpers?(node)
|
|
end
|
|
|
|
private
|
|
|
|
def relevant_migration?(node)
|
|
in_migration?(node) && version(node) >= ENFORCED_SINCE
|
|
end
|
|
|
|
def activerecord_migration_class?(node)
|
|
superclass(node) == ACTIVERECORD_MIGRATION_CLASS
|
|
end
|
|
|
|
def superclass(class_node)
|
|
_, *others = class_node.descendants
|
|
|
|
others.find { |node| node.const_type? && node&.const_name != 'Types' }&.const_name
|
|
end
|
|
|
|
# Returns true for any parent class of format Gitlab::Database::Migration[version] if version < current_version
|
|
def old_version_migration_class?(class_node)
|
|
parent_class_node = class_node.parent_class
|
|
return false if parent_class_node.nil?
|
|
return false unless parent_class_node.send_type? && parent_class_node.last_argument.float_type?
|
|
return false unless parent_class_node.children[0].const_name == GITLAB_MIGRATION_CLASS
|
|
|
|
parent_class_node.first_argument.value < CURRENT_MIGRATION_VERSION
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|