Class: Gitlab::UrlBuilder

Inherits:
Object
  • Object
show all
Extended by:
ActionView::RecordIdentifier
Includes:
Routing, GitlabRoutingHelper, Singleton
Defined in:
lib/gitlab/url_builder.rb

Constant Summary

Constants included from Routing::PseudonymizationHelper

Routing::PseudonymizationHelper::PSEUDONOMIZED_GROUP, Routing::PseudonymizationHelper::PSEUDONOMIZED_ID, Routing::PseudonymizationHelper::PSEUDONOMIZED_NAMESPACE, Routing::PseudonymizationHelper::PSEUDONOMIZED_PROJECT, Routing::PseudonymizationHelper::PSEUDONOMIZED_USERNAME

Class Method Summary collapse

Methods included from Routing::PackagesHelper

#package_path

Methods included from Routing::PseudonymizationHelper

#masked_page_url, #masked_query_params, #masked_referrer_url, #referrer_params

Methods included from Routing::GraphqlHelper

#graphql_etag_pipeline_path, #graphql_etag_pipeline_sha_path, #graphql_etag_project_on_demand_scan_counts_path

Methods included from Routing::WikiHelper

#group_wiki_page_url, #project_wiki_page_url, #wiki_page_path, #wiki_path

Methods included from Routing::SnippetsHelper

#gitlab_raw_snippet_blob_url, #gitlab_raw_snippet_url, #gitlab_snippet_note_path, #gitlab_snippet_notes_path, #gitlab_snippet_path, #gitlab_snippet_url, #gitlab_toggle_award_emoji_snippet_note_path, #preview_markdown_path, #toggle_award_emoji_personal_snippet_path, #toggle_award_emoji_project_project_snippet_path, #toggle_award_emoji_project_project_snippet_url

Methods included from Routing::PipelineSchedulesHelper

#edit_pipeline_schedule_path, #pipeline_schedule_path, #pipeline_schedules_path, #play_pipeline_schedule_path, #take_ownership_pipeline_schedule_path

Methods included from Routing::ArtifactsHelper

#artifacts_action_path, #expose_fast_artifacts_path, #fast_browse_project_job_artifacts_path, #fast_download_project_job_artifacts_path, #fast_keep_project_job_artifacts_path

Methods included from Routing::MembersHelper

#source_members_url

Methods included from Routing::Groups::MembersHelper

#approve_access_request_group_member_path, #group_member_path, #group_members_url, #leave_group_members_path, #request_access_group_members_path, #resend_invite_group_member_path

Methods included from Routing::Projects::MembersHelper

#approve_access_request_project_member_path, #leave_project_members_path, #project_member_path, #project_members_url, #request_access_project_members_path, #resend_invite_project_member_path

Methods included from Routing::ProjectsHelper

#commit_url, #commits_url, #edit_milestone_path, #environment_delete_path, #environment_path, #issue_path, #issue_url, #merge_request_path, #merge_request_url, #pipeline_job_url, #pipeline_path, #pipeline_url, #project_commits_path, #project_ref_path, #project_tree_path, #release_url, #toggle_subscription_path, #work_item_url

Methods included from API::Helpers::RelatedResourcesHelpers

#expose_path, #expose_url, #issues_available?, #mrs_available?, #project_feature_string_access_level

Methods included from ApplicationSettingsHelper

#all_protocols_enabled?, #allowed_protocols_present?, #anti_spam_service_enabled?, #deletion_protection_data, #deprecated_attributes, #enabled_protocol, #enabled_protocol_button, #expanded_by_default?, #external_authorization_allow_token_help_text, #external_authorization_client_certificate_help_text, #external_authorization_client_key_help_text, #external_authorization_client_pass_help_text, #external_authorization_client_url_help_text, #external_authorization_description, #external_authorization_service_attributes, #external_authorization_timeout_help_text, #external_authorization_url_help_text, #global_search_settings_checkboxes, #http_enabled?, #import_sources_checkboxes, #instance_clusters_enabled?, #integration_expanded?, #key_restriction_options_for_select, #kroki_available_formats, #oauth_providers_checkboxes, #pending_user_count, #registration_features_can_be_prompted?, #repository_storages_options_json, #restricted_level_checkboxes, #runner_token_expiration_interval_attributes, #sidekiq_job_limiter_mode_help_text, #sidekiq_job_limiter_modes_for_select, #signup_enabled?, #signup_form_data, #ssh_enabled?, #storage_weights, #user_oauth_applications?, #valid_runner_registrars, #visible_attributes, #vscode_extension_marketplace_settings_description, #vscode_extension_marketplace_settings_view

Methods included from ProjectsHelper

#able_to_see_forks_count?, #able_to_see_issues?, #able_to_see_merge_requests?, #any_projects?, #archiving_available?, #author_content_tag, #autodeploy_flash_notice, #badge_count, #branch_rules_path, #can_admin_associated_clusters?, #can_admin_project_member?, #can_change_visibility_level?, #can_disable_emails?, #can_push_code?, #can_set_diff_preview_in_email?, #can_view_branch_rules?, #clusters_deprecation_alert_message, #dashboard_projects_app_data, #delete_confirm_phrase, #delete_delayed_project_message, #delete_immediately_project_scheduled_for_deletion_message, #directory?, #error_tracking_setting_project_json, #explore_projects_tab?, #external_classification_label_help_message, #fork_button_data_attributes, #hidden_issue_icon, #home_panel_data_attributes, #http_clone_url_to_repo, #import_from_bitbucket_message, #inactive_project_deletion_date, #issue_css_classes, #issue_manual_ordering_class, #last_pipeline_from_status_cache, #last_push_event, #link_to_autodeploy_doc, #link_to_data_loss_doc, #link_to_member, #link_to_member_avatar, #link_to_namespace_change_doc, #link_to_project, #load_catalog_resources, #load_pipeline_status, #localized_project_human_access, #membership_locked?, #no_password_message, #notification_data_attributes, #project_can_be_shared?, #project_classes, #project_coverage_chart_data_attributes, #project_delete_delayed_button_data, #project_delete_immediately_button_data, #project_incident_management_setting, #project_license_name, #project_pages_domain_choices, #project_permissions_panel_data, #projects_filtered_search_and_sort_app_data, #push_project_breadcrumbs, #push_to_create_project_command, #remote_mirror_setting_enabled?, #remove_fork_project_confirm_json, #remove_fork_project_description_message, #remove_fork_project_warning_message, #remove_project_message, #show_archived_project_banner?, #show_auto_devops_implicitly_enabled_banner?, #show_clusters_alert?, #show_count?, #show_dashboard_projects_welcome_page?, #show_inactive_project_deletion_banner?, #show_invalid_gpg_key_message?, #show_lfs_misconfiguration_banner?, #show_mobile_devops_project_promo?, #show_no_password_message?, #show_no_ssh_key_message?, #show_projects?, #show_terraform_banner?, #show_xcode_link?, #ssh_clone_url_to_repo, #star_count_data_attributes, #transfer_project_confirm_button, #transfer_project_message, #visibility_level_content, #visible_fork_source, #vue_fork_divergence_data, #xcode_uri_to_repo

Methods included from Allowable

#can?, #can_all?, #can_any?

Methods included from CompareHelper

#create_mr_button?, #create_mr_path, #project_compare_selector_data, #target_projects

Methods included from Routing

includes_helpers, redirect_legacy_paths, url_helpers

Class Method Details

.abuse_report_note_url(note, **options) ⇒ Object 



117
118
119
 
# File 'lib/gitlab/url_builder.rb', line 117

def abuse_report_note_url(note, **options)
  instance.admin_abuse_report_url(note.abuse_report, anchor: dom_id(note), **options)
end

.board_url(board, **options) ⇒ Object

rubocop:enable Metrics/AbcSize rubocop:enable Metrics/CyclomaticComplexity



79
80
81
82
83
84
85
 
# File 'lib/gitlab/url_builder.rb', line 79

def board_url(board, **options)
  if board.project_board?
    instance.project_board_url(board.resource_parent, board, **options)
  else
    instance.group_board_url(board.resource_parent, board, **options)
  end
end

.build(object, **options) ⇒ Object

Using a case statement here is preferable for readability and maintainability. See discussion in gitlab.com/gitlab-org/gitlab/-/issues/217397

rubocop:disable Metrics/AbcSize rubocop:disable Metrics/CyclomaticComplexity



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/gitlab/url_builder.rb', line 19

def build(object, **options)
  # Objects are sometimes wrapped in a BatchLoader instance
  case object.itself
  when Board
    board_url(object, **options)
  when ::Ci::Build
    instance.project_job_url(object.project, object, **options)
  when ::Ci::Pipeline
    instance.project_pipeline_url(object.project, object, **options)
  when Commit
    commit_url(object, **options)
  when Compare
    compare_url(object, **options)
  when Group
    instance.group_canonical_url(object, **options)
  when WorkItem
    instance.work_item_url(object, **options)
  when Issue
    instance.issue_url(object, **options)
  when MergeRequest
    instance.merge_request_url(object, **options)
  when Milestone
    instance.milestone_url(object, **options)
  when Note
    note_url(object, **options)
  when AntiAbuse::Reports::Note
    abuse_report_note_url(object, **options)
  when Release
    instance.release_url(object, **options)
  when ::Organizations::Organization
    instance.organization_url(object, **options)
  when Project
    instance.project_url(object, **options)
  when Snippet
    snippet_url(object, **options)
  when User
    instance.user_url(object, **options)
  when Namespaces::UserNamespace
    instance.user_url(object.owner, **options)
  when Namespaces::ProjectNamespace
    instance.project_url(object.project, **options)
  when Wiki
    wiki_url(object, **options)
  when WikiPage
    wiki_page_url(object.wiki, object, **options)
  when WikiPage::Meta
    wiki_page_url(object.container.wiki, object.canonical_slug, **options)
  when ::DesignManagement::Design
    design_url(object, **options)
  when ::Packages::Package
    package_url(object, **options)
  when ::Key
    instance.(object)
  else
    raise NotImplementedError, "No URL builder defined for #{object.inspect}"
  end
end

.commit_url(commit, **options) ⇒ Object 



87
88
89
90
91
 
# File 'lib/gitlab/url_builder.rb', line 87

def commit_url(commit, **options)
  return '' unless commit.project

  instance.commit_url(commit, **options)
end

.compare_url(compare, **options) ⇒ Object 



93
94
95
96
97
 
# File 'lib/gitlab/url_builder.rb', line 93

def compare_url(compare, **options)
  return '' unless compare.project

  instance.project_compare_url(compare.project, **options.merge(compare.to_param))
end

.design_url(design, **options) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/gitlab/url_builder.rb', line 152

def design_url(design, **options)
  size, ref = options.values_at(:size, :ref)
  options.except!(:size, :ref)

  if size
    instance.project_design_management_designs_resized_image_url(design.project, design, ref, size, **options)
  else
    instance.project_design_management_designs_raw_image_url(design.project, design, ref, **options)
  end
end

.note_url(note, **options) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/gitlab/url_builder.rb', line 99

def note_url(note, **options)
  if note.for_commit?
    return '' unless note.project

    instance.project_commit_url(note.project, note.commit_id, anchor: dom_id(note), **options)
  elsif note.for_issue?
    instance.issue_url(note.noteable, anchor: dom_id(note), **options)
  elsif note.for_merge_request?
    instance.merge_request_url(note.noteable, anchor: dom_id(note), **options)
  elsif note.for_snippet?
    instance.gitlab_snippet_url(note.noteable, anchor: dom_id(note), **options)
  elsif note.for_abuse_report?
    instance.admin_abuse_report_url(note.noteable, anchor: dom_id(note), **options)
  elsif note.for_wiki_page?
    instance.project_wiki_page_url(note.noteable, anchor: dom_id(note), **options)
  end
end

.package_url(package, **options) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/gitlab/url_builder.rb', line 163

def package_url(package, **options)
  project = package.project

  if package.terraform_module?
    return instance.project_infrastructure_registry_url(project, package,
**options)
  end

  instance.project_package_url(project, package, **options)
end

.snippet_url(snippet, **options) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/gitlab/url_builder.rb', line 121

def snippet_url(snippet, **options)
  if options[:file].present?
    file, ref = options.values_at(:file, :ref)

    instance.gitlab_raw_snippet_blob_url(snippet, file, ref)
  elsif options.delete(:raw).present?
    instance.gitlab_raw_snippet_url(snippet, **options)
  else
    instance.gitlab_snippet_url(snippet, **options)
  end
end

.wiki_page_url(wiki, page, **options) ⇒ Object 



145
146
147
148
149
150
 
# File 'lib/gitlab/url_builder.rb', line 145

def wiki_page_url(wiki, page, **options)
  options[:action] ||= :show
  options[:id] = page

  wiki_url(wiki, **options)
end

.wiki_url(wiki, **options) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/gitlab/url_builder.rb', line 133

def wiki_url(wiki, **options)
  return wiki_page_url(wiki, Wiki::HOMEPAGE, **options) unless options[:action]

  if wiki.container.is_a?(Project)
    options[:controller] = 'projects/wikis'
    options[:namespace_id] = wiki.container.namespace
    options[:project_id] = wiki.container
  end

  instance.url_for(**options)
end