pdfkit 0.4.6 → 0.5.2

data/lib/pdfkit.rb

@@ -1,5 +1,4 @@
-require 'rubygems'
 require 'pdfkit/source'
 require 'pdfkit/pdfkit'
 require 'pdfkit/middleware'
-require 'pdfkit/configuration'
+require 'pdfkit/configuration'

data/pdfkit.gemspec

@@ -1,85 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pdfkit/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{pdfkit}
-  s.version = "0.4.6"
+  s.name        = "pdfkit"
+  s.version     = PDFKit::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jared Pace", "Relevance"]
+  s.email       = ["jared@codewordstudios.com"]
+  s.homepage    = "http://github.com/jdpace/PDFKit"
+  s.summary     = "HTML+CSS -> PDF"
+  s.description = "Uses wkhtmltopdf to create PDFs using HTML"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["jdpace"]
-  s.date = %q{2010-09-03}
-  s.default_executable = %q{pdfkit}
-  s.description = %q{Uses wkhtmltopdf to create PDFs using HTML}
-  s.email = %q{jared@codewordstudios.com}
-  s.executables = ["pdfkit"]
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.md"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     ".rspec",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "POST_INSTALL",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "bin/pdfkit",
-     "lib/pdfkit.rb",
-     "lib/pdfkit/configuration.rb",
-     "lib/pdfkit/middleware.rb",
-     "lib/pdfkit/pdfkit.rb",
-     "lib/pdfkit/source.rb",
-     "pdfkit.gemspec",
-     "spec/fixtures/example.css",
-     "spec/fixtures/example.html",
-     "spec/middleware_spec.rb",
-     "spec/pdfkit_spec.rb",
-     "spec/source_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/jdpace/PDFKit}
-  s.post_install_message = %q{******************************************************************
+  s.rubyforge_project = "pdfkit"
 
-Now install wkhtmltopdf binaries:
-Global: sudo `which pdfkit` --install-wkhtmltopdf
-or inside RVM folder: export TO=`which pdfkit | sed 's:/pdfkit:/wkhtmltopdf:'` && pdfkit --install-wkhtmltopdf
-(run pdfkit --help to see more options)
-
-******************************************************************}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{HTML+CSS -> PDF}
-  s.test_files = [
-    "spec/middleware_spec.rb",
-     "spec/pdfkit_spec.rb",
-     "spec/source_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
-      s.add_development_dependency(%q<rspec-core>, ["~> 2.0.0.beta.8"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
-      s.add_dependency(%q<rspec-core>, ["~> 2.0.0.beta.8"])
-      s.add_dependency(%q<mocha>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
-    s.add_dependency(%q<rspec-core>, ["~> 2.0.0.beta.8"])
-    s.add_dependency(%q<mocha>, [">= 0"])
-  end
+  # Developmnet Dependencies
+  s.add_development_dependency(%q<rspec>, ["~> 2.2.0"])
+  s.add_development_dependency(%q<mocha>, [">= 0.9.10"])
+  s.add_development_dependency(%q<rack-test>, [">= 0.5.6"])
+  s.add_development_dependency(%q<activesupport>, [">= 3.0.8"])
 end
 

data/spec/middleware_spec.rb

@@ -1,11 +1,136 @@
 require 'spec_helper'
 
+def app; Rack::Lint.new(@app); end
+
+def mock_app(options = {}, conditions = {})
+  main_app = lambda { |env|
+    @env = env
+    headers = {'Content-Type' => "text/html"}
+    [200, headers, @body || ['Hello world!']]
+  }
+
+  builder = Rack::Builder.new
+  builder.use PDFKit::Middleware, options, conditions
+  builder.run main_app
+  @app = builder.to_app
+end
+
 describe PDFKit::Middleware do
+
+  describe "#call" do
+    describe "conditions" do
+      describe ":only" do
+
+        describe "regex" do
+          describe "one" do
+            before { mock_app({}, :only => %r[^/public]) }
+
+            context "matching" do
+              specify do
+                get 'http://www.example.org/public/test.pdf'
+                last_response.headers["Content-Type"].should == "application/pdf"
+                last_response.body.bytesize.should == PDFKit.new("Hello world!").to_pdf.bytesize
+              end
+            end
+
+            context "not matching" do
+              specify do
+                get 'http://www.example.org/secret/test.pdf'
+                last_response.headers["Content-Type"].should == "text/html"
+                last_response.body.should == "Hello world!"
+              end
+            end
+          end # one regex
+
+          describe "multiple" do
+            before { mock_app({}, :only => [%r[^/invoice], %r[^/public]]) }
+
+            context "matching" do
+              specify do
+                get 'http://www.example.org/public/test.pdf'
+                last_response.headers["Content-Type"].should == "application/pdf"
+                last_response.body.bytesize.should == PDFKit.new("Hello world!").to_pdf.bytesize
+              end
+            end
+
+            context "not matching" do
+              specify do
+                get 'http://www.example.org/secret/test.pdf'
+                last_response.headers["Content-Type"].should == "text/html"
+                last_response.body.should == "Hello world!"
+              end
+            end
+          end # multiple regex
+        end # regex
+
+        describe "string" do
+          describe "one" do
+            before { mock_app({}, :only => '/public') }
+
+            context "matching" do
+              specify do
+                get 'http://www.example.org/public/test.pdf'
+                last_response.headers["Content-Type"].should == "application/pdf"
+                last_response.body.bytesize.should == PDFKit.new("Hello world!").to_pdf.bytesize
+              end
+            end
+
+            context "not matching" do
+              specify do
+                get 'http://www.example.org/secret/test.pdf'
+                last_response.headers["Content-Type"].should == "text/html"
+                last_response.body.should == "Hello world!"
+              end
+            end
+          end # one string
+
+          describe "multiple" do
+            before { mock_app({}, :only => ['/invoice', '/public']) }
+
+            context "matching" do
+              specify do
+                get 'http://www.example.org/public/test.pdf'
+                last_response.headers["Content-Type"].should == "application/pdf"
+                last_response.body.bytesize.should == PDFKit.new("Hello world!").to_pdf.bytesize
+              end
+            end
+
+            context "not matching" do
+              specify do
+                get 'http://www.example.org/secret/test.pdf'
+                last_response.headers["Content-Type"].should == "text/html"
+                last_response.body.should == "Hello world!"
+              end
+            end
+          end # multiple string
+        end # string
+
+      end
+    end
+
+    describe "remove .pdf from PATH_INFO and REQUEST_URI" do
+      before { mock_app }
+
+      context "matching" do
+        specify do
+          get 'http://www.example.org/public/file.pdf'
+          @env["PATH_INFO"].should == "/public/file"
+          @env["REQUEST_URI"].should == "/public/file"
+        end
+        specify do
+          get 'http://www.example.org/public/file.txt'
+          @env["PATH_INFO"].should == "/public/file.txt"
+          @env["REQUEST_URI"].should be_nil
+        end
+      end
+
+    end
+  end
+
   describe "#translate_paths" do
-    
     before do
       @pdf = PDFKit::Middleware.new({})
-      @env = {'REQUEST_URI' => 'http://example.com/document.pdf', 'rack.url_scheme' => 'http', 'HTTP_HOST' => 'example.com'}
+      @env = { 'REQUEST_URI' => 'http://example.com/document.pdf', 'rack.url_scheme' => 'http', 'HTTP_HOST' => 'example.com' }
     end
 
     it "should correctly parse relative url with single quotes" do
@@ -27,23 +152,44 @@ describe PDFKit::Middleware do
     end
   end
   
-  describe "#set_request_to_render_as_pdf" do
-    
-    before do      
+  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
 
-      @pdf_env = {'PATH_INFO' => Pathname.new("file.pdf"), 'REQUEST_URI' => Pathname.new("file.pdf")}
-      @non_pdf_env = {'PATH_INFO' => Pathname.new("file.txt"), 'REQUEST_URI' => Pathname.new("file.txt")}
+    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
     
-    it "should replace .pdf in PATH_INFO when the extname is .pdf" do
-      @pdf.send :set_request_to_render_as_pdf, @pdf_env
-      @pdf_env['PATH_INFO'].should == "file"
+    after do
+      PDFKit.configure do |config|
+        config.root_url = nil
+      end
     end
-    
-    it "should replace .pdf in REQUEST_URI when the extname is .pdf" do
-      @pdf.send :set_request_to_render_as_pdf, @pdf_env
-      @pdf_env['REQUEST_URI'].should == "file"
-    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

@@ -1,84 +1,95 @@
+#encoding: UTF-8
 require 'spec_helper'
 
 describe PDFKit do
-  
+
   context "initialization" do
     it "should accept HTML as the source" do
       pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
       pdfkit.source.should be_html
       pdfkit.source.to_s.should == '<h1>Oh Hai</h1>'
     end
-    
+
     it "should accept a URL as the source" do
       pdfkit = PDFKit.new('http://google.com')
       pdfkit.source.should be_url
       pdfkit.source.to_s.should == 'http://google.com'
     end
-    
+
     it "should accept a File as the source" do
       file_path = File.join(SPEC_ROOT,'fixtures','example.html')
       pdfkit = PDFKit.new(File.new(file_path))
       pdfkit.source.should be_file
       pdfkit.source.to_s.should == file_path
     end
-    
+
     it "should parse the options into a cmd line friedly format" do
       pdfkit = PDFKit.new('html', :page_size => 'Letter')
       pdfkit.options.should have_key('--page-size')
     end
-    
+
     it "should provide default options" do
       pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
-      ['--disable-smart-shrinking', '--margin-top', '--margin-right', '--margin-bottom', '--margin-left'].each do |option|
+      ['--margin-top', '--margin-right', '--margin-bottom', '--margin-left'].each do |option|
         pdfkit.options.should have_key(option)
       end
     end
-    
+
     it "should default to 'UTF-8' encoding" do
       pdfkit = PDFKit.new('Captación')
       pdfkit.options['--encoding'].should == 'UTF-8'
     end
-    
+
     it "should not have any stylesheedt by default" do
       pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
       pdfkit.stylesheets.should be_empty
     end
   end
-  
+
   context "command" do
     it "should contstruct the correct command" do
       pdfkit = PDFKit.new('html', :page_size => 'Letter', :toc_l1_font_size => 12)
       pdfkit.command[0].should include('wkhtmltopdf')
-      pdfkit.command[pdfkit.command.index('--page-size') + 1].should == 'Letter'
-      pdfkit.command[pdfkit.command.index('--toc-l1-font-size') + 1].should == '12'
+      pdfkit.command[pdfkit.command.index('"--page-size"') + 1].should == '"Letter"'
+      pdfkit.command[pdfkit.command.index('"--toc-l1-font-size"') + 1].should == '"12"'
     end
-    
+
     it "will not include default options it is told to omit" do
+      PDFKit.configure do |config|
+        config.default_options[:disable_smart_shrinking] = true
+      end
+
       pdfkit = PDFKit.new('html')
-      pdfkit.command.should include('--disable-smart-shrinking')
+      pdfkit.command.should include('"--disable-smart-shrinking"')
       pdfkit = PDFKit.new('html', :disable_smart_shrinking => false)
-      pdfkit.command.should_not include('--disable-smart-shrinking')
+      pdfkit.command.should_not include('"--disable-smart-shrinking"')
     end
-    
+
     it "should encapsulate string arguments in quotes" do
       pdfkit = PDFKit.new('html', :header_center => "foo [page]")
-      pdfkit.command[pdfkit.command.index('--header-center') + 1].should == 'foo [page]'
+      pdfkit.command[pdfkit.command.index('"--header-center"') + 1].should == '"foo [page]"'
     end
-    
+
     it "read the source from stdin if it is html" do
       pdfkit = PDFKit.new('html')
-      pdfkit.command[-2..-1].should == ['-', '-']
+      pdfkit.command[-2..-1].should == ['"-"', '"-"']
     end
-    
+
     it "specify the URL to the source if it is a url" do
       pdfkit = PDFKit.new('http://google.com')
-      pdfkit.command[-2..-1].should == ['http://google.com', '-']
+      pdfkit.command[-2..-1].should == ['"http://google.com"', '"-"']
     end
-    
+
     it "should specify the path to the source if it is a file" do
       file_path = File.join(SPEC_ROOT,'fixtures','example.html')
       pdfkit = PDFKit.new(File.new(file_path))
-      pdfkit.command[-2..-1].should == [file_path, '-']
+      pdfkit.command[-2..-1].should == [%Q{"#{file_path}"}, '"-"']
+    end
+
+    it "should specify the path for the ouput if a apth is given" do
+      file_path = "/path/to/output.pdf"
+      pdfkit = PDFKit.new("html")
+      pdfkit.command(file_path).last.should == %Q{"#{file_path}"}
     end
 
     it "should detect special pdfkit meta tags" do
@@ -91,30 +102,60 @@ describe PDFKit do
         </html>
       }
       pdfkit = PDFKit.new(body)
-      pdfkit.command[pdfkit.command.index('--page-size') + 1].should == 'Legal'
-      pdfkit.command[pdfkit.command.index('--orientation') + 1].should == 'Landscape'
+      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
     it "should generate a PDF of the HTML" do
       pdfkit = PDFKit.new('html', :page_size => 'Letter')
       pdf = pdfkit.to_pdf
       pdf[0...4].should == "%PDF" # PDF Signature at beginning of file
     end
-    
+
     it "should generate a PDF with a numerical parameter" do
       pdfkit = PDFKit.new('html', :header_spacing => 1)
       pdf = pdfkit.to_pdf
       pdf[0...4].should == "%PDF" # PDF Signature at beginning of file
     end
-    
+
     it "should generate a PDF with a symbol parameter" do
       pdfkit = PDFKit.new('html', :page_size => :Letter)
       pdf = pdfkit.to_pdf
       pdf[0...4].should == "%PDF" # PDF Signature at beginning of file
     end
-    
+
     it "should have the stylesheet added to the head if it has one" do
       pdfkit = PDFKit.new("<html><head></head><body>Hai!</body></html>")
       css = File.join(SPEC_ROOT,'fixtures','example.css')
@@ -122,7 +163,7 @@ describe PDFKit do
       pdfkit.to_pdf
       pdfkit.source.to_s.should include("<style>#{File.read(css)}</style>")
     end
-    
+
     it "should prepend style tags if the HTML doesn't have a head tag" do
       pdfkit = PDFKit.new("<html><body>Hai!</body></html>")
       css = File.join(SPEC_ROOT,'fixtures','example.css')
@@ -130,49 +171,66 @@ describe PDFKit do
       pdfkit.to_pdf
       pdfkit.source.to_s.should include("<style>#{File.read(css)}</style><html>")
     end
-    
+
     it "should throw an error if the source is not html and stylesheets have been added" do
       pdfkit = PDFKit.new('http://google.com')
       css = File.join(SPEC_ROOT,'fixtures','example.css')
       pdfkit.stylesheets << css
       lambda { pdfkit.to_pdf }.should raise_error(PDFKit::ImproperSourceError)
     end
+
+    it "should be able to deal with ActiveSupport::SafeBuffer" do
+      pdfkit = PDFKit.new(ActiveSupport::SafeBuffer.new "<html><head></head><body>Hai!</body></html>")
+      css = File.join(SPEC_ROOT,'fixtures','example.css')
+      pdfkit.stylesheets << css
+      pdfkit.to_pdf
+      pdfkit.source.to_s.should include("<style>#{File.read(css)}</style></head>")
+    end
+
   end
-  
+
   context "#to_file" do
     before do
       @file_path = File.join(SPEC_ROOT,'fixtures','test.pdf')
       File.delete(@file_path) if File.exist?(@file_path)
     end
-    
+
     after do
       File.delete(@file_path)
     end
-    
+
     it "should create a file with the PDF as content" do
       pdfkit = PDFKit.new('html', :page_size => 'Letter')
-      pdfkit.expects(:to_pdf).returns('PDF')
       file = pdfkit.to_file(@file_path)
       file.should be_instance_of(File)
-      File.read(file.path).should == 'PDF'
+      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
     before do
       @test_path = File.join(SPEC_ROOT,'fixtures','security-oops')
       File.delete(@test_path) if File.exist?(@test_path)
     end
-    
+
     after do
       File.delete(@test_path) if File.exist?(@test_path)
     end
-    
+
     it "should not allow shell injection in options" do
       pdfkit = PDFKit.new('html', :header_center => "a title\"; touch #{@test_path} #")
       pdfkit.to_pdf
       File.exist?(@test_path).should be_false
     end
   end
-  
+
 end

data/spec/source_spec.rb

@@ -17,6 +17,11 @@ describe PDFKit::Source do
       source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
       source.should_not be_url
     end
+
+    it "should return false if passed HTML with embedded urls at the beginning of a line" do
+      source = PDFKit::Source.new("<blink>Oh Hai!</blink>\nhttp://www.google.com")
+      source.should_not be_url
+    end
   end
   
   describe "#file?" do

data/spec/spec_helper.rb

@@ -6,13 +6,10 @@ require 'rspec'
 require 'rspec/autorun'
 require 'mocha'
 require 'rack'
+require 'rack/test'
+require 'active_support'
+require 'custom_wkhtmltopdf_path' if File.exists?(File.join(SPEC_ROOT, 'custom_wkhtmltopdf_path.rb'))
 
 RSpec.configure do |config|
-  
-  config.before do
-    PDFKit.any_instance.stubs(:wkhtmltopdf).returns(
-      File.join(SPEC_ROOT,'..','bin','wkhtmltopdf-proxy')
-    )
-  end
-  
+  include Rack::Test::Methods
 end