summaryrefslogtreecommitdiff
path: root/rubocop/cop/migration/schedule_async.rb
blob: 74bd2baffa94c8237bf2f1e13a9f4d854fda4284 (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
# frozen_string_literal: true

require_relative '../../migration_helpers'

module RuboCop
  module Cop
    module Migration
      class ScheduleAsync < RuboCop::Cop::Cop
        include MigrationHelpers

        ENFORCED_SINCE = 2020_02_12_00_00_00

        MSG = <<~MSG
          Don't call the background migration worker directly, use the `#migrate_async`,
          `#migrate_in`, `#bulk_migrate_async` or `#bulk_migrate_in` migration helpers
          instead.
        MSG

        def_node_matcher :calls_background_migration_worker?, <<~PATTERN
          (send (const nil? :BackgroundMigrationWorker) {:perform_async :perform_in :bulk_perform_async :bulk_perform_in} ... )
        PATTERN

        def on_send(node)
          return unless in_migration?(node)
          return if version(node) < ENFORCED_SINCE

          add_offense(node, location: :expression) if calls_background_migration_worker?(node)
        end

        def autocorrect(node)
          # This gets rid of the receiver `BackgroundMigrationWorker` and
          # replaces `perform` with `schedule`
          schedule_method = method_name(node).to_s.sub('perform', 'migrate')
          arguments = arguments(node).map(&:source).join(', ')

          replacement = "#{schedule_method}(#{arguments})"
          lambda do |corrector|
            corrector.replace(node.source_range, replacement)
          end
        end

        private

        def method_name(node)
          node.children.second
        end

        def arguments(node)
          node.children[2..]
        end
      end
    end
  end
end