wisepdf 1.0.0

data/test/dummy/log/test.log

@@ -0,0 +1,274 @@
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Compiled wisepdf.js  (0ms)  (pid 6915)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Compiled wisepdf.css  (0ms)  (pid 6915)
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction

data/test/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/test/dummy/public/javascripts/wisepdf.js

@@ -0,0 +1 @@
+// Wisepdf javascript

data/test/dummy/public/stylesheets/wisepdf.css

@@ -0,0 +1 @@
+/* Wisepdf styles */

data/test/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+
+ENV['RAILS_ENV'] = 'test'
+require "dummy/config/environment"
+require "rails/test_help"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'wisepdf'
+
+class Test::Unit::TestCase
+end

data/test/helper_assets_test.rb

@@ -0,0 +1,25 @@
+require 'helper'
+ 
+class AssetsHelperTest < ActionView::TestCase
+  include Wisepdf::Helper::Assets
+    
+  context "wisepdf_stylesheet_tag" do  
+    should 'include stylesheet if no extension is given' do
+      assert_match wisepdf_stylesheet_tag('wisepdf').strip, /Wisepdf styles/
+    end
+  
+    should 'include stylesheet if .css extension is given' do
+      assert_match wisepdf_stylesheet_tag('wisepdf.css').strip, /Wisepdf styles/
+    end
+  end  
+  
+  context "wisepdf_javascript_tag" do  
+    should 'include javascript if no extension is given' do
+      assert_match wisepdf_javascript_tag('wisepdf').strip, /Wisepdf javascript/
+    end
+  
+    should 'include javascript if .js extension is given' do
+      assert_match wisepdf_javascript_tag('wisepdf.js').strip, /Wisepdf javascript/
+    end
+  end  
+end

data/test/helper_legacy_test.rb

@@ -0,0 +1,25 @@
+require 'helper'
+ 
+class LegacyHelperTest < ActionView::TestCase
+  include Wisepdf::Helper::Legacy
+    
+  context "wisepdf_stylesheet_tag" do  
+    should 'include stylesheet if no extension is given' do
+      assert_match wisepdf_stylesheet_tag('wisepdf').strip, /Wisepdf styles/
+    end
+  
+    should 'include stylesheet if .css extension is given' do
+      assert_match wisepdf_stylesheet_tag('wisepdf.css').strip, /Wisepdf styles/
+    end
+  end  
+  
+  context "wisepdf_javascript_tag" do  
+    should 'include javascript if no extension is given' do
+      assert_match wisepdf_javascript_tag('wisepdf').strip, /Wisepdf javascript/
+    end
+  
+    should 'include javascript if .js extension is given' do
+      assert_match wisepdf_javascript_tag('wisepdf.js').strip, /Wisepdf javascript/
+    end
+  end  
+end

data/test/writer_test.rb

@@ -0,0 +1,204 @@
+require 'helper'
+
+HTML_DOCUMENT = "<html><body>Hello World</body></html>"
+
+# Provide a public accessor to the normally-private parse_options function
+class Wisepdf::Writer
+  public :parse_options
+end
+
+class WriterTest < Test::Unit::TestCase    
+  context "Default configuration" do
+    setup do
+      Wisepdf::Configuration.reset!
+    end
+    
+    should 'read default configuration' do
+      assert_equal 'pdf.html', Wisepdf::Configuration.options[:layout]
+      assert_equal false, Wisepdf::Configuration.options[:use_xserver]
+    end
+    
+    if RbConfig::CONFIG['target_os'] != 'mingw32'
+      should 'try to find wkhtmltopdf if not on windows' do
+        path = (defined?(Bundler) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+        
+        assert_equal path, Wisepdf::Configuration.wkhtmltopdf
+      end
+    end
+  end
+  
+  context "Configuration" do
+    setup do
+      Wisepdf::Configuration.reset!
+    end
+    
+    should 'accept and override default configuration' do
+      Wisepdf::Configuration.configure do |config|
+        config.wkhtmltopdf = '/path/to/wkhtmltopdf'
+        config.options = {
+          :layout => "layout.html",
+          :use_xserver => true,
+          :footer => { 
+            :right => "#{Date.today.year}",
+            :font_size => 8,
+            :spacing => 8
+          },
+          :margin => {
+            :bottom => 15
+          }
+        }
+      end
+      assert_equal '/path/to/wkhtmltopdf', Wisepdf::Configuration.wkhtmltopdf
+      
+      assert_equal 'layout.html', Wisepdf::Configuration.options[:layout]
+      assert_equal true, Wisepdf::Configuration.options[:use_xserver]
+      assert_equal "#{Date.today.year}", Wisepdf::Configuration.options[:footer][:right]
+      assert_equal 8, Wisepdf::Configuration.options[:footer][:font_size]
+      assert_equal 8, Wisepdf::Configuration.options[:footer][:spacing]
+      assert_equal 15, Wisepdf::Configuration.options[:margin][:bottom]
+    end
+  end  
+  
+  context "Option parsing" do
+    setup do
+      Wisepdf::Configuration.reset!
+    end
+    
+    should "parse header and footer options" do
+      wp = Wisepdf::Writer.new
+  
+      [:header, :footer].each do |hf|
+        [:center, :font_name, :left, :right].each do |o|
+          assert_equal  "--#{hf.to_s}-#{o.to_s.gsub('_', '-')} \"header_footer\"",
+                        wp.parse_options(hf => {o => "header_footer"}).strip
+        end
+  
+        [:font_size, :spacing].each do |o|
+          assert_equal  "--#{hf.to_s}-#{o.to_s.gsub('_', '-')} 12",
+                        wp.parse_options(hf => {o => "12"}).strip
+        end
+  
+        assert_equal  "--#{hf.to_s}-line",
+                      wp.parse_options(hf => {:line => true}).strip
+        assert_equal  "--#{hf.to_s}-html \"http://www.abc.com\"",
+                      wp.parse_options(hf => {:html => {:url => 'http://www.abc.com'}}).strip
+      end
+    end
+
+    should "parse toc options" do
+      wp = Wisepdf::Writer.new
+      
+      [:level_indentation, :header_text].each do |o|
+        assert_equal  "toc --toc-#{o.to_s.gsub('_', '-')} \"toc\"",
+                      wp.parse_options(:toc => {o => "toc"}).strip
+      end
+  
+      [:text_size_shrink].each do |o|
+        assert_equal  "toc --toc-#{o.to_s.gsub('_', '-')} 5",
+                      wp.parse_options(:toc => {o => 5}).strip
+      end
+  
+      [:disable_toc_links, :disable_dotted_lines].each do |o|
+        assert_equal  "toc --#{o.to_s.gsub('_', '-')}",
+                      wp.parse_options(:toc => {o => true}).strip
+      end
+    end
+  
+    should "parse outline options" do
+      wp = Wisepdf::Writer.new
+  
+      assert_equal "--outline", wp.parse_options(:outline => {:outline => true}).strip
+      assert_equal "--outline-depth 5", wp.parse_options(:outline => {:outline_depth => 5}).strip
+    end
+  
+    should "parse margins options" do
+      wp = Wisepdf::Writer.new
+  
+      [:top, :bottom, :left, :right].each do |o|
+        assert_equal "--margin-#{o.to_s} 12", wp.parse_options(:margin => {o => "12"}).strip
+      end
+    end
+
+    should "parse other options" do
+      wp = Wisepdf::Writer.new
+  
+      [ :orientation, :page_size, :proxy, :username, :password, :cover, :dpi,
+        :encoding, :user_style_sheet
+      ].each do |o|
+        assert_equal "--#{o.to_s.gsub('_', '-')} \"opts\"", wp.parse_options(o => "opts").strip
+      end
+  
+      [:cookie, :post].each do |o|
+        assert_equal "--#{o.to_s.gsub('_', '-')} name value", wp.parse_options(o => "name value").strip
+  
+        nv_formatter = ->(number){ "--#{o.to_s.gsub('_', '-')} par#{number} val#{number}" }
+        assert_equal "#{nv_formatter.call(1)} #{nv_formatter.call(2)}", wp.parse_options(o => ['par1 val1', 'par2 val2']).strip
+      end
+  
+      [:redirect_delay, :zoom, :page_offset].each do |o|
+        assert_equal "--#{o.to_s.gsub('_', '-')} 5", wp.parse_options(o => 5).strip
+      end
+  
+      [ :book, :default_header, :disable_javascript, :greyscale, :lowquality,
+        :enable_plugins, :disable_internal_links, :disable_external_links,
+        :print_media_type, :disable_smart_shrinking, :use_xserver, :no_background
+      ].each do |o|
+        assert_equal "--#{o.to_s.gsub('_', '-')}", wp.parse_options(o => true).strip
+      end
+    end
+    
+  end
+  
+  context "PDF generation" do  
+    should "generate PDF from html document" do
+      writer = Wisepdf::Writer.new
+      pdf = writer.to_pdf(HTML_DOCUMENT)
+      assert pdf.start_with?("%PDF-1.4")
+      assert pdf.rstrip.end_with?("%%EOF")
+      assert pdf.length > 100
+    end
+
+    should "raise exception when no path to wkhtmltopdf" do
+      assert_raise Wisepdf::NoExecutableError do
+        writer = Wisepdf::Writer.new(" ")
+        writer.to_pdf(HTML_DOCUMENT)
+      end
+    end
+
+    should "raise exception when wkhtmltopdf path is wrong" do
+      assert_raise Wisepdf::NoExecutableError do
+        writer = Wisepdf::Writer.new("/i/do/not/exist/notwkhtmltopdf")
+        writer.to_pdf(HTML_DOCUMENT)
+      end
+    end
+  
+    should "raise exception when wkhtmltopdf is not executable" do
+      begin
+        tmp = Tempfile.new('wkhtmltopdf')
+        fp = tmp.path
+        File.chmod 0000, fp
+        assert_raise Wisepdf::WriteError do
+          writer = Wisepdf::Writer.new(fp)
+          writer.to_pdf(HTML_DOCUMENT)          
+        end
+      ensure
+        tmp.delete
+      end
+    end
+
+  
+    should "raise exception when pdf generation fails" do
+      begin
+        tmp = Tempfile.new('wkhtmltopdf')
+        fp = tmp.path
+        File.chmod 0777, fp
+        assert_raise Wisepdf::WriteError do
+          writer = Wisepdf::Writer.new(fp)
+          writer.to_pdf(HTML_DOCUMENT)          
+        end
+      ensure
+        tmp.delete
+      end
+    end  
+  end    
+end