pdfkit 0.5.0 → 0.5.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pdfkit (0.5.0)
+    pdfkit (0.5.1)
 
 GEM
   remote: http://rubygems.org/

data/History.md

@@ -1,4 +1,14 @@
-2010-12-27 
+2011-06-17
+==================
+  * Bump to 0.5.1
+  * Fix for response body coming through as an array.
+  * Added root_url configuration for setup where a host my not know its own name.
+  * Awareness of Bundler when looking for the wkhtmltopdf executable.
+  * Fix for file data getting truncated in Ruby 1.8.6
+  * Fix for 0.5.0 release getting stuck rendering all requests as PDFs.
+  * More robust meta tag detection.
+
+2010-12-27
 ==================
   * Bump to 0.5.0
   * Switched to popen - adds support for JRuby and Windows

data/README.md

@@ -1,6 +1,6 @@
 # PDFKit
 
-Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antialize/wkhtmltopdf) on the backend which renders HTML using Webkit.
+Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antialize/wkhtmltopdf) on the back-end which renders HTML using Webkit.
 
 ## Install
 
@@ -10,11 +10,11 @@ Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antia
 
 ### wkhtmltopdf
 
-1. Install by hand (recomended):
+1. Install by hand (recommended):
 
-        https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF
+    <https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF>
 
-2. Try using the wkhtmltopdf-binary gem (mac + linux i386)
+2.  Try using the wkhtmltopdf-binary gem (mac + linux i386)
 
         gem install wkhtmltopdf-binary
 
@@ -47,11 +47,12 @@ If you're on Windows or you installed wkhtmltopdf by hand to a location other th
 
     # config/initializers/pdfkit.rb
     PDFKit.configure do |config|
-      config.wkhtmltopdf = '/path/to/wkhtmltopdf'
-      config.default_options = {
-        :page_size => 'Legal',
-        :print_media_type => true
-      }
+      # config.wkhtmltopdf = '/path/to/wkhtmltopdf'
+      # config.default_options = {
+      #   :page_size => 'Legal',
+      #   :print_media_type => true
+      # }
+      # config.root_url = "http://localhost" # Use only if your external hostname is unavailable on the server.
     end
 
 ## Middleware
@@ -79,7 +80,7 @@ PDFKit comes with a middleware that allows users to get a PDF view of any page o
 
 **With conditions to limit routes that can be generated in pdf**
 
-    # conditions can be regexes (either one or an array)
+    # conditions can be regexps (either one or an array)
     config.middleware.use PDFKit::Middleware, {}, :only => %r[^/public]
     config.middleware.use PDFKit::Middleware, {}, :only => [%r[^/invoice], %r[^/public]]
 
@@ -89,8 +90,8 @@ PDFKit comes with a middleware that allows users to get a PDF view of any page o
 
 ## Troubleshooting
 
-*  **Single thread issue:** In development environments it is common to run a 
-   single server process. This can cause issues when rendering your pdf 
+*  **Single thread issue:** In development environments it is common to run a
+   single server process. This can cause issues when rendering your pdf
    requires wkhtmltopdf to hit your server again (for images, js, css).
    This is because the resource requests will get blocked by the initial
    request and the initial request will be waiting on the resource
@@ -101,13 +102,15 @@ PDFKit comes with a middleware that allows users to get a PDF view of any page o
    like Passenger or try to embed your resources within your HTML to
    avoid extra HTTP requests.
 
-*  **Resources aren't included in the PDF:** Images, CSS, or Javascript
+*  **Resources aren't included in the PDF:** Images, CSS, or JavaScript
    does not seem to be downloading correctly in the PDF. This is due
    to the fact that wkhtmltopdf does not know where to find those files.
    Make sure you are using absolute paths (start with forward slash) to
-   your resources. If you are using PDFKit to generate pdfs from a raw
-   HTML source make sure you use complete paths (either file paths or 
-   urls including the domain).
+   your resources. If you are using PDFKit to generate PDFs from a raw
+   HTML source make sure you use complete paths (either file paths or
+   urls including the domain). In restrictive server environments the
+   root_url configuration may be what you are looking for change your
+   asset host.
 
 ## TODO
  - add amd64 support in --install-wkhtmltopdf

data/lib/pdfkit/configuration.rb

@@ -1,6 +1,6 @@
 class PDFKit
   class Configuration
-    attr_accessor :meta_tag_prefix, :default_options
+    attr_accessor :meta_tag_prefix, :default_options, :root_url
     attr_writer :wkhtmltopdf
 
     def initialize
@@ -17,7 +17,7 @@ class PDFKit
     end
 
     def wkhtmltopdf
-      @wkhtmltopdf ||= `which wkhtmltopdf`.chomp
+      @wkhtmltopdf ||= (defined?(Bundler) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
     end
   end
 

data/lib/pdfkit/middleware.rb

@@ -10,12 +10,14 @@ class PDFKit
 
     def call(env)
       @request    = Rack::Request.new(env)
+      @render_pdf = false
 
       set_request_to_render_as_pdf(env) if render_as_pdf?
       status, headers, response = @app.call(env)
 
       if rendering_pdf? && headers['Content-Type'] =~ /text\/html|application\/xhtml\+xml/
         body = response.respond_to?(:body) ? response.body : response.join
+        body = body.join if body.is_a?(Array)
         body = PDFKit.new(translate_paths(body, env), @options).to_pdf
         response = [body]
 
@@ -35,7 +37,7 @@ class PDFKit
     # Change relative paths to absolute
     def translate_paths(body, env)
       # Host with protocol
-      root = "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}/"
+      root = PDFKit.configuration.root_url || "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}/"
 
       body.gsub(/(href|src)=(['"])\/([^\"']*|[^"']*)['"]/, '\1=\2' + root + '\3\2')
     end

data/lib/pdfkit/pdfkit.rb

@@ -61,7 +61,7 @@ class PDFKit
     args = command(path)
     invoke = args.join(' ')
 
-    result = IO.popen(invoke, "w+") do |pdf|
+    result = IO.popen(invoke, "wb+") do |pdf|
       pdf.puts(@source.to_s) if @source.html?
       pdf.close_write
       pdf.gets(nil)
@@ -79,23 +79,19 @@ class PDFKit
 
   protected
 
-    def find_options_in_meta(body)
-      pdfkit_meta_tags(body).inject({}) do |found, tag|
-        name = tag.attributes["name"].sub(/^#{PDFKit.configuration.meta_tag_prefix}/, '').to_sym
-        found.merge(name => tag.attributes["content"])
-      end
-    end
+    def find_options_in_meta(content)
+      # Read file if content is a File
+      content = content.read if content.is_a?(File)
 
-    def pdfkit_meta_tags(body)
-      require 'rexml/document'
-      xml_body = REXML::Document.new(body)
-      found = []
-      xml_body.elements.each("html/head/meta") do |tag|
-        found << tag if tag.attributes['name'].to_s =~ /^#{PDFKit.configuration.meta_tag_prefix}/
+      found = {}
+      content.scan(/<meta [^>]*>/) do |meta|
+        if meta.match(/name=["']#{PDFKit.configuration.meta_tag_prefix}/)
+          name = meta.scan(/name=["']#{PDFKit.configuration.meta_tag_prefix}([^"']*)/)[0][0]
+          found[name] = meta.scan(/content=["']([^"']*)/)[0][0]
+        end
       end
+
       found
-    rescue # rexml random crash on invalid xml
-      []
     end
 
     def style_tag_for(stylesheet)

data/lib/pdfkit/version.rb

@@ -1,3 +1,3 @@
 class PDFKit
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/middleware_spec.rb

@@ -151,5 +151,45 @@ describe PDFKit::Middleware do
       body.should == "NO MATCH"
     end
   end
+  
+  describe "#translate_paths with root_url configuration" do
+    before do
+      @pdf = PDFKit::Middleware.new({})
+      @env = { 'REQUEST_URI' => 'http://example.com/document.pdf', 'rack.url_scheme' => 'http', 'HTTP_HOST' => 'example.com' }
+      PDFKit.configure do |config|
+        config.root_url = "http://example.net/"
+      end
+    end
+
+    it "should add the root_url" do
+      @body = %{<html><head><link href='/stylesheets/application.css' media='screen' rel='stylesheet' type='text/css' /></head><body><img alt='test' src="/test.png" /></body></html>}
+      body = @pdf.send :translate_paths, @body, @env
+      body.should == "<html><head><link href='http://example.net/stylesheets/application.css' media='screen' rel='stylesheet' type='text/css' /></head><body><img alt='test' src=\"http://example.net/test.png\" /></body></html>"
+    end
+    
+    after do
+      PDFKit.configure do |config|
+        config.root_url = nil
+      end
+    end
+  end
+
+  it "should not get stuck rendering each request as pdf" do
+    mock_app
+    # false by default. No requests.
+    @app.send(:rendering_pdf?).should be_false
+
+    # Remain false on a normal request
+    get 'http://www.example.org/public/file'
+    @app.send(:rendering_pdf?).should be_false
+
+    # Return true on a pdf request.
+    get 'http://www.example.org/public/file.pdf'
+    @app.send(:rendering_pdf?).should be_true
+
+    # Restore to false on any non-pdf request.
+    get 'http://www.example.org/public/file'
+    @app.send(:rendering_pdf?).should be_false
+  end
 
 end

data/spec/pdfkit_spec.rb

@@ -105,6 +105,36 @@ describe PDFKit do
       pdfkit.command[pdfkit.command.index('"--page-size"') + 1].should == '"Legal"'
       pdfkit.command[pdfkit.command.index('"--orientation"') + 1].should == '"Landscape"'
     end
+
+    it "should detect special pdfkit meta tags despite bad markup" do
+      body = %{
+        <html>
+          <head>
+            <meta name="pdfkit-page_size" content="Legal"/>
+            <meta name="pdfkit-orientation" content="Landscape"/>
+          </head>
+          <br>
+        </html>
+      }
+      pdfkit = PDFKit.new(body)
+      pdfkit.command[pdfkit.command.index('"--page-size"') + 1].should == '"Legal"'
+      pdfkit.command[pdfkit.command.index('"--orientation"') + 1].should == '"Landscape"'
+    end
+
+    it "should skip non-pdfkit meta tags" do
+      body = %{
+        <html>
+          <head>
+            <meta name="test-page_size" content="Legal"/>
+            <meta name="pdfkit-orientation" content="Landscape"/>
+          </head>
+          <br>
+        </html>
+      }
+      pdfkit = PDFKit.new(body)
+      pdfkit.command[pdfkit.command.index('"--orientation"') + 1].should == '"Landscape"'
+    end
+
   end
 
   context "#to_pdf" do
@@ -166,6 +196,15 @@ describe PDFKit do
       file.should be_instance_of(File)
       File.read(file.path)[0...4].should == "%PDF" # PDF Signature at beginning of file
     end
+
+    it "should not truncate data (in Ruby 1.8.6)" do
+      file_path = File.join(SPEC_ROOT,'fixtures','example.html')
+      pdfkit = PDFKit.new(File.new(file_path))
+      pdf_data = pdfkit.to_pdf
+      file = pdfkit.to_file(@file_path)
+      file_data = open(@file_path, 'rb') {|io| io.read }
+      pdf_data.size.should == file_data.size
+    end
   end
 
   context "security" do

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pdfkit
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 9
+  prerelease: 
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Jared Pace
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-27 00:00:00 -05:00
+date: 2011-06-17 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,6 +27,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 2
         - 2
@@ -41,6 +43,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 47
         segments: 
         - 0
         - 9
@@ -56,6 +59,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 0
         - 5
@@ -110,6 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -118,13 +123,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: pdfkit
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: HTML+CSS -> PDF