prawn-layout 0.2.1 → 0.3.1

data/vendor/prawn-core/spec/text_box_spec.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "A text box" do
+
+  before(:each) do
+    create_pdf    
+    @x      = 100
+    @y      = 125
+    @width  = 50
+    @height = @pdf.font.height * 10
+    @text = "Oh hai text box. " * 200    
+  end
+
+  it "should have a truncated text" do
+    @overflow = :truncate
+    create_text_box
+    @box.render
+    @box.text.should == "Oh hai\ntext box.\n" * 5
+  end
+
+  it "render should return truncated text (NOTE: which may have had its whitespace mangled by wrap/unwrap)" do
+    @text = "Oh hai text box. " * 25
+    @overflow = :truncate
+    create_text_box
+    excess_text = @box.render
+    excess_text.should == "Oh hai text box. " * 20
+  end
+
+  it "render should attempt to preserve double newlines in excess text before returning it" do
+    line  = "Oh hai text box. "
+    @text = line * 10 + "\n\n" + line * 10
+    @overflow = :truncate
+    create_text_box
+    excess_text = @box.render
+    excess_text.should == line * 5 + "\n\n" + line * 10
+  end
+
+  it "render should attempt to preserve single newlines in excess text before returning it" do
+    line  = "Oh hai text box. "
+    @text = line * 10 + "\n" + line * 10
+    @overflow = :truncate
+    create_text_box
+    excess_text = @box.render
+    excess_text.should == line * 5 + "\n" + line * 10
+  end
+
+  it "should have a height equal to @height" do
+    @overflow = :truncate    
+    create_text_box
+    @box.render    
+    @box.height.should == @height     
+  end
+
+  it "should add ... to for overflow :ellipses" do
+    @overflow = :ellipses
+    @height = @pdf.font.height * 2
+    @text = "Oh hai text box.\n" * 4
+    create_text_box
+    @box.render
+    @box.text.should == "Oh hai\ntext bo..."
+  end
+
+  it "should not fail if height is smaller than 1 line" do
+    @text = "a b c d e fgi"
+    @width = 30
+    @height = @pdf.font.height * 0.5
+    @overflow = :ellipses    
+    create_text_box
+    @box.render
+    @box.text.should == ""
+  end
+
+  it "should keep text intact for overflow :expand" do
+    @overflow = :expand
+    @text = "Oh hai text box.\n" * 4
+    @height = 0
+    create_text_box
+    @box.render
+    @box.text.should == "Oh hai\ntext box.\n" * 4    
+    @box.height.should == 0
+  end
+  
+  def create_text_box
+    @box = Prawn::Document::Text::Box.new(@text,
+                                          :width    => @width, :height => @height,
+                                          :overflow => @overflow,
+                                          :at       => [@x, @y],
+                                          :for      => @pdf)    
+  end
+end
+
+describe "drawing bounding boxes" do    
+  
+  before(:each) { create_pdf }   
+
+  it "should restore the margin box when bounding box exits" do
+    margin_box = @pdf.bounds
+
+    @pdf.text_box "Oh hai text box. " * 11, :height => @pdf.font.height * 10
+
+    @pdf.bounds.should == margin_box
+
+  end
+  
+end
+
+  

data/vendor/prawn-core/spec/text_spec.rb

@@ -0,0 +1,185 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")      
+
+describe "when drawing text" do     
+   
+   before(:each) { create_pdf } 
+
+   it "should advance down the document based on font_height" do
+     position = @pdf.y
+     @pdf.text "Foo"
+
+     @pdf.y.should.be.close(position - @pdf.font.height, 0.0001)
+
+     position = @pdf.y
+     @pdf.text "Foo\nBar\nBaz"
+     @pdf.y.should.be.close(position - 3*@pdf.font.height, 0.0001)
+   end
+   
+   it "should advance down the document based on font ascender only "+
+      "if final_gap is given" do
+     position = @pdf.y
+     @pdf.text "Foo", :final_gap => false
+
+     @pdf.y.should.be.close(position - @pdf.font.ascender, 0.0001)
+
+     position = @pdf.y
+     @pdf.text "Foo\nBar\nBaz", :final_gap => false
+     @pdf.y.should.be.close(position - 2*@pdf.font.height - @pdf.font.ascender, 0.0001)
+   end
+
+   it "should not accept :align alongside :at" do
+     assert_raises(ArgumentError) do
+       @pdf.text "What could this mean?", :at => [100, 100], :align => :center
+     end
+   end
+
+   it "should default to 12 point helvetica" do
+      @pdf.text "Blah", :at => [100,100]              
+      text = PDF::Inspector::Text.analyze(@pdf.render)  
+      text.font_settings[0][:name].should == :Helvetica
+      text.font_settings[0][:size].should == 12   
+      text.strings.first.should == "Blah"
+   end   
+   
+   it "should allow setting font size" do
+     @pdf.text "Blah", :at => [100,100], :size => 16
+     text = PDF::Inspector::Text.analyze(@pdf.render)  
+     text.font_settings[0][:size].should == 16
+   end
+   
+   it "should allow setting a default font size" do
+     @pdf.font_size = 16
+     @pdf.text "Blah"
+     text = PDF::Inspector::Text.analyze(@pdf.render)  
+     text.font_settings[0][:size].should == 16
+   end
+
+   it "should allow setting font size in DSL style" do
+     @pdf.font_size 20
+     @pdf.font_size.should == 20
+   end
+   
+   it "should allow overriding default font for a single instance" do
+     @pdf.font_size = 16
+
+     @pdf.text "Blah", :size => 11
+     @pdf.text "Blaz"
+     text = PDF::Inspector::Text.analyze(@pdf.render)  
+     text.font_settings[0][:size].should == 11
+     text.font_settings[1][:size].should == 16
+   end
+   
+   it "should allow setting a font size transaction with a block" do
+     @pdf.font_size 16 do
+       @pdf.text 'Blah'
+     end
+
+     @pdf.text 'blah'
+
+     text = PDF::Inspector::Text.analyze(@pdf.render)  
+     text.font_settings[0][:size].should == 16
+     text.font_settings[1][:size].should == 12
+   end
+   
+   it "should allow manual setting the font size " +
+       "when in a font size block" do
+     @pdf.font_size(16) do
+        @pdf.text 'Foo'
+        @pdf.text 'Blah', :size => 11
+        @pdf.text 'Blaz'
+      end
+      text = PDF::Inspector::Text.analyze(@pdf.render)  
+      text.font_settings[0][:size].should == 16
+      text.font_settings[1][:size].should == 11
+      text.font_settings[2][:size].should == 16
+   end
+      
+   it "should allow registering of built-in font_settings on the fly" do
+     @pdf.font "Times-Roman"
+     @pdf.text "Blah", :at => [100,100]
+     @pdf.font "Courier"                    
+     @pdf.text "Blaz", :at => [150,150]
+     text = PDF::Inspector::Text.analyze(@pdf.render)                      
+     text.font_settings[0][:name].should == :"Times-Roman"  
+     text.font_settings[1][:name].should == :Courier
+   end   
+
+   it "should utilise the same default font across multiple pages" do
+     @pdf.text "Blah", :at => [100,100]
+     @pdf.start_new_page
+     @pdf.text "Blaz", :at => [150,150]
+     text = PDF::Inspector::Text.analyze(@pdf.render)  
+
+     text.font_settings.size.should  == 2
+     text.font_settings[0][:name].should == :Helvetica
+     text.font_settings[1][:name].should == :Helvetica
+   end
+   
+   it "should raise an exception when an unknown font is used" do
+     lambda { @pdf.font "Pao bu" }.should.raise(Prawn::Errors::UnknownFont)
+   end
+
+   it "should correctly render a utf-8 string when using a built-in font" do
+     str = "©" # copyright symbol
+     @pdf.text str
+
+     # grab the text from the rendered PDF and ensure it matches
+     text = PDF::Inspector::Text.analyze(@pdf.render)
+     text.strings.first.should == str
+   end
+                    
+   if "spec".respond_to?(:encode!)
+     # Handle non utf-8 string encodings in a sane way on M17N aware VMs
+     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(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(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(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(ArgumentError)
+     end
+   end 
+
+  it "should wrap text" do
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+
+    text = "Please wrap this text about HERE. More text that should be wrapped"
+    expect = "Please wrap this text about\nHERE. More text that should be\nwrapped"
+
+    @pdf.naive_wrap(text, 220, @pdf.font_size).should == expect
+  end
+
+  it "should respect end of line when wrapping text" do
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+    text = "Please wrap only before\nTHIS word. Don't wrap this"
+    @pdf.naive_wrap(text, 220, @pdf.font_size).should == text
+  end
+
+  it "should respect end of line when wrapping text and mode is set to 'character'" do
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+
+    text = "You can wrap this text HERE"
+    expect = "You can wrap this text HE\nRE"
+
+    @pdf.naive_wrap(text, 180, @pdf.font_size, :mode => :character).should == expect
+  end     
+  
+end

data/vendor/prawn-core/spec/transparency_spec.rb

@@ -0,0 +1,61 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") 
+
+describe "Document with transparency" do
+  it "the PDF version should be at least 1.4" do
+    create_pdf
+    @pdf.transparent(0.5)
+    str = @pdf.render
+    str[0,8].should == "%PDF-1.4"
+  end
+  
+  it "a new extended graphics state should be created for "+
+     "each unique transparency setting" do
+    create_pdf
+    @pdf.transparent(0.5, 0.2)
+    @pdf.transparent(0.5, 0.75)
+    extgstates = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates
+    extgstates.length.should == 2
+  end
+  
+  it "a new extended graphics state should not be created for "+
+     "each duplicate transparency setting" do
+    create_pdf
+    @pdf.transparent(0.5, 0.75)
+    @pdf.transparent(0.5, 0.75)
+    extgstates = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates
+    extgstates.length.should == 1
+  end
+
+  it "setting the transparency with only one parameter sets the transparency"+
+     " for both the fill and the stroke" do
+    create_pdf
+    @pdf.transparent(0.5)
+    extgstate = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates[0]
+    extgstate[:opacity].should == 0.5
+    extgstate[:stroke_opacity].should == 0.5
+  end
+
+  it "setting the transparency with a numerical parameter and "+
+     "a :stroke should set the fill transparency to the numerical parameter "+
+     "and the stroke transparency to the option" do
+    create_pdf
+    @pdf.transparent(0.5, 0.2)
+    extgstate = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates[0]
+    extgstate[:opacity].should == 0.5
+    extgstate[:stroke_opacity].should == 0.2
+  end
+  
+  describe "with more than one page" do
+    it "the extended graphic state resource should be added to both pages" do
+      create_pdf
+      @pdf.transparent(0.5, 0.2)
+      @pdf.start_new_page
+      @pdf.transparent(0.5, 0.2)
+      extgstates = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates
+      extgstate = extgstates[0]
+      extgstates.length.should == 2
+      extgstate[:opacity].should == 0.5
+      extgstate[:stroke_opacity].should == 0.2
+    end
+  end
+end

data/vendor/prawn-core/vendor/pdf-inspector/README

@@ -0,0 +1,18 @@
+PDF::Inspector : A tool for analyzing PDF output
+
+This library provides a number of PDF::Reader[0] based tools for use in testing
+PDF output.  Presently, the primary purpose of this tool is to support the 
+tests found in Prawn[1], a pure Ruby PDF generation library.
+
+However, it may be useful to others, so we have made it available on Github[2]
+
+Questions can be directed to the Prawn mailing list[3], but please remember
+that this code is not necessarily suitable for production and has no officially
+planned release date.  
+
+That having been said, patches are welcome!
+
+[0] http://github.com/yob/pdf-reader                                         
+[1] http://github.com/sandal/prawn                                           
+[2] http://github.com/sandal/pdf-inspector              
+[3] http://groups.google.com/group/prawn-ruby

data/vendor/prawn-core/vendor/pdf-inspector/lib/pdf/inspector.rb

@@ -0,0 +1,26 @@
+require "rubygems"
+require "pdf/reader"
+require "pdf/inspector/text" 
+require "pdf/inspector/xobject"
+require "pdf/inspector/extgstate"
+require "pdf/inspector/graphics"
+require "pdf/inspector/page"
+
+module PDF
+  class Inspector
+    def self.analyze(output,*args,&block) 
+      obs = self.new(*args, &block)
+      PDF::Reader.string(output,obs)
+      obs  
+    end         
+    
+    def self.analyze_file(filename,*args,&block)
+      analyze(File.open(filename, "rb") { |f| f.read },*args,&block)
+    end  
+    
+    def self.parse(obj)
+      PDF::Reader::Parser.new(
+        PDF::Reader::Buffer.new(StringIO.new(obj)), nil).parse_token
+    end
+  end
+end

data/vendor/prawn-core/vendor/pdf-inspector/lib/pdf/inspector/extgstate.rb

@@ -0,0 +1,18 @@
+module PDF
+  class Inspector
+    class ExtGState < Inspector
+      attr_accessor :extgstates
+
+      def initialize
+        @extgstates = []
+      end
+
+      def resource_extgstate(*params)
+        @extgstates << {
+                        :opacity => params[1][:ca],
+                        :stroke_opacity => params[1][:CA]
+                        }
+      end
+    end
+  end
+end

data/vendor/prawn-core/vendor/pdf-inspector/lib/pdf/inspector/graphics.rb

@@ -0,0 +1,119 @@
+module PDF
+  class Inspector 
+    module Graphics                   
+      class Line < Inspector
+        attr_accessor :points, :widths
+
+        def initialize
+          @points = []
+          @widths = [] 
+        end  
+
+        def append_line(*params)
+          @points << params
+        end    
+
+        def begin_new_subpath(*params)
+          @points << params
+        end           
+        
+        def set_line_width(params)
+          @widths << params
+        end
+
+      end 
+      
+      class Rectangle < Inspector
+        attr_reader :rectangles
+
+        def initialize
+          @rectangles = []     
+        end
+
+        def append_rectangle(*params) 
+          @rectangles << { :point  => params[0..1],    
+                           :width  => params[2],
+                           :height => params[3]  }     
+        end
+      end
+      
+      class Curve < Inspector
+
+        attr_reader :coords
+
+        def initialize
+          @coords = []          
+        end   
+
+        def begin_new_subpath(*params)   
+          @coords += params
+        end
+
+        def append_curved_segment(*params)
+          @coords += params
+        end           
+
+      end   
+      
+      class Color < Inspector
+        attr_reader :stroke_color, :fill_color, :stroke_color_count, 
+                    :fill_color_count
+
+        def initialize
+          @stroke_color_count = 0
+          @fill_color_count   = 0
+        end
+
+        def set_rgb_color_for_stroking(*params)    
+          @stroke_color_count += 1
+          @stroke_color = params
+        end
+
+        def set_rgb_color_for_nonstroking(*params) 
+          @fill_color_count += 1
+          @fill_color = params
+        end
+      end 
+      
+      class Dash < Inspector
+        attr_reader :stroke_dash, :stroke_dash_count
+
+        def initialize
+          @stroke_dash_count = 0
+        end
+
+        def set_line_dash(*params)
+          @stroke_dash_count += 1
+          @stroke_dash = params
+        end
+      end
+      
+      class CapStyle < Inspector
+        attr_reader :cap_style, :cap_style_count
+
+        def initialize
+          @cap_style_count = 0
+        end
+
+        def set_line_cap_style(*params)
+          @cap_style_count += 1
+          @cap_style = params[0]
+        end
+      end
+      
+      class JoinStyle < Inspector
+        attr_reader :join_style, :join_style_count
+
+        def initialize
+          @join_style_count = 0
+        end
+
+        def set_line_join_style(*params)
+          @join_style_count += 1
+          @join_style = params[0]
+        end
+      end
+      
+    end                                
+  end
+end