Module: IssuesHelper

Includes:
ApplicationHelper
Included in:
IssuesController, Redmine::Export::PDF
Defined in:
app/helpers/issues_helper.rb

Overview

Redmine - project management software Copyright (C) 2006-2014 Jean-Philippe Lang

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Defined Under Namespace

Classes: IssueFieldsRows

Constant Summary

Constants included from ApplicationHelper

ApplicationHelper::HEADING_RE, ApplicationHelper::MACROS_RE, ApplicationHelper::MACRO_SUB_RE, ApplicationHelper::TOC_RE

Instance Method Summary collapse

Methods included from ApplicationHelper

#accesskey, #anchor, #api_meta, #authoring, #authorize_for, #avatar, #back_url, #back_url_hidden_field_tag, #body_css_classes, #breadcrumb, #calendar_for, #catch_macros, #check_all_links, #checked_image, #context_menu, #current_theme, #delete_link, #due_date_distance_in_words, #email_delivery_enabled?, #error_messages_for, #favicon, #favicon_path, #favicon_url, #format_activity_day, #format_activity_description, #format_activity_title, #format_object, #format_version_name, #heads_for_theme, #html_hours, #html_title, #image_tag, #include_calendar_headers_tags, #include_in_api_response?, #inject_macros, #javascript_heads, #javascript_include_tag, #labelled_fields_for, #labelled_form_for, #lang_options_for_select, #link_to_attachment, #link_to_function, #link_to_if_authorized, #link_to_issue, #link_to_message, #link_to_project, #link_to_project_settings, #link_to_revision, #link_to_user, #link_to_version, #option_tag, #other_formats_links, #page_header_title, #parse_headings, #parse_inline_attachments, #parse_non_pre_blocks, #parse_redmine_links, #parse_sections, #parse_wiki_links, #preview_link, #principals_check_box_tags, #principals_options_for_select, #progress_bar, #project_tree, #project_tree_options_for_select, #raw_json, #render_flash_messages, #render_page_hierarchy, #render_project_jump_box, #render_project_nested_lists, #render_tabs, #reorder_links, #replace_toc, #robot_exclusion_tag, #sanitize_anchor_name, #sidebar_content?, #simple_format_without_paragraph, #stylesheet_link_tag, #syntax_highlight, #syntax_highlight_lines, #textilizable, #thumbnail_tag, #time_tag, #title, #to_path_param, #toggle_checkboxes_link, #toggle_link, #truncate_lines, #truncate_single_line_raw, #view_layouts_base_sidebar_hook_response, #wiki_page_path

Methods included from Redmine::Pagination::Helper

#pagination_links_each, #pagination_links_full, #per_page_links, #per_page_options

Methods included from Redmine::I18n

#current_language, #day_letter, #day_name, #find_language, #format_date, #format_time, included, #l, #l_hours, #l_or_humanize, #languages_options, #ll, #month_name, #set_language_if_valid, #valid_languages

Methods included from GravatarHelper::PublicMethods

#gravatar, #gravatar_api_url, #gravatar_for, #gravatar_url

Methods included from Redmine::WikiFormatting::Macros::Definitions

#exec_macro, #extract_macro_options, #macro_exists?

Instance Method Details

#bulk_edit_error_messages(issues) ⇒ Object

Returns an array of error messages for bulk edited issues


98
99
100
101
102
103
104
105
106
107
108
109
# File 'app/helpers/issues_helper.rb', line 98

def bulk_edit_error_messages(issues)
   messages = {}
   issues.each do |issue|
     issue.errors.full_messages.each do |message|
       messages[message] ||= []
       messages[message] << issue
     end
   end
   messages.map { |message, issues|
     "#{message}: " + issues.map {|i| "##{i.id}"}.join(', ')
   }
end

#details_to_strings(details, no_html = false, options = {}) ⇒ Object

Returns the textual representation of a journal details as an array of strings


259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# File 'app/helpers/issues_helper.rb', line 259

def details_to_strings(details, no_html=false, options={})
  options[:only_path] = (options[:only_path] == false ? false : true)
  strings = []
  values_by_field = {}
  details.each do |detail|
    if detail.property == 'cf'
      field = detail.custom_field
      if field && field.multiple?
        values_by_field[field] ||= {:added => [], :deleted => []}
        if detail.old_value
          values_by_field[field][:deleted] << detail.old_value
        end
        if detail.value
          values_by_field[field][:added] << detail.value
        end
        next
      end
    end
    strings << show_detail(detail, no_html, options)
  end
  values_by_field.each do |field, changes|
    detail = JournalDetail.new(:property => 'cf', :prop_key => field.id.to_s)
    detail.instance_variable_set "@custom_field", field
    if changes[:added].any?
      detail.value = changes[:added]
      strings << show_detail(detail, no_html, options)
    elsif changes[:deleted].any?
      detail.old_value = changes[:deleted]
      strings << show_detail(detail, no_html, options)
    end
  end
  strings
end

#email_issue_attributes(issue, user) ⇒ Object


235
236
237
238
239
240
241
242
243
244
245
246
# File 'app/helpers/issues_helper.rb', line 235

def email_issue_attributes(issue, user)
  items = []
  %w(author status priority assigned_to category fixed_version).each do |attribute|
    unless issue.disabled_core_fields.include?(attribute+"_id")
      items << "#{l("field_#{attribute}")}: #{issue.send attribute}"
    end
  end
  issue.visible_custom_field_values(user).each do |value|
    items << "#{value.custom_field.name}: #{show_value(value, false)}"
  end
  items
end

#find_name_by_reflection(field, id) ⇒ Object

Find the name of an associated record stored in the field attribute


403
404
405
406
407
408
409
410
411
412
413
414
415
# File 'app/helpers/issues_helper.rb', line 403

def find_name_by_reflection(field, id)
  unless id.present?
    return nil
  end
  association = Issue.reflect_on_association(field.to_sym)
  if association
    record = association.class_name.constantize.find_by_id(id)
    if record
      record.name.force_encoding('UTF-8')
      return record.name
    end
  end
end

#issue_fields_rows {|r| ... } ⇒ Object

Yields:

  • (r)

156
157
158
159
160
# File 'app/helpers/issues_helper.rb', line 156

def issue_fields_rows
  r = IssueFieldsRows.new
  yield r
  r.to_html
end

#issue_heading(issue) ⇒ Object


60
61
62
# File 'app/helpers/issues_helper.rb', line 60

def issue_heading(issue)
  h("#{issue.tracker} ##{issue.id}")
end

#issue_list(issues, &block) ⇒ Object


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

def issue_list(issues, &block)
  ancestors = []
  issues.each do |issue|
    while (ancestors.any? && !issue.is_descendant_of?(ancestors.last))
      ancestors.pop
    end
    yield issue, ancestors.size
    ancestors << issue unless issue.leaf?
  end
end

#issues_destroy_confirmation_message(issues) ⇒ Object


183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'app/helpers/issues_helper.rb', line 183

def issues_destroy_confirmation_message(issues)
  issues = [issues] unless issues.is_a?(Array)
  message = l(:text_issues_destroy_confirmation)
  descendant_count = issues.inject(0) {|memo, i| memo += (i.right - i.left - 1)/2}
  if descendant_count > 0
    issues.each do |issue|
      next if issue.root?
      issues.each do |other_issue|
        descendant_count -= 1 if issue.is_descendant_of?(other_issue)
      end
    end
    if descendant_count > 0
      message << "\n" + l(:text_issues_destroy_descendants_confirmation, :count => descendant_count)
    end
  end
  message
end

Returns a link for adding a new subtask to the given issue


112
113
114
115
116
117
118
# File 'app/helpers/issues_helper.rb', line 112

def link_to_new_subtask(issue)
  attrs = {
    :tracker_id => issue.tracker,
    :parent_issue_id => issue
  }
  link_to(l(:button_add), new_project_issue_path(issue.project, :issue => attrs))
end

212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'app/helpers/issues_helper.rb', line 212

def query_links(title, queries)
  return '' if queries.empty?  # links to #index on issues/show

  url_params = controller_name == 'issues' ? {:controller => 'issues', :action => 'index', :project_id => @project} : params

  ('h3', title) + "\n" +
    ('ul',
      queries.collect {|query|
          css = 'query'
          css << ' selected' if query == @query
          ('li', link_to(query.name, url_params.merge(:query_id => query), :class => css))
        }.join("\n").html_safe,
      :class => 'queries'
    ) + "\n"
end

#render_api_issue_children(issue, api) ⇒ Object

Renders issue children recursively


418
419
420
421
422
423
424
425
426
427
428
429
# File 'app/helpers/issues_helper.rb', line 418

def render_api_issue_children(issue, api)
  return if issue.leaf?
  api.array :children do
    issue.children.each do |child|
      api.issue(:id => child.id) do
        api.tracker(:id => child.tracker_id, :name => child.tracker.name) unless child.tracker.nil?
        api.subject child.subject
        render_api_issue_children(child, api)
      end
    end
  end
end

#render_custom_fields_rows(issue) ⇒ Object


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'app/helpers/issues_helper.rb', line 162

def render_custom_fields_rows(issue)
  values = issue.visible_custom_field_values
  return if values.empty?
  ordered_values = []
  half = (values.size / 2.0).ceil
  half.times do |i|
    ordered_values << values[i]
    ordered_values << values[i + half]
  end
  s = "<tr>\n"
  n = 0
  ordered_values.compact.each do |value|
    css = "cf_#{value.custom_field.id}"
    s << "</tr>\n<tr>\n" if n > 0 && (n % 2) == 0
    s << "\t<th class=\"#{css}\">#{ h(value.custom_field.name) }:</th><td class=\"#{css}\">#{ h(show_value(value)) }</td>\n"
    n += 1
  end
  s << "</tr>\n"
  s.html_safe
end

#render_descendants_tree(issue) ⇒ Object


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'app/helpers/issues_helper.rb', line 80

def render_descendants_tree(issue)
  s = '<form><table class="list issues">'
  issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
    css = "issue issue-#{child.id} hascontextmenu"
    css << " idnt idnt-#{level}" if level > 0
    s << ('tr',
           ('td', check_box_tag("ids[]", child.id, false, :id => nil), :class => 'checkbox') +
           ('td', link_to_issue(child, :truncate => 60, :project => (issue.project_id != child.project_id)), :class => 'subject') +
           ('td', h(child.status)) +
           ('td', link_to_user(child.assigned_to)) +
           ('td', progress_bar(child.done_ratio, :width => '80px')),
           :class => css)
  end
  s << '</table></form>'
  s.html_safe
end

#render_email_issue_attributes(issue, user, html = false) ⇒ Object


248
249
250
251
252
253
254
255
# File 'app/helpers/issues_helper.rb', line 248

def render_email_issue_attributes(issue, user, html=false)
  items = email_issue_attributes(issue, user)
  if html
    ('ul', items.map{|s| ('li', s)}.join("\n").html_safe)
  else
    items.map{|s| "* #{s}"}.join("\n")
  end
end

#render_issue_subject_with_tree(issue) ⇒ Object


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'app/helpers/issues_helper.rb', line 64

def render_issue_subject_with_tree(issue)
  s = ''
  ancestors = issue.root? ? [] : issue.ancestors.visible.to_a
  ancestors.each do |ancestor|
    s << '<div>' + ('p', link_to_issue(ancestor, :project => (issue.project_id != ancestor.project_id)))
  end
  s << '<div>'
  subject = h(issue.subject)
  if issue.is_private?
    subject = ('span', l(:field_is_private), :class => 'private') + ' ' + subject
  end
  s << ('h3', subject)
  s << '</div>' * (ancestors.size + 1)
  s.html_safe
end

#render_issue_tooltip(issue) ⇒ Object

Renders a HTML/CSS tooltip

To use, a trigger div is needed. This is a div with the class of “tooltip” that contains this method wrapped in a span with the class of “tip”

<div class="tooltip"><%= link_to_issue(issue) %>
  <span class="tip"><%= render_issue_tooltip(issue) %></span>
</div>

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

def render_issue_tooltip(issue)
  @cached_label_status ||= l(:field_status)
  @cached_label_start_date ||= l(:field_start_date)
  @cached_label_due_date ||= l(:field_due_date)
  @cached_label_assigned_to ||= l(:field_assigned_to)
  @cached_label_priority ||= l(:field_priority)
  @cached_label_project ||= l(:field_project)

  link_to_issue(issue) + "<br /><br />".html_safe +
    "<strong>#{@cached_label_project}</strong>: #{link_to_project(issue.project)}<br />".html_safe +
    "<strong>#{@cached_label_status}</strong>: #{h(issue.status.name)}<br />".html_safe +
    "<strong>#{@cached_label_start_date}</strong>: #{format_date(issue.start_date)}<br />".html_safe +
    "<strong>#{@cached_label_due_date}</strong>: #{format_date(issue.due_date)}<br />".html_safe +
    "<strong>#{@cached_label_assigned_to}</strong>: #{h(issue.assigned_to)}<br />".html_safe +
    "<strong>#{@cached_label_priority}</strong>: #{h(issue.priority.name)}".html_safe
end

#render_sidebar_queriesObject


228
229
230
231
232
233
# File 'app/helpers/issues_helper.rb', line 228

def render_sidebar_queries
  out = ''.html_safe
  out << query_links(l(:label_my_queries), sidebar_queries.select(&:is_private?))
  out << query_links(l(:label_query_plural), sidebar_queries.reject(&:is_private?))
  out
end

#show_detail(detail, no_html = false, options = {}) ⇒ Object

Returns the textual representation of a single journal detail


294
295
296
297
298
299
300
301
302
303
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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
# File 'app/helpers/issues_helper.rb', line 294

def show_detail(detail, no_html=false, options={})
  multiple = false
  case detail.property
  when 'attr'
    field = detail.prop_key.to_s.gsub(/\_id$/, "")
    label = l(("field_" + field).to_sym)
    case detail.prop_key
    when 'due_date', 'start_date'
      value = format_date(detail.value.to_date) if detail.value
      old_value = format_date(detail.old_value.to_date) if detail.old_value

    when 'project_id', 'status_id', 'tracker_id', 'assigned_to_id',
          'priority_id', 'category_id', 'fixed_version_id'
      value = find_name_by_reflection(field, detail.value)
      old_value = find_name_by_reflection(field, detail.old_value)

    when 'estimated_hours'
      value = "%0.02f" % detail.value.to_f unless detail.value.blank?
      old_value = "%0.02f" % detail.old_value.to_f unless detail.old_value.blank?

    when 'parent_id'
      label = l(:field_parent_issue)
      value = "##{detail.value}" unless detail.value.blank?
      old_value = "##{detail.old_value}" unless detail.old_value.blank?

    when 'is_private'
      value = l(detail.value == "0" ? :general_text_No : :general_text_Yes) unless detail.value.blank?
      old_value = l(detail.old_value == "0" ? :general_text_No : :general_text_Yes) unless detail.old_value.blank?
    end
  when 'cf'
    custom_field = detail.custom_field
    if custom_field
      multiple = custom_field.multiple?
      label = custom_field.name
      value = format_value(detail.value, custom_field) if detail.value
      old_value = format_value(detail.old_value, custom_field) if detail.old_value
    end
  when 'attachment'
    label = l(:label_attachment)
  when 'relation'
    if detail.value && !detail.old_value
      rel_issue = Issue.visible.find_by_id(detail.value)
      value = rel_issue.nil? ? "#{l(:label_issue)} ##{detail.value}" :
                (no_html ? rel_issue : link_to_issue(rel_issue, :only_path => options[:only_path]))
    elsif detail.old_value && !detail.value
      rel_issue = Issue.visible.find_by_id(detail.old_value)
      old_value = rel_issue.nil? ? "#{l(:label_issue)} ##{detail.old_value}" :
                        (no_html ? rel_issue : link_to_issue(rel_issue, :only_path => options[:only_path]))
    end
    relation_type = IssueRelation::TYPES[detail.prop_key]
    label = l(relation_type[:name]) if relation_type
  end
  call_hook(:helper_issues_show_detail_after_setting,
            {:detail => detail, :label => label, :value => value, :old_value => old_value })

  label ||= detail.prop_key
  value ||= detail.value
  old_value ||= detail.old_value

  unless no_html
    label = ('strong', label)
    old_value = ("i", h(old_value)) if detail.old_value
    if detail.old_value && detail.value.blank? && detail.property != 'relation'
      old_value = ("del", old_value)
    end
    if detail.property == 'attachment' && !value.blank? && atta = Attachment.find_by_id(detail.prop_key)      # Link to the attachment if it has not been removed

      value = link_to_attachment(atta, :download => true, :only_path => options[:only_path])
      if options[:only_path] != false && atta.is_text?
        value += link_to(
                     image_tag('magnifier.png'),
                     :controller => 'attachments', :action => 'show',
                     :id => atta, :filename => atta.filename
                   )
      end
    else
      value = ("i", h(value)) if value
    end
  end

  if detail.property == 'attr' && detail.prop_key == 'description'
    s = l(:text_journal_changed_no_detail, :label => label)
    unless no_html
      diff_link = link_to 'diff',
        {:controller => 'journals', :action => 'diff', :id => detail.journal_id,
         :detail_id => detail.id, :only_path => options[:only_path]},
        :title => l(:label_view_diff)
      s << " (#{ diff_link })"
    end
    s.html_safe
  elsif detail.value.present?
    case detail.property
    when 'attr', 'cf'
      if detail.old_value.present?
        l(:text_journal_changed, :label => label, :old => old_value, :new => value).html_safe
      elsif multiple
        l(:text_journal_added, :label => label, :value => value).html_safe
      else
        l(:text_journal_set_to, :label => label, :value => value).html_safe
      end
    when 'attachment', 'relation'
      l(:text_journal_added, :label => label, :value => value).html_safe
    end
  else
    l(:text_journal_deleted, :label => label, :old => old_value).html_safe
  end
end

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

def sidebar_queries
  unless @sidebar_queries
    @sidebar_queries = IssueQuery.visible.
      order("#{Query.table_name}.name ASC").
      # Project specific queries and global queries
      where(@project.nil? ? ["project_id IS NULL"] : ["project_id IS NULL OR project_id = ?", @project.id]).
      to_a
  end
  @sidebar_queries
end