BigW Consortium Gitlab

diff_helper.rb 6.53 KB
Newer Older
1
module DiffHelper
2 3 4
  def mark_inline_diffs(old_line, new_line)
    old_diffs, new_diffs = Gitlab::Diff::InlineDiff.new(old_line, new_line).inline_diffs

5 6
    marked_old_line = Gitlab::Diff::InlineDiffMarker.new(old_line).mark(old_diffs, mode: :deletion)
    marked_new_line = Gitlab::Diff::InlineDiffMarker.new(new_line).mark(new_diffs, mode: :addition)
7 8 9 10

    [marked_old_line, marked_new_line]
  end

11 12
  def diffs_expanded?
    params[:expanded].present?
13 14
  end

15
  def diff_view
16 17
    @diff_view ||= begin
      diff_views = %w(inline parallel)
18
      diff_view = params[:view] || cookies[:diff_view]
19 20
      diff_view = diff_views.first unless diff_views.include?(diff_view)
      diff_view.to_sym
21
    end
22 23
  end

24
  def diff_options
25
    options = { ignore_whitespace_change: hide_whitespace?, expanded: diffs_expanded? }
26 27

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

32
    options
Douwe Maan committed
33 34
  end

35
  def diff_match_line(old_pos, new_pos, text: '', view: :inline, bottom: false)
36 37 38 39 40
    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
41 42 43

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

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

53
    html.html_safe
54 55
  end

56
  def diff_line_content(line)
57
    if line.blank?
58
      "&nbsp;".html_safe
59
    else
60 61 62
      # We can't use `sub` because the HTML-safeness of `line` will not survive.
      line[0] = '' if line.start_with?('+', '-', ' ')
      line
63 64
    end
  end
65

66
  def parallel_diff_discussions(left, right, diff_file)
Douwe Maan committed
67
    return unless @grouped_diff_discussions
68

69
    discussions_left = discussions_right = nil
70

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

76
    if right && right.discussable? && right.added?
77
      line_code = diff_file.line_code(right)
78
      discussions_right = @grouped_diff_discussions[line_code]
79 80
    end

81
    [discussions_left, discussions_right]
82
  end
83 84

  def inline_diff_btn
85
    diff_btn('Inline', 'inline', diff_view == :inline)
86 87 88
  end

  def parallel_diff_btn
89
    diff_btn('Side-by-side', 'parallel', diff_view == :parallel)
90
  end
Headless committed
91

92
  def submodule_link(blob, ref, repository = @repository)
93 94
    project_url, tree_url = submodule_links(blob, ref, repository)
    commit_id = if tree_url.nil?
95
                  Commit.truncate_sha(blob.id)
Headless committed
96
                else
97
                  link_to Commit.truncate_sha(blob.id), tree_url
Headless committed
98 99 100
                end

    [
101
      content_tag(:span, link_to(truncate(blob.name, length: 40), project_url)),
Headless committed
102
      '@',
103
      content_tag(:span, commit_id, class: 'commit-sha')
Headless committed
104 105
    ].join(' ').html_safe
  end
106

107 108
  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)
Douwe Maan committed
109 110
  end

111
  def diff_file_old_blob_raw_url(diff_file, only_path: false)
112 113
    sha = diff_file.old_content_sha
    return unless sha
114

115 116 117 118 119 120 121 122 123
    project_raw_url(@project, tree_join(diff_file.old_content_sha, diff_file.old_path), only_path: only_path)
  end

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

  def diff_file_old_blob_raw_path(diff_file)
    diff_file_old_blob_raw_url(diff_file, only_path: true)
Douwe Maan committed
124 125
  end

126
  def diff_file_html_data(project, diff_file_path, diff_commit_id)
127
    {
128
      blob_diff_path: project_blob_diff_path(project,
129
                                                       tree_join(diff_commit_id, diff_file_path)),
130
      view: diff_view
131 132 133
    }
  end

134 135
  def editable_diff?(diff_file)
    !diff_file.deleted_file? && @merge_request && @merge_request.source_project
136
  end
137

Douwe Maan committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
  def diff_render_error_reason(viewer)
    case viewer.render_error
    when :too_large
      "it is too large"
    when :server_side_but_stored_externally
      case viewer.diff_file.external_storage
      when :lfs
        'it is stored in LFS'
      else
        'it is stored externally'
      end
    end
  end

  def diff_render_error_options(viewer)
    diff_file = viewer.diff_file
    options = []

156
    blob_url = project_blob_path(@project, tree_join(diff_file.content_sha, diff_file.file_path))
Douwe Maan committed
157 158 159 160 161
    options << link_to('view the blob', blob_url)

    options
  end

162 163
  def diff_file_changed_icon(diff_file)
    if diff_file.deleted_file? || diff_file.renamed_file?
164
      "file-deletion"
165
    elsif diff_file.new_file?
166
      "file-addition"
167
    else
168
      "file-modified"
169 170 171 172 173 174 175 176 177 178 179
    end
  end

  def diff_file_changed_icon_color(diff_file)
    if diff_file.deleted_file?
      "cred"
    elsif diff_file.new_file?
      "cgreen"
    end
  end

180 181 182 183 184 185 186 187 188
  private

  def diff_btn(title, name, selected)
    params_copy = params.dup
    params_copy[:view] = name

    # Always use HTML to handle case where JSON diff rendered this button
    params_copy.delete(:format)

Alfredo Sumaran committed
189
    link_to url_for(params_copy), id: "#{name}-diff-btn", class: (selected ? 'btn active' : 'btn'), data: { view_type: name } do
190 191 192
      title
    end
  end
193

194
  def commit_diff_whitespace_link(project, commit, options)
195
    url = project_commit_path(project, commit.id, params_with_whitespace)
196
    toggle_whitespace_link(url, options)
197 198
  end

199
  def diff_merge_request_whitespace_link(project, merge_request, options)
200
    url = diffs_project_merge_request_path(project, merge_request, params_with_whitespace)
201
    toggle_whitespace_link(url, options)
202 203
  end

204
  def diff_compare_whitespace_link(project, from, to, options)
205
    url = project_compare_path(project, from, to, params_with_whitespace)
206 207 208
    toggle_whitespace_link(url, options)
  end

Alfredo Sumaran committed
209
  def hide_whitespace?
210 211 212 213
    params[:w] == '1'
  end

  def params_with_whitespace
Alfredo Sumaran committed
214
    hide_whitespace? ? request.query_parameters.except(:w) : request.query_parameters.merge(w: 1)
215 216
  end

217 218 219 220 221
  def toggle_whitespace_link(url, options)
    options[:class] ||= ''
    options[:class] << ' btn btn-default'

    link_to "#{hide_whitespace? ? 'Show' : 'Hide'} whitespace changes", url, class: options[:class]
222
  end
223 224 225 226 227 228

  def render_overflow_warning?(diff_files)
    diffs = @merge_request_diff.presence || diff_files

    diffs.overflow?
  end
229
end