HACKING bugs/resolved/canvas_sets_y_to_0.rb bugs/resolved/table_ignores_align_headers.rb bugs/resolved/table_suppress_newline.rb data/encodings/win_ansi.txt data/images/fractal.jpg data/images/letterhead.jpg examples/background.rb examples/cmyk.rb examples/euro.rb examples/font_calculations.rb examples/image_fit.rb examples/image_position.rb examples/measurement_units.rb examples/padded_box.rb examples/position_by_baseline.rb examples/stroke_bounds.rb examples/table_alignment.rb examples/table_border_color.rb examples/table_colspan.rb examples/table_header_color.rb examples/table_header_underline.rb examples/text_box.rb examples/win_ansi_charset.rb lib/prawn/document/annotations.rb lib/prawn/document/destinations.rb lib/prawn/document/text/box.rb lib/prawn/encoding.rb lib/prawn/literal_string.rb lib/prawn/measurement_extensions.rb lib/prawn/measurements.rb lib/prawn/name_tree.rb spec/annotations_spec.rb spec/destinations_spec.rb spec/measurement_units_spec.rb spec/name_tree_spec.rb vendor/ttfunk www/twilight.css @@ -1,3 +1,6 @@ [submodule "vendor/pdf-inspector"] path = vendor/pdf-inspector url = git://github.com/sandal/pdf-inspector.git +[submodule "vendor/ttfunk"] + path = vendor/ttfunk + url = git://github.com/sandal/ttfunk.git .gitmodules @@ -12,6 +12,9 @@ Website: http://prawn.majesticseacreature.com +Examples: +http://github.com/sandal/prawn/tree/master/examples + Bug Tracker / Wiki: http://prawn.lighthouseapp.com/projects/9398-prawn/home @@ -34,7 +37,7 @@ NOTES TO DEVELOPERS: You will need the pdf-reader and test-spec gems to run Prawn. Be sure to run the specs on both Ruby 1.8.6 and the latest Ruby 1.9 snapshot, as both versions -are supported. 1.8.7 is *not* officially supported. +are supported. 1.8.7 is not officially supported. Prawn relies on PDF::Inspector, a collection of PDF::Reader backed classes for analyzing PDF output. This is provided as a submodule in Prawn's git README @@ -53,6 +53,19 @@ task :examples do end +task :generate do + if File.exists?("examples/#{ENV['example']}.rb") + puts "Example already exists" + else + File.open("examples/#{ENV['example']}.rb", "w") do |f| + f << ["$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')", + "require 'prawn'\n", + "Prawn::Document.generate('#{ENV['example']}.pdf') do\n\nend"].join("\n") + end + sh "git add examples/#{ENV['example']}.rb" + end +end + spec = Gem::Specification.new do |spec| spec.name = "prawn" spec.version = PRAWN_VERSION Rakefile @@ -4,14 +4,16 @@ require 'prawn' Prawn::Document.generate("bounding_boxes.pdf") do bounding_box [100,600], :width => 200 do + move_down 10 text "The rain in spain falls mainly on the plains " * 5 + move_down 20 stroke do line bounds.top_left, bounds.top_right line bounds.bottom_left, bounds.bottom_right end end - bounding_box [100,500], :width => 200, :height => 200 do + bounding_box [100,cursor], :width => 200, :height => 200 do stroke do circle_at [100,100], :radius => 100 line bounds.top_left, bounds.bottom_right @@ -23,7 +25,9 @@ Prawn::Document.generate("bounding_boxes.pdf") do end end -end +end + +`open bounding_boxes.pdf` examples/bounding_boxes.rb @@ -12,7 +12,7 @@ Prawn::Document.generate("cell.pdf") do :text => "You know that kittens are made of mud!", :document => self) cell2 = Prawn::Graphics::Cell.new( :border_width => 3, :padding => 10, - :text => "And that puppies are made of gravy", :document => self) + :text => "And that puppies are made of gravy", :document => self, :font_size => 9) cell3 = Prawn::Graphics::Cell.new( :border_width => 3, :padding => 10, :width => 100, :text => "This is simply the way of the world", :document => self) examples/cell.rb @@ -19,6 +19,8 @@ ruby_19 do end Prawn::Document.generate("fancy_table.pdf", :page_layout => :landscape) do + + #font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf" mask(:y) { table body, :headers => headers, :align => :center, examples/fancy_table.rb @@ -15,5 +15,13 @@ Prawn::Document.generate "font_size.pdf", :page_size => "A4" do text 'Font at 9 point' end + font("Times-Roman", :style => :italic, :size => 12) do + text "Font in times at 12" + font.size(16) { text "Font in Times at 16" } + end + text 'Font at 16 point' -end + + font "Courier", :size => 40 + text "40 pt!" +end \ No newline at end of file examples/font_size.rb @@ -3,26 +3,31 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib') require "prawn" -Prawn::Document.generate("image-flow.pdf", :page_layout => :landscape) do +Prawn::Document.generate("image-flow.pdf", :page_layout => :landscape) do + font.size = 8 stef = "#{Prawn::BASEDIR}/data/images/stef.jpg" - text "o hai" + text "Image at default position with no arguments" + + move_down 10 image stef - text "flowing text" + text "Centered image flowing" image stef, :position => :center - text "beneath images" + text "Right aligned image flowing" image stef, :position => :right - text "again" + text "Explicitly left aligned image flowing" + + move_down 10 image stef, :position => :left - text "and again" + text "Flowing image at x=50" image stef, :position => 50 examples/image_flow.rb @@ -12,6 +12,7 @@ Prawn::Document.generate("ruport.pdf") do pad(50) { text "I'm Padded" } text "I'm far away" stroke_horizontal_line 50, 100 - stroke_vertical_line_at 300, 50, 250 + stroke_horizontal_line 50, 100, :at => 300 + stroke_vertical_line 300, 50, :at => 250 end examples/ruport_helpers.rb @@ -20,7 +20,7 @@ def recurse_bounding_box(pdf, max_depth=5, depth=1) left_top_corners = [5, box.right-width-5].combine [box.top-5, height+5] left_top_corners.each do |lt| pdf.bounding_box(lt, :width=>width, :height=>height) do - pdf.stroke_rectangle [0,height], width, height + pdf.stroke_bounds recurse_bounding_box(pdf, max_depth, depth+1) if depth<max_depth end end @@ -30,5 +30,3 @@ end Prawn::Document.generate("russian_boxes.pdf") do |pdf| recurse_bounding_box(pdf) end - - examples/russian_boxes.rb @@ -5,7 +5,7 @@ require "prawn" Prawn::Document.generate "hello.pdf" do fill_color "0000ff" - text "Hello World", :at => [200,720], :size => 32 + text "Hello World", :at => [200,420], :size => 32, :rotate => 45 font "Times-Roman" fill_color "ff0000" text "Overcoming singular font limitation", :at => [5,5] examples/simple_text.rb @@ -6,7 +6,7 @@ require "prawn" Prawn::Document.generate "hello-ttf.pdf" do fill_color "0000ff" font "#{Prawn::BASEDIR}/data/fonts/comicsans.ttf" - text "Hello World", :at => [200,720], :size => 32 + text "Hello World", :at => [200,720], :size => 32 font "#{Prawn::BASEDIR}/data/fonts/Chalkboard.ttf" examples/simple_text_ttf.rb @@ -1,37 +1,41 @@ # encoding: utf-8 - + # prawn.rb : A library for PDF generation in Ruby # -# Copyright April 2008, Gregory Brown. All Rights Reserved. +# Copyright April 2008, Gregory Brown. All Rights Reserved. # # This is free software. Please see the LICENSE and COPYING files for details. -%w[font_ttf].each do |dep| +%w[ttfunk/lib].each do |dep| $LOAD_PATH.unshift(File.dirname(__FILE__) + "/../vendor/#{dep}") end - -require 'ttf' - -module Prawn + +require 'ttfunk' + +module Prawn file = __FILE__ file = File.readlink(file) if File.symlink?(file) dir = File.dirname(file) # The base source directory for Prawn as installed on the system - BASEDIR = File.expand_path(File.join(dir, '..')) + BASEDIR = File.expand_path(File.join(dir, '..')) - VERSION = "0.2.3.99" + VERSION = "0.3.0" extend self - def verify_options(accepted,actual) #:nodoc: + attr_accessor :debug + + def verify_options(accepted,actual) #:nodoc: + return unless debug || $DEBUG require "set" unless (act=Set[*actual.keys]).subset?(acc=Set[*accepted]) - raise Prawn::Errors::UnknownOption, + raise Prawn::Errors::UnknownOption, "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" << "Accepted options are: #{accepted.inspect}" - end - end + end + yield if block_given? + end module Configurable #:nodoc: def configuration(*args) @@ -41,16 +45,16 @@ module Prawn elsif args.length > 1 @config.values_at(*args) elsif args.length == 1 - @config[args[0]] - else - @config + @config[args[0]] + else + @config end - end + end alias_method :C, :configuration end -end - +end + require "prawn/compatibility" require "prawn/errors" require "prawn/pdf_object" @@ -60,4 +64,6 @@ require "prawn/images/jpg" require "prawn/images/png" require "prawn/document" require "prawn/reference" -require "prawn/font" \ No newline at end of file +require "prawn/font" +require "prawn/encoding" +require "prawn/measurements" \ No newline at end of file lib/prawn.rb @@ -9,19 +9,23 @@ require "stringio" require "prawn/document/page_geometry" require "prawn/document/bounding_box" -require "prawn/document/text" +require "prawn/document/text" require "prawn/document/table" require "prawn/document/internals" require "prawn/document/span" +require "prawn/document/annotations" +require "prawn/document/destinations" module Prawn class Document include Prawn::Document::Internals - include Prawn::Graphics + include Prawn::Document::Annotations + include Prawn::Document::Destinations + include Prawn::Graphics include Prawn::Images - include Text - include PageGeometry + include Text + include PageGeometry attr_accessor :y, :margin_box attr_reader :margins, :page_size, :page_layout @@ -65,6 +69,7 @@ module Prawn # <tt>:bottom_margin</tt>:: Sets the bottom margin in points [0.5 inch] # <tt>:skip_page_creation</tt>:: Creates a document without starting the first page [false] # <tt>:compress</tt>:: Compresses content streams before rendering them [false] + # <tt>:background</tt>:: An image path to be used as background on all pages [nil] # # Usage: # @@ -74,19 +79,23 @@ module Prawn # # New document, A4 paper, landscaped # pdf = Prawn::Document.new(:page_size => "A4", :page_layout => :landscape) # + # # New document, with background + # pdf = Prawn::Document.new(:background => "#{Prawn::BASEDIR}/data/images/pigs.jpg") + # def initialize(options={},&block) Prawn.verify_options [:page_size, :page_layout, :left_margin, :right_margin, :top_margin, :bottom_margin, :skip_page_creation, - :compress, :skip_encoding, :text_options ], options + :compress, :skip_encoding, :text_options, :background ], options @objects = [] @info = ref(:Creator => "Prawn", :Producer => "Prawn") - @pages = ref(:Type => :Pages, :Count => 0, :Kids => []) - @root = ref(:Type => :Catalog, :Pages => @pages) + @pages = ref(:Type => :Pages, :Count => 0, :Kids => []) + @root = ref(:Type => :Catalog, :Pages => @pages) @page_size = options[:page_size] || "LETTER" @page_layout = options[:page_layout] || :portrait @compress = options[:compress] || false @skip_encoding = options[:skip_encoding] + @background = options[:background] text_options.update(options[:text_options] || {}) @@ -132,7 +141,9 @@ module Prawn add_content "q" - @y = @bounding_box.absolute_top + @y = @bounding_box.absolute_top + + image(@background, :at => [0,@y]) if @background end # Returns the number of pages in the document @@ -145,6 +156,13 @@ module Prawn def page_count @pages.data[:Count] end + + # The current y drawing position relative to the innermost bounding box, + # or to the page margins at the top level. + # + def cursor + y - bounds.absolute_bottom + end # Renders the PDF document to string # @@ -268,7 +286,7 @@ module Prawn :Parent => @pages, :MediaBox => page_dimensions, :Contents => @page_content) - font.add_to_current_page if @font_name + font.add_to_current_page if @font update_colors end lib/prawn/document.rb @@ -135,6 +135,15 @@ module Prawn ) end end + + # A bounding box with the same dimensions of its parents, minus a margin + # on all sides + # + def padded_box(margin, &block) + bounding_box [bounds.left + margin, bounds.top - margin], + :width => bounds.width - (margin * 2), + :height => bounds.height - (margin * 2), &block + end # A header is a LazyBoundingBox drawn relative to the margins that can be # repeated on every page of the document. lib/prawn/document/bounding_box.rb @@ -7,7 +7,6 @@ module Prawn # are you won't need anything you find here. # module Internals - # Creates a new Prawn::Reference and adds it to the Document's object # list. The +data+ argument is anything that Prawn::PdfObject() can convert. def ref(data) @@ -50,6 +49,13 @@ module Prawn page_resources[:XObject] ||= {} end + # The Name dictionary (PDF spec 3.6.3) for this document. It is + # lazily initialized, so that documents that do not need a name + # dictionary do not incur the additional overhead. + def names + @root.data[:Names] ||= ref(:Type => :Names) + end + private def finish_page_content @@ -104,4 +110,4 @@ module Prawn end end -end \ No newline at end of file +end lib/prawn/document/internals.rb @@ -9,70 +9,71 @@ module Prawn class Document module PageGeometry - + # Dimensions pulled from PDF::Writer, rubyforge.org/projects/ruby-pdf - SIZES = { "4A0" => [4767.87, 6740.79], - "2A0" => [3370.39, 4767.87], - "A0" => [2383.94, 3370.39], - "A1" => [1683.78, 2383.94], - "A2" => [1190.55, 1683.78], - "A3" => [841.89, 1190.55], - "A4" => [595.28, 841.89], - "A5" => [419.53, 595.28], - "A6" => [297.64, 419.53], - "A7" => [209.76, 297.64], - "A8" => [147.40, 209.76], - "A9" => [104.88, 147.40], - "A10" => [73.70, 104.88], - "B0" => [2834.65, 4008.19], - "B1" => [2004.09, 2834.65], - "B2" => [1417.32, 2004.09], - "B3" => [1000.63, 1417.32], - "B4" => [708.66, 1000.63], - "B5" => [498.90, 708.66], - "B6" => [354.33, 498.90], - "B7" => [249.45, 354.33], - "B8" => [175.75, 249.45], - "B9" => [124.72, 175.75], - "B10" => [87.87, 124.72], - "C0" => [2599.37, 3676.54], - "C1" => [1836.85, 2599.37], - "C2" => [1298.27, 1836.85], - "C3" => [918.43, 1298.27], - "C4" => [649.13, 918.43], - "C5" => [459.21, 649.13], - "C6" => [323.15, 459.21], - "C7" => [229.61, 323.15], - "C8" => [161.57, 229.61], - "C9" => [113.39, 161.57], - "C10" => [79.37, 113.39], - "RA0" => [2437.80, 3458.27], - "RA1" => [1729.13, 2437.80], - "RA2" => [1218.90, 1729.13], - "RA3" => [864.57, 1218.90], - "RA4" => [609.45, 864.57], - "SRA0" => [2551.18, 3628.35], - "SRA1" => [1814.17, 2551.18], - "SRA2" => [1275.59, 1814.17], - "SRA3" => [907.09, 1275.59], - "SRA4" => [637.80, 907.09], - "LETTER" => [612.00, 792.00], - "LEGAL" => [612.00, 1008.00], - "FOLIO" => [612.00, 936.00], - "EXECUTIVE" => [521.86, 756.00] } - + SIZES = { "4A0" => [4767.87, 6740.79], + "2A0" => [3370.39, 4767.87], + "A0" => [2383.94, 3370.39], + "A1" => [1683.78, 2383.94], + "A2" => [1190.55, 1683.78], + "A3" => [841.89, 1190.55], + "A4" => [595.28, 841.89], + "A5" => [419.53, 595.28], + "A6" => [297.64, 419.53], + "A7" => [209.76, 297.64], + "A8" => [147.40, 209.76], + "A9" => [104.88, 147.40], + "A10" => [73.70, 104.88], + "B0" => [2834.65, 4008.19], + "B1" => [2004.09, 2834.65], + "B2" => [1417.32, 2004.09], + "B3" => [1000.63, 1417.32], + "B4" => [708.66, 1000.63], + "B5" => [498.90, 708.66], + "B6" => [354.33, 498.90], + "B7" => [249.45, 354.33], + "B8" => [175.75, 249.45], + "B9" => [124.72, 175.75], + "B10" => [87.87, 124.72], + "C0" => [2599.37, 3676.54], + "C1" => [1836.85, 2599.37], + "C2" => [1298.27, 1836.85], + "C3" => [918.43, 1298.27], + "C4" => [649.13, 918.43], + "C5" => [459.21, 649.13], + "C6" => [323.15, 459.21], + "C7" => [229.61, 323.15], + "C8" => [161.57, 229.61], + "C9" => [113.39, 161.57], + "C10" => [79.37, 113.39], + "RA0" => [2437.80, 3458.27], + "RA1" => [1729.13, 2437.80], + "RA2" => [1218.90, 1729.13], + "RA3" => [864.57, 1218.90], + "RA4" => [609.45, 864.57], + "SRA0" => [2551.18, 3628.35], + "SRA1" => [1814.17, 2551.18], + "SRA2" => [1275.59, 1814.17], + "SRA3" => [907.09, 1275.59], + "SRA4" => [637.80, 907.09], + "EXECUTIVE" => [521.86, 756.00], + "FOLIO" => [612.00, 936.00], + "LEGAL" => [612.00, 1008.00], + "LETTER" => [612.00, 792.00], + "TABLOID" => [792.00, 1224.00] } + def page_dimensions #:nodoc: coords = SIZES[page_size] || page_size - [0,0] + case(page_layout) + [0,0] + case(page_layout) when :portrait coords when :landscape - coords.reverse - else - raise Prawn::Errors::InvalidPageLayout, + coords.reverse + else + raise Prawn::Errors::InvalidPageLayout, "Layout must be either :portrait or :landscape" end - end - end + end + end end end lib/prawn/document/page_geometry.rb @@ -37,7 +37,14 @@ module Prawn # # end # + # Will raise <tt>Prawn::Errors::EmptyTable</tt> given + # a nil or empty <tt>data</tt> paramater. + # def table(data,options={}) + if data.nil? || data.empty? + raise Prawn::Errors::EmptyTable, + "data must be a non-empty, non-nil, two dimensional array of Prawn::Cells or strings" + end Prawn::Document::Table.new(data,self,options).draw end @@ -85,12 +92,13 @@ module Prawn # <tt>:vertical_padding</tt>:: The vertical cell padding in PDF points [5] # <tt>:padding</tt>:: Horizontal and vertical cell padding (overrides both) # <tt>:border_width</tt>:: With of border lines in PDF points [1] - # <tt>:border_style</tt>:: If set to :grid, fills in all borders. Otherwise, borders are drawn on columns only, not rows + # <tt>:border_style</tt>:: If set to :grid, fills in all borders. If set to :underline_header, underline header only. Otherwise, borders are drawn on columns only, not rows # <tt>:position</tt>:: One of <tt>:left</tt>, <tt>:center</tt> or <tt>n</tt>, where <tt>n</tt> is an x-offset from the left edge of the current bounding box # <tt>:widths:</tt> A hash of indices and widths in PDF points. E.g. <tt>{ 0 => 50, 1 => 100 }</tt> # <tt>:row_colors</tt>:: An array of row background colors which are used cyclicly. # <tt>:align</tt>:: Alignment of text in columns, for entire table (<tt>:center</tt>) or by column (<tt>{ 0 => :left, 1 => :center}</tt>) - # <tt>:align_headers</tt>:: Alignment of header text. + # <tt>:align_headers</tt>:: Alignment of header text. Specify for entire header (<tt>:left</tt>) or by column (<tt>{ 0 => :right, 1 => :left}</tt>). If omitted, the header alignment is the same as the column alignment. + # <tt>:minimum_rows</tt>:: The minimum rows to display on a page, including header. # # Row colors are specified as html encoded values, e.g. # ["ffffff","aaaaaa","ccaaff"]. You can also specify @@ -110,8 +118,9 @@ module Prawn @document = document Prawn.verify_options [:font_size,:border_style, :border_width, - :position, :headers, :row_colors, :align, :align_headers, - :horizontal_padding, :vertical_padding, :padding, :widths ], options + :position, :headers, :row_colors, :align, :align_headers, :header_text_color, :border_color, + :horizontal_padding, :vertical_padding, :padding, :widths, + :header_color ], options configuration.update(options) @@ -193,10 +202,12 @@ module Prawn @document.font.size C(:font_size) do renderable_data.each_with_index do |row,index| c = Prawn::Graphics::CellBlock.new(@document) - row.each_with_index do |e,i| + + col_index = 0 + row.each do |e| case C(:align) when Hash - align = C(:align)[i] + align = C(:align)[col_index] else align = C(:align) end @@ -207,7 +218,7 @@ module Prawn case e when Prawn::Graphics::Cell e.document = @document - e.width = @col_widths[i] + e.width = @col_widths[col_index] e.horizontal_padding = C(:horizontal_padding) e.vertical_padding = C(:vertical_padding) e.border_width = C(:border_width) @@ -215,28 +226,42 @@ module Prawn e.align = align c << e else + text = e.is_a?(Hash) ? e[:text] : e.to_s + width = if e.is_a?(Hash) && e.has_key?(:colspan) + @col_widths.slice(col_index, e[:colspan]).inject { |sum, width| sum + width } + else + @col_widths[col_index] + end + c << Prawn::Graphics::Cell.new( :document => @document, - :text => e.to_s, - :width => @col_widths[i], + :text => text, + :width => width, :horizontal_padding => C(:horizontal_padding), :vertical_padding => C(:vertical_padding), :border_width => C(:border_width), :border_style => :sides, :align => align ) - end + end + + col_index += (e.is_a?(Hash) && e.has_key?(:colspan)) ? e[:colspan] : 1 end bbox = @parent_bounds.stretchy? ? @document.margin_box : @parent_bounds if c.height > y_pos - bbox.absolute_bottom - draw_page(page_contents) - @document.start_new_page - if C(:headers) - page_contents = [page_contents[0]] - y_pos = @document.y - page_contents[0].height - else - page_contents = [] + if C(:headers) && page_contents.length == 1 + @document.start_new_page y_pos = @document.y + else + draw_page(page_contents) + @document.start_new_page + if C(:headers) && page_contents.any? + page_contents = [page_contents[0]] + y_pos = @document.y - page_contents[0].height + else + page_contents = [] + y_pos = @document.y + end end end @@ -254,29 +279,50 @@ module Prawn def draw_page(contents) return if contents.empty? - - if C(:border_style) == :grid || contents.length == 1 + + if C(:border_style) == :underline_header + contents.each { |e| e.border_style = :none } + contents.first.border_style = :bottom_only if C(:headers) + elsif C(:border_style) == :grid || contents.length == 1 contents.each { |e| e.border_style = :all } - else - if C(:headers) - contents.first.border_style = :all - contents.first.align = C(:align_headers) || :left - else - contents.first.border_style = :no_bottom + else + contents.first.border_style = C(:headers) ? :all : :no_bottom + contents.last.border_style = :no_top + end + + if C(:headers) + contents.first.cells.each_with_index do |e,i| + if C(:align_headers) + case C(:align_headers) + when Hash + align = C(:align_headers)[i] + else + align = C(:align_headers) + end + end + e.align = align if align + e.text_color = C(:header_text_color) if C(:header_text_color) + e.background_color = C(:header_color) if C(:header_color) end - contents.last.border_style = :no_top end - - contents.each do |x| - x.background_color = next_row_color if C(:row_colors) + + contents.each do |x| + unless x.background_color + x.background_color = next_row_color if C(:row_colors) + end + x.border_color = C(:border_color) if C(:border_color) + x.draw end - + reset_row_colors end + def next_row_color - C(:row_colors).unshift(C(:row_colors).pop).last + color = C(:row_colors).shift + C(:row_colors).push(color) + color end def reset_row_colors lib/prawn/document/table.rb @@ -6,6 +6,7 @@ # # This is free software. Please see the LICENSE and COPYING files for details. require "zlib" +require "prawn/document/text/box" module Prawn class Document @@ -37,15 +38,39 @@ module Prawn # text will be kerned by default. You can disable this feature by passing # <tt>:kerning => false</tt>. # - # === Character Encoding Details: + # === Text Positioning Details: + # + # FIXME: If we go with this of using ascender for TTF and font height + # For AFM, we need to document the sucker. + # + # When using the +:at+ parameter, Prawn will position your text by its + # baseline, and flow along a single line. + # + # When using automatic text flow, Prawn will position your text exactly + # font.height *below* the baseline, and space each line of text by + # font.height + options[:spacing] (default 0) + # + # Finally, the drawing position will be moved to the baseline of final + # line of text, plus any additional spacing. + # + # If you wish to position your flowing text by it's baseline rather + # than +font.height+ below, simply call <tt>move_up font.height</tt> + # before your call to text() + # + # == Rotation + # + # Text can be rotated before it is placed on the canvas by specifying the + # :rotate option. Rotation occurs counter-clockwise. + # + # == Encoding # # Note that strings passed to this function should be encoded as UTF-8. # If you get unexpected characters appearing in your rendered document, # check this. # # If the current font is a built-in one, although the string must be - # encoded as UTF-8, only characters that are available in ISO-8859-1 - # are allowed (transliteration will be attempted). + # encoded as UTF-8, only characters that are available in WinAnsi + # are allowed. # # If an empty box is rendered to your PDF instead of the character you # wanted it usually means the current font doesn't include that character. @@ -67,6 +92,9 @@ module Prawn x,y = translate(options[:at]) font.size(options[:size]) { add_text_content(text,x,y,options) } else + if options[:rotate] + raise ArgumentError, "Rotated text may only be used with :at" + end wrapped_text(text,options) end @@ -86,7 +114,7 @@ module Prawn def process_text_options(options) Prawn.verify_options [:style, :kerning, :size, :at, :wrap, - :spacing, :align ], options + :spacing, :align, :rotate ], options if options[:style] raise "Bad font family" unless font.family @@ -117,8 +145,12 @@ module Prawn lines = text.lines - lines.each do |e| - move_text_position( font.height + font.descender ) + lines.each do |e| + if font.metrics.type0? + move_text_position(font.ascender) + else + move_text_position(font.height) + end line_width = font.width_of(e) case(options[:align]) @@ -132,27 +164,33 @@ module Prawn end add_text_content(e,x,y,options) - move_text_position(options[:spacing] || -font.descender ) + + if font.metrics.type0? + move_text_position(font.height - font.ascender) + end + + move_text_position(options[:spacing]) if options[:spacing] end end end - + def add_text_content(text, x, y, options) text = font.metrics.convert_text(text,options) - add_content %Q{ - BT - /#{font.identifier} #{font.size} Tf - #{x} #{y} Td - } - + add_content "\nBT" + add_content "/#{font.identifier} #{font.size} Tf" + if options[:rotate] + rad = options[:rotate].to_i * Math::PI / 180 + arr = [ Math.cos(rad), Math.sin(rad), -Math.sin(rad), Math.cos(rad), x, y ] + add_content "%.3f %.3f %.3f %.3f %.3f %.3f Tm" % arr + else + add_content "#{x} #{y} Td" + end + rad = 1.570796 add_content Prawn::PdfObject(text, true) << - " #{options[:kerning] ? 'TJ' : 'Tj'}\n" - - add_content %Q{ - ET - } - end + " #{options[:kerning] ? 'TJ' : 'Tj'}" + add_content "ET\n" + end end end end lib/prawn/document/text.rb @@ -39,6 +39,10 @@ module Prawn # This error is raised when table data is malformed # class InvalidTableData < StandardError; end + + # This error is raised when an empty or nil table is rendered + # + class EmptyTable < StandardError; end end end lib/prawn/errors.rb @@ -7,7 +7,8 @@ require "prawn/font/cmap" module Prawn class Document - # Sets the current font. + # Without arguments, this returns the currently selected font. Otherwise, + # it sets the current font. # # The single parameter must be a string. It can be one of the 14 built-in # fonts supported by PDF, or the location of a TTF file. The BUILT_INS @@ -22,19 +23,35 @@ module Prawn # more portable. # def font(name=nil, options={}) - if name - if font_families.key?(name) - ff = name - name = font_families[name][options[:style] || :normal] - end - Prawn::Font.register(name,:for => self, :family => ff) unless font_registry[name] - font_registry[name].add_to_current_page - @font_name = name - elsif @font_name.nil? - Prawn::Font.register("Helvetica", :for => self, :family => "Helvetica") - @font_name = "Helvetica" - end - font_registry[@font_name] + return @font || font("Helvetica") if name.nil? + + if block_given? + original_name = font.name + original_size = font.size + end + + @font = find_font(name, options) + @font.add_to_current_page + + @font.size = options[:size] if options[:size] + + if block_given? + yield + font(original_name, :size => original_size) + else + @font + end + end + + # Looks up the given font name. Once a font has been found by that name, + # it will be cached to subsequent lookups for that font will return the + # same object. + def find_font(name, options={}) #:nodoc: + if font_families.key?(name) + family, name = name, font_families[name][options[:style] || :normal] + end + + font_registry[name] ||= Font.new(name, options.merge(:for => self, :family => family)) end # Hash of Font objects keyed by names @@ -94,10 +111,6 @@ module Prawn DEFAULT_SIZE = 12 - def self.register(name,options={}) #:nodoc: - options[:for].font_registry[name] = Font.new(name,options) - end - # The font metrics object attr_reader :metrics @@ -125,16 +138,13 @@ module Prawn @document.proc_set :PDF, :Text @size = DEFAULT_SIZE @identifier = :"F#{@document.font_registry.size + 1}" - - case(name) - when /\.ttf$/i - embed_ttf(name) - else - register_builtin(name) - end - - add_to_current_page - end + + @reference = nil + end + + def inspect + "Prawn::Font< #{name}: #{size} >" + end # Sets the default font size for use within a block. Individual overrides # can be used as desired. The previous font size will be restored after the @@ -166,6 +176,9 @@ module Prawn # Gets width of string in PDF points at current font size # + # If using an AFM, string *must* be encoded as WinAnsi + # (Use normalize_encoding to convert) + # def width_of(string) @metrics.string_width(string,@size) end @@ -173,6 +186,9 @@ module Prawn # Gets height of text in PDF points at current font size. # Text +:line_width+ must be specified in PDF points. # + # If using an AFM, string *must* be encoded as WinAnsi + # (Use normalize_encoding to convert) + # def height_of(text,options={}) @metrics.string_height( text, :font_size => @size, :line_width => options[:line_width] ) @@ -195,6 +211,10 @@ module Prawn def descender @metrics.descender / 1000.0 * @size end + + def line_gap + @metrics.line_gap / 1000.0 * @size + end def normalize_encoding(text) # :nodoc: # check the string is encoded sanely @@ -208,23 +228,25 @@ module Prawn end def add_to_current_page #:nodoc: + embed! unless @reference @document.page_fonts.merge!(@identifier => @reference) end private - - # built-in fonts only work with latin encoding, so translate the string - def normalize_builtin_encoding(text) - if text.respond_to?(:encode!) - text.encode!("ISO-8859-1") + + def embed! + case(name) + when /\.ttf$/i + embed_ttf(name) else - require 'iconv' - text.replace Iconv.conv('ISO-8859-1//TRANSLIT', 'utf-8', text) - end - rescue - raise Prawn::Errors::IncompatibleStringEncoding, "When using a " + - "builtin font, only characters that exist in " + - "WinAnsi/ISO-8859-1 are allowed." + register_builtin(name) + end + end + + # built-in fonts only work with winansi encoding, so translate the string + def normalize_builtin_encoding(text) + enc = Prawn::Encoding::WinAnsi.new + text.replace text.unpack("U*").collect { |i| enc[i] }.pack("C*") end def normalize_ttf_encoding(text) @@ -275,7 +297,7 @@ module Prawn raise "Can't detect a postscript name for #{file}" if basename.nil? - @encodings = @metrics.enc_table + @encodings = @metrics.cmap if @encodings.nil? raise "#{file} missing the required encoding table" lib/prawn/font.rb @@ -9,6 +9,8 @@ # # This is free software. Please see the LICENSE and COPYING files for details. +require 'prawn/encoding' + module Prawn class Font class Metrics #:nodoc: @@ -33,37 +35,6 @@ module Prawn end class Adobe < Metrics #:nodoc: - - ISOLatin1Encoding = %w[ - .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef - .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef - .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef - .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef space - exclam quotedbl numbersign dollar percent ampersand quoteright - parenleft parenright asterisk plus comma minus period slash zero one - two three four five six seven eight nine colon semicolon less equal - greater question at A B C D E F G H I J K L M N O P Q R S - T U V W X Y Z bracketleft backslash bracketright asciicircum - underscore quoteleft a b c d e f g h i j k l m n o p q r s - t u v w x y z braceleft bar braceright asciitilde .notdef .notdef - .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef - .notdef .notdef .notdef .notdef .notdef .notdef .notdef dotlessi grave - acute circumflex tilde macron breve dotaccent dieresis .notdef ring - cedilla .notdef hungarumlaut ogonek caron space exclamdown cent - sterling currency yen brokenbar section dieresis copyright ordfeminine - guillemotleft logicalnot hyphen registered macron degree plusminus - twosuperior threesuperior acute mu paragraph periodcentered cedilla - onesuperior ordmasculine guillemotright onequarter onehalf threequarters - questiondown Agrave Aacute Acircumflex Atilde Adieresis Aring AE - Ccedilla Egrave Eacute Ecircumflex Edieresis Igrave Iacute Icircumflex - Idieresis Eth Ntilde Ograve Oacute Ocircumflex Otilde Odieresis - multiply Oslash Ugrave Uacute Ucircumflex Udieresis Yacute Thorn - germandbls agrave aacute acircumflex atilde adieresis aring ae - ccedilla egrave eacute ecircumflex edieresis igrave iacute icircumflex - idieresis eth ntilde ograve oacute ocircumflex otilde odieresis divide - oslash ugrave uacute ucircumflex udieresis yacute thorn ydieresis - ] - attr_reader :attributes def initialize(font_name) @@ -85,7 +56,9 @@ module Prawn end # calculates the width of the supplied string. - # String *must* be encoded as iso-8859-1 + # + # String *must* be encoded as WinAnsi + # def string_width(string, font_size, options = {}) scale = font_size / 1000.0 @@ -107,7 +80,8 @@ module Prawn # converts a string into an array with spacing offsets # bewteen characters that need to be kerned # - # String *must* be encoded as iso-8859-1 + # String *must* be encoded as WinAnsi + # def kern(string) kerned = string.unpack("C*").inject([]) do |a,r| if a.last.is_a? Array @@ -131,14 +105,14 @@ module Prawn def latin_kern_pairs_table @kern_pairs_table ||= @kern_pairs.inject({}) do |h,p| - h[p[0].map { |n| ISOLatin1Encoding.index(n) }] = p[1] + h[p[0].map { |n| Encoding::WinAnsi::CHARACTERS.index(n) }] = p[1] h end end def latin_glyphs_table @glyphs_table ||= (0..255).map do |i| - @glyph_widths[ISOLatin1Encoding[i]].to_i + @glyph_widths[Encoding::WinAnsi::CHARACTERS[i]].to_i end end @@ -183,7 +157,7 @@ module Prawn # perform any changes to the string that need to happen # before it is rendered to the canvas # - # String *must* be encoded as iso-8859-1 + # String *must* be encoded as WinAnsi # def convert_text(text, options={}) options[:kerning] ? kern(text) : text @@ -199,44 +173,45 @@ module Prawn @metrics_path.join("\n") end - def parse_afm(file) + def parse_afm(file_name) section = [] - - File.open(file,"rb") do |file| - - file.each do |line| - if line =~ /^Start(\w+)/ - section.push $1 - next - elsif line =~ /^End(\w+)/ - section.pop - next - end - - if section == ["FontMetrics", "CharMetrics"] - next unless line =~ /^CH?\s/ - - name = line[/\bN\s+(\.?\w+)\s*;/, 1] - @glyph_widths[name] = line[/\bWX\s+(\d+)\s*;/, 1].to_i - @bounding_boxes[name] = line[/\bB\s+([^;]+);/, 1].to_s.rstrip - elsif section == ["FontMetrics", "KernData", "KernPairs"] - next unless line =~ /^KPX\s+(\.?\w+)\s+(\.?\w+)\s+(-?\d+)/ - @kern_pairs[[$1, $2]] = $3.to_i - elsif section == ["FontMetrics", "KernData", "TrackKern"] - next - elsif section == ["FontMetrics", "Composites"] - next - elsif line =~ /(^\w+)\s+(.*)/ - key, value = $1.to_s.downcase, $2 - - @attributes[key] = @attributes[key] ? - Array(@attributes[key]) << value : value - else - warn "Can't parse: #{line}" - end + + File.foreach(file_name) do |line| + case line + when /^Start(\w+)/ + section.push $1 + next + when /^End(\w+)/ + section.pop + next end - end - end + + case section + when ["FontMetrics", "CharMetrics"] + next unless line =~ /^CH?\s/ + + name = line[/\bN\s+(\.?\w+)\s*;/, 1] + @glyph_widths[name] = line[/\bWX\s+(\d+)\s*;/, 1].to_i + @bounding_boxes[name] = line[/\bB\s+([^;]+);/, 1].to_s.rstrip + when ["FontMetrics", "KernData", "KernPairs"] + next unless line =~ /^KPX\s+(\.?\w+)\s+(\.?\w+)\s+(-?\d+)/ + @kern_pairs[[$1, $2]] = $3.to_i + when ["FontMetrics", "KernData", "TrackKern"], + ["FontMetrics", "Composites"] + next + else + parse_generic_afm_attribute(line) + end + end + end + + def parse_generic_afm_attribute(line) + line =~ /(^\w+)\s+(.*)/ + key, value = $1.to_s.downcase, $2 + + @attributes[key] = @attributes[key] ? + Array(@attributes[key]) << value : value + end end class TTF < Metrics #:nodoc: @@ -244,18 +219,18 @@ module Prawn attr_accessor :ttf def initialize(font) - @ttf = ::Font::TTF::File.open(font,"rb") + @ttf = TTFunk::File.new(font) @attributes = {} @glyph_widths = {} @bounding_boxes = {} @char_widths = {} - @has_kerning_data = !kern_pairs_table.empty? + @has_kerning_data = !! @ttf.kern? && @ttf.kern.sub_tables[0] end def cmap - @cmap ||= enc_table.charmaps + @cmap ||= @ttf.cmap.formats[4] end - + def string_width(string, font_size, options = {}) scale = font_size / 1000.0 if options[:kerning] @@ -298,9 +273,7 @@ module Prawn i = r.is_a?(Array) ? r.pack("U*") : r x = if i.is_a?(String) unicode_codepoints = i.unpack("U*") - glyph_codes = unicode_codepoints.map { |u| - enc_table.get_glyph_id_for_unicode(u) - } + glyph_codes = unicode_codepoints.map { |u| cmap[u] } glyph_codes.pack("n*") else i @@ -313,7 +286,7 @@ module Prawn def glyph_widths glyphs = cmap.values.uniq.sort first_glyph = glyphs.shift - widths = [first_glyph, [Integer(hmtx[first_glyph][0] * scale_factor)]] + widths = [first_glyph, [Integer(hmtx[first_glyph][0] * scale_factor)]] prev_glyph = first_glyph glyphs.each do |glyph| unless glyph == prev_glyph + 1 @@ -327,38 +300,25 @@ module Prawn end def bbox - head = @ttf.get_table(:head) [:x_min, :y_min, :x_max, :y_max].map do |atr| - Integer(head.send(atr)) * scale_factor + Integer(@ttf.head.send(atr)) * scale_factor end end def ascender - Integer(@ttf.get_table(:hhea).ascender * scale_factor) + Integer(@ttf.hhea.ascent * scale_factor) end def descender - Integer(@ttf.get_table(:hhea).descender * scale_factor) + Integer(@ttf.hhea.descent * scale_factor) end def line_gap - Integer(@ttf.get_table(:hhea).line_gap * scale_factor) + Integer(@ttf.hhea.line_gap * scale_factor) end def basename - return @basename if @basename - ps_name = ::Font::TTF::Table::Name::NameRecord::POSTSCRIPT_NAME - - @ttf.get_table(:name).name_records.each do |rec| - @basename = rec.utf8_str.to_sym if rec.name_id == ps_name - end - @basename - end - - def enc_table - @enc_table ||= @ttf.get_table(:cmap).encoding_tables.find do |t| - t.class == ::Font::TTF::Table::Cmap::EncodingTable4 - end + @basename ||= @ttf.name.postscript_name end # TODO: instead of creating a map that contains every glyph in the font, @@ -375,20 +335,7 @@ module Prawn end def kern_pairs_table - return @kern_pairs_table if @kern_pairs_table - - table = @ttf.get_table(:kern).subtables.find { |s| - s.is_a? ::Font::TTF::Table::Kern::KerningSubtable0 } - - if table - @kern_pairs_table = table.kerning_pairs.inject({}) do |h,p| - h[[p.left, p.right]] = p.value; h - end - else - @kern_pairs_table = {} - end - rescue ::Font::TTF::TableMissing - @kern_pairs_table = {} + @kerning_data ||= has_kerning_data? ? @ttf.kern.sub_tables[0] : {} end def has_kerning_data? @@ -404,18 +351,16 @@ module Prawn if options[:kerning] kern(text) else - unicode_codepoints = text.unpack("U*") - glyph_codes = unicode_codepoints.map { |u| - enc_table.get_glyph_id_for_unicode(u) - } + unicode_codepoints = text.unpack("U*") + glyph_codes = unicode_codepoints.map { |u| cmap[u] } text = glyph_codes.pack("n*") end end - + private def hmtx - @hmtx ||= @ttf.get_table(:hmtx).metrics + @hmtx ||= @ttf.hmtx.values end def character_width_by_code(code) @@ -424,7 +369,7 @@ module Prawn end def scale_factor - @scale ||= 1000 * Float(@ttf.get_table(:head).units_per_em)**-1 + @scale ||= 1000 * Float(@ttf.head.units_per_em)**-1 end end lib/prawn/font/metrics.rb @@ -7,25 +7,25 @@ # This is free software. Please see the LICENSE and COPYING files for details. require "enumerator" -require "prawn/graphics/cell" +require "prawn/graphics/cell" require "prawn/graphics/color" module Prawn - # Implements the drawing facilities for Prawn::Document. + # Implements the drawing facilities for Prawn::Document. # Use this to draw the most beautiful imaginable things. - # + # # This file lifts and modifies several of PDF::Writer's graphics functions # ruby-pdf.rubyforge.org # - module Graphics - + module Graphics + include Color - + ####################################################################### # Low level drawing operations must translate to absolute coords! # ####################################################################### - + # Moves the drawing position to a given point. The point can be # specified as a tuple or a flattened argument list # @@ -33,50 +33,50 @@ module Prawn # pdf.move_to(100,50) # def move_to(*point) - x,y = translate(point) + x,y = translate(point) add_content("%.3f %.3f m" % [ x, y ]) end - + # Draws a line from the current drawing position to the specified point. - # The destination may be described as a tuple or a flattened list: + # The destination may be described as a tuple or a flattened list: # - # pdf.line_to [50,50] - # pdf.line_to(50,50) + # pdf.line_to [50,50] + # pdf.line_to(50,50) # - def line_to(*point) + def line_to(*point) x,y = translate(point) - add_content("%.3f %.3f l" % [ x, y ]) - end - - # Draws a Bezier curve from the current drawing position to the + add_content("%.3f %.3f l" % [ x, y ]) + end + + # Draws a Bezier curve from the current drawing position to the # specified point, bounded by two additional points. - # - # pdf.curve_to [100,100], :bounds => [[90,90],[75,75]] # - def curve_to(dest,options={}) - options[:bounds] or raise Prawn::Errors::InvalidGraphicsPath, + # pdf.curve_to [100,100], :bounds => [[90,90],[75,75]] + # + def curve_to(dest,options={}) + options[:bounds] or raise Prawn::Errors::InvalidGraphicsPath, "Bounding points for bezier curve must be specified "+ - "as :bounds => [[x1,y1],[x2,y2]]" + "as :bounds => [[x1,y1],[x2,y2]]" curve_points = (options[:bounds] << dest).map { |e| translate(e) } - add_content("%.3f %.3f %.3f %.3f %.3f %.3f c" % - curve_points.flatten ) - end - - # Draws a rectangle given <tt>point</tt>, <tt>width</tt> and + add_content("%.3f %.3f %.3f %.3f %.3f %.3f c" % + curve_points.flatten ) + end + + # Draws a rectangle given <tt>point</tt>, <tt>width</tt> and # <tt>height</tt>. The rectangle is bounded by its upper-left corner. # # pdf.rectangle [300,300], 100, 200 - # + # def rectangle(point,width,height) x,y = translate(point) - add_content("%.3f %.3f %.3f %.3f re" % [ x, y - height, width, height ]) + add_content("%.3f %.3f %.3f %.3f re" % [ x, y - height, width, height ]) end - + ########################################################### - # Higher level functions: May use relative coords # - ########################################################### - + # Higher level functions: May use relative coords # + ########################################################### + # Sets line thickness to the <tt>width</tt> specified. # def line_width=(width) @@ -93,24 +93,33 @@ module Prawn @line_width || 1 end end - - # Draws a line from one point to another. Points may be specified as + + # Draws a line from one point to another. Points may be specified as # tuples or flattened argument list: # - # pdf.line [100,100], [200,250] + # pdf.line [100,100], [200,250] # pdf.line(100,100,200,250) # def line(*points) x0,y0,x1,y1 = points.flatten move_to(x0, y0) line_to(x1, y1) - end + end # Draws a horizontal line from <tt>x1</tt> to <tt>x2</tt> at the - # current <tt>y</tt> position. + # current <tt>y</tt> position, or the position specified by the :at option. # - def horizontal_line(x1,x2) - line(x1,y-bounds.absolute_bottom,x2,y-bounds.absolute_bottom) + # # draw a line from [25, 75] to [100, 75] + # horizontal_line 25, 100, :at => 75 + # + def horizontal_line(x1,x2,options={}) + if options[:at] + y1 = options[:at] + else + y1 = y - bounds.absolute_bottom + end + + line(x1,y1,x2,y1) end # Draws a horizontal line from the left border to the right border of the @@ -120,115 +129,124 @@ module Prawn horizontal_line(bounds.left, bounds.right) end - # Draws a vertical line at the given x position from y1 to y2. - # - def vertical_line_at(x,y1,y2) - line(x,y1,x,y2) + # Draws a vertical line at the x cooordinate given by :at from y1 to y2. + # + # # draw a line from [25, 100] to [25, 300] + # vertical_line 100, 300, :at => 25 + # + def vertical_line(y1,y2,params) + line(params[:at],y1,params[:at],y2) end - + # Draws a Bezier curve between two points, bounded by two additional # points # - # pdf.curve [50,100], [100,100], :bounds => [[90,90],[75,75]] + # pdf.curve [50,100], [100,100], :bounds => [[90,90],[75,75]] # def curve(origin,dest, options={}) - move_to *origin + move_to(*origin) curve_to(dest,options) end # This constant is used to approximate a symmetrical arc using a cubic - # Bezier curve. + # Bezier curve. # KAPPA = 4.0 * ((Math.sqrt(2) - 1.0) / 3.0) - + # Draws a circle of radius <tt>:radius</tt> with the centre-point at <tt>point</tt> # as a complete subpath. The drawing point will be moved to the - # centre-point upon completion of the drawing the circle. - # - # pdf.circle_at [100,100], :radius => 25 + # centre-point upon completion of the drawing the circle. + # + # pdf.circle_at [100,100], :radius => 25 # - def circle_at(point, options) + def circle_at(point, options) x,y = point - ellipse_at [x, y], options[:radius] - end - + ellipse_at [x, y], options[:radius] + end + # Draws an ellipse of +x+ radius <tt>r1</tt> and +y+ radius <tt>r2</tt> # with the centre-point at <tt>point</tt> as a complete subpath. The # drawing point will be moved to the centre-point upon completion of the - # drawing the ellipse. - # + # drawing the ellipse. + # # # draws an ellipse with x-radius 25 and y-radius 50 - # pdf.ellipse_at [100,100], 25, 50 + # pdf.ellipse_at [100,100], 25, 50 # - def ellipse_at(point, r1, r2 = r1) + def ellipse_at(point, r1, r2 = r1) x, y = point l1 = r1 * KAPPA - l2 = r2 * KAPPA - + l2 = r2 * KAPPA + move_to(x + r1, y) - + # Upper right hand corner - curve_to [x, y + r2], + curve_to [x, y + r2], :bounds => [[x + r1, y + l1], [x + l2, y + r2]] - # Upper left hand corner - curve_to [x - r1, y], - :bounds => [[x - l2, y + r2], [x - r1, y + l1]] - + # Upper left hand corner + curve_to [x - r1, y], + :bounds => [[x - l2, y + r2], [x - r1, y + l1]] + # Lower left hand corner - curve_to [x, y - r2], - :bounds => [[x - r1, y - l1], [x - l2, y - r2]] + curve_to [x, y - r2], + :bounds => [[x - r1, y - l1], [x - l2, y - r2]] # Lower right hand corner curve_to [x + r1, y], - :bounds => [[x + l2, y - r2], [x + r1, y - l1]] - + :bounds => [[x + l2, y - r2], [x + r1, y - l1]] + move_to(x, y) end - + # Draws a polygon from the specified points. - # + # # # draws a snazzy triangle - # pdf.polygon [100,100], [100,200], [200,200] + # pdf.polygon [100,100], [100,200], [200,200] # - def polygon(*points) + def polygon(*points) move_to points[0] (points << points[0]).each_cons(2) do |p1,p2| line_to(*p2) end end - + # Strokes and closes the current path. See Graphic::Color for color details # def stroke yield if block_given? add_content "S" end + + # Draws and strokes a rectangle represented by the current bounding box + # + def stroke_bounds + stroke_rectangle bounds.top_left, bounds.width, bounds.height + end # Fills and closes the current path. See Graphic::Color for color details # - def fill + def fill yield if block_given? add_content "f" end # Fills, strokes, and closes the current path. See Graphic::Color for color details # - def fill_and_stroke + def fill_and_stroke yield if block_given? - add_content "b" - end - - private - + add_content "b" + end + + private + def translate(*point) x,y = point.flatten [@bounding_box.absolute_left + x, @bounding_box.absolute_bottom + y] - end - + end + def translate!(point) point.replace(translate(point)) - end + end end end lib/prawn/graphics.rb @@ -42,23 +42,29 @@ module Prawn # <tt>:document</tt>:: The Prawn::Document object to render on. # <tt>:text</tt>:: The text to be flowed within the cell # <tt>:width</tt>:: The width in PDF points of the cell. - # <tt>:border</tt>:: The border line width. If omitted, no border will be drawn. + # <tt>:height</tt>:: The height in PDF points of the cell. # <tt>:horizontal_padding</tt>:: The horizontal padding in PDF points # <tt>:vertical_padding</tt>:: The vertical padding in PDF points # <tt>:padding</tt>:: Overrides both horizontal and vertical padding - # <tt>:border_style</tt>:: One of <tt>:all</tt>, <tt>:no_top</tt>, <tt>:no_bottom</tt>, <tt>:sides</tt> # <tt>:align</tt>:: One of <tt>:left</tt>, <tt>:right</tt>, <tt>:center</tt> + # <tt>:borders</tt>:: An array of sides which should have a border. Any of <tt>:top</tt>, <tt>:left</tt>, <tt>:right</tt>, <tt>:bottom</tt> + # <tt>:border_width</tt>:: The border line width. Defaults to 1. + # <tt>:border_style</tt>:: One of <tt>:all</tt>, <tt>:no_top</tt>, <tt>:no_bottom</tt>, <tt>:sides</tt>, <tt>:none</tt>, <tt>:bottom_only</tt>. Defaults to :all. # def initialize(options={}) @point = options[:point] @document = options[:document] @text = options[:text].to_s + @text_color = options[:text_color] @width = options[:width] + @height = options[:height] @borders = options[:borders] @border_width = options[:border_width] || 1 @border_style = options[:border_style] || :all + @border_color = options[:border_color] @background_color = options[:background_color] @align = options[:align] || :left + @font_size = options[:font_size] @horizontal_padding = options[:horizontal_padding] || 0 @vertical_padding = options[:vertical_padding] || 0 @@ -70,7 +76,7 @@ module Prawn attr_accessor :point, :border_style, :border_width, :background_color, :document, :horizontal_padding, :vertical_padding, :align, - :borders + :borders, :text_color, :border_color attr_writer :height, :width #:nodoc: @@ -90,7 +96,7 @@ module Prawn # def width @width || (@document.font.metrics.string_width(@text, - @document.font.size)) + 2*@horizontal_padding + @font_size || @document.font.size)) + 2*@horizontal_padding end # The height of the cell in PDF points @@ -125,26 +131,30 @@ module Prawn @document.mask(:line_width) do @document.line_width = @border_width - if borders.include?(:left) - @document.stroke_line [rel_point[0], rel_point[1] + (@border_width / 2.0)], - [rel_point[0], rel_point[1] - height - @border_width / 2.0 ] - end - - if borders.include?(:right) - @document.stroke_line( - [rel_point[0] + width, rel_point[1] + (@border_width / 2.0)], - [rel_point[0] + width, rel_point[1] - height - @border_width / 2.0] ) - end - - if borders.include?(:top) - @document.stroke_line( - [ rel_point[0] + @border_width / 2.0, rel_point[1] ], - [ rel_point[0] - @border_width / 2.0 + width, rel_point[1] ]) - end - - if borders.include?(:bottom) - @document.stroke_line [rel_point[0], rel_point[1] - height ], - [rel_point[0] + width, rel_point[1] - height] + @document.mask(:stroke_color) do + @document.stroke_color @border_color if @border_color + + if borders.include?(:left) + @document.stroke_line [rel_point[0], rel_point[1] + (@border_width / 2.0)], + [rel_point[0], rel_point[1] - height - @border_width / 2.0 ] + end + + if borders.include?(:right) + @document.stroke_line( + [rel_point[0] + width, rel_point[1] + (@border_width / 2.0)], + [rel_point[0] + width, rel_point[1] - height - @border_width / 2.0] ) + end + + if borders.include?(:top) + @document.stroke_line( + [ rel_point[0] + @border_width / 2.0, rel_point[1] ], + [ rel_point[0] - @border_width / 2.0 + width, rel_point[1] ]) + end + + if borders.include?(:bottom) + @document.stroke_line [rel_point[0], rel_point[1] - height ], + [rel_point[0] + width, rel_point[1] - height] + end end end @@ -157,7 +167,16 @@ module Prawn @point[1] - @vertical_padding], :width => text_area_width, :height => height - @vertical_padding) do - @document.text @text, :align => @align + @document.move_up @document.font.line_gap + + options = {:align => @align} + + options[:size] = @font_size if @font_size + + @document.mask(:fill_color) do + @document.fill_color @text_color if @text_color + @document.text @text, options + end end end @@ -173,6 +192,10 @@ module Prawn [:left,:right,:bottom] when :no_bottom [:left,:right,:top] + when :bottom_only + [:bottom] + when :none + [] end end @@ -189,8 +212,8 @@ module Prawn @height = 0 end - attr_reader :width, :height - attr_accessor :background_color + attr_reader :width, :height, :cells + attr_accessor :background_color, :text_color, :border_color def <<(cell) @cells << cell @@ -208,6 +231,8 @@ module Prawn y - @document.bounds.absolute_bottom] e.height = @height e.background_color ||= @background_color + e.text_color ||= @text_color + e.border_color ||= @border_color e.draw x += e.width end lib/prawn/graphics/cell.rb @@ -18,11 +18,13 @@ module Prawn # <tt>file</tt>:: path to file or an object that responds to #read # # Options: - # <tt>:at</tt>:: the location of the top left corner of the image. + # <tt>:at</tt>:: an array [x,y] with the location of the top left corner of the image. # <tt>:position</tt>:: One of (:left, :center, :right) or an x-offset + # <tt>:vposition</tt>:: One of (:top, :center, :center) or an y-offset # <tt>:height</tt>:: the height of the image [actual height of the image] # <tt>:width</tt>:: the width of the image [actual width of the image] - # <tt>:scale</tt>:: scale the dimensions of the image proportionally + # <tt>:scale</tt>:: scale the dimensions of the image proportionally + # <tt>:fit</tt>:: scale the dimensions of the image proportionally to fit inside [width,height] # # Prawn::Document.generate("image2.pdf", :page_layout => :landscape) do # pigs = "#{Prawn::BASEDIR}/data/images/pigs.jpg" @@ -36,6 +38,11 @@ module Prawn # proportionally. When both are provided, the image will be stretched to # fit the dimensions without maintaining the aspect ratio. # + # + # If :at is provided, the image will be place in the current page but + # the text position will not be changed. + # + # # If instead of an explicit filename, an object with a read method is # passed as +file+, you can embed images from IO objects and things # that act like them (including Tempfiles and open-uri objects). @@ -50,9 +57,10 @@ module Prawn # dimensions of an image object if needed. # (See also: Prawn::Images::PNG , Prawn::Images::JPG) # - def image(file, options={}) - Prawn.verify_options [:at,:position, :height, :width, :scale], options - + def image(file, options={}) + Prawn.verify_options [:at, :position, :vposition, :height, + :width, :scale, :fit], options + if file.respond_to?(:read) image_content = file.read else @@ -86,7 +94,8 @@ module Prawn # find where the image will be placed and how big it will be w,h = calc_image_dimensions(info, options) - if options[:at] + + if options[:at] x,y = translate(options[:at]) else x,y = image_position(w,h,options) @@ -109,6 +118,7 @@ module Prawn def image_position(w,h,options) options[:position] ||= :left + x = case options[:position] when :left bounds.absolute_left @@ -118,8 +128,20 @@ module Prawn bounds.absolute_right - w when Numeric options[:position] + bounds.absolute_left - end - + end + + y = case options[:vposition] + when :top + bounds.absolute_top + when :center + bounds.absolute_top - (bounds.height - h) / 2.0 + when :bottom + bounds.absolute_bottom + h + when Numeric + bounds.absolute_top - options[:vposition] + else + self.y + end return [x,y] end @@ -127,10 +149,12 @@ module Prawn color_space = case jpg.channels when 1 :DeviceGray + when 3 + :DeviceRGB when 4 :DeviceCMYK else - :DeviceRGB + raise ArgumentError, 'JPG uses an unsupported number of channels' end obj = ref(:Type => :XObject, :Subtype => :Image, @@ -140,6 +164,14 @@ module Prawn :Width => jpg.width, :Height => jpg.height, :Length => data.size ) + + # add extra decode params for CMYK images. By swapping the + # min and max values from the default, we invert the colours. See + # section 4.8.4 of the spec. + if color_space == :DeviceCMYK + obj.data[:Decode] = [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] + end + obj << data return obj end @@ -252,7 +284,6 @@ module Prawn end def calc_image_dimensions(info, options) - # TODO: allow the image to be aligned in a box w = options[:width] || info.width h = options[:height] || info.height @@ -267,8 +298,20 @@ module Prawn elsif options[:scale] w = info.width * options[:scale] h = info.height * options[:scale] + elsif options[:fit] + bw, bh = options[:fit] + bp = bw / bh.to_f + ip = info.width / info.height.to_f + if ip > bp + w = bw + h = bw / ip + else + h = bh + w = bh * ip + end end - + info.scaled_width = w + info.scaled_height = h [w,h] end lib/prawn/images.rb @@ -14,7 +14,8 @@ module Prawn # of a PNG image that we need to embed them in a PDF class JPG attr_reader :width, :height, :bits, :channels - + attr_accessor :scaled_width, :scaled_height + JPEG_SOF_BLOCKS = %W(\xc0 \xc1 \xc2 \xc3 \xc5 \xc6 \xc7 \xc9 \xca \xcb \xcd \xce \xcf) JPEG_APP_BLOCKS = %W(\xe0 \xe1 \xe2 \xe3 \xe4 \xe5 \xe6 \xe7 \xe8 \xe9 \xea \xeb \xec \xed \xee \xef) lib/prawn/images/jpg.rb @@ -19,7 +19,8 @@ module Prawn attr_reader :width, :height, :bits attr_reader :color_type, :compression_method, :filter_method attr_reader :interlace_method, :alpha_channel - + attr_accessor :scaled_width, :scaled_height + # Process a new PNG image # # <tt>:data</tt>:: A string containing a full PNG file lib/prawn/images/png.rb @@ -34,7 +34,10 @@ module Prawn when Numeric then String(obj) when Array "[" << obj.map { |e| PdfObject(e, in_content_stream) }.join(' ') << "]" - when String + when Prawn::LiteralString + obj = obj.gsub(/[\\\n]/) { |m| "\\#{m}" } + "(#{obj})" + when String obj = "\xFE\xFF" + obj.unpack("U*").pack("n*") unless in_content_stream "<" << obj.unpack("H*").first << ">" when Symbol @@ -57,6 +60,10 @@ module Prawn output << ">>" when Prawn::Reference obj.to_s + when Prawn::NameTree::Node + PdfObject(obj.to_hash) + when Prawn::NameTree::Value + PdfObject(obj.name) + " " + PdfObject(obj.value) else raise Prawn::Errors::FailedObjectConversion, "This object cannot be serialized to PDF" lib/prawn/pdf_object.rb @@ -1,6 +1,16 @@ # encoding: utf-8 -require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") +require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") + +describe "The cursor" do + it "should equal pdf.y - bounds.absolute_bottom" do + pdf = Prawn::Document.new + pdf.cursor.should == pdf.bounds.top + + pdf.y = 300 + pdf.cursor.should == pdf.y - pdf.bounds.absolute_bottom + end +end describe "When creating multi-page documents" do @@ -38,7 +48,23 @@ describe "When beginning each new page" do pdf.render call_count.should == 3 - end + end + describe "Background template feature" do + before(:each) do + @filename = "#{Prawn::BASEDIR}/data/images/pigs.jpg" + @pdf = Prawn::Document.new(:background => @filename) + end + it "should place a background image if it is in options block" do + output = @pdf.render + images = PDF::Inspector::XObject.analyze(output) + # there should be 2 images in the page resources + images.page_xobjects.first.size.should == 1 + end + it "should place a background image if it is in options block" do + @pdf.instance_variable_defined?(:@background).should == true + @pdf.instance_variable_get(:@background).should == @filename + end + end end @@ -84,6 +110,17 @@ describe "When ending each page" do pdf.render end + it "should result in a smaller file size when compressed" do + doc_uncompressed = Prawn::Document.new + doc_compressed = Prawn::Document.new(:compress => true) + [doc_compressed, doc_uncompressed].each do |pdf| + pdf.font "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf" + pdf.text "更可怕的是，同质化竞争对手可以按照URL中后面这个ID来遍历" * 10 + end + + doc_compressed.render.length.should.be < doc_uncompressed.render.length + end + end describe "When setting page size" do spec/document_spec.rb @@ -70,6 +70,28 @@ describe "font style support" do end +describe "Transactional font handling" do + before(:each) { create_pdf } + + it "should allow setting of size directly when font is created" do + @pdf.font "Courier", :size => 16 + @pdf.font.size.should == 16 + end + + it "should allow temporary setting of a new font using a transaction" do + original = @pdf.font + + @pdf.font "Courier", :size => 16 do + @pdf.font.name.should == "Courier" + @pdf.font.size.should == 16 + end + + @pdf.font.should == original + end + +end + + describe "Document#page_fonts" do before(:each) { create_pdf } spec/font_spec.rb @@ -1,58 +1,70 @@ # encoding: utf-8 -require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") - +require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") + describe "When drawing a line" do - + before(:each) { create_pdf } - + it "should draw a line from (100,600) to (100,500)" do @pdf.line([100,600],[100,500]) - + line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render) - - line_drawing.points.should == [[100,600],[100,500]] - end - + + line_drawing.points.should == [[100,600],[100,500]] + end + it "should draw two lines at (100,600) to (100,500) " + - "and (75,100) to (50,125)" do - @pdf.line(100,600,100,500) + "and (75,100) to (50,125)" do + @pdf.line(100,600,100,500) @pdf.line(75,100,50,125) - + line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render) - - line_drawing.points.should == + + line_drawing.points.should == [[100.0, 600.0], [100.0, 500.0], [75.0, 100.0], [50.0, 125.0]] end it "should properly set line width via line_width=" do @pdf.line_width = 10 - line = PDF::Inspector::Graphics::Line.analyze(@pdf.render) - line.widths.first.should == 10 - end - + line = PDF::Inspector::Graphics::Line.analyze(@pdf.render) + line.widths.first.should == 10 + end + it "should properly set line width via line_width(width)" do @pdf.line_width(10) - line = PDF::Inspector::Graphics::Line.analyze(@pdf.render) - line.widths.first.should == 10 - end - - describe "(Horizontally)" do - - before :each do - @pdf = Prawn::Document.new + line = PDF::Inspector::Graphics::Line.analyze(@pdf.render) + line.widths.first.should == 10 + end + + describe "(Horizontally)" do + it "should draw from [x1,pdf.y],[x2,pdf.y]" do @pdf.horizontal_line(100,150) @line = PDF::Inspector::Graphics::Line.analyze(@pdf.render) - end - - it "should draw from [x1,pdf.y],[x2,pdf.y]" do @line.points.should == [[100.0 + @pdf.bounds.absolute_left, @pdf.y], [150.0 + @pdf.bounds.absolute_left, @pdf.y]] - end - + end + + it "should draw a line from (200, 250) to (300, 250)" do + @pdf.horizontal_line(200,300,:at => 250) + line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render) + line_drawing.points.should == [[200,250],[300,250]] + end + end + + describe "(Vertically)" do + it "should draw a line from (350, 300) to (350, 400)" do + @pdf.vertical_line(300,400,:at => 350) + line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render) + line_drawing.points.should == [[350,300],[350,400]] + end + it "should require a y coordinate" do + lambda { @pdf.vertical_line(400,500) }. + should.raise(ArgumentError) + end end - -end + +end describe "When drawing a polygon" do @@ -61,11 +73,11 @@ describe "When drawing a polygon" do it "should draw each line passed to polygon()" do @pdf.polygon([100,500],[100,400],[200,400]) - line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render) + line_drawing = PDF::Inspector::Graphics::Line.analyze(@pdf.render) line_drawing.points.should == [[100,500],[100,400],[200,400],[100,500]] end -end +end describe "When drawing a rectangle" do @@ -83,53 +95,53 @@ describe "When drawing a rectangle" do end -end +end + +describe "When drawing a curve" do -describe "When drawing a curve" do - before(:each) { create_pdf } - + it "should draw a bezier curve from 50,50 to 100,100" do @pdf.move_to [50,50] @pdf.curve_to [100,100],:bounds => [[20,90], [90,70]] curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render) - curve.coords.should == [50.0, 50.0, 20.0, 90.0, 90.0, 70.0, 100.0, 100.0] - end - + curve.coords.should == [50.0, 50.0, 20.0, 90.0, 90.0, 70.0, 100.0, 100.0] + end + it "should draw a bezier curve from 100,100 to 50,50" do - @pdf.curve [100,100], [50,50], :bounds => [[20,90], [90,75]] - curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render) - curve.coords.should == [100.0, 100.0, 20.0, 90.0, 90.0, 75.0, 50.0, 50.0] + @pdf.curve [100,100], [50,50], :bounds => [[20,90], [90,75]] + curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render) + curve.coords.should == [100.0, 100.0, 20.0, 90.0, 90.0, 75.0, 50.0, 50.0] end - -end + +end describe "When drawing an ellipse" do - before(:each) do + before(:each) do create_pdf @pdf.ellipse_at [100,100], 25, 50 - @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render) - end - + @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render) + end + it "should move the pointer to the center of the ellipse after drawing" do @curve.coords[-2..-1].should == [100,100] - end - -end + end + +end describe "When drawing a circle" do - before(:each) do + before(:each) do create_pdf - @pdf.circle_at [100,100], :radius => 25 + @pdf.circle_at [100,100], :radius => 25 @pdf.ellipse_at [100,100], 25, 25 - @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render) - end - - it "should stroke the same path as the equivalent ellipse" do + @curve = PDF::Inspector::Graphics::Curve.analyze(@pdf.render) + end + + it "should stroke the same path as the equivalent ellipse" do middle = @curve.coords.length / 2 - @curve.coords[0...middle].should == @curve.coords[middle..-1] + @curve.coords[0...middle].should == @curve.coords[middle..-1] end -end +end describe "When setting colors" do @@ -144,54 +156,54 @@ describe "When setting colors" do it "should set fill colors" do @pdf.fill_color "ccff00" - colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) + colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) # 80% red, 100% green, 0% blue colors.fill_color.should == [0.8,1.0,0] - end - + end + it "should reset the colors on each new page if they have been defined" do @pdf.fill_color "ccff00" - colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) - - colors.fill_color_count.should == 2 + colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) + + colors.fill_color_count.should == 2 colors.stroke_color_count.should == 1 - @pdf.start_new_page - @pdf.stroke_color "ff00cc" - - colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) - colors.fill_color_count.should == 3 + @pdf.start_new_page + @pdf.stroke_color "ff00cc" + + colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) + colors.fill_color_count.should == 3 colors.stroke_color_count.should == 3 - + @pdf.start_new_page - colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) + colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render) colors.fill_color_count.should == 4 colors.stroke_color_count.should == 4 - + colors.fill_color.should == [0.8,1.0,0.0] - colors.stroke_color.should == [1.0,0.0,0.8] - end + colors.stroke_color.should == [1.0,0.0,0.8] + end end describe "When using painting shortcuts" do before(:each) { create_pdf } - + it "should convert stroke_some_method(args) into some_method(args); stroke" do @pdf.expects(:line_to).with([100,100]) @pdf.expects(:stroke) - + @pdf.stroke_line_to [100,100] - end - + end + it "should convert fill_some_method(args) into some_method(args); fill" do - @pdf.expects(:line_to).with([100,100]) + @pdf.expects(:line_to).with([100,100]) @pdf.expects(:fill) - + @pdf.fill_line_to [100,100] end - + it "should not break method_missing" do lambda { @pdf.i_have_a_pretty_girlfriend_named_jia }. - should.raise(NoMethodError) + should.raise(NoMethodError) end -end \ No newline at end of file +end spec/graphics_spec.rb @@ -17,7 +17,6 @@ describe "the image() function" do images = PDF::Inspector::XObject.analyze(output) # there should be 2 images in the page resources images.page_xobjects.first.size.should == 2 - # but only 1 image xobject output.scan(/\/Type \/XObject/).size.should == 1 end @@ -36,5 +35,34 @@ describe "the image() function" do info.height.should == 453 end + + describe ":fit option" do + it "should fit inside the defined constraints" do + info = @pdf.image @filename, :fit => [100,400] + info.scaled_width.should <= 100 + info.scaled_height.should <= 400 + + info = @pdf.image @filename, :fit => [400,100] + info.scaled_width.should <= 400 + info.scaled_height.should <= 100 + + info = @pdf.image @filename, :fit => [604,453] + info.scaled_width.should == 604 + info.scaled_height.should == 453 + end + it "should move text position" do + @y = @pdf.y + info = @pdf.image @filename, :fit => [100,400] + @pdf.y.should < @y + end + end + describe ":at option" do + it "should not move text position" do + @y = @pdf.y + info = @pdf.image @filename, :at => [100,400] + @pdf.y.should == @y + end + end + end spec/images_spec.rb @@ -1,12 +1,13 @@ # encoding: utf-8 -require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") +require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") +require "iconv" describe "adobe font metrics" do setup do @times = Prawn::Font::Metrics["Times-Roman"] - @iconv = Iconv.new('ISO-8859-1', 'utf-8') + @iconv = ::Iconv.new('ISO-8859-1', 'utf-8') end it "should calculate string width taking into account accented characters" do spec/metrics_spec.rb @@ -58,14 +58,15 @@ describe "PDF Object Serialization" do end it "should convert a Ruby array to PDF Array when outside a content stream" do + bar = "\xFE\xFF" + "Bar".unpack("U*").pack("n*") Prawn::PdfObject([1,2,3]).should == "[1 2 3]" PDF::Inspector.parse(Prawn::PdfObject([[1,2],:foo,"Bar"], false)).should == - [[1,2],:foo, "\xFE\xFF\x00B\x00a\x00r"] + [[1,2],:foo, bar] end it "should convert a Ruby hash to a PDF Dictionary when inside a content stream" do dict = Prawn::PdfObject( {:foo => :bar, - "baz" => [1,2,3], + "baz" => [1,2,3], :bang => {:a => "what", :b => [:you, :say] }}, true ) res = PDF::Inspector.parse(dict) @@ -77,15 +78,16 @@ describe "PDF Object Serialization" do end it "should convert a Ruby hash to a PDF Dictionary when outside a content stream" do + what = "\xFE\xFF" + "what".unpack("U*").pack("n*") dict = Prawn::PdfObject( {:foo => :bar, - "baz" => [1,2,3], + "baz" => [1,2,3], :bang => {:a => "what", :b => [:you, :say] }}, false ) res = PDF::Inspector.parse(dict) res[:foo].should == :bar res[:baz].should == [1,2,3] - res[:bang].should == { :a => "\xFE\xFF\x00w\x00h\x00a\x00t", :b => [:you, :say] } + res[:bang].should == { :a => what, :b => [:you, :say] } end @@ -98,5 +100,13 @@ describe "PDF Object Serialization" do ref = Prawn::Reference(1,true) Prawn::PdfObject(ref).should == ref.to_s end - + + it "should convert a NameTree::Node to a PDF hash" do + node = Prawn::NameTree::Node.new(Prawn::Document.new, 10) + node.add "hello", 1.0 + node.add "world", 2.0 + data = Prawn::PdfObject(node) + res = PDF::Inspector.parse(data) + res.should == {:Names => ["hello", 1.0, "world", 2.0]} + end end spec/pdf_object_spec.rb @@ -9,13 +9,15 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib') $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'vendor','pdf-inspector','lib') require "prawn" +Prawn.debug = true + gem 'pdf-reader', ">=0.7.3" require "pdf/reader" require "pdf/inspector" -def create_pdf - @pdf = Prawn::Document.new(:left_margin => 0, - :right_margin => 0, - :top_margin => 0, - :bottom_margin => 0) -end \ No newline at end of file +def create_pdf(klass=Prawn::Document) + @pdf = klass.new(:left_margin => 0, + :right_margin => 0, + :top_margin => 0, + :bottom_margin => 0) +end spec/spec_helper.rb @@ -75,6 +75,29 @@ end describe "A table's content" do + it "should not cause an error if rendering the very first row causes a page break" do + Prawn::Document.new( :page_layout => :portrait ) do + arr = Array(1..5).collect{|i| ["cell #{i}"] } + + move_down( y - (bounds.absolute_bottom + 3) ) + + lambda { + table( arr, + :font_size => 9, + :horizontal_padding => 3, + :vertical_padding => 3, + :border_width => 0.05, + :border_style => :none, + :row_colors => %w{ffffff eeeeee}, + :widths => {0 =>110}, + :position => :left, + :headers => ["exploding header"], + :align => :left, + :align_headers => :center) + }.should.not.raise + end + end + it "should output content cell by cell, row by row" do data = [["foo","bar"],["baz","bang"]] @pdf = Prawn::Document.new @@ -136,4 +159,21 @@ describe "An invalid table" do @pdf.table(@bad_data) end end + + it "should raise an EmptyTableError with empty table data" do + lambda { + data = [] + @pdf = Prawn::Document.new + @pdf.table(data) + }.should.raise( Prawn::Errors::EmptyTable ) + end + + it "should raise an EmptyTableError with nil table data" do + lambda { + data = nil + @pdf = Prawn::Document.new + @pdf.table(data) + }.should.raise( Prawn::Errors::EmptyTable ) + end + end spec/table_spec.rb @@ -112,23 +112,23 @@ describe "when drawing text" do it "should raise an exception when a utf-8 incompatible string is rendered" do str = "Blah \xDD" str.force_encoding("ASCII-8BIT") - lambda { @pdf.text str }.should.raise(Prawn::Errors::IncompatibleStringEncoding) + lambda { @pdf.text str }.should.raise(ArgumentError) end it "should not raise an exception when a shift-jis string is rendered" do datafile = "#{Prawn::BASEDIR}/data/shift_jis_text.txt" sjis_str = File.open(datafile, "r:shift_jis") { |f| f.gets } @pdf.font("#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf") - lambda { @pdf.text sjis_str }.should.not.raise(Prawn::Errors::IncompatibleStringEncoding) + lambda { @pdf.text sjis_str }.should.not.raise(ArgumentError) end else # Handle non utf-8 string encodings in a sane way on non-M17N aware VMs it "should raise an exception when a corrupt utf-8 string is rendered" do str = "Blah \xDD" - lambda { @pdf.text str }.should.raise(Prawn::Errors::IncompatibleStringEncoding) + lambda { @pdf.text str }.should.raise(ArgumentError) end it "should raise an exception when a shift-jis string is rendered" do sjis_str = File.read("#{Prawn::BASEDIR}/data/shift_jis_text.txt") - lambda { @pdf.text sjis_str }.should.raise(Prawn::Errors::IncompatibleStringEncoding) + lambda { @pdf.text sjis_str }.should.raise(ArgumentError) end end spec/text_spec.rb @@ -4,6 +4,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" /> <link href="prawn.css" rel="stylesheet" type="text/css" /> +<link href="twilight.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -26,7 +27,7 @@ </div> <h2>Building printable documents doesn't have to be hard</h2> -<img src="/media/prawn_logo.png" style="float: right;"> +<img src="media/prawn_logo.png" style="float: right;"> If you've ever needed to produce PDF documents before, in Ruby or another language, you probably know how much it can suck. Prawn takes the pain out of generating beautiful printable documents, while still remaining fast, tiny and nimble. It is also named after a majestic sea creature, and that has to count for something. @@ -43,8 +44,17 @@ a taste of what Prawn based programs looks like, <b Internationalized text in Prawn is as simple as providing UTF-8 strings for it to render, assuming you've got a Unicode aware TTF font handy. For those who are running on Ruby 1.9, any encoding that can be converted to UTF-8 will work out of the box! -<a href="media/utf8.pdf"><img src="media/utf8.png" style="padding-left: 1.5em;"/></a> - +<a href="media/utf8.pdf"> + + <pre class="textmate-source"><pre class="sunburst">Prawn::Document.generate("utf8.pdf") do + font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf" + text "ὕαλον ϕαγεῖν δύναμαι· τοῦτο οὔ με βλάπτει." * 20 +end +</pre></pre> + + +</a> + <h3>-- Easy image embedding</h3> @@ -52,7 +62,22 @@ Prawn makes embedding JPEG and PNG images a breeze. With support for alpha tran including all the graphics you need in your documents. -<a href="media/image.pdf"><img src="media/images.png" style="padding-left: 1.5em;"/></a> +<a href="media/image.pdf"> + + + + <pre class="textmate-source"><pre class="sunburst">Prawn::Document.generate("image2.pdf", :page_layout => :landscape) do + pigs = "#{Prawn::BASEDIR}/data/images/pigs.jpg" + image pigs, :at => [50,450], :width => 450 + + dice = "#{Prawn::BASEDIR}/data/images/dice.png" + image dice, :at => [50, 450], :scale => 0.75 +end +</pre></pre> + + + +</a> <h3>-- Flexible table drawing</h3> @@ -63,7 +88,27 @@ documents rather than forcing them to write a ton of low level graphics drawing code. -<a href="media/fancy_table.pdf"><img src="media/tables.png" style="padding-left: 1.5em;"/></a> +<a href="media/fancy_table.pdf"> + + + <pre class="textmate-source"><pre class="sunburst">Prawn::Document.generate("fancy_table.pdf") do + + data = [["Gregory Brown", "gregory.t.brown@fakemail.test" ], + ["James Healy" , "jimmy@fakemail.test" ], + ["Ross Perot" , "ross@fakemail.test" ], + ["Al Gore" , "al@fakemail.test" ], + ["Ralph Nader" , "ralph@fakemail.test" ]] + + table data, + :position => :center, + :headers => ["Name", "Email"], + :row_colors => ["ffffff","ffff00"], + :vertical_padding => 5, + :horizontal_padding => 3 +end +</pre></pre> + +</a> <h3>-- Simplified content positioning</h3> @@ -74,7 +119,34 @@ Text can also be flowed within these sectioned off bounding boxes, so this makes it trivial to generate columns of text on the fly. -<a href="media/bounding_boxes.pdf"><img src="media/bounding_boxes.png"/></a> +<a href="media/bounding_boxes.pdf"> +  + <pre class="textmate-source"><pre class="sunburst">Prawn::Document.generate("bounding_boxes.pdf") do + + bounding_box [100,600], :width => 200 do + text "The rain in spain falls mainly on the plains " * 5 + stroke do + line bounds.top_left, bounds.top_right + line bounds.bottom_left, bounds.bottom_right + end + end + + bounding_box [100,500], :width => 200, :height => 200 do + stroke do + circle_at [100,100], :radius => 100 + line bounds.top_left, bounds.bottom_right + line bounds.top_right, bounds.bottom_left + end + + bounding_box [50,150], :width => 100, :height => 100 do + stroke_rectangle bounds.top_left, bounds.width, bounds.height + end + end +end + </pre></pre> + +  +</a> <h3>-- And loads more to come</h3> www/index.html bugs/table_suppress_newline.rb vendor/font_ttf/ttf.rb vendor/font_ttf/ttf/datatypes.rb vendor/font_ttf/ttf/encodings.rb vendor/font_ttf/ttf/exceptions.rb vendor/font_ttf/ttf/file.rb vendor/font_ttf/ttf/fontchunk.rb vendor/font_ttf/ttf/table/cmap.rb vendor/font_ttf/ttf/table/cvt.rb vendor/font_ttf/ttf/table/fpgm.rb vendor/font_ttf/ttf/table/gasp.rb vendor/font_ttf/ttf/table/glyf.rb vendor/font_ttf/ttf/table/head.rb vendor/font_ttf/ttf/table/hhea.rb vendor/font_ttf/ttf/table/hmtx.rb vendor/font_ttf/ttf/table/kern.rb vendor/font_ttf/ttf/table/loca.rb vendor/font_ttf/ttf/table/maxp.rb vendor/font_ttf/ttf/table/name.rb vendor/font_ttf/ttf/table/os2.rb vendor/font_ttf/ttf/table/post.rb vendor/font_ttf/ttf/table/prep.rb vendor/font_ttf/ttf/table/vhea.rb vendor/font_ttf/ttf/table/vmtx.rb 97ccf8c5c73731e85b31721d0498f4fd207418b8 12b6d86f0c776d1bff574522fe23a41fb9701507 Gregory Brown gregory.t.brown@gmail.com http://github.com/sandal/prawn/commit/b9a29efbeadd596653c9bf30328e5ae086a72ebb b9a29efbeadd596653c9bf30328e5ae086a72ebb

2008-12-15T20:08:29-08:00

Resolve conflicts 3d83ce9a0e22e00e80a0f05a884e90263d8d8c18 Gregory Brown gregory.t.brown@gmail.com