spec/rubocop/cop/migration/add_timestamps_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
69
70
71
72
73
74

# frozen_string_literal: true

require 'fast_spec_helper'
require_relative '../../../../rubocop/cop/migration/add_timestamps'

RSpec.describe RuboCop::Cop::Migration::AddTimestamps do
  subject(:cop) { described_class.new }

  let(:migration_with_add_timestamps) do
    %q(
      class Users < ActiveRecord::Migration[4.2]
        def change
          add_column(:users, :username, :text)
          add_timestamps(:users)
        end
      end
    )
  end

  let(:migration_without_add_timestamps) do
    %q(
      class Users < ActiveRecord::Migration[4.2]
        def change
          add_column(:users, :username, :text)
        end
      end
    )
  end

  let(:migration_with_add_timestamps_with_timezone) do
    %q(
      class Users < ActiveRecord::Migration[4.2]
        def change
          add_column(:users, :username, :text)
          add_timestamps_with_timezone(:users)
        end
      end
    )
  end

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

    it 'registers an offense when the "add_timestamps" method is used' do
      expect_offense(<<~RUBY)
        class Users < ActiveRecord::Migration[4.2]
          def change
            add_column(:users, :username, :text)
            add_timestamps(:users)
            ^^^^^^^^^^^^^^ Do not use `add_timestamps`, use `add_timestamps_with_timezone` instead
          end
        end
      RUBY
    end

    it 'does not register an offense when the "add_timestamps" method is not used' do
      expect_no_offenses(migration_without_add_timestamps)
    end

    it 'does not register an offense when the "add_timestamps_with_timezone" method is used' do
      expect_no_offenses(migration_with_add_timestamps_with_timezone)
    end
  end

  context 'when outside of migration' do
    it 'registers no offense', :aggregate_failures do
      expect_no_offenses(migration_with_add_timestamps)
      expect_no_offenses(migration_without_add_timestamps)
      expect_no_offenses(migration_with_add_timestamps_with_timezone)
    end
  end
end