pdf-wrapper 0.2.1 → 0.3.0

data/lib/pdf/wrapper/text.rb

@@ -200,6 +200,18 @@ module PDF
       return width / Pango::SCALE
     end
 
+    def default_text_options
+      { :font => @default_font,
+        :font_size => @default_font_size,
+        :alignment => :left,
+        :wrap => :wordchar,
+        :justify => false,
+        :spacing => 0,
+        :color => nil,
+        :markup => nil
+      }
+    end
+
     private
 
     # takes a string and a range of options and creates a pango layout for us. Pango
@@ -299,18 +311,6 @@ module PDF
       return layout
     end
 
-    def default_text_options
-      { :font => @default_font,
-        :font_size => @default_font_size,
-        :alignment => :left,
-        :wrap => :wordchar,
-        :justify => false,
-        :spacing => 0,
-        :color => nil,
-        :markup => nil
-      }
-    end
-
     # renders a pango layout onto our main context
     # based on a function of the same name found in the text2.rb sample file
     # distributed with rcairo - it's still black magic to me and has a few edge

data/lib/pdf/wrapper/text_cell.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+module PDF
+  class Wrapper
+    class TextCell
+
+      attr_reader :data, :min_width, :natural_width, :max_width, :wrapper
+      attr_accessor :width, :height
+      attr_writer :options
+
+      def initialize(str)
+        @data = str.to_s
+        @options = {}
+      end
+
+      def draw(wrapper, x, y)
+        @wrapper = wrapper
+
+        wrapper.cell(self.data, x, y, self.width, self.height, self.options)
+      end
+
+      def calculate_width_range(wrapper)
+        @wrapper = wrapper
+
+        padding = options[:padding] || 3
+        if options[:markup] == :pango
+          str = self.data.dup.gsub(/<.+?>/,"").gsub("&amp;","&").gsub("&lt;","<").gsub("&gt;",">")
+        else
+          str = self.data.dup
+        end
+        @min_width  = wrapper.text_width(str.gsub(/\b|\B/,"\n"), text_options) + (padding * 4)
+        @natural_width = wrapper.text_width(str, text_options) + (padding * 4)
+      end
+
+      def calculate_height(wrapper)
+        raise "Cannot calculate height until cell width is set" if self.width.nil?
+
+        @wrapper = wrapper
+
+        padding = options[:padding] || 3
+        @height = wrapper.text_height(self.data, self.width - (padding * 2), text_options) + (padding * 2)
+      end
+
+      def options
+        @options ||= {}
+      end
+
+      def text_options
+        self.options.only(wrapper.default_text_options.keys)
+      end
+    end
+  end
+end

data/lib/pdf/wrapper/text_image_cell.rb

@@ -0,0 +1,68 @@
+# coding: utf-8
+
+module PDF
+  class Wrapper
+    class TextImageCell
+
+      attr_reader :text, :min_width, :natural_width, :max_width, :wrapper
+      attr_accessor :width, :height
+      attr_writer :options
+
+      def initialize(str, filename, width, height)
+        @text = str.to_s
+        @filename = filename
+        @min_width = width
+        @natural_width = width
+        @max_width = width
+        @height = height
+        @options = {}
+      end
+
+      def draw(wrapper, x, y)
+        @wrapper = wrapper
+
+        wrapper.cell(self.text, x, y, self.width, self.height, self.options)
+        wrapper.image(@filename, image_options(x,y))
+      end
+
+      def calculate_width_range(wrapper)
+        # nothing required, width range set in constructor
+      end
+
+      def calculate_height(wrapper)
+        # nothing required, height set in constructor
+      end
+
+      def options
+        @options ||= {}
+      end
+
+      private
+
+      def image_offset
+        @image_offset ||= text_height + 4
+      end
+
+      def image_options(x, y)
+        {
+          :left => x,
+          :top  => y + image_offset,
+          :width => self.width,
+          :height => self.height - image_offset,
+          :proportional => true,
+          :center => true
+        }
+      end
+
+      def text_height
+        padding = options[:padding] || 3
+        wrapper.text_height(self.text, self.width - (padding * 2), text_options) + (padding * 2)
+      end
+
+      def text_options
+        self.options.only(wrapper.default_text_options.keys)
+      end
+
+    end
+  end
+end

data/specs/graphics_spec.rb

@@ -18,8 +18,8 @@ context "The PDF::Wrapper class" do
     # the begin_new_subpath command specifies the start of the line, append line specifies the end
     receiver.count(:begin_new_subpath).should eql(1)
     receiver.count(:append_line).should eql(1)
-    receiver.first_occurance_of(:begin_new_subpath)[:args].should eql([x0.to_f, 741.89])
-    receiver.first_occurance_of(:append_line)[:args].should eql([x1.to_f, 641.89])
+    receiver.first_occurance_of(:begin_new_subpath)[:args].should eql([x0, 741.89])
+    receiver.first_occurance_of(:append_line)[:args].should eql([x1, 641.89])
   end
 
   specify "should be able to draw a single line onto the canvas with a width of 5" do
@@ -36,9 +36,9 @@ context "The PDF::Wrapper class" do
     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, 741.89])
-    receiver.first_occurance_of(:append_line)[:args].should eql([x1.to_f, 641.89])
+    receiver.first_occurance_of(:set_line_width)[:args].should eql([width])
+    receiver.first_occurance_of(:begin_new_subpath)[:args].should eql([x0, 741.89])
+    receiver.first_occurance_of(:append_line)[:args].should eql([x1, 641.89])
   end
 
   specify "should be able to draw a cubic bezier spline onto the canvas"
@@ -57,7 +57,7 @@ context "The PDF::Wrapper class" do
     callbacks.size.should eql(2)
     # don't care about the first rectangel, it just goes around the outside of the page
     callbacks.shift
-    callbacks.shift[:args].should eql([100.0, 741.89, 200.0, -200.0])
+    callbacks.shift[:args].should eql([100, 741.89, 200, -200])
   end
 
   specify "should be able to draw an empty rectangle onto the canvas with a line width of 5" do
@@ -72,14 +72,14 @@ context "The PDF::Wrapper class" do
 
     # 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])
+    receiver.first_occurance_of(:set_line_width)[:args].should eql([width])
 
     # the begin_new_subpath command specifies the start of the line, append line specifies the end
     callbacks = receiver.all(:append_rectangle)
     callbacks.size.should eql(2)
     # don't care about the first rectangel, it just goes around the outside of the page
     callbacks.shift
-    callbacks.shift[:args].should eql([100.0, 741.89, 200.0, -200.0])
+    callbacks.shift[:args].should eql([100, 741.89, 200, -200])
   end
 
   specify "should be able to draw a filled rectangle onto the canvas"

data/specs/tables_spec.rb

@@ -2,7 +2,7 @@
 
 require File.dirname(__FILE__) + '/spec_helper'
 
-context "The PDF::Wrapper class" do
+context PDF::Wrapper do
 
   before(:each) { create_pdf }
 
@@ -20,6 +20,41 @@ context "The PDF::Wrapper class" do
     receiver.content.first.include?("data4").should be_true
   end
 
+  specify "should be able to draw a table on the canvas using an array of TextCells" do
+    data = [
+      [ PDF::Wrapper::TextCell.new("data1"), PDF::Wrapper::TextCell.new("data2")],
+      [ PDF::Wrapper::TextCell.new("data3"), PDF::Wrapper::TextCell.new("data4")]
+    ]
+    @pdf.table(data)
+    @pdf.finish
+
+    receiver = PageTextReceiver.new
+    reader = PDF::Reader.string(@output.string, receiver)
+
+    receiver.content.first.include?("data1").should be_true
+    receiver.content.first.include?("data2").should be_true
+    receiver.content.first.include?("data3").should be_true
+    receiver.content.first.include?("data4").should be_true
+  end
+
+  specify "should be able to draw a table on the canvas using an array of TextImageCells" do
+    filename = File.dirname(__FILE__) + "/data/orc.svg"
+    data = [
+      [ "data1", PDF::Wrapper::TextImageCell.new("data2", filename, 100, 100)],
+      [ "data3", PDF::Wrapper::TextImageCell.new("data4", filename, 100, 100)]
+    ]
+    @pdf.table(data)
+    @pdf.finish
+
+    receiver = PageTextReceiver.new
+    reader = PDF::Reader.string(@output.string, receiver)
+
+    receiver.content.first.include?("data1").should be_true
+    receiver.content.first.include?("data2").should be_true
+    receiver.content.first.include?("data3").should be_true
+    receiver.content.first.include?("data4").should be_true
+  end
+
   specify "should be able to draw a table on the canvas using a PDF::Wrapper::Table object" do
     table = PDF::Wrapper::Table.new do |t|
       t.data = [%w{data1 data2}, %w{data3 data4}]
@@ -110,3 +145,201 @@ context "The PDF::Wrapper class" do
   end
 
 end
+
+context PDF::Wrapper, "data= method" do
+
+  specify "should raise an exception if given rows of uneven size" do
+    data = [%w{head1 head2},%w{data1}]
+    table = PDF::Wrapper::Table.new
+    lambda { table.data = data }.should raise_error(ArgumentError)
+  end
+
+  specify "should convert all non cell objects to TextCells" do
+    data = [%w{head1 head2},%w{data1 data2}]
+    table = PDF::Wrapper::Table.new
+    table.data = data
+    table.each_cell do |cell|
+      cell.should be_a_kind_of(PDF::Wrapper::TextCell)
+    end
+  end
+
+  specify "should leave existing TextCells unchanged" do
+    manual_cell_one = PDF::Wrapper::TextCell.new("data1")
+    manual_cell_two = PDF::Wrapper::TextCell.new("data2")
+    data = [[manual_cell_one, manual_cell_two]]
+
+    table = PDF::Wrapper::Table.new
+    table.data = data
+
+    cells = []
+    table.each_cell do |cell|
+      cells << cell
+    end
+    (cells[0] === manual_cell_one).should be_true
+    (cells[1] === manual_cell_two).should be_true
+  end
+
+  specify "should leave existing TextImageCells unchanged" do
+    manual_cell_one = PDF::Wrapper::TextImageCell.new("data1", "image.png", 100, 100)
+    manual_cell_two = PDF::Wrapper::TextImageCell.new("data2", "image.png", 100, 100)
+    data = [[manual_cell_one, manual_cell_two]]
+
+    table = PDF::Wrapper::Table.new
+    table.data = data
+
+    cells = []
+    table.each_cell do |cell|
+      cells << cell
+    end
+    (cells[0] === manual_cell_one).should be_true
+    (cells[1] === manual_cell_two).should be_true
+  end
+
+  specify "should set the default table options on all cells" do
+    data = [%w{head1 head2},%w{data1 data2}]
+    table = PDF::Wrapper::Table.new(:markup => :pango)
+
+    table.data = data
+
+    table.each_cell do |cell|
+      cell.options.should eql(:markup => :pango)
+    end
+  end
+end
+
+context PDF::Wrapper, "headers method" do
+
+  specify "should raise an exception if given cell count does not match existing data" do
+    data = [%w{data1 data2},%w{data1 data2}]
+    headers = %w{head1}
+
+    table = PDF::Wrapper::Table.new
+    table.data = data
+
+    lambda { table.headers(headers) }.should raise_error(ArgumentError)
+  end
+
+  specify "should wrap non-cell objects in a TextCell" do
+    headers = [["head1","head2"]]
+
+    table = PDF::Wrapper::Table.new
+    table.headers(headers)
+
+    set_headers = table.instance_variable_get("@headers")
+    set_headers.each do |cell|
+      cell.should be_a_kind_of(PDF::Wrapper::TextCell)
+    end
+  end
+
+  specify "should leave TextCell objects untouched" do
+    manual_cell_one = PDF::Wrapper::TextCell.new("data1")
+    manual_cell_two = PDF::Wrapper::TextCell.new("data2")
+    headers = [manual_cell_one, manual_cell_two]
+
+    table = PDF::Wrapper::Table.new
+    table.headers(headers)
+
+    set_headers = table.instance_variable_get("@headers")
+    (set_headers[0] === manual_cell_one).should be_true
+    (set_headers[1] === manual_cell_two).should be_true
+  end
+
+  specify "should leave TextImageCell objects untouched" do
+    manual_cell_one = PDF::Wrapper::TextImageCell.new("data1", "image.png", 100, 100)
+    manual_cell_two = PDF::Wrapper::TextImageCell.new("data2", "image.png", 100, 100)
+    headers = [manual_cell_one, manual_cell_two]
+
+    table = PDF::Wrapper::Table.new
+    table.headers(headers)
+
+    set_headers = table.instance_variable_get("@headers")
+    (set_headers[0] === manual_cell_one).should be_true
+    (set_headers[1] === manual_cell_two).should be_true
+  end
+
+  specify "should set options on all cells" do
+    headers = ["head1","head2"]
+
+    table = PDF::Wrapper::Table.new
+    table.headers(headers, :markup => :pango)
+
+    set_headers = table.instance_variable_get("@headers")
+    set_headers.each do |cell|
+      cell.options.should eql(:markup => :pango)
+    end
+  end
+
+  specify "should set default table options on all cells" do
+    headers = ["head1","head2"]
+
+    table = PDF::Wrapper::Table.new(:markup => :pango)
+    table.headers(headers)
+
+    set_headers = table.instance_variable_get("@headers")
+    set_headers.each do |cell|
+      cell.options.should eql(:markup => :pango)
+    end
+  end
+end
+
+context PDF::Wrapper, "cell method" do
+
+  specify "should return the appropriate cell" do
+    data = [%w{data1 data2},%w{data3 data4}]
+    headers = %w{head1}
+
+    table = PDF::Wrapper::Table.new
+    table.data = data
+
+    table.cell(0,0).should be_a_kind_of(PDF::Wrapper::TextCell)
+    table.cell(0,0).data.should eql("data1")
+
+    table.cell(1,1).should be_a_kind_of(PDF::Wrapper::TextCell)
+    table.cell(1,1).data.should eql("data4")
+  end
+end
+
+context PDF::Wrapper, "cell_options method" do
+
+  specify "should set options on the appropriate cell" do
+    data = [%w{data1 data2},%w{data3 data4}]
+
+    table = PDF::Wrapper::Table.new
+    table.data = data
+    table.cell_options(0,0, :markup => :pango)
+
+    table.cell(0,0).options.should eql(:markup => :pango)
+  end
+end
+
+context PDF::Wrapper, "col_options method" do
+
+  specify "should set options on all cells in the appropriate column" do
+    data = [%w{data1 data2},%w{data3 data4}]
+
+    table = PDF::Wrapper::Table.new
+    table.data = data
+    table.col_options(0, :markup => :pango)
+
+    table.cell(0,0).options.should eql(:markup => :pango)
+    table.cell(0,1).options.should eql(:markup => :pango)
+    table.cell(1,0).options.should eql({})
+    table.cell(1,1).options.should eql({})
+  end
+end
+
+context PDF::Wrapper, "row_options method" do
+
+  specify "should set options on all cells in the appropriate row" do
+    data = [%w{data1 data2},%w{data3 data4}]
+
+    table = PDF::Wrapper::Table.new
+    table.data = data
+    table.row_options(0, :markup => :pango)
+
+    table.cell(0,0).options.should eql(:markup => :pango)
+    table.cell(1,0).options.should eql(:markup => :pango)
+    table.cell(0,1).options.should eql({})
+    table.cell(1,1).options.should eql({})
+  end
+end