debian-mirror-gitlab/app/helpers/diff_helper.rb

317 lines
9.6 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
module DiffHelper
2016-04-02 18:10:28 +05:30
def mark_inline_diffs(old_line, new_line)
old_diffs, new_diffs = Gitlab::Diff::InlineDiff.new(old_line, new_line).inline_diffs
2021-04-17 20:07:23 +05:30
marked_old_line = Gitlab::Diff::InlineDiffMarker.new(old_line).mark(old_diffs)
marked_new_line = Gitlab::Diff::InlineDiffMarker.new(new_line).mark(new_diffs)
2016-04-02 18:10:28 +05:30
[marked_old_line, marked_new_line]
end
2017-09-10 17:25:29 +05:30
def diffs_expanded?
params[:expanded].present?
2016-08-24 12:49:21 +05:30
end
2015-11-26 14:37:03 +05:30
def diff_view
2016-09-13 17:45:13 +05:30
@diff_view ||= begin
diff_views = %w(inline parallel)
2017-09-10 17:25:29 +05:30
diff_view = params[:view] || cookies[:diff_view]
2016-09-13 17:45:13 +05:30
diff_view = diff_views.first unless diff_views.include?(diff_view)
diff_view.to_sym
2015-04-26 12:48:37 +05:30
end
end
2021-06-08 01:23:25 +05:30
def show_only_context_commits?
!!params[:only_context_commits] || @merge_request&.commits&.empty?
end
2016-06-02 11:05:42 +05:30
def diff_options
2017-09-10 17:25:29 +05:30
options = { ignore_whitespace_change: hide_whitespace?, expanded: diffs_expanded? }
2016-08-24 12:49:21 +05:30
if action_name == 'diff_for_path'
2017-09-10 17:25:29 +05:30
options[:expanded] = true
2016-08-24 12:49:21 +05:30
options[:paths] = params.values_at(:old_path, :new_path)
2015-09-11 14:41:01 +05:30
end
2014-09-02 18:07:02 +05:30
2016-09-13 17:45:13 +05:30
options
2014-09-02 18:07:02 +05:30
end
2015-04-26 12:48:37 +05:30
2016-09-13 17:45:13 +05:30
def diff_match_line(old_pos, new_pos, text: '', view: :inline, bottom: false)
2018-03-17 18:26:18 +05:30
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
2015-04-26 12:48:37 +05:30
2018-12-05 23:21:45 +05:30
html = []
2016-09-13 17:45:13 +05:30
if old_pos
2018-03-17 18:26:18 +05:30
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
2016-09-13 17:45:13 +05:30
end
2015-04-26 12:48:37 +05:30
2016-09-13 17:45:13 +05:30
if new_pos
2018-03-17 18:26:18 +05:30
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)])
2016-09-13 17:45:13 +05:30
end
2018-12-05 23:21:45 +05:30
html.join.html_safe
2015-09-11 14:41:01 +05:30
end
2017-08-17 22:00:37 +05:30
def diff_line_content(line)
2015-04-26 12:48:37 +05:30
if line.blank?
2017-08-17 22:00:37 +05:30
"&nbsp;".html_safe
2015-04-26 12:48:37 +05:30
else
2019-12-21 20:55:43 +05:30
# `sub` and substring-ing would destroy HTML-safeness of `line`
if line.start_with?('+', '-', ' ')
2021-01-29 00:20:46 +05:30
line[1, line.length]
2019-12-21 20:55:43 +05:30
else
line
end
2015-04-26 12:48:37 +05:30
end
end
2021-01-29 00:20:46 +05:30
def diff_link_number(line_type, match, text)
line_type == match ? " " : text
end
2016-09-13 17:45:13 +05:30
def parallel_diff_discussions(left, right, diff_file)
2017-08-17 22:00:37 +05:30
return unless @grouped_diff_discussions
2017-09-10 17:25:29 +05:30
2017-08-17 22:00:37 +05:30
discussions_left = discussions_right = nil
2015-04-26 12:48:37 +05:30
2017-09-10 17:25:29 +05:30
if left && left.discussable? && (left.unchanged? || left.removed?)
2016-09-13 17:45:13 +05:30
line_code = diff_file.line_code(left)
2017-08-17 22:00:37 +05:30
discussions_left = @grouped_diff_discussions[line_code]
2015-04-26 12:48:37 +05:30
end
2017-09-10 17:25:29 +05:30
if right && right.discussable? && right.added?
2016-09-13 17:45:13 +05:30
line_code = diff_file.line_code(right)
2017-08-17 22:00:37 +05:30
discussions_right = @grouped_diff_discussions[line_code]
2015-04-26 12:48:37 +05:30
end
2017-08-17 22:00:37 +05:30
[discussions_left, discussions_right]
2015-04-26 12:48:37 +05:30
end
def inline_diff_btn
2016-09-13 17:45:13 +05:30
diff_btn('Inline', 'inline', diff_view == :inline)
2015-04-26 12:48:37 +05:30
end
def parallel_diff_btn
2016-09-13 17:45:13 +05:30
diff_btn('Side-by-side', 'parallel', diff_view == :parallel)
2015-04-26 12:48:37 +05:30
end
2015-09-11 14:41:01 +05:30
def submodule_link(blob, ref, repository = @repository)
2020-11-24 15:15:51 +05:30
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
2015-04-26 12:48:37 +05:30
[
2020-11-24 15:15:51 +05:30
content_tag(:span, folder_name),
2015-04-26 12:48:37 +05:30
'@',
2017-09-10 17:25:29 +05:30
content_tag(:span, commit_id, class: 'commit-sha')
2015-04-26 12:48:37 +05:30
].join(' ').html_safe
end
2015-10-24 18:46:33 +05:30
2020-11-24 15:15:51 +05:30
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'),
' ',
content_tag(:span, Commit.truncate_sha(diff_file.old_blob.id), class: 'commit-sha'),
'...',
content_tag(:span, Commit.truncate_sha(diff_file.blob.id), class: 'commit-sha')
].join('').html_safe
tooltip = _('Compare submodule commit revisions')
2021-03-11 19:13:27 +05:30
link = content_tag(:span, link_to(link_text, compare_url, class: 'btn gl-button has-tooltip', title: tooltip), class: 'submodule-compare')
2020-11-24 15:15:51 +05:30
end
link
end
2018-03-17 18:26:18 +05:30
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)
2017-09-10 17:25:29 +05:30
end
2016-08-24 12:49:21 +05:30
2018-03-17 18:26:18 +05:30
def diff_file_old_blob_raw_url(diff_file, only_path: false)
2017-09-10 17:25:29 +05:30
sha = diff_file.old_content_sha
return unless sha
2018-03-17 18:26:18 +05:30
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)
2015-10-24 18:46:33 +05:30
end
2016-09-13 17:45:13 +05:30
def diff_file_html_data(project, diff_file_path, diff_commit_id)
2015-10-24 18:46:33 +05:30
{
2020-07-28 23:09:34 +05:30
blob_diff_path: project_blob_diff_path(project, tree_join(diff_commit_id, diff_file_path)),
2016-09-13 17:45:13 +05:30
view: diff_view
2015-10-24 18:46:33 +05:30
}
end
2017-09-10 17:25:29 +05:30
def editable_diff?(diff_file)
!diff_file.deleted_file? && @merge_request && @merge_request.source_project
end
def diff_file_changed_icon(diff_file)
2018-03-27 19:54:05 +05:30
if diff_file.deleted_file?
2018-03-17 18:26:18 +05:30
"file-deletion"
2017-09-10 17:25:29 +05:30
elsif diff_file.new_file?
2018-03-17 18:26:18 +05:30
"file-addition"
2017-09-10 17:25:29 +05:30
else
2018-03-17 18:26:18 +05:30
"file-modified"
2017-09-10 17:25:29 +05:30
end
end
def diff_file_changed_icon_color(diff_file)
if diff_file.deleted_file?
2021-11-11 11:23:49 +05:30
"danger"
2017-09-10 17:25:29 +05:30
elsif diff_file.new_file?
2021-11-11 11:23:49 +05:30
"success"
2017-09-10 17:25:29 +05:30
end
2015-10-24 18:46:33 +05:30
end
2015-12-23 02:04:40 +05:30
2020-01-01 13:55:28 +05:30
def render_overflow_warning?(diffs_collection)
2021-09-30 23:02:18 +05:30
diffs_collection.overflow?.tap do |overflown|
log_overflow_limits(diff_files: diffs_collection.raw_diff_files, collection_overflow: overflown)
2020-01-01 13:55:28 +05:30
end
end
2020-07-28 23:09:34 +05:30
def apply_diff_view_cookie!
set_secure_cookie(:diff_view, params.delete(:view), type: CookiesHelper::COOKIE_TYPE_PERMANENT) if params[:view].present?
end
2021-03-11 19:13:27 +05:30
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
# As the fork suggestion button is identical every time, we cache it for a full page load
def render_fork_suggestion
return unless current_user
strong_memoize(:fork_suggestion) do
render partial: "projects/fork_suggestion"
end
end
2015-12-23 02:04:40 +05:30
private
def diff_btn(title, name, selected)
2018-06-27 16:04:02 +05:30
params_copy = safe_params.dup
2015-12-23 02:04:40 +05:30
params_copy[:view] = name
# Always use HTML to handle case where JSON diff rendered this button
params_copy.delete(:format)
2021-04-17 20:07:23 +05:30
link_to url_for(params_copy), id: "#{name}-diff-btn", class: (selected ? 'btn gl-button btn-default selected' : 'btn gl-button btn-default'), data: { view_type: name } do
2015-12-23 02:04:40 +05:30
title
end
end
2016-06-02 11:05:42 +05:30
def commit_diff_whitespace_link(project, commit, options)
2017-09-10 17:25:29 +05:30
url = project_commit_path(project, commit.id, params_with_whitespace)
2016-06-02 11:05:42 +05:30
toggle_whitespace_link(url, options)
end
def diff_merge_request_whitespace_link(project, merge_request, options)
2017-09-10 17:25:29 +05:30
url = diffs_project_merge_request_path(project, merge_request, params_with_whitespace)
2016-06-02 11:05:42 +05:30
toggle_whitespace_link(url, options)
end
2016-06-22 15:30:34 +05:30
def diff_compare_whitespace_link(project, from, to, options)
2017-09-10 17:25:29 +05:30
url = project_compare_path(project, from, to, params_with_whitespace)
2016-06-22 15:30:34 +05:30
toggle_whitespace_link(url, options)
end
2021-11-11 11:23:49 +05:30
def diff_files_data(diff_files)
diffs_map = diff_files.map do |f|
{
href: "##{hexdigest(f.file_path)}",
title: f.new_path,
name: f.file_path,
path: diff_file_path_text(f),
icon: diff_file_changed_icon(f),
iconColor: "#{diff_file_changed_icon_color(f)}",
added: f.added_lines,
removed: f.removed_lines
}
end
diffs_map.to_json
end
2016-06-02 11:05:42 +05:30
def hide_whitespace?
params[:w] == '1'
end
def params_with_whitespace
hide_whitespace? ? request.query_parameters.except(:w) : request.query_parameters.merge(w: 1)
end
def toggle_whitespace_link(url, options)
2021-03-11 19:13:27 +05:30
options[:class] = [*options[:class], 'btn gl-button btn-default'].join(' ')
2016-06-02 11:05:42 +05:30
link_to "#{hide_whitespace? ? 'Show' : 'Hide'} whitespace changes", url, class: options[:class]
end
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
def diff_file_path_text(diff_file, max: 60)
path = diff_file.new_path
return path unless path.size > max && max > 3
2022-01-26 12:08:38 +05:30
"...#{path[-(max - 3)..]}"
2018-03-17 18:26:18 +05:30
end
2021-01-29 00:20:46 +05:30
def code_navigation_path(diffs)
2021-03-11 19:13:27 +05:30
Gitlab::CodeNavigationPath.new(merge_request.project, merge_request.diff_head_sha)
2021-01-29 00:20:46 +05:30
end
2021-10-27 15:23:28 +05:30
def conflicts(allow_tree_conflicts: false)
2021-01-29 00:20:46 +05:30
return unless options[:merge_ref_head_diff]
2021-10-27 15:23:28 +05:30
conflicts_service = MergeRequests::Conflicts::ListService.new(merge_request, allow_tree_conflicts: allow_tree_conflicts) # rubocop:disable CodeReuse/ServiceClass
2021-01-29 00:20:46 +05:30
2021-10-27 15:23:28 +05:30
return unless allow_tree_conflicts || conflicts_service.can_be_resolved_in_ui?
2021-01-29 00:20:46 +05:30
2021-10-27 15:23:28 +05:30
conflicts_service.conflicts.files.index_by(&:path)
2021-01-29 00:20:46 +05:30
end
2021-04-29 21:17:54 +05:30
2021-09-30 23:02:18 +05:30
def log_overflow_limits(diff_files:, collection_overflow:)
2021-04-29 21:17:54 +05:30
if diff_files.any?(&:too_large?)
Gitlab::Metrics.add_event(:diffs_overflow_single_file_limits)
end
2021-09-30 23:02:18 +05:30
Gitlab::Metrics.add_event(:diffs_overflow_collection_limits) if collection_overflow
2021-04-29 21:17:54 +05:30
Gitlab::Metrics.add_event(:diffs_overflow_max_bytes_limits) if diff_files.overflow_max_bytes?
Gitlab::Metrics.add_event(:diffs_overflow_max_files_limits) if diff_files.overflow_max_files?
Gitlab::Metrics.add_event(:diffs_overflow_max_lines_limits) if diff_files.overflow_max_lines?
Gitlab::Metrics.add_event(:diffs_overflow_collapsed_bytes_limits) if diff_files.collapsed_safe_bytes?
Gitlab::Metrics.add_event(:diffs_overflow_collapsed_files_limits) if diff_files.collapsed_safe_files?
Gitlab::Metrics.add_event(:diffs_overflow_collapsed_lines_limits) if diff_files.collapsed_safe_lines?
end
2014-09-02 18:07:02 +05:30
end