Module: SnippetsHelper

Included in:
Gitlab::SnippetSearchResults
Defined in:
app/helpers/snippets_helper.rb

Instance Method Summary collapse

Instance Method Details

#embedded_copy_snippet_button(blob) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'app/helpers/snippets_helper.rb', line 61

def embedded_copy_snippet_button(blob)
  return unless blob.rendered_as_text?(ignore_errors: false)

  button_options = { title: 'Copy snippet contents',
                     onclick: "copyToClipboard('.blob-content[data-blob-id=\"#{blob.id}\"] > pre')" }

  render Pajamas::ButtonComponent.new(button_options: button_options) do
    external_snippet_icon('copy-to-clipboard')
  end
end

#embedded_raw_snippet_button(snippet, blob) ⇒ Object 



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

def embedded_raw_snippet_button(snippet, blob)
  return if blob.empty? || blob.binary? || blob.stored_externally?

  render Pajamas::ButtonComponent.new(href: gitlab_raw_snippet_blob_url(snippet, blob.path), target: '_blank',
    button_options: { rel: 'noopener noreferrer', title: 'Open raw' }) do
    external_snippet_icon('doc-code')
  end
end

#embedded_snippet_download_button(snippet, blob) ⇒ Object 



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

def embedded_snippet_download_button(snippet, blob)
  render Pajamas::ButtonComponent.new(href: gitlab_raw_snippet_blob_url(snippet, blob.path, nil, inline: false),
    target: '_blank', button_options: { rel: 'noopener noreferrer', title: 'Download' }) do
    external_snippet_icon('download')
  end
end

#project_snippets_award_api_path(snippet) ⇒ Object 



86
87
88
 
# File 'app/helpers/snippets_helper.rb', line 86

def project_snippets_award_api_path(snippet)
  api_v4_projects_snippets_award_emoji_path(id: snippet.project.id, snippet_id: snippet.id)
end

#snippet_badge(snippet) ⇒ Object 



25
26
27
28
29
30
31
 
# File 'app/helpers/snippets_helper.rb', line 25

def snippet_badge(snippet)
  return unless attrs = snippet_badge_attributes(snippet)

  icon_name, text = attrs

  gl_badge_tag(text, icon: icon_name)
end

#snippet_badge_attributes(snippet) ⇒ Object 



33
34
35
36
37
 
# File 'app/helpers/snippets_helper.rb', line 33

def snippet_badge_attributes(snippet)
  if snippet.private?
    ['lock', _('private')]
  end
end

#snippet_file_count(snippet) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'app/helpers/snippets_helper.rb', line 72

def snippet_file_count(snippet)
  file_count = snippet.statistics&.file_count

  return unless file_count&.nonzero?

  tooltip = n_('%d file', '%d files', file_count) % file_count

  tag.span(class: 'file_count', title: tooltip, data: { toggle: 'tooltip', container: 'body' }) do
    concat(sprite_icon('documents', css_class: 'gl-vertical-align-middle'))
    concat(' ')
    concat(file_count)
  end
end

#snippet_report_abuse_path(snippet) ⇒ Object 



39
40
41
42
43
 
# File 'app/helpers/snippets_helper.rb', line 39

def snippet_report_abuse_path(snippet)
  return unless snippet.submittable_as_spam_by?(current_user)

  mark_as_spam_snippet_path(snippet)
end

#snippets_upload_path(snippet, user) ⇒ Object 



4
5
6
7
8
9
10
11
12
 
# File 'app/helpers/snippets_helper.rb', line 4

def snippets_upload_path(snippet, user)
  return unless user

  if snippet&.persisted?
    upload_path('personal_snippet', id: snippet.id)
  else
    upload_path('user', id: user.id)
  end
end

#subject_snippets_path(subject = nil, opts = nil) ⇒ Object

Return the path of a snippets index for a user or for a project



17
18
19
20
21
22
23
 
# File 'app/helpers/snippets_helper.rb', line 17

def subject_snippets_path(subject = nil, opts = nil)
  if subject.is_a?(Project)
    project_snippets_path(subject, opts)
  else # assume subject === User
    dashboard_snippets_path(opts)
  end
end