Class: Sidebars::Menu

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Gitlab::Utils::Override

extended, extensions, included, method_added, override, prepended, queue_verification, verify!

Methods included from Concerns::HasPartial

#menu_partial, #menu_partial_options, #menu_with_partial?

Methods included from Concerns::HasActiveRoutes

#active_routes

Methods included from Concerns::ContainerWithHtmlOptions

#collapsed_container_html_options, #extra_collapsed_container_html_options, #extra_container_html_options, #extra_nav_link_html_options, #nav_link_html_options, #title, #title_html_options

Methods included from Concerns::LinkWithHtmlOptions

#link_html_options

Methods included from Concerns::PositionableList

#add_element, #insert_element_after, #insert_element_before, #remove_element, #replace_element

Methods included from Concerns::HasIcon

#icon_or_image?, #image_html_options, #image_path, #sprite_icon, #sprite_icon_html_options

Methods included from Concerns::HasPill

#format_cached_count, #has_pill?, #pill_count, #pill_html_options

Methods included from Gitlab::Allowable

#can?

Methods included from Routing::PseudonymizationHelper

#masked_page_url

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

#wiki_page_path, #wiki_path

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

#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

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 Gitlab::Routing

add_helpers, includes_helpers, redirect_legacy_paths, url_helpers

Constructor Details

#initialize(context) ⇒ Menu

Returns a new instance of Menu.


21
22
23
24
25
26
# File 'lib/sidebars/menu.rb', line 21

def initialize(context)
  @context = context
  @items = []

  configure_menu_items
end

Instance Attribute Details

#contextObject (readonly)

Returns the value of attribute context.


17
18
19
# File 'lib/sidebars/menu.rb', line 17

def context
  @context
end

Instance Method Details

#add_item(item) ⇒ Object


75
76
77
# File 'lib/sidebars/menu.rb', line 75

def add_item(item)
  add_element(@items, item)
end

#all_active_routesObject

This method normalizes the information retrieved from the submenus and this menu Value from menus is something like: [{ path: 'foo', path: 'bar', controller: :foo }] This method filters the information and returns: { path: ['foo', 'bar'], controller: :foo }


45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/sidebars/menu.rb', line 45

def all_active_routes
  @all_active_routes ||= begin
    ([active_routes] + renderable_items.map(&:active_routes)).flatten.each_with_object({}) do |pairs, hash|
      pairs.each do |k, v|
        hash[k] ||= []
        hash[k] += Array(v)
        hash[k].uniq!
      end

      hash
    end
  end
end

#configure_menu_itemsObject


28
29
30
# File 'lib/sidebars/menu.rb', line 28

def configure_menu_items
  true
end

#container_html_optionsObject


88
89
90
91
92
93
94
95
# File 'lib/sidebars/menu.rb', line 88

def container_html_options
  super.tap do |html_options|
    # Flagging menus that can be rendered and with renderable menu items
    if render? && has_renderable_items?
      html_options[:class] = [*html_options[:class], 'has-sub-items'].join(' ')
    end
  end
end

#has_items?Boolean

Returns whether the menu has any menu item, no matter whether it is renderable or not

Returns:

  • (Boolean)

61
62
63
# File 'lib/sidebars/menu.rb', line 61

def has_items?
  @items.any?
end

#has_renderable_items?Boolean

Returns whether the menu has any renderable menu item

Returns:

  • (Boolean)

71
72
73
# File 'lib/sidebars/menu.rb', line 71

def has_renderable_items?
  renderable_items.any?
end

#insert_item_after(after_item, new_item) ⇒ Object


83
84
85
# File 'lib/sidebars/menu.rb', line 83

def insert_item_after(after_item, new_item)
  insert_element_after(@items, after_item, new_item)
end

#insert_item_before(before_item, new_item) ⇒ Object


79
80
81
# File 'lib/sidebars/menu.rb', line 79

def insert_item_before(before_item, new_item)
  insert_element_before(@items, before_item, new_item)
end

38
39
40
# File 'lib/sidebars/menu.rb', line 38

def link
  renderable_items.first&.link
end

#render?Boolean

Returns:

  • (Boolean)

33
34
35
# File 'lib/sidebars/menu.rb', line 33

def render?
  has_renderable_items? || menu_with_partial?
end

#renderable_itemsObject

Returns all renderable menu items


66
67
68
# File 'lib/sidebars/menu.rb', line 66

def renderable_items
  @renderable_items ||= @items.select(&:render?)
end