Module: DiffHelper

Instance Method Summary collapse

Instance Method Details

#apply_diff_view_cookie!Object


204
205
206
# File 'app/helpers/diff_helper.rb', line 204

def apply_diff_view_cookie!
  set_secure_cookie(:diff_view, params.delete(:view), type: CookiesHelper::COOKIE_TYPE_PERMANENT) if params[:view].present?
end

#collapsed_diff_url(diff_file) ⇒ Object


208
209
210
211
212
213
214
215
216
217
# File 'app/helpers/diff_helper.rb', line 208

def collapsed_diff_url(diff_file)
  url_for(
    safe_params.merge(
      action: :diff_for_path,
      old_path: diff_file.old_path,
      new_path: diff_file.new_path,
      file_identifier: diff_file.file_identifier
    )
  )
end

#diff_file_blob_raw_path(diff_file) ⇒ Object


167
168
169
# File 'app/helpers/diff_helper.rb', line 167

def diff_file_blob_raw_path(diff_file)
  diff_file_blob_raw_url(diff_file, only_path: true)
end

#diff_file_blob_raw_url(diff_file, only_path: false) ⇒ Object


156
157
158
# File 'app/helpers/diff_helper.rb', line 156

def diff_file_blob_raw_url(diff_file, only_path: false)
  project_raw_url(@project, tree_join(diff_file.content_sha, diff_file.file_path), only_path: only_path)
end

#diff_file_html_data(project, diff_file_path, diff_commit_id) ⇒ Object


175
176
177
178
179
180
# File 'app/helpers/diff_helper.rb', line 175

def diff_file_html_data(project, diff_file_path, diff_commit_id)
  {
    blob_diff_path: project_blob_diff_path(project, tree_join(diff_commit_id, diff_file_path)),
    view: diff_view
  }
end

#diff_file_old_blob_raw_path(diff_file) ⇒ Object


171
172
173
# File 'app/helpers/diff_helper.rb', line 171

def diff_file_old_blob_raw_path(diff_file)
  diff_file_old_blob_raw_url(diff_file, only_path: true)
end

#diff_file_old_blob_raw_url(diff_file, only_path: false) ⇒ Object


160
161
162
163
164
165
# File 'app/helpers/diff_helper.rb', line 160

def diff_file_old_blob_raw_url(diff_file, only_path: false)
  sha = diff_file.old_content_sha
  return unless sha

  project_raw_url(@project, tree_join(diff_file.old_content_sha, diff_file.old_path), only_path: only_path)
end

#diff_file_stats_data(diff_file) ⇒ Object


182
183
184
185
186
187
188
189
190
191
192
# File 'app/helpers/diff_helper.rb', line 182

def diff_file_stats_data(diff_file)
  old_blob = diff_file.old_blob
  new_blob = diff_file.new_blob
  {
    old_size: old_blob&.size,
    new_size: new_blob&.size,
    added_lines: diff_file.added_lines,
    removed_lines: diff_file.removed_lines,
    viewer_name: diff_file.viewer.partial_name
  }
end

#diff_line_content(line) ⇒ Object


75
76
77
78
79
80
81
82
83
84
85
86
# File 'app/helpers/diff_helper.rb', line 75

def diff_line_content(line)
  if line.blank?
    " ".html_safe
  else
    # `sub` and substring-ing would destroy HTML-safeness of `line`
    if line.start_with?('+', '-', ' ')
      line[1, line.length]
    else
      line
    end
  end
end

88
89
90
# File 'app/helpers/diff_helper.rb', line 88

def diff_link_number(line_type, match, text)
  line_type == match ? " " : text
end

#diff_match_line(old_pos, new_pos, text: '', view: :inline, bottom: false) ⇒ Object


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'app/helpers/diff_helper.rb', line 41

def diff_match_line(old_pos, new_pos, text: '', view: :inline, bottom: false)
  content_line_class = %w[line_content match]
  content_line_class << 'parallel' if view == :parallel

  line_num_class = %w[diff-line-num unfold js-unfold]
  line_num_class << 'js-unfold-bottom' if bottom

  html = []

  if old_pos
    html << (:td, '...', class: [*line_num_class, 'old_line'], data: { linenumber: old_pos })
    html << (:td, text, class: [*content_line_class, 'left-side']) if view == :parallel
  end

  if new_pos
    html << (:td, '...', class: [*line_num_class, 'new_line'], data: { linenumber: new_pos })
    html << (:td, text, class: [*content_line_class, ('right-side' if view == :parallel)])
  end

  html.join.html_safe
end

#diff_nomappinginraw_line(line, first_line_num_class, second_line_num_class, content_line_class) ⇒ Object


63
64
65
66
67
68
69
70
71
72
73
# File 'app/helpers/diff_helper.rb', line 63

def diff_nomappinginraw_line(line, first_line_num_class, second_line_num_class, content_line_class)
  css_class = ''
  css_class = 'old' if line.type == 'old-nomappinginraw'
  css_class = 'new' if line.type == 'new-nomappinginraw'

  html = [(:td, '', class: [*first_line_num_class, css_class])]
  html << (:td, '', class: [*second_line_num_class, css_class]) if second_line_num_class
  html << (:td, diff_line_content(line.rich_text), class: [*content_line_class, 'nomappinginraw', css_class])

  html.join.html_safe
end

#diff_optionsObject


30
31
32
33
34
35
36
37
38
39
# File 'app/helpers/diff_helper.rb', line 30

def diff_options
  options = { ignore_whitespace_change: hide_whitespace?, expanded: diffs_expanded?, use_extra_viewer_as_main: true }

  if action_name == 'diff_for_path'
    options[:expanded] = true
    options[:paths] = params.values_at(:old_path, :new_path)
  end

  options
end

#diff_viewObject


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

def diff_view
  @diff_view ||= begin
    diff_views = %w(inline parallel)
    diff_view = params[:view] || cookies[:diff_view]
    diff_view = diff_views.first unless diff_views.include?(diff_view)
    diff_view.to_sym
  end
end

#diffs_expanded?Boolean

Returns:

  • (Boolean)

13
14
15
# File 'app/helpers/diff_helper.rb', line 13

def diffs_expanded?
  params[:expanded].present?
end

#editable_diff?(diff_file) ⇒ Boolean

Returns:

  • (Boolean)

194
195
196
# File 'app/helpers/diff_helper.rb', line 194

def editable_diff?(diff_file)
  !diff_file.deleted_file? && @merge_request && @merge_request.source_project
end

#inline_diff_btnObject


110
111
112
# File 'app/helpers/diff_helper.rb', line 110

def inline_diff_btn
  diff_btn('Inline', 'inline', diff_view == :inline)
end

#mark_inline_diffs(old_line, new_line) ⇒ Object


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

def mark_inline_diffs(old_line, new_line)
  old_diffs, new_diffs = Gitlab::Diff::InlineDiff.new(old_line, new_line).inline_diffs

  marked_old_line = Gitlab::Diff::InlineDiffMarker.new(old_line).mark(old_diffs)
  marked_new_line = Gitlab::Diff::InlineDiffMarker.new(new_line).mark(new_diffs)

  [marked_old_line, marked_new_line]
end

#parallel_diff_btnObject


114
115
116
# File 'app/helpers/diff_helper.rb', line 114

def parallel_diff_btn
  diff_btn('Side-by-side', 'parallel', diff_view == :parallel)
end

#parallel_diff_discussions(left, right, diff_file) ⇒ Object


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'app/helpers/diff_helper.rb', line 92

def parallel_diff_discussions(left, right, diff_file)
  return unless @grouped_diff_discussions

  discussions_left = discussions_right = nil

  if left && left.discussable? && (left.unchanged? || left.removed?)
    line_code = diff_file.line_code(left)
    discussions_left = @grouped_diff_discussions[line_code]
  end

  if right && right.discussable? && right.added?
    line_code = diff_file.line_code(right)
    discussions_right = @grouped_diff_discussions[line_code]
  end

  [discussions_left, discussions_right]
end

#render_fork_suggestionObject

As the fork suggestion button is identical every time, we cache it for a full page load


220
221
222
223
224
225
226
# File 'app/helpers/diff_helper.rb', line 220

def render_fork_suggestion
  return unless current_user

  strong_memoize(:fork_suggestion) do
    render partial: "projects/fork_suggestion"
  end
end

#render_overflow_warning?(diffs_collection) ⇒ Boolean

Returns:

  • (Boolean)

198
199
200
201
202
# File 'app/helpers/diff_helper.rb', line 198

def render_overflow_warning?(diffs_collection)
  diffs_collection.overflow?.tap do |overflown|
    log_overflow_limits(diff_files: diffs_collection.raw_diff_files, collection_overflow: overflown)
  end
end

#show_only_context_commits?Boolean

Returns:

  • (Boolean)

26
27
28
# File 'app/helpers/diff_helper.rb', line 26

def show_only_context_commits?
  !!params[:only_context_commits] || @merge_request&.commits&.empty?
end

134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'app/helpers/diff_helper.rb', line 134

def submodule_diff_compare_link(diff_file)
  compare_url = submodule_links(diff_file.blob, diff_file.content_sha, diff_file.repository, diff_file)&.compare

  link = ""

  if compare_url

    link_text = [
        _('Compare'),
        ' ',
        (:span, Commit.truncate_sha(diff_file.old_blob.id), class: 'commit-sha'),
        '...',
        (:span, Commit.truncate_sha(diff_file.blob.id), class: 'commit-sha')
      ].join('').html_safe

    tooltip = _('Compare submodule commit revisions')
    link = (:span, link_to(link_text, compare_url, class: 'btn gl-button has-tooltip', title: tooltip), class: 'submodule-compare')
  end

  link
end

118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'app/helpers/diff_helper.rb', line 118

def submodule_link(blob, ref, repository = @repository)
  urls = submodule_links(blob, ref, repository)

  folder_name = truncate(blob.name, length: 40)
  folder_name = link_to(folder_name, urls.web) if urls&.web

  commit_id = Commit.truncate_sha(blob.id)
  commit_id = link_to(commit_id, urls.tree) if urls&.tree

  [
    (:span, folder_name),
    '@',
    (:span, commit_id, class: 'commit-sha')
  ].join(' ').html_safe
end