prawn-core 0.6.3 → 0.7.1

data/spec/text_box_spec.rb

@@ -2,95 +2,220 @@
 
 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    
+describe "Text::Box" do
+  it "should not fail if height is smaller than 1 line" do
+    create_pdf
+    @text = "Oh hai text rect. " * 10
+    @options = {
+      :height => @pdf.font.height * 0.5,
+      :document => @pdf
+    }
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render
+    text_box.text.should == ""
   end
+end
 
-  it "should have a truncated text" do
-    @overflow = :truncate
-    create_text_box
-    @box.render
-    @box.text.should == "Oh hai\ntext box.\n" * 5
+describe "Text::Box#render" do
+  it "should draw content to the page" do
+    create_pdf
+    @text = "Oh hai text rect. " * 10
+    @options = { :document => @pdf }
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render()
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings.should.not.be.empty
   end
+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
+describe "Text::Box#render(:dry_run => true)" do
+  it "should not draw any content to the page" do
+    create_pdf
+    @text = "Oh hai text rect. " * 10
+    @options = { :document => @pdf }
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render(:dry_run => true)
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings.should.be.empty
   end
+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
+describe "Text::Box default height" do
+  it "should be the height from the bottom bound to document.y" do
+    create_pdf
+    target_height = @pdf.y - @pdf.bounds.bottom
+    @text = "Oh hai\n" * 60
+    @options = { :document => @pdf }
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render
+    text_box.height.should.be.close(target_height, @pdf.font.height)
   end
+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
+describe "Text::Box default at" do
+  it "should be the left corner of the bounds, and the current document.y" do
+    create_pdf
+    target_at = [@pdf.bounds.left, @pdf.y]
+    @text = "Oh hai text rect. " * 100
+    @options = { :document => @pdf }
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render
+    text_box.at.should == target_at
   end
+end
 
-  it "should have a height equal to @height" do
-    @overflow = :truncate    
-    create_text_box
-    @box.render    
-    @box.height.should == @height     
+describe "Text::Box with text than can fit in the box" do
+  before(:each) do
+    create_pdf
+    @text = "Oh hai text rect. " * 10
+    @options = {
+      :width => 162.0,
+      :height => 162.0,
+      :document => @pdf
+    }
+  end
+  
+  it "printed text should match requested text, except for trailing or leading white space and that spaces may be replaced by newlines" do
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render
+    text_box.text.gsub("\n", " ").should == @text.strip
+  end
+  
+  it "render should return an empty string because no text remains unprinted" do
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render.should == ""
   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..."
+  it "should be truncated when the leading is set high enough to prevent all the lines from being printed" do
+    @options[:leading] = 40
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render
+    text_box.text.gsub("\n", " ").should.not == @text.strip
   end
+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
+describe "Text::Box with text than can fit in the box with :ellipses overflow and :valign => :bottom" do
+  it "should not print ellipses" do
+    create_pdf
+    @text = "Oh hai text rect. " * 10
+    @options = {
+      :width => 162.0,
+      :height => 162.0,
+      :overflow => :ellipses,
+      :valign => :bottom,
+      :document => @pdf
+    }
+    @text_box = Prawn::Text::Box.new(@text, @options)
+    @text_box.render
+    @text_box.text.should.not =~ /\.\.\./
+  end
+end
+
+describe "Text::Box with more text than can fit in the box" do
+  before(:each) do
+    create_pdf    
+    @text = "Oh hai text rect. " * 30
+    @bounding_height = 162.0
+    @options = {
+      :width => 162.0,
+      :height => @bounding_height,
+      :document => @pdf
+    }
+  end
+  
+  context "truncated overflow" do
+    before(:each) do
+      @options[:overflow] = :truncate
+      @text_box = Prawn::Text::Box.new(@text, @options)
+    end
+    it "should not display ellipses" do
+      @text_box.render
+      @text_box.text.should.not =~ /\.\.\./
+    end
+    it "should be truncated" do
+      @text_box.render
+      @text_box.text.gsub("\n", " ").should.not == @text.strip
+    end
+    it "render should not return an empty string because some text remains unprinted" do
+      @text_box.render.should.not == ""
+    end
+    it "#height should be no taller than the specified height" do
+      @text_box.render
+      @text_box.height.should.be <= @bounding_height
+    end
+    it "#height should be within one font height of the specified height" do
+      @text_box.render
+      @bounding_height.should.be.close(@text_box.height, @pdf.font.height)
+    end
   end
   
-  def create_text_box
-    @box = Prawn::Document::Text::Box.new(@text,
-                                          :width    => @width, :height => @height,
-                                          :overflow => @overflow,
-                                          :at       => [@x, @y],
-                                          :for      => @pdf)    
+  context "ellipses overflow" do
+    before(:each) do
+      @options[:overflow] = :ellipses
+      @text_box = Prawn::Text::Box.new(@text, @options)
+    end
+    it "should display ellipses" do
+      @text_box.render
+      @text_box.text.should =~ /\.\.\./
+    end
+    it "render should not return an empty string because some text remains unprinted" do
+      @text_box.render.should.not == ""
+    end
+  end
+
+  context "expand overflow" do
+    before(:each) do
+      @options[:overflow] = :expand
+      @text_box = Prawn::Text::Box.new(@text, @options)
+    end
+    it "height should expand to encompass all the text (but not exceed the height of the page)" do
+      @text_box.render
+      @text_box.height.should > @bounding_height
+    end
+    it "should display the entire string (as long as there was space remaining on the page to print all the text)" do
+      @text_box.render
+      @text_box.text.gsub("\n", " ").should == @text.strip
+    end
+    it "render should return an empty string because no text remains unprinted(as long as there was space remaining on the page to print all the text)" do
+      @text_box.render.should == ""
+    end
+  end
+
+  context "shrink_to_fit overflow" do
+    before(:each) do
+      @options[:overflow] = :shrink_to_fit
+      @options[:min_font_size] = 2
+      @text_box = Prawn::Text::Box.new(@text, @options)
+    end
+    it "should display the entire text" do
+      @text_box.render
+      @text_box.text.gsub("\n", " ").should == @text.strip
+    end
+    it "render should return an empty string because no text remains unprinted" do
+      @text_box.render.should == ""
+    end
+  end
+end
+
+describe "Text::Box with a solid block of Chinese characters" do
+  it "printed text should match requested text, except for newlines" do
+    create_pdf
+    @text = "写中国字" * 10
+    @options = {
+      :width => 162.0,
+      :height => 162.0,
+      :document => @pdf
+    }
+    @pdf.font "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"
+    @options[:overflow] = :truncate
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render
+    text_box.text.gsub("\n", "").should == @text.strip
   end
 end
 
+
 describe "drawing bounding boxes" do    
   
   before(:each) { create_pdf }   
@@ -107,3 +232,91 @@ describe "drawing bounding boxes" do
 end
 
   
+describe 'Text::Box wrapping' do
+  
+
+  it "should wrap text" do
+    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 = Prawn::Document.new
+    @pdf.font "Courier"
+    @text_box = Prawn::Text::Box.new(text,
+                                          :width    => 220,
+                                          :overflow => :expand,
+                                          :document => @pdf)
+    @text_box.render
+    @text_box.text.should == expect
+  end
+
+  it "should respect end of line when wrapping text" do
+    text = "Please wrap only before\nTHIS word. Don't wrap this"
+    expect = text
+
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+    @text_box = Prawn::Text::Box.new(text,
+                                          :width    => 220,
+                                          :overflow => :expand,
+                                          :document => @pdf)
+    @text_box.render
+    @text_box.text.should == expect
+  end
+
+  it "should respect multiple newlines when wrapping text" do
+    text = "Please wrap only before THIS\n\nword. Don't wrap this"
+    expect= "Please wrap only before\nTHIS\n\nword. Don't wrap this"
+
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+    @text_box = Prawn::Text::Box.new(text,
+                                          :width    => 200,
+                                          :overflow => :expand,
+                                          :document => @pdf)
+    @text_box.render
+    @text_box.text.should == expect
+  end
+
+  it "should respect multiple newlines when wrapping text when those newlines coincide with a line break" do
+    text = "Please wrap only before\n\nTHIS word. Don't wrap this"
+    expect = text
+
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+    @text_box = Prawn::Text::Box.new(text,
+                                          :width    => 220,
+                                          :overflow => :expand,
+                                          :document => @pdf)
+    @text_box.render
+    @text_box.text.should == expect
+  end
+
+  it "should respect initial newlines" do
+    text = "\nThis should be on line 2"
+    expect = text
+
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+    @text_box = Prawn::Text::Box.new(text,
+                                          :width    => 220,
+                                          :overflow => :expand,
+                                          :document => @pdf)
+    @text_box.render
+    @text_box.text.should == expect
+  end
+
+  it "should wrap lines comprised of a single word of the bounds when wrapping text" do
+    text = "You_can_wrap_this_text_HERE"
+    expect = "You_can_wrap_this_text_HE\nRE"
+
+    @pdf = Prawn::Document.new
+    @pdf.font "Courier"
+    @text_box = Prawn::Text::Box.new(text,
+                                          :width    => 180,
+                                          :overflow => :expand,
+                                          :document => @pdf)
+    @text_box.render
+    @text_box.text.should == expect
+  end     
+  
+end

data/spec/text_spec.rb

@@ -1,10 +1,22 @@
 # 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 "#height_of" do
+  before(:each) { create_pdf }
+
+  it "should return the height that would be required to print a" +
+    "particular string of text" do
+    original_y = @pdf.y
+    @pdf.text("Foo")
+    new_y = @pdf.y
+    @pdf.height_of("Foo", :width => 300).should.be.close(original_y - new_y, 0.0001)
+  end
+end
 
 describe "when drawing text" do     
    
-   before(:each) { create_pdf } 
+   before(:each) { create_pdf }
 
    it "should advance down the document based on font_height" do
      position = @pdf.y
@@ -16,6 +28,32 @@ describe "when drawing text" do
      @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_height" +
+      " with size option" do
+     position = @pdf.y
+     @pdf.text "Foo", :size => 15
+
+     @pdf.font_size = 15
+     @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_height" +
+      " with leading option" do
+     position = @pdf.y
+     leading = 2
+     @pdf.text "Foo", :leading => leading
+
+     @pdf.y.should.be.close(position - @pdf.font.height - leading, 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
@@ -153,33 +191,15 @@ describe "when drawing text" 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
+   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
+  it "should call move_past_bottom when printing more text than can fit between the current document.y and bounds.bottom" do
+    @pdf.y = @pdf.font.height
+    @pdf.text "Hello"
+    @pdf.text "World"
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+    pages.size.should == 2
+    pages[0][:strings].should == ["Hello"]
+    pages[1][:strings].should == ["World"]
   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/spec/transparency_spec.rb

@@ -44,6 +44,20 @@ describe "Document with transparency" do
     extgstate[:opacity].should == 0.5
     extgstate[:stroke_opacity].should == 0.2
   end
+
+  it "should enforce the valid range of 0.0 to 1.0" do
+    create_pdf
+    @pdf.transparent(-0.5, -0.2)
+    extgstate = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates[0]
+    extgstate[:opacity].should == 0.0
+    extgstate[:stroke_opacity].should == 0.0
+
+    create_pdf
+    @pdf.transparent(2.0, 3.0)
+    extgstate = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates[0]
+    extgstate[:opacity].should == 1.0
+    extgstate[:stroke_opacity].should == 1.0
+  end
   
   describe "with more than one page" do
     it "the extended graphic state resource should be added to both pages" do

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

@@ -64,12 +64,12 @@ module PDF
           @fill_color_count   = 0
         end
 
-        def set_rgb_color_for_stroking(*params)    
+        def set_color_for_stroking_and_special(*params)
           @stroke_color_count += 1
           @stroke_color = params
         end
 
-        def set_rgb_color_for_nonstroking(*params) 
+        def set_color_for_nonstroking_and_special(*params)
           @fill_color_count += 1
           @fill_color = params
         end