pdfkit 0.2.3 → 0.3.0

data/README.md

@@ -25,7 +25,12 @@ Create PDFs using plain old HTML+CSS. Uses [wkhtmltopdf](http://github.com/antia
     pdf = kit.to_pdf
     
     # Save the PDF to a file
-    File.open('/path/to/save/pdf','w') {|file| file << pdf}
+    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'))
    
 ## Middleware
 

data/Rakefile

@@ -12,6 +12,7 @@ begin
     gem.authors = ["jdpace"]
     gem.add_dependency "activesupport"
     gem.add_development_dependency "rspec", "~> 2.0.0.beta.8"
+    gem.add_development_dependency 'mocha'
     gem.files = [
       ".document",
        ".gitignore",
@@ -19,12 +20,19 @@ begin
        "README.md",
        "Rakefile",
        "VERSION",
+       "bin/pdfkit.rb",
+       "bin/wkhtmltopdf-linux-i386-0-9-9",
+       "bin/wkhtmltopdf-osx-i386-0-9-9",
+       "bin/wkhtmltopdf-proxy",
        "lib/pdfkit.rb",
        "lib/pdfkit/middleware.rb",
        "lib/pdfkit/pdfkit.rb",
+       "lib/pdfkit/source.rb",
        "pdfkit.gemspec",
        "spec/pdfkit_spec.rb",
+       "spec/source_spec.rb",
        "spec/fixtures/example.css",
+       "spec/fixtures/example.html",
        "spec/spec.opts",
        "spec/spec_helper.rb"
     ]

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/lib/pdfkit/pdfkit.rb

@@ -6,11 +6,18 @@ class PDFKit
     end
   end
   
-  attr_accessor :html, :stylesheets
+  class ImproperSourceError < StandardError
+    def initialize(msg)
+      super("Improper Source: #{msg}")
+    end
+  end
+  
+  attr_accessor :source, :stylesheets
   attr_reader :options
   
-  def initialize(html, options = {})
-    @html = html
+  def initialize(url_file_or_html, options = {})
+    @source = Source.new(url_file_or_html)
+    
     @stylesheets = []
     
     default_options = {
@@ -31,7 +38,13 @@ class PDFKit
     args = [@cmd]
     args += @options.to_a.flatten.compact
     args << '--quiet'
-    args << '-' # Get HTML from stdin
+    
+    if @source.html?
+      args << '-' # Get HTML from stdin
+    else
+      args << @source.to_s
+    end
+    
     args << '-' # Read PDF from stdout
     args.join(' ')
   end
@@ -40,13 +53,17 @@ class PDFKit
     append_stylesheets
     
     pdf = IO.popen(command, "w+")
-    pdf.puts(@html)
+    pdf.puts(@source.to_s) if @source.html?
     pdf.close_write
     result = pdf.gets(nil)
     pdf.close_read
     return result
   end
   
+  def to_file(path)
+    File.open(path,'w') {|file| file << self.to_pdf}
+  end
+  
   protected
   
     def style_tag_for(stylesheet)
@@ -54,11 +71,13 @@ class PDFKit
     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 @html.match(/<\/head>/)
-          @html.gsub!(/(<\/head>)/, style_tag_for(stylesheet)+'\1')
+        if @source.to_s.match(/<\/head>/)
+          @source.to_s.gsub!(/(<\/head>)/, style_tag_for(stylesheet)+'\1')
         else
-          @html.insert(0, style_tag_for(stylesheet))
+          @source.to_s.insert(0, style_tag_for(stylesheet))
         end
       end
     end
@@ -66,6 +85,7 @@ class PDFKit
     def normalize_options(options)
       normalized_options = {}
       options.each do |key, value|
+        next if !value
         normalized_key = "--#{key.to_s.downcase.dasherize}"
         normalized_value = value.is_a?(TrueClass) ? nil : value
         normalized_options[normalized_key] = normalized_value

data/lib/pdfkit/source.rb

@@ -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/lib/pdfkit.rb

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

data/pdfkit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pdfkit}
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jdpace"]
-  s.date = %q{2010-06-01}
+  s.date = %q{2010-06-11}
   s.description = %q{Uses wkhtmltopdf to create PDFs using HTML}
   s.email = %q{jared@codewordstudios.com}
   s.executables = ["pdfkit.rb", "wkhtmltopdf-linux-i386-0-9-9", "wkhtmltopdf-osx-i386-0-9-9", "wkhtmltopdf-proxy"]
@@ -24,12 +24,19 @@ Gem::Specification.new do |s|
      "README.md",
      "Rakefile",
      "VERSION",
+     "bin/pdfkit.rb",
+     "bin/wkhtmltopdf-linux-i386-0-9-9",
+     "bin/wkhtmltopdf-osx-i386-0-9-9",
+     "bin/wkhtmltopdf-proxy",
      "lib/pdfkit.rb",
      "lib/pdfkit/middleware.rb",
      "lib/pdfkit/pdfkit.rb",
+     "lib/pdfkit/source.rb",
      "pdfkit.gemspec",
      "spec/fixtures/example.css",
+     "spec/fixtures/example.html",
      "spec/pdfkit_spec.rb",
+     "spec/source_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -40,6 +47,7 @@ Gem::Specification.new do |s|
   s.summary = %q{HTML+CSS -> PDF}
   s.test_files = [
     "spec/pdfkit_spec.rb",
+     "spec/source_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -50,13 +58,16 @@ Gem::Specification.new do |s|
     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"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
     else
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
+      s.add_dependency(%q<mocha>, [">= 0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.8"])
+    s.add_dependency(%q<mocha>, [">= 0"])
   end
 end
 

data/spec/fixtures/example.html

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

data/spec/pdfkit_spec.rb

@@ -3,9 +3,23 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe PDFKit do
   
   context "initialization" do
-    it "should take HTML for the renderer" do
+    it "should accept HTML as the source" do
       pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
-      pdfkit.html.should == '<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
@@ -32,9 +46,25 @@ describe PDFKit do
       pdfkit.command.should include('wkhtmltopdf')
       pdfkit.command.should include('--page-size Letter')
     end
+    
+    it "read the source from stdin if it is html" do
+      pdfkit = PDFKit.new('html')
+      pdfkit.command.should match(/ - -$/)
+    end
+    
+    it "specify the URL to the source if it is a url" do
+      pdfkit = PDFKit.new('http://google.com')
+      pdfkit.command.should match(/ 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.should match(/ #{file_path} -$/)
+    end
   end
   
-  context "to_pdf" do
+  context "#to_pdf" do
     it "should generate a PDF of the HTML" do
       pdfkit = PDFKit.new('html', :page_size => 'Letter')
       pdf = pdfkit.to_pdf
@@ -43,18 +73,44 @@ describe PDFKit do
     
     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')
+      css = File.join(SPEC_ROOT,'fixtures','example.css')
       pdfkit.stylesheets << css
       pdfkit.to_pdf
-      pdfkit.html.should include("<style>#{File.read(css)}</style>")
+      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.expand_path(File.dirname(__FILE__) + '/fixtures/example.css')
+      css = File.join(SPEC_ROOT,'fixtures','example.css')
       pdfkit.stylesheets << css
       pdfkit.to_pdf
-      pdfkit.html.should include("<style>#{File.read(css)}</style><html>")
+      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
   

data/spec/source_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/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

@@ -1,8 +1,10 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+SPEC_ROOT = File.dirname(__FILE__)
+$LOAD_PATH.unshift(SPEC_ROOT)
+$LOAD_PATH.unshift(File.join(SPEC_ROOT, '..', 'lib'))
 require 'pdfkit'
 require 'spec'
 require 'spec/autorun'
+require 'mocha'
 
 Spec::Runner.configure do |config|
   

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - jdpace
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-01 00:00:00 -04:00
+date: 2010-06-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,18 @@ dependencies:
         version: 2.0.0.beta.8
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Uses wkhtmltopdf to create PDFs using HTML
 email: jared@codewordstudios.com
 executables: 
@@ -64,12 +76,19 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/pdfkit.rb
+- bin/wkhtmltopdf-linux-i386-0-9-9
+- bin/wkhtmltopdf-osx-i386-0-9-9
+- bin/wkhtmltopdf-proxy
 - lib/pdfkit.rb
 - lib/pdfkit/middleware.rb
 - lib/pdfkit/pdfkit.rb
+- lib/pdfkit/source.rb
 - pdfkit.gemspec
 - spec/fixtures/example.css
+- spec/fixtures/example.html
 - spec/pdfkit_spec.rb
+- spec/source_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -104,4 +123,5 @@ specification_version: 3
 summary: HTML+CSS -> PDF
 test_files: 
 - spec/pdfkit_spec.rb
+- spec/source_spec.rb
 - spec/spec_helper.rb