Module: EventsHelper

Defined in:
app/helpers/events_helper.rb

Constant Summary collapse

ICON_NAMES_BY_EVENT_TYPE =
{
  'pushed to' => 'commit',
  'pushed new' => 'commit',
  'updated' => 'commit',
  'created' => 'status_open',
  'opened' => 'status_open',
  'closed' => 'status_closed',
  'accepted' => 'fork',
  'commented on' => 'comment',
  'deleted' => 'remove',
  'destroyed' => 'remove',
  'imported' => 'import',
  'joined' => 'users'
}.freeze
DESIGN_ICONS =
{
  'created' => 'upload',
  'updated' => 'pencil',
  'destroyed' => ICON_NAMES_BY_EVENT_TYPE['destroyed']
}.freeze

Instance Method Summary collapse

Instance Method Details

#comments_visible?Boolean

Returns:

  • (Boolean)

75
76
77
78
79
# File 'app/helpers/events_helper.rb', line 75

def comments_visible?
  event_filter_visible(:repository) ||
    event_filter_visible(:merge_requests) ||
    event_filter_visible(:issues)
end

#design_activity_enabled?(project) ⇒ Boolean

Returns:

  • (Boolean)

71
72
73
# File 'app/helpers/events_helper.rb', line 71

def design_activity_enabled?(project)
  Ability.allowed?(current_user, :read_design_activity, project)
end

#design_event_icon(action, size: 24) ⇒ Object


246
247
248
249
# File 'app/helpers/events_helper.rb', line 246

def design_event_icon(action, size: 24)
  icon_name = DESIGN_ICONS[action]
  sprite_icon(icon_name, size: size) if icon_name
end

#designs_visible?Boolean

Returns:

  • (Boolean)

59
60
61
62
63
64
65
66
67
68
69
# File 'app/helpers/events_helper.rb', line 59

def designs_visible?
  if @project
    design_activity_enabled?(@project)
  elsif @group
    design_activity_enabled?(@group)
  elsif @projects
    @projects.with_namespace.include_project_feature.any? { |p| design_activity_enabled?(p) }
  else
    true
  end
end

#event_action_name(event) ⇒ Object


30
31
32
33
34
# File 'app/helpers/events_helper.rb', line 30

def event_action_name(event)
  target = event.note_target_type_name || event.target_type_name

  [event.action_name, target].join(" ")
end

#event_commit_title(message) ⇒ Object


228
229
230
231
232
233
# File 'app/helpers/events_helper.rb', line 228

def event_commit_title(message)
  message ||= ''
  (message.split("\n").first || "").truncate(70)
rescue StandardError
  "--broken encoding"
end

#event_design_title_html(event) ⇒ Object


204
205
206
207
208
209
210
211
# File 'app/helpers/events_helper.rb', line 204

def event_design_title_html(event)
  capture do
    concat (:span, _('design'), class: "event-target-type gl-mr-2")
    concat link_to(event.design.reference_link_text, design_url(event.design),
                   title: event.target_title,
                   class: 'has-tooltip event-design event-target-link gl-mr-2')
  end
end

#event_feed_summary(event) ⇒ Object


166
167
168
169
170
171
172
173
174
175
176
# File 'app/helpers/events_helper.rb', line 166

def event_feed_summary(event)
  if event.issue?
    render "events/event_issue", issue: event.issue
  elsif event.push_action?
    render "events/event_push", event: event
  elsif event.merge_request?
    render "events/event_merge_request", merge_request: event.merge_request
  elsif event.note?
    render "events/event_note", note: event.note
  end
end

#event_feed_title(event) ⇒ Object


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'app/helpers/events_helper.rb', line 91

def event_feed_title(event)
  words = []
  words << event.author_name
  words << event_action_name(event)

  if event.push_action?
    words << event.ref_type
    words << event.ref_name
    words << "at"
  elsif event.commented_action?
    words << event.note_target_reference
    words << "at"
  elsif event.milestone?
    words << "##{event.target_iid}" if event.target_iid
    words << "in"
  elsif event.design?
    words << event.design.to_reference
    words << "in"
  elsif event.wiki_page?
    words << event.target_title
    words << "in"
  elsif event.target
    prefix =
      if event.merge_request?
        MergeRequest.reference_prefix
      else
        Issue.reference_prefix
      end

    words << "#{prefix}#{event.target_iid}:" if event.target_iid
    words << event.target.title if event.target.respond_to?(:title)
    words << "at"
  end

  words << event.resource_parent_name

  words.join(" ")
end

#event_feed_url(event) ⇒ Object


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'app/helpers/events_helper.rb', line 130

def event_feed_url(event)
  if event.issue?
    project_issue_url(event.project,
                                event.issue)
  elsif event.merge_request?
    project_merge_request_url(event.project, event.merge_request)
  elsif event.commit_note?
    project_commit_url(event.project,
                                 event.note_target)
  elsif event.note?
    if event.note_target
      event_note_target_url(event)
    end
  elsif event.push_action?
    push_event_feed_url(event)
  elsif event.created_project_action?
    project_url(event.project)
  end
end

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'app/helpers/events_helper.rb', line 36

def event_filter_link(key, text, tooltip)
  key = key.to_s
  active = 'active' if @event_filter.active?(key)
  link_opts = {
    class: "event-filter-link",
    id:    "#{key}_event_filter",
    title: tooltip
  }

   :li, class: active do
    link_to request.path, link_opts do
      (:span, ' ' + text)
    end
  end
end

#event_filter_visible(feature_key) ⇒ Object


52
53
54
55
56
57
# File 'app/helpers/events_helper.rb', line 52

def event_filter_visible(feature_key)
  return designs_visible? if feature_key == :designs
  return true unless @project

  @project.feature_available?(feature_key, current_user)
end

#event_note_target_url(event) ⇒ Object


178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'app/helpers/events_helper.rb', line 178

def event_note_target_url(event)
  if event.commit_note?
    project_commit_url(event.project, event.note_target, anchor: dom_id(event.target))
  elsif event.snippet_note?
    gitlab_snippet_url(event.note_target, anchor: dom_id(event.target))
  elsif event.issue_note?
    project_issue_url(event.project, id: event.note_target, anchor: dom_id(event.target))
  elsif event.merge_request_note?
    project_merge_request_url(event.project, id: event.note_target, anchor: dom_id(event.target))
  elsif event.design_note?
    design_url(event.note_target, anchor: dom_id(event.note))
  else
    polymorphic_url([event.project, event.note_target],
                      anchor: dom_id(event.target))
  end
end

#event_note_title_html(event) ⇒ Object


217
218
219
220
221
222
223
224
225
226
# File 'app/helpers/events_helper.rb', line 217

def event_note_title_html(event)
  if event.note_target
    capture do
      concat (:span, event.note_target_type_name, class: "event-target-type gl-mr-2")
      concat link_to(event.note_target_reference, event_note_target_url(event), title: event.target_title, class: 'has-tooltip event-target-link gl-mr-2')
    end
  else
    (:strong, '(deleted)')
  end
end

#event_preposition(event) ⇒ Object


81
82
83
84
85
86
87
88
89
# File 'app/helpers/events_helper.rb', line 81

def event_preposition(event)
  if event.wiki_page?
    'in the wiki for'
  elsif event.milestone?
    'in'
  elsif event.push_action? || event.commented_action? || event.target
    'at'
  end
end

#event_user_info(event) ⇒ Object


273
274
275
276
277
278
279
# File 'app/helpers/events_helper.rb', line 273

def (event)
  (:div, class: "event-user-info") do
    concat (:span, link_to_author(event), class: "author-name")
    concat "&nbsp;".html_safe
    concat (:span, event.author.to_reference, class: "username")
  end
end

#event_wiki_page_target_url(event) ⇒ Object


213
214
215
# File 'app/helpers/events_helper.rb', line 213

def event_wiki_page_target_url(event)
  project_wiki_url(event.project, event.target&.canonical_slug || Wiki::HOMEPAGE)
end

#event_wiki_title_html(event) ⇒ Object


195
196
197
198
199
200
201
202
# File 'app/helpers/events_helper.rb', line 195

def event_wiki_title_html(event)
  capture do
    concat (:span, _('wiki page'), class: "event-target-type gl-mr-2")
    concat link_to(event.target_title, event_wiki_page_target_url(event),
                   title: event.target_title,
                   class: 'has-tooltip event-target-link gl-mr-2')
  end
end

#icon_for_event(note, size: 24) ⇒ Object


235
236
237
238
# File 'app/helpers/events_helper.rb', line 235

def icon_for_event(note, size: 24)
  icon_name = ICON_NAMES_BY_EVENT_TYPE[note]
  sprite_icon(icon_name, size: size) if icon_name
end

#icon_for_profile_event(event) ⇒ Object


251
252
253
254
255
256
257
258
259
260
261
# File 'app/helpers/events_helper.rb', line 251

def icon_for_profile_event(event)
  if current_path?('users#show')
     :div, class: "system-note-image #{event.action_name.parameterize}-icon" do
      icon_for_event(event.action_name)
    end
  else
     :div, class: 'system-note-image user-avatar' do
      author_avatar(event, size: 32)
    end
  end
end

#inline_event_icon(event) ⇒ Object


263
264
265
266
267
268
269
270
271
# File 'app/helpers/events_helper.rb', line 263

def inline_event_icon(event)
  unless current_path?('users#show')
     :span, class: "system-note-image-inline d-none d-sm-flex gl-mr-2 #{event.action_name.parameterize}-icon align-self-center" do
      next design_event_icon(event.action, size: 14) if event.design?

      icon_for_event(event.action_name, size: 14)
    end
  end
end

19
20
21
22
23
24
25
26
27
28
# File 'app/helpers/events_helper.rb', line 19

def link_to_author(event, self_added: false)
  author = event.author

  if author
    name = self_added ? 'You' : author.name
    link_to name, user_path(author.username), title: name
  else
    escape_once(event.author_name)
  end
end

#push_event_feed_url(event) ⇒ Object


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'app/helpers/events_helper.rb', line 150

def push_event_feed_url(event)
  if event.push_with_commits? && event.md_ref?
    if event.commits_count > 1
      project_compare_url(event.project,
                                    from: event.commit_from, to:
                                    event.commit_to)
    else
      project_commit_url(event.project,
                                   id: event.commit_to)
    end
  elsif event.ref_name
    project_commits_url(event.project,
                                  event.ref_name)
  end
end