Module: ProjectsHelper

Includes:
CompareHelper, Gitlab::Allowable, Gitlab::Utils::StrongMemoize
Included in:
GitlabRoutingHelper, MergeRequestWidgetEntity
Defined in:
app/helpers/projects_helper.rb

Instance Method Summary collapse

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

#able_to_see_forks_count?(project, user) ⇒ Boolean

Returns:

  • (Boolean) 


493
494
495
 
# File 'app/helpers/projects_helper.rb', line 493

def able_to_see_forks_count?(project, user)
  project.forking_enabled? && can?(user, :read_code, project)
end

#able_to_see_issues?(project, user) ⇒ Boolean

Returns:

  • (Boolean) 


485
486
487
 
# File 'app/helpers/projects_helper.rb', line 485

def able_to_see_issues?(project, user)
  project.issues_enabled? && can?(user, :read_issue, project)
end

#able_to_see_merge_requests?(project, user) ⇒ Boolean

Returns:

  • (Boolean) 


489
490
491
 
# File 'app/helpers/projects_helper.rb', line 489

def able_to_see_merge_requests?(project, user)
  project.merge_requests_enabled? && can?(user, :read_merge_request, project)
end

#any_projects?(projects) ⇒ Boolean

Returns true if any projects are present.

If the relation has a LIMIT applied we’ll cast the relation to an Array since repeated any? checks would otherwise result in multiple COUNT queries being executed.

If no limit is applied we’ll just issue a COUNT since the result set could be too large to load into memory.

Returns:

  • (Boolean) 


338
339
340
341
342
343
344
345
346
 
# File 'app/helpers/projects_helper.rb', line 338

def any_projects?(projects)
  return projects.any? if projects.is_a?(Array)

  if projects.limit_value
    projects.to_a.any?
  else
    projects.except(:offset).any?
  end
end

#archiving_available?(project) ⇒ Boolean

Returns:

  • (Boolean) 


575
576
577
578
579
 
# File 'app/helpers/projects_helper.rb', line 575

def archiving_available?(project)
  return false unless project

  project.persisted? && !project.self_deletion_scheduled? && can?(current_user, :archive_project, project)
end

#author_content_tag(author, opts = {}) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'app/helpers/projects_helper.rb', line 40

def author_content_tag(author, opts = {})
  default_opts = { author_class: 'author', tooltip: false, by_username: false }
  opts = default_opts.merge(opts)

  has_tooltip = !opts[:by_username] && opts[:tooltip]

  username = opts[:by_username] ? author.to_reference : author.name
  name_tag_options = { class: [opts[:author_class]] }

  if has_tooltip
    name_tag_options[:title] = author.to_reference
    name_tag_options[:data] = { placement: 'top' }
    name_tag_options[:class] << 'has-tooltip'
  end

  # NOTE: ActionView::Helpers::TagHelper#content_tag HTML escapes username
  content_tag(:span, username, name_tag_options)
end

#autodeploy_flash_notice(branch_name) ⇒ Object 



242
243
244
245
246
247
248
249
250
 
# File 'app/helpers/projects_helper.rb', line 242

def autodeploy_flash_notice(branch_name)
  ERB::Util.html_escape(
    _("Branch %{branch_name} was created. To set up auto deploy, choose a GitLab CI " \
      "Yaml template and commit your changes. %{link_to_autodeploy_doc}")
  ) % {
    branch_name: tag.strong(truncate(sanitize(branch_name))),
    link_to_autodeploy_doc: link_to_autodeploy_doc
  }
end

#badge_count(number) ⇒ Object 



634
635
636
 
# File 'app/helpers/projects_helper.rb', line 634

def badge_count(number)
  format_cached_count(1000, number)
end

#branch_rules_path ⇒ Object 



662
663
664
 
# File 'app/helpers/projects_helper.rb', line 662

def branch_rules_path
  project_settings_repository_path(@project, anchor: 'js-branch-rules')
end

#can_admin_associated_clusters?(project) ⇒ Boolean

Returns:

  • (Boolean) 


658
659
660
 
# File 'app/helpers/projects_helper.rb', line 658

def can_admin_associated_clusters?(project)
  can_admin_project_clusters?(project) || can_admin_group_clusters?(project)
end

#can_change_visibility_level?(project, current_user) ⇒ Boolean

Returns:

  • (Boolean) 


215
216
217
 
# File 'app/helpers/projects_helper.rb', line 215

def can_change_visibility_level?(project, current_user)
  can?(current_user, :change_visibility_level, project)
end

#can_disable_emails?(project, current_user) ⇒ Boolean

Returns:

  • (Boolean) 


219
220
221
222
223
 
# File 'app/helpers/projects_helper.rb', line 219

def can_disable_emails?(project, current_user)
  return false if project.group&.emails_disabled?

  can?(current_user, :set_emails_disabled, project)
end

#can_push_code? ⇒ Boolean

Returns:

  • (Boolean) 


654
655
656
 
# File 'app/helpers/projects_helper.rb', line 654

def can_push_code?
  current_user&.can?(:push_code, @project)
end

#can_set_diff_preview_in_email?(project, current_user) ⇒ Boolean

Returns:

  • (Boolean) 


225
226
227
228
229
 
# File 'app/helpers/projects_helper.rb', line 225

def can_set_diff_preview_in_email?(project, current_user)
  return false if project.group&.show_diff_preview_in_email?.equal?(false)

  can?(current_user, :set_show_diff_preview_in_email, project)
end

#can_view_branch_rules? ⇒ Boolean

Returns:

  • (Boolean) 


650
651
652
 
# File 'app/helpers/projects_helper.rb', line 650

def can_view_branch_rules?
  can?(current_user, :maintainer_access, @project)
end

#clusters_deprecation_alert_message ⇒ Object 



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'app/helpers/projects_helper.rb', line 602

def clusters_deprecation_alert_message
  if has_active_license?
    s_(
      'ClusterIntegration|The certificate-based Kubernetes integration is deprecated and ' \
        'will be removed in the future. You should %{linkStart}migrate to the GitLab agent ' \
        'for Kubernetes%{linkEnd}. For more information, see the %{deprecationLinkStart}' \
        'deprecation epic%{deprecationLinkEnd}, or contact GitLab support.'
    )
  else
    s_(
      'ClusterIntegration|The certificate-based Kubernetes integration is deprecated and ' \
        'will be removed in the future. You should %{linkStart}migrate to the GitLab agent ' \
        'for Kubernetes%{linkEnd}. For more information, see the %{deprecationLinkStart}' \
        'deprecation epic%{deprecationLinkEnd}.'
    )
  end
end

#dashboard_projects_app_data ⇒ Object 



712
713
714
715
716
717
 
# File 'app/helpers/projects_helper.rb', line 712

def dashboard_projects_app_data
  {
    initial_sort: project_list_sort_by,
    programming_languages: programming_languages
  }.to_json
end

#delete_confirm_phrase(project) ⇒ Object

Returns the confirm phrase the user needs to type in order to delete the project

Thus the phrase should include the namespace to make it very clear to the user which project is subject to deletion. Relevant issue: gitlab.com/gitlab-org/gitlab/-/issues/343591



481
482
483
 
# File 'app/helpers/projects_helper.rb', line 481

def delete_confirm_phrase(project)
  project.path_with_namespace
end

#directory? ⇒ Boolean

Returns:

  • (Boolean) 


393
394
395
 
# File 'app/helpers/projects_helper.rb', line 393

def directory?
  @path.present?
end

#error_tracking_setting_project_json ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'app/helpers/projects_helper.rb', line 378

def error_tracking_setting_project_json
  setting = @project.error_tracking_setting

  return if setting.blank? || setting.project_slug.blank? ||
    setting.organization_slug.blank?

  {
    sentry_project_id: setting.sentry_project_id,
    name: setting.project_name,
    organization_name: setting.organization_name,
    organization_slug: setting.organization_slug,
    slug: setting.project_slug
  }.to_json
end

#explore_projects_tab? ⇒ Boolean

Returns:

  • (Boolean) 


368
369
370
371
372
 
# File 'app/helpers/projects_helper.rb', line 368

def explore_projects_tab?
  current_page?(explore_projects_path) ||
    current_page?(trending_explore_projects_path) ||
    current_page?(starred_explore_projects_path)
end

#external_classification_label_help_message ⇒ Object 



397
398
399
400
401
402
403
404
405
 
# File 'app/helpers/projects_helper.rb', line 397

def external_classification_label_help_message
  default_label = ::Gitlab::CurrentSettings.current_application_settings
                    .external_authorization_service_default_label

  s_(
    "ExternalAuthorizationService|When no classification label is set the "\
      "default label `%{default_label}` will be used."
  ) % { default_label: default_label }
end

#fork_button_data_attributes(project) ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'app/helpers/projects_helper.rb', line 497

def fork_button_data_attributes(project)
  return unless current_user
  return if project.empty_repo?

  if current_user.already_forked?(project) && !current_user.has_forkable_groups?
    user_fork_url = namespace_project_path(current_user, current_user.fork_of(project))
  end

  {
    can_fork_project: can?(current_user, :fork_project, project).to_s,
    can_read_code: can?(current_user, :read_code, project).to_s,
    forks_count: project.forks_count,
    new_fork_url: new_project_fork_path(project),
    project_forks_url: project_forks_path(project),
    project_full_path: project.full_path,
    user_fork_url: user_fork_url
  }
end

#hidden_issue_icon(issue) ⇒ Object 



685
686
687
688
689
 
# File 'app/helpers/projects_helper.rb', line 685

def hidden_issue_icon(issue)
  return unless issue_hidden?(issue)

  hidden_resource_icon(issue)
end

#home_panel_data_attributes ⇒ Object 



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'app/helpers/projects_helper.rb', line 543

def home_panel_data_attributes
  project = @project.is_a?(ProjectPresenter) ? @project.project : @project
  dropdown_attributes = groups_projects_more_actions_dropdown_data(project) || {}
  fork_button_attributes = fork_button_data_attributes(project) || {}
  notification_attributes = notification_data_attributes(project) || {}
  star_count_attributes = star_count_data_attributes(project)
  admin_path = admin_project_path(project) if current_user&.can_admin_all_resources?
  cicd_catalog_path = explore_catalog_path(project.catalog_resource) if project.catalog_resource

  {
    admin_path: admin_path,
    can_read_project: can?(current_user, :read_project, project).to_s,
    cicd_catalog_path: cicd_catalog_path,
    is_project_archived: project.archived.to_s,
    is_project_empty: project.empty_repo?.to_s,
    is_project_marked_for_deletion: project.self_deletion_scheduled?.to_s,
    project_avatar: project.avatar_url,
    project_name: project.name,
    project_id: project.id,
    project_visibility_level: Gitlab::VisibilityLevel.string_level(project.visibility_level)
  }.merge(
    dropdown_attributes,
    fork_button_attributes,
    notification_attributes,
    star_count_attributes
  )
end

#http_clone_url_to_repo(project) ⇒ Object 



642
643
644
 
# File 'app/helpers/projects_helper.rb', line 642

def http_clone_url_to_repo(project)
  project.http_url_to_repo
end

#import_from_bitbucket_message ⇒ Object 



571
572
573
 
# File 'app/helpers/projects_helper.rb', line 571

def import_from_bitbucket_message
  configure_oauth_import_message('Bitbucket', help_page_path("integration/bitbucket.md"))
end

#inactive_project_deletion_date(project) ⇒ Object 



594
595
596
 
# File 'app/helpers/projects_helper.rb', line 594

def inactive_project_deletion_date(project)
  Gitlab::InactiveProjectsDeletionWarningTracker.new(project.id).scheduled_deletion_date
end

#issue_css_classes(issue) ⇒ Object 



691
692
693
694
695
696
 
# File 'app/helpers/projects_helper.rb', line 691

def issue_css_classes(issue)
  classes = ["issue"]
  classes << "closed" if issue.closed?
  classes << "gl-cursor-grab" if @sort == 'relative_position'
  classes.join(' ')
end

#issue_manual_ordering_class ⇒ Object 



698
699
700
701
702
 
# File 'app/helpers/projects_helper.rb', line 698

def issue_manual_ordering_class
  return unless @sort == 'relative_position' && !issue_repositioning_disabled?

  'manual-ordering'
end

#last_pipeline_from_status_cache(project) ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
 
# File 'app/helpers/projects_helper.rb', line 261

def last_pipeline_from_status_cache(project)
  if Feature.enabled?(:last_pipeline_from_pipeline_status, project)
    pipeline_status = project.pipeline_status
    return unless pipeline_status.has_status?

    # commits have far more attributes than id, but last_pipeline only requires sha
    return Commit.from_hash({ id: pipeline_status.sha }, project).last_pipeline
  end

  project.last_pipeline
end

#last_push_event ⇒ Object 



231
232
233
 
# File 'app/helpers/projects_helper.rb', line 231

def last_push_event
  current_user&.recent_push(@project)
end

#link_to_autodeploy_doc ⇒ Object 



235
236
237
238
239
240
 
# File 'app/helpers/projects_helper.rb', line 235

def link_to_autodeploy_doc
  link_to _('About auto deploy'),
    help_page_path('topics/autodevops/stages.md', anchor: 'auto-deploy'),
    target: '_blank',
    rel: 'noopener'
end

#link_to_data_loss_doc ⇒ Object 



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

def link_to_data_loss_doc
  link_to _('data loss'), help_page_path('user/project/repository/_index.md', anchor: 'repository-path-changes'),
    target: '_blank', rel: 'noopener'
end

#link_to_member(author, opts = {}, &block) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'app/helpers/projects_helper.rb', line 59

def link_to_member(author, opts = {}, &block)
  default_opts = { avatar: true, name: true, title: ":name" }
  opts = default_opts.merge(opts)

  return "(deleted)" unless author

  data_attrs = {
    user_id: author.id,
    username: author.username,
    name: author.name,
    testid: "author-link"
  }

  inject_classes = ["author-link gl-text-link", opts[:extra_class]]

  if opts[:name]
    inject_classes.concat(["js-user-link", opts[:mobile_classes]])
  else
    inject_classes.append("has-tooltip")
  end

  inject_classes = inject_classes.compact.join(" ")

  author_html = []
  # Build avatar image tag
  author_html << link_to_member_avatar(author, opts) if opts[:avatar]
  # Build name span tag
  author_html << author_content_tag(author, opts) if opts[:name]
  author_html << capture(&block) if block
  author_html = author_html.join.html_safe

  if opts[:name]
    link_to(author_html, user_path(author), class: inject_classes, data: data_attrs).html_safe
  else
    title = opts[:title].sub(":name", sanitize(author.name))
    link_to(
      author_html,
      user_path(author),
      class: inject_classes,
      title: title,
      data: { container: 'body' }
    ).html_safe
  end
end

#link_to_member_avatar(author, opts = {}) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
 
# File 'app/helpers/projects_helper.rb', line 28

def link_to_member_avatar(author, opts = {})
  default_opts = { size: 16 }
  opts = default_opts.merge(opts)

  classes = %W[avatar avatar-inline s#{opts[:size]}]
  classes << opts[:avatar_class] if opts[:avatar_class]

  avatar = avatar_icon_for_user(author, opts[:size])

  image_tag(avatar, width: opts[:size], class: classes, alt: '')
end

#link_to_namespace_change_doc ⇒ Object 



126
127
128
129
130
131
 
# File 'app/helpers/projects_helper.rb', line 126

def link_to_namespace_change_doc
  link_to _('project\'s path'),
    help_page_path('user/group/manage.md', anchor: 'change-a-groups-path'),
    target: '_blank',
    rel: 'noopener'
end

#link_to_project(project) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'app/helpers/projects_helper.rb', line 13

def link_to_project(project)
  link_to namespace_project_path(namespace_id: project.namespace, id: project),
    title: h(project.name),
    class: 'gl-link' do
    title = content_tag(:span, project.name, class: 'project-name')

    if project.namespace
      namespace = content_tag(:span, "#{project.namespace.human_name} / ", class: 'namespace-name')
      title = namespace + title
    end

    title
  end
end

#load_catalog_resources(projects) ⇒ Object 



257
258
259
 
# File 'app/helpers/projects_helper.rb', line 257

def load_catalog_resources(projects)
  ActiveRecord::Associations::Preloader.new(records: projects, associations: :catalog_resource).call
end

#load_pipeline_status(projects) ⇒ Object 



252
253
254
255
 
# File 'app/helpers/projects_helper.rb', line 252

def load_pipeline_status(projects)
  Gitlab::Cache::Ci::ProjectPipelineStatus
    .load_in_batch_for_projects(projects)
end

#localized_project_human_access(access) ⇒ Object 



630
631
632
 
# File 'app/helpers/projects_helper.rb', line 630

def localized_project_human_access(access)
  localized_access_names[access] || Gitlab::Access.human_access(access)
end

#membership_locked? ⇒ Boolean

Returns:

  • (Boolean) 


411
412
413
 
# File 'app/helpers/projects_helper.rb', line 411

def membership_locked?
  false
end

#no_password_message ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'app/helpers/projects_helper.rb', line 304

def no_password_message
  set_password_link_start = '<a href="%{url}">'.html_safe % { url:  }
  set_up_pat_link_start = '<a href="%{url}">'.html_safe % { url:  }

  message = if current_user.require_password_creation_for_git?
              _(
                'Your account is authenticated with SSO or SAML. To push and pull over %{protocol} ' \
                  'with Git using this account, you must %{set_password_link_start}set a password%{link_end} ' \
                  'or %{set_up_pat_link_start}set up a personal access token%{link_end} to use instead of a password.'
              )
            else
              _(
                'Your account is authenticated with SSO or SAML. To push and pull over %{protocol} with Git using ' \
                  'this account, you must %{set_up_pat_link_start}set up a personal access token%{link_end} to use ' \
                  'instead of a password.'
              )
            end

  ERB::Util.html_escape(message) % {
    protocol: gitlab_config.protocol.upcase,
    set_password_link_start: set_password_link_start,
    set_up_pat_link_start: set_up_pat_link_start,
    link_end: '</a>'.html_safe
  }
end

#notification_data_attributes(project) ⇒ Object 



528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'app/helpers/projects_helper.rb', line 528

def notification_data_attributes(project)
  return unless current_user

  notification_setting = current_user.notification_settings_for(project)
  dropdown_items = notification_dropdown_items(notification_setting).to_json if notification_setting
  notification_level = notification_setting.level if notification_setting

  {
    emails_disabled: project.emails_disabled?.to_s,
    notification_dropdown_items: dropdown_items,
    notification_help_page_path: help_page_path('user/profile/notifications.md'),
    notification_level: notification_level
  }
end

#project_can_be_shared? ⇒ Boolean

Returns:

  • (Boolean) 


407
408
409
 
# File 'app/helpers/projects_helper.rb', line 407

def project_can_be_shared?
  !membership_locked? || @project.allowed_to_share_with_group?
end

#project_classes(project) ⇒ Object 



470
471
472
473
474
 
# File 'app/helpers/projects_helper.rb', line 470

def project_classes(project)
  return "project-highlight-puc" if project.warn_about_potentially_unwanted_characters?

  ""
end

#project_coverage_chart_data_attributes(daily_coverage_options, ref) ⇒ Object 



620
621
622
623
624
625
626
627
628
 
# File 'app/helpers/projects_helper.rb', line 620

def project_coverage_chart_data_attributes(daily_coverage_options, ref)
  {
    graph_endpoint: "#{daily_coverage_options[:graph_api_path]}?#{daily_coverage_options[:base_params].to_query}",
    graph_start_date: daily_coverage_options[:base_params][:start_date].strftime('%b %d'),
    graph_end_date: daily_coverage_options[:base_params][:end_date].strftime('%b %d'),
    graph_ref: ref.to_s,
    graph_csv_path: "#{daily_coverage_options[:download_path]}?#{daily_coverage_options[:base_params].to_query}"
  }
end

#project_incident_management_setting ⇒ Object 



8
9
10
11
 
# File 'app/helpers/projects_helper.rb', line 8

def project_incident_management_setting
  @project_incident_management_setting ||= @project.incident_management_setting ||
    @project.build_incident_management_setting
end

#project_license_name(project) ⇒ Object 



415
416
417
418
419
420
421
422
423
424
 
# File 'app/helpers/projects_helper.rb', line 415

def project_license_name(project)
  key = "project:#{project.id}:license_name"

  Gitlab::SafeRequestStore.fetch(key) { project.repository.license&.name }
rescue GRPC::Unavailable, GRPC::DeadlineExceeded, Gitlab::Git::CommandError => e
  Gitlab::ErrorTracking.track_exception(e)
  Gitlab::SafeRequestStore[key] = nil

  nil
end

#project_pages_domain_choices ⇒ Object 



730
731
732
733
734
735
736
737
738
739
740
 
# File 'app/helpers/projects_helper.rb', line 730

def project_pages_domain_choices
  pages_url = build_pages_url(@project)
  blank_option = [[s_('GitLabPages|Don’t enforce a primary domain'), '']]
  gitlab_default_option = [[pages_url, pages_url]]

  domain_options = @project.pages_domains.map { |domain| [domain.url, domain.url] } || []
  options_for_select(
    blank_option + domain_options + gitlab_default_option,
    selected: @project.project_setting.pages_primary_domain
  )
end

#project_permissions_panel_data(project) ⇒ Object 



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'app/helpers/projects_helper.rb', line 439

def project_permissions_panel_data(project)
  {
    packagesAvailable: ::Gitlab.config.packages.enabled,
    packagesHelpPath: help_page_path('user/packages/_index.md'),
    currentSettings: project_permissions_settings(project),
    canAddCatalogResource: can_add_catalog_resource?(project),
    canSetDiffPreviewInEmail: can_set_diff_preview_in_email?(project, current_user),
    canChangeVisibilityLevel: can_change_visibility_level?(project, current_user),
    canDisableEmails: can_disable_emails?(project, current_user),
    allowedVisibilityOptions: project_allowed_visibility_levels(project),
    visibilityHelpPath: help_page_path('user/public_access.md'),
    registryAvailable: Gitlab.config.registry.enabled,
    registryHelpPath: help_page_path('user/packages/container_registry/_index.md'),
    lfsAvailable: Gitlab.config.lfs.enabled,
    lfsHelpPath: help_page_path('topics/git/lfs/_index.md'),
    lfsObjectsExist: project.lfs_objects.exists?,
    lfsObjectsRemovalHelpPath: help_page_path('topics/git/lfs/_index.md',
      anchor: 'delete-a-git-lfs-file-from-repository-history'),
    pagesAvailable: Gitlab.config.pages.enabled,
    pagesAccessControlEnabled: Gitlab.config.pages.access_control,
    pagesAccessControlForced: project.pages_access_control_forced_by_ancestor?,
    pagesHelpPath: help_page_path('user/project/pages/pages_access_control.md'),
    issuesHelpPath: help_page_path('user/project/issues/_index.md'),
    membersPagePath: project_project_members_path(project),
    environmentsHelpPath: help_page_path('ci/environments/_index.md'),
    featureFlagsHelpPath: help_page_path('operations/feature_flags.md'),
    releasesHelpPath: help_page_path('user/project/releases/_index.md'),
    infrastructureHelpPath: help_page_path('user/infrastructure/_index.md')
  }
end

#projects_filtered_search_and_sort_app_data ⇒ Object 



704
705
706
707
708
709
710
 
# File 'app/helpers/projects_helper.rb', line 704

def projects_filtered_search_and_sort_app_data
  {
    initial_sort: project_list_sort_by,
    programming_languages: programming_languages,
    paths_to_exclude_sort_on: [starred_explore_projects_path, explore_root_path]
  }.to_json
end

#push_project_breadcrumbs(project) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'app/helpers/projects_helper.rb', line 104

def push_project_breadcrumbs(project)
  if project.group
    push_group_breadcrumbs(project.group)
  else
    owner = project.namespace.owner
    name = sanitize(owner.name, tags: [])
    url = user_path(owner)

    push_to_schema_breadcrumb(name, url)
  end

  push_to_schema_breadcrumb(simple_sanitize(project.name), project_path(project), project.try(:avatar_url))
end

#push_to_create_project_command(user = current_user) ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
 
# File 'app/helpers/projects_helper.rb', line 348

def push_to_create_project_command(user = current_user)
  repository_url =
    if Gitlab::CurrentSettings.current_application_settings.enabled_git_access_protocol == 'http'
      user_url(user)
    else
      Gitlab.config.gitlab_shell.ssh_path_prefix + user.username
    end

  "git push --set-upstream #{repository_url}/$(git rev-parse --show-toplevel | xargs basename).git " \
    "$(git rev-parse --abbrev-ref HEAD)"
end

#remote_mirror_setting_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


638
639
640
 
# File 'app/helpers/projects_helper.rb', line 638

def remote_mirror_setting_enabled?
  false
end

#remove_fork_project_confirm_json(project, remove_form_id) ⇒ Object 



202
203
204
205
206
207
208
209
 
# File 'app/helpers/projects_helper.rb', line 202

def remove_fork_project_confirm_json(project, remove_form_id)
  {
    remove_form_id: remove_form_id,
    button_text: _('Remove fork relationship'),
    confirm_danger_message: remove_fork_project_warning_message(project),
    phrase: @project.path
  }
end

#remove_fork_project_description_message(project) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'app/helpers/projects_helper.rb', line 153

def remove_fork_project_description_message(project)
  source = visible_fork_source(project)

  if source
    msg = _('This will remove the fork relationship between this project and %{fork_source}.') % {
      fork_source: link_to(source.full_name, project_path(source))
    }

    msg.html_safe
  else
    _('This will remove the fork relationship between this project and other projects in the fork network.')
  end
end

#remove_fork_project_warning_message(project) ⇒ Object 



196
197
198
199
200
 
# File 'app/helpers/projects_helper.rb', line 196

def remove_fork_project_warning_message(project)
  _("You are going to remove the fork relationship from %{project_full_name}. Are you ABSOLUTELY sure?") % {
    project_full_name: project.full_name
  }
end

#remove_project_message ⇒ Object 



118
119
120
121
122
123
124
 
# File 'app/helpers/projects_helper.rb', line 118

def remove_project_message
  format(
    _("Deleting a project places it into a read-only state until %{date}, " \
      "at which point the project will be permanently deleted. Are you ABSOLUTELY sure?"),
    date: permanent_deletion_date_formatted(Date.current)
  )
end

#show_archived_project_banner?(project) ⇒ Boolean

Returns:

  • (Boolean) 


581
582
583
584
585
 
# File 'app/helpers/projects_helper.rb', line 581

def show_archived_project_banner?(project)
  return false unless project

  project.persisted? && project.archived?
end

#show_auto_devops_implicitly_enabled_banner?(project, user) ⇒ Boolean

Returns:

  • (Boolean) 


292
293
294
295
296
 
# File 'app/helpers/projects_helper.rb', line 292

def show_auto_devops_implicitly_enabled_banner?(project, user)
  return false unless user_can_see_auto_devops_implicitly_enabled_banner?(project, user)

  cookies[:"hide_auto_devops_implicitly_enabled_banner_#{project.id}"].blank?
end

#show_clusters_alert?(project) ⇒ Boolean

Returns:

  • (Boolean) 


598
599
600
 
# File 'app/helpers/projects_helper.rb', line 598

def show_clusters_alert?(project)
  Gitlab.com? && can_admin_associated_clusters?(project)
end

#show_count?(disabled: false, compact_mode: false) ⇒ Boolean

Returns:

  • (Boolean) 


374
375
376
 
# File 'app/helpers/projects_helper.rb', line 374

def show_count?(disabled: false, compact_mode: false)
  !disabled && !compact_mode
end

#show_dashboard_projects_welcome_page? ⇒ Boolean

Returns:

  • (Boolean) 


719
720
721
722
723
724
725
726
727
728
 
# File 'app/helpers/projects_helper.rb', line 719

def show_dashboard_projects_welcome_page?
  dashboard_projects_landing_paths = [
    root_path,
    root_dashboard_path,
    dashboard_projects_path,
    contributed_dashboard_projects_path
  ]

  dashboard_projects_landing_paths.include?(request.path) && !current_user.authorized_projects.exists?
end

#show_inactive_project_deletion_banner?(project) ⇒ Boolean

Returns:

  • (Boolean) 


587
588
589
590
591
592
 
# File 'app/helpers/projects_helper.rb', line 587

def show_inactive_project_deletion_banner?(project)
  return false unless project
  return false unless delete_inactive_projects?

  project.persisted? && project.inactive?
end

#show_invalid_gpg_key_message?(project) ⇒ Boolean

Returns:

  • (Boolean) 


280
281
282
283
284
285
 
# File 'app/helpers/projects_helper.rb', line 280

def show_invalid_gpg_key_message?(project)
  return false unless project.beyond_identity_integration&.active?
  return false if current_user.gpg_keys.externally_valid.exists?

  true
end

#show_lfs_misconfiguration_banner?(project) ⇒ Boolean

Returns:

  • (Boolean) 


431
432
433
434
435
436
437
 
# File 'app/helpers/projects_helper.rb', line 431

def show_lfs_misconfiguration_banner?(project)
  return false unless project.repository && project.lfs_enabled?

  Rails.cache.fetch("show_lfs_misconfiguration_banner_#{project.id}", expires_in: 5.minutes) do
    project.lfs_objects_projects.project_repository_type.any? && !project.repository.has_gitattributes?
  end
end

#show_mobile_devops_project_promo?(project) ⇒ Boolean

Returns:

  • (Boolean) 


298
299
300
301
302
 
# File 'app/helpers/projects_helper.rb', line 298

def show_mobile_devops_project_promo?(project)
  return false unless (project.project_setting.target_platforms & ::ProjectSetting::ALLOWED_TARGET_PLATFORMS).any?

  cookies[:"hide_mobile_devops_promo_#{project.id}"].blank?
end

#show_no_password_message? ⇒ Boolean

Returns:

  • (Boolean) 


287
288
289
290
 
# File 'app/helpers/projects_helper.rb', line 287

def show_no_password_message?
  cookies[:hide_no_password_message].blank? && !current_user.hide_no_password &&
    current_user.require_extra_setup_for_git_auth?
end

#show_no_ssh_key_message?(project) ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
276
277
278
 
# File 'app/helpers/projects_helper.rb', line 273

def show_no_ssh_key_message?(project)
  Gitlab::CurrentSettings.user_show_add_ssh_key_message? &&
    cookies[:hide_no_ssh_message].blank? &&
    !current_user.hide_no_ssh_key &&
    current_user.require_ssh_key?
end

#show_terraform_banner?(project) ⇒ Boolean

Returns:

  • (Boolean) 


426
427
428
429
 
# File 'app/helpers/projects_helper.rb', line 426

def show_terraform_banner?(project)
  Feature.enabled?(:show_terraform_banner, type: :ops) &&
    project.repository_languages.with_programming_language('HCL').exists? && project.terraform_states.empty?
end

#show_xcode_link?(project = @project) ⇒ Boolean

Returns:

  • (Boolean) 


360
361
362
 
# File 'app/helpers/projects_helper.rb', line 360

def show_xcode_link?(project = @project)
  browser.platform.mac? && project.repository.xcode_project?
end

#ssh_clone_url_to_repo(project) ⇒ Object 



646
647
648
 
# File 'app/helpers/projects_helper.rb', line 646

def ssh_clone_url_to_repo(project)
  project.ssh_url_to_repo
end

#star_count_data_attributes(project) ⇒ Object 



516
517
518
519
520
521
522
523
524
525
526
 
# File 'app/helpers/projects_helper.rb', line 516

def star_count_data_attributes(project)
  starred = current_user ? current_user.starred?(project) : false

  {
    project_id: project.id,
    sign_in_path: new_session_path(:user, redirect_to_referer: 'yes'),
    star_count: project.star_count,
    starred: starred.to_s,
    starrers_path: project_starrers_path(project)
  }
end

#transfer_project_confirm_button ⇒ Object 



149
150
151
 
# File 'app/helpers/projects_helper.rb', line 149

def transfer_project_confirm_button
  _("Transfer project")
end

#transfer_project_message(project) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
 
# File 'app/helpers/projects_helper.rb', line 138

def transfer_project_message(project)
  _("You are about to transfer %{code_start}%{project_full_name}%{code_end} to another namespace. This action " \
    "changes the %{link_to_namespace_change_doc} and can lead to %{link_to_data_loss_doc}.") % {
      project_full_name: project.full_name,
      code_start: '<code>',
      code_end: '</code>',
      link_to_namespace_change_doc: link_to_namespace_change_doc,
      link_to_data_loss_doc: link_to_data_loss_doc
    }
end

#visibility_level_content(project, css_class: nil, icon_css_class: nil, icon_variant: nil) ⇒ Object 



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'app/helpers/projects_helper.rb', line 666

def visibility_level_content(project, css_class: nil, icon_css_class: nil, icon_variant: nil)
  title = visibility_icon_description(project)
  container_class = [
    'has-tooltip gl-border-0 gl-bg-transparent gl-p-0 gl-leading-0 gl-text-inherit',
    css_class
  ].compact.join(' ')
  data = { container: 'body', placement: 'top' }

  content_tag(
    :button,
    class: container_class,
    data: data,
    title: title,
    type: 'button',
    aria: { label: title }) do
    visibility_level_icon(project.visibility_level, options: { class: icon_css_class, variant: icon_variant })
  end
end

#visible_fork_source(project) ⇒ Object 



211
212
213
 
# File 'app/helpers/projects_helper.rb', line 211

def visible_fork_source(project)
  project.fork_source if project.fork_source && can?(current_user, :read_project, project.fork_source)
end

#vue_fork_divergence_data(project, ref) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'app/helpers/projects_helper.rb', line 167

def vue_fork_divergence_data(project, ref)
  source_project = visible_fork_source(project)

  return {} unless source_project

  source_default_branch = source_project.default_branch

  merge_request =
    MergeRequest.opened
      .from_project(project).of_projects(source_project.id).from_source_branches(ref).first

  {
    project_path: project.full_path,
    selected_branch: ref,
    source_name: source_project.full_name,
    source_path: project_path(source_project),
    source_default_branch: source_default_branch,
    can_sync_branch: can_sync_branch?(project, ref).to_s,
    ahead_compare_path: project_compare_path(
      project, from: source_default_branch, to: ref, from_project_id: source_project.id
    ),
    create_mr_path: create_merge_request_path(project, source_project, ref, merge_request),
    view_mr_path: merge_request && project_merge_request_path(source_project, merge_request),
    behind_compare_path: project_compare_path(
      source_project, from: ref, to: source_default_branch, from_project_id: project.id
    )
  }
end

#xcode_uri_to_repo(project = @project) ⇒ Object 



364
365
366
 
# File 'app/helpers/projects_helper.rb', line 364

def xcode_uri_to_repo(project = @project)
  "xcode://clone?repo=#{CGI.escape(default_url_to_repo(project))}"
end