Module: Redmine::Export::PDF::IssuesPdfHelper
- Includes:
- ActionView::Helpers::NumberHelper
- Included in:
- IssuesHelper
- Defined in:
- lib/redmine/export/pdf/issues_pdf_helper.rb
Instance Method Summary collapse
-
#calc_col_width(issues, query, table_width, pdf) ⇒ Object
calculate columns width.
-
#fetch_row_values(issue, query, level) ⇒ Object
fetch row values.
-
#get_issues_to_pdf_write_cells(pdf, col_values, col_widths, head = false) ⇒ Object
returns the maximum height of MultiCells.
- #is_cjk? ⇒ Boolean
-
#issue_to_pdf(issue, assoc = {}) ⇒ Object
Returns a PDF string of a single issue.
-
#issues_to_pdf(issues, project, query) ⇒ Object
Returns a PDF string of a list of issues.
-
#issues_to_pdf_draw_borders(pdf, top_x, top_y, lower_y, col_id_width, col_widths, rtl = false) ⇒ Object
Draw lines to close the row (MultiCell border drawing in not uniform).
-
#issues_to_pdf_write_cells(pdf, col_values, col_widths, row_height, head = false) ⇒ Object
Renders MultiCells and returns the maximum height used.
- #pdf_format_text(object, attribute) ⇒ Object
- #render_table_header(pdf, query, col_width, row_height, table_width) ⇒ Object
Instance Method Details
#calc_col_width(issues, query, table_width, pdf) ⇒ Object
calculate columns width
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 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 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 423 def calc_col_width(issues, query, table_width, pdf) # calculate statistics # by captions pdf.SetFontStyle('B', 8) margins = pdf.get_margins col_padding = margins['cell'] col_width_min = query.inline_columns.map {|v| pdf.get_string_width(v.) + col_padding} col_width_max = Array.new(col_width_min) col_width_avg = Array.new(col_width_min) col_min = pdf.get_string_width('OO') + col_padding * 2 if table_width > col_min * col_width_avg.length table_width -= col_min * col_width_avg.length else col_min = pdf.get_string_width('O') + col_padding * 2 if table_width > col_min * col_width_avg.length table_width -= col_min * col_width_avg.length else ratio = table_width / col_width_avg.sum return col_width = col_width_avg.map {|w| w * ratio} end end word_width_max = query.inline_columns.map do |c| n = 10 c..split.each do |w| x = pdf.get_string_width(w) + col_padding n = x if n < x end n end # by properties of issues pdf.SetFontStyle('', 8) k = 1 issue_list(issues) do |issue, level| k += 1 values = fetch_row_values(issue, query, level) values.each_with_index do |v, i| n = pdf.get_string_width(v) + col_padding * 2 col_width_max[i] = n if col_width_max[i] < n col_width_min[i] = n if col_width_min[i] > n col_width_avg[i] += n v.split.each do |w| x = pdf.get_string_width(w) + col_padding word_width_max[i] = x if word_width_max[i] < x end end end col_width_avg.map! {|x| x / k} # calculate columns width ratio = table_width / col_width_avg.sum col_width = col_width_avg.map {|w| w * ratio} # correct max word width if too many columns ratio = table_width / word_width_max.sum word_width_max.map! {|v| v * ratio} if ratio < 1 # correct and lock width of some columns done = 1 col_fix = [] col_width.each_with_index do |w, i| if w > col_width_max[i] col_width[i] = col_width_max[i] col_fix[i] = 1 done = 0 elsif w < word_width_max[i] col_width[i] = word_width_max[i] col_fix[i] = 1 done = 0 else col_fix[i] = 0 end end # iterate while need to correct and lock coluns width while done == 0 # calculate free & locked columns width done = 1 ratio = table_width / col_width.sum # correct columns width col_width.each_with_index do |w, i| if col_fix[i] == 0 col_width[i] = w * ratio # check if column width less then max word width if col_width[i] < word_width_max[i] col_width[i] = word_width_max[i] col_fix[i] = 1 done = 0 elsif col_width[i] > col_width_max[i] col_width[i] = col_width_max[i] col_fix[i] = 1 done = 0 end end end end ratio = table_width / col_width.sum col_width.map! {|v| v * ratio + col_min} col_width end |
#fetch_row_values(issue, query, level) ⇒ Object
fetch row values
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 392 def fetch_row_values(issue, query, level) query.inline_columns.collect do |column| s = if column.is_a?(QueryCustomFieldColumn) cv = issue.visible_custom_field_values.detect {|v| v.custom_field_id == column.custom_field.id} show_value(cv, false) else value = column.value_object(issue) case column.name when :subject value = " " * level + value when :attachments value = value.to_a.map {|a| a.filename}.join("\n") when :watcher_users value = value.to_a.join("\n") end if value.is_a?(Date) format_date(value) elsif value.is_a?(Time) format_time(value) elsif value.is_a?(Float) number_with_delimiter(sprintf('%.2f', value), delimiter: nil) else value end end s.to_s end end |
#get_issues_to_pdf_write_cells(pdf, col_values, col_widths, head = false) ⇒ Object
returns the maximum height of MultiCells
546 547 548 549 550 551 552 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 546 def get_issues_to_pdf_write_cells(pdf, col_values, col_widths, head=false) heights = [] col_values.each_with_index do |column, i| heights << pdf.get_string_height(col_widths[i], head ? column. : column) end return heights.max end |
#is_cjk? ⇒ Boolean
382 383 384 385 386 387 388 389 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 382 def is_cjk? case current_language.to_s.downcase when 'ja', 'zh-tw', 'zh', 'ko' true else false end end |
#issue_to_pdf(issue, assoc = {}) ⇒ Object
Returns a PDF string of a single issue
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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 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 141 142 143 144 145 146 147 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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 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 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 27 def issue_to_pdf(issue, assoc={}) pdf = ITCPDF.new(current_language) pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}") pdf.alias_nb_pages pdf. = format_date(User.current.today) pdf.add_page pdf.SetFontStyle('B', 11) buf = "#{issue.project} - #{issue.tracker} ##{issue.id}" pdf.RDMMultiCell(190, 5, buf) pdf.SetFontStyle('', 8) base_x = pdf.get_x i = 1 issue.ancestors.visible.each do |ancestor| pdf.set_x(base_x + i) buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status}): #{ancestor.subject}" pdf.RDMMultiCell(190 - i, 5, buf) i += 1 if i < 35 end pdf.SetFontStyle('B', 11) pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s) pdf.SetFontStyle('', 8) pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.}") pdf.ln left = [] left << [l(:field_status), issue.status] left << [l(:field_priority), issue.priority] left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?('assigned_to_id') left << [l(:field_category), issue.category] unless issue.disabled_core_fields.include?('category_id') left << [l(:field_fixed_version), issue.fixed_version] unless issue.disabled_core_fields.include?('fixed_version_id') right = [] right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?('start_date') right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?('due_date') right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?('done_ratio') right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?('estimated_hours') right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project) rows = [left.size, right.size].max left << nil while left.size < rows right << nil while right.size < rows custom_field_values = issue.visible_custom_field_values.reject {|value| value.custom_field.full_width_layout?} half = (custom_field_values.size / 2.0).ceil custom_field_values.each_with_index do |custom_value, i| (i < half ? left : right) << [custom_value.custom_field.name, show_value(custom_value, false)] end if pdf.get_rtl border_first_top = 'RT' border_last_top = 'LT' border_first = 'R' border_last = 'L' else border_first_top = 'LT' border_last_top = 'RT' border_first = 'L' border_last = 'R' end rows = [left.size, right.size].max rows.times do |i| heights = [] pdf.SetFontStyle('B', 9) item = left[i] heights << pdf.get_string_height(35, item ? "#{item.first}:" : "") item = right[i] heights << pdf.get_string_height(35, item ? "#{item.first}:" : "") pdf.SetFontStyle('', 9) item = left[i] heights << pdf.get_string_height(60, item ? item.last.to_s : "") item = right[i] heights << pdf.get_string_height(60, item ? item.last.to_s : "") height = heights.max item = left[i] pdf.SetFontStyle('B', 9) pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0) pdf.SetFontStyle('', 9) pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 0) item = right[i] pdf.SetFontStyle('B', 9) pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0) pdf.SetFontStyle('', 9) pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 2) pdf.set_x(base_x) end pdf.SetFontStyle('B', 9) pdf.RDMCell(35 + 155, 5, l(:field_description), "LRT", 1) pdf.SetFontStyle('', 9) # Set resize image scale pdf.set_image_scale(1.6) text = pdf_format_text(issue, :description) pdf.RDMwriteFormattedCell(35+155, 5, '', '', text, issue., "LRB") custom_field_values = issue.visible_custom_field_values.select {|value| value.custom_field.full_width_layout?} custom_field_values.each do |value| is_html = value.custom_field.full_text_formatting? text = show_value(value, is_html) next if text.blank? pdf.SetFontStyle('B', 9) pdf.RDMCell(35+155, 5, value.custom_field.name, "LRT", 1) pdf.SetFontStyle('', 9) if is_html pdf.RDMwriteFormattedCell(35+155, 5, '', '', text, issue., "LRB") else pdf.RDMwriteHTMLCell(35+155, 5, '', '', text, issue., "LRB") end end unless issue.leaf? truncate_length = (!is_cjk? ? 90 : 65) pdf.SetFontStyle('B', 9) pdf.RDMCell(35+155, 5, l(:label_subtask_plural) + ":", "LTR") pdf.ln issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level| buf = "#{child.tracker} # #{child.id}: #{child.subject}". truncate(truncate_length) level = 10 if level >= 10 pdf.SetFontStyle('', 8) pdf.RDMCell(35 + 135, 5, (level >=1 ? " " * level : "") + buf, border_first) pdf.SetFontStyle('B', 8) pdf.RDMCell(20, 5, child.status.to_s, border_last) pdf.ln end end relations = issue.relations.select {|r| r.other_issue(issue).visible?} unless relations.empty? truncate_length = (!is_cjk? ? 80 : 60) pdf.SetFontStyle('B', 9) pdf.RDMCell(35 + 155, 5, l(:label_related_issues) + ":", "LTR") pdf.ln relations.each do |relation| buf = relation.to_s(issue) do |other| text = "" if Setting.cross_project_issue_relations? text += "#{relation.other_issue(issue).project} - " end text += "#{other.tracker} ##{other.id}: #{other.subject}" text end buf = buf.truncate(truncate_length) pdf.SetFontStyle('', 8) pdf.RDMCell(35+155-60, 5, buf, border_first) pdf.SetFontStyle('B', 8) pdf.RDMCell(20, 5, relation.other_issue(issue).status.to_s, "") pdf.RDMCell(20, 5, format_date(relation.other_issue(issue).start_date), "") pdf.RDMCell(20, 5, format_date(relation.other_issue(issue).due_date), border_last) pdf.ln end end pdf.RDMCell(190, 5, "", "T") pdf.ln if issue.changesets.any? && User.current.allowed_to?(:view_changesets, issue.project) pdf.SetFontStyle('B', 9) pdf.RDMCell(190, 5, l(:label_associated_revisions), "B") pdf.ln issue.changesets.each do |changeset| pdf.SetFontStyle('B', 8) csstr = "#{l(:label_revision)} #{changeset.format_identifier} - " csstr += format_time(changeset.committed_on) + " - " + changeset..to_s pdf.RDMCell(190, 5, csstr) pdf.ln unless changeset.comments.blank? pdf.SetFontStyle('', 8) pdf.RDMwriteHTMLCell( 190, 5, '', '', changeset.comments.to_s, issue., "" ) end pdf.ln end end if assoc[:journals].present? pdf.SetFontStyle('B', 9) pdf.RDMCell(190, 5, l(:label_history), "B") pdf.ln assoc[:journals].each do |journal| pdf.SetFontStyle('B', 8) title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}" title += " (#{l(:field_private_notes)})" if journal.private_notes? pdf.RDMCell(190, 5, title) pdf.ln pdf.SetFontStyle('I', 8) details_to_strings(journal.visible_details, true).each do |string| pdf.RDMMultiCell(190, 5, "- " + string) end if journal.notes? pdf.ln unless journal.details.empty? pdf.SetFontStyle('', 8) text = pdf_format_text(journal, :notes) pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue., "") end pdf.ln end end if issue..any? pdf.SetFontStyle('B', 9) pdf.RDMCell(190, 5, l(:label_attachment_plural), "B") pdf.ln issue..each do || pdf.SetFontStyle('', 8) pdf.RDMCell(80, 5, .filename) pdf.RDMCell(20, 5, number_to_human_size(.filesize), 0, 0, "R") pdf.RDMCell(25, 5, format_date(.created_on), 0, 0, "R") pdf.RDMCell(65, 5, ..name, 0, 0, "R") pdf.ln end end pdf.output end |
#issues_to_pdf(issues, project, query) ⇒ Object
Returns a PDF string of a list of issues
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 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 317 318 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 370 371 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 254 def issues_to_pdf(issues, project, query) pdf = ITCPDF.new(current_language, "L") title = query.new_record? ? l(:label_issue_plural) : query.name title = "#{project} - #{title}" if project pdf.set_title(title) pdf.alias_nb_pages pdf. = format_date(User.current.today) pdf.set_auto_page_break(false) pdf.add_page("L") # Landscape A4 = 210 x 297 mm page_height = pdf.get_page_height # 210 page_width = pdf.get_page_width # 297 left_margin = pdf.get_original_margins['left'] # 10 right_margin = pdf.get_original_margins['right'] # 10 bottom_margin = pdf. row_height = 4 # column widths table_width = page_width - right_margin - left_margin col_width = [] unless query.inline_columns.empty? col_width = calc_col_width(issues, query, table_width, pdf) table_width = col_width.sum end # use full width if the query has block columns (description, last_notes or full width custom fieds) if table_width > 0 && query.block_columns.any? col_width = col_width.map {|w| w * (page_width - right_margin - left_margin) / table_width} table_width = col_width.sum end # title pdf.SetFontStyle('B', 11) pdf.RDMCell(190, 8, title) pdf.ln # totals totals = query.totals.map {|column, total| "#{column.}: #{total}"} if totals.present? pdf.SetFontStyle('B', 10) pdf.RDMCell(table_width, 6, totals.join(" "), 0, 1, 'R') end totals_by_group = query.totals_by_group render_table_header(pdf, query, col_width, row_height, table_width) previous_group = false result_count_by_group = query.result_count_by_group issue_list(issues) do |issue, level| if query.grouped? && (group = query.group_by_column.group_value(issue)) != previous_group pdf.SetFontStyle('B', 10) group_label = group.blank? ? +'None' : group.to_s.dup group_label << " (#{result_count_by_group[group]})" pdf.bookmark group_label, 0, -1 pdf.RDMCell(table_width, row_height * 2, group_label, 'LR', 1, 'L') pdf.SetFontStyle('', 8) totals = totals_by_group.map {|column, total| "#{column.}: #{total[group]}"}.join(" ") if totals.present? pdf.RDMCell(table_width, row_height, totals, 'LR', 1, 'L') end previous_group = group end # fetch row values col_values = fetch_row_values(issue, query, level) # make new page if it doesn't fit on the current one base_y = pdf.get_y max_height = get_issues_to_pdf_write_cells(pdf, col_values, col_width) space_left = page_height - base_y - bottom_margin if max_height > space_left pdf.add_page("L") render_table_header(pdf, query, col_width, row_height, table_width) base_y = pdf.get_y end # write the cells on page issues_to_pdf_write_cells(pdf, col_values, col_width, max_height) pdf.set_y(base_y + max_height) query.block_columns.each do |column| is_html = false if column.is_a?(QueryCustomFieldColumn) cv = issue.visible_custom_field_values.detect do |v| v.custom_field_id == column.custom_field.id end is_html = cv.custom_field.full_text_formatting? if cv text = show_value(cv, is_html) else text = pdf_format_text issue, column.name.to_sym is_html = true end next if text.blank? pdf.set_x(10) pdf.set_auto_page_break(true, bottom_margin) pdf.SetFontStyle('B', 9) pdf.RDMCell(0, 5, column., "LRT", 1) pdf.SetFontStyle('', 9) if is_html pdf.RDMwriteFormattedCell(0, 5, '', '', text, issue., "LRB") else pdf.RDMwriteHTMLCell(0, 5, '', '', text, [], "LRB") end pdf.set_auto_page_break(false) end end if issues.size == Setting.issues_export_limit.to_i pdf.SetFontStyle('B', 10) pdf.RDMCell(0, row_height, '...') end pdf.output end |
#issues_to_pdf_draw_borders(pdf, top_x, top_y, lower_y, col_id_width, col_widths, rtl = false) ⇒ Object
Draw lines to close the row (MultiCell border drawing in not uniform)
parameter "col_id_width" is not used. it is kept for compatibility.
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 564 def issues_to_pdf_draw_borders(pdf, top_x, top_y, lower_y, col_id_width, col_widths, rtl=false) col_x = top_x pdf.line(col_x, top_y, col_x, lower_y) # id right border col_widths.each do |width| if rtl col_x -= width else col_x += width end pdf.line(col_x, top_y, col_x, lower_y) # columns right border end pdf.line(top_x, top_y, top_x, lower_y) # left border pdf.line(top_x, lower_y, col_x, lower_y) # bottom border end |
#issues_to_pdf_write_cells(pdf, col_values, col_widths, row_height, head = false) ⇒ Object
Renders MultiCells and returns the maximum height used
555 556 557 558 559 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 555 def issues_to_pdf_write_cells(pdf, col_values, col_widths, row_height, head=false) col_values.each_with_index do |column, i| pdf.RDMMultiCell(col_widths[i], row_height, head ? column. : column.strip, 1, '', 1, 0) end end |
#pdf_format_text(object, attribute) ⇒ Object
373 374 375 376 377 378 379 380 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 373 def pdf_format_text(object, attribute) textilizable(object, attribute, :only_path => false, :edit_section_links => false, :headings => false, :inline_attachments => false ) end |
#render_table_header(pdf, query, col_width, row_height, table_width) ⇒ Object
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 |
# File 'lib/redmine/export/pdf/issues_pdf_helper.rb', line 527 def render_table_header(pdf, query, col_width, row_height, table_width) # headers pdf.SetFontStyle('B', 8) pdf.set_fill_color(230, 230, 230) base_x = pdf.get_x base_y = pdf.get_y max_height = get_issues_to_pdf_write_cells(pdf, query.inline_columns, col_width, true) # write the cells on page issues_to_pdf_write_cells(pdf, query.inline_columns, col_width, max_height, true) pdf.set_xy(base_x, base_y + max_height) # rows pdf.SetFontStyle('', 8) pdf.set_fill_color(255, 255, 255) end |