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-2017 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.

Since:

  • 0.4.0

Constant Summary

Constants included from ApplicationHelper

ApplicationHelper::HEADING_RE, ApplicationHelper::LINKS_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, #default_search_project_scope, #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_hires_images, #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, #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

Since:

  • 2.2.0



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

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

Since:

  • 3.2.0



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

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

Since:

  • 0.6.0



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

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

#column_header(query, column, options = {}) ⇒ Object

Since:

  • 0.6.0



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
191
192
193
194
195
196
 
# File 'app/helpers/queries_helper.rb', line 164

def column_header(query, column, options={})
  if column.sortable?
    css, order = nil, column.default_order
    if column.name.to_s == query.sort_criteria.first_key
      if query.sort_criteria.first_asc?
        css = 'sort asc'
        order = 'desc'
      else
        css = 'sort desc'
        order = 'asc'
      end
    end
    param_key = options[:sort_param] || :sort
    sort_param = { param_key => query.sort_criteria.add(column.name, order).to_param }
    while sort_param.keys.first.to_s =~ /^(.+)\[(.+)\]$/
      sort_param = {$1 => {$2 => sort_param.values.first}}
    end
    link_options = {
        :title => l(:label_sort_by, "\"#{column.caption}\""),
        :class => css
      }
    if options[:sort_link_options]
      link_options.merge! options[:sort_link_options]
    end
    content = link_to(column.caption,
        {:params => request.query_parameters.deep_merge(sort_param)},
        link_options
      )
  else
    content = column.caption
  end
  content_tag('th', content)
end

#column_value(column, item, value) ⇒ Object

Since:

  • 1.4.0



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

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 :last_notes
    item.last_notes.present? ? content_tag('div', textilizable(item, :last_notes), :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, :estimated_hours
    format_hours(value)
  when :spent_hours
    link_to_if(value > 0, format_hours(value), project_time_entries_path(item.project, :issue_id => "#{item.id}"))
  when :total_spent_hours
    link_to_if(value > 0, format_hours(value), project_time_entries_path(item.project, :issue_id => "~#{item.id}"))
  when :attachments
    value.to_a.map {|a| format_object(a)}.join(" ").html_safe
  else
    format_object(value)
  end
end

#csv_content(column, item) ⇒ Object

Since:

  • 2.3.0



239
240
241
242
243
244
245
246
 
# File 'app/helpers/queries_helper.rb', line 239

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

Since:

  • 2.3.0



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 248

def csv_value(column, object, value)
  case column.name
  when :attachments
    value.to_a.map {|a| a.filename}.join("\n")
  else
    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
end

#filters_options_for_select(query) ⇒ Object

Since:

  • 2.1.0



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
56
57
 
# 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 =~ /^cf_\d+\./
      group = (field_options[:through] || field_options[:field]).try(:name)
    elsif field =~ /^(.+)\./
      # association filters
      group = "field_#{$1}".to_sym
    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| [k.is_a?(Symbol) ? l(k) : k.to_s, v]}
    s << grouped_options_for_select(localized_grouped)
  end
  s
end

#group_by_column_select_tag(query) ⇒ Object

Since:

  • 3.4.0



83
84
85
86
 
# File 'app/helpers/queries_helper.rb', line 83

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, &block) ⇒ Object

Since:

  • 3.4.0



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

def grouped_query_results(items, query, &block)
  result_count_by_group = query.result_count_by_group
  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 = result_count_by_group ? result_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

Since:

  • 3.2.1



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

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
  query.columns.each do |column|
    tags << hidden_field_tag("c[]", column.name, :id => nil)
  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
  if query.sort_criteria.present?
    tags << hidden_field_tag("sort", query.sort_criteria.to_param, :id => nil)
  end

  tags
end

#query_available_inline_columns_options(query) ⇒ Object

Since:

  • 2.3.0



105
106
107
 
# File 'app/helpers/queries_helper.rb', line 105

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

Since:

  • 2.3.1



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

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

Since:

  • 2.3.1



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

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_sort_tag(query) ⇒ Object

Since:

  • 3.4.0



371
372
373
 
# File 'app/helpers/queries_helper.rb', line 371

def query_hidden_sort_tag(query)
  hidden_field_tag("sort", query.sort_criteria.to_param, :id => nil)
end

#query_hidden_tags(query) ⇒ Object

Since:

  • 2.3.1



79
80
81
 
# File 'app/helpers/queries_helper.rb', line 79

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

Since:

  • 3.4.0



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'app/helpers/queries_helper.rb', line 381

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

Since:

  • 2.3.0



109
110
111
 
# File 'app/helpers/queries_helper.rb', line 109

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

Since:

  • 2.3.0



272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'app/helpers/queries_helper.rb', line 272

def query_to_csv(items, query, options={})
  columns = query.columns

  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

Since:

  • 2.3.0



113
114
115
116
 
# File 'app/helpers/queries_helper.rb', line 113

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

Since:

  • 3.2.0



145
146
147
148
149
150
151
 
# File 'app/helpers/queries_helper.rb', line 145

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

Since:

  • 3.4.0



398
399
400
401
402
403
404
405
 
# File 'app/helpers/queries_helper.rb', line 398

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

Since:

  • 1.0.0



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'app/helpers/queries_helper.rb', line 286

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
  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, :sort => @query.sort_criteria.to_a} 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], :sort_criteria => session[session_key][:sort])
    @query.project = @project
  end
  if params[:sort].present?
    @query.sort_criteria = params[:sort]
    if use_session
      session[session_key] ||= {}
      session[session_key][:sort] = @query.sort_criteria.to_a
    end
  end
  @query
end

#retrieve_query_from_session(klass = IssueQuery) ⇒ Object

Since:

  • 1.4.0



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'app/helpers/queries_helper.rb', line 318

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], :sort_criteria => session[session_key][:sort])
    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

Since:

  • 3.4.0



376
377
378
 
# File 'app/helpers/queries_helper.rb', line 376

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

#total_tag(column, value) ⇒ Object

Since:

  • 3.2.0



153
154
155
156
157
158
159
160
161
162
 
# File 'app/helpers/queries_helper.rb', line 153

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