blob: 9158b268bf91ea23725ec0ab615defc4d7627f86 (
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
# frozen_string_literal: true
require_relative '../../migration_helpers'
module RuboCop
module Cop
module BackgroundMigration
# Checks the batched background migration has the corresponding dictionary file
class MissingDictionaryFile < RuboCop::Cop::Base
include MigrationHelpers
MSG = "Missing %{file_name}. " \
"Use the generator 'batched_background_migration' to create dictionary files automatically. " \
"For more details refer: https://docs.gitlab.com/ee/development/database/batched_background_migrations.html#generator"
DICTIONARY_DIR = "db/docs/batched_background_migrations"
def_node_matcher :batched_background_migration_name_node, <<~PATTERN
`(send nil? :queue_batched_background_migration $_ ...)
PATTERN
def_node_matcher :migration_constant_value, <<~PATTERN
`(casgn nil? %const_name ({sym|str} $_))
PATTERN
def on_class(node)
return unless time_enforced?(node) && in_post_deployment_migration?(node)
migration_name_node = batched_background_migration_name_node(node)
return unless migration_name_node
migration_name = if migration_name_node.const_name.present?
migration_constant_value(node, const_name: migration_name_node.const_name.to_sym)
else
migration_name_node.value
end
return if dictionary_file?(migration_name)
add_offense(node, message: format(MSG, file_name: dictionary_file_path(migration_name)))
end
private
def dictionary_file?(migration_class_name)
File.exist?(dictionary_file_path(migration_class_name))
end
def dictionary_file_path(migration_class_name)
File.join(rails_root, DICTIONARY_DIR, "#{migration_class_name.underscore}.yml")
end
def rails_root
@rails_root ||= File.expand_path('../../..', __dir__)
end
end
end
end
end
|
