Module: IssuesHelper

Includes:
ApplicationHelper, IssueStatusesHelper, Redmine::Export::PDF::IssuesPdfHelper
Defined in:
app/helpers/issues_helper.rb

Overview

Redmine - project management software Copyright (C) 2006-2021 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, MultipleValuesDetail

Constant Summary

Constants included from ApplicationHelper

ApplicationHelper::ATTACHMENT_CONTAINER_LINK, ApplicationHelper::HEADING_RE, ApplicationHelper::LINKS_RE, ApplicationHelper::MACROS_RE, ApplicationHelper::MACRO_SUB_RE, ApplicationHelper::RECORD_LINK, ApplicationHelper::TOC_RE

Instance Method Summary collapse

Methods included from IssueStatusesHelper

#issue_status_type_badge

Methods included from Redmine::Export::PDF::IssuesPdfHelper

#calc_col_width, #fetch_row_values, #get_issues_to_pdf_write_cells, #is_cjk?, #issue_to_pdf, #issues_to_pdf, #issues_to_pdf_draw_borders, #issues_to_pdf_write_cells, #render_table_header

Methods included from ApplicationHelper

#accesskey, #actions_dropdown, #anchor, #api_meta, #authoring, #authorize_for, #autocomplete_data_sources, #back_url_hidden_field_tag, #body_css_classes, #breadcrumb, #bulk_edit_error_messages, #calendar_for, #cancel_button_tag, #catch_macros, #check_all_links, #checked_image, #context_menu, #copy_object_url_link, #default_search_project_scope, #delete_link, #due_date_distance_in_words, #email_delivery_enabled?, #error_messages_for, #export_csv_encoding_select_tag, #favicon, #favicon_path, #favicon_url, #form_tag_html, #format_activity_day, #format_activity_description, #format_activity_title, #format_changeset_comments, #format_object, #format_version_name, #get_tab_action, #heads_for_auto_complete, #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_attachment_container, #link_to_context_menu, #link_to_function, #link_to_group, #link_to_if_authorized, #link_to_issue, #link_to_message, #link_to_month, #link_to_next_month, #link_to_previous_month, #link_to_project, #link_to_project_settings, #link_to_record, #link_to_revision, #link_to_user, #link_to_version, #option_tag, #other_formats_links, #page_header_title, #parse_headings, #parse_hires_images, #parse_inline_attachments, #parse_non_pre_blocks, #parse_redmine_links, #parse_sections, #parse_wiki_links, #principals_check_box_tags, #principals_options_for_select, #progress_bar, #project_tree, #project_tree_options_for_select, #projects_for_jump_box, #raw_json, #render_error_messages, #render_flash_messages, #render_if_exist, #render_page_hierarchy, #render_project_jump_box, #render_project_nested_lists, #render_projects_for_jump_box, #render_tabs, #reorder_handle, #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::Helpers::URL

#uri_with_safe_scheme?

Methods included from Redmine::Hook::Helper

#call_hook

Methods included from Redmine::Themes::Helper

#current_theme, #heads_for_theme

Methods included from Redmine::SudoMode::Helper

#hash_to_hidden_fields

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_hours, #format_time, included, #l, #l_hours, #l_hours_short, #l_or_humanize, #languages_options, #ll, #lu, #month_name, #set_language_if_valid, #valid_languages

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

#exec_macro, #extract_macro_options, #macro_exists?

Instance Method Details

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

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


471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'app/helpers/issues_helper.rb', line 471

def details_to_strings(details, no_html=false, options={})
  options[:only_path] = !(options[:only_path] == false)
  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
  if values_by_field.present?
    values_by_field.each do |field, changes|
      if changes[:added].any?
        detail = MultipleValuesDetail.new('cf', field.id.to_s, field)
        detail.value = changes[:added]
        strings << show_detail(detail, no_html, options)
      end
      if changes[:deleted].any?
        detail = MultipleValuesDetail.new('cf', field.id.to_s, field)
        detail.old_value = changes[:deleted]
        strings << show_detail(detail, no_html, options)
      end
    end
  end
  strings
end

#email_issue_attributes(issue, user, html) ⇒ Object 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'app/helpers/issues_helper.rb', line 431

def email_issue_attributes(issue, user, html)
  items = []
  %w(author status priority assigned_to category fixed_version start_date due_date).each do |attribute|
    if issue.disabled_core_fields.grep(/^#{attribute}(_id)?$/).empty?
      attr_value = (issue.send attribute).to_s
      next if attr_value.blank?

      if html
        items << content_tag('strong', "#{l("field_#{attribute}")}: ") + attr_value
      else
        items << "#{l("field_#{attribute}")}: #{attr_value}"
      end
    end
  end
  issue.visible_custom_field_values(user).each do |value|
    cf_value = show_value(value, false)
    next if cf_value.blank?

    if html
      items << content_tag('strong', "#{value.custom_field.name}: ") + cf_value
    else
      items << "#{value.custom_field.name}: #{cf_value}"
    end
  end
  items
end

#find_name_by_reflection(field, id) ⇒ Object

Find the name of an associated record stored in the field attribute For project, return the associated record only if is visible for the current User


641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'app/helpers/issues_helper.rb', line 641

def find_name_by_reflection(field, id)
  return nil if id.blank?

  @detail_value_name_by_reflection ||= Hash.new do |hash, key|
    association = Issue.reflect_on_association(key.first.to_sym)
    name = nil
    if association
      record = association.klass.find_by_id(key.last)
      if (record && !record.is_a?(Project)) || (record.is_a?(Project) && record.visible?)
        name = record.name.force_encoding('UTF-8')
      end
    end
    hash[key] = name
  end
  @detail_value_name_by_reflection[[field, id]]
end

#grouped_issue_list(issues, query, &block) ⇒ Object 


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

def grouped_issue_list(issues, query, &block)
  ancestors = []
  grouped_query_results(issues, query) do |issue, group_name, group_count, group_totals|
    while ancestors.any? &&
          !issue.is_descendant_of?(ancestors.last)
      ancestors.pop
    end
    yield issue, ancestors.size, group_name, group_count, group_totals
    ancestors << issue unless issue.leaf?
  end
end

#issue_due_date_details(issue) ⇒ Object 


274
275
276
277
278
279
280
 
# File 'app/helpers/issues_helper.rb', line 274

def issue_due_date_details(issue)
  return if issue&.due_date.nil?

  s = format_date(issue.due_date)
  s += " (#{due_date_distance_in_words(issue.due_date)})" unless issue.closed?
  s
end

#issue_estimated_hours_details(issue) ⇒ Object 


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

def issue_estimated_hours_details(issue)
  if issue.total_estimated_hours.present?
    if issue.total_estimated_hours == issue.estimated_hours
      l_hours_short(issue.estimated_hours)
    else
      s = issue.estimated_hours.present? ? l_hours_short(issue.estimated_hours) : ""
      s += " (#{l(:label_total)}: #{l_hours_short(issue.total_estimated_hours)})"
      s.html_safe
    end
  end
end

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

Yields:

  • (r) 

350
351
352
353
354
 
# File 'app/helpers/issues_helper.rb', line 350

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

#issue_heading(issue) ⇒ Object 


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

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

#issue_history_default_tab ⇒ Object 


731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'app/helpers/issues_helper.rb', line 731

def issue_history_default_tab
  # tab params overrides user default tab preference
  return params[:tab] if params[:tab].present?

  user_default_tab = User.current.pref.history_default_tab

  case user_default_tab
  when 'last_tab_visited'
    cookies['history_last_tab'].presence || 'notes'
  when ''
    'notes'
  else
    user_default_tab
  end
end

#issue_history_tabs ⇒ Object

Issue history tabs


674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'app/helpers/issues_helper.rb', line 674

def issue_history_tabs
  tabs = []
  if @journals.present?
    journals_without_notes = @journals.select{|value| value.notes.blank?}
    journals_with_notes = @journals.reject{|value| value.notes.blank?}
    tabs <<
      {
        :name => 'history',
        :label => :label_history,
        :onclick => 'showIssueHistory("history", this.href)',
        :partial => 'issues/tabs/history',
        :locals => {:issue => @issue, :journals => @journals}
      }
    if journals_with_notes.any?
      tabs <<
        {
          :name => 'notes',
          :label => :label_issue_history_notes,
          :onclick => 'showIssueHistory("notes", this.href)'
        }
    end
    if journals_without_notes.any?
      tabs <<
        {
          :name => 'properties',
          :label => :label_issue_history_properties,
          :onclick => 'showIssueHistory("properties", this.href)'
        }
    end
  end
  if User.current.allowed_to?(:view_time_entries, @project) && @issue.spent_hours > 0
    tabs <<
      {
        :name => 'time_entries',
        :label => :label_time_entry_plural,
        :remote => true,
        :onclick =>
          "getRemoteTab('time_entries', " \
          "'#{tab_issue_path(@issue, :name => 'time_entries')}', " \
          "'#{issue_path(@issue, :tab => 'time_entries')}')"
      }
  end
  if @has_changesets
    tabs <<
      {
        :name => 'changesets',
        :label => :label_associated_revisions,
        :remote => true,
        :onclick =>
          "getRemoteTab('changesets', " \
          "'#{tab_issue_path(@issue, :name => 'changesets')}', " \
          "'#{issue_path(@issue, :tab => 'changesets')}')"
      }
  end
  tabs
end

#issue_list(issues, &block) ⇒ Object 


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

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

#issue_spent_hours_details(issue) ⇒ Object 


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

def issue_spent_hours_details(issue)
  if issue.total_spent_hours > 0
    path = project_time_entries_path(issue.project, :issue_id => "~#{issue.id}")

    if issue.total_spent_hours == issue.spent_hours
      link_to(l_hours_short(issue.spent_hours), path)
    else
      s = issue.spent_hours > 0 ? l_hours_short(issue.spent_hours) : ""
      s += " (#{l(:label_total)}: #{link_to l_hours_short(issue.total_spent_hours), path})"
      s.html_safe
    end
  end
end

#issues_descendant_count(issues) ⇒ Object

Returns the number of descendants for an array of issues


403
404
405
406
407
 
# File 'app/helpers/issues_helper.rb', line 403

def issues_descendant_count(issues)
  ids = issues.reject(&:leaf?).map {|issue| issue.descendants.ids}.flatten.uniq
  ids -= issues.map(&:id)
  ids.size
end

#issues_destroy_confirmation_message(issues) ⇒ Object 


409
410
411
412
413
414
415
416
417
418
 
# File 'app/helpers/issues_helper.rb', line 409

def issues_destroy_confirmation_message(issues)
  issues = [issues] unless issues.is_a?(Array)
  message = l(:text_issues_destroy_confirmation)

  descendant_count = issues_descendant_count(issues)
  if descendant_count > 0
    message << "\n" + l(:text_issues_destroy_descendants_confirmation, :count => descendant_count)
  end
  message
end

#link_to_new_subtask(issue) ⇒ Object

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


283
284
285
 
# File 'app/helpers/issues_helper.rb', line 283

def link_to_new_subtask(issue)
  link_to(l(:button_add), url_for_new_subtask(issue))
end

#projects_for_select(issue) ⇒ Object 


747
748
749
750
751
752
753
754
755
 
# File 'app/helpers/issues_helper.rb', line 747

def projects_for_select(issue)
  if issue.parent_issue_id.present?
    issue.allowed_target_projects_for_subtask(User.current)
  elsif @project && issue.new_record? && !issue.copy?
    issue.allowed_target_projects(User.current, 'tree')
  else
    issue.allowed_target_projects(User.current)
  end
end

#render_api_issue_children(issue, api) ⇒ Object

Renders issue children recursively


659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'app/helpers/issues_helper.rb', line 659

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_descendants_stats(issue) ⇒ Object

Renders descendants stats (total descendants (open - closed)) with query links


147
148
149
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
180
181
182
183
184
185
186
187
188
189
190
 
# File 'app/helpers/issues_helper.rb', line 147

def render_descendants_stats(issue)
  # Get issue descendants grouped by status type (open/closed) using a single query
  subtasks_grouped = issue.descendants.visible.joins(:status).select(:is_closed, :id).group(:is_closed).reorder(:is_closed).count(:id)
  # Cast keys to boolean in order to have consistent results between database types
  subtasks_grouped.transform_keys! {|k| ActiveModel::Type::Boolean.new.cast(k)}

  open_subtasks = subtasks_grouped[false].to_i
  closed_subtasks = subtasks_grouped[true].to_i
  all_subtasks = open_subtasks + closed_subtasks

  return if all_subtasks == 0

  all_block = content_tag(
    'span',
    link_to(all_subtasks, issues_path(parent_id: "~#{issue.id}", set_filter: true, status_id: '*')),
    class: 'badge badge-issues-count'
  )

  closed_block = content_tag(
    'span',
    link_to_if(
      closed_subtasks > 0,
      l(:label_x_closed_issues_abbr, count: closed_subtasks),
      issues_path(parent_id: "~#{issue.id}", set_filter: true, status_id: 'c')
    ),
    class: 'closed'
  )

  open_block = content_tag(
    'span',
    link_to_if(
      open_subtasks > 0,
      l(:label_x_open_issues_abbr, :count => open_subtasks),
      issues_path(:parent_id => "~#{issue.id}", :set_filter => true, :status_id => 'o')
    ),
    class: 'open'
  )

  content_tag(
    'span',
    "#{all_block} (#{open_block} &#8212; #{closed_block})".html_safe,
    :class => 'issues-stat'
  )
end

#render_descendants_tree(issue) ⇒ Object 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'app/helpers/issues_helper.rb', line 92

def render_descendants_tree(issue)
  manage_relations = User.current.allowed_to?(:manage_subtasks, issue.project)
  s = +'<table class="list issues odd-even">'
  issue_list(
    issue.descendants.visible.
      preload(:status, :priority, :tracker,
              :assigned_to).sort_by(&:lft)) do |child, level|
    css = +"issue issue-#{child.id} hascontextmenu #{child.css_classes}"
    css << " idnt idnt-#{level}" if level > 0
    buttons =
      if manage_relations
        link_to(
          l(:label_delete_link_to_subtask),
          issue_path(
            {:id => child.id, :issue => {:parent_issue_id => ''},
             :back_url => issue_path(issue.id), :no_flash => '1'}
          ),
          :method => :put,
          :data => {:confirm => l(:text_are_you_sure)},
          :title => l(:label_delete_link_to_subtask),
          :class => 'icon-only icon-link-break'
        )
      else
        "".html_safe
      end
    buttons << link_to_context_menu
    s <<
      content_tag(
        'tr',
        content_tag('td', check_box_tag("ids[]", child.id, false, :id => nil),
                    :class => 'checkbox') +
           content_tag('td',
                       link_to_issue(
                         child,
                         :project => (issue.project_id != child.project_id)),
                       :class => 'subject') +
           content_tag('td', h(child.status), :class => 'status') +
           content_tag('td', link_to_user(child.assigned_to), :class => 'assigned_to') +
           content_tag('td', format_date(child.start_date), :class => 'start_date') +
           content_tag('td', format_date(child.due_date), :class => 'due_date') +
           content_tag('td',
                       (if child.disabled_core_fields.include?('done_ratio')
                          ''
                        else
                          progress_bar(child.done_ratio)
                        end),
                       :class=> 'done_ratio') +
           content_tag('td', buttons, :class => 'buttons'),
        :class => css)
  end
  s << '</table>'
  s.html_safe
end

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


458
459
460
461
462
463
464
465
 
# File 'app/helpers/issues_helper.rb', line 458

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

#render_full_width_custom_fields_rows(issue) ⇒ Object 


369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'app/helpers/issues_helper.rb', line 369

def render_full_width_custom_fields_rows(issue)
  values = issue.visible_custom_field_values.select {|value| value.custom_field.full_width_layout?}
  return if values.empty?

  s = ''.html_safe
  values.each_with_index do |value, i|
    attr_value_tag = custom_field_value_tag(value)
    next if attr_value_tag.blank?

    content =
      content_tag('hr') +
      content_tag('p', content_tag('strong', custom_field_name_tag(value.custom_field) )) +
      content_tag('div', attr_value_tag, class: 'value')
    s << content_tag('div', content, class: "#{value.custom_field.css_classes} attribute")
  end
  s
end

#render_half_width_custom_fields_rows(issue) ⇒ Object 


356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'app/helpers/issues_helper.rb', line 356

def render_half_width_custom_fields_rows(issue)
  values = issue.visible_custom_field_values.reject {|value| value.custom_field.full_width_layout?}
  return if values.empty?

  half = (values.size / 2.0).ceil
  issue_fields_rows do |rows|
    values.each_with_index do |value, i|
      m = (i < half ? :left : :right)
      rows.send m, custom_field_name_tag(value.custom_field), custom_field_value_tag(value), :class => value.custom_field.css_classes
    end
  end
end

#render_issue_relations(issue, relations) ⇒ Object

Renders the list of related issues on the issue details view


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'app/helpers/issues_helper.rb', line 193

def render_issue_relations(issue, relations)
  manage_relations = User.current.allowed_to?(:manage_issue_relations, issue.project)
  s = ''.html_safe
  relations.each do |relation|
    other_issue = relation.other_issue(issue)
    css = "issue hascontextmenu #{other_issue.css_classes}"
    buttons =
      if manage_relations
        link_to(
          l(:label_relation_delete),
          relation_path(relation),
          :remote => true,
          :method => :delete,
          :data => {:confirm => l(:text_are_you_sure)},
          :title => l(:label_relation_delete),
          :class => 'icon-only icon-link-break'
        )
      else
        "".html_safe
      end
    buttons << link_to_context_menu
    s <<
      content_tag(
        'tr',
        content_tag('td',
                    check_box_tag(
                      "ids[]", other_issue.id,
                      false, :id => nil),
                    :class => 'checkbox') +
           content_tag('td',
                       relation.to_s(@issue) do |other|
                         link_to_issue(
                           other,
                           :project => Setting.cross_project_issue_relations?
                         )
                       end.html_safe,
                       :class => 'subject') +
           content_tag('td', other_issue.status, :class => 'status') +
           content_tag('td', link_to_user(other_issue.assigned_to), :class => 'assigned_to') +
           content_tag('td', format_date(other_issue.start_date), :class => 'start_date') +
           content_tag('td', format_date(other_issue.due_date), :class => 'due_date') +
           content_tag('td',
                       (if other_issue.disabled_core_fields.include?('done_ratio')
                          ''
                        else
                          progress_bar(other_issue.done_ratio)
                        end),
                       :class=> 'done_ratio') +
           content_tag('td', buttons, :class => 'buttons'),
        :id => "relation-#{relation.id}",
        :class => css)
  end
  content_tag('table', s, :class => 'list issues odd-even')
end

#render_issue_subject_with_tree(issue) ⇒ Object 


79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'app/helpers/issues_helper.rb', line 79

def render_issue_subject_with_tree(issue)
  s = +''
  ancestors = issue.root? ? [] : issue.ancestors.visible.to_a
  ancestors.each do |ancestor|
    s << '<div>' + content_tag('p', link_to_issue(ancestor, :project => (issue.project_id != ancestor.project_id)))
  end
  s << '<div>'
  subject = h(issue.subject)
  s << content_tag('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>


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'app/helpers/issues_helper.rb', line 58

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) + (" (#{format_date(issue.closed_on)})" if issue.closed?)}<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>: #{avatar(issue.assigned_to, :size => '13', :title => l(:field_assigned_to)) if issue.assigned_to} #{h(issue.assigned_to)}<br />".html_safe +
    "<strong>#{@cached_label_priority}</strong>: #{h(issue.priority.name)}".html_safe
end

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

Returns the textual representation of a single journal detail


509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'app/helpers/issues_helper.rb', line 509

def show_detail(detail, no_html=false, options={})
  multiple = false
  show_diff = false
  no_details = 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 = l_hours_short(detail.value.to_f) unless detail.value.blank?
      old_value = l_hours_short(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?

    when 'description'
      show_diff = true
    end
  when 'cf'
    custom_field = detail.custom_field
    if custom_field
      label = custom_field.name
      if custom_field.format.class.change_no_details
        no_details = true
      elsif custom_field.format.class.change_as_diff
        show_diff = true
      else
        multiple = custom_field.multiple?
        value = format_value(detail.value, custom_field) if detail.value
        old_value = format_value(detail.old_value, custom_field) if detail.old_value
      end
    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 =
        if rel_issue.nil?
          "#{l(:label_issue)} ##{detail.value}"
        else
          (no_html ? rel_issue : link_to_issue(rel_issue, :only_path => options[:only_path]))
        end
    elsif detail.old_value && !detail.value
      rel_issue = Issue.visible.find_by_id(detail.old_value)
      old_value =
        if rel_issue.nil?
          "#{l(:label_issue)} ##{detail.old_value}"
        else
          (no_html ? rel_issue : link_to_issue(rel_issue, :only_path => options[:only_path]))
        end
    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 = content_tag('strong', label)
    old_value = content_tag("i", h(old_value)) if detail.old_value
    if detail.old_value && detail.value.blank? && detail.property != 'relation'
      old_value = content_tag("del", old_value)
    end
    if detail.property == 'attachment' && value.present? &&
        atta = detail.journal.journalized.attachments.detect {|a| a.id == detail.prop_key.to_i}
      # Link to the attachment if it has not been removed
      value = link_to_attachment(atta, only_path: options[:only_path])
      if options[:only_path] != false
        value += ' '
        value += link_to_attachment atta, class: 'icon-only icon-download', title: l(:button_download), download: true
      end
    else
      value = content_tag("i", h(value)) if value
    end
  end

  if no_details
    s = l(:text_journal_changed_no_detail, :label => label).html_safe
  elsif show_diff
    s = l(:text_journal_changed_no_detail, :label => label)
    unless no_html
      diff_link =
        link_to(
          l(:label_diff),
          diff_journal_url(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

#trackers_for_select(issue) ⇒ Object 


302
303
304
305
306
307
308
309
310
 
# File 'app/helpers/issues_helper.rb', line 302

def trackers_for_select(issue)
  trackers = issue.allowed_target_trackers
  if issue.new_record? && issue.parent_issue_id.present?
    trackers = trackers.reject do |tracker|
      issue.tracker_id != tracker.id && tracker.disabled_core_fields.include?('parent_issue_id')
    end
  end
  trackers
end

#trackers_options_for_select(issue) ⇒ Object 


297
298
299
300
 
# File 'app/helpers/issues_helper.rb', line 297

def trackers_options_for_select(issue)
  trackers = trackers_for_select(issue)
  trackers.collect {|t| [t.name, t.id]}
end

#update_issue_form_path(project, issue) ⇒ Object

Returns the path for updating the issue form with project as the current project


389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'app/helpers/issues_helper.rb', line 389

def update_issue_form_path(project, issue)
  options = {:format => 'js'}
  if issue.new_record?
    if project
      new_project_issue_path(project, options)
    else
      new_issue_path(options)
    end
  else
    edit_issue_path(issue, options)
  end
end

#url_for_new_subtask(issue) ⇒ Object 


287
288
289
290
291
292
293
294
295
 
# File 'app/helpers/issues_helper.rb', line 287

def url_for_new_subtask(issue)
  attrs = {
    :parent_issue_id => issue
  }
  attrs[:tracker_id] = issue.tracker unless issue.tracker.disabled_core_fields.include?('parent_issue_id')
  params = {:issue => attrs}
  params[:back_url] = issue_path(issue) if controller_name == 'issues' && action_name == 'show'
  new_project_issue_path(issue.project, params)
end

#users_for_new_issue_watchers(issue) ⇒ Object

Returns an array of users that are proposed as watchers on the new issue form


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

def users_for_new_issue_watchers(issue)
  users = issue.watcher_users.select{|u| u.status == User::STATUS_ACTIVE}
  assignable_watchers = issue.project.principals.assignable_watchers.limit(21)
  if assignable_watchers.size <= 20
    users += assignable_watchers.sort
  end
  users.uniq
end