summaryrefslogtreecommitdiff
path: root/app/models/work_item/type.rb
blob: 3acb9c0011c958223864f8ef89bce3591ab356d6 (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
49
50
51
52
53
54
55
# frozen_string_literal: true

# Note: initial thinking behind `icon_name` is for it to do triple duty:
# 1. one of our svg icon names, such as `external-link` or a new one `bug`
# 2. if it's an absolute url, then url to a user uploaded icon/image
# 3. an emoji, with the format of `:smile:`
class WorkItem::Type < ApplicationRecord
  self.table_name = 'work_item_types'

  include CacheMarkdownField

  # Base types need to exist on the DB on app startup
  # This constant is used by the DB seeder
  BASE_TYPES = {
    issue:       { name: 'Issue', icon_name: 'issue-type-issue', enum_value: 0 },
    incident:    { name: 'Incident', icon_name: 'issue-type-incident', enum_value: 1 },
    test_case:   { name: 'Test Case', icon_name: 'issue-type-test-case', enum_value: 2 }, ## EE-only
    requirement: { name: 'Requirement', icon_name: 'issue-type-requirements', enum_value: 3 }, ## EE-only
    task:        { name: 'Task', icon_name: 'issue-type-task', enum_value: 4 }
  }.freeze

  cache_markdown_field :description, pipeline: :single_line

  enum base_type: BASE_TYPES.transform_values { |value| value[:enum_value] }

  belongs_to :namespace, optional: true
  has_many :work_items, class_name: 'Issue', foreign_key: :work_item_type_id, inverse_of: :work_item_type

  before_validation :strip_whitespace

  # TODO: review validation rules
  # https://gitlab.com/gitlab-org/gitlab/-/issues/336919
  validates :name, presence: true
  validates :name, uniqueness: { case_sensitive: false, scope: [:namespace_id] }
  validates :name, length: { maximum: 255 }
  validates :icon_name, length: { maximum: 255 }

  def self.default_by_type(type)
    find_by(namespace_id: nil, base_type: type)
  end

  def self.default_issue_type
    default_by_type(:issue)
  end

  def self.allowed_types_for_issues
    base_types.keys.excluding('task')
  end

  private

  def strip_whitespace
    name&.strip!
  end
end