Module: QueriesHelper

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

#available_block_columns_tags(query) ⇒ Object


92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'app/helpers/queries_helper.rb', line 92

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

#available_display_types_tags(query) ⇒ Object


139
140
141
142
143
144
145
146
# File 'app/helpers/queries_helper.rb', line 139

def available_display_types_tags(query)
  tags = ''.html_safe
  query.available_display_types.each do |t|
    tags << radio_button_tag('display_type', t, @query.display_type == t, :id => "display_type_#{t}") +
      ('label', l(:"label_display_type_#{t}"), :for => "display_type_#{t}", :class => "inline")
  end
  tags
end

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


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'app/helpers/queries_helper.rb', line 107

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

#column_content(column, item) ⇒ Object


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

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


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

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 icon icon-sorted-desc'
        order = 'desc'
      else
        css = 'sort desc icon icon-sorted-asc'
        order = 'asc'
      end
    end
    param_key = options[:sort_param] || :sort
    sort_param = {param_key => query.sort_criteria.add(column.name, order).to_param}
    sort_param = {$1 => {$2 => sort_param.values.first}} while sort_param.keys.first.to_s =~ /^(.+)\[(.+)\]$/
    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
  ('th', content, :class => column.css_classes)
end

#column_value(column, item, value) ⇒ Object


240
241
242
243
244
245
246
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 240

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? ? ('div', textilizable(item, :description), :class => "wiki") : ''
  when :last_notes
    item.last_notes.present? ? ('div', textilizable(item, :last_notes), :class => "wiki") : ''
  when :done_ratio
    progress_bar(value)
  when :relations
    (
      '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, :total_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


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

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


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'app/helpers/queries_helper.rb', line 281

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.visible? ? "#{value.tracker} ##{value.id}: #{value.subject}" : "##{value.id}"
        else
          value.id
        end
      else
        value
      end
    end
  end
end

#filters_options_for_select(query) ⇒ Object


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
58
59
60
61
# File 'app/helpers/queries_helper.rb', line 25

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 /^cf_\d+\./.match?(field)
      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
    elsif %w(estimated_hours spent_time).include?(field)
      group = :label_time_tracking
    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


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

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


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

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

472
473
474
475
476
477
478
479
# File 'app/helpers/queries_helper.rb', line 472

def link_to_clear_query
  link_to(
    l(:button_clear),
    {:set_filter => 1, :sort => '', :project_id => @project},
    :class => 'icon-only icon-clear-query',
    :title => l(:button_clear)
  )
end

#query_as_hidden_field_tags(query) ⇒ Object

Returns the query definition as hidden field tags


400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'app/helpers/queries_helper.rb', line 400

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


124
125
126
127
# File 'app/helpers/queries_helper.rb', line 124

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


75
76
77
78
79
80
81
# File 'app/helpers/queries_helper.rb', line 75

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


63
64
65
66
67
68
69
70
71
72
73
# File 'app/helpers/queries_helper.rb', line 63

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


432
433
434
# File 'app/helpers/queries_helper.rb', line 432

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

#query_hidden_tags(query) ⇒ Object


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

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

Renders a group of queries


442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
# File 'app/helpers/queries_helper.rb', line 442

def query_links(title, queries)
  return '' if queries.empty?

  # links to #index on issues/show
  url_params =
    if controller_name == 'issues'
      {:controller => 'issues', :action => 'index', :project_id => @project}
    else
      {}
    end
  ('h3', title) + "\n" +
    (
      'ul',
      queries.collect do |query|
        css = +'query'
        clear_link = +''
        if query == @query
          css << ' selected'
          clear_link += link_to_clear_query
        end
        ('li',
                    link_to(query.name,
                            url_params.merge(:query_id => query),
                            :class => css) +
                      clear_link.html_safe)
      end.join("\n").html_safe,
      :class => 'queries'
    ) + "\n"
end

#query_selected_inline_columns_options(query) ⇒ Object


129
130
131
132
# File 'app/helpers/queries_helper.rb', line 129

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


305
306
307
308
309
310
311
312
313
314
315
316
# File 'app/helpers/queries_helper.rb', line 305

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

  Redmine::Export::CSV.generate(:encoding => params[:encoding]) 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


134
135
136
137
# File 'app/helpers/queries_helper.rb', line 134

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


175
176
177
178
179
180
181
182
# File 'app/helpers/queries_helper.rb', line 175

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
  ('p', totals.join(" ").html_safe, :class => "query-totals")
end

#render_sidebar_queries(klass, project) ⇒ Object

Renders the list of queries for the sidebar


482
483
484
485
486
487
488
489
# File 'app/helpers/queries_helper.rb', line 482

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, options = {}) ⇒ Object

Retrieve query from session or build a new query


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

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

  if params[:query_id].present?
    scope = klass.where(:project_id => nil)
    scope = scope.or(klass.where(:project_id => @project)) if @project
    @query = scope.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, options[:defaults])
    if use_session
      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
      }
    end
  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


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

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

Returns the queries that are rendered in the sidebar


437
438
439
# File 'app/helpers/queries_helper.rb', line 437

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

#total_tag(column, value) ⇒ Object


184
185
186
187
188
189
190
191
192
193
194
# File 'app/helpers/queries_helper.rb', line 184

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