prawn 0.11.1 → 0.15.0

data/{examples/m17n → manual/text}/win_ansi_charset.rb

@@ -7,18 +7,22 @@
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
-FONT_SIZE = 9.5
-
-Prawn::Document.generate("win-ansi.pdf") do
-  @skip_encoding = true
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Example.generate(filename) do
+  FONT_SIZE = 9.5
 
   x = 0
   y = bounds.top
 
-  fields = [[20, :right], [8, :left], [12, :center], [30, :right], [8, :left], [0, :left]]
+  fields = [[20, :right], [8, :left], [12, :center], [30, :right], [8, :left],
+            [0, :left]]
 
   font "Helvetica", :size => FONT_SIZE
 
+  move_down 30
+  text "(See next page for WinAnsi table)", :align => :center
+  start_new_page
+
   Prawn::Encoding::WinAnsi::CHARACTERS.each_with_index do |name, index|
     next if name == ".notdef"
     y -= FONT_SIZE
@@ -32,21 +36,21 @@ Prawn::Document.generate("win-ansi.pdf") do
     char = index.chr
 
     width = 1000 * width_of(char, :size => FONT_SIZE) / FONT_SIZE
-    size = "%d" % width
+    size  = "%d" % width
 
     data = [code, nil, char, size, nil, name]
-    dx = x
+    dx   = x
     fields.zip(data).each do |(total_width, align), field|
       if field
         width = width_of(field, :size => FONT_SIZE)
 
         case align
-        when :left then offset = 0
-        when :right then offset = total_width - width
+        when :left   then offset = 0
+        when :right  then offset = total_width - width
         when :center then offset = (total_width - width)/2
         end
 
-        draw_text(field, :at => [dx + offset, y])
+        text_box(field, :at => [dx + offset, y], :skip_encoding => true)
       end
 
       dx += total_width

data/prawn.gemspec

@@ -1,27 +1,37 @@
-# Version numbering: http://wiki.github.com/sandal/prawn/development-roadmap
-PRAWN_VERSION = "0.11.1"
-
 Gem::Specification.new do |spec|
   spec.name = "prawn"
-  spec.version = PRAWN_VERSION
+  spec.version = File.read(File.expand_path('VERSION', File.dirname(__FILE__))).strip
   spec.platform = Gem::Platform::RUBY
   spec.summary = "A fast and nimble PDF generator for Ruby"
-  spec.files =  Dir.glob("{examples,lib,spec,data}/**/**/*") +
-                      ["Rakefile", "prawn.gemspec"]
+  spec.files =  Dir.glob("{examples,lib,spec,manual}/**/**/*") +
+                Dir.glob("data/{encodings,images,pdfs}/*") +
+                Dir.glob("data/fonts/{MustRead.html,*.afm}") +
+                ["data/shift_jis_text.txt"] +
+                ["Rakefile", "prawn.gemspec", "Gemfile",
+                 "COPYING", "LICENSE", "GPLv2", "GPLv3",
+                 ".yardopts"]
   spec.require_path = "lib"
-  spec.required_ruby_version = '>= 1.8.7'
+  spec.required_ruby_version = '>= 1.9.3'
   spec.required_rubygems_version = ">= 1.3.6"
 
-  spec.test_files = Dir[ "test/*_test.rb" ]
-  spec.has_rdoc = true
-  spec.extra_rdoc_files = %w{HACKING README LICENSE COPYING}
-  spec.rdoc_options << '--title' << 'Prawn Documentation' <<
-                       '--main'  << 'README' << '-q'
-  spec.authors = ["Gregory Brown","Brad Ediger","Daniel Nelson","Jonathen Greenberg","James Healy"]
+  spec.test_files = Dir[ "spec/*_spec.rb" ]
+  spec.authors = ["Gregory Brown","Brad Ediger","Daniel Nelson","Jonathan Greenberg","James Healy"]
   spec.email = ["gregory.t.brown@gmail.com","brad@bradediger.com","dnelson@bluejade.com","greenberg@entryway.net","jimmy@deefa.com"]
   spec.rubyforge_project = "prawn"
-  spec.add_dependency('pdf-reader', '>=0.9.0')
-  spec.add_dependency('ttfunk', '~>1.0.0')
+  spec.licenses = ['RUBY', 'GPL-2', 'GPL-3']
+
+  spec.add_dependency('ttfunk', '~> 1.1.0')
+  spec.add_dependency('pdf-core', "~> 0.1.3")
+
+  spec.add_development_dependency('pdf-inspector', '~> 1.1.0')
+  spec.add_development_dependency('coderay', '~> 1.0.7')
+  spec.add_development_dependency('yard')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('mocha')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('simplecov')
+  spec.add_development_dependency('pdf-reader', '~>1.2')
+
   spec.homepage = "http://prawn.majesticseacreature.com"
   spec.description = <<END_DESC
   Prawn is a fast, tiny, and nimble PDF generator for Ruby
@@ -31,11 +41,11 @@ END_DESC
   ********************************************
 
 
-  A lot has changed since 0.8.4
+  A lot has changed recently in Prawn.
 
   Please read the changelog for details:
 
-  https://github.com/sandal/prawn/wiki/CHANGELOG
+  https://github.com/prawnpdf/prawn/wiki/CHANGELOG
 
 
   ********************************************

data/spec/acceptance/png.rb

@@ -0,0 +1,23 @@
+require_relative "../../lib/prawn"
+
+images = [
+      ["Type 0", "#{Prawn::BASEDIR}/data/images/web-links.png"],
+      ["Type 2", "#{Prawn::BASEDIR}/data/images/ruport.png"],
+      ["Type 3", "#{Prawn::BASEDIR}/data/images/indexed_color.png"],
+      ["Type 4", "#{Prawn::BASEDIR}/data/images/page_white_text.png"],
+      ["Type 6", "#{Prawn::BASEDIR}/data/images/dice.png"],
+]
+
+Prawn::Document.generate("png_types.pdf", :page_size => "A5") do
+  images.each do |header, file|
+    start_new_page unless header.include?("0")
+
+    fill_color "FF0000"
+
+    fill_rectangle bounds.top_left, bounds.width, bounds.height
+    text header 
+    
+    image file, :at => [50,450]
+  end 
+end
+

data/spec/annotations_spec.rb

@@ -1,35 +1,19 @@
 # encoding: utf-8
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
-                               
-class PageAnnotations
-  attr_reader :pages
-
-  def self.parse(document)
-    receiver = new
-    PDF::Reader.string(document.render, receiver)
-    return receiver
-  end
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
-  def initialize
-    @pages = []
-  end
 
-  def begin_page(params)
-    @pages << params
-  end
-end
+describe "When creating annotations" do
 
-describe "When creating annotations" do 
- 
   before(:each) { create_pdf }
-  
-  it "should append annotation to current page" do 
+
+  it "should append annotation to current page" do
     @pdf.start_new_page
     @pdf.annotate(:Rect => [0,0,10,10], :Subtype => :Text, :Contents => "Hello world!")
-    obj = PageAnnotations.parse(@pdf)
-    obj.pages[0][:Annots].nil?.should == true
-    obj.pages[1][:Annots].length.should == 1
+    PDF::Reader.open(StringIO.new(@pdf.render)) do |pdf|
+      pdf.page(1).attributes[:Annots].should be_nil
+      pdf.page(2).attributes[:Annots].size.should == 1
+    end
   end
 
   it "should force :Type to be :Annot" do
@@ -42,14 +26,14 @@ describe "When creating annotations" do
 end
 
 describe "When creating text annotations" do
- 
+
   before(:each) do
     @rect = [0,0,10,10]
     @content = "Hello, world!"
     create_pdf
   end
-  
-  it "should build appropriate annotation" do 
+
+  it "should build appropriate annotation" do
     opts = @pdf.text_annotation(@rect, @content)
     opts[:Type].should == :Annot
     opts[:Subtype].should == :Text
@@ -57,7 +41,7 @@ describe "When creating text annotations" do
     opts[:Contents].should == @content
   end
 
-  it "should merge extra options" do 
+  it "should merge extra options" do
     opts = @pdf.text_annotation(@rect, @content, :Open => true, :Subtype => :Bogus)
     opts[:Subtype].should == :Text
     opts[:Open].should == true
@@ -66,14 +50,14 @@ describe "When creating text annotations" do
 end
 
 describe "When creating link annotations" do
- 
+
   before(:each) do
     @rect = [0,0,10,10]
     @dest = "home"
     create_pdf
   end
-  
-  it "should build appropriate annotation" do 
+
+  it "should build appropriate annotation" do
     opts = @pdf.link_annotation(@rect, :Dest => @dest)
     opts[:Type].should == :Annot
     opts[:Subtype].should == :Link
@@ -81,7 +65,7 @@ describe "When creating link annotations" do
     opts[:Dest].should == @dest
   end
 
-  it "should merge extra options" do 
+  it "should merge extra options" do
     opts = @pdf.link_annotation(@rect, :Dest => @dest, :Subtype => :Bogus)
     opts[:Subtype].should == :Link
     opts[:Dest].should == @dest

data/spec/bounding_box_spec.rb

@@ -84,7 +84,14 @@ describe "A bounding box" do
   it "should require width to be set" do
     lambda do
       Prawn::Document::BoundingBox.new(nil, nil, [100,100])
-    end.should.raise(ArgumentError)
+    end.should raise_error(ArgumentError)
+  end
+
+  it "should raise_error an ArgumentError if a block is not passed" do
+    pdf = Prawn::Document.new
+    lambda do
+      pdf.bounding_box([0, 0], :width => 200)
+    end.should raise_error(ArgumentError)
   end
 
 end
@@ -93,6 +100,15 @@ describe "drawing bounding boxes" do
 
   before(:each) { create_pdf }
 
+  it "should not stomp on the arguments to bounding_box" do
+    pdf = Prawn::Document.new
+    x = [100, 500]
+    pdf.bounding_box x, :width => 100 do
+      pdf.text "bork-bork-bork"
+    end
+    x.should == [100, 500]
+  end
+
   it "should restore the margin box when bounding box exits" do
     margin_box = @pdf.bounds
 
@@ -128,7 +144,7 @@ describe "drawing bounding boxes" do
       @pdf.text "The rain in Spain falls mainly on the plains."
     end
 
-    @pdf.y.should.be.close 458.384, 0.001
+    @pdf.y.should be_within(0.001).of(458.384)
   end
 
   it "should keep track of the max height the box was stretched to" do
@@ -140,6 +156,43 @@ describe "drawing bounding boxes" do
     box.height.should == 100
   end
 
+  it "should advance the y-position by bbox.height by default" do
+    orig_y = @pdf.y
+    @pdf.bounding_box [0, @pdf.cursor], :width => @pdf.bounds.width,
+        :height => 30 do
+      @pdf.text "hello"
+    end
+    @pdf.y.should be_within(0.001).of(orig_y - 30)
+  end
+
+  it "should not advance y-position if passed :hold_position => true" do
+    orig_y = @pdf.y
+    @pdf.bounding_box [0, @pdf.cursor], :width => @pdf.bounds.width,
+        :hold_position => true do
+      @pdf.text "hello"
+    end
+    # y only advances by height of one line ("hello")
+    @pdf.y.should be_within(0.001).of(orig_y - @pdf.height_of("hello"))
+  end
+
+  it "should not advance y-position of a stretchy bbox if it would stretch " +
+     "the bbox further" do
+    bottom = @pdf.y = @pdf.margin_box.absolute_bottom
+    @pdf.bounding_box [0, @pdf.margin_box.top], :width => @pdf.bounds.width do
+      @pdf.y = bottom
+      @pdf.text "hello" # starts a new page
+    end
+    @pdf.page_count.should == 2
+
+    # Restoring the position (to the absolute bottom) would stretch the bbox to
+    # the bottom of the page, which we don't want. This should be equivalent to
+    # a bbox with :hold_position => true, where we only advance by the amount
+    # that was actually drawn.
+    @pdf.y.should be_within(0.001).of(
+      @pdf.margin_box.absolute_top - @pdf.height_of("hello")
+    )
+  end
+
 end
 
 describe "Indentation" do
@@ -209,6 +262,111 @@ describe "Indentation" do
       @pdf.bounds.width.should == 200
     end
   end
+
+  describe "in a ColumnBox" do
+    it "should subtract the given indentation from the available width" do
+      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width,
+                      :height => 200, :columns => 2, :spacer => 20) do
+        width = @pdf.bounds.width
+        @pdf.indent(20) do
+          @pdf.bounds.width.should be_within(0.01).of(width - 20)
+        end
+      end
+    end
+
+    it "should subtract right padding from the available width" do
+      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width,
+                      :height => 200, :columns => 2, :spacer => 20) do
+        width = @pdf.bounds.width
+        @pdf.indent(20, 30) do
+          @pdf.bounds.width.should be_within(0.01).of(width - 50)
+        end
+      end
+    end
+
+    it "should maintain the same left indentation across column breaks" do
+      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
+        3.times do |column|
+          x = @pdf.bounds.left_side
+          @pdf.indent(20) do
+            @pdf.bounds.left_side.should == x+20
+          end
+          @pdf.bounds.move_past_bottom
+        end
+      end
+    end
+
+    it "should not change the right margin if only left indentation is requested" do
+      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
+        3.times do |column|
+          x = @pdf.bounds.right_side
+          @pdf.indent(20) do
+            @pdf.bounds.right_side.should == x
+          end
+          @pdf.bounds.move_past_bottom
+        end
+      end
+    end
+
+    it "should maintain the same right indentation across columns" do
+      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
+        3.times do |column|
+          x = @pdf.bounds.right_side
+          @pdf.indent(20, 10) do
+            @pdf.bounds.right_side.should == x-10
+          end
+          @pdf.bounds.move_past_bottom
+        end
+      end
+    end
+
+    it "should keep the right indentation after nesting indents" do
+      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
+        3.times do |column|
+          # I am giving a right indent of 10...
+          @pdf.indent(20, 10) do
+            x = @pdf.bounds.right_side
+            # ...and no right indent here...
+            @pdf.indent(20) do
+              # right indent is inherited from the parent!
+              @pdf.bounds.right_side.should == x
+            end
+          end
+          @pdf.bounds.move_past_bottom
+        end
+      end
+    end
+
+    it "should revert the right indentation if negative indent is given in nested indent" do
+      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
+        3.times do |column|
+          x = @pdf.bounds.right_side
+          @pdf.indent(20, 10) do
+            # requesting a negative right-indent of equivalent size...
+            @pdf.indent(20, -10) do
+              # ...resets the right margin to that of the column!
+              @pdf.bounds.right_side.should == x
+            end
+          end
+          @pdf.bounds.move_past_bottom
+        end
+      end
+    end
+
+    it "should reduce the available column width by the sum of all nested indents" do
+      @pdf.column_box([0, @pdf.cursor], :width => @pdf.bounds.width, :columns => 3, :spacer => 15) do
+        3.times do |column|
+          w = @pdf.bounds.width
+          @pdf.indent(20, 10) do
+            @pdf.indent(20, 10) do
+              @pdf.bounds.width.should == w - 60
+            end
+          end
+          @pdf.bounds.move_past_bottom
+        end
+      end
+    end
+  end
 end
 
 describe "A canvas" do
@@ -220,4 +378,128 @@ describe "A canvas" do
     end
     @pdf.y.should == 450
   end
+
+  it "should restore the original ypos after execution", :issue => 523 do
+    doc = Prawn::Document.new(:skip_page_creation => true)
+    doc.start_new_page
+
+    original_ypos = doc.y
+
+    doc.canvas {}
+
+    doc.y.should == original_ypos
+  end
+
+end
+
+describe "Deep-copying" do
+  it "should create a new object that does not copy @document" do
+    Prawn::Document.new do |pdf|
+      orig = pdf.bounds
+      copy = orig.deep_copy
+
+      copy.should_not == pdf.bounds
+      copy.document.should be_nil
+    end
+  end
+
+  it "should deep-copy parent bounds" do
+    Prawn::Document.new do |pdf|
+      outside = pdf.bounds
+      pdf.bounding_box [100, 100], :width => 100 do
+        copy = pdf.bounds.deep_copy
+
+        # the parent bounds should have the same parameters
+        copy.parent.width.should  == outside.width
+        copy.parent.height.should == outside.height
+
+        # but should not be the same object
+        copy.parent.should_not == outside
+      end
+    end
+  end
+end
+
+describe "Prawn::Document#reference_bounds" do
+  before(:each) { create_pdf }
+
+  it "should return self for non-stretchy bounds" do
+    @pdf.bounding_box([0, @pdf.cursor], :width => 100, :height => 100) do
+      @pdf.reference_bounds.should == @pdf.bounds
+    end
+  end
+
+  it "should return the parent bounds if in a stretchy box" do
+    @pdf.bounding_box([0, @pdf.cursor], :width => 100, :height => 100) do
+      correct_bounds = @pdf.bounds
+      @pdf.bounding_box([0, @pdf.cursor], :width => 100) do
+        @pdf.reference_bounds.should == correct_bounds
+      end
+    end
+  end
+
+  it "should find the non-stretchy box through 2 levels" do
+    @pdf.bounding_box([0, @pdf.cursor], :width => 100, :height => 100) do
+      correct_bounds = @pdf.bounds
+      @pdf.bounding_box([0, @pdf.cursor], :width => 100) do
+        @pdf.bounding_box([0, @pdf.cursor], :width => 100) do
+          @pdf.reference_bounds.should == correct_bounds
+        end
+      end
+    end
+  end
+
+  it "should return the margin box if there's no explicit bbox" do
+    @pdf.reference_bounds.should == @pdf.margin_box
+
+    @pdf.bounding_box([0, @pdf.cursor], :width => 100) do
+      @pdf.reference_bounds.should == @pdf.margin_box
+    end
+  end
+
+  it "should return the canvas box if we're in a canvas" do
+    @pdf.canvas do
+      canvas_box = @pdf.bounds
+
+      @pdf.reference_bounds.should == canvas_box
+
+      @pdf.bounding_box([0, @pdf.cursor], :width => 100) do
+        @pdf.reference_bounds.should == canvas_box
+      end
+    end
+  end
+
+end
+
+describe "BoundingBox#move_past_bottom" do
+  before(:each) { create_pdf }
+
+  it "should ordinarily start a new page" do
+    @pdf.bounds.move_past_bottom
+    @pdf.text "Foo"
+
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+    pages.size.should == 2
+    pages[0][:strings].should == []
+    pages[1][:strings].should == ["Foo"]
+  end
+
+  it "should move to the top of the next page if it exists already" do
+    # save away the y-position at the top of a page
+    top_y = @pdf.y
+
+    # create a blank page but go to the page before it
+    @pdf.start_new_page
+    @pdf.go_to_page 1
+    @pdf.text "Foo"
+
+    @pdf.bounds.move_past_bottom
+    @pdf.y.should be_within(0.001).of(top_y)
+    @pdf.text "Bar"
+
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+    pages.size.should == 2
+    pages[0][:strings].should == ["Foo"]
+    pages[1][:strings].should == ["Bar"]
+  end
 end