Module: IssuablesHelper

Includes:
GitlabRoutingHelper, IssuablesDescriptionTemplatesHelper, Sidebars::Concerns::HasPill
Included in:
Notify, Sidebars::YourWork::Menus::MergeRequestsMenu, Types::Namespaces::MarkdownPaths, Types::Namespaces::Metadata, Types::WorkItemType
Defined in:
app/helpers/issuables_helper.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

Instance Method Summary collapse

Methods included from Sidebars::Concerns::HasPill

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

Methods included from IssuablesDescriptionTemplatesHelper

#available_service_desk_templates_for, #default_template_name, #issuable_templates, #selected_template_name, #template_dropdown_tag, #template_names, #template_names_path

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, #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?, #custom_admin_roles_available?, #default_search_scope_options_for_select, #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_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, #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_archive_settings_app_data, #project_can_be_shared?, #project_classes, #project_coverage_chart_data_attributes, #project_incident_management_setting, #project_license_name, #project_pages_domain_choices, #project_permissions_panel_data, #project_unarchive_settings_app_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_badge?, #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_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 Gitlab::Allowable

#can?, #can_all?, #can_any?

Methods included from CompareHelper

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

Instance Method Details

#assignees_label(issuable, include_value: true) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
 
# File 'app/helpers/issuables_helper.rb', line 25

def assignees_label(issuable, include_value: true)
  assignees = issuable.assignees

  if include_value
    sanitized_list = sanitize_name(issuable.assignee_list)
    ns_('NotificationEmail|Assignee: %{users}', 'NotificationEmail|Assignees: %{users}', assignees.count) % { users: sanitized_list }
  else
    ns_('NotificationEmail|Assignee', 'NotificationEmail|Assignees', assignees.count)
  end
end

#close_issuable_path(issuable) ⇒ Object 



130
131
132
 
# File 'app/helpers/issuables_helper.rb', line 130

def close_issuable_path(issuable)
  issuable_path(issuable, close_reopen_params(issuable, :close))
end

#has_filter_bar_param? ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'app/helpers/issuables_helper.rb', line 146

def has_filter_bar_param?
  finder.class.scalar_params.any? { |p| params[p].present? }
end

#issuable_author_is_current_user(issuable) ⇒ Object 



142
143
144
 
# File 'app/helpers/issuables_helper.rb', line 142

def issuable_author_is_current_user(issuable)
  issuable.author == current_user
end

#issuable_initial_data(issuable) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'app/helpers/issuables_helper.rb', line 101

def issuable_initial_data(issuable)
  data = {
    endpoint: issuable_path(issuable),
    updateEndpoint: "#{issuable_path(issuable)}.json",
    canUpdate: can?(current_user, :"update_#{issuable.to_ability_name}", issuable),
    canDestroy: can?(current_user, :"destroy_#{issuable.to_ability_name}", issuable),
    issuableRef: issuable.to_reference,
    imported: issuable.imported?,
    markdownPreviewPath: preview_markdown_path(parent, target_type: issuable.model_name, target_id: issuable.iid),
    markdownDocsPath: help_page_path('user/markdown.md'),
    lockVersion: issuable.lock_version,
    issuableTemplateNamesPath: template_names_path(parent, issuable),
    initialTitleHtml: markdown_field(issuable, :title),
    initialTitleText: issuable.title,
    initialDescriptionHtml: markdown_field(issuable, :description),
    initialDescriptionText: issuable.description,
    initialTaskCompletionStatus: issuable.task_completion_status
  }
  data.merge!(issue_only_initial_data(issuable))
  data.merge!(path_data(parent))
  data.merge!(updated_at_by(issuable))

  data
end

#issuable_label_selector_data(project, issuable) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'app/helpers/issuables_helper.rb', line 150

def issuable_label_selector_data(project, issuable)
  initial_labels = issuable.labels.map do |label|
    {
      __typename: "Label",
      id: label.id,
      title: label.title,
      description: label.description,
      color: label.color,
      text_color: label.text_color,
      lock_on_merge: label.lock_on_merge
    }
  end

  filter_base_path =
    if issuable.issuable_type == "merge_request"
      project_merge_requests_path(project)
    else
      project_issues_path(project)
    end

  {
    field_name: "#{issuable.class.model_name.param_key}[label_ids][]",
    full_path: project.full_path,
    initial_labels: initial_labels.to_json,
    issuable_type: issuable.issuable_type,
    labels_filter_base_path: filter_base_path,
    labels_manage_path: project_labels_path(project),
    supports_lock_on_merge: issuable.supports_lock_on_merge?.to_s
  }
end

#issuable_path(issuable, *options) ⇒ Object 



138
139
140
 
# File 'app/helpers/issuables_helper.rb', line 138

def issuable_path(issuable, *options)
  polymorphic_path(issuable, *options)
end

#issuable_project_reference(issuable) ⇒ Object 



97
98
99
 
# File 'app/helpers/issuables_helper.rb', line 97

def issuable_project_reference(issuable)
  "#{issuable.project.full_name} #{issuable.to_reference}"
end

#issuable_reference(issuable) ⇒ Object 



93
94
95
 
# File 'app/helpers/issuables_helper.rb', line 93

def issuable_reference(issuable)
  @show_full_reference ? issuable.to_reference(full: true) : issuable.to_reference(@group || @project)
end

#issuables_count_for_state(issuable_type, state) ⇒ Object 



126
127
128
 
# File 'app/helpers/issuables_helper.rb', line 126

def issuables_count_for_state(issuable_type, state)
  Gitlab::IssuablesCountForState.new(finder, fast_fail: true, store_in_redis_cache: true)[state]
end

#issuables_state_counter_text(issuable_type, state, display_count) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'app/helpers/issuables_helper.rb', line 73

def issuables_state_counter_text(issuable_type, state, display_count)
  titles = {
    opened: _("Open"),
    closed: _("Closed"),
    merged: _("Merged"),
    all: _("All")
  }
  state_title = titles[state] || state.to_s.humanize
  html = content_tag(:span, state_title)

  return html.html_safe unless display_count

  count = issuables_count_for_state(issuable_type, state)
  if count != -1
    html << " " << gl_badge_tag(format_count(issuable_type, count, Gitlab::IssuablesCountForState::THRESHOLD), { variant: :neutral }, { class: "gl-tab-counter-badge gl-hidden @sm/panel:gl-inline-flex" })
  end

  html.html_safe
end

#multi_label_name(current_labels, default_label) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
 
# File 'app/helpers/issuables_helper.rb', line 36

def multi_label_name(current_labels, default_label)
  return default_label if current_labels.blank?

  title = current_labels.first.try(:title) || current_labels.first[:title]

  if current_labels.size > 1
    "#{title} +#{current_labels.size - 1} more"
  else
    title
  end
end

#reopen_issuable_path(issuable) ⇒ Object 



134
135
136
 
# File 'app/helpers/issuables_helper.rb', line 134

def reopen_issuable_path(issuable)
  issuable_path(issuable, close_reopen_params(issuable, :reopen))
end

#serialize_issuable(issuable, opts = {}) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'app/helpers/issuables_helper.rb', line 48

def serialize_issuable(issuable, opts = {})
  serializer_klass = case issuable
                     when Issue
                       IssueSerializer
                     when MergeRequest
                       MergeRequestSerializer
                     end

  serializer_klass
    .new(current_user: current_user, project: issuable.project)
    .represent(issuable, opts)
    .to_json
end

#sidebar_gutter_collapsed_class(is_merge_request_with_flag) ⇒ Object 



15
16
17
18
19
 
# File 'app/helpers/issuables_helper.rb', line 15

def sidebar_gutter_collapsed_class(is_merge_request_with_flag)
  return "right-sidebar-expanded" if is_merge_request_with_flag

  "right-sidebar-#{sidebar_gutter_collapsed? ? 'collapsed' : 'expanded'}"
end

#sidebar_gutter_toggle_icon ⇒ Object 



8
9
10
11
12
13
 
# File 'app/helpers/issuables_helper.rb', line 8

def sidebar_gutter_toggle_icon
  content_tag(:span, class: 'js-sidebar-toggle-container gl-button-text', data: { is_expanded: !sidebar_gutter_collapsed? }) do
    sprite_icon('chevron-double-lg-left', css_class: "js-sidebar-expand #{'hidden' unless sidebar_gutter_collapsed?}") +
      sprite_icon('chevron-double-lg-right', css_class: "js-sidebar-collapse #{'hidden' if sidebar_gutter_collapsed?}")
  end
end

#sidebar_gutter_tooltip_text ⇒ Object 



21
22
23
 
# File 'app/helpers/issuables_helper.rb', line 21

def sidebar_gutter_tooltip_text
  sidebar_gutter_collapsed? ? _('Expand sidebar') : _('Collapse sidebar')
end

#users_dropdown_label(selected_users) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'app/helpers/issuables_helper.rb', line 62

def users_dropdown_label(selected_users)
  case selected_users.length
  when 0
    _('Unassigned')
  when 1
    selected_users[0].name
  else
    "#{selected_users[0].name} + #{selected_users.length - 1} more"
  end
end