prawn-core 0.5.0.1

data/spec/reference_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "A Reference object" do
+  it "should produce a PDF reference on #to_s call" do
+    ref = Prawn::Reference(1,true)
+    ref.to_s.should == "1 0 R"
+  end                                        
+  
+  it "should allow changing generation number" do
+    ref = Prawn::Reference(1,true)
+    ref.gen = 1
+    ref.to_s.should == "1 1 R"
+  end
+  
+  it "should generate a valid PDF object for the referenced data" do
+    ref = Prawn::Reference(2,[1,"foo"]) 
+    ref.object.should == "2 0 obj\n#{Prawn::PdfObject([1,"foo"])}\nendobj\n" 
+  end             
+  
+  it "should automatically open a stream when #<< is used" do
+     ref = Prawn::Reference(1, :Length => 41)
+     ref << "BT\n/F1 12 Tf\n72 712 Td\n( A stream ) Tj\nET"   
+     ref.object.should == "1 0 obj\n<< /Length 41\n>>\nstream"+
+                           "\nBT\n/F1 12 Tf\n72 712 Td\n( A stream ) Tj\nET" +
+                           "\nendstream\nendobj\n"
+  end
+
+  it "should compress a stream upon request" do
+    ref = Prawn::Reference(2,{})
+    ref << "Hi There " * 20
+
+    cref = Prawn::Reference(2,{})
+    cref << "Hi There " * 20
+    cref.compress_stream
+
+    assert cref.stream.size < ref.stream.size, 
+      "compressed stream expected to be smaller than source but wasn't"
+    cref.data[:Filter].should == :FlateDecode
+  end
+end

data/spec/span_spec.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "drawing span" do    
+  
+  before(:each) {
+    Prawn.debug = false
+    create_pdf
+  }   
+
+  it "should only accept :position as option in debug mode" do
+    Prawn.debug = true
+    lambda { @pdf.span(350, {:x => 3}) {} }.should.raise(Prawn::Errors::UnknownOption)
+  end
+
+  it "should have raise an error if :position is invalid" do
+    lambda { @pdf.span(350, :position => :x) {} }.should.raise(ArgumentError)
+  end
+
+  it "should restore the margin box when bounding box exits" do
+    margin_box = @pdf.bounds
+
+    @pdf.span(350, :position => :center) do
+      @pdf.text "Here's some centered text in a 350 point column. " * 100
+    end
+    
+    @pdf.bounds.should == margin_box
+    
+  end
+
+  it "should do create a margin box" do
+    y = @pdf.y
+    margin_box = @pdf.span(350, :position => :center) do
+      @pdf.text "Here's some centered text in a 350 point column. " * 100
+    end
+    
+    margin_box.top.should == 792.0
+    margin_box.bottom.should == 0    
+    
+  end  
+  
+end
+
+  

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+puts "Prawn specs: Running on Ruby Version: #{RUBY_VERSION}"
+
+require "rubygems"
+require "test/spec"                                                
+require "mocha"
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib') 
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'vendor','pdf-inspector','lib')
+require "prawn/core"
+
+Prawn.debug = true
+
+gem 'pdf-reader', ">=0.7.3"
+require "pdf/reader"          
+require "pdf/inspector"
+
+def create_pdf(klass=Prawn::Document)
+  @pdf = klass.new(:left_margin   => 0,
+                   :right_margin  => 0,
+                   :top_margin    => 0,
+                   :bottom_margin => 0)
+end    

data/spec/text_box_spec.rb

@@ -0,0 +1,83 @@
+# 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 "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/spec/text_spec.rb

@@ -0,0 +1,178 @@
+# 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 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/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/pdf-inspector/lib/pdf/inspector.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "pdf/reader"
+require "pdf/inspector/text" 
+require "pdf/inspector/xobject"
+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/pdf-inspector/lib/pdf/inspector/graphics.rb

@@ -0,0 +1,80 @@
+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 
+      
+    end                                
+  end
+end