pdfkit 0.6.2 → 0.7.0

data/spec/pdfkit_spec.rb

@@ -2,52 +2,51 @@
 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>'
+      expect(pdfkit.source).to be_html
+      expect(pdfkit.source.to_s).to eq('<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'
+      expect(pdfkit.source).to be_url
+      expect(pdfkit.source.to_s).to eq('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
+      expect(pdfkit.source).to be_file
+      expect(pdfkit.source.to_s).to eq(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')
+      expect(pdfkit.options).to have_key('--page-size')
     end
 
     it "should parse complex options into a cmd line friedly format" do
       pdfkit = PDFKit.new('html', :replace => {'value' => 'something else'} )
-      pdfkit.options.should have_key('--replace')
+      expect(pdfkit.options).to have_key('--replace')
     end
 
     it "should provide default options" do
       pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
       ['--margin-top', '--margin-right', '--margin-bottom', '--margin-left'].each do |option|
-        pdfkit.options.should have_key(option)
+        expect(pdfkit.options).to have_key(option)
       end
     end
 
     it "should default to 'UTF-8' encoding" do
       pdfkit = PDFKit.new('Captación')
-      pdfkit.options['--encoding'].should == 'UTF-8'
+      expect(pdfkit.options['--encoding']).to eq('UTF-8')
     end
 
     it "should not have any stylesheedt by default" do
       pdfkit = PDFKit.new('<h1>Oh Hai</h1>')
-      pdfkit.stylesheets.should be_empty
+      expect(pdfkit.stylesheets).to be_empty
     end
   end
 
@@ -55,30 +54,36 @@ describe PDFKit do
     it "should contstruct the correct command" do
       pdfkit = PDFKit.new('html', :page_size => 'Letter', :toc_l1_font_size => 12, :replace => {'foo' => 'bar'})
       command = pdfkit.command
-      command.should include "wkhtmltopdf"
-      command.should include "--page-size Letter"
-      command.should include "--toc-l1-font-size 12"
-      command.should include "--replace foo bar"
+      expect(command).to include "wkhtmltopdf"
+      expect(command).to include "--page-size Letter"
+      expect(command).to include "--toc-l1-font-size 12"
+      expect(command).to include "--replace foo bar"
     end
 
     it "should setup one cookie only" do
       pdfkit = PDFKit.new('html', cookie: {cookie_name: :cookie_value})
       command = pdfkit.command
-      command.should include "--cookie cookie_name cookie_value"
+      expect(command).to include "--cookie cookie_name cookie_value"
+    end
+
+    it "should not break Windows paths" do
+      pdfkit = PDFKit.new('html')
+      allow(PDFKit.configuration).to receive(:wkhtmltopdf).and_return 'c:/Program Files/wkhtmltopdf/wkhtmltopdf.exe'
+      expect(pdfkit.command).not_to include('Program\ Files')
     end
 
     it "should setup multiple cookies when passed a hash" do
       pdfkit = PDFKit.new('html', :cookie => {:cookie_name1 => :cookie_val1, :cookie_name2 => :cookie_val2})
       command = pdfkit.command
-      command.should include "--cookie cookie_name1 cookie_val1"
-      command.should include "--cookie cookie_name2 cookie_val2"
+      expect(command).to include "--cookie cookie_name1 cookie_val1"
+      expect(command).to include "--cookie cookie_name2 cookie_val2"
     end
 
     it "should setup multiple cookies when passed an array of tuples" do
       pdfkit = PDFKit.new('html', :cookie => [[:cookie_name1, :cookie_val1], [:cookie_name2, :cookie_val2]])
       command = pdfkit.command
-      command.should include "--cookie cookie_name1 cookie_val1"
-      command.should include "--cookie cookie_name2 cookie_val2"
+      expect(command).to include "--cookie cookie_name1 cookie_val1"
+      expect(command).to include "--cookie cookie_name2 cookie_val2"
     end
 
     it "will not include default options it is told to omit" do
@@ -87,41 +92,41 @@ describe PDFKit do
       end
 
       pdfkit = PDFKit.new('html')
-      pdfkit.command.should include('--disable-smart-shrinking')
+      expect(pdfkit.command).to include('--disable-smart-shrinking')
       pdfkit = PDFKit.new('html', :disable_smart_shrinking => false)
-      pdfkit.command.should_not include('--disable-smart-shrinking')
+      expect(pdfkit.command).not_to include('--disable-smart-shrinking')
     end
 
     it "should encapsulate string arguments in quotes" do
       pdfkit = PDFKit.new('html', :header_center => "foo [page]")
-      pdfkit.command.should include "--header-center foo\\ \\[page\\]"
+      expect(pdfkit.command).to include "--header-center foo\\ \\[page\\]"
     end
 
     it "should sanitize string arguments" do
       pdfkit = PDFKit.new('html', :header_center => "$(ls)")
-      pdfkit.command.should include "--header-center \\$\\(ls\\)"
+      expect(pdfkit.command).to include "--header-center \\$\\(ls\\)"
     end
 
     it "read the source from stdin if it is html" do
       pdfkit = PDFKit.new('html')
-      pdfkit.command.should match /- -$/
+      expect(pdfkit.command).to 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 -$/
+      expect(pdfkit.command).to 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} -$/
+      expect(pdfkit.command).to match /#{file_path} -$/
     end
 
     it "should specify the path for the ouput if a apth is given" do
       file_path = "/path/to/output.pdf"
       pdfkit = PDFKit.new("html")
-      pdfkit.command(file_path).should match /#{file_path}$/
+      expect(pdfkit.command(file_path)).to match /#{file_path}$/
     end
 
     it "should detect special pdfkit meta tags" do
@@ -135,8 +140,8 @@ describe PDFKit do
       }
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
-      command.should include "--page-size Legal"
-      command.should include "--orientation Landscape"
+      expect(command).to include "--page-size Legal"
+      expect(command).to include "--orientation Landscape"
     end
 
     it "should detect cookies meta tag" do
@@ -150,7 +155,7 @@ describe PDFKit do
       }
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
-      command.should include "--cookie rails_session rails_session_value --cookie cookie_variable cookie_variable_value"
+      expect(command).to include "--cookie rails_session rails_session_value --cookie cookie_variable cookie_variable_value"
     end
 
     it "should detect disable_smart_shrinking meta tag" do
@@ -163,8 +168,8 @@ describe PDFKit do
       }
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
-      command.should include "--disable-smart-shrinking"
-      command.should_not include "--disable-smart-shrinking true"
+      expect(command).to include "--disable-smart-shrinking"
+      expect(command).not_to include "--disable-smart-shrinking true"
     end
 
     it "should detect names with hyphens instead of underscores" do
@@ -178,7 +183,7 @@ describe PDFKit do
         </html>
       }
       pdfkit = PDFKit.new(body)
-      pdfkit.command.should_not include 'name\='
+      expect(pdfkit.command).not_to include 'name\='
     end
 
     it "should detect special pdfkit meta tags despite bad markup" do
@@ -193,8 +198,8 @@ describe PDFKit do
       }
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
-      command.should include "--page-size Legal"
-      command.should include "--orientation Landscape"
+      expect(command).to include "--page-size Legal"
+      expect(command).to include "--orientation Landscape"
     end
 
     it "should skip non-pdfkit meta tags" do
@@ -209,18 +214,18 @@ describe PDFKit do
       }
       pdfkit = PDFKit.new(body)
       command = pdfkit.command
-      command.should_not include "--page-size Legal"
-      command.should include "--orientation Landscape"
+      expect(command).not_to include "--page-size Legal"
+      expect(command).to include "--orientation Landscape"
     end
 
     it "should not use quiet" do
       pdfkit = PDFKit.new('html', quiet: false)
-      pdfkit.command.should_not include '--quiet'
+      expect(pdfkit.command).not_to include '--quiet'
     end
 
     it "should use quiet option by defautl" do
       pdfkit = PDFKit.new('html')
-      pdfkit.command.should include '--quiet'
+      expect(pdfkit.command).to include '--quiet'
     end
 
     it "should not use quiet option in verbose mode" do
@@ -229,7 +234,7 @@ describe PDFKit do
       end
 
       pdfkit = PDFKit.new('html')
-      pdfkit.command.should_not include '--quiet'
+      expect(pdfkit.command).not_to include '--quiet'
 
       PDFKit.configure do |config|
         config.verbose = false
@@ -239,22 +244,41 @@ describe PDFKit do
   end
 
   context "#to_pdf" do
+    it "should not read the contents of the pdf when saving it as a file" do
+      file_path = "/my/file/path.pdf"
+      pdfkit = PDFKit.new('html', :page_size => 'Letter')
+
+      mock_pdf = double
+      expect(mock_pdf).to receive(:puts)
+      expect(mock_pdf).not_to receive(:gets) # do no read the contents when given a file path
+      expect(mock_pdf).to receive(:close_write)
+      
+
+      expect(IO).to receive(:popen) do |args, mode, &block|
+        block.call(mock_pdf)
+      end
+
+      expect(::File).to receive(:size).with(file_path).and_return(50)
+
+      pdfkit.to_pdf(file_path)
+    end
+
     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
+      expect(pdf[0...4]).to eq("%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
+      expect(pdf[0...4]).to eq("%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
+      expect(pdf[0...4]).to eq("%PDF") # PDF Signature at beginning of file
     end
 
     it "should have the stylesheet added to the head if it has one" do
@@ -262,7 +286,7 @@ describe PDFKit do
       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>")
+      expect(pdfkit.source.to_s).to include("<style>#{File.read(css)}</style>")
     end
 
     it "should prepend style tags if the HTML doesn't have a head tag" do
@@ -270,14 +294,14 @@ describe PDFKit do
       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>")
+      expect(pdfkit.source.to_s).to 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)
+      expect { pdfkit.to_pdf }.to raise_error(PDFKit::ImproperSourceError)
     end
 
     it "should be able to deal with ActiveSupport::SafeBuffer" do
@@ -285,7 +309,7 @@ describe PDFKit do
       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></head>")
+      expect(pdfkit.source.to_s).to include("<style>#{File.read(css)}</style></head>")
     end
 
     it "should escape \\X in stylesheets" do
@@ -293,25 +317,25 @@ describe PDFKit do
       css = File.join(SPEC_ROOT,'fixtures','example_with_hex_symbol.css')
       pdfkit.stylesheets << css
       pdfkit.to_pdf
-      pdfkit.source.to_s.should include("<style>#{File.read(css)}</style></head>")
+      expect(pdfkit.source.to_s).to include("<style>#{File.read(css)}</style></head>")
     end
 
     #NOTICE: This test is failed if use wkhtmltopdf-binary (0.9.9.1)
     it "should throw an error if it is unable to connect" do
       pdfkit = PDFKit.new("http://google.com/this-should-not-be-found/404.html")
-      lambda { pdfkit.to_pdf }.should raise_error /exitstatus=2/
+      expect { pdfkit.to_pdf }.to raise_error /exitstatus=2/
     end
 
     it "should not throw an error if it is unable to connect", pending: 'this test works for wkhtmltopdf-binary (0.9.9.1)' do
       pdfkit = PDFKit.new("http://localhost/this-should-not-be-found/404.html")
       pdf = pdfkit.to_pdf
-      pdf[0...4].should == "%PDF" # PDF Signature at the beginning
+      expect(pdf[0...4]).to eq("%PDF") # PDF Signature at the beginning
     end
 
     it "should generate PDF if there are missing assets" do
       pdfkit = PDFKit.new("<html><body><img alt='' src='http://example.com/surely-it-doesnt-exist.gif' /></body></html>", ignore_load_errors: true)
       pdf = pdfkit.to_pdf
-      pdf[0...4].should == "%PDF" # PDF Signature at the beginning
+      expect(pdf[0...4]).to eq("%PDF") # PDF Signature at the beginning
     end
   end
 
@@ -328,8 +352,8 @@ describe PDFKit do
     it "should create a file with the PDF as content" do
       pdfkit = PDFKit.new('html', :page_size => 'Letter')
       file = pdfkit.to_file(@file_path)
-      file.should be_instance_of(File)
-      File.read(file.path)[0...4].should == "%PDF" # PDF Signature at beginning of file
+      expect(file).to be_instance_of(File)
+      expect(File.read(file.path)[0...4]).to eq("%PDF") # PDF Signature at beginning of file
     end
 
     it "should not truncate data (in Ruby 1.8.6)" do
@@ -338,7 +362,7 @@ describe PDFKit do
       pdf_data = pdfkit.to_pdf
       file = pdfkit.to_file(@file_path)
       file_data = open(@file_path, 'rb') {|io| io.read }
-      pdf_data.size.should == file_data.size
+      expect(pdf_data.size).to eq(file_data.size)
     end
   end
 
@@ -355,7 +379,7 @@ describe PDFKit do
     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
+      expect(File.exist?(@test_path)).to eq(false)
     end
   end
 end

data/spec/source_spec.rb

@@ -5,74 +5,73 @@ 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
+      expect(source).to be_url
     end
     
     it "should return false if passed a file" do
       source = PDFKit::Source.new(File.new(__FILE__))
-      source.should_not be_url
+      expect(source).not_to be_url
     end
     
     it "should return false if passed HTML" do
       source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
-      source.should_not be_url
+      expect(source).not_to be_url
     end
 
     it "should return false if passed HTML with embedded urls at the beginning of a line" do
       source = PDFKit::Source.new("<blink>Oh Hai!</blink>\nhttp://www.google.com")
-      source.should_not be_url
+      expect(source).not_to 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
+      source = PDFKit::Source.new(::File.new(__FILE__))
+      expect(source).to 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
+      expect(source).not_to be_file
     end
     
     it "should return false if passed HTML" do
       source = PDFKit::Source.new('<blink>Oh Hai!</blink>')
-      source.should_not be_file
+      expect(source).not_to 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
+      expect(source).to be_html
     end
     
     it "should return false if passed a file" do
-      source = PDFKit::Source.new(File.new(__FILE__))
-      source.should_not be_html
+      source = PDFKit::Source.new(::File.new(__FILE__))
+      expect(source).not_to 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
+      expect(source).not_to 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>'
+      expect(source.to_s).to eq('<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__
+      source = PDFKit::Source.new(::File.new(__FILE__))
+      expect(source.to_s).to eq(__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'
+      expect(source.to_s).to eq('http://google.com')
     end
   end
-  
 end