File: rspec_metadata_validator.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 (36 lines) | stat: -rw-r--r-- 851 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
# frozen_string_literal: true

# rubocop:disable Gitlab/NamespacedClass -- There is no product domain for this class.
class RspecMetadataValidator
  class UnknownMetadataError < RuntimeError
    def initialize(keys)
      super(<<~MSG)
        Following metadata keys are unknown: #{keys}
        Please fix the key name or update the 'known_rspec_metadata_keys.yml' file.
      MSG
    end
  end

  class << self
    def validate!(metadata)
      extra_keys = metadata.keys - known_keys

      return unless extra_keys.any?

      raise UnknownMetadataError, extra_keys
    end

    private

    def known_keys
      @known_keys ||= YAML.load_file(known_keys_file)
    end

    def known_keys_file
      File.join(__dir__, 'known_rspec_metadata_keys.yml')
    end
  end
end

RspecMetadataValidator.prepend_mod
# rubocop:enable Gitlab/NamespacedClass