wisepdf 1.0.0

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'rails', '>=3.0.0'
+
+group :development, :test do
+  gem 'sqlite3-ruby'
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end

data/Gemfile.lock

@@ -0,0 +1,102 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.2)
+      actionpack (= 3.2.2)
+      mail (~> 2.4.0)
+    actionpack (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+    activerecord (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    journey (1.0.3)
+    json (1.6.5)
+    mail (2.4.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.1.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.2)
+      actionmailer (= 3.2.2)
+      actionpack (= 3.2.2)
+      activerecord (= 3.2.2)
+      activeresource (= 3.2.2)
+      activesupport (= 3.2.2)
+      bundler (~> 1.0)
+      railties (= 3.2.2)
+    railties (3.2.2)
+      actionpack (= 3.2.2)
+      activesupport (= 3.2.2)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.32)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rails (>= 3.0.0)
+  shoulda
+  sqlite3-ruby

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Miles Z. Sterret
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,243 @@
+# wisepdf
+
+Wkhtmltopdf wrapper done right.
+
+**Wisepdf** uses the shell utility [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) to serve a PDF file to a user from HTML.  In other words, rather than dealing with a PDF generation DSL of some sort, you simply write an HTML view as you would normally, then let PDF take care of the hard stuff.
+
+**Wisepdf** is inspired by [Wicked PDF](https://github.com/mileszs/wicked_pdf) and [PDFKit](https://github.com/jdpace/PDFKit). PDF is optimized to use with Rails 3.1 (3.2), Ruby 1.9.2 and wkhtmltopdf 0.10.0 (and above).
+
+## Installation
+
+First, be sure to install [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/).
+Note that versions before 0.9.0 [have problems](http://code.google.com/p/wkhtmltopdf/issues/detail?id=82&q=vodnik) on some machines with reading/writing to streams.
+This plugin relies on streams to communicate with wkhtmltopdf.
+
+More information about [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf/) could be found [here](http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf_0.10.0_rc2-doc.html).
+
+Add this to your Gemfile:
+
+    gem 'wisepdf'
+
+then do:
+    
+    bundle
+
+## How does it work?
+
+### Basic Usage
+
+    class ThingsController < ApplicationController
+      def show
+        respond_to do |format|
+          format.html
+          format.pdf do
+            render :pdf => "file_name"
+          end
+        end
+      end
+    end
+
+### Advanced Usage with all available options
+
+    class ThingsController < ApplicationController
+      def show
+        respond_to do |format|
+          format.html
+          format.pdf do
+            render :pdf                            => 'file_name',
+                   :template                       => 'things/show.pdf.erb',
+                   :layout                         => 'pdf.html',                   # use 'pdf.html' for a pdf.html.erb file
+                   :show_as_html                   => params[:debug].present?,      # allow debuging based on url param
+                   :orientation                    => 'Landscape',                  # default Portrait
+                   :page_size                      => 'A4, Letter, ...',            # default A4
+                   :save_to_file                   => Rails.root.join('pdfs', "#{filename}.pdf"),
+                   :save_only                      => false,                        # depends on :save_to_file being set first
+                   :proxy                          => 'TEXT',
+                   :basic_auth                     => false                         # when true username & password are automatically sent from session
+                   :username                       => 'TEXT',
+                   :password                       => 'TEXT',
+                   :cover                          => 'URL',
+                   :dpi                            => 'dpi',
+                   :encoding                       => 'TEXT',
+                   :user_style_sheet               => 'URL',
+                   :cookie                         => ['_session_id SESSION_ID'], # could be an array or a single string in a 'name value' format
+                   :post                           => ['query QUERY_PARAM'],    # could be an array or a single string in a 'name value' format
+                   :redirect_delay                 => NUMBER,
+                   :zoom                           => FLOAT,
+                   :page_offset                    => NUMBER,
+                   :book                           => true,
+                   :default_header                 => true,
+                   :disable_javascript             => false,
+                   :greyscale                      => true,
+                   :lowquality                     => true,
+                   :enable_plugins                 => true,
+                   :disable_internal_links         => true,
+                   :disable_external_links         => true,
+                   :print_media_type               => true,
+                   :disable_smart_shrinking        => true,
+                   :use_xserver                    => true,
+                   :no_background                  => true,
+                   :margin => {:top                => SIZE,                         # default 10 (mm)
+                               :bottom             => SIZE,
+                               :left               => SIZE,
+                               :right              => SIZE},
+                   :header => {:html => { :template => 'users/header.pdf.erb',  # use :template OR :url
+                                          :layout   => 'pdf_plain.html',        # optional, use 'pdf_plain.html' for a pdf_plain.html.erb file, defaults to main layout
+                                          :url      => 'www.example.com',
+                                          :locals   => { :foo => @bar }},
+                               :center             => 'TEXT',
+                               :font_name          => 'NAME',
+                               :font_size          => SIZE,
+                               :left               => 'TEXT',
+                               :right              => 'TEXT',
+                               :spacing            => REAL,
+                               :line               => true},
+                   :footer => {:html => { :template => 'shared/footer.pdf.erb', # use :template OR :url
+                                          :layout   => 'pdf_plain.html',        # optional, use 'pdf_plain.html' for a pdf_plain.html.erb file, defaults to main layout
+                                          :url      => 'www.example.com',
+                                          :locals   => { :foo => @bar }},
+                               :center             => 'TEXT',
+                               :font_name          => 'NAME',
+                               :font_size          => SIZE,
+                               :left               => 'TEXT',
+                               :right              => 'TEXT',
+                               :spacing            => REAL,
+                               :line               => true},
+                   :outline => {:outline           => true,
+                                :outline_depth     => LEVEL}
+          end
+        end
+      end
+    end
+
+By default, it will render without a layout (:layout => false) and the template for the current controller and action.
+
+### Super Advanced Usage ###
+
+If you need to just create a pdf and not display it:
+
+    # create a pdf from a string
+    pdf = Wisepdf::Writer.new.to_pdf('<h1>Hello There!</h1>')
+		
+    # or from your controller, using views & templates and all other options as normal
+    pdf = render_to_string :pdf => "some_file_name"
+		
+    # then save to a file
+    save_path = Rails.root.join('pdfs','filename.pdf')
+    File.open(save_path, 'wb') do |file|
+      file << pdf
+    end
+
+If you need to display utf encoded characters, add this to your pdf views or layouts:
+
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+
+### Styles
+
+You must define absolute paths to CSS files, images, and javascripts; the best option is to use the *wisepdf_stylesheet_tag*, *wisepdf_image_tag*, and *wisepdf_javascript_tag* helpers.
+
+    <!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" />
+        <%= wisepdf_stylesheet_tag "pdf" -%>
+        <%= wisepdf_javascript_tag "number_pages" %>
+      </head>
+      <body onload='number_pages'>
+        <div id="header">
+          <%= wisepdf_image_tag 'mysite.jpg' %>
+        </div>
+        <div id="content">
+          <%= yield %>
+        </div>
+      </body>
+    </html>
+
+### Page Numbering
+
+A bit of javascript can help you number your pages. Create a template or header/footer file with this:
+
+    <html>
+      <head>
+        <script>
+          function number_pages() {
+            var vars={};
+            var x=document.location.search.substring(1).split('&');
+            for(var i in x) {var z=x[i].split('=',2);vars[z[0]] = unescape(z[1]);}
+            var x=['frompage','topage','page','webpage','section','subsection','subsubsection'];
+            for(var i in x) {
+              var y = document.getElementsByClassName(x[i]);
+              for(var j=0; j<y.length; ++j) y[j].textContent = vars[x[i]];
+            }
+          }
+        </script>
+      </head>
+      <body onload="number_pages()">
+        Page <span class="page"></span> of <span class="topage"></span>
+      </body>
+    </html>
+
+Anything with a class listed in "var x" above will be auto-filled at render time.
+
+If you do not have explicit page breaks (and therefore do not have any "page" class), you can also use wkhtmltopdf's built in page number generation by setting one of the headers to "[page]":
+
+    render :pdf => 'filename', :header => { :right => '[page] of [topage]' }
+
+### Configuration
+
+You can put your default configuration, applied to all pdf's at "configure_wisepdf.rb" initializer.
+
+    Wisepdf::Configuration.configure do |c|
+      c.wkhtmltopdf = '/path/to/wkhtmltopdf'
+      c.options = {
+        :layout => "layout.html",
+        :use_xserver => true,
+        :footer => { 
+          :right => "#{Date.today.year}",
+          :font_size => 8,
+          :spacing => 8
+        },
+        :margin => {
+          :bottom => 15
+        }
+      }
+      
+    end
+      
+
+### Debugging
+
+You can use a debug param on the URL that shows you the content of the pdf in plain html to design it faster.
+
+First of all you must configure the render parameter `:show_as_html => params[:debug]` and then just use it like normally but adding `debug=1` as a param:
+
+    http://localhost:3001/CONTROLLER/X.pdf?debug=1
+
+However, the wisepdf_* helpers will use file:// paths for assets when using :show_as_html, and your browser's cross-domain safety feature will kick in, and not render them. To get around this, you can load your assets like so in your templates:
+
+    <%= params[:debug].present? ? image_tag('foo') : wisepdf_image_tag('foo') %>
+
+## Production?  
+
+**wisepdf** is used at:
+
+* [www.sdelki.ru](http://www.sdelki.ru)
+* [www.lienlog.com](http://www.lienlog.com)
+
+Know other projects? Then contact me and I will add them to the list.
+
+## Contributing to wisepdf
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Igor Alexandrov. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "wisepdf"
+  gem.homepage = "http://github.com/igor-alexandrov/wisepdf"
+  gem.license = "MIT"
+  gem.summary = "wkhtmltopdf for Rails done right"
+  gem.description = %Q{wisepdf uses the shell utility wkhtmltopdf to serve a PDF file to a user from HTML. In other words, rather than dealing with a PDF generation DSL of some sort, you simply write an HTML view as you would normally, and let pdf take care of the hard stuff.}
+  gem.email = "igor.alexandrov@gmail.com"
+  gem.authors = [ "Igor Alexandrov" ]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "wisepdf #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/generators/pdf/pdf_generator.rb

@@ -0,0 +1,7 @@
+class PdfGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file "configure_pdf.rb", "config/initializers/configure_pdf.rb"
+    end
+  end
+end

data/generators/pdf/templates/configure_pdf.rb

@@ -0,0 +1,6 @@
+Pdf::Configuration.configuration do |config|
+  config.wkhtmltopdf = '/path/to/wkhtmltopdf'
+  config.options = {
+    #:layout => "pdf.html"
+  }
+end

data/lib/generators/pdf_generator.rb

@@ -0,0 +1,9 @@
+if defined?(Rails) && Rails::VERSION::MAJOR > 2
+  # Rails3 generator invoked with 'rails generate pdf'
+  class PdfGenerator < Rails::Generators::Base
+    source_root(File.expand_path(File.dirname(__FILE__) + "/../../generators/pdf/templates"))
+    def copy_initializer
+      copy_file 'configure_pdf.rb', 'config/initializers/configure_pdf.rb'
+    end
+  end
+end

data/lib/wisepdf/configuration.rb

@@ -0,0 +1,47 @@
+require 'singleton'
+
+module Wisepdf
+  class Configuration
+    include Singleton
+    cattr_accessor :options
+    cattr_accessor :wkhtmltopdf
+    
+    class << self
+      def wkhtmltopdf
+        return @@wkhtmltopdf if @@wkhtmltopdf.present?
+                
+        if @@wkhtmltopdf.nil? && !self.windows?
+          @@wkhtmltopdf = (defined?(Bundler) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+        end
+        return @@wkhtmltopdf 
+      end
+    
+      def configure
+        yield self
+      end
+    
+      def reset!
+        @@options = {
+          :layout => "pdf.html",
+          :use_xserver => false
+        }
+        @@wkhtmltopdf = nil
+      end    
+    
+      def development?
+        (defined?(::Rails) && ::Rails.env == 'development') ||
+          (defined?(RAILS_ENV) && RAILS_ENV == 'development')
+      end
+
+      def windows?
+        RbConfig::CONFIG['target_os'] == 'mingw32'
+      end
+    end
+    
+    self.reset!
+    
+    def method_missing(method)
+      self.class.send(method)
+    end
+  end
+end

data/lib/wisepdf/errors.rb

@@ -0,0 +1,13 @@
+module Wisepdf
+  class NoExecutableError < StandardError
+    def initialize(path=nil)
+      msg = "No wkhtmltopdf found or it is not executable\n"
+      msg += "Path: '#{path}'\n" unless path.nil?
+      msg += "Please install wkhtmltopdf - http://code.google.com/p/wkhtmltopdf"
+      super(msg)
+    end
+  end
+  
+  class WriteError < StandardError
+  end
+end

data/lib/wisepdf/helper.rb

@@ -0,0 +1,59 @@
+module Wisepdf
+  module Helper
+    module Legacy
+      def wisepdf_stylesheet_tag(*sources)
+        stylesheets_dir = ::Rails.root.join('public','stylesheets')
+                
+        sources.collect { |source|
+          filename = ( source =~ /.css\z/ ? source : source + '.css' )  
+          "<style type='text/css'>
+            #{File.read(stylesheets_dir.join(filename))}
+          </style>"
+        }.join("\n").html_safe
+      end
+
+      def wisepdf_image_tag(img, options={})
+        image_tag "file:///#{::Rails.root.join('public', 'images', img).pathname.to_s}", options
+      end
+      
+      def wisepdf_javascript_tag(*sources)
+        javascripts_dir = ::Rails.root.join('public','javascripts')
+        
+        sources.collect { |source|
+          filename = ( source =~ /.js\z/ ? source : source + '.js' )
+          "<script type='text/javascript'>
+            //<![CDATA[
+              #{File.read(javascripts_dir.join(filename))}
+            //]]>
+          </script>"
+        }.join("\n").html_safe
+      end
+    end  
+    
+    module Assets
+      def wisepdf_stylesheet_tag(*sources)        
+        sources.collect { |source|
+          filename = ( source =~ /.css\z/ ? source : source + '.css' )  
+          "<style type='text/css'>
+            #{::Rails.application.assets.find_asset(filename)}
+          </style>"
+        }.join("\n").html_safe
+      end
+
+      def wisepdf_image_tag(img, options={})
+        image_tag "file:///#{::Rails.application.assets.find_asset(img).pathname.to_s}", options
+      end
+      
+      def wisepdf_javascript_tag(*sources)
+        sources.collect { |source|
+          filename = ( source =~ /.js\z/ ? source : source + '.js' )
+          "<script type='text/javascript'>
+            //<![CDATA[
+              #{::Rails.application.assets.find_asset(filename)}
+            //]]>
+          </script>"
+        }.join("\n").html_safe
+      end
+    end
+  end
+end

data/lib/wisepdf/rails/engine.rb

@@ -0,0 +1,10 @@
+module Wisepdf
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer "wicked_pdf.register" do
+        ActionController::Base.send :include, Render
+        ActionView::Base.send :include, Helper::Assets
+      end
+    end
+  end
+end

data/lib/wisepdf/rails/legacy.rb

@@ -0,0 +1,5 @@
+ActionController::Base.send :include, Render
+
+unless ActionView::Base.instance_methods.include? "wicked_pdf_stylesheet_link_tag"
+  ActionView::Base.send :include, Helper::Legacy
+end

data/lib/wisepdf/rails/railtie.rb

@@ -0,0 +1,10 @@
+module Wisepdf
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "wicked_pdf.register" do
+        ActionController::Base.send :include, Render
+        ActionView::Base.send :include, Helper::Legacy
+      end      
+    end
+  end
+end

data/lib/wisepdf/rails.rb

@@ -0,0 +1,17 @@
+module Wisepdf
+  module Rails
+    if ::Rails::VERSION::MAJOR == 2
+      require 'wisepdf/rails/legacy'
+    elsif ::Rails::VERSION::MAJOR > 2
+      if ::Rails::VERSION::MINOR < 1
+        require 'wisepdf/rails/railtie'
+      else
+        require 'wisepdf/rails/engine'
+      end  
+    end  
+    
+    if Mime::Type.lookup_by_extension(:pdf).nil?
+      Mime::Type.register('application/pdf', :pdf)
+    end
+  end
+end