Module: QueriesHelper

Includes:
ApplicationHelper
Included in:
CalendarsController, GanttsController, IssuesController, JournalsController, QueriesController, TimelogController
Defined in:
app/helpers/queries_helper.rb

Overview

Redmine - project management software Copyright (C) 2006-2016 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.

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, #avatar_edit_link, #back_url, #back_url_hidden_field_tag, #body_css_classes, #breadcrumb, #calendar_for, #catch_macros, #check_all_links, #checked_image, #context_menu, #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_changeset_comments, #format_object, #format_version_name, #generate_csv, #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, #projects_for_jump_box, #raw_json, #render_error_messages, #render_flash_messages, #render_page_hierarchy, #render_project_jump_box, #render_project_nested_lists, #render_projects_for_jump_box, #render_tabs, #reorder_handle, #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::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 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

#available_block_columns_tags(query) ⇒ Object 



86
87
88
89
90
91
92
 
# File 'app/helpers/queries_helper.rb', line 86

def available_block_columns_tags(query)
  tags = ''.html_safe
  query.available_block_columns.each do |column|
    tags << content_tag('label', check_box_tag('c[]', column.name.to_s, query.has_column?(column), :id => nil) + " #{column.caption}", :class => 'inline')
  end
  tags
end

#available_totalable_columns_tags(query) ⇒ Object 



94
95
96
97
98
99
100
101
 
# File 'app/helpers/queries_helper.rb', line 94

def available_totalable_columns_tags(query)
  tags = ''.html_safe
  query.available_totalable_columns.each do |column|
    tags << content_tag('label', check_box_tag('t[]', column.name.to_s, query.totalable_columns.include?(column), :id => nil) + " #{column.caption}", :class => 'inline')
  end
  tags << hidden_field_tag('t[]', '')
  tags
end

#column_content(column, item) ⇒ Object 



167
168
169
170
171
172
173
174
 
# File 'app/helpers/queries_helper.rb', line 167

def column_content(column, item)
  value = column.value_object(item)
  if value.is_a?(Array)
    value.collect {|v| column_value(column, item, v)}.compact.join(', ').html_safe
  else
    column_value(column, item, value)
  end
end

#column_header(column) ⇒ Object 



161
162
163
164
165
 
# File 'app/helpers/queries_helper.rb', line 161

def column_header(column)
  column.sortable ? sort_header_tag(column.name.to_s, :caption => column.caption,
                                                      :default_order => column.default_order) :
                    content_tag('th', h(column.caption))
end

#column_value(column, item, value) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'app/helpers/queries_helper.rb', line 176

def column_value(column, item, value)
  case column.name
  when :id
    link_to value, issue_path(item)
  when :subject
    link_to value, issue_path(item)
  when :parent
    value ? (value.visible? ? link_to_issue(value, :subject => false) : "##{value.id}") : ''
  when :description
    item.description? ? content_tag('div', textilizable(item, :description), :class => "wiki") : ''
  when :done_ratio
    progress_bar(value)
  when :relations
    content_tag('span',
      value.to_s(item) {|other| link_to_issue(other, :subject => false, :tracker => false)}.html_safe,
      :class => value.css_classes_for(item))
  when :hours, :spent_hours, :total_spent_hours, :estimated_hours
    format_hours(value)
  else
    format_object(value)
  end
end

#csv_content(column, item) ⇒ Object 



199
200
201
202
203
204
205
206
 
# File 'app/helpers/queries_helper.rb', line 199

def csv_content(column, item)
  value = column.value_object(item)
  if value.is_a?(Array)
    value.collect {|v| csv_value(column, item, v)}.compact.join(', ')
  else
    csv_value(column, item, value)
  end
end

#csv_value(column, object, value) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'app/helpers/queries_helper.rb', line 208

def csv_value(column, object, value)
  format_object(value, false) do |value|
    case value.class.name
    when 'Float'
      sprintf("%.2f", value).gsub('.', l(:general_csv_decimal_separator))
    when 'IssueRelation'
      value.to_s(object)
    when 'Issue'
      if object.is_a?(TimeEntry)
        "#{value.tracker} ##{value.id}: #{value.subject}"
      else
        value.id
      end
    else
      value
    end
  end
end

#filters_options_for_select(query) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'app/helpers/queries_helper.rb', line 23

def filters_options_for_select(query)
  ungrouped = []
  grouped = {}
  query.available_filters.map do |field, field_options|
    if field_options[:type] == :relation
      group = :label_relations
    elsif field_options[:type] == :tree
      group = query.is_a?(IssueQuery) ? :label_relations : nil
    elsif field =~ /^(.+)\./
      # association filters
      group = "field_#{$1}"
    elsif %w(member_of_group assigned_to_role).include?(field)
      group = :field_assigned_to
    elsif field_options[:type] == :date_past || field_options[:type] == :date
      group = :label_date
    end
    if group
      (grouped[group] ||= []) << [field_options[:name], field]
    else
      ungrouped << [field_options[:name], field]
    end
  end
  # Don't group dates if there's only one (eg. time entries filters)
  if grouped[:label_date].try(:size) == 1
    ungrouped << grouped.delete(:label_date).first
  end
  s = options_for_select([[]] + ungrouped)
  if grouped.present?
    localized_grouped = grouped.map {|k,v| [l(k), v]}
    s << grouped_options_for_select(localized_grouped)
  end
  s
end

#group_by_column_select_tag(query) ⇒ Object 



81
82
83
84
 
# File 'app/helpers/queries_helper.rb', line 81

def group_by_column_select_tag(query)
  options = [[]] + query.groupable_columns.collect {|c| [c.caption, c.name.to_s]}
  select_tag('group_by', options_for_select(options, @query.group_by))
end

#grouped_query_results(items, query, item_count_by_group, &block) ⇒ Object 



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
 
# File 'app/helpers/queries_helper.rb', line 116

def grouped_query_results(items, query, item_count_by_group, &block)
  previous_group, first = false, true
  totals_by_group = query.totalable_columns.inject({}) do |h, column|
    h[column] = query.total_by_group_for(column)
    h
  end
  items.each do |item|
    group_name = group_count = nil
    if query.grouped?
      group = query.group_by_column.value(item)
      if first || group != previous_group
        if group.blank? && group != false
          group_name = "(#{l(:label_blank_value)})"
        else
          group_name = format_object(group)
        end
        group_name ||= ""
        group_count = item_count_by_group ? item_count_by_group[group] : nil
        group_totals = totals_by_group.map {|column, t| total_tag(column, t[group] || 0)}.join(" ").html_safe
      end
    end
    yield item, group_name, group_count, group_totals
    previous_group, first = group, false
  end
end

#query_as_hidden_field_tags(query) ⇒ Object

Returns the query definition as hidden field tags



293
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
 
# File 'app/helpers/queries_helper.rb', line 293

def query_as_hidden_field_tags(query)
  tags = hidden_field_tag("set_filter", "1", :id => nil)

  if query.filters.present?
    query.filters.each do |field, filter|
      tags << hidden_field_tag("f[]", field, :id => nil)
      tags << hidden_field_tag("op[#{field}]", filter[:operator], :id => nil)
      filter[:values].each do |value|
        tags << hidden_field_tag("v[#{field}][]", value, :id => nil)
      end
    end
  else
    tags << hidden_field_tag("f[]", "", :id => nil)
  end
  if query.column_names.present?
    query.column_names.each do |name|
      tags << hidden_field_tag("c[]", name, :id => nil)
    end
  end
  if query.totalable_names.present?
    query.totalable_names.each do |name|
      tags << hidden_field_tag("t[]", name, :id => nil)
    end
  end
  if query.group_by.present?
    tags << hidden_field_tag("group_by", query.group_by, :id => nil)
  end

  tags
end

#query_available_inline_columns_options(query) ⇒ Object 



103
104
105
 
# File 'app/helpers/queries_helper.rb', line 103

def query_available_inline_columns_options(query)
  (query.available_inline_columns - query.columns).reject(&:frozen?).collect {|column| [column.caption, column.name]}
end

#query_columns_hidden_tags(query) ⇒ Object 



69
70
71
72
73
74
75
 
# File 'app/helpers/queries_helper.rb', line 69

def query_columns_hidden_tags(query)
  tags = ''.html_safe
  query.columns.each do |column|
    tags << hidden_field_tag("c[]", column.name, :id => nil)
  end
  tags
end

#query_filters_hidden_tags(query) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
 
# File 'app/helpers/queries_helper.rb', line 57

def query_filters_hidden_tags(query)
  tags = ''.html_safe
  query.filters.each do |field, options|
    tags << hidden_field_tag("f[]", field, :id => nil)
    tags << hidden_field_tag("op[#{field}]", options[:operator], :id => nil)
    options[:values].each do |value|
      tags << hidden_field_tag("v[#{field}][]", value, :id => nil)
    end
  end
  tags
end

#query_hidden_tags(query) ⇒ Object 



77
78
79
 
# File 'app/helpers/queries_helper.rb', line 77

def query_hidden_tags(query)
  query_filters_hidden_tags(query) + query_columns_hidden_tags(query)
end

#query_links(title, queries) ⇒ Object

Renders a group of queries



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'app/helpers/queries_helper.rb', line 330

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} : {}

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

#query_selected_inline_columns_options(query) ⇒ Object 



107
108
109
 
# File 'app/helpers/queries_helper.rb', line 107

def query_selected_inline_columns_options(query)
  (query.inline_columns & query.available_inline_columns).reject(&:frozen?).collect {|column| [column.caption, column.name]}
end

#query_to_csv(items, query, options = {}) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'app/helpers/queries_helper.rb', line 227

def query_to_csv(items, query, options={})
  options ||= {}
  columns = (options[:columns] == 'all' ? query.available_inline_columns : query.inline_columns)
  query.available_block_columns.each do |column|
    if options[column.name].present?
      columns << column
    end
  end

  Redmine::Export::CSV.generate do |csv|
    # csv header fields
    csv << columns.map {|c| c.caption.to_s}
    # csv lines
    items.each do |item|
      csv << columns.map {|c| csv_content(c, item)}
    end
  end
end

#render_query_columns_selection(query, options = {}) ⇒ Object 



111
112
113
114
 
# File 'app/helpers/queries_helper.rb', line 111

def render_query_columns_selection(query, options={})
  tag_name = (options[:name] || 'c') + '[]'
  render :partial => 'queries/columns', :locals => {:query => query, :tag_name => tag_name}
end

#render_query_totals(query) ⇒ Object 



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

def render_query_totals(query)
  return unless query.totalable_columns.present?
  totals = query.totalable_columns.map do |column|
    total_tag(column, query.total_for(column))
  end
  content_tag('p', totals.join(" ").html_safe, :class => "query-totals")
end

#render_sidebar_queries(klass, project) ⇒ Object

Renders the list of queries for the sidebar



347
348
349
350
351
352
353
354
 
# File 'app/helpers/queries_helper.rb', line 347

def render_sidebar_queries(klass, project)
  queries = sidebar_queries(klass, project)

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

#retrieve_query(klass = IssueQuery, use_session = true) ⇒ Object

Retrieve query from session or build a new query



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'app/helpers/queries_helper.rb', line 247

def retrieve_query(klass=IssueQuery, use_session=true)
  session_key = klass.name.underscore.to_sym

  if params[:query_id].present?
    cond = "project_id IS NULL"
    cond << " OR project_id = #{@project.id}" if @project
    @query = klass.where(cond).find(params[:query_id])
    raise ::Unauthorized unless @query.visible?
    @query.project = @project
    session[session_key] = {:id => @query.id, :project_id => @query.project_id} if use_session
    sort_clear
  elsif api_request? || params[:set_filter] || !use_session || session[session_key].nil? || session[session_key][:project_id] != (@project ? @project.id : nil)
    # Give it a name, required to be valid
    @query = klass.new(:name => "_", :project => @project)
    @query.build_from_params(params)
    session[session_key] = {:project_id => @query.project_id, :filters => @query.filters, :group_by => @query.group_by, :column_names => @query.column_names, :totalable_names => @query.totalable_names} if use_session
  else
    # retrieve from session
    @query = nil
    @query = klass.find_by_id(session[session_key][:id]) if session[session_key][:id]
    @query ||= klass.new(:name => "_", :filters => session[session_key][:filters], :group_by => session[session_key][:group_by], :column_names => session[session_key][:column_names], :totalable_names => session[session_key][:totalable_names])
    @query.project = @project
  end
end

#retrieve_query_from_session(klass = IssueQuery) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'app/helpers/queries_helper.rb', line 272

def retrieve_query_from_session(klass=IssueQuery)
  session_key = klass.name.underscore.to_sym
  session_data = session[session_key]

  if session_data
    if session_data[:id]
      @query = IssueQuery.find_by_id(session_data[:id])
      return unless @query
    else
      @query = IssueQuery.new(:name => "_", :filters => session_data[:filters], :group_by => session_data[:group_by], :column_names => session_data[:column_names], :totalable_names => session_data[:totalable_names])
    end
    if session_data.has_key?(:project_id)
      @query.project_id = session_data[:project_id]
    else
      @query.project = @project
    end
    @query
  end
end

#sidebar_queries(klass, project) ⇒ Object

Returns the queries that are rendered in the sidebar



325
326
327
 
# File 'app/helpers/queries_helper.rb', line 325

def sidebar_queries(klass, project)
  klass.visible.global_or_on_project(@project).sorted.to_a
end

#total_tag(column, value) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
 
# File 'app/helpers/queries_helper.rb', line 150

def total_tag(column, value)
  label = content_tag('span', "#{column.caption}:")
  value = if [:hours, :spent_hours, :total_spent_hours, :estimated_hours].include? column.name
    format_hours(value)
  else
    format_object(value)
  end
  value = content_tag('span', value, :class => 'value')
  content_tag('span', label + " " + value, :class => "total-for-#{column.name.to_s.dasherize}")
end