pdfkit 0.3.0 → 0.3.1

data/Rakefile

@@ -20,7 +20,6 @@ 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",
@@ -44,10 +43,10 @@ rescue LoadError
 end
 
 require 'rspec/core/rake_task'
-Rspec::Core::RakeTask.new(:spec) do |spec|
+RSpec::Core::RakeTask.new(:spec) do |spec|
 end
 
-Rspec::Core::RakeTask.new(:rcov) do |spec|
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/pdfkit/pdfkit.rb

@@ -30,12 +30,11 @@ class PDFKit
     }
     @options = normalize_options(options.reverse_merge(default_options))
     
-    @cmd  = `which wkhtmltopdf-proxy`.chomp
-    raise NoExecutableError.new if @cmd.blank?
+    raise NoExecutableError.new if wkhtmltopdf.blank?
   end
   
   def command
-    args = [@cmd]
+    args = [wkhtmltopdf]
     args += @options.to_a.flatten.compact
     args << '--quiet'
     
@@ -66,6 +65,10 @@ class PDFKit
   
   protected
   
+    def wkhtmltopdf
+      @wkhtmltopdf ||= `which wkhtmltopdf-proxy`.chomp
+    end
+  
     def style_tag_for(stylesheet)
       "<style>#{File.read(stylesheet)}</style>"
     end

data/pdfkit.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pdfkit}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jdpace"]
-  s.date = %q{2010-06-11}
+  s.date = %q{2010-06-15}
   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"]
+  s.executables = ["wkhtmltopdf-linux-i386-0-9-9", "wkhtmltopdf-osx-i386-0-9-9", "wkhtmltopdf-proxy"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.md"
@@ -24,7 +24,6 @@ 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",
@@ -43,10 +42,10 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.3.7}
   s.summary = %q{HTML+CSS -> PDF}
   s.test_files = [
-    "spec/pdfkit_spec.rb",
+    "spec/PDFKit_spec.rb",
      "spec/source_spec.rb",
      "spec/spec_helper.rb"
   ]
@@ -55,7 +54,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= 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"])

data/spec/PDFKit_spec.rb

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

data/spec/spec_helper.rb

@@ -8,4 +8,8 @@ require 'mocha'
 
 Spec::Runner.configure do |config|
   
+  config.before do
+    PDFKit.any_instance.stubs(:wkhtmltopdf).returns(File.join(SPEC_ROOT,'..','bin','wkhtmltopdf-proxy'))
+  end
+  
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pdfkit
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - jdpace
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-11 00:00:00 -04:00
+date: 2010-06-15 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +36,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 62196467
         segments: 
         - 2
         - 0
@@ -49,9 +54,11 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -60,7 +67,6 @@ dependencies:
 description: Uses wkhtmltopdf to create PDFs using HTML
 email: jared@codewordstudios.com
 executables: 
-- pdfkit.rb
 - wkhtmltopdf-linux-i386-0-9-9
 - wkhtmltopdf-osx-i386-0-9-9
 - wkhtmltopdf-proxy
@@ -76,7 +82,6 @@ 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
@@ -91,6 +96,7 @@ files:
 - spec/source_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/PDFKit_spec.rb
 has_rdoc: true
 homepage: http://github.com/jdpace/PDFKit
 licenses: []
@@ -101,27 +107,31 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: HTML+CSS -> PDF
 test_files: 
-- spec/pdfkit_spec.rb
+- spec/PDFKit_spec.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb

data/bin/pdfkit.rb

@@ -1,2 +0,0 @@
-# Having this file, which matches the name of the gem,
-# is required for the gem to be installed and called properly.