to_pdf 0.1.3 → 0.1.4

data/README.rdoc

@@ -1,6 +1,6 @@
-= ToPDF
+= to_pdf
 
-Render rails actions as a PDF using {PrinceXML}[http://princexml.com/].
+Render rails actions as a PDF using {PrinceXML}[http://princexml.com/] or Wkhtmltopdf.
 
 == Installation 
 
@@ -45,7 +45,7 @@ You can though define CSS at the top of the document (note that "body" rules wil
 
 Or link a stylesheet:
 
-  = stylesheet_link_tag 'pdf', :media => 'print'
+  = stylesheet_link_tag 'pdf', :media => 'all'
 
   .job
     .name
@@ -56,7 +56,7 @@ This will even work with the Rails 3.1 asset pipeline. However, in development y
   MyProject::Application.configure do
     ...
 
-    config.prince_xml_asset_domain = "http://myproject.dev"
+    config.to_pdf_asset_domain = 'http://myproject.dev'
   end
 
 Another configuration option available is the path to the PrinceXML executable. Again, this can optionally be set on a per environment basis:
@@ -70,8 +70,18 @@ Another configuration option available is the path to the PrinceXML executable.
 == Caveats
 
 * Only sends PDFs inline
-* Does not use layouts
-* Without configuring #prince_xml_asset_domain stylesheets will not load images
+* If you wish to use a layout then it also requires a .pdf format, eg. application.pdf.haml
+* In order for css files to load images then config.prince_xml_asset_domain needs to be defined
+
+== Wkhtmltopdf
+
+To use Wkhtmltopdf us must add the following additional configuration:
+
+  MyProject::Application.configure do
+    ...
+
+    config.to_pdf_renderer = :wkhtmltopdf
+  end
 
 == Maintainers
 
@@ -98,4 +108,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/to_pdf.rb

@@ -1,3 +1,4 @@
 autoload :PrinceXML, 'to_pdf/prince_xml'
+autoload :Wkhtmltopdf, 'to_pdf/wkhtmltopdf'
 
 require 'to_pdf/railtie' if defined?(Rails::Railtie)

data/lib/to_pdf/railtie.rb

@@ -1,24 +1,35 @@
 module ToPDF
   class Railtie < Rails::Railtie
-    initializer 'to_pdf.configure_prince_xml' do |app|
-      if app.config.respond_to? :prince_xml_asset_domain
-        PrinceXML.asset_domain = app.config.prince_xml_asset_domain
-      end
+    config.to_pdf_renderer = :princexml
 
+    initializer 'to_pdf.configure' do |app|
+      if app.config.respond_to? :to_pdf_asset_domain
+        PrinceXML.asset_domain   = app.config.to_pdf_asset_domain
+        Wkhtmltopdf.asset_domain = app.config.to_pdf_asset_domain
+      end
+    
       if app.config.respond_to? :prince_xml_executable_path
         PrinceXML.executable_path = app.config.prince_xml_executable_path
       end
+    
+      if app.config.respond_to? :wkhtmltopdf_executable_path
+        Wkhtmltopdf.executable_path = app.to_pdf.wkhtmltopdf_executable_path
+      end
     end
 
     initializer 'to_pdf.init_mime_types' do
       Mime::Type.register 'application/pdf', :pdf
     end
 
-    initializer 'to_pdf.insert_into_action_controller' do
+    initializer 'to_pdf.insert_into_action_controller' do |app|
       ActiveSupport.on_load :action_controller  do
         ActionController::Renderers.add :pdf do |template, options|
           string = render_to_string template, options
-          send_data PrinceXML.string_to_pdf(string), :type => :pdf, :disposition => 'inline'
+          if app.config.to_pdf_renderer == :wkhtmltopdf
+            send_data Wkhtmltopdf.string_to_pdf(string), :type => :pdf, :disposition => 'inline'
+          else
+            send_data PrinceXML.string_to_pdf(string), :type => :pdf, :disposition => 'inline'
+          end
         end
 
         class ActionController::Responder

data/lib/to_pdf/version.rb

@@ -1,3 +1,3 @@
 module ToPDF
-  VERSION = "0.1.3"
+  VERSION = '0.1.4'
 end

data/lib/to_pdf/wkhtmltopdf.rb

@@ -0,0 +1,48 @@
+class Wkhtmltopdf
+  class << self
+    attr_writer :executable_path, :asset_domain
+
+    def asset_domain=(domain)
+      @asset_domain = domain
+    end
+
+    def executable_path=(path)
+      @executable_path = File.expand_path(path)
+    end
+
+    def detect_executable_path
+      IO.popen('which wkhtmltopdf') { |pipe| @executable_path = pipe.gets }
+      raise 'Cannot find command `wkhtmltopdf` in $PATH' unless @executable_path
+      @executable_path.strip!
+    end
+
+    def string_to_pdf(string)
+      detect_executable_path unless @executable_path
+
+      pdf = IO.popen(wkhtmltopdf_command, 'w+')
+      pdf.puts(localise_paths(string))
+      pdf.close_write
+      result = pdf.gets(nil)
+      pdf.close_read
+
+      result
+    end
+
+    def wkhtmltopdf_command
+      "#{@executable_path} --quiet --allow #{Rails.public_path} - -"
+    end
+
+    def localise_paths(string)
+      string.gsub!('src="/', "src=\"#{Rails.public_path}/") if defined?(Rails)
+
+      if @asset_domain
+        string.gsub!('link href="/', "link href=\"#{@asset_domain}/")
+      elsif defined?(Rails)
+        string.gsub!('link href="/', "link href=\"#{Rails.public_path}/")
+        string.gsub!('url(/', "url(#{Rails.public_path}/")
+      end
+
+      string
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: to_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-24 00:00:00.000000000Z
+date: 2011-10-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70349858287660 !ruby/object:Gem::Requirement
+  requirement: &70344200396480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70349858287660
+  version_requirements: *70344200396480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70349858287060 !ruby/object:Gem::Requirement
+  requirement: &70344200395800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70349858287060
+  version_requirements: *70344200395800
 description: Render rails actions as a PDF using PrinceXML.
 email: hugh@artpop.com.au
 executables: []
@@ -46,6 +46,7 @@ files:
 - lib/to_pdf/prince_xml.rb
 - lib/to_pdf/railtie.rb
 - lib/to_pdf/version.rb
+- lib/to_pdf/wkhtmltopdf.rb
 - to_pdf.gemspec
 homepage: https://github.com/hughevans/to_pdf
 licenses: []