spec/rubocop/cop/migration/with_lock_retries_disallowed_method_spec.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
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
60
61
62
63
64
65
66
67
68

# frozen_string_literal: true

require 'spec_helper'

require 'rubocop'
require 'rubocop/rspec/support'

require_relative '../../../../rubocop/cop/migration/with_lock_retries_disallowed_method'

describe RuboCop::Cop::Migration::WithLockRetriesDisallowedMethod do
  include CopHelper

  subject(:cop) { described_class.new }

  context 'in migration' do
    before do
      allow(cop).to receive(:in_migration?).and_return(true)
    end

    it 'registers an offense when `with_lock_retries` block has disallowed method' do
      inspect_source('def change; with_lock_retries { disallowed_method }; end')

      aggregate_failures do
        expect(cop.offenses.size).to eq(1)
        expect(cop.offenses.map(&:line)).to eq([1])
      end
    end

    it 'registers an offense when `with_lock_retries` block has disallowed methods' do
      source = <<~HEREDOC
      def change
        with_lock_retries do
          disallowed_method

          create_table do |t|
            t.text :text
          end

          other_disallowed_method

          add_column :users, :name
        end
      end
      HEREDOC

      inspect_source(source)

      aggregate_failures do
        expect(cop.offenses.size).to eq(2)
        expect(cop.offenses.map(&:line)).to eq([3, 9])
      end
    end

    it 'registers no offense when `with_lock_retries` has only allowed method' do
      inspect_source('def up; with_lock_retries { add_foreign_key :foo, :bar }; end')

      expect(cop.offenses.size).to eq(0)
    end
  end

  context 'outside of migration' do
    it 'registers no offense' do
      inspect_source('def change; with_lock_retries { disallowed_method }; end')

      expect(cop.offenses.size).to eq(0)
    end
  end
end