pdf-wrapper 0.0.6 → 0.0.7

data/CHANGELOG

@@ -1,4 +1,9 @@
-v0.0.6 (28th April 2008)w
+v0.0.7 (30th April 2008)
+- Added support for creating new pages from a template file (pdf/png/jpg/gif/svg/probably more)
+- Convert the params to start_new_page to be an options hash
+- Added a :padding option to PDF::Wrapper#image
+
+v0.0.6 (28th April 2008)
 - Fix a nasty bug in text layout code
 
 v0.0.5 (27th April 2008)

data/Rakefile

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

data/examples/padded_image.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+
+require 'pdf/wrapper'
+
+pdf = PDF::Wrapper.new(:paper => :A4)
+pdf.rectangle(100, 100, 200, 200)
+pdf.image(File.dirname(__FILE__) + "/../specs/data/zits.gif", :left => 100, :top => 100, :width => 200, :height => 200, :padding => 25, :proportional => true)
+
+pdf.render_to_file("image.pdf")

data/examples/template.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+
+require 'pdf/wrapper'
+
+pdf = PDF::Wrapper.new(:paper => :A4)
+pdf.default_font("Sans Serif")
+pdf.default_color(:black)
+pdf.text "James", :font => "Monospace", :font_size => 8, :alignment => :left
+#pdf.start_new_page()
+pdf.render_to_file("template.pdf")

data/lib/pdf/wrapper.rb

@@ -87,6 +87,9 @@ module PDF
     # <tt>:margin_bottom</tt>::   The size of the default bottom margin (default 5% of page)
     # <tt>:margin_left</tt>::   The size of the default left margin (default 5% of page)
     # <tt>:margin_right</tt>::   The size of the default right margin (default 5% of page)
+    # <tt>:template</tt>::  The path to an image file. If specified, the first page of the document will use the specified image as a template. 
+    #                       The page will be sized to match the template size. The use templates on subsequent pages, see the options for
+    #                       start_new_page.
     def initialize(opts={})
 
       # ensure we have recentish cairo bindings
@@ -99,7 +102,7 @@ module PDF
       options.merge!(opts)
 
       # test for invalid options
-      options.assert_valid_keys(:paper, :orientation, :background_color, :margin_left, :margin_right, :margin_top, :margin_bottom)
+      options.assert_valid_keys(:paper, :orientation, :background_color, :margin_left, :margin_right, :margin_top, :margin_bottom, :template)
       options[:paper] = options[:paper].to_sym
       raise ArgumentError, "Invalid paper option" unless PAGE_SIZES.include?(options[:paper])
 
@@ -139,6 +142,13 @@ module PDF
       @page = 1
       @repeating = []
 
+      # build the first page from a template if required
+      if opts[:template]
+        w, h = image_dimensions(opts[:template])
+        @surface.set_size(w, h)
+        image(opts[:template], :left => 0, :top => 0)
+      end
+
       # move the cursor to the top left of the usable canvas
       reset_cursor
     end
@@ -503,8 +513,8 @@ module PDF
       move_to(origx, origy)
     end
 
-    # Adds a cubic Bezier spline to the path from the  (x0, y0) to position (x3, y3) 
-    # in user-space coordinates, using (x1, y1) and (x2, y2) as the control points. 
+    # Adds a cubic Bezier spline to the path from the  (x0, y0) to position (x3, y3)
+    # in user-space coordinates, using (x1, y1) and (x2, y2) as the control points.
     # Options:
     # <tt>:color</tt>::   The colour of the line
     # <tt>:line_width</tt>::   The width of line. Defaults to 2.0
@@ -522,7 +532,7 @@ module PDF
       # restore the cursor position
       move_to(origx, origy)
     end
-  
+
 
     # draw a rectangle starting at x,y with w,h dimensions.
     # Parameters:
@@ -614,17 +624,22 @@ module PDF
     # <tt>:height</tt>::   The height of the image
     # <tt>:width</tt>::    The width of the image
     # <tt>:proportional</tt>::   Boolean. Maintain image proportions when scaling. Defaults to false.
+    # <tt>:padding</tt>::    Add some padding between the image and the specified box.
     #
     # left and top default to the current cursor location
     # width and height default to the size of the imported image
+    # padding defaults to 0
     def image(filename, opts = {})
       # TODO: add some options for justification and padding
-      # TODO: add a seperate method for adding arbitary pages from a PDF file to this one. Good for
-      #       templating, etc. Save a letterhead as a PDF file, then open it and add it to the page
-      #       as a starting point. Until we call start_new_page, we can add stuff over the top of the
-      #       imported content
       raise ArgumentError, "file #{filename} not found" unless File.file?(filename)
-      opts.assert_valid_keys(default_positioning_options.keys + [:proportional])
+      opts.assert_valid_keys(default_positioning_options.keys + [:padding, :proportional])
+
+      if opts[:padding]
+        opts[:left]   += opts[:padding].to_i if opts[:left]
+        opts[:top]    += opts[:padding].to_i if opts[:top]
+        opts[:width]  -= opts[:padding].to_i * 2 if opts[:width]
+        opts[:height] -= opts[:padding].to_i * 2 if opts[:height]
+      end
 
       case detect_image_type(filename)
       when :pdf   then draw_pdf filename, opts
@@ -712,14 +727,25 @@ module PDF
 
     # move to the next page
     #
-    # arguments:
-    # <tt>pageno</tt>::    If specified, the current page number will be set to that. By default, the page number will just increment.
-    def start_new_page(pageno = nil)
+    # options:
+    # <tt>:pageno</tt>::    If specified, the current page number will be set to that. By default, the page number will just increment.
+    # <tt>:template</tt>::  The path to an image file. If specified, the new page will use the specified image as a template. The page will be sized to match the template size
+    def start_new_page(opts = {})
+      opts.assert_valid_keys(:pageno, :template)
+
       @context.show_page
 
+      if opts[:template]
+        w, h = image_dimensions(opts[:template])
+        @surface.set_size(w, h)
+        image(opts[:template], :left => 0, :top => 0)
+      else
+        @surface.set_size(@page_width, @page_height)
+      end
+
       # reset or increment the page counter
-      if pageno
-        @page = pageno.to_i
+      if opts[:pageno]
+        @page = opts[:pageno].to_i
       else
         @page += 1
       end
@@ -977,6 +1003,32 @@ module PDF
       return y + row_height
     end
 
+    def image_dimensions(filename)
+      raise ArgumentError, "file #{filename} not found" unless File.file?(filename)
+
+      case detect_image_type(filename)
+      when :pdf   then
+        load_libpoppler
+        page = Poppler::Document.new(filename).get_page(1)
+        return page.size
+      when :png   then
+        img_surface = Cairo::ImageSurface.from_png(filename)
+        return img_surface.width, img_surface.height
+      when :svg   then
+        load_librsvg
+        handle = RSVG::Handle.new_from_file(filename)
+        return handle.width, handle.height
+      else
+        load_libpixbuf
+        begin
+          pixbuf = Gdk::Pixbuf.new(filename)
+          return pixbuf.width, pixbuf.height
+        rescue Gdk::PixbufError
+          raise ArgumentError, "Unrecognised image format (#{filename})"
+        end
+      end
+    end
+
     # load libpango if it isn't already loaded.
     # This will add some methods to the cairo Context class in addition to providing
     # its own classes and constants. A small amount of documentation is available at
@@ -1038,9 +1090,9 @@ module PDF
 
       offset = 0
       baseline = 0
-      
+
       iter = layout.iter
-      loop do 
+      loop do
         line = iter.line
         ink_rect, logical_rect = iter.line_extents
         if y + (baseline - offset) >= (y + h)
@@ -1065,7 +1117,7 @@ module PDF
         @context.show_pango_layout_line(line)
 
         break unless iter.next_line!
-      end 
+      end
 
       # return the y co-ord we finished on
       return y + baseline - offset

data/specs/image_spec.rb

@@ -12,11 +12,22 @@ context "The PDF::Wrapper class" do
     pdf.detect_image_type(File.dirname(__FILE__) + "/data/shipsail.jpg").should eql(:jpg)
   end
 
-  specify "should be able to calculate image dimensions correctly" do
+  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])
+  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])
   end
+
+  specify "should be able to draw an image with padding correctly"
 end

data/specs/spec_helper.rb

@@ -14,20 +14,21 @@ require 'pdf/reader'
 class PDF::Wrapper
   public :build_pango_layout
   public :calc_image_dimensions
-  public :load_librsvg
-  public :load_libpixbuf
-  public :load_libpango
-  public :load_libpoppler
   public :default_text_options
   public :detect_image_type
   public :draw_pdf
   public :draw_pixbuf
   public :draw_png
   public :draw_svg
+  public :image_dimensions
+  public :load_librsvg
+  public :load_libpixbuf
+  public :load_libpango
+  public :load_libpoppler
   public :validate_color
 end
 
-# a helper class for couting the number of pages in a PDF
+# a helper class for counting the number of pages in a PDF
 class PageReceiver
   attr_accessor :page_count
 
@@ -41,6 +42,20 @@ class PageReceiver
   end
 end
 
+# a helper class for recording the dimensions of pages in a PDF
+class PageSizeReceiver
+  attr_accessor :pages
+
+  def initialize
+    @pages = []
+  end
+
+  # Called when page parsing ends
+  def begin_page(args)
+    pages << args["MediaBox"] || args[:MediaBox]
+  end
+end
+
 class PageTextReceiver
   attr_accessor :content
 

data/specs/wrapper_spec.rb

@@ -399,7 +399,7 @@ context "The PDF::Wrapper class" do
     pdf.page.should eql(1)
     pdf.start_new_page
     pdf.page.should eql(2)
-    pdf.start_new_page(50)
+    pdf.start_new_page(:pageno => 50)
     pdf.page.should eql(50)
   end
 
@@ -414,7 +414,30 @@ context "The PDF::Wrapper class" do
     lambda { pdf.circle(100,100,100, :ponies => true)}.should raise_error(ArgumentError)
     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)
+
+    receiver.pages[0].should eql([0.0, 0.0, 734.0, 772.0])
+    receiver.pages[1].should eql([0.0, 0.0, 595.28, 841.89])
+  end
+
+  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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pdf-wrapper
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - James Healy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-28 00:00:00 +10:00
+date: 2008-04-30 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +31,8 @@ files:
 - examples/table.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