tooling/danger/database_dictionary.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

# frozen_string_literal: true

require 'yaml'

module Tooling
  module Danger
    module DatabaseDictionary
      DICTIONARY_PATH_REGEXP = %r{db/docs/.*\.yml}

      # `change_type` can be:
      #   - :added
      #   - :modified
      #   - :deleted
      def database_dictionary_files(change_type:)
        files = helper.public_send("#{change_type}_files") # rubocop:disable GitlabSecurity/PublicSend

        files.filter_map { |path| Found.new(path) if path =~ DICTIONARY_PATH_REGEXP }
      end

      class Found
        ATTRIBUTES = %w[
          table_name classes feature_categories description introduced_by_url milestone gitlab_schema
        ].freeze

        attr_reader :path

        def initialize(path)
          @path = path
        end

        ATTRIBUTES.each do |attribute|
          define_method(attribute) do
            yaml[attribute]
          end
        end

        def raw
          @raw ||= File.read(path)
        end

        def ci_schema?
          gitlab_schema == 'gitlab_ci'
        end

        def main_schema?
          gitlab_schema == 'gitlab_main'
        end

        private

        def yaml
          @yaml ||= YAML.safe_load(raw)
        end
      end
    end
  end
end