##// END OF EJS Templates
jro_apps » redmine
RSS
Makes project custom fields available on spent time report (#1766)....
Jean-Philippe Lang -
r11229:85b872f34050
parent child
Show More
Side by Side Unified
Context file:
r11229:85b872f34050 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,148 +1,151
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2013 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 module Redmine
19 19 module Helpers
20 20 class TimeReport
21 21 attr_reader :criteria, :columns, :hours, :total_hours, :periods
22 22
23 23 def initialize(project, issue, criteria, columns, time_entry_scope)
24 24 @project = project
25 25 @issue = issue
26 26
27 27 @criteria = criteria || []
28 28 @criteria = @criteria.select{|criteria| available_criteria.has_key? criteria}
29 29 @criteria.uniq!
30 30 @criteria = @criteria[0,3]
31 31
32 32 @columns = (columns && %w(year month week day).include?(columns)) ? columns : 'month'
33 33 @scope = time_entry_scope
34 34
35 35 run
36 36 end
37 37
38 38 def available_criteria
39 39 @available_criteria || load_available_criteria
40 40 end
41 41
42 42 private
43 43
44 44 def run
45 45 unless @criteria.empty?
46 46 time_columns = %w(tyear tmonth tweek spent_on)
47 47 @hours = []
48 48 @scope.sum(:hours,
49 49 :include => [:issue, :activity],
50 50 :group => @criteria.collect{|criteria| @available_criteria[criteria][:sql]} + time_columns,
51 51 :joins => @criteria.collect{|criteria| @available_criteria[criteria][:joins]}.compact).each do |hash, hours|
52 52 h = {'hours' => hours}
53 53 (@criteria + time_columns).each_with_index do |name, i|
54 54 h[name] = hash[i]
55 55 end
56 56 @hours << h
57 57 end
58 58
59 59 @hours.each do |row|
60 60 case @columns
61 61 when 'year'
62 62 row['year'] = row['tyear']
63 63 when 'month'
64 64 row['month'] = "#{row['tyear']}-#{row['tmonth']}"
65 65 when 'week'
66 66 row['week'] = "#{row['tyear']}-#{row['tweek']}"
67 67 when 'day'
68 68 row['day'] = "#{row['spent_on']}"
69 69 end
70 70 end
71 71
72 72 min = @hours.collect {|row| row['spent_on']}.min
73 73 @from = min ? min.to_date : Date.today
74 74
75 75 max = @hours.collect {|row| row['spent_on']}.max
76 76 @to = max ? max.to_date : Date.today
77 77
78 78 @total_hours = @hours.inject(0) {|s,k| s = s + k['hours'].to_f}
79 79
80 80 @periods = []
81 81 # Date#at_beginning_of_ not supported in Rails 1.2.x
82 82 date_from = @from.to_time
83 83 # 100 columns max
84 84 while date_from <= @to.to_time && @periods.length < 100
85 85 case @columns
86 86 when 'year'
87 87 @periods << "#{date_from.year}"
88 88 date_from = (date_from + 1.year).at_beginning_of_year
89 89 when 'month'
90 90 @periods << "#{date_from.year}-#{date_from.month}"
91 91 date_from = (date_from + 1.month).at_beginning_of_month
92 92 when 'week'
93 93 @periods << "#{date_from.year}-#{date_from.to_date.cweek}"
94 94 date_from = (date_from + 7.day).at_beginning_of_week
95 95 when 'day'
96 96 @periods << "#{date_from.to_date}"
97 97 date_from = date_from + 1.day
98 98 end
99 99 end
100 100 end
101 101 end
102 102
103 103 def load_available_criteria
104 104 @available_criteria = { 'project' => {:sql => "#{TimeEntry.table_name}.project_id",
105 105 :klass => Project,
106 106 :label => :label_project},
107 107 'status' => {:sql => "#{Issue.table_name}.status_id",
108 108 :klass => IssueStatus,
109 109 :label => :field_status},
110 110 'version' => {:sql => "#{Issue.table_name}.fixed_version_id",
111 111 :klass => Version,
112 112 :label => :label_version},
113 113 'category' => {:sql => "#{Issue.table_name}.category_id",
114 114 :klass => IssueCategory,
115 115 :label => :field_category},
116 116 'user' => {:sql => "#{TimeEntry.table_name}.user_id",
117 117 :klass => User,
118 118 :label => :label_user},
119 119 'tracker' => {:sql => "#{Issue.table_name}.tracker_id",
120 120 :klass => Tracker,
121 121 :label => :label_tracker},
122 122 'activity' => {:sql => "#{TimeEntry.table_name}.activity_id",
123 123 :klass => TimeEntryActivity,
124 124 :label => :label_activity},
125 125 'issue' => {:sql => "#{TimeEntry.table_name}.issue_id",
126 126 :klass => Issue,
127 127 :label => :label_issue}
128 128 }
129 129
130 # Add list and boolean custom fields as available criteria
131 custom_fields = (@project.nil? ? IssueCustomField.for_all : @project.all_issue_custom_fields)
132 # Add list and boolean time entry custom fields
133 custom_fields += TimeEntryCustomField.all
134 # Add list and boolean time entry activity custom fields
130 # Add time entry custom fields
131 custom_fields = TimeEntryCustomField.all
132 # Add project custom fields
133 custom_fields += ProjectCustomField.all
134 # Add issue custom fields
135 custom_fields += (@project.nil? ? IssueCustomField.for_all : @project.all_issue_custom_fields)
136 # Add time entry activity custom fields
135 137 custom_fields += TimeEntryActivityCustomField.all
136 138
139 # Add list and boolean custom fields as available criteria
137 140 custom_fields.select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
138 141 @available_criteria["cf_#{cf.id}"] = {:sql => "#{cf.join_alias}.value",
139 142 :joins => cf.join_for_order_statement,
140 143 :format => cf.field_format,
141 144 :label => cf.name}
142 145 end
143 146
144 147 @available_criteria
145 148 end
146 149 end
147 150 end
148 151 end
Show file before | Show file after | Hide comments
@@ -1,332 +1,346
1 1 # -*- coding: utf-8 -*-
2 2 # Redmine - project management software
3 3 # Copyright (C) 2006-2013 Jean-Philippe Lang
4 4 #
5 5 # This program is free software; you can redistribute it and/or
6 6 # modify it under the terms of the GNU General Public License
7 7 # as published by the Free Software Foundation; either version 2
8 8 # of the License, or (at your option) any later version.
9 9 #
10 10 # This program is distributed in the hope that it will be useful,
11 11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 13 # GNU General Public License for more details.
14 14 #
15 15 # You should have received a copy of the GNU General Public License
16 16 # along with this program; if not, write to the Free Software
17 17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 18
19 19 require File.expand_path('../../test_helper', __FILE__)
20 20
21 21 class TimeEntryReportsControllerTest < ActionController::TestCase
22 22 tests TimelogController
23 23
24 24 fixtures :projects, :enabled_modules, :roles, :members, :member_roles,
25 25 :issues, :time_entries, :users, :trackers, :enumerations,
26 26 :issue_statuses, :custom_fields, :custom_values
27 27
28 28 include Redmine::I18n
29 29
30 30 def setup
31 31 Setting.default_language = "en"
32 32 end
33 33
34 34 def test_report_at_project_level
35 35 get :report, :project_id => 'ecookbook'
36 36 assert_response :success
37 37 assert_template 'report'
38 38 assert_tag :form,
39 39 :attributes => {:action => "/projects/ecookbook/time_entries/report", :id => 'query_form'}
40 40 end
41 41
42 42 def test_report_all_projects
43 43 get :report
44 44 assert_response :success
45 45 assert_template 'report'
46 46 assert_tag :form,
47 47 :attributes => {:action => "/time_entries/report", :id => 'query_form'}
48 48 end
49 49
50 50 def test_report_all_projects_denied
51 51 r = Role.anonymous
52 52 r.permissions.delete(:view_time_entries)
53 53 r.permissions_will_change!
54 54 r.save
55 55 get :report
56 56 assert_redirected_to '/login?back_url=http%3A%2F%2Ftest.host%2Ftime_entries%2Freport'
57 57 end
58 58
59 59 def test_report_all_projects_one_criteria
60 60 get :report, :columns => 'week', :from => "2007-04-01", :to => "2007-04-30", :criteria => ['project']
61 61 assert_response :success
62 62 assert_template 'report'
63 63 assert_not_nil assigns(:report)
64 64 assert_equal "8.65", "%.2f" % assigns(:report).total_hours
65 65 end
66 66
67 67 def test_report_all_time
68 68 get :report, :project_id => 1, :criteria => ['project', 'issue']
69 69 assert_response :success
70 70 assert_template 'report'
71 71 assert_not_nil assigns(:report)
72 72 assert_equal "162.90", "%.2f" % assigns(:report).total_hours
73 73 end
74 74
75 75 def test_report_all_time_by_day
76 76 get :report, :project_id => 1, :criteria => ['project', 'issue'], :columns => 'day'
77 77 assert_response :success
78 78 assert_template 'report'
79 79 assert_not_nil assigns(:report)
80 80 assert_equal "162.90", "%.2f" % assigns(:report).total_hours
81 81 assert_tag :tag => 'th', :content => '2007-03-12'
82 82 end
83 83
84 84 def test_report_one_criteria
85 85 get :report, :project_id => 1, :columns => 'week', :from => "2007-04-01", :to => "2007-04-30", :criteria => ['project']
86 86 assert_response :success
87 87 assert_template 'report'
88 88 assert_not_nil assigns(:report)
89 89 assert_equal "8.65", "%.2f" % assigns(:report).total_hours
90 90 end
91 91
92 92 def test_report_two_criteria
93 93 get :report, :project_id => 1, :columns => 'month', :from => "2007-01-01", :to => "2007-12-31", :criteria => ["user", "activity"]
94 94 assert_response :success
95 95 assert_template 'report'
96 96 assert_not_nil assigns(:report)
97 97 assert_equal "162.90", "%.2f" % assigns(:report).total_hours
98 98 end
99 99
100 100 def test_report_custom_field_criteria_with_multiple_values
101 101 field = TimeEntryCustomField.create!(:name => 'multi', :field_format => 'list', :possible_values => ['value1', 'value2'])
102 102 entry = TimeEntry.create!(:project => Project.find(1), :hours => 1, :activity_id => 10, :user => User.find(2), :spent_on => Date.today)
103 103 CustomValue.create!(:customized => entry, :custom_field => field, :value => 'value1')
104 104 CustomValue.create!(:customized => entry, :custom_field => field, :value => 'value2')
105 105
106 106 get :report, :project_id => 1, :columns => 'day', :criteria => ["cf_#{field.id}"]
107 107 assert_response :success
108 108 end
109 109
110 110 def test_report_one_day
111 111 get :report, :project_id => 1, :columns => 'day', :from => "2007-03-23", :to => "2007-03-23", :criteria => ["user", "activity"]
112 112 assert_response :success
113 113 assert_template 'report'
114 114 assert_not_nil assigns(:report)
115 115 assert_equal "4.25", "%.2f" % assigns(:report).total_hours
116 116 end
117 117
118 118 def test_report_at_issue_level
119 119 get :report, :project_id => 1, :issue_id => 1, :columns => 'month', :from => "2007-01-01", :to => "2007-12-31", :criteria => ["user", "activity"]
120 120 assert_response :success
121 121 assert_template 'report'
122 122 assert_not_nil assigns(:report)
123 123 assert_equal "154.25", "%.2f" % assigns(:report).total_hours
124 124 assert_tag :form,
125 125 :attributes => {:action => "/projects/ecookbook/issues/1/time_entries/report", :id => 'query_form'}
126 126 end
127 127
128 def test_report_custom_field_criteria
129 get :report, :project_id => 1, :criteria => ['project', 'cf_1', 'cf_7']
128 def test_report_should_propose_association_custom_fields
129 get :report
130 assert_response :success
131 assert_template 'report'
132
133 assert_select 'select[name=?]', 'criteria[]' do
134 assert_select 'option[value=cf_1]', {:text => 'Database'}, 'Issue custom field not found'
135 assert_select 'option[value=cf_3]', {:text => 'Development status'}, 'Project custom field not found'
136 assert_select 'option[value=cf_7]', {:text => 'Billable'}, 'TimeEntryActivity custom field not found'
137 end
138 end
139
140 def test_report_with_association_custom_fields
141 get :report, :criteria => ['cf_1', 'cf_3', 'cf_7']
130 142 assert_response :success
131 143 assert_template 'report'
132 144 assert_not_nil assigns(:report)
133 145 assert_equal 3, assigns(:report).criteria.size
134 146 assert_equal "162.90", "%.2f" % assigns(:report).total_hours
135 # Custom field column
136 assert_tag :tag => 'th', :content => 'Database'
147
148 # Custom fields columns
149 assert_select 'th', :text => 'Database'
150 assert_select 'th', :text => 'Development status'
151 assert_select 'th', :text => 'Billable'
152
137 153 # Custom field row
138 assert_tag :tag => 'td', :content => 'MySQL',
139 :sibling => { :tag => 'td', :attributes => { :class => 'hours' },
140 :child => { :tag => 'span', :attributes => { :class => 'hours hours-int' },
141 :content => '1' }}
142 # Second custom field column
143 assert_tag :tag => 'th', :content => 'Billable'
154 assert_select 'tr' do
155 assert_select 'td', :text => 'MySQL'
156 assert_select 'td.hours', :text => '1.00'
157 end
144 158 end
145 159
146 160 def test_report_one_criteria_no_result
147 161 get :report, :project_id => 1, :columns => 'week', :from => "1998-04-01", :to => "1998-04-30", :criteria => ['project']
148 162 assert_response :success
149 163 assert_template 'report'
150 164 assert_not_nil assigns(:report)
151 165 assert_equal "0.00", "%.2f" % assigns(:report).total_hours
152 166 end
153 167
154 168 def test_report_status_criterion
155 169 get :report, :project_id => 1, :criteria => ['status']
156 170 assert_response :success
157 171 assert_template 'report'
158 172 assert_tag :tag => 'th', :content => 'Status'
159 173 assert_tag :tag => 'td', :content => 'New'
160 174 end
161 175
162 176 def test_report_all_projects_csv_export
163 177 get :report, :columns => 'month', :from => "2007-01-01", :to => "2007-06-30",
164 178 :criteria => ["project", "user", "activity"], :format => "csv"
165 179 assert_response :success
166 180 assert_equal 'text/csv; header=present', @response.content_type
167 181 lines = @response.body.chomp.split("\n")
168 182 # Headers
169 183 assert_equal 'Project,User,Activity,2007-3,2007-4,Total', lines.first
170 184 # Total row
171 185 assert_equal 'Total,"","",154.25,8.65,162.90', lines.last
172 186 end
173 187
174 188 def test_report_csv_export
175 189 get :report, :project_id => 1, :columns => 'month',
176 190 :from => "2007-01-01", :to => "2007-06-30",
177 191 :criteria => ["project", "user", "activity"], :format => "csv"
178 192 assert_response :success
179 193 assert_equal 'text/csv; header=present', @response.content_type
180 194 lines = @response.body.chomp.split("\n")
181 195 # Headers
182 196 assert_equal 'Project,User,Activity,2007-3,2007-4,Total', lines.first
183 197 # Total row
184 198 assert_equal 'Total,"","",154.25,8.65,162.90', lines.last
185 199 end
186 200
187 201 def test_csv_big_5
188 202 Setting.default_language = "zh-TW"
189 203 str_utf8 = "\xe4\xb8\x80\xe6\x9c\x88"
190 204 str_big5 = "\xa4@\xa4\xeb"
191 205 if str_utf8.respond_to?(:force_encoding)
192 206 str_utf8.force_encoding('UTF-8')
193 207 str_big5.force_encoding('Big5')
194 208 end
195 209 user = User.find_by_id(3)
196 210 user.firstname = str_utf8
197 211 user.lastname = "test-lastname"
198 212 assert user.save
199 213 comments = "test_csv_big_5"
200 214 te1 = TimeEntry.create(:spent_on => '2011-11-11',
201 215 :hours => 7.3,
202 216 :project => Project.find(1),
203 217 :user => user,
204 218 :activity => TimeEntryActivity.find_by_name('Design'),
205 219 :comments => comments)
206 220
207 221 te2 = TimeEntry.find_by_comments(comments)
208 222 assert_not_nil te2
209 223 assert_equal 7.3, te2.hours
210 224 assert_equal 3, te2.user_id
211 225
212 226 get :report, :project_id => 1, :columns => 'day',
213 227 :from => "2011-11-11", :to => "2011-11-11",
214 228 :criteria => ["user"], :format => "csv"
215 229 assert_response :success
216 230 assert_equal 'text/csv; header=present', @response.content_type
217 231 lines = @response.body.chomp.split("\n")
218 232 # Headers
219 233 s1 = "\xa5\xce\xa4\xe1,2011-11-11,\xc1`\xadp"
220 234 s2 = "\xc1`\xadp"
221 235 if s1.respond_to?(:force_encoding)
222 236 s1.force_encoding('Big5')
223 237 s2.force_encoding('Big5')
224 238 end
225 239 assert_equal s1, lines.first
226 240 # Total row
227 241 assert_equal "#{str_big5} #{user.lastname},7.30,7.30", lines[1]
228 242 assert_equal "#{s2},7.30,7.30", lines[2]
229 243
230 244 str_tw = "Traditional Chinese (\xe7\xb9\x81\xe9\xab\x94\xe4\xb8\xad\xe6\x96\x87)"
231 245 if str_tw.respond_to?(:force_encoding)
232 246 str_tw.force_encoding('UTF-8')
233 247 end
234 248 assert_equal str_tw, l(:general_lang_name)
235 249 assert_equal 'Big5', l(:general_csv_encoding)
236 250 assert_equal ',', l(:general_csv_separator)
237 251 assert_equal '.', l(:general_csv_decimal_separator)
238 252 end
239 253
240 254 def test_csv_cannot_convert_should_be_replaced_big_5
241 255 Setting.default_language = "zh-TW"
242 256 str_utf8 = "\xe4\xbb\xa5\xe5\x86\x85"
243 257 if str_utf8.respond_to?(:force_encoding)
244 258 str_utf8.force_encoding('UTF-8')
245 259 end
246 260 user = User.find_by_id(3)
247 261 user.firstname = str_utf8
248 262 user.lastname = "test-lastname"
249 263 assert user.save
250 264 comments = "test_replaced"
251 265 te1 = TimeEntry.create(:spent_on => '2011-11-11',
252 266 :hours => 7.3,
253 267 :project => Project.find(1),
254 268 :user => user,
255 269 :activity => TimeEntryActivity.find_by_name('Design'),
256 270 :comments => comments)
257 271
258 272 te2 = TimeEntry.find_by_comments(comments)
259 273 assert_not_nil te2
260 274 assert_equal 7.3, te2.hours
261 275 assert_equal 3, te2.user_id
262 276
263 277 get :report, :project_id => 1, :columns => 'day',
264 278 :from => "2011-11-11", :to => "2011-11-11",
265 279 :criteria => ["user"], :format => "csv"
266 280 assert_response :success
267 281 assert_equal 'text/csv; header=present', @response.content_type
268 282 lines = @response.body.chomp.split("\n")
269 283 # Headers
270 284 s1 = "\xa5\xce\xa4\xe1,2011-11-11,\xc1`\xadp"
271 285 if s1.respond_to?(:force_encoding)
272 286 s1.force_encoding('Big5')
273 287 end
274 288 assert_equal s1, lines.first
275 289 # Total row
276 290 s2 = ""
277 291 if s2.respond_to?(:force_encoding)
278 292 s2 = "\xa5H?"
279 293 s2.force_encoding('Big5')
280 294 elsif RUBY_PLATFORM == 'java'
281 295 s2 = "??"
282 296 else
283 297 s2 = "\xa5H???"
284 298 end
285 299 assert_equal "#{s2} #{user.lastname},7.30,7.30", lines[1]
286 300 end
287 301
288 302 def test_csv_fr
289 303 with_settings :default_language => "fr" do
290 304 str1 = "test_csv_fr"
291 305 user = User.find_by_id(3)
292 306 te1 = TimeEntry.create(:spent_on => '2011-11-11',
293 307 :hours => 7.3,
294 308 :project => Project.find(1),
295 309 :user => user,
296 310 :activity => TimeEntryActivity.find_by_name('Design'),
297 311 :comments => str1)
298 312
299 313 te2 = TimeEntry.find_by_comments(str1)
300 314 assert_not_nil te2
301 315 assert_equal 7.3, te2.hours
302 316 assert_equal 3, te2.user_id
303 317
304 318 get :report, :project_id => 1, :columns => 'day',
305 319 :from => "2011-11-11", :to => "2011-11-11",
306 320 :criteria => ["user"], :format => "csv"
307 321 assert_response :success
308 322 assert_equal 'text/csv; header=present', @response.content_type
309 323 lines = @response.body.chomp.split("\n")
310 324 # Headers
311 325 s1 = "Utilisateur;2011-11-11;Total"
312 326 s2 = "Total"
313 327 if s1.respond_to?(:force_encoding)
314 328 s1.force_encoding('ISO-8859-1')
315 329 s2.force_encoding('ISO-8859-1')
316 330 end
317 331 assert_equal s1, lines.first
318 332 # Total row
319 333 assert_equal "#{user.firstname} #{user.lastname};7,30;7,30", lines[1]
320 334 assert_equal "#{s2};7,30;7,30", lines[2]
321 335
322 336 str_fr = "Fran\xc3\xa7ais"
323 337 if str_fr.respond_to?(:force_encoding)
324 338 str_fr.force_encoding('UTF-8')
325 339 end
326 340 assert_equal str_fr, l(:general_lang_name)
327 341 assert_equal 'ISO-8859-1', l(:general_csv_encoding)
328 342 assert_equal ';', l(:general_csv_separator)
329 343 assert_equal ',', l(:general_csv_decimal_separator)
330 344 end
331 345 end
332 346 end
General Comments 0
You need to be logged in to leave comments. Login now