RubyGems - thelinuxlich-pdfkit - Versions diffs - 0.4.6 - Mend

thelinuxlich-pdfkit 0.4.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

data/.document ADDED

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore ADDED

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+## TEXTMATE
+*.tmproj
+tmtags
+## EMACS
+*~
+\#*
+.\#*
+## VIM
+*.swp
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+## PROJECT::SPECIFIC
+.bundle

data/.rspec ADDED

	@@ -0,0 +1 @@
1	+ --color

data/Gemfile ADDED

@@ -0,0 +1,9 @@
+source :rubygems
+group :development do
+  gem "rspec", "~> 2.0.0.beta.8"
+  gem "rspec-core", "~> 2.0.0.beta.8"
+  gem "mocha"
+  gem "jeweler"
+  gem "rack"
+end

data/Gemfile.lock ADDED

@@ -0,0 +1,35 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.3)
+    mocha (0.9.8)
+      rake
+    rack (1.2.1)
+    rake (0.8.7)
+    rspec (2.0.0.beta.19)
+      rspec-core (= 2.0.0.beta.19)
+      rspec-expectations (= 2.0.0.beta.19)
+      rspec-mocks (= 2.0.0.beta.19)
+    rspec-core (2.0.0.beta.19)
+    rspec-expectations (2.0.0.beta.19)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.19)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  jeweler
+  mocha
+  rack
+  rspec (~> 2.0.0.beta.8)
+  rspec-core (~> 2.0.0.beta.8)

data/LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jdpace
+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/POST_INSTALL ADDED

@@ -0,0 +1,8 @@
+******************************************************************
+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)
+******************************************************************

data/README.md ADDED

@@ -0,0 +1,90 @@
+# PDFKit
+Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antialize/wkhtmltopdf) on the backend which renders HTML using Webkit.
+## Install
+### PDFKit
+    gem install pdfkit
+### wkhtmltopdf
+ * **Automatic**: `sudo pdfkit --install-wkhtmltopdf`
+ install latest version into /usr/local/bin
+ (overwrite defaults with e.g. ARCHITECTURE=amd64 TO=/home/foo/bin)
+ * By hand: http://code.google.com/p/wkhtmltopdf/downloads/list
+## Usage
+    # PDFKit.new takes the HTML and any options for wkhtmltopdf
+    # run `wkhtmltopdf --extended-help` for a full list of options
+    kit = PDFKit.new(html, :page_size => 'Letter')
+    kit.stylesheets << '/path/to/css/file'
+    # Git an inline PDF
+    pdf = kit.to_pdf
+    # Save the PDF to a file
+    file = kit.to_file('/path/to/save/pdf')
+    # PDFKit.new can optionally accept a URL or a File.
+    # Stylesheets can not be added when source is provided as a URL of File.
+    kit = PDFKit.new('http://google.com')
+    kit = PDFKit.new(File.new('/path/to/html'))
+    # Add any kind of option through meta tags
+    PDFKit.new('<html><head><meta name="pdfkit-page_size" content="Letter")
+## Configuration
+If you're on Windows or you installed wkhtmltopdf by hand to a location other than /usr/local/bin you will need to tell PDFKit where the binary is. You can configure PDFKit like so:
+    # config/initializers/pdfkit.rb
+    PDFKit.configure do |config|
+      config.wkhtmltopdf = '/path/to/wkhtmltopdf'
+      config.default_options = {
+        :page_size => 'Legal',
+        :print_media_type => true
+      }
+    end
+## Middleware
+PDFKit comes with a middleware that allows users to get a PDF view of any page on your site by appending .pdf to the URL.
+### Middleware Setup
+**Non-Rails Rack apps**
+    # in config.ru
+    require 'pdfkit'
+    use PDFKit::Middleware
+**Rails apps**
+    # in application.rb(Rails3) or environment.rb(Rails2)
+    require 'pdfkit'
+    config.middleware.use PDFKit::Middleware
+**With PDFKit options**
+    # options will be passed to PDFKit.new
+    config.middleware.use PDFKit::Middleware, :print_media_type => true
+## TODO
+ - add amd64 support in --install-wkhtmltopdf
+## Note on Patches/Pull Requests
+* Fork the project.
+* Setup your development environment with: gem install bundler; bundle install
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+## Copyright
+Copyright (c) 2010 Jared Pace. See LICENSE for details.

data/Rakefile ADDED

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+require 'bundler'
+Bundler.require(:development)
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "thelinuxlich-pdfkit"
+    gem.summary = %Q{HTML+CSS -> PDF}
+    gem.description = %Q{Uses wkhtmltopdf to create PDFs using HTML(Windows-compatible)}
+    gem.email = "thelinuxlich@gmail.com"
+    gem.homepage = "http://github.com/thelinuxlich/PDFKit"
+    gem.authors = ["jdpace","thelinuxlich"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "rspec-core"
+    gem.add_development_dependency 'mocha'
+    gem.post_install_message = File.read('POST_INSTALL')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+end
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+task :spec => :check_dependencies
+task :default => :spec
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "PDFKit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION ADDED

	@@ -0,0 +1 @@
1	+ 0.4.6

data/bin/pdfkit ADDED

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+require 'rbconfig'
+require 'open-uri'
+require 'pdfkit/configuration'
+def detect_architecture
+  case Config::CONFIG['host_os']
+  when /x86_64-linux/i
+    'amd64'
+  when /linux/i
+    'i386'
+  when /darwin/i
+    'OS-X.i368'
+  else
+    raise "No binaries found for your system. Please install wkhtmltopdf by hand."
+  end
+end
+def cleanup(install_to)
+  `rm -rf wkhtmltopdf*`
+  `rm #{install_to}`
+end
+def download_wkhtmltopdf(arch)
+  page = open("http://code.google.com/p/wkhtmltopdf/downloads/list").read
+  download = page.match(/href=".*name=(.*wkhtmltopdf-.*#{arch}.*?)&/) || raise("File not found..")
+  download = download[1]
+  url = "http://wkhtmltopdf.googlecode.com/files/#{download}"
+  puts "Downloading #{download} from #{url}"
+  `curl #{url} > #{download}`
+  download
+end
+def install(download, arch, install_to)
+  puts "Installing #{download} to #{install_to}"
+  if download =~ /.tar.bz2$/
+    `tar xjvf #{download}`
+    `mv wkhtmltopdf-#{arch} #{install_to}`
+  elsif download =~ /.tar.lzma$/
+    raise "couldn't extract archive: lzcat not found" unless system("which lzcat > /dev/null 2>/dev/null")
+    `lzcat #{download} | tar x`
+    `mv wkhtmltopdf-#{arch} #{install_to}`
+  else
+    `mv #{download} #{install_to}`
+  end
+  `sudo chmod +x #{install_to}`
+end
+OptionParser.new do |parser|
+  parser.banner = "PDFKit\n\nOptions are:"
+  parser.on("--install-wkhtmltopdf", "Install wkhtmltopdf binaries (TO=/usr/local/bin ARCHITECTURE=i386)") do
+    architecture = ENV['ARCHITECTURE'] || detect_architecture
+    install_to = ENV['TO'] || PDFKit.configuration.wkhtmltopdf
+    Dir.chdir '/tmp'
+    cleanup(install_to)
+    download = download_wkhtmltopdf(architecture)
+    install(download, architecture, install_to)
+  end
+  parser.on("--version", "Show Version.") do
+    root = File.dirname(File.dirname(__FILE__))
+    puts File.read(File.join(root, 'VERSION'))
+  end
+  parser.on("-h", "--help", "Show this.") { puts parser; exit }
+end.parse!

data/lib/pdfkit.rb ADDED

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

data/lib/pdfkit/configuration.rb ADDED

@@ -0,0 +1,41 @@
+class PDFKit
+  class Configuration
+    attr_accessor :meta_tag_prefix, :wkhtmltopdf, :default_options
+    def initialize
+      @meta_tag_prefix = 'pdfkit-'
+      @wkhtmltopdf = '/usr/local/bin/wkhtmltopdf'
+      @default_options = {
+        :disable_smart_shrinking => true,
+        :page_size => 'Letter',
+        :margin_top => '0.75in',
+        :margin_right => '0.75in',
+        :margin_bottom => '0.75in',
+        :margin_left => '0.75in',
+        :encoding => "UTF-8"
+      }
+    end
+  end
+  class << self
+    attr_accessor :configuration
+  end
+  # Configure PDFKit someplace sensible,
+  # like config/initializers/pdfkit.rb
+  #
+  # @example
+  #   PDFKit.configure do |config|
+  #     config.wkhtmltopdf = '/usr/bin/wkhtmltopdf'
+  #   end
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  def self.configure
+    self.configuration
+    yield(configuration)
+  end
+end

data/lib/pdfkit/middleware.rb ADDED

@@ -0,0 +1,61 @@
+class PDFKit
+  class Middleware
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+    end
+    def call(env)
+      @render_pdf = false
+      set_request_to_render_as_pdf(env) if env['PATH_INFO'].match(/\.pdf$/)
+      status, headers, response = @app.call(env)
+      request = Rack::Request.new(env)
+      if @render_pdf && headers['Content-Type'] =~ /text\/html|application\/xhtml\+xml/
+        body = response.body
+        body = translate_paths(body, env)
+        pdf = PDFKit.new(body, @options)
+        body = pdf.to_pdf
+        # Do not cache PDFs
+        headers.delete('ETag')
+        headers.delete('Cache-Control')
+        headers["Content-Length"] = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
+        headers["Content-Type"] = "application/pdf"
+        response = [body]
+      end
+      [status, headers, response]
+    end
+    private
+      # Change relative paths to absolute
+      def translate_paths(body, env)
+        # Host with protocol
+        root = env['rack.url_scheme'] + "://" + env['HTTP_HOST'] + "/"
+        body.gsub(/(href|src)=(['"])\/([^\"']*|[^"']*)['"]/,'\1=\2'+root+'\3\2')
+      end
+      def set_request_to_render_as_pdf(env)
+        @render_pdf = true
+        path = Pathname(env['PATH_INFO'])
+        ['PATH_INFO','REQUEST_URI'].each { |e| env[e] = path.to_s.sub(/#{path.extname}$/,'')  } if path.extname == '.pdf'
+        env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type('.html'))
+      end
+      def concat(accepts, type)
+        (accepts || '').split(',').unshift(type).compact.join(',')
+      end
+  end
+end

data/lib/pdfkit/pdfkit.rb ADDED

@@ -0,0 +1,144 @@
+class PDFKit
+  class NoExecutableError < StandardError
+    def initialize
+      msg  = "No wkhtmltopdf executable found at #{PDFKit.configuration.wkhtmltopdf}\n"
+      msg << ">> Install wkhtmltopdf by hand or try running `pdfkit --install-wkhtmltopdf`"
+      super(msg)
+    end
+  end
+  class ImproperSourceError < StandardError
+    def initialize(msg)
+      super("Improper Source: #{msg}")
+    end
+  end
+  attr_accessor :source, :stylesheets,:fix_fonts_for_windows
+  attr_reader :options
+  def initialize(url_file_or_html, options = {})
+    @source = Source.new(url_file_or_html)
+    @stylesheets = []
+    @fix_fonts_for_windows = false
+    @options = PDFKit.configuration.default_options.merge(options)
+    @options.merge! find_options_in_meta(url_file_or_html) unless source.url?
+    @options = normalize_options(@options)
+    raise NoExecutableError.new unless File.exists?(PDFKit.configuration.wkhtmltopdf)
+  end
+  def command
+    args = [executable]
+    args += @options.to_a.flatten.compact
+    args << '--quiet'
+    if @source.html?
+      args << '-' # Get HTML from stdin
+    else
+      args << @source.to_s
+    end
+    args << '-' # Read PDF from stdout
+    args
+  end
+  def executable
+    default = PDFKit.configuration.wkhtmltopdf
+    return default if default !~ /^\// # its not a path, so nothing we can do
+    if File.exist?(default)
+      default
+    else
+      default.split('/').last
+    end
+  end
+  def to_pdf(path=nil)
+    append_stylesheets
+    fix_all_font_styles_for_windows if @fix_fonts_for_windows == true
+    args = command
+    args[-1] = path if path && args[-1] == "-"
+    invoke = args.map {|arg| %{"#{arg.gsub('"','\\"')}"}} * " "
+    result = IO.popen(invoke, "w+") do |pdf|
+      pdf.puts(@source.to_s) if @source.html?
+      pdf.close_write
+      pdf.gets(nil)
+    end
+    result = File.open(path, "rb") {|file| file.read} if path
+    raise "command failed: #{invoke}" if result.to_s.strip.empty?
+    return result
+  end
+  alias to_file to_pdf
+  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 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}/
+      end
+      found
+    rescue # rexml random crash on invalid xml
+      []
+    end
+    def style_tag_for(stylesheet)
+      "<style>#{File.read(stylesheet)}</style>"
+    end
+    def append_stylesheets
+      raise ImproperSourceError.new('Stylesheets may only be added to an HTML source') if stylesheets.any? && !@source.html?
+      stylesheets.each do |stylesheet|
+        if @source.to_s.match(/<\/head>/)
+          @source.to_s.gsub!(/(<\/head>)/, style_tag_for(stylesheet)+'\1')
+        else
+          @source.to_s.insert(0, style_tag_for(stylesheet))
+        end
+      end
+    end
+    def normalize_options(options)
+      normalized_options = {}
+      options.each do |key, value|
+        next if !value
+        normalized_key = "--#{normalize_arg key}"
+        normalized_options[normalized_key] = normalize_value(value)
+      end
+      normalized_options
+    end
+    def normalize_arg(arg)
+      arg.to_s.downcase.gsub(/[^a-z0-9]/,'-')
+    end
+    def normalize_value(value)
+      case value
+      when TrueClass
+        nil
+      else
+        value.to_s
+      end
+    end
+    def fix_all_font_styles_for_windows
+     @source.to_s.gsub!(/(font-family:[\s]?)([a-zA-Z,\s]+)[;]?["]?$/) do |s|
+        s = $1+$2.split(',').map{|font| font = "'#{font}'"}.join(',')
+     end
+    end
+end

data/lib/pdfkit/source.rb ADDED

@@ -0,0 +1,27 @@
+class PDFKit
+  class Source
+    def initialize(url_file_or_html)
+      @source = url_file_or_html
+    end
+    def url?
+      @source.is_a?(String) && @source.match(/^http/)
+    end
+    def file?
+      @source.kind_of?(File)
+    end
+    def html?
+      !(url? || file?)
+    end
+    def to_s
+      file? ? @source.path : @source
+    end
+  end
+end

data/pdfkit.gemspec ADDED

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{pdfkit}
+  s.version = "0.4.6"
+  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{******************************************************************
+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.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
+end

data/spec/fixtures/example.css ADDED

	@@ -0,0 +1 @@
1	+ body { font-size: 20px; }

data/spec/fixtures/example.html ADDED

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <h1>Oh Hai!</h1>
+  </body>
+</html>

data/spec/middleware_spec.rb ADDED

@@ -0,0 +1,49 @@
+require 'spec_helper'
+describe PDFKit::Middleware do
+  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'}
+    end
+    it "should correctly parse relative url with single quotes" 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.com/stylesheets/application.css' media='screen' rel='stylesheet' type='text/css' /></head><body><img alt='test' src=\"http://example.com/test.png\" /></body></html>"
+    end
+    it "should correctly parse relative url with double quotes" do
+      @body = %{<link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />}
+      body = @pdf.send :translate_paths, @body, @env
+      body.should == "<link href=\"http://example.com/stylesheets/application.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />"
+    end
+    it "should return the body even if there are no valid substitutions found" do
+      @body = "NO MATCH"
+      body = @pdf.send :translate_paths, @body, @env
+      body.should == "NO MATCH"
+    end
+  end
+  describe "#set_request_to_render_as_pdf" do
+    before do
+      @pdf = PDFKit::Middleware.new({})
+      @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")}
+    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"
+    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
+end

data/spec/pdfkit_spec.rb ADDED

@@ -0,0 +1,178 @@
+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|
+        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'
+    end
+    it "will not include default options it is told to omit" do
+      pdfkit = PDFKit.new('html')
+      pdfkit.command.should include('--disable-smart-shrinking')
+      pdfkit = PDFKit.new('html', :disable_smart_shrinking => false)
+      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]'
+    end
+    it "read the source from stdin if it is html" do
+      pdfkit = PDFKit.new('html')
+      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', '-']
+    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, '-']
+    end
+    it "should detect special pdfkit meta tags" do
+      body = %{
+        <html>
+          <head>
+            <meta name="pdfkit-page_size" content="Legal"/>
+            <meta name="pdfkit-orientation" content="Landscape"/>
+          </head>
+        </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
+  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')
+      pdfkit.stylesheets << css
+      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')
+      pdfkit.stylesheets << css
+      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
+  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'
+    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 ADDED

@@ -0,0 +1,73 @@
+require 'spec_helper'
+describe PDFKit::Source do
+  describe "#url?" do
+    it "should return true if passed a url like string" do
+      source = PDFKit::Source.new('http://google.com')
+      source.should be_url
+    end
+    it "should return false if passed a file" do
+      source = PDFKit::Source.new(File.new(__FILE__))
+      source.should_not be_url
+    end
+    it "should return false if passed HTML" do
+      source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
+      source.should_not be_url
+    end
+  end
+  describe "#file?" do
+    it "should return true if passed a file" do
+      source = PDFKit::Source.new(File.new(__FILE__))
+      source.should be_file
+    end
+    it "should return false if passed a url like string" do
+      source = PDFKit::Source.new('http://google.com')
+      source.should_not be_file
+    end
+    it "should return false if passed HTML" do
+      source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
+      source.should_not be_file
+    end
+  end
+  describe "#html?" do
+    it "should return true if passed HTML" do
+      source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
+      source.should be_html
+    end
+    it "should return false if passed a file" do
+      source = PDFKit::Source.new(File.new(__FILE__))
+      source.should_not be_html
+    end
+    it "should return false if passed a url like string" do
+      source = PDFKit::Source.new('http://google.com')
+      source.should_not be_html
+    end
+  end
+  describe "#to_s" do
+    it "should return the HTML if passed HTML" do
+      source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
+      source.to_s.should == '<blink>Oh Hai!</blink>'
+    end
+    it "should return a path if passed a file" do
+      source = PDFKit::Source.new(File.new(__FILE__))
+      source.to_s.should == __FILE__
+    end
+    it "should return the url if passed a url like string" do
+      source = PDFKit::Source.new('http://google.com')
+      source.to_s.should == 'http://google.com'
+    end
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,18 @@
+SPEC_ROOT = File.dirname(__FILE__)
+$LOAD_PATH.unshift(SPEC_ROOT)
+$LOAD_PATH.unshift(File.join(SPEC_ROOT, '..', 'lib'))
+require 'pdfkit'
+require 'rspec'
+require 'rspec/autorun'
+require 'mocha'
+require 'rack'
+RSpec.configure do |config|
+  config.before do
+    PDFKit.any_instance.stubs(:wkhtmltopdf).returns(
+      File.join(SPEC_ROOT,'..','bin','wkhtmltopdf-proxy')
+    )
+  end
+end

metadata ADDED

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: thelinuxlich-pdfkit
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 4
+  - 6
+  version: 0.4.6
+platform: ruby
+authors:
+- jdpace
+- thelinuxlich
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-10-20 00:00:00 -02:00
+default_executable: pdfkit
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: Uses wkhtmltopdf to create PDFs using HTML(Windows-compatible)
+email: thelinuxlich@gmail.com
+executables:
+- pdfkit
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+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
+has_rdoc: true
+homepage: http://github.com/thelinuxlich/PDFKit
+licenses: []
+post_install_message: |-
+  ******************************************************************
+  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)
+  ******************************************************************
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 1989877863628538783
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: HTML+CSS -> PDF
+test_files:
+- spec/source_spec.rb
+- spec/middleware_spec.rb
+- spec/pdfkit_spec.rb
+- spec/spec_helper.rb