Module: TreeHelper

Instance Method Summary collapse

Methods included from WebIdeButtonHelper

#can_collaborate?, #can_create_mr_from_fork?, #can_push_code?, #edit_url, #fork?, #gitpod_url, #needs_to_fork?, #project_fork, #project_to_use, #readable_blob?, #show_edit_button?, #show_gitpod_button?, #show_pipeline_editor_button?, #show_web_ide_button?, #web_ide_url

Methods included from BlobHelper

#blob_editor_paths, #blob_icon, #blob_raw_path, #blob_raw_url, #blob_render_error_options, #blob_render_error_reason, #can_modify_blob?, #contribution_options, #copy_blob_source_button, #copy_file_path_button, #delete_blob_link, #dockerfile_names, #download_blob_button, #edit_blob_button, #edit_blob_fork_params, #edit_blob_path, #edit_button_tag, #edit_disabled_button_tag, #edit_fork_button_tag, #edit_link_tag, #edit_modify_file_fork_params, #editing_ci_config?, #editing_preview_title, #encode_ide_path, #fork_and_edit_path, #fork_path_for_current_user, #gitignore_names, #gitlab_ci_ymls, #human_access, #ide_edit_path, #ide_fork_and_edit_path, #ide_merge_request_path, #leave_edit_message, #licenses_for_select, #metrics_dashboard_ymls, #modify_file_button, #open_raw_blob_button, #parent_dir_raw_path, #readable_blob, #ref_project, #replace_blob_link, #sanitize_svg_data, #show_suggest_pipeline_creation_celebration?, #suggest_pipeline_commit_cookie_name

Instance Method Details


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'app/helpers/tree_helper.rb', line 132

def breadcrumb_data_attributes
  attrs = {
    selected_branch: selected_branch,
    can_push_code: can?(current_user, :push_code, @project).to_s,
    can_collaborate: can_collaborate_with_project?(@project).to_s,
    new_blob_path: project_new_blob_path(@project, @ref),
    upload_path: project_create_blob_path(@project, @ref),
    new_dir_path: project_create_dir_path(@project, @ref),
    new_branch_path: new_project_branch_path(@project),
    new_tag_path: new_project_tag_path(@project),
    can_edit_tree: can_edit_tree?.to_s
  }

  if can?(current_user, :fork_project, @project) && can?(current_user, :create_merge_request_in, @project)
    continue_param = {
      to: project_new_blob_path(@project, @id),
      notice: edit_in_new_fork_notice,
      notice_now: edit_in_new_fork_notice_now
    }

    attrs.merge!(
      fork_new_blob_path: project_forks_path(@project, namespace_key: current_user.namespace.id, continue: continue_param),
      fork_new_directory_path: project_forks_path(@project, namespace_key: current_user.namespace.id, continue: continue_param.merge({
        to: request.fullpath,
        notice: _("%{edit_in_new_fork_notice} Try to create a new directory again.") % { edit_in_new_fork_notice: edit_in_new_fork_notice }
      })),
      fork_upload_blob_path: project_forks_path(@project, namespace_key: current_user.namespace.id, continue: continue_param.merge({
        to: request.fullpath,
        notice: _("%{edit_in_new_fork_notice} Try to upload a file again.") % { edit_in_new_fork_notice: edit_in_new_fork_notice }
      }))
    )
  end

  attrs
end

#can_edit_tree?(project = nil, ref = nil) ⇒ Boolean

Returns:

  • (Boolean)

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

def can_edit_tree?(project = nil, ref = nil)
  project ||= @project
  ref ||= @ref

  return false unless on_top_of_branch?(project, ref)

  can_collaborate_with_project?(project, ref: ref)
end

#commit_in_fork_helpObject


83
84
85
# File 'app/helpers/tree_helper.rb', line 83

def commit_in_fork_help
  _("GitLab will create a branch in your fork and start a merge request.")
end

#commit_in_single_accessible_branchObject


87
88
89
90
91
92
93
94
# File 'app/helpers/tree_helper.rb', line 87

def commit_in_single_accessible_branch
  branch_name = ERB::Util.html_escape(selected_branch)

  message = _("Your changes can be committed to %{branch_name} because a merge "\
              "request is open.") % { branch_name: "<strong>#{branch_name}</strong>" }

  message.html_safe
end

218
219
220
221
222
223
224
225
# File 'app/helpers/tree_helper.rb', line 218

def directory_download_links(project, ref, archive_prefix)
  Gitlab::Workhorse::ARCHIVE_FORMATS.map do |fmt|
    {
      text: fmt,
      path: project_archive_path(project, id: tree_join(ref, archive_prefix), format: fmt)
    }
  end
end

#edit_in_new_fork_noticeObject


74
75
76
77
# File 'app/helpers/tree_helper.rb', line 74

def edit_in_new_fork_notice
  _("You're not allowed to make changes to this project directly. "\
    "A fork of this project has been created that you can make changes in, so you can submit a merge request.")
end

#edit_in_new_fork_notice_action(action) ⇒ Object


79
80
81
# File 'app/helpers/tree_helper.rb', line 79

def edit_in_new_fork_notice_action(action)
  edit_in_new_fork_notice + _(" Try to %{action} this file again.") % { action: action }
end

#edit_in_new_fork_notice_nowObject


69
70
71
72
# File 'app/helpers/tree_helper.rb', line 69

def edit_in_new_fork_notice_now
  _("You're not allowed to make changes to this project directly. "\
    "A fork of this project is being created that you can make changes in, so you can submit a merge request.")
end

#flatten_tree(root_path, tree) ⇒ Object

returns the relative path of the first subdir that doesn't have only one directory descendant


120
121
122
# File 'app/helpers/tree_helper.rb', line 120

def flatten_tree(root_path, tree)
  tree.flat_path.sub(%r{\A#{Regexp.escape(root_path)}/}, '')
end

#fork_modal_options(project, ref, path, blob) ⇒ Object


178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'app/helpers/tree_helper.rb', line 178

def fork_modal_options(project, ref, path, blob)
  if show_edit_button?({ blob: blob })
    fork_path = fork_and_edit_path(project, ref, path)
    fork_modal_id = "modal-confirm-fork-edit"
  elsif show_web_ide_button?
    fork_path = ide_fork_and_edit_path(project, ref, path)
    fork_modal_id = "modal-confirm-fork-webide"
  end

  {
    fork_path: fork_path,
    fork_modal_id: fork_modal_id
  }
end

#on_top_of_branch?(project = @project, ref = @ref) ⇒ Boolean

Returns:

  • (Boolean)

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

def on_top_of_branch?(project = @project, ref = @ref)
  project.repository.branch_exists?(ref)
end

#patch_branch_name(ref) ⇒ Object

Generate a patch branch name that should look like: `username-branchname-patch-epoch` where `epoch` is the last 5 digits of the time since epoch (in milliseconds)

Note: this correlates with how the WebIDE formats the branch name and if this implementation changes, so should the `placeholderBranchName` definition in app/assets/javascripts/ide/stores/modules/commit/getters.js


52
53
54
55
56
57
58
59
# File 'app/helpers/tree_helper.rb', line 52

def patch_branch_name(ref)
  return unless current_user

  username = current_user.username
  epoch = time_in_milliseconds.to_s.last(5)

  "#{username}-#{ref}-patch-#{epoch}"
end

#path_breadcrumbs(max_links = 6) ⇒ Object


96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'app/helpers/tree_helper.rb', line 96

def path_breadcrumbs(max_links = 6)
  if @path.present?
    part_path = ""
    parts = @path.split('/')

    yield('..', File.join(*parts.first(parts.count - 2))) if parts.count > max_links

    parts.each do |part|
      part_path = File.join(part_path, part) unless part_path.empty?
      part_path = part if part_path.empty?

      next if parts.count > max_links && !parts.last(2).include?(part)

      yield(part, part_path)
    end
  end
end

#relative_url_rootObject


128
129
130
# File 'app/helpers/tree_helper.rb', line 128

def relative_url_root
  Gitlab.config.gitlab.relative_url_root.presence || '/'
end

#selected_branchObject


124
125
126
# File 'app/helpers/tree_helper.rb', line 124

def selected_branch
  @branch_name || tree_edit_branch
end

#tree_edit_branch(project = @project, ref = @ref) ⇒ Object


34
35
36
37
38
39
40
41
42
# File 'app/helpers/tree_helper.rb', line 34

def tree_edit_branch(project = @project, ref = @ref)
  return unless can_edit_tree?(project, ref)

  if user_access(project).can_push_to_branch?(ref)
    ref
  else
    patch_branch_name(ref)
  end
end

#tree_edit_project(project = @project) ⇒ Object


61
62
63
64
65
66
67
# File 'app/helpers/tree_helper.rb', line 61

def tree_edit_project(project = @project)
  if can?(current_user, :push_code, project)
    project
  elsif current_user && current_user.already_forked?(project)
    current_user.fork_of(project)
  end
end

#tree_icon(type, mode, name) ⇒ Object

Return an image icon depending on the file type and mode

type - String type of the tree item; either 'folder' or 'file' mode - File unix mode name - File name


12
13
14
# File 'app/helpers/tree_helper.rb', line 12

def tree_icon(type, mode, name)
  sprite_icon(file_type_icon_class(type, mode, name))
end

#tree_join(*args) ⇒ Object

Simple shortcut to File.join


17
18
19
# File 'app/helpers/tree_helper.rb', line 17

def tree_join(*args)
  File.join(*args)
end

#up_dir_pathObject


114
115
116
117
# File 'app/helpers/tree_helper.rb', line 114

def up_dir_path
  file = File.join(@path, "..")
  tree_join(@ref, file)
end

#vue_file_list_data(project, ref) ⇒ Object


168
169
170
171
172
173
174
175
176
# File 'app/helpers/tree_helper.rb', line 168

def vue_file_list_data(project, ref)
  {
    project_path: project.full_path,
    project_short_path: project.path,
    ref: ref,
    escaped_ref: ActionDispatch::Journey::Router::Utils.escape_path(ref),
    full_name: project.name_with_namespace
  }
end

#web_ide_button_data(options = {}) ⇒ Object


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'app/helpers/tree_helper.rb', line 193

def web_ide_button_data(options = {})
  {
    project_path: project_to_use.full_path,
    ref: @ref,

    is_fork: fork?,
    needs_to_fork: needs_to_fork?,
    gitpod_enabled: !current_user.nil? && current_user.gitpod_enabled,
    is_blob: !options[:blob].nil?,

    show_edit_button: show_edit_button?(options),
    show_web_ide_button: show_web_ide_button?,
    show_gitpod_button: show_gitpod_button?,
    show_pipeline_editor_button: show_pipeline_editor_button?(@project, @path),

    web_ide_url: web_ide_url,
    edit_url: edit_url(options),
    pipeline_editor_url: project_ci_pipeline_editor_path(@project, branch_name: @ref),

    gitpod_url: gitpod_url,
    user_preferences_gitpod_path: profile_preferences_path(anchor: 'user_gitpod_enabled'),
    user_profile_enable_gitpod_path: profile_path(user: { gitpod_enabled: true })
  }
end