summaryrefslogtreecommitdiff
path: root/app/controllers/concerns/controller_with_feature_category.rb
blob: c1ff9ef2e6918142c6dabc3eb23aa662c74a87e2 (plain)
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
# frozen_string_literal: true

module ControllerWithFeatureCategory
  extend ActiveSupport::Concern
  include Gitlab::ClassAttributes

  class_methods do
    def feature_category(category, actions = [])
      feature_category_configuration[category] ||= []
      feature_category_configuration[category] += actions.map(&:to_s)

      validate_config!(feature_category_configuration)
    end

    def feature_category_for_action(action)
      category_config = feature_category_configuration.find do |_, actions|
        actions.empty? || actions.include?(action)
      end

      category_config&.first || superclass_feature_category_for_action(action)
    end

    private

    def validate_config!(config)
      empty = config.find { |_, actions| actions.empty? }
      duplicate_actions = config.values.flatten.group_by(&:itself).select { |_, v| v.count > 1 }.keys

      if config.length > 1 && empty
        raise ArgumentError, "#{empty.first} is defined for all actions, but other categories are set"
      end

      if duplicate_actions.any?
        raise ArgumentError, "Actions have multiple feature categories: #{duplicate_actions.join(', ')}"
      end
    end

    def feature_category_configuration
      class_attributes[:feature_category_config] ||= {}
    end

    def superclass_feature_category_for_action(action)
      return unless superclass.respond_to?(:feature_category_for_action)

      superclass.feature_category_for_action(action)
    end
  end
end