rubocop/cop/migration/with_lock_retries_with_change.rb


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

# frozen_string_literal: true

require_relative '../../migration_helpers'

module RuboCop
  module Cop
    module Migration
      # Cop that prevents usage of `with_lock_retries` within the `change` method.
      class WithLockRetriesWithChange < RuboCop::Cop::Cop
        include MigrationHelpers

        MSG = '`with_lock_retries` cannot be used within `change` so you must manually define ' \
          'the `up` and `down` methods in your migration class and use `with_lock_retries` in both methods'.freeze

        def on_send(node)
          return unless in_migration?(node)
          return unless node.children[1] == :with_lock_retries

          node.each_ancestor(:def) do |def_node|
            add_offense(def_node, location: :name) if method_name(def_node) == :change
          end
        end

        def method_name(node)
          node.children.first
        end
      end
    end
  end
end