nurettin-prawn 1.0.0.rc1

data/spec/template_spec.rb

@@ -0,0 +1,351 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "Document built from a template" do
+  it "should have the same page count as the source document" do
+    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
+    @pdf = Prawn::Document.new(:template => filename)
+    page_counter = PDF::Inspector::Page.analyze(@pdf.render)
+
+    page_counter.pages.size.should == 1
+  end
+
+  it "should not set the template page's parent to the document pages catalog (especially with nested pages)" do
+    filename = "#{Prawn::DATADIR}/pdfs/nested_pages.pdf"
+    @pdf = Prawn::Document.new(:template => filename, :skip_page_creation => true)
+    @pdf.state.page.dictionary.data[:Parent].should_not == @pdf.state.store.pages
+  end
+
+
+  it "should have start with the Y cursor at the top of the document" do
+    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename)
+    (@pdf.y == nil).should == false
+  end
+
+  it "should respect margins set by Prawn" do
+    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename, :margin => 0)
+    @pdf.page.margins.should == { :left   => 0,
+                                  :right  => 0,
+                                  :top    => 0,
+                                  :bottom => 0 }
+
+    @pdf = Prawn::Document.new(:template => filename, :left_margin => 0)
+
+    @pdf.page.margins.should == { :left   => 0,
+                                  :right  => 36,
+                                  :top    => 36,
+                                  :bottom => 36 }
+
+    @pdf.start_new_page(:right_margin => 0)
+
+    @pdf.page.margins.should == { :left   => 0,
+                                  :right  => 0,
+                                  :top    => 36,
+                                  :bottom => 36 }
+
+
+
+  end
+
+  it "should not add an extra restore_graphics_state operator to the end of any content stream" do
+    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename)
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+
+    hash.each_value do |obj|
+      next unless obj.kind_of?(PDF::Reader::Stream)
+
+      data = obj.data.tr(" \n\r","")
+      data.include?("QQ").should == false
+    end
+  end
+
+  it "should have a single page object if importing a single page template" do
+    filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename)
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+
+    pages = hash.values.select { |obj| obj.kind_of?(Hash) && obj[:Type] == :Page }
+
+    pages.size.should == 1
+  end
+
+  it "should have two content streams if importing a single page template" do
+    filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename)
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+
+    streams = hash.values.select { |obj| obj.kind_of?(PDF::Reader::Stream) }
+
+    streams.size.should == 2
+  end
+
+  it "should not die if using this PDF as a template" do
+    filename = "#{Prawn::DATADIR}/pdfs/complex_template.pdf"
+
+    lambda {
+      @pdf = Prawn::Document.new(:template => filename)
+    }.should_not raise_error
+  end
+
+
+  it "should have balance q/Q operators on all content streams" do
+    filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename)
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+
+    streams = hash.values.select { |obj| obj.kind_of?(PDF::Reader::Stream) }
+
+    streams.each do |stream|
+      data = stream.unfiltered_data
+      data.scan("q").size.should == 1
+      data.scan("Q").size.should == 1
+    end
+  end
+
+  it "should allow text to be added to a single page template" do
+    filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename)
+
+    @pdf.text "Adding some text"
+
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings.first.should == "Adding some text"
+  end
+
+  it "should allow PDFs with page resources behind an indirect object to be used as templates" do
+    filename = "#{Prawn::DATADIR}/pdfs/resources_as_indirect_object.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename)
+
+    @pdf.text "Adding some text"
+
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    all_text = text.strings.join
+    all_text.include?("Adding some text").should == true
+  end
+
+  it "should copy the PDF version from the template file" do
+    filename = "#{Prawn::DATADIR}/pdfs/version_1_6.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename)
+    str = @pdf.render
+    str[0,8].should == "%PDF-1.6"
+  end
+
+  it "should correctly add a TTF font to a template that has existing fonts" do
+    filename = "#{Prawn::DATADIR}/pdfs/contains_ttf_font.pdf"
+    @pdf = Prawn::Document.new(:template => filename)
+    @pdf.font "#{Prawn::DATADIR}/fonts/Chalkboard.ttf"
+    @pdf.move_down(40)
+    @pdf.text "Hi There"
+
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+
+    page_dict = hash.values.detect{ |obj| obj.is_a?(Hash) && obj[:Type] == :Page }
+    resources = page_dict[:Resources]
+    fonts = resources[:Font]
+    fonts.size.should == 2
+  end
+
+  it "should correctly import a template file that is missing a MediaBox entry" do
+    filename = "#{Prawn::DATADIR}/pdfs/page_without_mediabox.pdf"
+
+    @pdf = Prawn::Document.new(:template => filename)
+    str = @pdf.render
+    str[0,4].should == "%PDF"
+  end
+
+  context "with the template as a stream" do
+    it "should correctly import a template file from a stream" do
+      filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
+      io = StringIO.new(File.binread(filename))
+      @pdf = Prawn::Document.new(:template => io)
+      str = @pdf.render
+      str[0,4].should == "%PDF"
+    end
+  end
+
+  it "merges metadata info" do
+    filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
+    info = { :Title => "Sample METADATA",
+             :Author => "Me",
+             :Subject => "Not Working",
+             :CreationDate => Time.now }
+
+    @pdf = Prawn::Document.new(:template => filename, :info => info)
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+    info.keys.each { |k| hash[hash.trailer[:Info]].keys.include?(k).should == true }
+  end
+
+end
+
+describe "Document#start_new_page with :template option" do
+  filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
+
+  it "should set the imported page's parent to the document pages catalog" do
+    @pdf = Prawn::Document.new()
+    @pdf.start_new_page(:template => filename)
+    @pdf.state.page.dictionary.data[:Parent].should == @pdf.state.store.pages
+  end
+
+  it "should set start the Y cursor at the top of the page" do
+    @pdf = Prawn::Document.new()
+    @pdf.start_new_page(:template => filename)
+    (@pdf.y == nil).should == false
+  end
+
+  it "should respect margins set by Prawn" do
+    @pdf = Prawn::Document.new(:margin => 0)
+    @pdf.start_new_page(:template => filename)
+    @pdf.page.margins.should == { :left   => 0,
+                                  :right  => 0,
+                                  :top    => 0,
+                                  :bottom => 0 }
+
+    @pdf = Prawn::Document.new(:left_margin => 0)
+    @pdf.start_new_page(:template => filename)
+    @pdf.page.margins.should == { :left   => 0,
+                                  :right  => 36,
+                                  :top    => 36,
+                                  :bottom => 36 }
+    @pdf.start_new_page(:template => filename, :right_margin => 0)
+    @pdf.page.margins.should == { :left   => 0,
+                                  :right  => 0,
+                                  :top    => 36,
+                                  :bottom => 36 }
+  end
+
+  it "should not add an extra restore_graphics_state operator to the end of any content stream" do
+    @pdf = Prawn::Document.new
+    @pdf.start_new_page(:template => filename)
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+
+    hash.each_value do |obj|
+      next unless obj.kind_of?(PDF::Reader::Stream)
+
+      data = obj.data.tr(" \n\r","")
+      data.include?("QQ").should == false
+    end
+  end
+
+  it "should have two content streams if importing a single page template" do
+    filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
+    @pdf = Prawn::Document.new()
+    @pdf.start_new_page(:template => filename)
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+    pages = hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Pages}[:Kids]
+    template_page = hash[pages[1]]
+    template_page[:Contents].size.should == 2
+  end
+
+  it "should have balance q/Q operators on all content streams" do
+    filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
+
+    @pdf = Prawn::Document.new()
+    @pdf.start_new_page(:template => filename)
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+
+    streams = hash.values.select { |obj| obj.kind_of?(PDF::Reader::Stream) }
+
+    streams.each do |stream|
+      data = stream.unfiltered_data
+      data.scan("q").size.should == 1
+      data.scan("Q").size.should == 1
+    end
+  end
+
+  it "should allow text to be added to a single page template" do
+
+    @pdf = Prawn::Document.new()
+    @pdf.start_new_page(:template => filename)
+
+    @pdf.text "Adding some text"
+
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings.first.should == "Adding some text"
+  end
+
+  it "should allow PDFs with page resources behind an indirect object to be used as templates" do
+    filename = "#{Prawn::DATADIR}/pdfs/resources_as_indirect_object.pdf"
+
+    @pdf = Prawn::Document.new()
+    @pdf.start_new_page(:template => filename)
+
+    @pdf.text "Adding some text"
+
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    all_text = text.strings.join
+    all_text.include?("Adding some text").should == true
+  end
+
+  it "should correctly add a TTF font to a template that has existing fonts" do
+    filename = "#{Prawn::DATADIR}/pdfs/contains_ttf_font.pdf"
+    @pdf = Prawn::Document.new()
+    @pdf.start_new_page(:template => filename)
+    @pdf.font "#{Prawn::DATADIR}/fonts/Chalkboard.ttf"
+    @pdf.move_down(40)
+    @pdf.text "Hi There"
+
+    output = StringIO.new(@pdf.render)
+    hash = PDF::Reader::ObjectHash.new(output)
+    hash = PDF::Reader::ObjectHash.new(output)
+    pages = hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Pages}[:Kids]
+    template_page = hash[pages[1]]
+    resources = template_page[:Resources]
+    fonts = resources[:Font]
+    fonts.size.should == 2
+  end
+
+  it "indexes template pages when used multiple times" do
+    filename = "#{Prawn::DATADIR}/pdfs/multipage_template.pdf"
+    @repeated_pdf = Prawn::Document.new()
+    3.times { @repeated_pdf.start_new_page(:template => filename) }
+    repeated_hash = PDF::Reader::ObjectHash.new(StringIO.new(@repeated_pdf.render))
+    @sequential_pdf = Prawn::Document.new()
+    (1..3).each { |p| @sequential_pdf.start_new_page(:template => filename, :template_page => p ) }
+    sequential_hash = PDF::Reader::ObjectHash.new(StringIO.new(@sequential_pdf.render))
+    (repeated_hash.size < sequential_hash.size).should == true
+  end
+
+  context "with the template as a stream" do
+    it "should correctly import a template file from a stream" do
+      filename = "#{Prawn::DATADIR}/pdfs/hexagon.pdf"
+      io = StringIO.new(File.binread(filename))
+
+      @pdf = Prawn::Document.new()
+      @pdf.start_new_page(:template => io)
+
+      str = @pdf.render
+      str[0,4].should == "%PDF"
+    end
+  end
+
+  context "using template_page option" do
+    it "uses the specified page option" do
+      filename = "#{Prawn::DATADIR}/pdfs/multipage_template.pdf"
+      @pdf = Prawn::Document.new()
+      @pdf.start_new_page(:template => filename, :template_page => 2)
+      text = PDF::Inspector::Text.analyze(@pdf.render)
+      text.strings.first.should == "This is template page 2"
+    end
+  end
+
+end

data/spec/text_at_spec.rb

@@ -0,0 +1,129 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "#draw_text" do
+  before(:each) { create_pdf }
+
+  it "should raise_error ArgumentError if :at option omitted" do
+    lambda { @pdf.draw_text("hai", { }) }.should raise_error(ArgumentError)
+  end
+
+  it "should raise_error ArgumentError if :align option included" do
+    lambda { @pdf.draw_text("hai", :at => [0, 0], :align => :center) }.should raise_error(ArgumentError)
+  end
+
+  it "should allow drawing empty strings to the page" do
+    @pdf.draw_text(" ", :at => [100,100])
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings.first.should == " "
+  end
+
+  it "should default to 12 point helvetica" do
+    @pdf.draw_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.draw_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.draw_text("Blah", :at => [0, 0])
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.font_settings[0][:size].should == 16
+  end
+
+  it "should allow overriding default font for a single instance" do
+    @pdf.font_size = 16
+
+    @pdf.draw_text("Blah", :size => 11, :at => [0, 0])
+    @pdf.draw_text("Blaz", :at => [0, 0])
+    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.draw_text('Blah', :at => [0, 0])
+    end
+
+    @pdf.draw_text('blah', :at => [0, 0])
+
+    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.draw_text('Foo', :at => [0, 0])
+      @pdf.draw_text('Blah', :size => 11, :at => [0, 0])
+      @pdf.draw_text('Blaz', :at => [0, 0])
+    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.draw_text("Blah", :at => [100,100], :at => [0, 0])
+    @pdf.font "Courier"
+    @pdf.draw_text("Blaz", :at => [150,150], :at => [0, 0])
+    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 raise_error an exception when an unknown font is used" do
+    lambda { @pdf.font "Pao bu" }.should raise_error(Prawn::Errors::UnknownFont)
+  end
+
+  it "should correctly render a utf-8 string when using a built-in font" do
+    str = "©" # copyright symbol
+    @pdf.draw_text(str, :at => [0, 0])
+
+    # 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_error an exception when a utf-8 incompatible string is rendered" do
+      str = "Blah \xDD"
+      str.force_encoding("ASCII-8BIT")
+      lambda { @pdf.draw_text(str, :at => [0, 0]) }.should raise_error(
+        Prawn::Errors::IncompatibleStringEncoding)
+    end
+    it "should_not raise_error an exception when a shift-jis string is rendered" do
+      datafile = "#{Prawn::DATADIR}/shift_jis_text.txt"
+      sjis_str = File.open(datafile, "r:shift_jis") { |f| f.gets }
+      @pdf.font("#{Prawn::DATADIR}/fonts/gkai00mp.ttf")
+      lambda { @pdf.draw_text(sjis_str, :at => [0, 0]) }.should_not raise_error(
+        Prawn::Errors::IncompatibleStringEncoding)
+    end
+  else
+    # Handle non utf-8 string encodings in a sane way on non-M17N aware VMs
+    it "should raise_error an exception when a corrupt utf-8 string is rendered" do
+      str = "Blah \xDD"
+      lambda { @pdf.draw_text(str, :at => [0, 0]) }.should raise_error(
+        Prawn::Errors::IncompatibleStringEncoding)
+    end
+    it "should raise_error an exception when a shift-jis string is rendered" do
+      sjis_str = File.read("#{Prawn::DATADIR}/shift_jis_text.txt")
+      lambda { @pdf.draw_text(sjis_str, :at => [0, 0]) }.should raise_error(
+        Prawn::Errors::IncompatibleStringEncoding)
+    end
+  end
+end