wkhtmltopdf_for_rails 0.0.1

data/Manifest

@@ -0,0 +1,16 @@
+Manifest
+bin/wkhtmltopdf
+bin/wkhtmltopdf-amd64
+bin/wkhtmltopdf-binary.rb
+bin/wkhtmltopdf_darwin_386
+bin/wkhtmltopdf_linux_386
+init.rb
+lib/render_pdf.rb
+lib/wkhtmltopdf.rb
+lib/wkhtmltopdf_for_rails.rb
+rakefile
+test/fixtures/wkhtmltopdf.html
+test/test_helper.rb
+test/wkhtmltopdf_test.rb
+test/wkhtmltopdf_test_controller_test.rb
+Rakefile

data/Rakefile

@@ -0,0 +1,13 @@
+# Rakefile
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('wkhtmltopdf_for_rails', '0.0.1') do |p|
+  p.description    = "Provides WKHTMLTOPDF for ruby on rails."
+  p.url            = "http://github.com/aratak/wkhtmltopdf_for_rails"
+  p.author         = "Alexey Osipenko"
+  p.email          = "alexey@osipenko.in.ua"
+  p.ignore_pattern = ["pkg/*"]
+  p.development_dependencies = []
+end

data/bin/wkhtmltopdf

@@ -0,0 +1,15 @@
+#!/usr/bin/ruby
+
+if RUBY_PLATFORM =~ /linux/ && RUBY_PLATFORM =~ /386/
+  executable = 'wkhtmltopdf_linux_386'
+elsif RUBY_PLATFORM =~ /linux/ && RUBY_PLATFORM =~ /64/
+  executable = 'wkhtmltopdf-amd64'
+elsif RUBY_PLATFORM =~ /darwin/
+  executable = 'wkhtmltopdf_darwin_386'
+else
+  raise "Invalid platform. Must be running linux or intel-based Mac OS."
+end
+
+executable = File.join(File.dirname(__FILE__), executable)
+system(executable + " " + $*.join(" "))
+

data/init.rb

@@ -0,0 +1,7 @@
+require 'render_pdf'
+require 'wkhtmltopdf'
+
+Mime::Type.register 'application/pdf', :pdf
+
+ActionController::Base.send(:include, RenderPdf)
+

data/lib/render_pdf.rb

@@ -0,0 +1,62 @@
+module RenderPdf
+  
+  def render_to_pdf(options = {})
+    make_pdf(options)
+    # pdf_file_name = "#{options[:file_path]}/#{options[:pdf]}.pdf"
+    send_pdf_options = {
+      :filename => "#{options[:pdf]}.pdf",
+      :type     => 'application/pdf'
+    }
+    # if options[:delete_generated_pdf]
+    #   send_pdf_options[:stream] = false
+    # end
+    
+    send_data(make_pdf(options), send_pdf_options)
+    
+    # if options[:delete_generated_pdf] && File.exists?(pdf_file_name)
+    #   File.delete(pdf_file_name)
+    # end
+  end
+  
+  private
+  
+  def make_pdf(options)
+    if options.has_key?(:template)
+      html_string = generate_html(options)
+      timestamp = Time.now.strftime("%y%m%d%H%M%S")
+      html_file_name = "#{timestamp}_#{options[:pdf]}.html"
+      html_file_path = File.join(RAILS_ROOT, 'tmp', html_file_name)
+      File.open(html_file_path, 'w') do |f|
+        f.write(html_string)
+      end
+      options[:html_file] = html_file_path
+    end
+    
+    pdf = Wkhtmltopdf.new(options)
+    pdf.generate
+
+    # if html_file_path.present? && File.exists?(html_file_path)
+    #   File.delete(html_file_path)
+    # end
+  end
+  
+  def generate_html(options)
+    render_options = {}
+    render_options[:template] = options.delete(:template)
+    render_options[:layout] = options.delete(:layout) if options.has_key?(:layout)
+    
+    html_string = render_to_string(render_options)
+    
+    # re-route absolute paths for images, scripts and stylesheets
+    html_string.gsub!( /src=["']+([^:]+?)["']/i ) { |m| "src=\"#{RAILS_ROOT}/public" + $1 + '"' }
+    html_string.gsub!( /<link href=["']+([^:]+?)["']/i ) { |m| "<link href=\"#{RAILS_ROOT}/public" + $1 + '"' }
+    
+    # Remove asset ids on images, scripts, and stylesheets with a regex
+    html_string.gsub!( /src=["'](\S+\?\d*)["']/i ) { |m| 'src="' + $1.split('?').first + '"' }
+    html_string.gsub!( /<link href=["'](\S+\?\d*)["']/i ) { |m| '<link href="' + $1.split('?').first + '"' }
+    
+    return html_string
+  end
+  
+end
+

data/lib/wkhtmltopdf.rb

@@ -0,0 +1,43 @@
+class Wkhtmltopdf
+  
+  attr_accessor :pdf_file, :html_file, :source, :optional_params, :params_string
+  
+  def initialize(options)
+    # @pdf_file = "#{options[:file_path]}/#{options[:pdf]}.pdf"
+    @html_file = options[:html_file] if options.has_key?(:html_file)
+    @source = options[:source] if options.has_key?(:source)
+    @optional_params = options[:wkhtmltopdf_options] if options.has_key?(:wkhtmltopdf_options)
+    create_params_string
+  end
+  
+  def generate
+    wkhtml_call = "wkhtmltopdf "
+    if !@source.nil?
+      puts "source"
+      wkhtml_call << "#{@source}"
+    else
+      puts "local html"
+      wkhtml_call << "#{@html_file}"
+    end
+    wkhtml_call << " #{@params_string} - -q"
+    return `#{wkhtml_call}`
+  end
+  
+  private
+  
+  def create_params_string
+    params_arr = []
+    unless @optional_params.nil?
+      @optional_params.each do |key, val|
+        if val && val.is_a?(String)
+          params_arr << "--#{key.to_s} '#{val}'"
+        elsif val
+          params_arr << "--#{key.to_s}"
+        end
+      end
+    end
+    @params_string = params_arr.join(' ')
+  end
+  
+end
+

data/lib/wkhtmltopdf_for_rails.rb

@@ -0,0 +1,6 @@
+require 'render_pdf'
+require 'wkhtmltopdf'
+
+Mime::Type.register 'application/pdf', :pdf
+
+ActionController::Base.send(:include, RenderPdf)

data/rakefile

@@ -0,0 +1,13 @@
+# Rakefile
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('wkhtmltopdf_for_rails', '0.0.1') do |p|
+  p.description    = "Provides WKHTMLTOPDF for ruby on rails."
+  p.url            = "http://github.com/aratak/wkhtmltopdf_for_rails"
+  p.author         = "Alexey Osipenko"
+  p.email          = "alexey@osipenko.in.ua"
+  p.ignore_pattern = ["pkg/*"]
+  p.development_dependencies = []
+end

data/test/fixtures/wkhtmltopdf.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>Plugin Test</title>
+  
+  
+  <link href="/home/tom/rails/plugin_test/public/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" />
+  <script src="/home/tom/rails/plugin_test/public/javascripts/prototype.js" type="text/javascript"></script>
+<script src="/home/tom/rails/plugin_test/public/javascripts/effects.js" type="text/javascript"></script>
+<script src="/home/tom/rails/plugin_test/public/javascripts/dragdrop.js" type="text/javascript"></script>
+<script src="/home/tom/rails/plugin_test/public/javascripts/controls.js" type="text/javascript"></script>
+<script src="/home/tom/rails/plugin_test/public/javascripts/application.js" type="text/javascript"></script>
+  <script src="/home/tom/rails/plugin_test/public/javascripts/plotter.js" type="text/javascript"></script>
+
+  
+  <link href="/home/tom/rails/plugin_test/public/stylesheets/print.css" media="print" rel="stylesheet" type="text/css" />
+</head>
+
+<body>
+  <p>This is an html file</p>
+</body>
+</html>
+

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+
+require 'test/unit'
+require 'shoulda'
+
+module WkhtmltopdfHelper
+  
+  def valid_pdf_source_attributes
+    {
+      :pdf => 'wkhtmltopdf_test',
+      :file_path => File.join(File.dirname(__FILE__), 'pdfs'),
+      :source => "http://www.google.com/"
+    }
+  end
+  
+  def valid_pdf_html_attributes
+    {
+      :pdf => 'wkhtmltopdf_test',
+      :file_path => File.join(File.dirname(__FILE__), 'pdfs'),
+      :html_file => File.join(File.dirname(__FILE__), 'fixtures', 'wkhtmltopdf.html')
+    }
+  end
+  
+end
+

data/test/wkhtmltopdf_test.rb

@@ -0,0 +1,145 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/../lib/wkhtmltopdf'
+
+include WkhtmltopdfHelper
+
+class WkhtmltopdfTest < Test::Unit::TestCase
+  
+  context "new wkhtmltopdf with a source url" do
+    setup do
+      @options = valid_pdf_source_attributes
+      @pdf = Wkhtmltopdf.new(@options)
+    end
+    
+    subject { @pdf }
+    
+    should "set the instance methods on instantiation" do
+      assert_equal @options[:source], @pdf.source
+      assert_equal File.join(File.dirname(__FILE__), 'pdfs', 'wkhtmltopdf_test.pdf'), @pdf.pdf_file
+      assert_nil @pdf.html_file
+      assert_nil @pdf.optional_params
+    end
+    
+    should "set the params_string" do
+      assert_equal "", @pdf.params_string
+    end
+    
+    should "create the pdf" do
+      @pdf.generate
+      assert File.exists?(@pdf.pdf_file)
+      remove_pdf_after_generation(@pdf)
+    end
+  end
+  
+  context "new wkhtmltopdf with a local html file" do
+    setup do
+      @options = valid_pdf_html_attributes
+      @pdf = Wkhtmltopdf.new(@options)
+    end
+    
+    subject { @pdf }
+    
+    should "set the instance methods on instantiation" do
+      assert_equal File.join(File.dirname(__FILE__), 'fixtures', 'wkhtmltopdf.html'), @pdf.html_file
+      assert_equal File.join(File.dirname(__FILE__), 'pdfs', 'wkhtmltopdf_test.pdf'), @pdf.pdf_file
+      assert_nil @pdf.source
+      assert_nil @pdf.optional_params
+    end
+    
+    should "set the params_string" do
+      assert_equal "", @pdf.params_string
+    end
+    
+    should "create the pdf" do
+      @pdf.generate
+      assert File.exists?(@pdf.pdf_file)
+      remove_pdf_after_generation(@pdf)
+    end
+  end
+  
+  context "with optional params" do
+    setup do
+      @options = valid_pdf_source_attributes
+      @optional_params = {
+          :wkhtmltopdf_options => {
+            "footer-line" => true,
+            "footer-center" => "[page] / [toPage]",
+          }
+        }
+      @pdf = Wkhtmltopdf.new(@options.merge(@optional_params))
+    end
+    
+    subject { @pdf }
+    
+    should "set the instance methods on instantiation" do
+      assert_equal @options[:source], @pdf.source
+      assert_equal File.join(File.dirname(__FILE__), 'pdfs', 'wkhtmltopdf_test.pdf'), @pdf.pdf_file
+      assert_nil @pdf.html_file
+      assert_not_nil @pdf.optional_params
+      assert_equal @optional_params[:wkhtmltopdf_options], @pdf.optional_params
+    end
+    
+    should "set the params_string" do
+      assert_not_nil @pdf.params_string
+      assert_match /--footer-line/, @pdf.params_string
+      assert_match /--footer-center '\[page\] \/ \[toPage\]'/, @pdf.params_string
+    end
+    
+    should "create the pdf" do
+      @pdf.generate
+      assert File.exists?(@pdf.pdf_file)
+      remove_pdf_after_generation(@pdf)
+    end
+    
+    context "with symbol keys for optional params" do
+      setup do
+        @options = valid_pdf_source_attributes
+        @optional_params = {
+          :wkhtmltopdf_options => {
+            "footer-line" => true,
+            "footer-center" => "[page] / [toPage]",
+            :lowquality  => true,
+            :'print-media-type'  => true
+          }
+        }
+        @pdf = Wkhtmltopdf.new(@options.merge(@optional_params))
+      end
+      
+      subject { @pdf }
+      
+      should "set the params_string" do
+        assert_not_nil @pdf.params_string
+        assert_match /--footer-line/, @pdf.params_string
+        assert_match /--footer-center '\[page\] \/ \[toPage\]'/, @pdf.params_string
+        assert_match /--lowquality/, @pdf.params_string
+        assert_match /--print-media-type/, @pdf.params_string
+      end
+    end
+    
+    
+    context "with false values for optional params" do
+      setup do
+        @options = valid_pdf_source_attributes
+        @optional_params = {
+          :wkhtmltopdf_options => {
+            "footer-line" => false,
+            :lowquality  => false,
+            :'print-media-type'  => false
+          }
+        }
+        @pdf = Wkhtmltopdf.new(@options.merge(@optional_params))
+      end
+      
+      subject { @pdf }
+      
+      should "set the params_string" do
+        assert_equal "", @pdf.params_string
+      end
+    end
+  end
+  
+  def remove_pdf_after_generation(pdf)
+    File.delete(pdf.pdf_file) if File.exists?(pdf.pdf_file)
+  end
+  
+end

data/test/wkhtmltopdf_test_controller_test.rb

@@ -0,0 +1,92 @@
+require 'action_controller'
+require File.dirname(__FILE__) + '/test_helper'
+require 'shoulda/rails'
+require File.dirname(__FILE__) + '/../init.rb'
+
+RAILS_ROOT = File.dirname(__FILE__)
+
+class WkhtmltopdfTestController < ActionController::Base
+  def test_source
+    respond_to do |format|
+      format.pdf do
+        render_to_pdf({
+          :pdf       => "source", 
+          :file_path => File.join(File.dirname(__FILE__), 'pdfs'), 
+          :source    => "http://www.google.com/"
+        })
+      end
+    end
+  end
+  
+  def test_source_with_delete
+    respond_to do |format|
+      format.pdf do
+        render_to_pdf({
+          :pdf       => "source", 
+          :file_path => File.join(File.dirname(__FILE__), 'pdfs'), 
+          :source    => "http://www.google.com/",
+          :delete_generated_pdf  => true
+        })
+      end
+    end
+  end
+  
+  def test_html
+    respond_to do |format|
+      format.pdf do
+        render_to_pdf({
+          :pdf                   => "html", 
+          :file_path             => File.join(File.dirname(__FILE__), 'pdfs'), 
+          :template              => File.join(File.dirname(__FILE__), 'fixtures', 'wkhtmltopdf.html')
+        })
+      end
+    end
+  end
+end
+
+ActionController::Routing::Routes.draw do |map|
+  map.resources :pdfs,
+    :controller => 'wkhtmltopdf_test',
+    :collection => [:test_source, :test_source_with_delete, :test_html]
+end
+
+class WkhtmltopdfTestControllerTest < ActionController::TestCase
+  
+  context "on GET to pdf from a source" do
+    setup do
+      get :test_source, :format => "pdf"
+    end
+    
+    subject { @controller }
+    
+    should_respond_with :success
+    should_respond_with_content_type "application/pdf"
+  end
+  
+  context "on GET to pdf with deleting the pdf after generation" do
+    setup do
+      get :test_source_with_delete, :format => "pdf"
+    end
+    
+    subject { @controller }
+    
+    should_respond_with :success
+    should_respond_with_content_type "application/pdf"
+    
+    should "delete the pdf after sending the file" do
+      assert !File.exists?(File.join(File.dirname(__FILE__), 'pdfs', 'source.pdf'))
+    end
+  end
+  
+  context "on GET to pdf from a template" do
+    setup do
+      get :test_html, :format => "pdf"
+    end
+    
+    subject { @controller }
+    
+    should_respond_with :success
+    should_respond_with_content_type "application/pdf"
+  end
+  
+end

data/wkhtmltopdf_for_rails.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wkhtmltopdf_for_rails}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexey Osipenko"]
+  s.date = %q{2010-04-29}
+  s.description = %q{Provides WKHTMLTOPDF for ruby on rails.}
+  s.email = %q{alexey@osipenko.in.ua}
+  s.executables = ["wkhtmltopdf", "wkhtmltopdf-amd64", "wkhtmltopdf-binary.rb", "wkhtmltopdf_darwin_386", "wkhtmltopdf_linux_386"]
+  s.extra_rdoc_files = ["bin/wkhtmltopdf", "bin/wkhtmltopdf-amd64", "bin/wkhtmltopdf-binary.rb", "bin/wkhtmltopdf_darwin_386", "bin/wkhtmltopdf_linux_386", "lib/render_pdf.rb", "lib/wkhtmltopdf.rb", "lib/wkhtmltopdf_for_rails.rb"]
+  s.files = ["Manifest", "bin/wkhtmltopdf", "bin/wkhtmltopdf-amd64", "bin/wkhtmltopdf-binary.rb", "bin/wkhtmltopdf_darwin_386", "bin/wkhtmltopdf_linux_386", "init.rb", "lib/render_pdf.rb", "lib/wkhtmltopdf.rb", "lib/wkhtmltopdf_for_rails.rb", "rakefile", "test/fixtures/wkhtmltopdf.html", "test/test_helper.rb", "test/wkhtmltopdf_test.rb", "test/wkhtmltopdf_test_controller_test.rb", "Rakefile", "wkhtmltopdf_for_rails.gemspec"]
+  s.homepage = %q{http://github.com/aratak/wkhtmltopdf_for_rails}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Wkhtmltopdf_for_rails"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{wkhtmltopdf_for_rails}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Provides WKHTMLTOPDF for ruby on rails.}
+  s.test_files = ["test/test_helper.rb", "test/wkhtmltopdf_test.rb", "test/wkhtmltopdf_test_controller_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: wkhtmltopdf_for_rails
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alexey Osipenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-29 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Provides WKHTMLTOPDF for ruby on rails.
+email: alexey@osipenko.in.ua
+executables: 
+- wkhtmltopdf
+- wkhtmltopdf-amd64
+- wkhtmltopdf-binary.rb
+- wkhtmltopdf_darwin_386
+- wkhtmltopdf_linux_386
+extensions: []
+
+extra_rdoc_files: 
+- bin/wkhtmltopdf
+- bin/wkhtmltopdf-amd64
+- bin/wkhtmltopdf-binary.rb
+- bin/wkhtmltopdf_darwin_386
+- bin/wkhtmltopdf_linux_386
+- lib/render_pdf.rb
+- lib/wkhtmltopdf.rb
+- lib/wkhtmltopdf_for_rails.rb
+files: 
+- Manifest
+- bin/wkhtmltopdf
+- bin/wkhtmltopdf-amd64
+- bin/wkhtmltopdf-binary.rb
+- bin/wkhtmltopdf_darwin_386
+- bin/wkhtmltopdf_linux_386
+- init.rb
+- lib/render_pdf.rb
+- lib/wkhtmltopdf.rb
+- lib/wkhtmltopdf_for_rails.rb
+- rakefile
+- test/fixtures/wkhtmltopdf.html
+- test/test_helper.rb
+- test/wkhtmltopdf_test.rb
+- test/wkhtmltopdf_test_controller_test.rb
+- Rakefile
+- wkhtmltopdf_for_rails.gemspec
+has_rdoc: true
+homepage: http://github.com/aratak/wkhtmltopdf_for_rails
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Wkhtmltopdf_for_rails
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: wkhtmltopdf_for_rails
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provides WKHTMLTOPDF for ruby on rails.
+test_files: 
+- test/test_helper.rb
+- test/wkhtmltopdf_test.rb
+- test/wkhtmltopdf_test_controller_test.rb