gitlab-org--gitlab-foss/app/models/user_callout.rb

# frozen_string_literal: true

class UserCallout < ApplicationRecord
  belongs_to :user

  # We use `UserCalloutEnums.feature_names` here so that EE can more easily
  # extend this `Hash` with new values.
  enum feature_name: ::UserCalloutEnums.feature_names

  validates :user, presence: true
  validates :feature_name,
    presence: true,
    uniqueness: { scope: :user_id },
    inclusion: { in: UserCallout.feature_names.keys }
end
Enable frozen string in app/models/*.rb Partially addresses #47424. 2018-07-25 05:30:33 -04:00			`# frozen_string_literal: true`

Inherit from ApplicationRecord instead of ActiveRecord::Base 2019-03-28 09:17:42 -04:00			`class UserCallout < ApplicationRecord`
Add Callout model 2018-01-26 11:06:52 -05:00			`belongs_to :user`
Remove dismissed_state from Callout model 2018-02-01 21:07:33 -05:00
Refactor how a few ActiveRecord enums are defined In a few models we define ActiveRecord enums that are redefined in EE using the following pattern: enum :some_enum, { ... }.merge(EE_ENUM_VALUES) This particular approach is problematic to deal with, because it requires that we `prepend` and EE module _before_ defining the enum. This typically translates to the `prepend` being the first line in the model in EE, but this can easily lead to merge conflicts when developers add more `include` and/or `prepend` lines. As part of https://gitlab.com/gitlab-org/gitlab-ee/issues/8244 and https://gitlab.com/gitlab-org/gitlab-ee/issues/8241 we are moving `prepend` to the last line in a file, reducing the chances of running into merge conflicts. This poses a bit of a problem with the pattern above, because this pattern does not allow us to move the `prepend` further down a file. To resolve this problem, we simply move the Hash value of the enum to a separate class method. This method is defined in a separate module where necessary, allowing us to use it like so: enum :failure_reasons, ::SomeModelEnums.failure_reasons The method in turn is defined in a very straightforward manner: module SomeModelEnums def self.failure_reasons { ... } end end This makes it easy for EE to add values without requiring the `prepend` to be placed before the `enum` is defined. For more information, see the following issues and merge requests: * https://gitlab.com/gitlab-org/gitlab-ee/issues/8244 * https://gitlab.com/gitlab-org/gitlab-ee/issues/8241 * https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/8424 2018-11-13 11:29:14 -05:00			# We use `UserCalloutEnums.feature_names` here so that EE can more easily
			# extend this `Hash` with new values.
			`enum feature_name: ::UserCalloutEnums.feature_names`
Change UserCallout feautre_name to enum 2018-02-02 18:16:24 -05:00
Remove dismissed_state from Callout model 2018-02-01 21:07:33 -05:00			`validates :user, presence: true`
Change UserCallout feautre_name to enum 2018-02-02 18:16:24 -05:00			`validates :feature_name,`
			`presence: true,`
			`uniqueness: { scope: :user_id },`
			`inclusion: { in: UserCallout.feature_names.keys }`
Add Callout model 2018-01-26 11:06:52 -05:00			`end`