Module: EventsHelper

Included in:
Profile::EventEntity
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) 


124
125
126
127
128
 
# File 'app/helpers/events_helper.rb', line 124

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

#design_activity_enabled?(project) ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'app/helpers/events_helper.rb', line 120

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

#design_event_icon(action, size: 24) ⇒ Object 



300
301
302
303
 
# File 'app/helpers/events_helper.rb', line 300

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) 


108
109
110
111
112
113
114
115
116
117
118
 
# File 'app/helpers/events_helper.rb', line 108

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 



79
80
81
82
83
 
# File 'app/helpers/events_helper.rb', line 79

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 



282
283
284
285
286
287
 
# File 'app/helpers/events_helper.rb', line 282

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

#event_design_title_html(event) ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
 
# File 'app/helpers/events_helper.rb', line 255

def event_design_title_html(event)
  capture do
    concat content_tag(: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 



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

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 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'app/helpers/events_helper.rb', line 146

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 



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'app/helpers/events_helper.rb', line 185

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

#event_filter_link(key, text, tooltip) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'app/helpers/events_helper.rb', line 85

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
  }

  content_tag :li, class: active do
    link_to request.path, link_opts do
      content_tag(:span, " #{text}")
    end
  end
end

#event_filter_visible(feature_key) ⇒ Object 



101
102
103
104
105
106
 
# File 'app/helpers/events_helper.rb', line 101

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 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'app/helpers/events_helper.rb', line 227

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 



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

def event_note_title_html(event)
  if event.note_target
    capture do
      concat content_tag(: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
    content_tag(:strong, '(deleted)')
  end
end

#event_preposition(event) ⇒ Object 



130
131
132
133
134
135
136
137
138
 
# File 'app/helpers/events_helper.rb', line 130

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_target_path(event) ⇒ Object 



140
141
142
143
144
 
# File 'app/helpers/events_helper.rb', line 140

def event_target_path(event)
  return Gitlab::UrlBuilder.build(event.target, only_path: true) if event.work_item?

  event.target_link_options
end

#event_user_info(event) ⇒ Object 



327
328
329
330
331
332
333
 
# File 'app/helpers/events_helper.rb', line 327

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

#event_wiki_page_target_url(event) ⇒ Object 



267
268
269
 
# File 'app/helpers/events_helper.rb', line 267

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 



243
244
245
246
247
248
249
250
251
252
253
 
# File 'app/helpers/events_helper.rb', line 243

def event_wiki_title_html(event)
  capture do
    concat content_tag(: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 



289
290
291
292
 
# File 'app/helpers/events_helper.rb', line 289

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 



305
306
307
308
309
310
311
312
313
314
315
 
# File 'app/helpers/events_helper.rb', line 305

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

#inline_event_icon(event) ⇒ Object 



317
318
319
320
321
322
323
324
325
 
# File 'app/helpers/events_helper.rb', line 317

def inline_event_icon(event)
  unless current_path?('users#show')
    content_tag :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

#link_to_author(event, self_added: false) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
 
# File 'app/helpers/events_helper.rb', line 68

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

#localized_action_name(event) ⇒ Object 



62
63
64
65
66
 
# File 'app/helpers/events_helper.rb', line 62

def localized_action_name(event)
  action_name = event.action_name
  # The action fallback is used to cover the types were not included in the maps.
  localized_action_name_map[action_name.to_sym] || action_name
end

#localized_action_name_map ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'app/helpers/events_helper.rb', line 19

def localized_action_name_map
  {
    accepted: s_('Event|accepted'),
    approved: s_('Event|approved'),
    closed: s_('Event|closed'),
    'commented on': s_('Event|commented on'),
    created: s_('Event|created'),
    destroyed: s_('Event|destroyed'),
    joined: s_('Event|joined'),
    left: s_('Event|left'),
    opened: s_('Event|opened'),
    updated: s_('Event|updated'),
    'removed due to membership expiration from': s_('Event|removed due to membership expiration from')
  }.merge(
    localized_push_action_name_map,
    localized_created_project_action_name_map,
    localized_design_action_names
  ).freeze
end

#localized_created_project_action_name_map ⇒ Object 



47
48
49
50
51
52
 
# File 'app/helpers/events_helper.rb', line 47

def localized_created_project_action_name_map
  {
    created: s_('Event|created'),
    imported: s_('Event|imported')
  }.freeze
end

#localized_design_action_names ⇒ Object 



54
55
56
57
58
59
60
 
# File 'app/helpers/events_helper.rb', line 54

def localized_design_action_names
  {
    added: s_('Event|added'),
    updated: s_('Event|updated'),
    removed: s_('Event|removed')
  }.freeze
end

#localized_push_action_name_map ⇒ Object 



39
40
41
42
43
44
45
 
# File 'app/helpers/events_helper.rb', line 39

def localized_push_action_name_map
  {
    'pushed new': s_('Event|pushed new'),
    deleted: s_('Event|deleted'),
    'pushed to': s_('Event|pushed to')
  }.freeze
end

#push_event_feed_url(event) ⇒ Object 



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

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