pdf-wrapper 0.0.7 → 0.1.0

data/specs/text_spec.rb

@@ -16,7 +16,7 @@ context "The PDF::Wrapper class" do
   end
 
   specify "should be able to add unicode text to the canvas" do
-    msg = "メインページ"
+    msg = "Alex Čihař"
     pdf = PDF::Wrapper.new
     pdf.text msg
 
@@ -96,8 +96,14 @@ context "The PDF::Wrapper class" do
     (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)
+  end
+
   specify "should be able to add text to the canvas in a bounding box using the cell method" do
-    msg = "メインページ"
+    msg = "Alex Čihař"
     pdf = PDF::Wrapper.new
     pdf.cell msg, 100, 100, 200, 200
 
@@ -174,4 +180,59 @@ context "The PDF::Wrapper class" do
 
     specify "should raise an error when a string that isn't convertable to UTF-8 is passed into build_pango_layout()"
   end
+
+  specify "should accept and render pango markup correctly" do
+    msg = "<b>James</b>"
+    pdf = PDF::Wrapper.new
+    pdf.text msg, :markup => :pango
+
+    receiver = PageTextReceiver.new
+    reader = PDF::Reader.string(pdf.render, receiver)
+
+    page_one = receiver.content.first.dup
+    page_one.should eql("James")
+  end
+
+  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
+
+    receiver = PageTextReceiver.new
+    reader = PDF::Reader.string(pdf.render, receiver)
+
+    # TODO: test for the text is in the appropriate location on the page
+    receiver.content.first.should eql(msg)
+  end
+
+  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
+
+    receiver = PageTextReceiver.new
+    reader = PDF::Reader.string(pdf.render, receiver)
+
+    # TODO: test for the text is in the appropriate location on the page
+    receiver.content.first.should eql(msg)
+  end
+
+  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
+
+    receiver = PageTextReceiver.new
+    reader = PDF::Reader.string(pdf.render, receiver)
+
+    # TODO: test for the text is in the appropriate location on the page
+    receiver.content.first.should eql(msg)
+  end
+
+  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)
+  end
+
 end

data/specs/wrapper_spec.rb

@@ -41,36 +41,22 @@ context "The PDF::Wrapper class" do
 
   specify "should initilize with the correct default text and colour settings" do
     pdf = PDF::Wrapper.new
-    pdf.instance_variable_get("@default_color").should eql([0.0,0.0,0.0,1.0])
     pdf.instance_variable_get("@default_font").should eql("Sans Serif")
     pdf.instance_variable_get("@default_font_size").should eql(16)
-    pdf.instance_variable_get("@default_line_width").should eql(2.0)
-  end
-
-  specify "should be able to change the default color" do
-    pdf = PDF::Wrapper.new
-    pdf.default_color(:red)
-    pdf.instance_variable_get("@default_color").should eql([1.0,0.0,0.0,1.0])
   end
 
   specify "should be able to change the default font" do
     pdf = PDF::Wrapper.new
-    pdf.default_font("Arial")
+    pdf.font("Arial")
     pdf.instance_variable_get("@default_font").should eql("Arial")
   end
 
   specify "should be able to change the default font size" do
     pdf = PDF::Wrapper.new
-    pdf.default_font_size(24)
+    pdf.font_size(24)
     pdf.instance_variable_get("@default_font_size").should eql(24)
   end
 
-  specify "should be able to change the default line width" do
-    pdf = PDF::Wrapper.new
-    pdf.default_line_width(10)
-    pdf.instance_variable_get("@default_line_width").should eql(10)
-  end
-
   specify "should initialize with the cursor at the top left of the body of the page" do
     pdf = PDF::Wrapper.new
     x,y = pdf.current_point
@@ -92,8 +78,8 @@ context "The PDF::Wrapper class" do
     pdf.absolute_y_middle.should eql(PDF::Wrapper::PAGE_SIZES[:A4].last / 2)
     pdf.body_width.should eql(pdf.page_width - pdf.margin_left - pdf.margin_right)
     pdf.body_height.should eql(pdf.page_height - pdf.margin_top - pdf.margin_bottom)
-    pdf.margin_x_middle.should eql(pdf.margin_left + (pdf.body_width/ 2))
-    pdf.margin_y_middle.should eql(pdf.margin_top + (pdf.body_height/ 2))
+    pdf.body_x_middle.should eql(pdf.margin_left + (pdf.body_width/ 2))
+    pdf.body_y_middle.should eql(pdf.margin_top + (pdf.body_height/ 2))
     pdf.points_to_bottom_margin(300).should eql(pdf.absolute_bottom_margin - 300)
     pdf.points_to_right_margin(300).should eql(pdf.absolute_right_margin - 300)
   end
@@ -106,10 +92,14 @@ context "The PDF::Wrapper class" do
     y.to_i.should eql(100)
   end
 
-  specify "should raise an exception if the user tries to move the cursor off the canvas" do
+  specify "should be able to move the cursor to any arbitary point on the canvas when scaled" do
     pdf = PDF::Wrapper.new
-    lambda {pdf.move_to(PDF::Wrapper::PAGE_SIZES[:A4].first + 10,100)}.should raise_error(ArgumentError)
-    lambda {pdf.move_to(100, PDF::Wrapper::PAGE_SIZES[:A4].last + 10)}.should raise_error(ArgumentError)
+    pdf.scale(pdf.page_width, pdf.page_height) do
+      pdf.move_to(0.5, 0.5)
+      x,y = pdf.current_point
+      sprintf("%0.1f",x).should eql("0.5")
+      sprintf("%0.1f",y).should eql("0.5")
+    end
   end
 
   specify "should be able to shift the y position of the cursor using pad" do
@@ -171,24 +161,6 @@ context "The PDF::Wrapper class" do
     tmp.unlink
   end
 
-  specify "should be able to draw a table on the canvas"
-
-  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)
-  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
-    x.to_i.should eql(100)
-  end
-
   specify "should be able to determine if a requested colour is valid or not" do
     pdf = PDF::Wrapper.new
     pdf.validate_color(:black).should be_true
@@ -203,15 +175,15 @@ context "The PDF::Wrapper class" do
     test_str = "repeating"
 
     pdf = PDF::Wrapper.new
-    pdf.repeating_element(:all) { pdf.text test_str } 
-    
+    pdf.repeating_element(:all) { pdf.text test_str }
+
     pdf.start_new_page
     pdf.start_new_page
     pdf.start_new_page
-    
+
     receiver = PageTextReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
-   
+
     receiver.content.size.should eql(4)
     receiver.content[0].should eql(test_str)
     receiver.content[1].should eql(test_str)
@@ -223,15 +195,15 @@ context "The PDF::Wrapper class" do
     test_str = "repeating"
 
     pdf = PDF::Wrapper.new
-    pdf.repeating_element(:odd) { pdf.text test_str } 
-    
+    pdf.repeating_element(:odd) { pdf.text test_str }
+
     pdf.start_new_page
     pdf.start_new_page
     pdf.start_new_page
-    
+
     receiver = PageTextReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
-   
+
     receiver.content.size.should eql(4)
     receiver.content[0].should eql(test_str)
     receiver.content[1].should eql("")
@@ -243,15 +215,15 @@ context "The PDF::Wrapper class" do
     test_str = "repeating"
 
     pdf = PDF::Wrapper.new
-    pdf.repeating_element(:even) { pdf.text test_str } 
-    
+    pdf.repeating_element(:even) { pdf.text test_str }
+
     pdf.start_new_page
     pdf.start_new_page
     pdf.start_new_page
-    
+
     receiver = PageTextReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
-   
+
     receiver.content.size.should eql(4)
     receiver.content[0].should eql("")
     receiver.content[1].should eql(test_str)
@@ -263,15 +235,15 @@ context "The PDF::Wrapper class" do
     test_str = "repeating"
 
     pdf = PDF::Wrapper.new
-    pdf.repeating_element((2..3)) { pdf.text test_str } 
-    
+    pdf.repeating_element((2..3)) { pdf.text test_str }
+
     pdf.start_new_page
     pdf.start_new_page
     pdf.start_new_page
-    
+
     receiver = PageTextReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
-   
+
     receiver.content.size.should eql(4)
     receiver.content[0].should eql("")
     receiver.content[1].should eql(test_str)
@@ -283,15 +255,15 @@ context "The PDF::Wrapper class" do
     test_str = "repeating"
 
     pdf = PDF::Wrapper.new
-    pdf.repeating_element(2) { pdf.text test_str } 
-    
+    pdf.repeating_element(2) { pdf.text test_str }
+
     pdf.start_new_page
     pdf.start_new_page
     pdf.start_new_page
-    
+
     receiver = PageTextReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
-   
+
     receiver.content.size.should eql(4)
     receiver.content[0].should eql("")
     receiver.content[1].should eql(test_str)
@@ -303,15 +275,15 @@ context "The PDF::Wrapper class" do
     test_str = "repeating"
 
     pdf = PDF::Wrapper.new
-    pdf.repeating_element([1,3,4]) { pdf.text test_str } 
-    
+    pdf.repeating_element([1,3,4]) { pdf.text test_str }
+
     pdf.start_new_page
     pdf.start_new_page
     pdf.start_new_page
-    
+
     receiver = PageTextReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
-   
+
     receiver.content.size.should eql(4)
     receiver.content[0].should eql(test_str)
     receiver.content[1].should eql("")
@@ -386,12 +358,6 @@ context "The PDF::Wrapper class" do
     x, y = pdf.current_point
     x.should eql(origx)
     y.should eql(origy)
-
-    # rounded_rectangle()
-    pdf.rounded_rectangle(200, 400, 100, 100, 10)
-    x, y = pdf.current_point
-    x.should eql(origx)
-    y.should eql(origy)
   end
 
   specify "should maintain an internal counter of pages" do
@@ -415,14 +381,13 @@ context "The PDF::Wrapper class" do
     lambda { pdf.line(100,100,200,200, :ponies => true)}.should raise_error(ArgumentError)
     lambda { pdf.rectangle(100,100,100,100, :ponies => true)}.should raise_error(ArgumentError)
     lambda { pdf.start_new_page(:ponies => true)}.should raise_error(ArgumentError)
-    lambda { pdf.rounded_rectangle(100,100,100,100,10, :ponies => true)}.should raise_error(ArgumentError)
     lambda { pdf.image(File.dirname(__FILE__) + "/data/orc.svg", :ponies => true)}.should raise_error(ArgumentError)
   end
 
   specify "should allow an existing file to be used as a template for page 1" do
     pdf = PDF::Wrapper.new(:paper => :A4, :template => File.dirname(__FILE__) + "/data/orc.svg")
     pdf.start_new_page
-    
+
     receiver = PageSizeReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
 
@@ -433,11 +398,119 @@ context "The PDF::Wrapper class" do
   specify "should allow an existing file to be used as a template for page 2" do
     pdf = PDF::Wrapper.new(:paper => :A4)
     pdf.start_new_page(:template => File.dirname(__FILE__) + "/data/orc.svg")
-    
+
     receiver = PageSizeReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
 
     receiver.pages[0].should eql([0.0, 0.0, 595.28, 841.89])
     receiver.pages[1].should eql([0.0, 0.0, 734.0, 772.0])
   end
+
+  specify "should return correct page dimensions when scaled" do
+    pdf = PDF::Wrapper.new(:paper => :A4)
+
+    pdf.scale(595.28, 841.89) do
+      pdf.page_width.should eql(1.0)
+      pdf.page_height.should eql(1.0)
+      pdf.absolute_x_middle.should eql(0.5)
+      pdf.absolute_y_middle.should eql(0.5)
+    end
+  end
+
+  specify "should return correct body dimensions when scaled" do
+    pdf = PDF::Wrapper.new(:paper => :A4, :margin_top => 10, :margin_right => 10, :margin_bottom => 10, :margin_left => 10)
+
+    # scale so the dimensions of the body are 1,1
+    pdf.scale(595.28 - 20, 841.89 - 20) do
+      pdf.body_width.should eql(1.0)
+      pdf.body_height.should eql(1.0)
+      pdf.body_x_middle.should eql(0.5)
+      pdf.body_y_middle.should eql(0.5)
+    end
+  end
+
+  specify "should correctly convert a user x co-ordinate to device" do
+    pdf = PDF::Wrapper.new(:paper => :A4, :margin_left => 40)
+
+    pdf.user_x_to_device_x(10).should eql(10.0)
+
+    # translate so that 0,0 is at the page body corner
+    pdf.translate(pdf.margin_left, pdf.margin_top) do
+      # a user x co-ord of 10 is now equal to a device co-ord of 50
+      pdf.user_x_to_device_x(10).should eql(50.0)
+    end
+
+    # scale so the dimensions of the page are 1,1
+    pdf.scale(pdf.page_width, pdf.page_height) do
+      pdf.user_x_to_device_x(0.5).should eql(595.28/2)
+    end
+  end
+
+  specify "should correctly convert a user y co-ordinate to device" do
+    pdf = PDF::Wrapper.new(:paper => :A4, :margin_top => 40)
+
+    pdf.user_y_to_device_y(10).should eql(10.0)
+
+    # translate so that 0,0 is at the page body corner
+    pdf.translate(pdf.margin_left, pdf.margin_top) do
+      # a user y co-ord of 10 is now equal to a device co-ord of 50
+      pdf.user_y_to_device_y(10).should eql(50.0)
+    end
+
+    # scale so the dimensions of the page are 1,1
+    pdf.scale(pdf.page_width, pdf.page_height) do
+      pdf.user_y_to_device_y(0.5).should eql(841.89/2)
+    end
+  end
+
+  specify "should correctly convert a device x co-ordinate to user" do
+    pdf = PDF::Wrapper.new(:paper => :A4, :margin_left => 40)
+
+    pdf.device_x_to_user_x(10).should eql(10.0)
+
+    # translate so that 0,0 is at the page body corner
+    pdf.translate(pdf.margin_left, pdf.margin_top) do
+      pdf.device_x_to_user_x(50).should eql(10.0)
+    end
+
+    # scale so the dimensions of the page are 1,1
+    pdf.scale(pdf.page_width, pdf.page_height) do
+      pdf.device_x_to_user_x(595.28/2).should eql(0.5)
+    end
+  end
+
+  specify "should correctly convert a device y co-ordinate to user" do
+    pdf = PDF::Wrapper.new(:paper => :A4, :margin_top => 40)
+
+    pdf.device_y_to_user_y(10).should eql(10.0)
+
+    # translate so that 0,0 is at the page body corner
+    pdf.translate(pdf.margin_left, pdf.margin_top) do
+      pdf.device_y_to_user_y(50).should eql(10.0)
+    end
+
+    # scale so the dimensions of the page are 1,1
+    pdf.scale(pdf.page_width, pdf.page_height) do
+      pdf.device_y_to_user_y(841.89/2).should eql(0.5)
+    end
+  end
+
+  specify "should correctly convert a user distance to distance" do
+    pdf = PDF::Wrapper.new(:paper => :A4, :margin_top => 40)
+
+    pdf.user_to_device_dist(10,0).should eql([10.0,0.0])
+    pdf.user_to_device_dist(0,10).should eql([0.0,10.0])
+
+    # translate so that 0,0 is at the page body corner
+    pdf.translate(pdf.margin_left, pdf.margin_top) do
+      pdf.user_to_device_dist(10,0).should eql([10.0,0.0])
+      pdf.user_to_device_dist(0,10).should eql([0.0,10.0])
+    end
+
+    # scale so the dimensions of the page are 1,1
+    pdf.scale(pdf.page_width, pdf.page_height) do
+      pdf.user_to_device_dist(0.5,0).should eql([595.28/2,0.0])
+      pdf.user_to_device_dist(0,0.5).should eql([0.0,841.89/2])
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pdf-wrapper
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors: 
 - James Healy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-30 00:00:00 +10:00
+date: 2008-05-28 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -26,16 +26,25 @@ extra_rdoc_files:
 files: 
 - examples/cell.rb
 - examples/image.rb
+- examples/markup.rb
 - examples/repeating.rb
+- examples/scaled.rb
+- examples/scaled_cells.rb
+- examples/scaled_image.rb
 - examples/shapes.rb
 - examples/table.rb
+- examples/translate.rb
 - examples/utf8-long.rb
 - examples/utf8.rb
-- examples/template.rb
-- examples/padded_image.rb
 - lib/pdf
 - lib/pdf/core.rb
 - lib/pdf/wrapper.rb
+- lib/pdf/wrapper
+- lib/pdf/wrapper/graphics.rb
+- lib/pdf/wrapper/images.rb
+- lib/pdf/wrapper/loading.rb
+- lib/pdf/wrapper/table.rb
+- lib/pdf/wrapper/text.rb
 - specs/data
 - specs/data/google.png
 - specs/data/iso-2022-jp.txt
@@ -46,13 +55,15 @@ files:
 - specs/data/utf8-long.pdf
 - specs/data/utf8-long.txt
 - specs/data/utf8.txt
+- specs/data/windmill.jpg
 - specs/data/zits.gif
-- specs/wrapper_spec.rb
+- specs/graphics_spec.rb
+- specs/image_spec.rb
 - specs/load_spec.rb
-- specs/shapes_spec.rb
-- specs/text_spec.rb
 - specs/spec_helper.rb
-- specs/image_spec.rb
+- specs/tables_spec.rb
+- specs/text_spec.rb
+- specs/wrapper_spec.rb
 - Rakefile
 - README
 - CHANGELOG
@@ -83,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: pdf-wrapper
-rubygems_version: 1.0.1
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: A PDF generating library built on top of cairo