Module: QueriesHelper

Overview

Redmine - project management software Copyright (C) 2006-2014 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, #back_url, #back_url_hidden_field_tag, #body_css_classes, #breadcrumb, #calendar_for, #catch_macros, #check_all_links, #checked_image, #context_menu, #current_theme, #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_object, #format_version_name, #heads_for_theme, #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, #raw_json, #render_flash_messages, #render_page_hierarchy, #render_project_jump_box, #render_project_nested_lists, #render_tabs, #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::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_time, included, #l, #l_hours, #l_or_humanize, #languages_options, #ll, #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


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

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

#column_content(column, issue) ⇒ Object


106
107
108
109
110
111
112
113
# File 'app/helpers/queries_helper.rb', line 106

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

#column_header(column) ⇒ Object


100
101
102
103
104
# File 'app/helpers/queries_helper.rb', line 100

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

#column_value(column, issue, value) ⇒ Object


115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'app/helpers/queries_helper.rb', line 115

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

#csv_content(column, issue) ⇒ Object


136
137
138
139
140
141
142
143
# File 'app/helpers/queries_helper.rb', line 136

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

#csv_value(column, object, value) ⇒ Object


145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'app/helpers/queries_helper.rb', line 145

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

#query_available_inline_columns_options(query) ⇒ Object


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

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


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

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


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

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


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

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

#query_selected_inline_columns_options(query) ⇒ Object


91
92
93
# File 'app/helpers/queries_helper.rb', line 91

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


164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'app/helpers/queries_helper.rb', line 164

def query_to_csv(items, query, options={})
  encoding = l(:general_csv_encoding)
  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

  export = CSV.generate(:col_sep => l(:general_csv_separator)) do |csv|
    # csv header fields
    csv << columns.collect {|c| Redmine::CodesetUtil.from_utf8(c.caption.to_s, encoding) }
    # csv lines
    items.each do |item|
      csv << columns.collect {|c| Redmine::CodesetUtil.from_utf8(csv_content(c, item), encoding) }
    end
  end
  export
end

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


95
96
97
98
# File 'app/helpers/queries_helper.rb', line 95

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

#retrieve_queryObject

Retrieve query from session or build a new query


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'app/helpers/queries_helper.rb', line 185

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

#retrieve_query_from_sessionObject


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

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