pdf-wrapper 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,9 +1,17 @@
-v0.0.3 (xxx)
+v0.0.4 (12th March 2008)
+- added support for custom line widths on primitive drawing shapes (circles,
+  lines, etc). Thanks Paweł Kondzior
+- fixed a bug where the first line of text in a multi-line cell appeared at the
+  current cursor location instead of inside the cell. Thanks Paweł Kondzior
+- bumped dependency on PDF::Reader for running specs to 0.6.1
+
+v0.0.3 (17th January 2008)
 - added support for repeating elements (like page numbers) via repeating_element
 - Ensured consistent behaviour WRT functions moving the internal cursor 
-  - functions that require positioning info (cell, shapes, etc) will not move the cursor at all
-  - functions where positioning info in optional (text, image, etc), the cursor will be moved to the bottom left
-    corner of the object
+  - functions that require positioning info (cell, shapes, etc) will not move
+    the cursor at all
+  - functions where positioning info in optional (text, image, etc), the cursor
+    will be moved to the bottom left corner of the object
 - Ensure no unrecognised options are provided to various functions
 - Add support for padding between a cell border and its text
 - added support for scaling images proportionally

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/testtask'
 require "rake/gempackagetask"
 require 'spec/rake/spectask'
 
-PKG_VERSION = "0.0.3"
+PKG_VERSION = "0.0.4"
 PKG_NAME = "pdf-wrapper"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 

data/lib/pdf/wrapper.rb

@@ -123,6 +123,7 @@ module PDF
 
       # set a default drawing colour and font style
       default_color(:black)
+      default_line_width(2.0)
       default_font("Sans Serif")
       default_font_size(16)
 
@@ -246,6 +247,15 @@ module PDF
     alias default_color= default_color
     alias stroke_color default_color    # PDF::Writer compatibility
 
+    # change the default line width used to draw stroke on the canvas
+    #
+    # Parameters:
+    # <tt>f</tt>:: float value of stroke width from 0.01 to 255
+    def default_line_width(f)
+      @default_line_width = f
+    end
+    alias default_line_width= default_line_width
+
     # add text to the page, bounded by a box with dimensions HxW, with it's top left corner
     # at x,y. Any text that doesn't fit it the box will be silently dropped.
     #
@@ -256,7 +266,7 @@ module PDF
     # <tt>:border_width</tt>::  How wide should the border be?
     # <tt>:border_color</tt>::  What color should the border be?
     # <tt>:bgcolor</tt>::  A background color for the cell. Defaults to none.
-    # <tt>:padding</tt>::  The number of points to leave between the inside of the border and text. Defaults to 3. 
+    # <tt>:padding</tt>::  The number of points to leave between the inside of the border and text. Defaults to 3.
     def cell(str, x, y, w, h, opts={})
       # TODO: add support for pango markup (see http://ruby-gnome2.sourceforge.jp/hiki.cgi?pango-markup)
       # TODO: add a wrap option so wrapping can be disabled
@@ -302,9 +312,10 @@ module PDF
     end
 
     # draws a basic table onto the page
-    # data   - a 2d array with the data for the columns. The first row will be treated as the headings
     #
-    # In addition to the standard text style options (see the documentation for text()), cell() supports
+    # <tt>data</tt>:: a 2d array with the data for the columns. The first row will be treated as the headings
+    #
+    # In addition to the standard text style options (see the documentation for text), table supports
     # the following options:
     #
     # <tt>:left</tt>::   The x co-ordinate of the left-hand side of the table. Defaults to the left margin
@@ -422,13 +433,15 @@ module PDF
     #
     # Options:
     # <tt>:color</tt>::   The colour of the circle outline
+    # <tt>:line_width</tt>::   The width of outline. Defaults to 2.0
     # <tt>:fill_color</tt>::   The colour to fill the circle with. Defaults to nil (no fill)
     def circle(x, y, r, opts = {})
       options = {:color => @default_color,
+                 :line_width => @default_line_width,
                  :fill_color => nil
                  }
       options.merge!(opts)
-      options.assert_valid_keys(:color, :fill_color)
+      options.assert_valid_keys(:color, :line_width, :fill_color)
 
       # save the cursor position so we can restore it at the end
       origx, origy = current_point
@@ -442,6 +455,7 @@ module PDF
       end
 
       set_color(options[:color])
+      @context.set_line_width(options[:line_width])
       @context.circle(x, y, r).stroke
 
       # restore the cursor position
@@ -452,16 +466,17 @@ module PDF
     #
     # Options:
     # <tt>:color</tt>::   The colour of the line
+    # <tt>:line_width</tt>::   The width of line. Defaults its 2.0
     def line(x0, y0, x1, y1, opts = {})
-      options = {:color => @default_color }
+      options = {:color => @default_color, :line_width => @default_line_width }
       options.merge!(opts)
-      options.assert_valid_keys(:color)
+      options.assert_valid_keys(:color, :line_width)
 
       # save the cursor position so we can restore it at the end
       origx, origy = current_point
 
       set_color(options[:color])
-
+      @context.set_line_width(options[:line_width])
       move_to(x0,y0)
       @context.line_to(x1,y1).stroke
 
@@ -478,13 +493,15 @@ module PDF
     #
     # Options:
     # <tt>:color</tt>::   The colour of the rectangle outline
+    # <tt>:line_width</tt>::   The width of outline. Defaults to 2.0
     # <tt>:fill_color</tt>::   The colour to fill the rectangle with. Defaults to nil (no fill)
     def rectangle(x, y, w, h, opts = {})
       options = {:color => @default_color,
+                 :line_width => @default_line_width,
                  :fill_color => nil
                  }
       options.merge!(opts)
-      options.assert_valid_keys(:color, :fill_color)
+      options.assert_valid_keys(:color, :line_width, :fill_color)
 
       # save the cursor position so we can restore it at the end
       origx, origy = current_point
@@ -496,6 +513,7 @@ module PDF
       end
 
       set_color(options[:color])
+      @context.set_line_width(options[:line_width])
       @context.rectangle(x, y, w, h).stroke
 
       # restore the cursor position
@@ -512,13 +530,15 @@ module PDF
     #
     # Options:
     # <tt>:color</tt>::   The colour of the rectangle outline
+    # <tt>:line_width</tt>::   The width of outline. Defaults to 2.0
     # <tt>:fill_color</tt>::   The colour to fill the rectangle with. Defaults to nil (no fill)
     def rounded_rectangle(x, y, w, h, r, opts = {})
       options = {:color => @default_color,
+                 :line_width => @default_line_width,
                  :fill_color => nil
                  }
       options.merge!(opts)
-      options.assert_valid_keys(:color, :fill_color)
+      options.assert_valid_keys(:color, :fill_color, :line_width)
 
       raise ArgumentError, "Argument r must be less than both w and h arguments" if r >= w || r >= h
 
@@ -532,6 +552,7 @@ module PDF
       end
 
       set_color(options[:color])
+      @context.set_line_width(options[:line_width])
       @context.rounded_rectangle(x, y, w, h, r).stroke
 
       # restore the cursor position
@@ -958,7 +979,7 @@ module PDF
     # distributed with rcairo - it's still black magic to me and has a few edge
     # cases where it doesn't work too well. Needs to be improved.
     def render_layout(layout, x, y, h, opts = {})
-      # we can't use content.show_pango_layout, as that won't start
+      # we can't use context.show_pango_layout, as that won't start
       # a new page if the layout hits the bottom margin. Instead,
       # we iterate over each line of text in the layout and add it to
       # the canvas, page breaking as necessary
@@ -972,14 +993,9 @@ module PDF
 
       # for each line in the layout
       layout.lines.each do |line|
-
-        # draw the line on the canvas
-        @context.show_pango_layout_line(line)
-
         #calculate where the next line starts
         ink_rect, logical_rect = line.extents
         y = y + (logical_rect.height / Pango::SCALE * (3.0/4.0)) + 1
-
         if y >= (orig_y + h)
           # our text is using the maximum amount of vertical space we want it to
           if options[:auto_new_page]
@@ -996,6 +1012,8 @@ module PDF
 
         # move to the start of the next line
         move_to(x, y)
+        # draw the line on the canvas
+        @context.show_pango_layout_line(line)
       end
 
       # return the y co-ord we finished on

data/specs/wrapper_spec.rb

@@ -5,6 +5,9 @@ $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 require 'pdf/wrapper'
 require 'tempfile'
 require 'rubygems'
+
+gem "pdf-reader", ">=0.6.1"
+
 require 'pdf/reader'
 
 # make some private methods of PDF::Wrapper public for testing
@@ -140,6 +143,31 @@ context "The PDF::Wrapper class" do
     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.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.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
@@ -213,6 +241,25 @@ context "The PDF::Wrapper class" do
     receiver.first_occurance_of(:append_line)[:args].should eql([x1.to_f, y1.to_f])
   end
 
+  specify "should be able to draw a single line onto the canvas with a width of 5" do
+    x0 = y0 = 100
+    x1 = y1 = 200
+    width = 5
+    pdf = PDF::Wrapper.new
+    pdf.line(x0,y0,x1,y1, :line_width => width)
+
+    receiver = PDF::Reader::RegisterReceiver.new
+    reader = PDF::Reader.string(pdf.render, receiver)
+
+    # the begin_new_subpath command specifies the start of the line, append line specifies the end
+    receiver.count(:set_line_width).should eql(1)
+    receiver.count(:begin_new_subpath).should eql(1)
+    receiver.count(:append_line).should eql(1)
+    receiver.first_occurance_of(:set_line_width)[:args].should eql([width.to_f])
+    receiver.first_occurance_of(:begin_new_subpath)[:args].should eql([x0.to_f, y0.to_f])
+    receiver.first_occurance_of(:append_line)[:args].should eql([x1.to_f, y1.to_f])
+  end
+
   specify "should be able to draw an empty rectangle onto the canvas" do
     x = y = 100
     w = h = 200
@@ -230,6 +277,28 @@ context "The PDF::Wrapper class" do
     callbacks.shift[:args].should eql([x.to_f, (y+h).to_f])
   end
 
+  specify "should be able to draw an empty rectangle onto the canvas with a line width of 5" do
+    x = y = 100
+    w = h = 200
+    width = 5
+    pdf = PDF::Wrapper.new
+    pdf.rectangle(x,y,w,h, :line_width => width)
+
+    receiver = PDF::Reader::RegisterReceiver.new
+    reader = PDF::Reader.string(pdf.render, receiver)
+
+    # ensure the line width was set correctly
+    receiver.count(:set_line_width).should eql(1)
+    receiver.first_occurance_of(:set_line_width)[:args].should eql([width.to_f])
+
+    # the begin_new_subpath command specifies the start of the line, append line specifies the end
+    callbacks = receiver.series(:begin_new_subpath, :append_line,:append_line,:append_line, :close_subpath)
+    callbacks.shift[:args].should eql([x.to_f, y.to_f])
+    callbacks.shift[:args].should eql([(x+w).to_f, y.to_f])
+    callbacks.shift[:args].should eql([(x+w).to_f, (y+h).to_f])
+    callbacks.shift[:args].should eql([x.to_f, (y+h).to_f])
+  end
+
   specify "should leave the cursor in the bottom left of a layout when new text is added" do
     pdf = PDF::Wrapper.new
     x, y = pdf.current_point
@@ -275,6 +344,23 @@ context "The PDF::Wrapper class" do
   end
 =end
 
+  specify "should be able to draw an empty rounded rectangle onto the canvas with a line width of 5"
+=begin
+  do
+    x = y = 100
+    w = h = 200
+    r = 5
+    w = 5
+    pdf = PDF::Wrapper.new
+    pdf.rounded_rectangle(x,y,w,h,r, :line_width => w)
+
+    receiver = PDF::Reader::RegisterReceiver.new
+    reader = PDF::Reader.string(pdf.render, receiver)
+
+    # TODO: test for the appropriate pattern of callbacks
+  end
+=end
+
   specify "should be able to draw a filled rounded rectangle onto the canvas"
 =begin
   do
@@ -307,14 +393,15 @@ context "The PDF::Wrapper class" do
   end
 =end
 
-  specify "should be able to draw a filled circle onto the canvas"
+  specify "should be able to draw an empty circle onto the canvas with a line width of 5"
 =begin
   do
     x = 100
     y = 200
     r = 5
+    w = 5
     pdf = PDF::Wrapper.new
-    pdf.circle(x,y,r, :fill_color => :red)
+    pdf.circle(x,y,r, :line_width => w)
 
     receiver = PDF::Reader::RegisterReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
@@ -323,9 +410,23 @@ context "The PDF::Wrapper class" do
   end
 =end
 
-  specify "should be able to add ascii text to the canvas"
+  specify "should be able to draw a filled circle onto the canvas"
 =begin
   do
+    x = 100
+    y = 200
+    r = 5
+    pdf = PDF::Wrapper.new
+    pdf.circle(x,y,r, :fill_color => :red)
+
+    receiver = PDF::Reader::RegisterReceiver.new
+    reader = PDF::Reader.string(pdf.render, receiver)
+
+    # TODO: test for the appropriate pattern of callbacks
+  end
+=end
+
+  specify "should be able to add ascii text to the canvas" do
     msg = "Chunky Bacon"
     pdf = PDF::Wrapper.new
     pdf.text msg
@@ -333,14 +434,11 @@ context "The PDF::Wrapper class" do
     receiver = PageTextReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
 
-    # TODO: test for the appropriate text on the page. Need to fix unicode spport in pdf-reader first
-    #puts receiver.content.inspect
+    # TODO: test for the text is in the appropriate location on the page
+    receiver.content.first.should eql(msg)
   end
-=end
 
-  specify "should be able to add unicode text to the canvas"
-=begin
-  do
+  specify "should be able to add unicode text to the canvas" do
     msg = "メインページ"
     pdf = PDF::Wrapper.new
     pdf.text msg
@@ -348,25 +446,47 @@ context "The PDF::Wrapper class" do
     receiver = PageTextReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
 
-    # TODO: test for the appropriate text on the page. Need to fix unicode spport in pdf-reader first
-    #puts receiver.content.inspect
+    # TODO: test for the text is in the appropriate location on the page
+    receiver.content.first.should eql(msg)
   end
-=end
 
-  specify "should be able to add text to the canvas in a bounding box using the cell method"
-=begin
-  do
+  specify "should be able to add text to the canvas in a bounding box using the cell method" do
     msg = "メインページ"
     pdf = PDF::Wrapper.new
-    pdf.text msg
+    pdf.cell msg, 100, 100, 200, 200
 
     receiver = PageTextReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
 
-    # TODO: test for the appropriate text on the page. Need to fix unicode spport in pdf-reader first
-    #puts receiver.content.inspect
+    # TODO: test for the text is in the appropriate location on the page
+    receiver.content.first.should eql(msg)
+  end
+
+  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
+
+    receiver = PDF::Reader::RegisterReceiver.new
+    reader = PDF::Reader.string(pdf.render, receiver)
+
+    receiver.all(:set_text_matrix_and_text_line_matrix).each do |cb|
+      # horizontal location
+      # TODO: we're only testing the it doesn't start past the right boundary of the cell
+      #       should also test that it doesn't start in the cell but overrun it
+      (cb[:args][4] >= x).should     be_true
+      (cb[:args][4] <= x + w).should be_true
+
+      # 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
+      (cb[:args][5] <= cell_top_bound).should     be_true
+      (cb[:args][5] >= cell_top_bound - h).should be_true
+    end
   end
-=end
 
   specify "should be able to render to a file" do
     # generate a PDF
@@ -456,7 +576,125 @@ context "The PDF::Wrapper class" do
     lambda { pdf.validate_color([1000, 255, 0])}.should raise_error(ArgumentError)
   end
 
-  specify "should be able to add repeating elements to various pages (:all, :odd, :even, :range, int)"
+  specify "should be able to add repeating elements to :all pages" do
+    test_str = "repeating"
+
+    pdf = PDF::Wrapper.new
+    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)
+    receiver.content[2].should eql(test_str)
+    receiver.content[3].should eql(test_str)
+  end
+
+  specify "should be able to add repeating elements to :odd pages" do
+    test_str = "repeating"
+
+    pdf = PDF::Wrapper.new
+    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("")
+    receiver.content[2].should eql(test_str)
+    receiver.content[3].should eql("")
+  end
+
+  specify "should be able to add repeating elements to :even pages" do
+    test_str = "repeating"
+
+    pdf = PDF::Wrapper.new
+    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)
+    receiver.content[2].should eql("")
+    receiver.content[3].should eql(test_str)
+  end
+
+  specify "should be able to add repeating elements to a range of pages" do
+    test_str = "repeating"
+
+    pdf = PDF::Wrapper.new
+    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)
+    receiver.content[2].should eql(test_str)
+    receiver.content[3].should eql("")
+  end
+
+  specify "should be able to add repeating elements to a single page" do
+    test_str = "repeating"
+
+    pdf = PDF::Wrapper.new
+    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)
+    receiver.content[2].should eql("")
+    receiver.content[3].should eql("")
+  end
+
+  specify "should be able to add repeating elements to an array of pages" do
+    test_str = "repeating"
+
+    pdf = PDF::Wrapper.new
+    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("")
+    receiver.content[2].should eql(test_str)
+    receiver.content[3].should eql(test_str)
+  end
 
   specify "should not change the state of the cairo canvas or PDF::Writer defaults (fonts, colors, etc) when adding repeating elements"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pdf-wrapper
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - James Healy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-17 00:00:00 +11:00
+date: 2008-03-12 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -35,8 +35,8 @@ files:
 - lib/pdf/wrapper.rb
 - lib/pdf/core.rb
 - specs/data
-- specs/data/google.png
 - specs/data/shift_jis.txt
+- specs/data/google.png
 - specs/data/utf8-long.txt
 - specs/data/iso-2022-jp.txt
 - specs/data/utf8.txt