prawn 0.13.0 → 2.4.0

data/manual/text/rotation.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Rotating text is best avoided on free flowing text, so this example
 # will only use the <code>text_box</code> method as we can have much more
 # control over its output.
@@ -7,37 +7,46 @@
 # To rotate text all we need to do is use the <code>:rotate</code> option
 # passing an angle in degrees and an optional <code>:rotate_around</code> to
 # indicate the origin of the rotation (the default is <code>:upper_left</code>).
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  width  = 100
+Prawn::ManualBuilder::Example.generate(filename) do
+  width = 100
   height = 60
-  angle  = 30
-  x      = 200
-  y      = cursor - 30
+  angle = 30
+  x = 200
+  y = cursor - 30
 
   stroke_rectangle [0, y], width, height
-  text_box("This text was not rotated",
-           :at => [0, y], :width => width, :height => height)
-  
+  text_box(
+    'This text was not rotated',
+    at: [0, y],
+    width: width,
+    height: height
+  )
+
   stroke_rectangle [0, y - 100], width, height
-  text_box("This text was rotated around the center",
-           :at => [0, y - 100], :width => width, :height => height,
-           :rotate => angle, :rotate_around => :center)
-  
-  [:lower_left, :upper_left,
-   :lower_right, :upper_right].each_with_index do |corner, index|
-    
-    y = y - 100 if index == 2
+  text_box(
+    'This text was rotated around the center',
+    at: [0, y - 100],
+    width: width,
+    height: height,
+    rotate: angle,
+    rotate_around: :center
+  )
+
+  %i[lower_left upper_left lower_right upper_right]
+    .each_with_index do |corner, index|
+    y -= 100 if index == 2
     stroke_rectangle [x + (index % 2) * 200, y], width, height
-    text_box("This text was rotated around the #{corner} corner.",
-             :at     => [x + (index % 2) * 200, y],
-             :width  => width,
-             :height => height,
-             :rotate => angle,
-             :rotate_around => corner)
+    text_box(
+      "This text was rotated around the #{corner} corner.",
+      at: [x + (index % 2) * 200, y],
+      width: width,
+      height: height,
+      rotate: angle,
+      rotate_around: corner
+    )
   end
 end

data/manual/text/single_usage.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The PDF format has some built-in font support. If you want to use other fonts
 # in Prawn you need to embed the font file.
 #
@@ -12,26 +12,25 @@
 # times, providing the path each time it is used becomes cumbersome. The example
 # on the next page shows a better way to deal with fonts which are used several
 # times in a document.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   # Using a TTF font file
-  font("#{Prawn::DATADIR}/fonts/Chalkboard.ttf") do
-    text "Written with the Chalkboard TTF font."
+  font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf") do
+    text 'Written with the DejaVu Sans TTF font.'
   end
   move_down 20
-  
-  text "Written with the default font."
+
+  text 'Written with the default font.'
   move_down 20
-  
+
   # Using an DFONT font file
-  font("#{Prawn::DATADIR}/fonts/Action Man.dfont") do
-    text "Written with the Action Man DFONT font"
+  font("#{Prawn::DATADIR}/fonts/Panic+Sans.dfont") do
+    text 'Written with the Panic Sans DFONT font'
   end
   move_down 20
 
-  text "Written with the default font once more."
+  text 'Written with the default font once more.'
 end

data/manual/text/text.rb

@@ -1,75 +1,75 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Examples for text rendering.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-Prawn::Example.generate("text.pdf", :page_size => "FOLIO") do
-  
-  package "text" do |p|
-    
-    p.section "Basics" do |s|
-      s.example "free_flowing_text"
-      s.example "positioned_text"
-      s.example "text_box_overflow"
-      s.example "text_box_excess"
-      s.example "group"
-      s.example "column_box"
+require '../example_helper'
+
+Prawn::ManualBuilder::Example.generate('text.pdf', page_size: 'FOLIO') do
+  package 'text' do |p|
+    p.section 'Basics' do |s|
+      s.example 'free_flowing_text'
+      s.example 'positioned_text'
+      s.example 'text_box_overflow'
+      s.example 'text_box_excess'
+      s.example 'column_box'
     end
-    
-    p.section "Styling" do |s|
-      s.example "font"
-      s.example "font_size"
-      s.example "font_style"
-      s.example "color"
-      s.example "alignment"
-      s.example "leading"
-      s.example "kerning_and_character_spacing"
-      s.example "paragraph_indentation"
-      s.example "rotation"
+
+    p.section 'Styling' do |s|
+      s.example 'font'
+      s.example 'font_size'
+      s.example 'font_style'
+      s.example 'color'
+      s.example 'alignment'
+      s.example 'leading'
+      s.example 'kerning_and_character_spacing'
+      s.example 'paragraph_indentation'
+      s.example 'rotation'
     end
-    
-    p.section "Advanced Styling" do |s|
-      s.example "inline"
-      s.example "formatted_text"
-      s.example "formatted_callbacks"
-      s.example "rendering_and_color"
-      s.example "text_box_extensions"
+
+    p.section 'Advanced Styling' do |s|
+      s.example 'inline'
+      s.example 'formatted_text'
+      s.example 'formatted_callbacks'
+      s.example 'rendering_and_color'
+      s.example 'text_box_extensions'
     end
-    
-    p.section "External Fonts" do |s|
-      s.example "single_usage"
-      s.example "registering_families"
+
+    p.section 'External Fonts' do |s|
+      s.example 'single_usage'
+      s.example 'registering_families'
     end
-    
-    p.section "M17n" do |s|
-      s.example "utf8"
-      s.example "line_wrapping"
-      s.example "right_to_left_text"
-      s.example "fallback_fonts"
-      s.example "win_ansi_charset"
+
+    p.section 'Multilingualization' do |s|
+      s.example 'utf8'
+      s.example 'line_wrapping'
+      s.example 'right_to_left_text'
+      s.example 'fallback_fonts'
+      s.example 'win_ansi_charset'
     end
-    
+
     p.intro do
-      prose("This is probably the feature people will use the most. There is no shortage of options when it comes to text. You'll be hard pressed to find a use case that is not covered by one of the text methods and configurable options.
+      prose <<-TEXT
+        This is probably the feature people will use the most. There is no
+        shortage of options when it comes to text. You'll be hard pressed to
+        find a use case that is not covered by one of the text methods and
+        configurable options.
 
-      The examples show:")
+        The examples show:
+      TEXT
 
-      list( "Text that flows from page to page automatically starting new pages when necessary",
-            "How to use text boxes and place them on specific positions",
-            "What to do when a text box is too small to fit its content",
-            "How to proceed when you want to prevent paragraphs from splitting between pages",
-            "Flowing text in columns",
-            "How to change the text style configuring font, size, alignment and many other settings",
-            "How to style specific portions of a text with inline styling and formatted text",
-            "How to define formatted callbacks to reuse common styling definitions",
-            "How to use the different rendering modes available for the text methods",
-            "How to create your custom text box extensions",
-            "How to use external fonts on your pdfs",
-            "What happens when rendering text in different languages"
-          )
+      list(
+        'Text that flows from page to page automatically starting new pages when necessary',
+        'How to use text boxes and place them on specific positions',
+        'What to do when a text box is too small to fit its content',
+        'Flowing text in columns',
+        'How to change the text style configuring font, size, alignment and many other settings',
+        'How to style specific portions of a text with inline styling and formatted text',
+        'How to define formatted callbacks to reuse common styling definitions',
+        'How to use the different rendering modes available for the text methods',
+        'How to create your custom text box extensions',
+        'How to use external fonts on your pdfs',
+        'What happens when rendering text in different languages'
+      )
     end
-    
   end
 end

data/manual/text/text_box_excess.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Whenever the <code>text_box</code> method truncates text, this truncated bit
 # is not lost, it is the method return value and we can take advantage of that.
 #
@@ -8,25 +8,28 @@
 # This example renders as much of the text as will fit in a larger font inside
 # one text_box and then proceeds to render the remaining text in the default
 # size in a second text_box.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  string = "This is the beginning of the text. It will be cut somewhere and " +
-           "the rest of the text will procede to be rendered this time by " +
-           "calling another method." + " . " * 50
+Prawn::ManualBuilder::Example.generate(filename) do
+  string = 'This is the beginning of the text. It will be cut somewhere and ' \
+    'the rest of the text will procede to be rendered this time by ' \
+    'calling another method.' + ' . ' * 50
 
   y_position = cursor - 20
-  excess_text = text_box string,
-                         :width    => 300,
-                         :height   => 50,
-                         :overflow => :truncate,
-                         :at       => [100, y_position],
-                         :size     => 18
-  
-  text_box excess_text,
-           :width    => 300,
-           :at       => [100, y_position - 100]
+  excess_text = text_box(
+    string,
+    width: 300,
+    height: 50,
+    overflow: :truncate,
+    at: [100, y_position],
+    size: 18
+  )
+
+  text_box(
+    excess_text,
+    width: 300,
+    at: [100, y_position - 100]
+  )
 end

data/manual/text/text_box_extensions.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # We've already seen one way of using text boxes with the <code>text_box</code>
 # method. Turns out this method is just a convenience for using the
 # <code>Prawn::Text::Box</code> class as it creates a new object and call
@@ -9,12 +9,11 @@
 # effect when we use the <code>text_box</code> method. To add an extension all
 # we need to do is append the <code>Prawn::Text::Box.extensions</code> array
 # with a module.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   module TriangleBox
     def available_width
       height + 25
@@ -22,22 +21,26 @@ Prawn::Example.generate(filename) do
   end
 
   y_position = cursor - 10
-  width      = 100
-  height     = 100
-  
+  width = 100
+  height = 100
+
   Prawn::Text::Box.extensions << TriangleBox
   stroke_rectangle([0, y_position], width, height)
-  text_box("A" * 100,
-           :at => [0, y_position],
-           :width => width,
-           :height => height)
-  
+  text_box(
+    'A' * 100,
+    at: [0, y_position],
+    width: width,
+    height: height
+  )
+
   Prawn::Text::Formatted::Box.extensions << TriangleBox
   stroke_rectangle([200, y_position], width, height)
-  formatted_text_box([:text => "A" * 100, :color => "009900"],
-                     :at => [200, y_position],
-                     :width => width,
-                     :height => height)
+  formatted_text_box(
+    [{ text: 'A' * 100, color: '009900' }],
+    at: [200, y_position],
+    width: width,
+    height: height
+  )
 
   # Here we clear the extensions array
   Prawn::Text::Box.extensions.clear

data/manual/text/text_box_overflow.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The <code>text_box</code> method accepts both <code>:width</code> and
 # <code>:height</code> options. So what happens if the text doesn't fit the box?
 #
@@ -9,36 +9,43 @@
 # (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.
 #
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# If the <code>:disable_wrap_by_char</code> is set to <code>true</code>
+# then any text wrapping done while using the <code>:shrink_to_fit</code>
+# mode will not break up the middle of words.
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  string = "This is the sample text used for the text boxes. See how it " +
-           "behave with the various overflow options used."
+Prawn::ManualBuilder::Example.generate(filename) do
+  string = 'This is the sample text used for the text boxes. See how it ' \
+    'behave with the various overflow options used.'
 
   text string
-  
+
   y_position = cursor - 20
-  [:truncate, :expand, :shrink_to_fit].each_with_index do |mode, i|
-    text_box string, :at => [i * 150, y_position],
-             :width => 100, :height => 50,
-             :overflow => mode
+  %i[truncate expand shrink_to_fit].each_with_index do |mode, i|
+    text_box string,
+      at: [i * 150, y_position],
+      width: 100,
+      height: 50,
+      overflow: mode
   end
-  
-  string = "If the box is too small for the text, :shrink_to_fit " +
-           "can render the text in a really small font size."
-  
+
+  string = 'If the box is too small for the text, :shrink_to_fit ' \
+    'can render the text in a really small font size.'
+
   move_down 120
   text string
   y_position = cursor - 20
   [nil, 8, 10, 12].each_with_index do |value, index|
-    text_box string, :at => [index * 150, y_position],
-             :width => 50, :height => 50,
-             :overflow => :shrink_to_fit,
-             :min_font_size => value
+    text_box string,
+      at: [index * 150, y_position],
+      width: 50,
+      height: 50,
+      overflow: :shrink_to_fit,
+      min_font_size: value
   end
 end

data/manual/text/utf8.rb

@@ -1,28 +1,27 @@
-# encoding: utf-8
-# 
+# frozen_string_literal: true
+
 # Multilingualization isn't much of a problem on Prawn as its default encoding
 # is UTF-8. The only thing you need to worry about is if the font support the
 # glyphs of your language.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  text "Take this example, a simple Euro sign:"
-  text "€", :size => 32
+Prawn::ManualBuilder::Example.generate(filename) do
+  text 'Take this example, a simple Euro sign:'
+  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 external fonts:'
   move_down 20
-  
+
   font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf") do
-    text "ὕαλον ϕαγεῖν δύναμαι· τοῦτο οὔ με βλάπτει."
-    text "There you go."
+    text 'ὕαλον ϕαγεῖν δύναμαι· τοῦτο οὔ με βλάπτει.'
+    text 'There you go.'
   end
 end

data/manual/text/win_ansi_charset.rb

@@ -1,56 +1,59 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Prints a list of all of the glyphs that can be rendered by Adobe's built
 # in fonts, along with their character widths and WinAnsi codes.  Be sure
 # to pass these glyphs as UTF-8, and Prawn will transcode them for you.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  FONT_SIZE = 9.5
+Prawn::ManualBuilder::Example.generate(filename) do
+  font_size = 9.5
 
   x = 0
   y = bounds.top
 
-  fields = [[20, :right], [8, :left], [12, :center], [30, :right], [8, :left],
-            [0, :left]]
+  fields = [
+    [20, :right], [8, :left], [12, :center], [30, :right], [8, :left],
+    [0, :left]
+  ]
 
-  font "Helvetica", :size => FONT_SIZE
+  font 'Helvetica', size: font_size
 
-  move_down 30
-  text "(See next page for WinAnsi table)", :align => :center
   start_new_page
 
   Prawn::Encoding::WinAnsi::CHARACTERS.each_with_index do |name, index|
-    next if name == ".notdef"
-    y -= FONT_SIZE
+    next if name == '.notdef'
+
+    y -= font_size
 
-    if y < FONT_SIZE
-      y = bounds.top - FONT_SIZE
+    if y < font_size
+      y = bounds.top - font_size
       x += 170
     end
 
-    code = "%d." % index
-    char = index.chr
+    code = format('%<index>d.', index: index)
+    char = index.chr.force_encoding(::Encoding::Windows_1252)
 
-    width = 1000 * width_of(char, :size => FONT_SIZE) / FONT_SIZE
-    size  = "%d" % width
+    width = 1000 * width_of(char, size: font_size) / font_size
+    size = format('%<width>d', width: width)
 
     data = [code, nil, char, size, nil, name]
-    dx   = x
+    dx = x
     fields.zip(data).each do |(total_width, align), field|
       if field
-        width = width_of(field, :size => FONT_SIZE)
+        width = width_of(field, size: font_size)
 
         case align
-        when :left   then offset = 0
-        when :right  then offset = total_width - width
-        when :center then offset = (total_width - width)/2
+        when :left then offset = 0
+        when :right then offset = total_width - width
+        when :center then offset = (total_width - width) / 2
         end
 
-        text_box(field, :at => [dx + offset, y], :skip_encoding => true)
+        text_box(
+          field.dup.force_encoding('windows-1252').encode('UTF-8'),
+          at: [dx + offset, y]
+        )
       end
 
       dx += total_width