pdfkit 0.1.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -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/PDFKit.gemspec

@@ -0,0 +1,61 @@
+# 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.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["jdpace"]
+  s.date = %q{2010-05-21}
+  s.description = %q{Uses wkhtmltopdf to create PDFs using HTML}
+  s.email = %q{jared@codewordstudios.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "PDFKit.gemspec",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/PDFKit.rb",
+     "lib/pdfkit/middleware.rb",
+     "lib/pdfkit/pdfkit.rb",
+     "spec/PDFKit_spec.rb",
+     "spec/fixtures/example.css",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jdpace/PDFKit}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{HTML+CSS -> PDF}
+  s.test_files = [
+    "spec/pdfkit_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
+  end
+end
+

data/README.md

@@ -0,0 +1,56 @@
+# PDFKit
+
+Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antialize/wkhtmltopdf) on the backend which renders HTML using Webkit.
+
+## Installation
+
+1. Install wkhtmltopdf
+   # Download the latest binary from http://code.google.com/p/wkhtmltopdf/downloads/list
+   # Place the binary somewhere on your path (e.g /usr/local/bin)
+2. Install PDFKit
+   # $ gem install pdfkit
+   
+## 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.open('/path/to/save/pdf','w') {|file| file << pdf}
+   
+## Middleware
+
+PDFKit comes with a middleware that allows users to visit any to get a PDF view of any page on your site by appending ?pdf=true 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
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* 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

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pdfkit"
+    gem.summary = %Q{HTML+CSS -> PDF}
+    gem.description = %Q{Uses wkhtmltopdf to create PDFs using HTML}
+    gem.email = "jared@codewordstudios.com"
+    gem.homepage = "http://github.com/jdpace/PDFKit"
+    gem.authors = ["jdpace"]
+    gem.add_dependency "activesupport"
+    gem.add_development_dependency "rspec", "~> 2.0.0.beta.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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

@@ -0,0 +1 @@
+0.1.0

data/lib/PDFKit.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'active_support/core_ext'
+require 'active_support/inflector'
+require 'pdfkit/pdfkit'
+require 'pdfkit/middleware'

data/lib/pdfkit/middleware.rb

@@ -0,0 +1,41 @@
+class PDFKit
+  
+  # A rack middleware for validating HTML via w3c validator
+  class Middleware
+    
+    def initialize( app )
+      @app = app
+    end
+        
+    def call( env )
+      status, headers, response = @app.call( env )
+      
+      request = Rack::Request.new( env )
+      if !request.params['pdf'].blank?
+        if headers['Content-Type'] =~ /text\/html|application\/xhtml\+xml/
+          body = response.body
+          
+          # Make absolute urls
+          uri = env['REQUEST_URI'].split('?').first
+          uri += '/' unless uri.match(/\/$/)
+          root = env['rack.url_scheme'] + "://" + env['HTTP_HOST']
+          # translate relative urls
+          body.gsub!(/(href|src)=['"]([^\/][^\"']*)['"]/,'\1="'+root+'/\2"')
+          
+          # translate absolute urls
+          body.gsub!(/(href|src)=['"]\/([^\"]*|[^']*)['"]/,'\1="'+uri+'\2"')
+          
+          pdf = PDFKit.new(body)
+          body = pdf.to_pdf
+          
+          headers["Content-Length"] = body.length.to_s
+          headers["Content-Type"] = "application/pdf"
+          response = [body]
+        end
+      end
+      
+      [status, headers, response]
+    end
+  
+  end
+end

data/lib/pdfkit/pdfkit.rb

@@ -0,0 +1,76 @@
+class PDFKit
+  
+  class NoExecutableError < StandardError
+    def initialize
+      super('Could not locate wkhtmltopdf executable')
+    end
+  end
+  
+  attr_accessor :html, :stylesheets
+  attr_reader :options
+  
+  def initialize(html, options = {})
+    @html = html
+    @stylesheets = []
+    
+    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'
+    }
+    @options = normalize_options(options.reverse_merge(default_options))
+    
+    @cmd  = `which wkhtmltopdf`.chomp
+    raise NoExecutableError.new if @cmd.blank?
+  end
+  
+  def command
+    args = [@cmd]
+    args += @options.to_a.flatten.compact
+    args << '--quiet'
+    args << '-' # Get HTML from stdin
+    args << '-' # Read PDF from stdout
+    args.join(' ')
+  end
+  
+  def to_pdf
+    append_stylesheets
+    
+    pdf = IO.popen(command, "w+")
+    pdf.puts(@html)
+    pdf.close_write
+    result = pdf.gets(nil)
+    pdf.close_read
+    return result
+  end
+  
+  protected
+  
+    def style_tag_for(stylesheet)
+      "<style>#{File.read(stylesheet)}</style>"
+    end
+    
+    def append_stylesheets
+      stylesheets.each do |stylesheet|
+        if @html.match(/<\/head>/)
+          @html.gsub!(/(<\/head>)/, "#{style_tag_for(stylesheet)}$1")
+        else
+          @html.insert(0, style_tag_for(stylesheet))
+        end
+      end
+    end
+  
+    def normalize_options(options)
+      normalized_options = {}
+      options.each do |key, value|
+        normalized_key = "--#{key.to_s.downcase.dasherize}"
+        normalized_value = value.is_a?(TrueClass) ? nil : value
+        normalized_options[normalized_key] = normalized_value
+      end
+      normalized_options
+    end
+  
+end

data/spec/PDFKit_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe PDFKit do
+  
+  context "initialization" do
+    it "should take HTML for the renderer" do
+      pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
+      pdfkit.html.should == '<h1>Oh Hai</h1>'
+    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 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')
+      pdfkit.command.should include('wkhtmltopdf')
+      pdfkit.command.should include('--page-size Letter')
+    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.should match(/^%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.expand_path(File.dirname(__FILE__) + '/fixtures/example.css')
+      pdfkit.stylesheets << css
+      pdfkit.to_pdf
+      pdfkit.html.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.expand_path(File.dirname(__FILE__) + '/fixtures/example.css')
+      pdfkit.stylesheets << css
+      pdfkit.to_pdf
+      pdfkit.html.should include("<style>#{File.read(css)}</style><html>")
+    end
+  end
+  
+end

data/spec/fixtures/example.css

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

data/spec/pdfkit_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe PDFKit do
+  
+  context "initialization" do
+    it "should take HTML for the renderer" do
+      pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
+      pdfkit.html.should == '<h1>Oh Hai</h1>'
+    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 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')
+      pdfkit.command.should include('wkhtmltopdf')
+      pdfkit.command.should include('--page-size Letter')
+    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.should match(/^%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.expand_path(File.dirname(__FILE__) + '/fixtures/example.css')
+      pdfkit.stylesheets << css
+      pdfkit.to_pdf
+      pdfkit.html.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.expand_path(File.dirname(__FILE__) + '/fixtures/example.css')
+      pdfkit.stylesheets << css
+      pdfkit.to_pdf
+      pdfkit.html.should include("<style>#{File.read(css)}</style><html>")
+    end
+  end
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'PDFKit'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: pdfkit
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- jdpace
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-21 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 8
+        version: 2.0.0.beta.8
+  type: :development
+  version_requirements: *id002
+description: Uses wkhtmltopdf to create PDFs using HTML
+email: jared@codewordstudios.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- PDFKit.gemspec
+- README.md
+- Rakefile
+- VERSION
+- lib/PDFKit.rb
+- lib/pdfkit/middleware.rb
+- lib/pdfkit/pdfkit.rb
+- spec/PDFKit_spec.rb
+- spec/fixtures/example.css
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jdpace/PDFKit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: HTML+CSS -> PDF
+test_files: 
+- spec/pdfkit_spec.rb
+- spec/spec_helper.rb