prawn 0.13.0 → 2.4.0

data/manual/security/security.rb

@@ -1,28 +1,28 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Examples for document encryption.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-Prawn::Example.generate("security.pdf", :page_size => "FOLIO") do
-  
-  package "security" do |p|
-    
-    p.example "encryption",  :eval_source => false, :full_source => true
-    p.example "permissions", :eval_source => false, :full_source => true
-    
+require_relative '../example_helper'
+
+Prawn::ManualBuilder::Example.generate('security.pdf', page_size: 'FOLIO') do
+  package 'security' do |p|
+    p.example 'encryption', eval_source: false, full_source: true
+    p.example 'permissions', eval_source: false, full_source: true
+
     p.intro do
-      prose("Security lets you control who can read the document by defining a password.
+      prose <<-TEXT
+        Security lets you control who can read the document by defining
+        a password.
 
-      The examples include:")
+        The examples include:
+      TEXT
 
-      list( "How to encrypt the document without the need for a password",
-            "How to configure the regular user permitions",
-            "How to require a password for the regular user",
-            "How to set a owner password that bypass the document permissions"
-          )
+      list(
+        'How to encrypt the document without the need for a password',
+        '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'
+      )
     end
-    
   end
 end

data/manual/table.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+
+Prawn::ManualBuilder::Example.generate(filename) do
+  header('Prawn::Table')
+
+  prose <<-END_TEXT
+    As of Prawn 1.2.0, Prawn::Table has been extracted into its own
+    semi-officially supported gem.
+
+    Please see https://github.com/prawnpdf/prawn-table for more details.
+  END_TEXT
+end

data/manual/text/alignment.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Horizontal text alignment can be achieved by supplying the <code>:align</code>
 # option to the text methods. Available options are <code>:left</code>
 # (default), <code>:right</code>, <code>:center</code>, and
@@ -11,34 +11,33 @@
 #
 # Both forms of alignment will be evaluated in the context of the current
 # bounding_box.
-#
-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 "This text should be left aligned"
-  text "This text should be centered",      :align => :center
-  text "This text should be right aligned", :align => :right
+Prawn::ManualBuilder::Example.generate(filename) do
+  text 'This text should be left aligned'
+  text 'This text should be centered', align: :center
+  text 'This text should be right aligned', align: :right
 
-  bounding_box([0, 220], :width => 250, :height => 220) do
-    text "This text is flowing from the left. "   * 4
+  bounding_box([0, 220], width: 250, height: 220) do
+    text 'This text is flowing from the left. ' * 4
 
     move_down 15
-    text "This text is flowing from the center. " * 3, :align => :center
+    text 'This text is flowing from the center. ' * 3, align: :center
 
     move_down 15
-    text "This text is flowing from the right. "  * 4, :align => :right
+    text 'This text is flowing from the right. ' * 4, align: :right
 
     move_down 15
-    text "This text is justified. "  * 6, :align => :justify
+    text 'This text is justified. ' * 6, align: :justify
     transparent(0.5) { stroke_bounds }
   end
 
-  bounding_box([300, 220], :width => 250, :height => 220) do
-    text "This text should be vertically top aligned"
-    text "This text should be vertically centered",       :valign => :center
-    text "This text should be vertically bottom aligned", :valign => :bottom
+  bounding_box([300, 220], width: 250, height: 220) do
+    text 'This text should be vertically top aligned'
+    text 'This text should be vertically centered', valign: :center
+    text 'This text should be vertically bottom aligned', valign: :bottom
     transparent(0.5) { stroke_bounds }
   end
 end

data/manual/text/color.rb

@@ -1,24 +1,24 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The <code>:color</code> attribute can give a block of text a default color,
 # in RGB hex format or 4-value CMYK.
-#
-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 "Default color is black"
+Prawn::ManualBuilder::Example.generate(filename) do
+  text 'Default color is black'
   move_down 25
 
-  text "Changed to red", :color => "FF0000"
+  text 'Changed to red', color: 'FF0000'
   move_down 25
 
-  text "CMYK color", :color => [22, 55, 79, 30]
+  text 'CMYK color', color: [22, 55, 79, 30]
   move_down 25
 
-  text "Also works with <color rgb='ff0000'>inline</color> formatting",
-       :color => "0000FF",
-       :inline_format => true
+  text(
+    "Also works with <color rgb='ff0000'>inline</color> formatting",
+    color: '0000FF',
+    inline_format: true
+  )
 end
-

data/manual/text/column_box.rb

@@ -1,21 +1,20 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The <code>column_box</code> method allows you to define columns that flow
 # their contents from one section to the next. You can have a number of columns
 # on the page, and only when the last column overflows will a new page be
 # created.
-#
-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 "The Prince",          :align => :center, :size => 18
-  text "Niccolò Machiavelli", :align => :center, :size => 14
+Prawn::ManualBuilder::Example.generate(filename) do
+  text 'The Prince', align: :center, size: 18
+  text 'Niccolò Machiavelli', align: :center, size: 14
   move_down 12
 
-  column_box([0, cursor], :columns => 2, :width => bounds.width) do
-    text((<<-END.gsub(/\s+/, ' ') + "\n\n") * 3)
+  column_box([0, cursor], columns: 2, width: bounds.width) do
+    text("#{<<~TEXT.gsub(/\s+/, ' ')}\n\n" * 3)
       All the States and Governments by which men are or ever have been ruled,
       have been and are either Republics or Princedoms. Princedoms are either
       hereditary, in which the sovereignty is derived through an ancient line
@@ -26,7 +25,6 @@ Prawn::Example.generate(filename) do
       acquired have either been used to live under a Prince or have been free;
       and he who acquires them does so either by his own arms or by the arms of
       others, and either by good fortune or by merit.
-    END
+    TEXT
   end
 end
-

data/manual/text/fallback_fonts.rb

@@ -1,37 +1,41 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Prawn enables the declaration of fallback fonts for those glyphs that may not
 # be present in the desired font. Use the <code>:fallback_fonts</code> option
 # with any of the text or text box methods, or set fallback_fonts document-wide.
-#
-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
   file = "#{Prawn::DATADIR}/fonts/gkai00mp.ttf"
-  font_families["Kai"] = {
-    :normal => { :file => file, :font => "Kai" }
+  font_families['Kai'] = {
+    normal: { file: file, font: 'Kai' }
   }
-  
-  file = "#{Prawn::DATADIR}/fonts/Action Man.dfont"
-  font_families["Action Man"] = {
-    :normal => { :file => file, :font => "ActionMan" },
+
+  file = "#{Prawn::DATADIR}/fonts/Panic+Sans.dfont"
+  font_families['Panic Sans'] = {
+    normal: { file: file, font: 'PanicSans' }
   }
-  
-  font("Action Man") do
-    text("When fallback fonts are included, each glyph will be rendered " +
-         "using the first font that includes the glyph, starting with the " +
-         "current font and then moving through the fallback fonts from left " +
-         "to right." +
-         "\n\n" +
-         "hello ƒ 你好\n再见 ƒ goodbye",
-         :fallback_fonts => ["Times-Roman", "Kai"])
+
+  font('Panic Sans') do
+    text(
+      'When fallback fonts are included, each glyph will be rendered ' \
+      'using the first font that includes the glyph, starting with the ' \
+      'current font and then moving through the fallback fonts from left ' \
+      'to right.' \
+      "\n\n" \
+      "hello ƒ 你好\n再见 ƒ goodbye",
+      fallback_fonts: %w[Times-Roman Kai]
+    )
   end
   move_down 20
 
-  formatted_text([ { :text => "Fallback fonts can even override" },
-                   { :text => "fragment fonts (你好)", :font => "Times-Roman" },
-                 ],
-                 :fallback_fonts => ["Times-Roman", "Kai"])
+  formatted_text(
+    [
+      { text: 'Fallback fonts can even override' },
+      { text: 'fragment fonts (你好)', font: 'Times-Roman' }
+    ],
+    fallback_fonts: %w[Times-Roman Kai]
+  )
 end

data/manual/text/font.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-# 
+# frozen_string_literal: true
+
 # The <code>font</code> method can be used in three different ways.
 #
 # If we don't pass it any arguments it will return the current font being used
@@ -12,30 +12,29 @@
 # specified font will only be used to render text inside the block.
 #
 # The default font is Helvetica.
-#
-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
   text "Let's see which font we are using: #{font.inspect}"
-  
+
   move_down 20
-  font "Times-Roman"
-  text "Written in Times."
-  
+  font 'Times-Roman'
+  text 'Written in Times.'
+
   move_down 20
-  font("Courier") do
-    text "Written in Courier because we are inside the block."
+  font('Courier') do
+    text 'Written in Courier because we are inside the block.'
   end
-  
+
   move_down 20
-  text "Written in Times again as we left the previous block."
-  
+  text 'Written in Times again as we left the previous block.'
+
   move_down 20
   text "Let's see which font we are using again: #{font.inspect}"
-  
+
   move_down 20
-  font "Helvetica"
-  text "Back to normal."
+  font 'Helvetica'
+  text 'Back to normal.'
 end

data/manual/text/font_size.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-# 
+# frozen_string_literal: true
+
 # The <code>font_size</code> method works just like the <code>font</code>
 # method.
 #
@@ -10,36 +10,35 @@
 # option to the text methods.
 #
 # The default font size is <code>12</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
+Prawn::ManualBuilder::Example.generate(filename) do
   text "Let's see which is the current font_size: #{font_size.inspect}"
-  
+
   move_down 10
   font_size 16
-  text "Yeah, something bigger!"
-  
+  text 'Yeah, something bigger!'
+
   move_down 10
-  font_size(25) { text "Even bigger!" }
-  
+  font_size(25) { text 'Even bigger!' }
+
   move_down 10
-  text "Back to 16 again."
-  
+  text 'Back to 16 again.'
+
   move_down 10
-  text "Single line on 20 using the :size option.", :size => 20
-  
+  text 'Single line on 20 using the :size option.', size: 20
+
   move_down 10
-  text "Back to 16 once more."
-  
+  text 'Back to 16 once more.'
+
   move_down 10
-  font("Courier", :size => 10) do
-    text "Yeah, using Courier 10 courtesy of the font method."
+  font('Courier', size: 10) do
+    text 'Yeah, using Courier 10 courtesy of the font method.'
   end
-  
+
   move_down 10
-  font("Helvetica", :size => 12)
-  text "Back to normal"
+  font('Helvetica', size: 12)
+  text 'Back to normal'
 end

data/manual/text/font_style.rb

@@ -1,22 +1,24 @@
-# encoding: utf-8
-# 
+# frozen_string_literal: true
+
 # Most font families come with some styles other than normal. Most common are
 # <code>bold</code>, <code>italic</code> and <code>bold_italic</code>.
 #
 # The style can be set the using the <code>:style</code> option, with either the
 # <code>font</code> method which will set the font and style for rest of the
 # document, or with the inline text methods.
-#
-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
-  ["Courier", "Helvetica", "Times-Roman"].each do |example_font|
+Prawn::ManualBuilder::Example.generate(filename) do
+  fonts = %w[Courier Helvetica Times-Roman]
+  styles = %i[bold bold_italic italic normal]
+
+  fonts.each do |example_font|
     move_down 20
-    
-    [:bold, :bold_italic, :italic, :normal].each do |style|
-      font example_font, :style => style
+
+    styles.each do |style|
+      font example_font, style: style
       text "I'm writing in #{example_font} (#{style})"
     end
   end

data/manual/text/formatted_callbacks.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The <code>:callback</code> option is also available for the formatted text
 # methods.
 #
@@ -10,51 +10,61 @@
 #
 # This example defines two new callback classes and provide callback objects
 # for the formatted_text
-#
-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
   class HighlightCallback
     def initialize(options)
-      @color    = options[:color]
+      @color = options[:color]
       @document = options[:document]
     end
 
     def render_behind(fragment)
-      original_color       = @document.fill_color
+      original_color = @document.fill_color
       @document.fill_color = @color
-      @document.fill_rectangle(fragment.top_left, fragment.width,
-                                                  fragment.height)
+      @document.fill_rectangle(
+        fragment.top_left,
+        fragment.width,
+        fragment.height
+      )
       @document.fill_color = original_color
     end
   end
 
   class ConnectedBorderCallback
     def initialize(options)
-      @radius   = options[:radius]
+      @radius = options[:radius]
       @document = options[:document]
     end
 
     def render_in_front(fragment)
-      @document.stroke_polygon(fragment.top_left, fragment.top_right,
-                               fragment.bottom_right, fragment.bottom_left)
-      
-      @document.fill_circle(fragment.top_left,     @radius)
-      @document.fill_circle(fragment.top_right,    @radius)
+      @document.stroke_polygon(
+        fragment.top_left,
+        fragment.top_right,
+        fragment.bottom_right,
+        fragment.bottom_left
+      )
+
+      @document.fill_circle(fragment.top_left, @radius)
+      @document.fill_circle(fragment.top_right, @radius)
       @document.fill_circle(fragment.bottom_right, @radius)
-      @document.fill_circle(fragment.bottom_left,  @radius)
+      @document.fill_circle(fragment.bottom_left, @radius)
     end
   end
 
-  highlight = HighlightCallback.new(:color => 'ffff00', :document => self)
-  border    = ConnectedBorderCallback.new(:radius => 2.5, :document => self)
-  
-  formatted_text [ { :text => "hello", :callback => highlight },
-                   { :text => "     " },
-                   { :text => "world", :callback => border },
-                   { :text => "     " },
-                   { :text => "hello world", :callback => [highlight, border] }
-                 ], :size => 20
+  highlight = HighlightCallback.new(color: 'ffff00', document: self)
+  border = ConnectedBorderCallback.new(radius: 2.5, document: self)
+
+  formatted_text(
+    [
+      { text: 'hello', callback: highlight },
+      { text: '     ' },
+      { text: 'world', callback: border },
+      { text: '     ' },
+      { text: 'hello world', callback: [highlight, border] }
+    ],
+    size: 20
+  )
 end

data/manual/text/formatted_text.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # There are two other text methods available: <code>formatted_text</code> and
 # <code>formatted_text_box</code>.
 #
@@ -17,38 +17,45 @@
 # <code>:character_spacing</code> (additional space between the characters),
 # <code>:font</code> (the name of a registered font), <code>:color</code> (the
 # same input accepted by <code>fill_color</code> and <code>stroke_color</code>),
-# <code>:link</code> (an URL to create a link), <code>:anchor</code> (a
-# destination inside the document), and <code>:local</code> (a link to a local
-# file).
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# <code>:link</code> (an URL to create a link), and <code>:local</code>
+# (a link to a local file).
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  formatted_text [ { :text => "Some bold. ",      :styles => [:bold] },
-                   { :text => "Some italic. ",    :styles => [:italic] },
-                   { :text => "Bold italic. ",    :styles => [:bold, :italic] },
-                   { :text => "Bigger Text. ",    :size  => 20 },
-                   { :text => "More spacing. ",   :character_spacing => 3 },
-                   { :text => "Different Font. ", :font => "Courier" },
-                   { :text => "Some coloring. ",  :color => "FF00FF" },
-                   { :text => "Link to the wiki. ",
-                     :color => "0000FF",
-                     :link => "https://github.com/prawnpdf/prawn/wiki" },
-                   { :text => "Link to the Text Reference. "  ,
-                     :color => "0000FF",
-                     :anchor => "Text Reference" },
-                   { :text => "Link to a local file. ",
-                     :color => "0000FF",
-                     :local => "./local_file.txt" }
-                 ]
-  
-  formatted_text_box [ { :text => "Just your regular" },
-                       { :text => " text_box ", :font => "Courier" },
-                       { :text => "with some additional formatting options " +
-                                  "added to the mix.",
-                         :color => [50, 100, 0, 0],
-                         :styles => [:italic] }
-                     ], :at => [100, 100], :width => 200, :height => 100
+Prawn::ManualBuilder::Example.generate(filename) do
+  formatted_text([
+    { text: 'Some bold. ', styles: [:bold] },
+    { text: 'Some italic. ', styles: [:italic] },
+    { text: 'Bold italic. ', styles: %i[bold italic] },
+    { text: 'Bigger Text. ', size: 20 },
+    { text: 'More spacing. ', character_spacing: 3 },
+    { text: 'Different Font. ', font: 'Courier' },
+    { text: 'Some coloring. ', color: 'FF00FF' },
+    {
+      text: 'Link to the wiki. ',
+      color: '0000FF',
+      link: 'https://github.com/prawnpdf/prawn/wiki'
+    },
+    {
+      text: 'Link to a local file. ',
+      color: '0000FF',
+      local: './local_file.txt'
+    }
+  ])
+
+  formatted_text_box(
+    [
+      { text: 'Just your regular' },
+      { text: ' text_box ', font: 'Courier' },
+      {
+        text: 'with some additional formatting options added to the mix.',
+        color: [50, 100, 0, 0],
+        styles: [:italic]
+      }
+    ],
+    at: [100, 100],
+    width: 200,
+    height: 100
+  )
 end