pdf-wrapper 0.1.3 → 0.2.0

data/specs/image_spec.rb

@@ -3,38 +3,37 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 context "The PDF::Wrapper class" do
+
+  before(:each) { create_pdf }
+
   specify "should be able to detect the filetype of an image" do
-    pdf = PDF::Wrapper.new
-    pdf.detect_image_type(File.dirname(__FILE__) + "/data/google.png").should eql(:png)
-    pdf.detect_image_type(File.dirname(__FILE__) + "/data/zits.gif").should eql(:gif)
-    pdf.detect_image_type(File.dirname(__FILE__) + "/data/orc.svg").should eql(:svg)
-    pdf.detect_image_type(File.dirname(__FILE__) + "/data/utf8-long.pdf").should eql(:pdf)
-    pdf.detect_image_type(File.dirname(__FILE__) + "/data/shipsail.jpg").should eql(:jpg)
+    @pdf.detect_image_type(File.dirname(__FILE__) + "/data/google.png").should eql(:png)
+    @pdf.detect_image_type(File.dirname(__FILE__) + "/data/zits.gif").should eql(:gif)
+    @pdf.detect_image_type(File.dirname(__FILE__) + "/data/orc.svg").should eql(:svg)
+    @pdf.detect_image_type(File.dirname(__FILE__) + "/data/utf8-long.pdf").should eql(:pdf)
+    @pdf.detect_image_type(File.dirname(__FILE__) + "/data/shipsail.jpg").should eql(:jpg)
   end
 
   specify "should be able to determine image dimensions correctly" do
-    pdf = PDF::Wrapper.new
-    pdf.image_dimensions(File.dirname(__FILE__) + "/data/google.png").should eql([166,55])
-    pdf.image_dimensions(File.dirname(__FILE__) + "/data/zits.gif").should eql([525,167])
-    pdf.image_dimensions(File.dirname(__FILE__) + "/data/orc.svg").should eql([734, 772])
-    pdf.image_dimensions(File.dirname(__FILE__) + "/data/utf8-long.pdf").map{ |d| d.to_i}.should eql([595,841])
-    pdf.image_dimensions(File.dirname(__FILE__) + "/data/shipsail.jpg").should eql([192,128])
+    @pdf.image_dimensions(File.dirname(__FILE__) + "/data/google.png").should eql([166,55])
+    @pdf.image_dimensions(File.dirname(__FILE__) + "/data/zits.gif").should eql([525,167])
+    @pdf.image_dimensions(File.dirname(__FILE__) + "/data/orc.svg").should eql([734, 772])
+    @pdf.image_dimensions(File.dirname(__FILE__) + "/data/utf8-long.pdf").map{ |d| d.to_i}.should eql([595,841])
+    @pdf.image_dimensions(File.dirname(__FILE__) + "/data/shipsail.jpg").should eql([192,128])
   end
 
   specify "should be able to calculate scaled image dimensions correctly" do
-    pdf = PDF::Wrapper.new
-    pdf.calc_image_dimensions(100, 100, 200, 200).should eql([100.0,100.0])
-    pdf.calc_image_dimensions(nil, nil, 200, 200).should eql([200.0,200.0])
-    pdf.calc_image_dimensions(150, 200, 200, 200, true).should eql([150.0,150.0])
-    pdf.calc_image_dimensions(300, 250, 200, 200, true).should eql([250.0,250.0])
+    @pdf.calc_image_dimensions(100, 100, 200, 200).should eql([100.0,100.0])
+    @pdf.calc_image_dimensions(nil, nil, 200, 200).should eql([200.0,200.0])
+    @pdf.calc_image_dimensions(150, 200, 200, 200, true).should eql([150.0,150.0])
+    @pdf.calc_image_dimensions(300, 250, 200, 200, true).should eql([250.0,250.0])
   end
 
   specify "should be able to draw rotated images correctly" do
-    pdf = PDF::Wrapper.new
-    pdf.image(File.dirname(__FILE__) + "/data/shipsail.jpg", :rotate => :clockwise)
-    pdf.image(File.dirname(__FILE__) + "/data/shipsail.jpg", :rotate => :counterclockwise)
-    pdf.image(File.dirname(__FILE__) + "/data/shipsail.jpg", :rotate => :upsidedown)
-    pdf.image(File.dirname(__FILE__) + "/data/shipsail.jpg", :rotate => :none)
+    @pdf.image(File.dirname(__FILE__) + "/data/shipsail.jpg", :rotate => :clockwise)
+    @pdf.image(File.dirname(__FILE__) + "/data/shipsail.jpg", :rotate => :counterclockwise)
+    @pdf.image(File.dirname(__FILE__) + "/data/shipsail.jpg", :rotate => :upsidedown)
+    @pdf.image(File.dirname(__FILE__) + "/data/shipsail.jpg", :rotate => :none)
   end
 
   specify "should be able to draw an image with padding correctly"

data/specs/load_spec.rb

@@ -3,28 +3,29 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 context "The PDF::Wrapper class" do
-  specify "should load external libs correctly" do
-    pdf = PDF::Wrapper.new
 
+  before(:each) { create_pdf }
+
+  specify "should load external libs correctly" do
     # lib gdkpixbuf
     ::Object.const_defined?(:Gdk).should eql(false)
-    pdf.load_libpixbuf
+    @pdf.load_libpixbuf
     ::Object.const_defined?(:Gdk).should eql(true)
     ::Gdk.const_defined?(:Pixbuf).should eql(true)
 
     # pango
     ::Object.const_defined?(:Pango).should eql(false)
-    pdf.load_libpango
+    @pdf.load_libpango
     ::Object.const_defined?(:Pango).should eql(true)
 
     # libpoppler
     ::Object.const_defined?(:Poppler).should eql(false)
-    pdf.load_libpoppler
+    @pdf.load_libpoppler
     ::Object.const_defined?(:Poppler).should eql(true)
 
     # librsvg
     ::Object.const_defined?(:RSVG).should eql(false)
-    pdf.load_librsvg
+    @pdf.load_librsvg
     ::Object.const_defined?(:RSVG).should eql(true)
 
   end

data/specs/spec_helper.rb

@@ -10,6 +10,11 @@ gem "pdf-reader", ">=0.7.3"
 
 require 'pdf/reader'
 
+def create_pdf
+  @output = StringIO.new
+  @pdf = PDF::Wrapper.new(@output, :paper => :A4)
+end
+
 # make some private methods of PDF::Wrapper public for testing
 class PDF::Wrapper
   public :build_pango_layout

data/specs/tables_spec.rb

@@ -3,13 +3,16 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 context "The PDF::Wrapper class" do
+
+  before(:each) { create_pdf }
+
   specify "should be able to draw a table on the canvas using an array of data" do
-    pdf = PDF::Wrapper.new
     data = [%w{data1 data2}, %w{data3 data4}]
-    pdf.table(data)
+    @pdf.table(data)
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     receiver.content.first.include?("data1").should be_true
     receiver.content.first.include?("data2").should be_true
@@ -18,15 +21,15 @@ context "The PDF::Wrapper class" do
   end
 
   specify "should be able to draw a table on the canvas using a PDF::Wrapper::Table object" do
-    pdf = PDF::Wrapper.new
     table = PDF::Wrapper::Table.new do |t|
       t.data = [%w{data1 data2}, %w{data3 data4}]
     end
 
-    pdf.table(table)
+    @pdf.table(table)
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     receiver.content.first.include?("data1").should be_true
     receiver.content.first.include?("data2").should be_true
@@ -35,36 +38,36 @@ context "The PDF::Wrapper class" do
   end
 
   specify "should be able to draw a table on the canvas with no headings" do
-    pdf = PDF::Wrapper.new
     
     table = PDF::Wrapper::Table.new do |t|
       t.data = (1..50).collect { [1,2] }
-      t.headers = ["col1", "col2"]
+      t.headers ["col1", "col2"]
       t.show_headers = nil
     end
 
-    pdf.table(table)
+    @pdf.table(table)
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     receiver.content.first.include?("col1").should be_false
     receiver.content.first.include?("col2").should be_false
   end
 
   specify "should be able to draw a table on the canvas with headers on the first page only" do
-    pdf = PDF::Wrapper.new
     
     table = PDF::Wrapper::Table.new do |t|
       t.data = (1..50).collect { [1,2] }
-      t.headers = ["col1", "col2"]
+      t.headers ["col1", "col2"]
       t.show_headers = :once
     end
 
-    pdf.table(table)
+    @pdf.table(table)
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     receiver.content[0].include?("col1").should be_true
     receiver.content[0].include?("col2").should be_true
@@ -73,18 +76,18 @@ context "The PDF::Wrapper class" do
   end
 
   specify "should be able to draw a table on the canvas with headers on all pages" do
-    pdf = PDF::Wrapper.new
     
     table = PDF::Wrapper::Table.new do |t|
       t.data = (1..50).collect { [1,2] }
-      t.headers = ["col1", "col2"]
+      t.headers ["col1", "col2"]
       t.show_headers = :page
     end
 
-    pdf.table(table)
+    @pdf.table(table)
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     receiver.content[0].include?("col1").should be_true
     receiver.content[0].include?("col2").should be_true
@@ -93,18 +96,16 @@ context "The PDF::Wrapper class" do
   end
 
   specify "should leave the cursor in the bottom left when adding a table" do
-    pdf = PDF::Wrapper.new
     data = [%w{head1 head2},%w{data1 data2}]
-    pdf.table(data, :left => pdf.margin_left)
-    x,y = pdf.current_point
-    x.to_i.should eql(pdf.margin_left)
+    @pdf.table(data, :left => @pdf.margin_left)
+    x,y = @pdf.current_point
+    x.to_i.should eql(@pdf.margin_left)
   end
 
   specify "should default to using as much available space when adding a table that isn't left aligned with the left margin" do
-    pdf = PDF::Wrapper.new
     data = [%w{head1 head2},%w{data1 data2}]
-    pdf.table(data, :left => 100)
-    x,y = pdf.current_point
+    @pdf.table(data, :left => 100)
+    x,y = @pdf.current_point
     x.to_i.should eql(100)
   end
 

data/specs/text_spec.rb

@@ -3,13 +3,30 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 context "The PDF::Wrapper class" do
+
+  before(:each) { create_pdf }
+
+  specify "should be able to permanantly change the font size" do
+    @pdf.font_size 20
+    @pdf.instance_variable_get("@default_font_size").should eql(20)
+  end
+
+  specify "should be able to temporarily change the font size" do
+    @pdf.font_size 20
+    @pdf.instance_variable_get("@default_font_size").should eql(20)
+    @pdf.font_size(10) do
+      @pdf.instance_variable_get("@default_font_size").should eql(10)
+    end
+    @pdf.instance_variable_get("@default_font_size").should eql(20)
+  end
+
   specify "should be able to add ascii text to the canvas" do
     msg = "Chunky Bacon"
-    pdf = PDF::Wrapper.new
-    pdf.text msg
+    @pdf.text msg
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # TODO: test for the text is in the appropriate location on the page
     receiver.content.first.should eql(msg)
@@ -17,11 +34,11 @@ context "The PDF::Wrapper class" do
 
   specify "should be able to add unicode text to the canvas" do
     msg = "Alex Čihař"
-    pdf = PDF::Wrapper.new
-    pdf.text msg
+    @pdf.text msg
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # TODO: test for the text is in the appropriate location on the page
     receiver.content.first.should eql(msg)
@@ -29,11 +46,11 @@ context "The PDF::Wrapper class" do
 
   specify "should be able to add unicode text that spans multiple pages to the canvas" do
     msg = "James\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nHealy"
-    pdf = PDF::Wrapper.new
-    pdf.text msg
+    @pdf.text msg
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     receiver.content.size.should eql(2)
     receiver.content[0].should eql("James")
@@ -42,73 +59,72 @@ context "The PDF::Wrapper class" do
 
   specify "should be align text on the left when using the text method" do
     msg = "Chunky Bacon"
-    pdf = PDF::Wrapper.new
-    pdf.text msg, :alignment => :left
+    @pdf.text msg, :alignment => :left
+    @pdf.finish
 
     receiver = PDF::Reader::RegisterReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # ensure the text is placed in the right location
     params = receiver.first_occurance_of(:set_text_matrix_and_text_line_matrix)[:args]
-    params[4].should eql(pdf.margin_left.to_f)
+    params[4].should eql(@pdf.margin_left.to_f)
   end
 
   specify "should be able to align text on the left when using the text method" do
     msg = "Chunky Bacon"
-    pdf = PDF::Wrapper.new
-    pdf.text msg, :alignment => :left
+    @pdf.text msg, :alignment => :left
+    @pdf.finish
 
     receiver = PDF::Reader::RegisterReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # ensure the text is placed in the right location
     params = receiver.first_occurance_of(:set_text_matrix_and_text_line_matrix)[:args]
-    params[4].should eql(pdf.margin_left.to_f)
+    params[4].should eql(@pdf.margin_left.to_f)
   end
 
   specify "should be able to align text in the centre when using the text method" do
     msg = "Chunky Bacon"
-    pdf = PDF::Wrapper.new
-    pdf.text msg, :alignment => :center
+    @pdf.text msg, :alignment => :center
+    @pdf.finish
 
     receiver = PDF::Reader::RegisterReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # ensure the text is placed in the right location - the left
     # egde should be less than half way across the page, but not on the left margin
     params = receiver.first_occurance_of(:set_text_matrix_and_text_line_matrix)[:args]
-    (params[4] < pdf.absolute_x_middle).should be_true
-    (params[4] > pdf.absolute_x_middle - 100).should be_true
+    (params[4] < @pdf.absolute_x_middle).should be_true
+    (params[4] > @pdf.absolute_x_middle - 100).should be_true
   end
 
   specify "should be able to align text on the right when using the text method" do
     msg = "Chunky Bacon"
-    pdf = PDF::Wrapper.new
-    pdf.text msg, :alignment => :right
+    @pdf.text msg, :alignment => :right
+    @pdf.finish
 
     receiver = PDF::Reader::RegisterReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # ensure the text is placed in the right location - the left
     # egde should be more than half way across the page, but not on the right margin
     params = receiver.first_occurance_of(:set_text_matrix_and_text_line_matrix)[:args]
-    (params[4] > pdf.absolute_x_middle).should be_true
-    (params[4] < pdf.absolute_right_margin).should be_true
+    (params[4] > @pdf.absolute_x_middle).should be_true
+    (params[4] < @pdf.absolute_right_margin).should be_true
   end
 
   specify "should raise an error when an invalid alignment is specified" do
     msg = "James Healy"
-    pdf = PDF::Wrapper.new
-    lambda { pdf.text msg, :alignment => :ponies }.should raise_error(ArgumentError)
+    lambda { @pdf.text msg, :alignment => :ponies }.should raise_error(ArgumentError)
   end
 
   specify "should be able to add text to the canvas in a bounding box using the cell method" do
     msg = "Alex Čihař"
-    pdf = PDF::Wrapper.new
-    pdf.cell msg, 100, 100, 200, 200
+    @pdf.cell msg, 100, 100, 200, 200
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # TODO: test for the text is in the appropriate location on the page
     receiver.content.first.should eql(msg)
@@ -116,13 +132,13 @@ context "The PDF::Wrapper class" do
 
   specify "should keep all text for a cell inside the cell boundaries" do
     msg = "This is a text cell, added by James"
-    pdf = PDF::Wrapper.new
     x = y = 100
     w = h = 200
-    pdf.cell msg, x, y, w, h
+    @pdf.cell msg, x, y, w, h
+    @pdf.finish
 
     receiver = PDF::Reader::RegisterReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     receiver.all(:set_text_matrix_and_text_line_matrix).each do |cb|
       # horizontal location
@@ -134,7 +150,7 @@ context "The PDF::Wrapper class" do
       # vertical location
       # TODO: we're only testing the it doesn't start past the bottom boundary of the cell
       #       should also test that it doesn't start in the cell but overrun it
-      cell_top_bound = pdf.page_height - y
+      cell_top_bound = @pdf.page_height - y
       (cb[:args][5] <= cell_top_bound).should     be_true
       (cb[:args][5] >= cell_top_bound - h).should be_true
     end
@@ -142,37 +158,33 @@ context "The PDF::Wrapper class" do
 
   specify "should be able to calculate the height of a string of text" do
     str   = "This is a medium length string\nthat is also multi line. one two three four."
-    pdf = PDF::Wrapper.new
     opts = {:font_size => 16, :font => "Sans Serif", :alignment => :left, :justify => false }
-    pdf.text_height(str, pdf.body_width, opts).should eql(49)
+    @pdf.text_height(str, @pdf.body_width, opts).should eql(49)
   end
 
   specify "should be able to calculate the width of a string of text" do
     str  = "James Healy"
     str2 = "James Healy is a Ruby dev that lives in Melbourne, Australia. His day job mostly involved Ruby on Rails."
-    pdf = PDF::Wrapper.new
     opts = {:font_size => 16, :font => "Sans Serif"}
-    pdf.text(str, opts)
-    pdf.text_width(str, opts).should eql(131)
-    pdf.text_width(str2, opts).should eql(1107)
+    @pdf.text(str, opts)
+    @pdf.text_width(str, opts).should eql(131)
+    @pdf.text_width(str2, opts).should eql(1107)
   end
 
   specify "should raise an exception if build_pango_layout is passed anything other than a string" do
-    pdf = PDF::Wrapper.new
-    lambda { pdf.build_pango_layout(10) }.should raise_error(ArgumentError)
+    lambda { @pdf.build_pango_layout(10) }.should raise_error(ArgumentError)
   end
 
   if RUBY_VERSION >= "1.9"
     specify "should accept non UTF-8 strings to build_pango_layout and convert them on the fly" do
-      pdf = PDF::Wrapper.new
 
       # all three of these files have the same content, but in different encodings
       iso2022_str  = File.open(File.dirname(__FILE__) + "/data/shift_jis.txt", "r:ISO-2022-JP") { |f| f.read }.strip!
       shiftjis_str = File.open(File.dirname(__FILE__) + "/data/iso-2022-jp.txt", "r:Shift_JIS") { |f| f.read }.strip!
       utf8_str     = File.open(File.dirname(__FILE__) + "/data/utf8.txt", "r:UTF-8") { |f| f.read }.strip!
 
-      pdf.build_pango_layout(shiftjis_str)
-      pdf.build_pango_layout(iso2022_str)
+      @pdf.build_pango_layout(shiftjis_str)
+      @pdf.build_pango_layout(iso2022_str)
 
       # TODO: improve this spec using mocks. Atm, I'm assume that if build_pango_layout didn't raise an exception when
       #       passed in the non UTF-8 strings, then all worked fine. yuck.
@@ -183,11 +195,11 @@ context "The PDF::Wrapper class" do
 
   specify "should accept and render pango markup correctly" do
     msg = "<b>James</b>"
-    pdf = PDF::Wrapper.new
-    pdf.text msg, :markup => :pango
+    @pdf.text msg, :markup => :pango
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     page_one = receiver.content.first.dup
     page_one.should eql("James")
@@ -195,11 +207,11 @@ context "The PDF::Wrapper class" do
 
   specify "should be able to alle to wrap text on word boundaries" do
     msg = "James Healy"
-    pdf = PDF::Wrapper.new
-    pdf.text msg, :wrap => :word
+    @pdf.text msg, :wrap => :word
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # TODO: test for the text is in the appropriate location on the page
     receiver.content.first.should eql(msg)
@@ -207,11 +219,11 @@ context "The PDF::Wrapper class" do
 
   specify "should be able to able to wrap text on char boundaries" do
     msg = "James Healy"
-    pdf = PDF::Wrapper.new
-    pdf.text msg, :wrap => :char
+    @pdf.text msg, :wrap => :char
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # TODO: test for the text is in the appropriate location on the page
     receiver.content.first.should eql(msg)
@@ -219,11 +231,11 @@ context "The PDF::Wrapper class" do
 
   specify "should be able to wrap text on word and char boundaries" do
     msg = "James Healy"
-    pdf = PDF::Wrapper.new
-    pdf.text msg, :wrap => :wordchar
+    @pdf.text msg, :wrap => :wordchar
+    @pdf.finish
 
     receiver = PageTextReceiver.new
-    reader = PDF::Reader.string(pdf.render, receiver)
+    reader = PDF::Reader.string(@output.string, receiver)
 
     # TODO: test for the text is in the appropriate location on the page
     receiver.content.first.should eql(msg)
@@ -231,8 +243,7 @@ context "The PDF::Wrapper class" do
 
   specify "should raise an error when an invalid wrapping technique is specified" do
     msg = "James Healy"
-    pdf = PDF::Wrapper.new
-    lambda { pdf.text msg, :wrap => :ponies }.should raise_error(ArgumentError)
+    lambda { @pdf.text msg, :wrap => :ponies }.should raise_error(ArgumentError)
   end
 
 end