Module: IssuesHelper

Includes:
ApplicationHelper
Included in:
IssuesController
Defined in:
app/helpers/issues_helper.rb

Overview

– copyright ChiliProject is a project management system.

Copyright (C) 2010-2013 the ChiliProject Team

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.

See doc/COPYRIGHT.rdoc for more details. ++

Constant Summary

Constants included from ApplicationHelper

ApplicationHelper::HEADING_RE, ApplicationHelper::RELATIVE_LINK_RE, ApplicationHelper::TOC_RE

Instance Method Summary collapse

Methods included from ApplicationHelper

#accesskey, #api_meta, #authoring, #authorize_for, #avatar, #back_url_hidden_field_tag, #body_css_classes, #breadcrumb, #calendar_for, #check_all_links, #checked_image, #content_for, #context_menu, #context_menu_link, #current_theme, #due_date_distance_in_words, #expand_current_menu, #favicon, #format_activity_day, #format_activity_description, #format_activity_title, #format_version_name, #gravatar, #has_content?, #heads_for_theme, #help_menu_item, #html_hours, #html_title, #image_to_function, #include_in_api_response?, #javascript_heads, #jquery_datepicker_settings, #label_tag_for, #labelled_tabular_form_for, #lang_options_for_select, #link_to_attachment, #link_to_if_authorized, #link_to_issue, #link_to_message, #link_to_project, #link_to_remote_if_authorized, #link_to_revision, #link_to_user, #list_users, #main_top_menu_items, #more_top_menu_items, #other_formats_links, #page_header_title, #pagination_links_full, #parse_headings, #parse_inline_attachments, #parse_non_pre_blocks, #parse_redmine_links, #parse_relative_urls, #parse_wiki_links, #path_to_stylesheet, #per_page_links, #principals_check_box_tags, #progress_bar, #project_nested_ul, #project_tree, #project_tree_options_for_select, #projects_check_box_tags, #prompt_to_remote, #render_flash_messages, #render_page_hierarchy, #render_project_jump_box, #render_tabs, #reorder_links, #replace_toc, #robot_exclusion_tag, #simple_format_without_paragraph, #split_top_menu_into_main_or_more_menus, #stylesheet_path, #syntax_highlight, #textilizable, #time_tag, #to_path_param, #toggle_link, #truncate_lines, #truncate_single_line

Methods included from Redmine::I18n

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

Instance Method Details

#find_name_by_reflection(field, id) ⇒ Object

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


151
152
153
154
155
156
157
# File 'app/helpers/issues_helper.rb', line 151

def find_name_by_reflection(field, id)
  association = Issue.reflect_on_association(field.to_sym)
  if association
    record = association.class_name.constantize.find_by_id(id)
    return record.name if record
  end
end

#issue_list(issues, &block) ⇒ Object


18
19
20
21
22
23
24
25
26
27
# File 'app/helpers/issues_helper.rb', line 18

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_to_csv(issues, project = nil) ⇒ Object


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
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
# File 'app/helpers/issues_helper.rb', line 173

def issues_to_csv(issues, project = nil)
  ic = Iconv.new(l(:general_csv_encoding), 'UTF-8')
  decimal_separator = l(:general_csv_decimal_separator)
  export = FCSV.generate(:col_sep => l(:general_csv_separator)) do |csv|
    # csv header fields
    headers = [ "#",
                l(:field_status),
                l(:field_project),
                l(:field_tracker),
                l(:field_priority),
                l(:field_subject),
                l(:field_assigned_to),
                l(:field_category),
                l(:field_fixed_version),
                l(:field_author),
                l(:field_start_date),
                l(:field_due_date),
                l(:field_done_ratio),
                l(:field_estimated_hours),
                l(:field_parent_issue),
                l(:field_created_on),
                l(:field_updated_on)
                ]
    # Export project custom fields if project is given
    # otherwise export custom fields marked as "For all projects"
    custom_fields = project.nil? ? IssueCustomField.for_all : project.all_issue_custom_fields
    custom_fields.each {|f| headers << f.name}
    # Description in the last column
    headers << l(:field_description)
    csv << headers.collect {|c| begin; ic.iconv(c.to_s); rescue; c.to_s; end }
    # csv lines
    issues.each do |issue|
      fields = [issue.id,
                issue.status.name,
                issue.project.name,
                issue.tracker.name,
                issue.priority.name,
                issue.subject,
                issue.assigned_to,
                issue.category,
                issue.fixed_version,
                issue.author.name,
                format_date(issue.start_date),
                format_date(issue.due_date),
                issue.done_ratio,
                issue.estimated_hours.to_s.gsub('.', decimal_separator),
                issue.parent_id,
                format_time(issue.created_on),
                format_time(issue.updated_on)
                ]
      custom_fields.each {|f| fields << show_value(issue.custom_value_for(f)) }
      fields << issue.description
      csv << fields.collect {|c| begin; ic.iconv(c.to_s); rescue; c.to_s; end }
    end
  end
  export
end

131
132
133
134
135
136
137
138
139
# File 'app/helpers/issues_helper.rb', line 131

def query_links(title, queries)
  # links to #index on issues/show
  url_params = controller_name == 'issues' ? {:controller => 'issues', :action => 'index', :project_id => @project} : params

  ('h3', h(title)) +
    queries.collect {|query|
        link_to(h(query.name), url_params.merge(:query_id => query))
      }.join('<br />')
end

#render_api_issue_children(issue, api) ⇒ Object

Renders issue children recursively


160
161
162
163
164
165
166
167
168
169
170
171
# File 'app/helpers/issues_helper.rb', line 160

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


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'app/helpers/issues_helper.rb', line 98

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

#render_descendants_tree(issue) ⇒ Object


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

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

#render_issue_subject_with_tree(issue) ⇒ Object

TODO: deprecate and/or remove


56
57
58
59
60
61
62
63
64
65
# File 'app/helpers/issues_helper.rb', line 56

def render_issue_subject_with_tree(issue)
  s = ''
  ancestors = issue.root? ? [] : issue.ancestors.all
  ancestors.each do |ancestor|
    s << '<div>' + ('h2', link_to_issue(ancestor))
  end
  s << '<div class="subject">' + ('h2', h(issue.subject))
  s << '</div>' * (ancestors.size + 1)
  s
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>

38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'app/helpers/issues_helper.rb', line 38

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

#render_parents_and_subtree(issue) ⇒ Object


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

def render_parents_and_subtree(issue)
  return if issue.leaf? && !issue.parent
  s = '<form><table id="issue_tree" class="list">'
  issue_list(issue.self_and_ancestors.sort_by(&:lft) + issue.descendants.sort_by(&:lft)) do |el, level|
    s << ('tr',
           ('td', check_box_tag("ids[]", el.id, false, :id => nil), :class => 'checkbox') +
           ('td', link_to_issue(el, :truncate => 60), :class => 'subject') +
           ('td', h(el.status)) +
           ('td', link_to_user(el.assigned_to)) +
           ('td', progress_bar(el.done_ratio, :width => '80px')),
           :class => "issue issue-#{el.id} #{"self" if el == issue} hascontextmenu #{level > 0 ? "idnt idnt-#{level}" : nil}")
  end
  s << '</table></form>'
  s
end

#render_sidebar_queriesObject


141
142
143
144
145
146
147
148
# File 'app/helpers/issues_helper.rb', line 141

def render_sidebar_queries
  out = ''
  queries = sidebar_queries.select {|q| !q.is_public?}
  out << query_links(l(:label_my_queries), queries) if queries.any?
  queries = sidebar_queries.select {|q| q.is_public?}
  out << query_links(l(:label_query_plural), queries) if queries.any?
  out
end

#send_notification_optionObject


231
232
233
234
235
236
237
238
239
# File 'app/helpers/issues_helper.rb', line 231

def send_notification_option
  (:p,
              (:label,
                          l(:label_notify_member_plural), :for => 'send_notification') +
              hidden_field_tag('send_notification', '0', :id => nil) +
              check_box_tag('send_notification', '1', true))


end

117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'app/helpers/issues_helper.rb', line 117

def sidebar_queries
  unless @sidebar_queries
    # User can see public queries and his own queries
    visible = ARCondition.new(["is_public = ? OR user_id = ?", true, (User.current.logged? ? User.current.id : 0)])
    # Project specific queries and global queries
    visible << (@project.nil? ? ["project_id IS NULL"] : ["project_id IS NULL OR project_id = ?", @project.id])
    @sidebar_queries = Query.find(:all,
                                  :select => 'id, name, is_public',
                                  :order => "name ASC",
                                  :conditions => visible.conditions)
  end
  @sidebar_queries
end