alphasights-prawn 0.10.0

data/spec/text_spacing_spec.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "#character_spacing" do
+  it "should draw the character spacing to the document" do
+    create_pdf
+    @pdf.character_spacing(10.555555) do
+      @pdf.text("hello world")
+    end
+    contents = PDF::Inspector::Text.analyze(@pdf.render)
+    contents.character_spacing.first.should == 10.556
+  end
+  it "should not draw the character spacing to the document" +
+    " when the new character spacing matches the old" do
+    create_pdf
+    @pdf.character_spacing(0) do
+      @pdf.text("hello world")
+    end
+    contents = PDF::Inspector::Text.analyze(@pdf.render)
+    contents.character_spacing.should.be.empty
+  end
+  it "should restore character spacing to 0" do
+    create_pdf
+    @pdf.character_spacing(10.555555) do
+      @pdf.text("hello world")
+    end
+    contents = PDF::Inspector::Text.analyze(@pdf.render)
+    contents.character_spacing.last.should == 0
+  end
+  it "should function as an accessor when no parameter given" do
+    create_pdf
+    @pdf.character_spacing(10.555555) do
+      @pdf.text("hello world")
+      @pdf.character_spacing.should == 10.555555
+    end
+    @pdf.character_spacing.should == 0
+  end
+end
+
+describe "#word_spacing" do
+  it "should draw the word spacing to the document" do
+    create_pdf
+    @pdf.word_spacing(10.555555) do
+      @pdf.text("hello world")
+    end
+    contents = PDF::Inspector::Text.analyze(@pdf.render)
+    contents.word_spacing.first.should == 10.556
+  end
+  it "should draw the word spacing to the document" +
+    " when the new word spacing matches the old" do
+    create_pdf
+    @pdf.word_spacing(0) do
+      @pdf.text("hello world")
+    end
+    contents = PDF::Inspector::Text.analyze(@pdf.render)
+    contents.word_spacing.should.be.empty
+  end
+  it "should restore word spacing to 0" do
+    create_pdf
+    @pdf.word_spacing(10.555555) do
+      @pdf.text("hello world")
+    end
+    contents = PDF::Inspector::Text.analyze(@pdf.render)
+    contents.word_spacing.last.should == 0
+  end
+  it "should function as an accessor when no parameter given" do
+    create_pdf
+    @pdf.word_spacing(10.555555) do
+      @pdf.text("hello world")
+      @pdf.word_spacing.should == 10.555555
+    end
+    @pdf.word_spacing.should == 0
+  end
+end

data/spec/text_spec.rb

@@ -0,0 +1,333 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "Prawn::Text::NBSP" do
+  it "should be defined" do
+    Prawn::Text::NBSP.should == " "
+  end
+end
+
+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
+
+  it "should raise CannotFit if a too-small width is given" do
+    lambda do
+      @pdf.height_of("text", :width => 1)
+    end.should.raise(Prawn::Errors::CannotFit)
+  end
+
+  it "should raise NotImplementedError if :indent_paragraphs option is provided" do
+    lambda {
+      @pdf.height_of("hai", :width => 300,
+                     :indent_paragraphs => 60)
+    }.should.raise(NotImplementedError)
+  end
+
+  it "should not raise Prawn::Errors::UnknownOption if :final_gap option is provided" do
+    lambda {
+      @pdf.height_of("hai", :width => 300,
+                     :final_gap => true)
+    }.should.not.raise(Prawn::Errors::UnknownOption)
+  end
+end
+
+describe "#text" do
+  before(:each) { create_pdf }
+
+  it "should default to use kerning information" do
+    @pdf.text "hello world"
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.kerned[0].should.be true
+  end
+
+  it "should be able to disable kerning with an option" do
+    @pdf.text "hello world", :kerning => false
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.kerned[0].should.be false
+  end
+
+  it "should be able to disable kerning document wide" do
+    @pdf.default_kerning(false)
+    @pdf.default_kerning = false
+    @pdf.text "hello world"
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.kerned[0].should.be false
+  end
+
+  it "option should be able to override document wide kerning disabling" do
+    @pdf.default_kerning = false
+    @pdf.text "hello world", :kerning => true
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.kerned[0].should.be true
+  end
+
+  it "should raise ArgumentError if :at option included" do
+    lambda { @pdf.text("hai", :at => [0, 0]) }.should.raise(ArgumentError)
+  end
+
+  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_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
+    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 be able to print text starting at the last line of a page" do
+    @pdf.move_cursor_to(@pdf.font.height)
+    @pdf.text("hello world")
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+    pages.size.should == 1
+  end
+
+  it "should default to 12 point helvetica" do
+    @pdf.text "Blah"
+    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", :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 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"
+    @pdf.font "Courier"
+    @pdf.text "Blaz"
+    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"
+    @pdf.start_new_page
+    @pdf.text "Blaz"
+    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
+
+  it "should correctly render a utf-8 string when using a TTF font" do
+    str = "©" # copyright symbol
+    @pdf.font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+    @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
+
+  it "should correctly render a string with higher bit characters across" +
+     " a page break when using a built-in font" do
+    str = "©"
+    @pdf.move_cursor_to(@pdf.font.height)
+    @pdf.text(str + "\n" + str)
+
+    # grab the text from the rendered PDF and ensure it matches
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings[1].should == str.strip
+  end
+
+  it "should correctly render a string with higher bit characters across" +
+    " a page break when using a built-in font and :indent_paragraphs option" do
+    str = "©"
+    @pdf.move_cursor_to(@pdf.font.height)
+    @pdf.text(str + "\n" + str, :indent_paragraphs => 20)
+
+    # grab the text from the rendered PDF and ensure it matches
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings[1].should == str.strip
+  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 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
+
+  describe "with :indent_paragraphs option" do
+    it "should indent the paragraphs" do
+      hello = "hello " * 50
+      hello2 = "hello " * 50
+      @pdf.text(hello + "\n" + hello2, :indent_paragraphs => 60)
+      text = PDF::Inspector::Text.analyze(@pdf.render)
+      text.strings[0].should == ("hello " * 19).strip
+      text.strings[1].should == ("hello " * 21).strip
+      text.strings[3].should == ("hello " * 19).strip
+      text.strings[4].should == ("hello " * 21).strip
+    end
+    describe "when wrap to new page, and first line of new page" +
+             " is not the start of a new paragraph, that line should" +
+             " not be indented" do
+      it "should indent the paragraphs" do
+        hello = "hello " * 50
+        hello2 = "hello " * 50
+        @pdf.move_cursor_to(@pdf.font.height)
+        @pdf.text(hello + "\n" + hello2, :indent_paragraphs => 60)
+        text = PDF::Inspector::Text.analyze(@pdf.render)
+        text.strings[0].should == ("hello " * 19).strip
+        text.strings[1].should == ("hello " * 21).strip
+        text.strings[3].should == ("hello " * 19).strip
+        text.strings[4].should == ("hello " * 21).strip
+      end
+    end
+    describe "when wrap to new page, and first line of new page" +
+             " is the start of a new paragraph, that line should" +
+             " be indented" do
+      it "should indent the paragraphs" do
+        hello = "hello " * 50
+        hello2 = "hello " * 50
+        @pdf.move_cursor_to(@pdf.font.height * 3)
+        @pdf.text(hello + "\n" + hello2, :indent_paragraphs => 60)
+        text = PDF::Inspector::Text.analyze(@pdf.render)
+        text.strings[0].should == ("hello " * 19).strip
+        text.strings[1].should == ("hello " * 21).strip
+        text.strings[3].should == ("hello " * 19).strip
+        text.strings[4].should == ("hello " * 21).strip
+      end
+    end
+  end
+end

data/spec/text_with_inline_formatting_spec.rb

@@ -0,0 +1,193 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "#height_of_formatted with inline styling" 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
+    array = [:text => "Foo"]
+    @pdf.formatted_text(array)
+    new_y = @pdf.y
+    @pdf.height_of_formatted(array,
+            :width => 300).should.be.close(original_y - new_y, 0.0001)
+  end
+
+  it "should raise CannotFit if a too-small width is given" do
+    lambda do
+      @pdf.height_of_formatted([:text => "hai"], :width => 1)
+    end.should.raise(Prawn::Errors::CannotFit)
+  end
+
+  it "should raise NotImplementedError if :indent_paragraphs option is" +
+     "provided" do
+    lambda {
+      @pdf.height_of_formatted([:text => "hai"], :width => 300,
+                               :indent_paragraphs => 60)
+    }.should.raise(NotImplementedError)
+  end
+
+  it "should not raise Prawn::Errors::UnknownOption if :final_gap option" +
+     "is provided" do
+    lambda {
+      @pdf.height_of_formatted([:text => "hai"], :width => 300,
+                               :final_gap => true)
+    }.should.not.raise(Prawn::Errors::UnknownOption)
+  end
+end
+
+describe "#formatted_text" do
+  it "should draw text" do
+    create_pdf
+    string = "hello world"
+    format_array = [:text => string]
+    @pdf.formatted_text(format_array)
+    # grab the text from the rendered PDF and ensure it matches
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings.first.should == string
+  end
+end
+
+describe "#text with inline styling" do
+  before(:each) { create_pdf }
+
+  it "should advance down the document based on font_height" do
+    position = @pdf.y
+    @pdf.text "Foo", :inline_format => true
+
+    @pdf.y.should.be.close(position - @pdf.font.height, 0.0001)
+
+    position = @pdf.y
+    @pdf.text "Foo\nBar\nBaz", :inline_format => true
+    @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, :inline_format => true
+
+    @pdf.font_size = 15
+    @pdf.y.should.be.close(position - @pdf.font.height, 0.0001)
+
+    position = @pdf.y
+    @pdf.text "Foo\nBar\nBaz", :inline_format => true
+    @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, :inline_format => true
+
+    @pdf.y.should.be.close(position - @pdf.font.height - leading, 0.0001)
+
+    position = @pdf.y
+    @pdf.text "Foo\nBar\nBaz", :inline_format => true
+    @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, :inline_format => true
+
+    @pdf.y.should.be.close(position - @pdf.font.ascender, 0.0001)
+
+    position = @pdf.y
+    @pdf.text "Foo\nBar\nBaz", :final_gap => false, :inline_format => true
+    @pdf.y.should.be.close(position -
+                           2*@pdf.font.height -
+                           @pdf.font.ascender, 0.0001)
+  end
+
+  it "should be able to print text starting at the last line of a page" do
+    @pdf.move_cursor_to(@pdf.font.height)
+    @pdf.text("hello world", :inline_format => true)
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+    pages.size.should == 1
+  end
+
+  it "should automatically move to a new page if the tallest fragment" +
+     " on the next line won't fit in the available space" do
+    create_pdf
+    @pdf.move_cursor_to(@pdf.font.height)
+    formatted = "this contains <font size='24'>sized</font> text"
+    @pdf.text(formatted, :inline_format => true)
+    pages = PDF::Inspector::Page.analyze(@pdf.render).pages
+    pages.size.should == 2
+  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, :inline_format => true
+
+    # grab the text from the rendered PDF and ensure it matches
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings.first.should == str
+  end
+
+  it "should correctly render a string with higher bit characters across" +
+     " a page break when using a built-in font" do
+    str = "©"
+    @pdf.move_cursor_to(@pdf.font.height)
+    @pdf.text(str + "\n" + str, :inline_format => true)
+
+    # grab the text from the rendered PDF and ensure it matches
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings[1].should == str.strip
+  end
+
+  it "should correctly render a string with higher bit characters across" +
+    " a page break when using a built-in font and :indent_paragraphs option" do
+    str = "©"
+    @pdf.move_cursor_to(@pdf.font.height)
+    @pdf.text(str + "\n" + str,
+              :indent_paragraphs => 20,
+              :inline_format => true)
+
+    # grab the text from the rendered PDF and ensure it matches
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings[1].should == str.strip
+  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,
+          :inline_format => true }.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_families["gkai00mp"] = {
+        :normal      => { :file => "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf",
+                          :font => "gkai00mp" }
+      }
+      @pdf.font("gkai00mp")
+      lambda { @pdf.text sjis_str,
+          :inline_format => true }.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,
+          :inline_format => true }.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,
+          :inline_format => true }.should.raise(ArgumentError)
+    end
+  end
+end