Class: Gitlab::UrlBuilder
- Inherits:
-
Object
- Object
- Gitlab::UrlBuilder
- Extended by:
- ActionView::RecordIdentifier
- Includes:
- Routing, GitlabRoutingHelper, Singleton
- Defined in:
- lib/gitlab/url_builder.rb
Class Method Summary collapse
-
.board_url(board, **options) ⇒ Object
rubocop:enable Metrics/CyclomaticComplexity.
-
.build(object, **options) ⇒ Object
Using a case statement here is preferable for readability and maintainability.
- .commit_url(commit, **options) ⇒ Object
- .compare_url(compare, **options) ⇒ Object
- .design_url(design, **options) ⇒ Object
- .note_url(note, **options) ⇒ Object
- .snippet_url(snippet, **options) ⇒ Object
- .wiki_page_url(wiki, page, **options) ⇒ Object
- .wiki_url(wiki, **options) ⇒ Object
Methods included from Routing::PseudonymizationHelper
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
Methods included from Routing::SnippetsHelper
#gitlab_dashboard_snippets_path, #gitlab_raw_snippet_blob_path, #gitlab_raw_snippet_blob_url, #gitlab_raw_snippet_path, #gitlab_raw_snippet_url, #gitlab_snippet_note_path, #gitlab_snippet_note_url, #gitlab_snippet_notes_path, #gitlab_snippet_notes_url, #gitlab_snippet_path, #gitlab_snippet_url, #gitlab_toggle_award_emoji_snippet_note_path, #gitlab_toggle_award_emoji_snippet_note_url, #gitlab_toggle_award_emoji_snippet_path, #gitlab_toggle_award_emoji_snippet_url, #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
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
Methods included from API::Helpers::RelatedResourcesHelpers
#expose_path, #expose_url, #issues_available?, #mrs_available?
Methods included from ApplicationSettingsHelper
#all_protocols_enabled?, #allowed_protocols_present?, #deprecated_attributes, #enabled_protocol, #enabled_protocol_button, #expanded_by_default?, #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, #http_enabled?, #import_sources_checkboxes, #instance_clusters_enabled?, #integration_expanded?, #key_restriction_options_for_select, #kroki_available_formats, #oauth_providers_checkboxes, #omnibus_protected_paths_throttle?, #pending_user_count, #registration_features_can_be_prompted?, #repository_storages_options_json, #restricted_level_checkboxes, #self_monitoring_project_data, #sidekiq_job_limiter_mode_help_text, #sidekiq_job_limiter_modes_for_select, #signup_enabled?, #ssh_enabled?, #storage_weights, #user_oauth_applications?, #valid_runner_registrars, #visible_attributes
Methods included from ProjectsHelper
#able_to_see_issues?, #able_to_see_merge_requests?, #any_projects?, #author_content_tag, #autodeploy_flash_notice, #can_admin_project_member?, #can_change_visibility_level?, #can_disable_emails?, #delete_confirm_phrase, #directory?, #error_tracking_setting_project_json, #explore_projects_tab?, #external_classification_label_help_message, #fork_button_disabled_tooltip, #grafana_integration_enabled?, #grafana_integration_masked_token, #grafana_integration_url, #import_from_bitbucket_message, #import_from_gitlab_message, #last_push_event, #link_to_autodeploy_doc, #link_to_member, #link_to_member_avatar, #link_to_project, #load_pipeline_status, #membership_locked?, #metrics_dashboard_timezone, #metrics_external_dashboard_url, #no_password_message, #project_can_be_shared?, #project_classes, #project_incident_management_setting, #project_license_name, #project_list_cache_key, #project_permissions_panel_data, #project_search_tabs?, #project_title, #push_to_create_project_command, #remove_fork_project_confirm_json, #remove_fork_project_description_message, #remove_fork_project_warning_message, #remove_project_message, #share_project_description, #show_auto_devops_implicitly_enabled_banner?, #show_issue_count?, #show_merge_request_count?, #show_no_password_message?, #show_no_ssh_key_message?, #show_projects?, #show_terraform_banner?, #show_xcode_link?, #transfer_project_message, #visible_fork_source, #xcode_uri_to_repo
Methods included from Routing
add_helpers, includes_helpers, redirect_legacy_paths, url_helpers
Class Method Details
.board_url(board, **options) ⇒ Object
rubocop:enable Metrics/CyclomaticComplexity
59 60 61 62 63 64 65 |
# File 'lib/gitlab/url_builder.rb', line 59 def board_url(board, **) if board.project_board? instance.project_board_url(board.resource_parent, board, **) else instance.group_board_url(board.resource_parent, board, **) 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/CyclomaticComplexity
18 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 |
# File 'lib/gitlab/url_builder.rb', line 18 def build(object, **) # Objects are sometimes wrapped in a BatchLoader instance case object.itself when Board board_url(object, **) when ::Ci::Build instance.project_job_url(object.project, object, **) when Commit commit_url(object, **) when Compare compare_url(object, **) when Group instance.group_canonical_url(object, **) when Issue instance.issue_url(object, **) when MergeRequest instance.merge_request_url(object, **) when Milestone instance.milestone_url(object, **) when Note note_url(object, **) when Release instance.release_url(object, **) when Project instance.project_url(object, **) when Snippet snippet_url(object, **) when User instance.user_url(object, **) when Wiki wiki_url(object, **) when WikiPage wiki_page_url(object.wiki, object, **) when ::DesignManagement::Design design_url(object, **) else raise NotImplementedError, "No URL builder defined for #{object.inspect}" end end |
.commit_url(commit, **options) ⇒ Object
67 68 69 70 71 |
# File 'lib/gitlab/url_builder.rb', line 67 def commit_url(commit, **) return '' unless commit.project instance.commit_url(commit, **) end |
.compare_url(compare, **options) ⇒ Object
73 74 75 76 77 |
# File 'lib/gitlab/url_builder.rb', line 73 def compare_url(compare, **) return '' unless compare.project instance.project_compare_url(compare.project, **.merge(compare.to_param)) end |
.design_url(design, **options) ⇒ Object
124 125 126 127 128 129 130 131 132 133 |
# File 'lib/gitlab/url_builder.rb', line 124 def design_url(design, **) size, ref = .values_at(:size, :ref) .except!(:size, :ref) if size instance.project_design_management_designs_resized_image_url(design.project, design, ref, size, **) else instance.project_design_management_designs_raw_image_url(design.project, design, ref, **) end end |
.note_url(note, **options) ⇒ Object
79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/gitlab/url_builder.rb', line 79 def note_url(note, **) if note.for_commit? return '' unless note.project instance.project_commit_url(note.project, note.commit_id, anchor: dom_id(note), **) elsif note.for_issue? instance.issue_url(note.noteable, anchor: dom_id(note), **) elsif note.for_merge_request? instance.merge_request_url(note.noteable, anchor: dom_id(note), **) elsif note.for_snippet? instance.gitlab_snippet_url(note.noteable, anchor: dom_id(note), **) end end |
.snippet_url(snippet, **options) ⇒ Object
93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/gitlab/url_builder.rb', line 93 def snippet_url(snippet, **) if [:file].present? file, ref = .values_at(:file, :ref) instance.gitlab_raw_snippet_blob_url(snippet, file, ref) elsif .delete(:raw).present? instance.gitlab_raw_snippet_url(snippet, **) else instance.gitlab_snippet_url(snippet, **) end end |
.wiki_page_url(wiki, page, **options) ⇒ Object
117 118 119 120 121 122 |
# File 'lib/gitlab/url_builder.rb', line 117 def wiki_page_url(wiki, page, **) [:action] ||= :show [:id] = page wiki_url(wiki, **) end |
.wiki_url(wiki, **options) ⇒ Object
105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/gitlab/url_builder.rb', line 105 def wiki_url(wiki, **) return wiki_page_url(wiki, Wiki::HOMEPAGE, **) unless [:action] if wiki.container.is_a?(Project) [:controller] = 'projects/wikis' [:namespace_id] = wiki.container.namespace [:project_id] = wiki.container end instance.url_for(**) end |