Module: NotesHelper

Constant Summary collapse

MAX_PRERENDERED_NOTES =
10

Instance Method Summary collapse

Instance Method Details

#add_diff_note_button(line_code, position, line_type) ⇒ Object


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

def add_diff_note_button(line_code, position, line_type)
  return if @diff_notes_disabled

  (:span, class: 'add-diff-note tooltip-wrapper') do
    button_tag '',
      class: 'note-button add-diff-note js-add-diff-note-button',
      type: 'submit', name: 'button',
      data: diff_view_line_data(line_code, position, line_type),
      title: _('Add a comment to this line') do
        sprite_icon('comment', size: 12)
      end
  end
end

#can_create_note?Boolean

Returns:

  • (Boolean)

141
142
143
144
145
# File 'app/helpers/notes_helper.rb', line 141

def can_create_note?
  noteable = @issue || @merge_request || @snippet || @project

  can?(current_user, :create_note, noteable)
end

#diff_view_dataObject


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

def diff_view_data
  return {} unless @new_diff_note_attrs

  @new_diff_note_attrs.slice(:noteable_id, :noteable_type, :commit_id)
end

#diff_view_line_data(line_code, position, line_type) ⇒ Object


39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'app/helpers/notes_helper.rb', line 39

def diff_view_line_data(line_code, position, line_type)
  return if @diff_notes_disabled

  data = {
    line_code: line_code,
    line_type: line_type
  }

  if @use_legacy_diff_notes
    data[:note_type] = LegacyDiffNote.name
  else
    data[:note_type] = DiffNote.name
    data[:position] = position.to_json
  end

  data
end

#discussion_path(discussion) ⇒ Object


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'app/helpers/notes_helper.rb', line 88

def discussion_path(discussion)
  if discussion.for_merge_request?
    return unless discussion.diff_discussion?

    version_params = discussion.merge_request_version_params
    return unless version_params

    path_params = version_params.merge(anchor: discussion.line_code)

    diffs_project_merge_request_path(discussion.project, discussion.noteable, path_params)
  elsif discussion.for_commit?
    anchor = discussion.diff_discussion? ? discussion.line_code : "note_#{discussion.first_note.id}"

    project_commit_path(discussion.project, discussion.noteable, anchor: anchor)
  end
end

#discussion_resolved_intro(discussion) ⇒ Object


198
199
200
# File 'app/helpers/notes_helper.rb', line 198

def discussion_resolved_intro(discussion)
  discussion.resolved_by_push? ? 'Automatically resolved' : 'Resolved'
end

#discussions_path(issuable) ⇒ Object


165
166
167
168
169
170
171
# File 'app/helpers/notes_helper.rb', line 165

def discussions_path(issuable)
  if issuable.is_a?(Issue)
    discussions_project_issue_path(@project, issuable, format: :json)
  else
    discussions_project_merge_request_path(@project, issuable, format: :json)
  end
end

#form_resourcesObject


127
128
129
130
131
132
133
# File 'app/helpers/notes_helper.rb', line 127

def form_resources
  if @snippet.is_a?(PersonalSnippet)
    [@note]
  else
    [@project, @note]
  end
end

#initial_notes_data(autocomplete) ⇒ Object


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

def initial_notes_data(autocomplete)
  {
    notesUrl: notes_url,
    notesIds: @noteable.notes.pluck(:id), # rubocop: disable CodeReuse/ActiveRecord
    now: Time.now.to_i,
    diffView: diff_view,
    enableGFM: {
      emojis: true,
      members: autocomplete,
      issues: autocomplete,
      mergeRequests: autocomplete,
      epics: autocomplete,
      milestones: autocomplete,
      labels: autocomplete
    }
  }
end

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

def link_to_reply_discussion(discussion, line_type = nil)
  return unless current_user

  data = {
    discussion_id: discussion.reply_id,
    discussion_project_id: discussion.project&.id,
    line_type: line_type
  }

  button_tag 'Reply...', class: 'btn btn-text-field js-discussion-reply-button',
                         data: data, title: 'Add a reply'
end

#new_form_urlObject


135
136
137
138
139
# File 'app/helpers/notes_helper.rb', line 135

def new_form_url
  return unless @snippet.is_a?(PersonalSnippet)

  gitlab_snippet_notes_path(@snippet)
end

#note_max_access_for_user(note) ⇒ Object


84
85
86
# File 'app/helpers/notes_helper.rb', line 84

def note_max_access_for_user(note)
  note.project.team.max_member_access(note.author_id)
end

#note_supports_quick_actions?(note) ⇒ Boolean

Returns:

  • (Boolean)

20
21
22
# File 'app/helpers/notes_helper.rb', line 20

def note_supports_quick_actions?(note)
  Notes::QuickActionsService.supported?(note)
end

#note_target_fields(note) ⇒ Object


13
14
15
16
17
18
# File 'app/helpers/notes_helper.rb', line 13

def note_target_fields(note)
  if note.noteable
    hidden_field_tag(:target_type, note.noteable.class.name.underscore) +
      hidden_field_tag(:target_id, note.noteable.id)
  end
end

#note_target_title(note) ⇒ Object


6
7
8
9
10
11
# File 'app/helpers/notes_helper.rb', line 6

def note_target_title(note)
  # The design title is already present in `Event#note_target_reference`.
  return if note.nil? || note.for_design?

  note.title
end

#note_url(note, project = @project) ⇒ Object


115
116
117
118
119
120
121
# File 'app/helpers/notes_helper.rb', line 115

def note_url(note, project = @project)
  if note.noteable.is_a?(PersonalSnippet)
    gitlab_snippet_note_path(note.noteable, note)
  else
    project_note_path(project, note)
  end
end

#noteable_json(noteable) ⇒ Object


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

def noteable_json(noteable)
  {
    id: noteable.id,
    class: noteable.class.name,
    resources: noteable.class.table_name,
    project_id: noteable.project.id
  }.to_json
end

#noteable_note_url(note) ⇒ Object


123
124
125
# File 'app/helpers/notes_helper.rb', line 123

def noteable_note_url(note)
  Gitlab::UrlBuilder.build(note) if note.id
end

#notes_data(issuable) ⇒ Object


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'app/helpers/notes_helper.rb', line 173

def notes_data(issuable)
  data = {
    discussionsPath: discussions_path(issuable),
    registerPath: new_session_path(:user, redirect_to_referer: 'yes', anchor: 'register-pane'),
    newSessionPath: new_session_path(:user, redirect_to_referer: 'yes'),
    markdownDocsPath: help_page_path('user/markdown'),
    quickActionsDocsPath: help_page_path('user/project/quick_actions'),
    closePath: close_issuable_path(issuable),
    reopenPath: reopen_issuable_path(issuable),
    notesPath: notes_url,
    prerenderedNotesCount: issuable.capped_notes_count(MAX_PRERENDERED_NOTES),
    lastFetchedAt: Time.now.to_i * ::Gitlab::UpdatedNotesPaginator::MICROSECOND
  }

  if issuable.is_a?(MergeRequest)
    data.merge!(
      draftsPath: project_merge_request_drafts_path(@project, issuable),
      draftsPublishPath: publish_project_merge_request_drafts_path(@project, issuable),
      draftsDiscardPath: discard_project_merge_request_drafts_path(@project, issuable)
    )
  end

  data
end

#notes_url(params = {}) ⇒ Object


105
106
107
108
109
110
111
112
113
# File 'app/helpers/notes_helper.rb', line 105

def notes_url(params = {})
  if @snippet.is_a?(PersonalSnippet)
    gitlab_snippet_notes_path(@snippet, params)
  else
    params.merge!(target_id: @noteable.id, target_type: @noteable.class.name.underscore)

    project_noteable_notes_path(@project, params)
  end
end

#rendered_for_merge_request?Boolean

Returns:

  • (Boolean)

202
203
204
# File 'app/helpers/notes_helper.rb', line 202

def rendered_for_merge_request?
  params[:from_merge_request].present?
end

#serialize_notes?Boolean

Returns:

  • (Boolean)

206
207
208
# File 'app/helpers/notes_helper.rb', line 206

def serialize_notes?
  rendered_for_merge_request? || params['html'].nil?
end