File: migration_record.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (41 lines) | stat: -rw-r--r-- 1,202 bytes parent folder | download
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
# frozen_string_literal: true

require_relative '../../migration_helpers'

module RuboCop
  module Cop
    module Migration
      class MigrationRecord < RuboCop::Cop::Base
        include MigrationHelpers

        ENFORCED_SINCE = 2022_04_26_00_00_00

        MSG = <<~MSG
          Don't inherit from ActiveRecord::Base or ApplicationRecord but use MigrationRecord instead.
          See https://docs.gitlab.com/ee/development/database/migrations_for_multiple_databases.html#example-usage-of-activerecord-classes.
        MSG

        def_node_search :inherits_from_active_record_base?, <<~PATTERN
          (class _ (const (const _ :ActiveRecord) :Base) _)
        PATTERN

        def_node_search :inherits_from_application_record?, <<~PATTERN
          (class _ (const _ :ApplicationRecord) _)
        PATTERN

        def on_class(node)
          return unless relevant_migration?(node)
          return unless inherits_from_active_record_base?(node) || inherits_from_application_record?(node)

          add_offense(node)
        end

        private

        def relevant_migration?(node)
          in_migration?(node) && version(node) >= ENFORCED_SINCE
        end
      end
    end
  end
end