Module: Ci::StatusHelper

Defined in:
app/helpers/ci/status_helper.rb

Instance Method Summary collapse

Instance Method Details

#ci_icon_class_for_status(status) ⇒ Object

rubocop:enable Metrics/CyclomaticComplexity


106
107
108
109
110
# File 'app/helpers/ci/status_helper.rb', line 106

def ci_icon_class_for_status(status)
  group = detailed_status?(status) ? status.group : status.dasherize

  "ci-status-icon-#{group}"
end

#ci_icon_for_status(status, size: 16) ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'app/helpers/ci/status_helper.rb', line 67

def ci_icon_for_status(status, size: 16)
  if detailed_status?(status)
    return sprite_icon(status.icon, size: size)
  end

  icon_name =
    case status
    when 'success'
      'status_success'
    when 'success-with-warnings'
      'status_warning'
    when 'failed'
      'status_failed'
    when 'pending'
      'status_pending'
    when 'waiting_for_resource'
      'status_pending'
    when 'preparing'
      'status_preparing'
    when 'running'
      'status_running'
    when 'play'
      'play'
    when 'created'
      'status_created'
    when 'skipped'
      'status_skipped'
    when 'manual'
      'status_manual'
    when 'scheduled'
      'status_scheduled'
    else
      'status_canceled'
    end

  sprite_icon(icon_name, size: size)
end

#ci_label_for_status(status) ⇒ Object


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'app/helpers/ci/status_helper.rb', line 12

def ci_label_for_status(status)
  if detailed_status?(status)
    return status.label
  end

  label = case status
          when 'success'
            'passed'
          when 'success-with-warnings'
            'passed with warnings'
          when 'manual'
            'waiting for manual action'
          when 'scheduled'
            'waiting for delayed job'
          else
            status
          end
  translation = "CiStatusLabel|#{label}"
  s_(translation)
end

#ci_status_for_statuseable(subject) ⇒ Object


61
62
63
64
# File 'app/helpers/ci/status_helper.rb', line 61

def ci_status_for_statuseable(subject)
  status = subject.try(:status) || 'not found'
  status.humanize
end

#ci_text_for_status(status) ⇒ Object


33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'app/helpers/ci/status_helper.rb', line 33

def ci_text_for_status(status)
  if detailed_status?(status)
    return status.text
  end

  case status
  when 'success'
    s_('CiStatusText|passed')
  when 'success-with-warnings'
    s_('CiStatusText|passed')
  when 'manual'
    s_('CiStatusText|blocked')
  when 'scheduled'
    s_('CiStatusText|delayed')
  else
    # All states are already being translated inside the detailed statuses:
    # :running => Gitlab::Ci::Status::Running
    # :skipped => Gitlab::Ci::Status::Skipped
    # :failed => Gitlab::Ci::Status::Failed
    # :success => Gitlab::Ci::Status::Success
    # :canceled => Gitlab::Ci::Status::Canceled
    # The following states are customized above:
    # :manual => Gitlab::Ci::Status::Manual
    status_translation = "CiStatusText|#{status}"
    s_(status_translation)
  end
end

#detailed_status?(status) ⇒ Boolean

Returns:

  • (Boolean)

141
142
143
144
145
146
# File 'app/helpers/ci/status_helper.rb', line 141

def detailed_status?(status)
  status.respond_to?(:text) &&
    status.respond_to?(:group) &&
    status.respond_to?(:label) &&
    status.respond_to?(:icon)
end

#pipeline_status_cache_key(pipeline_status) ⇒ Object


112
113
114
# File 'app/helpers/ci/status_helper.rb', line 112

def pipeline_status_cache_key(pipeline_status)
  "pipeline-status/#{pipeline_status.sha}-#{pipeline_status.status}"
end

#render_commit_status(commit, status, ref: nil, tooltip_placement: 'left') ⇒ Object


116
117
118
119
120
121
122
123
124
125
# File 'app/helpers/ci/status_helper.rb', line 116

def render_commit_status(commit, status, ref: nil, tooltip_placement: 'left')
  project = commit.project
  path = pipelines_project_commit_path(project, commit, ref: ref)

  render_status_with_link(
    status,
    path,
    tooltip_placement: tooltip_placement,
    icon_size: 24)
end

127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'app/helpers/ci/status_helper.rb', line 127

def render_status_with_link(status, path = nil, type: _('pipeline'), tooltip_placement: 'left', cssclass: '', container: 'body', icon_size: 16)
  klass = "ci-status-link #{ci_icon_class_for_status(status)} d-inline-flex #{cssclass}"
  title = "#{type.titleize}: #{ci_label_for_status(status)}"
  data = { toggle: 'tooltip', placement: tooltip_placement, container: container }

  if path
    link_to ci_icon_for_status(status, size: icon_size), path,
            class: klass, title: title, data: data
  else
     :span, ci_icon_for_status(status, size: icon_size),
            class: klass, title: title, data: data
  end
end