Module: Lipsiadmin::Mailer::PdfBuilder

Includes:
Utils::HtmlEntities
Defined in:
lib/mailer/pdf_builder.rb

Overview

This module convert a string/controller to a pdf through Pd4ml java library (included in this plugin)

PD4ML is a powerful PDF generating tool that uses HTML and CSS (Cascading Style Sheets) as page layout and content definition format. Written in 100% pure Java, it allows users to easily add PDF generation functionality to end products.

For generate a pdf you can simply do

script/generate pdf invoice

then edit your template /app/views/pdf/invoice.html.haml

Then in any of your mailers add some like this:

def order_invoiced(order)
  recipients my@mail.com
  from       my@server.com
  subject    Your Invoice

  attachment "application/pdf" do |a|
    a.body = render_pdf(:invoice, :invoice => order.invoice, :other => order.invoice.other)
  end

  part "text/plain" do |a|
    a.body = render_message("order_invoiced", :order => order, :body_template => @body_template)
  end
end

Lipsiadmin include a trial fully functional evaluation version, but if you want buy it, go here: pd4ml.com/buy.htm and then put your licensed jar in a directory in your project then simply calling this:

Lipsiadmin::Utils::PdfBuilder.jars_path = "here/is/my/licensed/pd4ml"
Lipsiadmin::Utils::PdfBuilder.view_path = "keep/template/in/other/path"

you can use your version without any problem.

By default Lipsiadmin will look into your “vendor/pd4ml” and if:

  • pd4ml.jar

  • ss_css2.jar

are present will use it

Instance Method Summary collapse

Methods included from Utils::HtmlEntities

#encode_entities

Instance Method Details

#render_pdf(template, body) ⇒ Object

Convert a stream to pdf, the template must be located in app/view/pdf/yourtemplate.pdf.erb



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
 
# File 'lib/mailer/pdf_builder.rb', line 51

def render_pdf(template, body)

  # path to the pd4ml jarfile
  jars_path = Lipsiadmin::Utils::PdfBuilder.jars_path
  # path to our templates
  view_path = Lipsiadmin::Utils::PdfBuilder.view_path

  body[:landescape] = body[:landescape] ? "LANDESCAPE" : "PORTRAIT"

  # try to find erb extension
  ext = File.exist?("#{view_path}/#{template}.html.erb") ? "erb" : "haml"

  # encode the template
  input = encode_entities(render_message("#{view_path}/#{template}.html.#{ext}", body))

  # search for stylesheet links and make their paths absolute.
  input.gsub!('<link href="/javascripts', '<link href="' + view_path + '/../../../public/javascripts')
  input.gsub!('<link href="/stylesheets', '<link href="' + view_path + '/../../../public/stylesheets')

  # search for images src, append full-path.
  input.gsub!('src="/', 'src="' + RAILS_ROOT + '/public/')
  input.gsub!('url(','url('+RAILS_ROOT+'/public')

  # write our temp file
  tmp = File.join(Rails.root, 'tmp')
  Dir.mkdir(tmp) unless File.exist?(tmp)
  t = Tempfile.new("pd4ml.html", tmp)
  t.binmode
  t.write(input)
  t.flush

  # build the command
  class_path = "#{jars_path}/pd4ml.jar:.:#{jars_path}"
  class_path = "\"#{jars_path}/pd4ml.jar\";\"#{jars_path}\"" if RUBY_PLATFORM =~ /mswin/
  cmd = "cd #{Lipsiadmin::Utils::PdfBuilder.pd4ruby_path} && java -Xmx512m -Djava.awt.headless=true -cp #{class_path} Pd4Ruby --file \"#{t.path}\" --width 950 --orientation #{body[:landescape]} 2>&1"

  # grep the output
  output = IO.popen(cmd) { |s| s.read }

  # raise error if process returned false (ie: a java error)
  raise PdfError, "An unknonwn error occurred while generating pdf" if $?.exitstatus == 127

  # return raw pdf binary-stream
  output
ensure
  t.close if t
end