2020-04-22 15:09:27 +00:00
# frozen_string_literal: true
module Limitable
extend ActiveSupport :: Concern
2020-05-27 18:08:14 +00:00
GLOBAL_SCOPE = :limitable_global_scope
2020-04-22 15:09:27 +00:00
included do
class_attribute :limit_scope
2021-06-02 15:09:59 +00:00
class_attribute :limit_relation
2020-04-22 15:09:27 +00:00
class_attribute :limit_name
2021-05-05 21:09:59 +00:00
class_attribute :limit_feature_flag
2021-07-31 00:10:15 +00:00
class_attribute :limit_feature_flag_for_override # Allows selectively disabling by actor (as per https://docs.gitlab.com/ee/development/feature_flags/#selectively-disable-by-actor)
2020-04-22 15:09:27 +00:00
self . limit_name = self . name . demodulize . tableize
validate :validate_plan_limit_not_exceeded , on : :create
end
private
def validate_plan_limit_not_exceeded
2020-05-27 18:08:14 +00:00
if GLOBAL_SCOPE == limit_scope
validate_global_plan_limit_not_exceeded
else
validate_scoped_plan_limit_not_exceeded
end
end
def validate_scoped_plan_limit_not_exceeded
2020-04-22 15:09:27 +00:00
scope_relation = self . public_send ( limit_scope ) # rubocop:disable GitlabSecurity/PublicSend
return unless scope_relation
2022-05-06 15:09:03 +00:00
return if limit_feature_flag && :: Feature . disabled? ( limit_feature_flag , scope_relation )
return if limit_feature_flag_for_override && :: Feature . enabled? ( limit_feature_flag_for_override , scope_relation )
2020-04-22 15:09:27 +00:00
2021-06-02 15:09:59 +00:00
relation = limit_relation ? self . public_send ( limit_relation ) : self . class . where ( limit_scope = > scope_relation ) # rubocop:disable GitlabSecurity/PublicSend
2020-05-27 18:08:14 +00:00
limits = scope_relation . actual_limits
2020-04-22 15:09:27 +00:00
2020-05-27 18:08:14 +00:00
check_plan_limit_not_exceeded ( limits , relation )
end
def validate_global_plan_limit_not_exceeded
relation = self . class . all
limits = Plan . default . actual_limits
check_plan_limit_not_exceeded ( limits , relation )
end
def check_plan_limit_not_exceeded ( limits , relation )
return unless limits . exceeded? ( limit_name , relation )
errors . add ( :base , _ ( " Maximum number of %{name} (%{count}) exceeded " ) %
{ name : limit_name . humanize ( capitalize : false ) , count : limits . public_send ( limit_name ) } ) # rubocop:disable GitlabSecurity/PublicSend
2020-04-22 15:09:27 +00:00
end
end