issuables_helper.rb 9.6 KB
Newer Older
1
module IssuablesHelper
2 3
  include GitlabRoutingHelper

4
  def sidebar_gutter_toggle_icon
F
Filipa Lacerda 已提交
5
    sidebar_gutter_collapsed? ? icon('angle-double-left', { 'aria-hidden': 'true' }) : icon('angle-double-right', { 'aria-hidden': 'true' })
6 7 8 9 10 11
  end

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

12
  def multi_label_name(current_labels, default_label)
13
    if current_labels && current_labels.any?
14
      title = current_labels.first.try(:title)
15 16
      if current_labels.size > 1
        "#{title} +#{current_labels.size - 1} more"
J
Jacob Schatz 已提交
17
      else
18
        title
J
Jacob Schatz 已提交
19
      end
A
Arinde Eniola 已提交
20
    else
21
      default_label
J
Jacob Schatz 已提交
22 23 24
    end
  end

J
Jacob Schatz 已提交
25 26 27
  def issuable_json_path(issuable)
    project = issuable.project

D
Douwe Maan 已提交
28
    if issuable.is_a?(MergeRequest)
29
      project_merge_request_path(project, issuable.iid, :json)
J
Jacob Schatz 已提交
30
    else
31
      project_issue_path(project, issuable.iid, :json)
J
Jacob Schatz 已提交
32 33 34
    end
  end

35 36 37 38 39
  def serialize_issuable(issuable)
    case issuable
    when Issue
      IssueSerializer.new.represent(issuable).to_json
    when MergeRequest
F
Fatih Acet 已提交
40 41 42 43
      MergeRequestSerializer
        .new(current_user: current_user, project: issuable.project)
        .represent(issuable)
        .to_json
44 45 46
    end
  end

47 48 49 50 51 52 53 54 55 56 57 58 59
  def template_dropdown_tag(issuable, &block)
    title = selected_template(issuable) || "Choose a template"
    options = {
      toggle_class: 'js-issuable-selector',
      title: title,
      filter: true,
      placeholder: 'Filter',
      footer_content: true,
      data: {
        data: issuable_templates(issuable),
        field_name: 'issuable_template',
        selected: selected_template(issuable),
        project_path: ref_project.path,
60
        namespace_path: ref_project.namespace.full_path
61 62 63 64 65 66 67 68
      }
    }

    dropdown_tag(title, options: options) do
      capture(&block)
    end
  end

69
  def users_dropdown_label(selected_users)
70 71
    case selected_users.length
    when 0
72
      "Unassigned"
73
    when 1
74 75 76 77 78 79
      selected_users[0].name
    else
      "#{selected_users[0].name} + #{selected_users.length - 1} more"
    end
  end

80
  def user_dropdown_label(user_id, default_label)
P
Phil Hughes 已提交
81
    return default_label if user_id.nil?
82 83
    return "Unassigned" if user_id == "0"

P
Phil Hughes 已提交
84
    user = User.find_by(id: user_id)
85 86 87 88 89 90 91 92

    if user
      user.name
    else
      default_label
    end
  end

93 94 95 96 97 98 99
  def project_dropdown_label(project_id, default_label)
    return default_label if project_id.nil?
    return "Any project" if project_id == "0"

    project = Project.find_by(id: project_id)

    if project
100
      project.name_with_namespace
101 102 103 104 105
    else
      default_label
    end
  end

P
Phil Hughes 已提交
106
  def milestone_dropdown_label(milestone_title, default_label = "Milestone")
107 108 109 110 111 112
    title =
      case milestone_title
      when Milestone::Upcoming.name then Milestone::Upcoming.title
      when Milestone::Started.name then Milestone::Started.title
      else milestone_title.presence
      end
P
Phil Hughes 已提交
113

114
    h(title || default_label)
115 116
  end

117 118 119 120 121 122 123 124 125 126 127
  def to_url_reference(issuable)
    case issuable
    when Issue
      link_to issuable.to_reference, issue_url(issuable)
    when MergeRequest
      link_to issuable.to_reference, merge_request_url(issuable)
    else
      issuable.to_reference
    end
  end

128
  def issuable_meta(issuable, project, text)
129 130 131 132 133
    output = content_tag(:strong, class: "identifier") do
      concat("#{text} ")
      concat(to_url_reference(issuable))
    end

134
    output << " opened #{time_ago_with_tooltip(issuable.created_at)} by ".html_safe
135
    output << content_tag(:strong) do
136
      author_output = link_to_member(project, issuable.author, size: 24, mobile_classes: "hidden-xs", tooltip: true)
137 138
      author_output << link_to_member(project, issuable.author, size: 24, by_username: true, avatar: false, mobile_classes: "hidden-sm hidden-md hidden-lg")
    end
139

140
    output << "&ensp;".html_safe
141 142
    output << content_tag(:span, (issuable.task_status if issuable.tasks?), id: "task_status", class: "hidden-xs hidden-sm")
    output << content_tag(:span, (issuable.task_status_short if issuable.tasks?), id: "task_status_short", class: "hidden-md hidden-lg")
143 144

    output
145 146
  end

P
Phil Hughes 已提交
147
  def issuable_todo(issuable)
148
    if current_user
P
Phil Hughes 已提交
149
      current_user.todos.find_by(target: issuable, state: :pending)
150
    end
P
Phil Hughes 已提交
151 152
  end

P
Phil Hughes 已提交
153
  def issuable_labels_tooltip(labels, limit: 5)
P
Phil Hughes 已提交
154
    first, last = labels.partition.with_index{ |_, i| i < limit  }
155

P
Phil Hughes 已提交
156 157
    label_names = first.collect(&:name)
    label_names << "and #{last.size} more" unless last.empty?
158

P
Phil Hughes 已提交
159
    label_names.join(', ')
160 161
  end

162 163 164 165 166 167
  def issuables_state_counter_text(issuable_type, state)
    titles = {
      opened: "Open"
    }

    state_title = titles[state] || state.to_s.humanize
168
    count = issuables_count_for_state(issuable_type, state)
169 170 171 172 173 174 175

    html = content_tag(:span, state_title)
    html << " " << content_tag(:span, number_with_delimiter(count), class: 'badge')

    html.html_safe
  end

176 177
  def assigned_issuables_count(issuable_type)
    current_user.public_send("assigned_open_#{issuable_type}_count")
178 179
  end

180 181 182 183 184 185 186 187 188 189
  def issuable_filter_params
    [
      :search,
      :author_id,
      :assignee_id,
      :milestone_title,
      :label_name
    ]
  end

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

194 195 196 197
  def issuable_filter_present?
    issuable_filter_params.any? { |k| params.key?(k) }
  end

198
  def issuable_initial_data(issuable)
199
    data = {
200
      endpoint: project_issue_path(@project, issuable),
201 202
      canUpdate: can?(current_user, :update_issue, issuable),
      canDestroy: can?(current_user, :destroy_issue, issuable),
203
      canMove: current_user ? issuable.can_move?(current_user) : false,
204 205 206 207 208
      issuableRef: issuable.to_reference,
      isConfidential: issuable.confidential,
      markdownPreviewUrl: preview_markdown_path(@project),
      markdownDocs: help_page_path('user/markdown'),
      projectsAutocompleteUrl: autocomplete_projects_path(project_id: @project.id),
209
      issuableTemplates: issuable_templates(issuable),
210 211 212 213 214
      projectPath: ref_project.path,
      projectNamespace: ref_project.namespace.full_path,
      initialTitleHtml: markdown_field(issuable, :title),
      initialTitleText: issuable.title,
      initialDescriptionHtml: markdown_field(issuable, :description),
215 216
      initialDescriptionText: issuable.description,
      initialTaskStatus: issuable.task_status
217 218
    }

L
Luke "Jared" Bennett 已提交
219 220 221
    data.merge!(updated_at_by(issuable))

    data.to_json
222 223 224 225 226 227
  end

  def updated_at_by(issuable)
    return {} unless issuable.is_edited?

    {
228 229
      updatedAt: issuable.updated_at.to_time.iso8601,
      updatedBy: {
230 231 232 233 234 235
        name: issuable.last_edited_by.name,
        path: user_path(issuable.last_edited_by)
      }
    }
  end

236 237 238 239 240 241 242 243 244 245 246 247
  def issuables_count_for_state(issuable_type, state, finder: nil)
    finder ||= public_send("#{issuable_type}_finder")
    cache_key = finder.state_counter_cache_key(state)

    @counts ||= {}
    @counts[cache_key] ||= Rails.cache.fetch(cache_key, expires_in: 2.minutes) do
      finder.count_by_state
    end

    @counts[cache_key][state]
  end

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
  def close_issuable_path(issuable)
    params = state_event_hash(issuable, :close)
    params[:format] = 'json' if issuable.is_a?(Issue)

    issuable_path(issuable, params)
  end

  def reopen_issuable_path(issuable)
    params = state_event_hash(issuable, :reopen)
    params[:format] = 'json' if issuable.is_a?(Issue)

    issuable_path(issuable, params)
  end

  def close_reopen_issuable_path(issuable)
    issuable.closed? ? reopen_issuable_path(issuable) : close_issuable_path(issuable)
  end

  def issuable_path(issuable, *path_options)
    case issuable
    when Issue then issue_path(issuable, *path_options)
    when MergeRequest then merge_request_path(issuable, *path_options)
    else raise 'unknown issuable type'
    end
  end

  def issuable_url(issuable, *path_options)
    case issuable
    when Issue then issue_url(issuable, *path_options)
    when MergeRequest then merge_request_url(issuable, *path_options)
    else raise 'unknown issuable type'
    end
  end

282 283 284 285 286 287 288
  private

  def sidebar_gutter_collapsed?
    cookies[:collapsed_gutter] == 'true'
  end

  def base_issuable_scope(issuable)
289
    issuable.project.send(issuable.class.table_name).send(issuable_state_scope(issuable))
290 291 292
  end

  def issuable_state_scope(issuable)
293 294 295 296 297
    if issuable.respond_to?(:merged?) && issuable.merged?
      :merged
    else
      issuable.open? ? :opened : :closed
    end
298
  end
299

300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
  def issuable_templates(issuable)
    @issuable_templates ||=
      case issuable
      when Issue
        issue_template_names
      when MergeRequest
        merge_request_template_names
      else
        raise 'Unknown issuable type!'
      end
  end

  def merge_request_template_names
    @merge_request_templates ||= Gitlab::Template::MergeRequestTemplate.dropdown_names(ref_project)
  end

  def issue_template_names
    @issue_templates ||= Gitlab::Template::IssueTemplate.dropdown_names(ref_project)
  end

  def selected_template(issuable)
321
    params[:issuable_template] if issuable_templates(issuable).any?{ |template| template[:name] == params[:issuable_template] }
322
  end
P
Phil Hughes 已提交
323 324 325 326 327 328 329 330 331

  def issuable_todo_button_data(issuable, todo, is_collapsed)
    {
      todo_text: "Add todo",
      mark_text: "Mark done",
      todo_icon: (is_collapsed ? icon('plus-square') : nil),
      mark_icon: (is_collapsed ? icon('check-square', class: 'todo-undone') : nil),
      issuable_id: issuable.id,
      issuable_type: issuable.class.name.underscore,
332
      url: project_todos_path(@project),
P
Phil Hughes 已提交
333 334 335 336 337
      delete_path: (dashboard_todo_path(todo) if todo),
      placement: (is_collapsed ? 'left' : nil),
      container: (is_collapsed ? 'body' : nil)
    }
  end
338 339 340 341 342 343 344

  def state_event_hash(issuable, event_symbol)
    event_hash = {}
    event_hash[:"#{issuable.class.to_s.underscore}"] = { state_event: event_symbol }

    event_hash
  end
345
end