prawn 1.3.0 → 2.0.0

data/lib/prawn/text/formatted/line_wrap.rb

@@ -102,6 +102,10 @@ module Prawn
 
               if @accumulated_width + segment_width <= @width
                 @accumulated_width += segment_width
+                if segment[-1] == soft_hyphen
+                  sh_width = @document.width_of("#{soft_hyphen}", :kerning => @kerning)
+                  @accumulated_width -= sh_width
+                end
                 @fragment_output += segment
               else
                 end_of_the_line_reached(segment)
@@ -124,6 +128,7 @@ module Prawn
             "[#{whitespace}]+|" +
             "#{hyphen}+[^#{break_chars}]*|" +
             "#{soft_hyphen}"
+
           Regexp.new(pattern)
         end
 

data/lib/prawn/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Prawn
-  VERSION = "1.3.0"
+  VERSION = "2.0.0"
 end

data/manual/basic_concepts/measurement.rb

@@ -3,7 +3,7 @@
 # The base unit in Prawn is the PDF Point. One PDF Point is equal to 1/72 of
 # an inch.
 #
-# There is no need to waste time converting this measures. Prawn provides
+# There is no need to waste time converting this measure. Prawn provides
 # helpers for converting from other measurements
 # to PDF Points.
 #

data/manual/bounding_box/bounds.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #
 # The <code>bounds</code> method returns the current bounding box. This is
-# useful because the <code>Prawn::BoundinBox</code> exposes some nice boundary
+# useful because the <code>Prawn::BoundingBox</code> exposes some nice boundary
 # helpers.
 #
 # <code>top</code>, <code>bottom</code>, <code>left</code> and

data/manual/cover.rb

@@ -24,11 +24,8 @@ Prawn::ManualBuilder::Example.generate(filename) do
                      ], :at => [170, cursor - 160])
 
   if Dir.exist?("#{Prawn::BASEDIR}/.git")
-    #long git commit hash
-    #commit = `git show --pretty=%H`
-    #short git commit hash
     commit = `git show --pretty=%h`
-    git_commit = "git commit: #{commit}"
+    git_commit = "git commit: #{commit.lines.first}"
   else
     git_commit = ""
   end

data/manual/example_helper.rb

@@ -4,3 +4,4 @@ require_relative "../lib/prawn"
 require "prawn/manual_builder"
 
 Prawn::ManualBuilder.manual_dir = File.dirname(__FILE__)
+Prawn::Font::AFM.hide_m17n_warning = true

data/manual/how_to_read_this_manual.rb

@@ -32,9 +32,9 @@ Prawn::ManualBuilder::Example.generate(filename) do
 
   Most of the example snippets illustrate features that alter the page in place. The effect of these snippets is shown right below a dashed line. If it doesn't make sense to evaluate the snippet inline, a box with the link for the example file is shown instead.
 
-  Note that the <code>stroke_axis</code> method, used occasionally in the manual, is not part of standard Prawn and is used for demonstrative purposes. It is defined in this file:
+  Note that the <code>stroke_axis</code> method used throughout the manual is part of standard Prawn. It is defined in this file:
 
-  https://github.com/prawnpdf/prawn/blob/master/manual/example_helper.rb
+  https://github.com/prawnpdf/prawn/blob/master/lib/prawn/graphics.rb
   END_TEXT
 
 end

data/manual/repeatable_content/alternate_page_numbering.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+#
+# Below is the code to generate page numbers that alternate being rendered
+# on the right and left side of the page. The first page will have a "1" in
+# the bottom right corner. The second page will have a "2" in the bottom
+# left corner of the page. The third a "3" in the bottom right, etc.
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  text "This is the first page!"
+
+  10.times do
+    start_new_page
+    text "Here comes yet another page."
+  end
+
+  string = "<page>"
+  odd_options = { :at => [bounds.right - 150, 0],
+                  :width => 150,
+                  :align => :right,
+                  :page_filter => :odd,
+                  :start_count_at => 1 }
+  even_options = { :at => [0, bounds.left],
+                   :width => 150,
+                   :align => :left,
+                   :page_filter => :even,
+                   :start_count_at => 2 }
+  number_pages string, odd_options
+  number_pages string, even_options
+end

data/manual/repeatable_content/repeatable_content.rb

@@ -12,6 +12,7 @@ Prawn::ManualBuilder::Example.generate("repeatable_content.pdf", :page_size => "
     p.example "repeater",       :eval_source => false
     p.example "stamp"
     p.example "page_numbering", :eval_source => false
+    p.example "alternate_page_numbering", :eval_source => false
 
     p.intro do
       prose("Prawn offers two ways to handle repeatable content blocks. Repeater is useful for content that gets repeated at well defined intervals while Stamp is more appropriate if you need better control of when to repeat it.

data/manual/security/security.rb

@@ -18,7 +18,7 @@ Prawn::ManualBuilder::Example.generate("security.pdf", :page_size => "FOLIO") do
       The examples include:")
 
       list( "How to encrypt the document without the need for a password",
-            "How to configure the regular user permitions",
+            "How to configure the regular user permissions",
             "How to require a password for the regular user",
             "How to set a owner password that bypass the document permissions"
           )

data/manual/text/paragraph_indentation.rb

@@ -23,4 +23,12 @@ Prawn::ManualBuilder::Example.generate(filename) do
   text "This paragraph will be indented. " * 10 +
        "\n" + "This one will too. " * 10,
        :indent_paragraphs => 60
+
+  move_down 20
+
+  text "FROM RIGHT TO LEFT:"
+  text "This paragraph will be indented. " * 10 +
+        "\n" + "This one will too. " * 10,
+        :indent_paragraphs => 60, :direction => :rtl
+
 end

data/manual/text/right_to_left_text.rb

@@ -9,6 +9,10 @@
 # that two fragments going against the main direction cannot be placed next to
 # each other without appearing in the wrong order.
 #
+# Writing bidirectional text that combines both left-to-right and right-to-left
+# languages is easy using the <code>bidi</code> Ruby Gem and its
+# <code>render_visual</code> function. See https://github.com/elad/ruby-bidi for
+# instructions and an example using Prawn.
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 

data/manual/text/text.rb

@@ -42,7 +42,7 @@ Prawn::ManualBuilder::Example.generate("text.pdf", :page_size => "FOLIO") do
       s.example "registering_families"
     end
 
-    p.section "M17n" do |s|
+    p.section "Multilingualization" do |s|
       s.example "utf8"
       s.example "line_wrapping"
       s.example "right_to_left_text"

data/manual/text/text_box_overflow.rb

@@ -9,7 +9,7 @@
 # (the text font size will be shrunk to fit).
 #
 # If <code>:shrink_to_fit</code> mode is used with the
-# <code>:min_font_size</code> option set. The font size will not be reduced to
+# <code>:min_font_size</code> option set, the font size will not be reduced to
 # less than the value provided even if it means truncating some text.
 #
 # If the <code>:disable_wrap_by_char</code> is set to <code>true</code>

data/manual/text/utf8.rb

@@ -13,12 +13,12 @@ Prawn::ManualBuilder::Example.generate(filename) do
   text "€", :size => 32
   move_down 20
 
-  text "Seems ok. Now let's try something more complex:"
-  text "ὕαλον ϕαγεῖν δύναμαι· τοῦτο οὔ με βλάπτει."
+  text "This works, because €  is one of the few "+
+       "non-ASCII glyphs supported in PDF built-in fonts."
+
   move_down 20
 
-  text "Looks like the current font (#{font.inspect}) doesn't support those."
-  text "Let's try them with another font."
+  text "For full internationalized text support, we need to use TTF fonts:"
   move_down 20
 
   font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf") do

data/manual/text/win_ansi_charset.rb

@@ -50,7 +50,8 @@ Prawn::ManualBuilder::Example.generate(filename) do
         when :center then offset = (total_width - width)/2
         end
 
-        text_box(field, :at => [dx + offset, y], :skip_encoding => true)
+        text_box(field.force_encoding("windows-1252").encode("UTF-8"),
+          :at => [dx + offset, y])
       end
 
       dx += total_width

data/prawn.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
                  "COPYING", "LICENSE", "GPLv2", "GPLv3",
                  ".yardopts"]
   spec.require_path = "lib"
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
   spec.required_rubygems_version = ">= 1.3.6"
 
   spec.test_files = Dir[ "spec/*_spec.rb" ]
@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.licenses = ['RUBY', 'GPL-2', 'GPL-3']
 
   spec.add_dependency('ttfunk', '~> 1.4.0')
-  spec.add_dependency('pdf-core', "~> 0.4.0")
+  spec.add_dependency('pdf-core', "~> 0.5.0")
 
-  spec.add_development_dependency('pdf-inspector', '~> 1.1.0')
+  spec.add_development_dependency('pdf-inspector', '~> 1.2.0')
   spec.add_development_dependency('yard')
   spec.add_development_dependency('rspec', '2.14.1')
   spec.add_development_dependency('mocha')
@@ -35,26 +35,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('simplecov')
   spec.add_development_dependency('prawn-manual_builder', ">= 0.2.0")
   spec.add_development_dependency('pdf-reader', '~>1.2')
-  spec.add_development_dependency('rubocop', '0.20.1')
+  spec.add_development_dependency('rubocop', '0.28.0')
   spec.add_development_dependency('code_statistics', '0.2.13')
 
   spec.homepage = "http://prawn.majesticseacreature.com"
   spec.description = <<END_DESC
   Prawn is a fast, tiny, and nimble PDF generator for Ruby
-END_DESC
-  spec.post_install_message = <<END_DESC
-
-  ********************************************
-
-
-  A lot has changed recently in Prawn.
-
-  Please read the changelog for details:
-
-  https://github.com/prawnpdf/prawn/wiki/CHANGELOG
-
-
-  ********************************************
-
 END_DESC
 end

data/spec/document_spec.rb

@@ -180,6 +180,10 @@ describe "on_page_create callback" do
     create_pdf
   end
 
+  it "should be delegated from Document to renderer" do
+    expect(@pdf.respond_to?(:on_page_create)).to be_true
+  end
+
   it "should be invoked with document" do
     called_with = nil
 
@@ -304,14 +308,33 @@ describe "When reopening pages" do
     pages[2][:strings].should == ["Old page 2"]
   end
 
-  it "should update the bounding box to the new page's margin box" do
+  it "should restore the layout of the page" do
     Prawn::Document.new do
       start_new_page :layout => :landscape
       lsize = [bounds.width, bounds.height]
+
+      [bounds.width, bounds.height].should == lsize
       go_to_page 1
       [bounds.width, bounds.height].should == lsize.reverse
     end
   end
+
+  it "should restore the margin box of the page" do
+    Prawn::Document.new(:margin => [100, 100]) do
+      page1_bounds = bounds
+
+      start_new_page(:margin => [200, 200])
+
+      [bounds.width, bounds.height].should == [page1_bounds.width  - 200,
+                                               page1_bounds.height - 200]
+
+      go_to_page(1)
+
+      bounds.width.should == page1_bounds.width
+      bounds.height.should == page1_bounds.height
+    end
+
+  end
 end
 
 describe "When setting page size" do

data/spec/font_spec.rb

@@ -80,6 +80,31 @@ describe "#width_of" do
     styled_bold_hello.should == @bold_hello
   end
 
+  it "should calculate styled widths correctly using TTFs" do
+    create_pdf
+
+    @pdf.font_families.update(
+      'DejaVu Sans' => {
+        :normal => "#{Prawn::DATADIR}/fonts/DejaVuSans.ttf",
+        :bold => "#{Prawn::DATADIR}/fonts/DejaVuSans-Bold.ttf",
+      }
+    )
+    @pdf.font("DejaVu Sans") {
+      @styled_bold_hello = @pdf.width_of("hello", :style => :bold)
+    }
+    @pdf.font("DejaVu Sans", :style => :bold) {
+      @bold_hello = @pdf.width_of("hello")
+    }
+
+    @pdf.font("DejaVu Sans") {
+      @plain_hello = @pdf.width_of("hello")
+    }
+
+    @plain_hello.should_not == @bold_hello
+
+    @styled_bold_hello.should == @bold_hello
+  end
+
   it "should not treat minus as if it were a hyphen", :issue => 578 do
     create_pdf
 

data/spec/formatted_text_box_spec.rb

@@ -18,9 +18,9 @@ describe "Text::Formatted::Box wrapping" do
     text_box.text.should == "Hello\nWorld2"
   end
 
-  it "should not raise an Encoding::CompatibilityError when keeping a TTF and an " +
-    "AFM font together" do
+  it "should not raise an Encoding::CompatibilityError when keeping a TTF and an AFM font together" do
     file = "#{Prawn::DATADIR}/fonts/gkai00mp.ttf"
+
     @pdf.font_families["Kai"] = {
       :normal => { :file => file, :font => "Kai" }
     }
@@ -81,28 +81,6 @@ describe "Text::Formatted::Box wrapping" do
     }.should_not raise_error
     text_box.text.should == "Noua Delineatio Geographica\ngeneralis | Apostolicarum\nperegrinationum | S FRANCISCI\nXAUERII | Indiarum & Iaponi\346\nApostoli"
   end
-
-  describe "Unicode" do
-    before do
-      @reset_value = [Encoding.default_external, Encoding.default_internal]
-      Encoding.default_external = Encoding::UTF_8
-      Encoding.default_internal = Encoding::UTF_8
-    end
-
-    after do
-      Encoding.default_external = @reset_value[0]
-      Encoding.default_internal = @reset_value[1]
-    end
-
-    it "should properly handle empty slices using Unicode encoding" do
-      texts = [{ :text => "Noua Delineatio Geographica generalis | Apostolicarum peregrinationum | S FRANCISCI XAUERII | Indiarum & Iaponiæ Apostoli", :font => 'Courier', :size => 10 }]
-      text_box = Prawn::Text::Formatted::Box.new(texts, :document => @pdf, :width => @pdf.width_of("Noua Delineatio Geographica gen"))
-      lambda {
-        text_box.render
-      }.should_not raise_error
-      text_box.text.should == "Noua Delineatio Geographica\ngeneralis | Apostolicarum\nperegrinationum | S FRANCISCI\nXAUERII | Indiarum & Iaponi\346\nApostoli"
-    end
-  end
 end
 
 describe "Text::Formatted::Box with :fallback_fonts option that includes" +
@@ -170,6 +148,12 @@ describe "Text::Formatted::Box with :fallback_fonts option and fragment " +
     @pdf.font_families["Kai"] = {
       :normal => { :file => file, :font => "Kai" }
     }
+
+    file = "#{Prawn::DATADIR}/fonts/DejaVuSans.ttf"
+    @pdf.font_families["DejaVu Sans"] = {
+      :normal => { :file => file }
+    }
+
     formatted_text = [{ :text => "hello你好" },
                       { :text => "再见goodbye", :font => "Times-Roman" }]
     @pdf.formatted_text_box(formatted_text, :fallback_fonts => ["Kai"])
@@ -197,6 +181,13 @@ describe "Text::Formatted::Box" do
     @pdf.font_families["Kai"] = {
       :normal => { :file => file, :font => "Kai" }
     }
+
+    file = "#{Prawn::DATADIR}/fonts/DejaVuSans.ttf"
+    @pdf.font_families["DejaVu Sans"] = {
+      :normal => { :file => file }
+    }
+
+
     @formatted_text = [{ :text => "hello你好" }]
     @pdf.fallback_fonts(["Kai"])
     @pdf.fallback_fonts = ["Kai"]
@@ -215,26 +206,35 @@ describe "Text::Formatted::Box" do
     fonts_used[1].to_s.should =~ /GBZenKai-Medium/
   end
   it "should be able to override document-wide fallback_fonts" do
-    @pdf.formatted_text_box(@formatted_text, :fallback_fonts => ["Courier"])
+    @pdf.fallback_fonts = ["DejaVu Sans"]
+    @pdf.formatted_text_box(@formatted_text, :fallback_fonts => ["Kai"])
 
     text = PDF::Inspector::Text.analyze(@pdf.render)
 
     fonts_used = text.font_settings.map { |e| e[:name] }
-    fonts_used.length.should == 1
+    fonts_used.length.should == 2
     fonts_used[0].should == :"Helvetica"
+    fonts_used[1].should =~ /Kai/
   end
   it "should omit the fallback fonts overhead when passing an empty array " +
     "as the :fallback_fonts" do
+    @pdf.font("Kai")
+
     box = Prawn::Text::Formatted::Box.new(@formatted_text,
                                           :document => @pdf,
                                           :fallback_fonts => [])
+
     box.expects(:process_fallback_fonts).never
     box.render
   end
+
   it "should be able to clear document-wide fallback_fonts" do
     @pdf.fallback_fonts([])
     box = Prawn::Text::Formatted::Box.new(@formatted_text,
                                           :document => @pdf)
+
+    @pdf.font("Kai")
+
     box.expects(:process_fallback_fonts).never
     box.render
   end
@@ -242,16 +242,15 @@ end
 
 describe "Text::Formatted::Box with :fallback_fonts option " +
   "with glyphs not in the primary or the fallback fonts" do
-  it "should use the primary font" do
+
+  it "should raise an exception" do
+   file = "#{Prawn::DATADIR}/fonts/gkai00mp.ttf"
     create_pdf
     formatted_text = [{ :text => "hello world. 世界你好。" }]
-    @pdf.formatted_text_box(formatted_text, :fallback_fonts => ["Helvetica"])
 
-    text = PDF::Inspector::Text.analyze(@pdf.render)
-
-    fonts_used = text.font_settings.map { |e| e[:name] }
-    fonts_used.length.should == 1
-    fonts_used[0].should == :"Helvetica"
+    lambda {
+      @pdf.formatted_text_box(formatted_text, :fallback_fonts => ["Courier"])
+    }.should raise_error(Prawn::Errors::IncompatibleStringEncoding)
   end
 end
 
@@ -616,6 +615,51 @@ describe "Text::Formatted::Box#render with :align => :justify" do
   end
 end
 
+describe "Text::Formatted::Box#render with :valign => :center" do
+  it "should have a bottom gap equal to baseline and bottom of box" do
+    create_pdf
+    box_height = 100
+    y = 450
+    array = [{ :text => 'Vertical Align' }]
+    options = {
+     :document => @pdf,
+     :valign => :center,
+     :at => [0,y],
+     :width => 100,
+     :height => box_height,
+     :size => 16
+    }
+    text_box = Prawn::Text::Formatted::Box.new(array, options)
+    text_box.render
+    line_padding = (box_height - text_box.height + text_box.descender) * 0.5
+    baseline = y - line_padding
+
+    text_box.at[1].should be_within(0.01).of(baseline)
+  end
+end
+
+describe "Text::Formatted::Box#render with :valign => :bottom" do
+  it "should not render a gap between the text and bottom of box" do
+    create_pdf
+    box_height = 100
+    y = 450
+    array = [{ :text => 'Vertical Align' }]
+    options = {
+     :document => @pdf,
+     :valign => :bottom,
+     :at => [0,y],
+     :width => 100,
+     :height => box_height,
+     :size => 16
+    }
+    text_box = Prawn::Text::Formatted::Box.new(array, options)
+    text_box.render
+    top_padding = y - (box_height - text_box.height)
+
+    text_box.at[1].should be_within(0.01).of(top_padding)
+  end
+end
+
 class TestFragmentCallback
   def initialize(string, number, options)
     @document = options[:document]