pdf-wrapper 0.1.0 → 0.1.3

data/CHANGELOG

@@ -1,3 +1,18 @@
+v0.1.3 (24th July 2008)
+- Require the gem version of cairo
+  - >= 1.5. However I recommend >= 1.6.3 to avoid FATAL error under 1.8.7
+- Removed Wrapper#scale. Was causing more trouble than it's worth. May re-implement later.
+- Allow the render functions to be called multiple times
+- Added Wrapper#finished?
+- rename Wrapper#render_to_file to Wrapper#render_file.
+  - old method still exists with a deprecation warning
+- add :rotate option to Wrapper#image (thanks Lourens Naudé)
+- borrowed some convenience methods for co-ordinate manipulation from Prawn
+- Wrapper#translate now resets the point to 0,0 before yielding
+
+v0.1.1 (Unreleased)
+- use a proxy object when building repeating objects to prevent a new page being started
+
 v0.1.0 (28th May 2008)
 - added PDF::Wrapper#translate and PDF::Wrapper#scale
 - fixed a bug that caused some text to be rendered off the page when wrapping onto 3rd and 

data/{README → README.rdoc}

@@ -1,27 +1,30 @@
 = Overview
 
 PDF::Wrapper is a PDF generation library that uses the cairo and pango
-libraries to do the heavy lifting. I've essentially just wrapped these general
-purpose graphics libraries with some sugar that makes them a little easier to
-use for making PDFs. The idea is to lever the low level tools in those libraries
-(drawing shapes, laying out text, importing raster images, etc) to build some
-higher level tools - tables, text boxes, borders, lists, repeating elements
-(headers/footers), etc.
-
-The API started off *roughly* following that of PDF::Writer, but i've made 
-tweaks and changes along the way and it's diverging. This is a work in progress
-so many features of PDF::Writer aren't available yet.
+native libraries to do the heavy lifting. It essentially just wraps these
+general purpose graphics libraries with some sugar that makes them a little
+easier to use for making PDFs. The idea is to lever the low level tools in
+those libraries (drawing shapes, laying out text, importing raster images, etc)
+to build some higher level tools - tables, text boxes, borders, lists,
+repeating elements (headers/footers), etc.
+
+The API started off *roughly* following that of PDF::Writer, but it has since
+diverged significantly. I've spent some time contributing to a pure Ruby PDF
+generation library (Prawn[http://github.com/sandal/prawn/tree]) and its elegant
+and simple API is having a strong effect on the direction I've been taking
+PDF::Wrapper.
 
 A key motivation for writing this library is cairo's support for Unicode in PDFs.
-All text functions in this library support UTF-8 input, although as a native 
-English speaker I've only tested this a little, so any feedback is welcome. 
+All text functions in this library require UTF-8 input, although as a native
+English speaker I've only tested non ASCII text a little, so any feedback is
+welcome.
 
-There also seems to be a lack of English documentation available for the ruby 
+There also seems to be a lack of English documentation available for the ruby
 bindings to cairo/pango, so I'm aiming to document the code as much as possible
 to provide worked examples for others. I'm learning as I go though, so if regular
 users of either library spot techniques that fail best practice, please let me know.
 
-It's early days, so the API is far from stable and I'm hesitant to write extensive 
+It's early days, so the API is far from stable and I'm hesitant to write extensive
 documentation just yet. It's the price you pay for being an early adopter. The
 examples/ dir should have a range of sample code, and I'll try to keep it up to
 date.
@@ -44,7 +47,7 @@ James Healy <jimmy@deefa.com>
 
 * GPL version 2 or the Ruby License
 * Ruby: http://www.ruby-lang.org/en/LICENSE.txt
- 
+
 = Dependencies
 
 * ruby/cairo[http://cairographics.org/rcairo/]
@@ -65,7 +68,9 @@ of the cairo source available on your system.
 
 = Compatibility
 
-JRuby users, you're probably out of luck. 
+JRuby users, you're currently out of luck. In theory it should be possible to use the Java bindings
+to the native libraries we need, but as I'm not a JRuby user, it's not an itch
+I've been motivated to scratch.
 
 Rubinius users, I have no idea.
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/testtask'
 require "rake/gempackagetask"
 require 'spec/rake/spectask'
 
-PKG_VERSION = "0.1.0"
+PKG_VERSION = "0.1.3"
 PKG_NAME = "pdf-wrapper"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
@@ -18,6 +18,7 @@ desc "Run all rspec files"
 Spec::Rake::SpecTask.new("spec") do |t|
   # spec files listed explicitly so that load_spec is the first one run
   t.spec_files = ['specs/load_spec.rb','specs/image_spec.rb','specs/graphics_spec.rb','specs/tables_spec.rb','specs/text_spec.rb','specs/wrapper_spec.rb']
+  t.spec_opts = ['-c']
   t.rcov = true
   t.rcov_dir = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + "/rcov"
   t.rcov_opts = ["--exclude","spec.*\.rb","--exclude",".*cairo.*","--exclude",".*rcov.*","--exclude",".*rspec.*","--exclude",".*pdf-reader.*", "--exclude",".*gems.*"]
@@ -45,7 +46,7 @@ desc "Create documentation"
 Rake::RDocTask.new("doc") do |rdoc|
   rdoc.title = "pdf-wrapper"
   rdoc.rdoc_dir = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/rdoc'
-  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('CHANGELOG')
   rdoc.rdoc_files.include('TODO')
   rdoc.rdoc_files.include('lib/**/*.rb')
@@ -67,8 +68,9 @@ spec = Gem::Specification.new do |spec|
   spec.files =  Dir.glob("{examples,lib,specs}/**/**/*") + ["Rakefile"]
   spec.require_path = "lib"
   spec.has_rdoc = true
-  spec.extra_rdoc_files = %w{README CHANGELOG TODO}
-  spec.rdoc_options << '--title' << 'PDF::Wrapper Documentation' << '--main'  << 'README' << '-q'
+  spec.extra_rdoc_files = %w{README.rdoc CHANGELOG TODO}
+  spec.rdoc_options << '--title' << 'PDF::Wrapper Documentation' << '--main'  << 'README.rdoc' << '-q'
+  spec.add_dependency 'cairo', '>=1.5.0'
   spec.author = "James Healy"
   spec.homepage = "http://pdf-wrapper.rubyforge.org/"
   spec.email = "jimmy@deefa.com"

data/examples/text.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+
+require 'pdf/wrapper'
+
+pdf = PDF::Wrapper.new(:paper => :A4)
+pdf.font("Sans Serif")
+pdf.text "Line 1", :font_size => 8
+pdf.text "Line 2", :font_size => 8
+pdf.text "Line 3", :font_size => 8
+pdf.text "Line 4\nLine 5", :font_size => 8
+pdf.render_to_file("text.pdf")

data/lib/pdf/errors.rb

@@ -0,0 +1 @@
+class InvalidOperationError < RuntimeError; end;

data/lib/pdf/wrapper.rb

@@ -2,28 +2,18 @@
 
 require 'stringio'
 require 'pdf/core'
+require 'pdf/errors'
 
 require File.dirname(__FILE__) + "/wrapper/graphics"
 require File.dirname(__FILE__) + "/wrapper/images"
 require File.dirname(__FILE__) + "/wrapper/loading"
 require File.dirname(__FILE__) + "/wrapper/table"
 require File.dirname(__FILE__) + "/wrapper/text"
+require File.dirname(__FILE__) + "/wrapper/page"
 
-# try to load cairo from the standard places, but don't worry if it fails,
-# we'll try to find it via rubygems
-begin
-  require 'cairo'
-rescue LoadError
-    begin
-      require 'rubygems'
-      gem 'cairo', '>=1.5'
-      require 'cairo'
-    rescue Gem::LoadError
-      raise LoadError, "Could not find the ruby cairo bindings in the standard locations or via rubygems. Check to ensure they're installed correctly"
-    rescue LoadError
-      raise LoadError, "Could not load rubygems"
-    end
-end
+require 'rubygems'
+gem 'cairo', '>=1.5'
+require 'cairo'
 
 module PDF
   # Create PDF files by using the cairo and pango libraries.
@@ -289,33 +279,7 @@ module PDF
     def translate(x, y, &block)
       @context.save do
         @context.translate(x, y)
-        yield
-      end
-    end
-
-    # all code wrapped in the block passed to this function will have co-ordinates
-    # and distances (width/height) multiplied by these values before being used
-    #
-    # Divide everything by 2
-    #
-    #   pdf.scale(0.5, 0.5) do
-    #     ...
-    #   end
-    #
-    # Make the page 1.0 wide and 1.0 tall, so co-ordinates and distances
-    # can be specified as percentages (0.5 == 50%, etc)
-    #
-    #   pdf.scale(pdf.page_width.to_f, pdf.page_height.to_f) do
-    #     ...
-    #   end
-    #
-    def scale(w, h, &block)
-      @context.save do
-        @context.scale(w, h)
-
-        # set the line width again so that it's set relative to the current
-        # scale factor
-        line_width @line_width
+        move_to(0,0)
         yield
       end
     end
@@ -343,16 +307,19 @@ module PDF
     def render
       # finalise the document, then convert the StringIO object it was rendered to
       # into a string
-      @context.show_page
-      @context.target.finish
+      finish
       return @output.string
     end
 
+    def render_to_file(filename) #nodoc
+      # TODO: remove this at some point
+      warn "WARNING: render_to_file() is deprecated, please use render_file()"
+      render_file filename
+    end
+
     # save the rendered PDF to a file
-    def render_to_file(filename)
-      # finalise the document
-      @context.show_page
-      @context.target.finish
+    def render_file(filename)
+      finish
 
       # write each line from the StringIO object it was rendered to into the
       # requested file
@@ -366,10 +333,110 @@ module PDF
     # Misc Functions
     #####################################################
 
-    def pad(n)
+    # move down the canvas by n points
+    # returns the new y position
+    #
+    def move_down(n)
+      x, y = current_point
+      newy = y + n
+      move_to(x, newy)
+      newy
+    end
+
+    # move up the canvas by n points
+    # returns the new y position
+    #
+    def move_up(n)
+      x, y = current_point
+      newy = y - n
+      move_to(x, newy)
+      newy
+    end
+
+    # move left across the canvas by n points
+    # returns the new x position
+    #
+    def move_left(n)
+      x, y = current_point
+      newx = x - n
+      move_to(newx, y)
+      newx
+    end
+
+    # move right across the canvas by n points
+    # returns the new x position
+    #
+    def move_right(n)
       x, y = current_point
-      move_to(x, y + n)
-      y + n
+      newx = x + n
+      move_to(newx, y)
+      newx
+    end
+
+    # Moves down the document and then executes a block.
+    #
+    #   pdf.text "some text"
+    #   pdf.pad_top(100) do
+    #     pdf.text "This is 100 points below the previous line of text"
+    #   end
+    #   pdf.text "This text appears right below the previous line of text"
+    #
+    def pad_top(n)
+      move_down n
+      yield
+    end
+
+    # Executes a block then moves down the document
+    #
+    #   pdf.text "some text"
+    #   pdf.pad_bottom(100) do
+    #     pdf.text "This text appears right below the previous line of text"
+    #   end
+    #   pdf.text "This is 100 points below the previous line of text"
+    #
+    def pad_bottom(n)
+      yield
+      move_down n
+    end
+
+    # Moves down the document by y, executes a block, then moves down the
+    # document by y again.
+    #
+    #   pdf.text "some text"
+    #   pdf.pad(100) do
+    #     pdf.text "This is 100 points below the previous line of text"
+    #   end
+    #   pdf.text "This is 100 points below the previous line of text"
+    #
+    def pad(n)
+      if block_given?
+        move_down n
+        yield
+        move_down n
+      else
+        move_down n
+      end
+    end
+
+    # Moves right across the document by n, executes a block, then moves back
+    # left by the same amount
+    #
+    #   pdf.text "some text"
+    #   pdf.indent(50) do
+    #     pdf.text "This starts 50 points right the previous line of text"
+    #   end
+    #   pdf.text "This starts in line with the first line of text"
+    #
+    # If no block is provided, operates just like move_right.
+    #
+    def indent(n)
+      if block_given?
+        move_right n
+        yield
+        move_left n
+      else
+        move_right n
+      end
     end
 
     # move the cursor to an arbitary position on the current page
@@ -382,21 +449,35 @@ module PDF
       @context.move_to(margin_left,margin_top)
     end
 
+    # returns true if the PDF has already been rendered, false if it hasn't.
+    # Due to limitations of the underlying libraries, content cannot be
+    # added to a PDF once it has been rendered.
+    #
+    def finished?
+      @output.seek(@output.size - 6)
+      bytes = @output.read(6)
+      bytes == "%%EOF\n" ? true : false
+    end
+
     # add the same elements to multiple pages. Useful for adding items like headers, footers and
     # watermarks.
     #
+    # There is a single block parameter that is a proxy to the current PDF::Wrapper object that
+    # disallows start_new_page calls. Every other method from PDF::Wrapper is considered valid.
+    #
     # arguments:
     # <tt>spec</tt>::     Which pages to add the items to. :all, :odd, :even, a range, an Array of numbers or an number
     #
     # To add text to every page that mentions the page number
-    #   pdf.repeating_element(:all) do
-    #     pdf.text("Page #{pdf.page}!", :left => pdf.margin_left, :top => pdf.margin_top, :font_size => 18)
+    #   pdf.repeating_element(:all) do |page|
+    #     page.text("Page #{page.page}!", :left => page.margin_left, :top => page.margin_top, :font_size => 18)
     #   end
     #
     # To add a circle to the middle of every page
-    #   pdf.repeating_element(:all) do
-    #     pdf.circle(pdf.absolute_x_middle, pdf.absolute_y_middle, 100)
+    #   pdf.repeating_element(:all) do |page|
+    #     page.circle(page.absolute_x_middle, page.absolute_y_middle, 100)
     #   end
+    #
     def repeating_element(spec = :all, &block)
       call_repeating_element(spec, block)
 
@@ -409,6 +490,7 @@ module PDF
     # 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)
 
@@ -440,10 +522,17 @@ module PDF
 
     private
 
+    def finish
+      # finalise the document
+      @context.show_page
+      @context.target.finish
+    rescue Cairo::SurfaceFinishedError
+      # do nothing, we're happy that the surfaced has been finished
+    end
+
     # runs the code in block, passing it a hash of options that might be
     # required
     def call_repeating_element(spec, block)
-      # TODO: disallow start_new_page when adding a repeating element
       if spec == :all ||
          (spec == :even && (page % 2) == 0) ||
          (spec == :odd && (page % 2) == 1) ||
@@ -453,7 +542,7 @@ module PDF
 
         @context.save do
           # add it to the current page
-          block.call
+          block.call PDF::Wrapper::Page.new(self)
         end
       end
     end
@@ -491,10 +580,6 @@ module PDF
       Cairo::Color.parse(c).to_rgb.to_a
     end
 
-    def user_to_device_dist(x,y)
-      @context.user_to_device_distance(x, y)
-    end
-
     def user_x_to_device_x(x)
       @context.user_to_device(x, 0).first.abs
     end
@@ -503,10 +588,6 @@ module PDF
       @context.user_to_device(0, y).last.abs
     end
 
-    def device_to_user_dist(x, y)
-      @context.device_to_user_distance(x, y)
-    end
-
     def device_x_to_user_x(x)
       @context.device_to_user(x, 0).first.abs
     end

data/lib/pdf/wrapper/images.rb

@@ -13,6 +13,8 @@ module PDF
     # <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.
     # <tt>:center</tt>::    If the image is scaled, it will be centered horizontally and vertically
+    # <tt>:rotate</tt>::    The desired rotation. One of :counterclockwise, :upsidedown, :clockwise.
+    #                       Doesn't work with PNG, PDF or SVG files.
     #
     # left and top default to the current cursor location
     # width and height default to the size of the imported image
@@ -20,7 +22,7 @@ module PDF
     def image(filename, opts = {})
       # TODO: add some options for justification and padding
       raise ArgumentError, "file #{filename} not found" unless File.file?(filename)
-      opts.assert_valid_keys(default_positioning_options.keys + [:padding, :proportional, :center])
+      opts.assert_valid_keys(default_positioning_options.keys + [:padding, :proportional, :center, :rotate])
 
       if opts[:padding]
         opts[:left]   += opts[:padding].to_i if opts[:left]
@@ -132,6 +134,9 @@ module PDF
       load_libpixbuf
       x, y = current_point
       pixbuf = Gdk::Pixbuf.new(filename)
+      if opts[:rotate]
+        pixbuf = pixbuf.rotate( rotation_constant( opts[:rotate] ) )
+      end
       width, height = calc_image_dimensions(opts[:width], opts[:height], pixbuf.width, pixbuf.height, opts[:proportional])
       x, y = calc_image_coords(opts[:left] || x, opts[:top] || y, opts[:width] || pixbuf.width, opts[:height] || pixbuf.height, width, height,  opts[:center])
       @context.save do
@@ -145,6 +150,10 @@ module PDF
       raise ArgumentError, "Unrecognised image format (#{filename})"
     end
 
+    def rotation_constant( rotation )
+      Gdk::Pixbuf.const_get "ROTATE_#{rotation.to_s.upcase}"
+    end
+
     def draw_png(filename, opts = {})
       # based on a similar function in rabbit. Thanks Kou.
       x, y = current_point

data/lib/pdf/wrapper/page.rb

@@ -0,0 +1,20 @@
+module PDF
+  class Wrapper
+
+    # a proxy to a PDF::Wrapper object that disallows new pages
+    class Page
+
+      def initialize(pdf)
+        @pdf = pdf
+      end
+
+      def method_missing(method, *args, &block)
+        if method.to_sym == :start_new_page
+          raise InvalidOperationError, 'start_new_page is not allowed in the current context'
+        else
+          @pdf.__send__(method, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/pdf/wrapper/table.rb

@@ -16,6 +16,11 @@ module PDF
     # <tt>:top</tt>::   The y co-ordinate of the top of the text. Defaults to the current cursor location
     # <tt>:width</tt>::   The width of the table. Defaults to the distance from the left of the table to the right margin
     def table(data, opts = {})
+      # TODO: add support for a table footer
+      #       - repeating each page, or just at the bottom? 
+      #       - if it repeats, should it be different on each page? ie. a sum of that pages rows, etc.
+      # TODO: add support for manually specifying 1 or more column widths
+      # TODO: maybe support for multiple data sets with group headers/footers. useful for subtotals, etc
 
       x, y = current_point
       options = {:left => x, :top => y }
@@ -163,7 +168,7 @@ module PDF
     # For example:
     #
     #    table = Table.new do |t|
-    #      t.headings = ["Words", "Numbers"]
+    #      t.headers = ["Words", "Numbers"]
     #      t.data = [['one',  1],
     #                ['two',  2],
     #                ['three',3]]
@@ -186,12 +191,6 @@ module PDF
       attr_reader :cells, :headers
       attr_accessor :width, :show_headers
 
-      # Create a new table object.
-      #
-      # data should be a 2d array
-      #
-      #   [[ "one", "two"],
-      #    [ "one", "two"]]
       #
       # headers should be a single array
       #  
@@ -209,7 +208,14 @@ module PDF
         self
       end
 
+      # Specify the tables data.
+      #
+      # The single argument should be a 2d array like:
+      #
+      #   [[ "one", "two"],
+      #    [ "one", "two"]]
       def data=(d)
+        # TODO: raise an exception of the data rows aren't all the same size
         # TODO: ensure d is array-like
         @cells = d.collect do |row|
           row.collect do |str|
@@ -218,14 +224,21 @@ module PDF
         end
       end
 
+      # Specify the tables optional column headers.
+      #
+      # The single argument should be an array like:
+      #
+      #   [ "col one", "col two"]
       def headers=(h)
+        # TODO: raise an exception of the size of the array does not match the size
+        #       of the data row arrays
         # TODO: ensure h is array-like
         @headers = h.collect do |str|
           Wrapper::Cell.new(str)
         end
       end
 
-      # access a particular cell
+      # access a particular cell at location x, y
       def cell(col_idx, row_idx)
         @cells[row_idx, col_idx]
       end

data/lib/pdf/wrapper/text.rb

@@ -28,9 +28,10 @@ module PDF
     def cell(str, x, y, w, h, opts={})
       # TODO: add a wrap option so wrapping can be disabled
       # TODO: add an option for vertical alignment
+      # TODO: allow cell contents to be defined as a block, like link_to in EDGE rails
 
       options = default_text_options
-      options.merge!({:border => "tblr", :border_width => @default_line_width, :border_color => :black,  :fill_color => nil, :padding => device_to_user_dist(3,0).first, :radius => nil})
+      options.merge!({:border => "tblr", :border_width => @default_line_width, :border_color => :black,  :fill_color => nil, :padding => 3, :radius => nil})
       options.merge!(opts)
       options.assert_valid_keys(default_text_options.keys + [:width, :border, :border_width, :border_color, :fill_color, :padding, :radius])
 
@@ -142,7 +143,7 @@ module PDF
       # draw the context on our cairo layout
       y = render_layout(layout, options[:left], options[:top], points_to_bottom_margin(options[:top]), :auto_new_page => true)
 
-      move_to(options[:left], y + device_y_to_user_y(5))
+      move_to(options[:left], y)
     end
 
     # Returns the amount of vertical space needed to display the supplied text at the requested width
@@ -233,7 +234,7 @@ module PDF
         layout.width = w * Pango::SCALE
       end
       # spacing is specified in user points
-      layout.spacing = device_y_to_user_y(options[:spacing] * Pango::SCALE)
+      layout.spacing = options[:spacing] * Pango::SCALE
 
       # set the alignment of the text in the layout
       if options[:alignment].eql?(:left)
@@ -263,7 +264,7 @@ module PDF
       # setup the font that will be used to render the text
       fdesc = Pango::FontDescription.new(options[:font])
       # font size should be specified in device points for simplicity's sake.
-      fdesc.size = device_y_to_user_y(options[:font_size] * Pango::SCALE)
+      fdesc.size = options[:font_size] * Pango::SCALE
       layout.font_description = fdesc
       @context.update_pango_layout(layout)
 
@@ -296,6 +297,7 @@ module PDF
 
       offset = 0
       baseline = 0
+      spacing = layout.spacing / Pango::SCALE
 
       iter = layout.iter
       loop do
@@ -320,7 +322,7 @@ module PDF
         end
 
         # move to the start of this line
-        @context.move_to(x + linex, y + baseline - offset)
+        @context.move_to(x + linex, y + baseline - offset + spacing)
 
         # draw the line on the canvas
         @context.show_pango_layout_line(line)
@@ -328,10 +330,11 @@ module PDF
         break unless iter.next_line!
       end
 
+      width, height = layout.size
+
       # return the y co-ord we finished on
-      return device_y_to_user_y(y + baseline - offset)
+      return y + (height / Pango::SCALE) - offset + spacing
     end
 
-
   end
 end

data/specs/image_spec.rb

@@ -29,5 +29,13 @@ context "The PDF::Wrapper class" do
     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)
+  end
+
   specify "should be able to draw an image with padding correctly"
 end

data/specs/spec_helper.rb

@@ -6,7 +6,7 @@ require 'pdf/wrapper'
 require 'tempfile'
 require 'rubygems'
 
-gem "pdf-reader", ">=0.6.1"
+gem "pdf-reader", ">=0.7.3"
 
 require 'pdf/reader'
 
@@ -27,7 +27,6 @@ class PDF::Wrapper
   public :load_libpoppler
   public :user_x_to_device_x
   public :user_y_to_device_y
-  public :user_to_device_dist
   public :device_x_to_user_x
   public :device_y_to_user_y
   public :validate_color
@@ -35,15 +34,15 @@ end
 
 # a helper class for counting the number of pages in a PDF
 class PageReceiver
-  attr_accessor :page_count
+  attr_accessor :pages
 
   def initialize
     @page_count = 0
   end
 
   # Called when page parsing ends
-  def end_page
-    @page_count += 1
+  def page_count(arg)
+    @pages = arg
   end
 end
 

data/specs/wrapper_spec.rb

@@ -92,16 +92,6 @@ context "The PDF::Wrapper class" do
     y.to_i.should eql(100)
   end
 
-  specify "should be able to move the cursor to any arbitary point on the canvas when scaled" do
-    pdf = PDF::Wrapper.new
-    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
     pdf = PDF::Wrapper.new
     pdf.move_to(100,100)
@@ -123,7 +113,7 @@ context "The PDF::Wrapper class" do
     # verify the output
     receiver = PageReceiver.new
     reader = PDF::Reader.string(pdf.render, receiver)
-    receiver.page_count.should eql(2)
+    receiver.pages.should eql(2)
   end
 
 
@@ -150,7 +140,7 @@ context "The PDF::Wrapper class" do
     # write the PDF to a temp file
     tmp = Tempfile.open("siftr")
     tmp.close
-    pdf.render_to_file(tmp.path)
+    pdf.render_file(tmp.path)
 
     # ensure an actual PDF was written out
     File.open(tmp.path, "r") do |f|
@@ -175,7 +165,7 @@ 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) { |page| page.text test_str }
 
     pdf.start_new_page
     pdf.start_new_page
@@ -195,7 +185,7 @@ 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) { |page| page.text test_str }
 
     pdf.start_new_page
     pdf.start_new_page
@@ -215,7 +205,7 @@ 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) { |page| page.text test_str }
 
     pdf.start_new_page
     pdf.start_new_page
@@ -235,7 +225,7 @@ 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)) { |page| page.text test_str }
 
     pdf.start_new_page
     pdf.start_new_page
@@ -255,7 +245,7 @@ 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) { |page| page.text test_str }
 
     pdf.start_new_page
     pdf.start_new_page
@@ -275,7 +265,7 @@ 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]) { |page| page.text test_str }
 
     pdf.start_new_page
     pdf.start_new_page
@@ -292,6 +282,19 @@ context "The PDF::Wrapper class" do
   end
 
   specify "should not change the state of the cairo canvas or PDF::Writer defaults (fonts, colors, etc) when adding repeating elements"
+  
+  specify "should not allow a new page to be started while adding repeating elements" do
+    test_str = "repeating"
+
+    pdf = PDF::Wrapper.new
+    lambda do
+      pdf.repeating_element([1,3,4]) do |page|
+        page.text test_str
+        page.start_new_page
+      end
+    end.should raise_error(InvalidOperationError)
+
+  end
 
   specify "should leave the cursor on the bottom left corner of an object when using functions with optional positioning [func(data, opts)]" do
     pdf = PDF::Wrapper.new
@@ -406,29 +409,6 @@ context "The PDF::Wrapper class" do
     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)
 
@@ -439,11 +419,6 @@ context "The PDF::Wrapper class" 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
@@ -456,11 +431,6 @@ context "The PDF::Wrapper class" 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
@@ -472,11 +442,6 @@ context "The PDF::Wrapper class" do
     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
@@ -488,29 +453,20 @@ context "The PDF::Wrapper class" do
     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
+  specify "should allow Wrapper#render to be called multiple times" do
+    pdf = PDF::Wrapper.new
+    pdf.text "Hi!"
+    pdf.render.should be_a_kind_of(String)
+    pdf.render.should be_a_kind_of(String)
+  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
+  specify "should be aware of when the underlying PDFSurface has been finished" do
+    pdf = PDF::Wrapper.new
+    pdf.text "Hi!"
+    pdf.finished?.should be_false
+    pdf.render
+    pdf.finished?.should be_true
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pdf-wrapper
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors: 
 - James Healy
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-28 00:00:00 +10:00
+date: 2008-07-28 00:00:00 +10:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cairo
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
 description: A unicode aware PDF writing library that uses the ruby bindings to various c libraries ( like cairo, pango, poppler and rsvg ) to do the heavy lifting.
 email: jimmy@deefa.com
 executables: []
@@ -20,7 +29,7 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 - CHANGELOG
 - TODO
 files: 
@@ -28,21 +37,22 @@ files:
 - examples/image.rb
 - examples/markup.rb
 - examples/repeating.rb
-- examples/scaled.rb
-- examples/scaled_cells.rb
-- examples/scaled_image.rb
+- examples/utf8-long.rb
 - examples/shapes.rb
 - examples/table.rb
+- examples/scaled_image.rb
 - examples/translate.rb
-- examples/utf8-long.rb
 - examples/utf8.rb
+- examples/text.rb
 - lib/pdf
 - lib/pdf/core.rb
 - lib/pdf/wrapper.rb
+- lib/pdf/errors.rb
 - lib/pdf/wrapper
 - lib/pdf/wrapper/graphics.rb
 - lib/pdf/wrapper/images.rb
 - lib/pdf/wrapper/loading.rb
+- lib/pdf/wrapper/page.rb
 - lib/pdf/wrapper/table.rb
 - lib/pdf/wrapper/text.rb
 - specs/data
@@ -57,15 +67,15 @@ files:
 - specs/data/utf8.txt
 - specs/data/windmill.jpg
 - specs/data/zits.gif
-- specs/graphics_spec.rb
+- specs/spec_helper.rb
 - specs/image_spec.rb
 - specs/load_spec.rb
-- specs/spec_helper.rb
 - specs/tables_spec.rb
 - specs/text_spec.rb
 - specs/wrapper_spec.rb
+- specs/graphics_spec.rb
 - Rakefile
-- README
+- README.rdoc
 - CHANGELOG
 - TODO
 has_rdoc: true
@@ -75,7 +85,7 @@ rdoc_options:
 - --title
 - PDF::Wrapper Documentation
 - --main
-- README
+- README.rdoc
 - -q
 require_paths: 
 - lib
@@ -94,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: pdf-wrapper
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: A PDF generating library built on top of cairo

data/examples/scaled.rb

@@ -1,38 +0,0 @@
-#!/usr/bin/env ruby
-# coding: utf-8
-
-$:.unshift(File.dirname(__FILE__) + "/../lib")
-
-require 'pdf/wrapper'
-
-pdf = PDF::Wrapper.new(:paper => :A4)
-pdf.line_width = 2
-
-# grid lines
-pdf.line(50, 0, 50, pdf.page_height)
-pdf.line(100, 0, 100, pdf.page_height)
-pdf.line(150, 0, 150, pdf.page_height)
-pdf.line(200, 0, 200, pdf.page_height)
-pdf.line(0, 50, pdf.page_width, 50)
-pdf.line(0, 100, pdf.page_width, 100)
-pdf.line(0, 150, pdf.page_width, 150)
-pdf.line(0, 200, pdf.page_width, 200)
-
-# non scaled
-pdf.rectangle(100,100,100,100, :fill_color => :green)
-
-# scaled
-pdf.scale(pdf.page_width.to_f, pdf.page_height.to_f) do
-  # top left corner 10% of the page width from the left and top of the page. 
-  # width 10% of the page width
-  # height 10% of the page height
-  # - obviously will not be square on a A4 page
-  pdf.rectangle(0.1,0.1,0.1,0.1, :fill_color => :red)
-  pdf.text("boo!", :top => 0.5, :left => 0.2, :width => 0.6)
-end
-
-#pdf.text("boo2!", :top => 500, :left => 100)
-
-
-# show results
-pdf.render_to_file("scaled.pdf")

data/examples/scaled_cells.rb

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-# coding: utf-8
-
-$:.unshift(File.dirname(__FILE__) + "/../lib")
-
-require 'pdf/wrapper'
-
-pdf = PDF::Wrapper.new(:paper => :A4)
-pdf.font("Sans Serif")
-pdf.line_width(0.1)
-# naglowek
-pdf.translate(pdf.absolute_left_margin, pdf.absolute_top_margin) do
-  pdf.scale(pdf.body_width, pdf.body_width) do
-    pdf.cell("Exorigo", 0, 0, 0.2, 0.05, :alignment => :center, :font_size => 15)
-    pdf.cell("Zamówienie nr PO/0000/01/01/2008", 0.2, 0, 0.8, 0.05, :fill_color => :gray, :alignment => :center)
-    pdf.cell("imię i naziwsko osoby zamawiającej. NALEŻY PODAĆ NA FAKTURZE", 0, 0.05, 0.55, 0.025, :font_size => 6)
-    pdf.cell("data zamówienia", 0.55, 0.05, 0.15, 0.025, :font_size => 6)
-    pdf.cell("POWYŻSZY NUMER ZAMÓWIENIA NALEŻY PODAĆ NA FAKTURZE", 0.7, 0.05, 0.3, 0.05, :font_size => 6, :alignment => :center, :spacing => 4)
-    pdf.cell("Jan Kowalski", 0, 0.075, 0.55, 0.025, :font => "Sans Serif bold", :font_size => 8)
-    pdf.cell("22.01.2008", 0.55, 0.075, 0.15, 0.025, :font => "Sans Serif bold", :font_size => 8)
-  end
-end
-# dane dostawcy
-
-# szczegoly zamowienia
-
-# autoryzacja
-
-# adres
-pdf.render_to_file("scaled-cells.pdf")