prawn 2.1.0 → 2.2.0

data/manual/text/fallback_fonts.rb

@@ -1,37 +1,39 @@
-# encoding: utf-8
-#
 # 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::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/Panic+Sans.dfont"
-  font_families["Panic Sans"] = {
-    :normal => { :file => file, :font => "PanicSans" }
+  font_families['Panic Sans'] = {
+    normal: { file: file, font: 'PanicSans' }
   }
 
-  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 => ["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: ['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: ['Times-Roman', 'Kai']
+  )
 end

data/manual/text/font.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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 +10,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::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,3 @@
-# encoding: utf-8
-#
 # The <code>font_size</code> method works just like the <code>font</code>
 # method.
 #
@@ -10,9 +8,8 @@
 # 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::ManualBuilder::Example.generate(filename) do
@@ -20,26 +17,26 @@ Prawn::ManualBuilder::Example.generate(filename) do
 
   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,19 @@
-# encoding: utf-8
-#
 # 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::ManualBuilder::Example.generate(filename) do
-  ["Courier", "Helvetica", "Times-Roman"].each do |example_font|
+  ['Courier', 'Helvetica', 'Times-Roman'].each do |example_font|
     move_down 20
 
     [:bold, :bold_italic, :italic, :normal].each do |style|
-      font example_font, :style => 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,3 @@
-# encoding: utf-8
-#
 # The <code>:callback</code> option is also available for the formatted text
 # methods.
 #
@@ -10,37 +8,40 @@
 #
 # 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::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.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)
@@ -49,13 +50,14 @@ Prawn::ManualBuilder::Example.generate(filename) do
     end
   end
 
-  highlight = HighlightCallback.new(:color => 'ffff00', :document => self)
-  border    = ConnectedBorderCallback.new(:radius => 2.5, :document => self)
+  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
+  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,3 @@
-# encoding: utf-8
-#
 # There are two other text methods available: <code>formatted_text</code> and
 # <code>formatted_text_box</code>.
 #
@@ -20,31 +18,39 @@
 # <code>:link</code> (an URL to create a link), and <code>:local</code>
 # (a link to a local file).
 
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::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 a local file. ",
-                     :color => "0000FF",
-                     :local => "./local_file.txt" }
-                 ]
+  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 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
+  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

data/manual/text/free_flowing_text.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Text rendering can be as simple or as complex as you want.
 #
 # This example covers the most basic method: <code>text</code>. It is meant for
@@ -12,40 +10,39 @@
 #
 # This example also shows text flowing across pages following the margin box and
 # other bounding boxes.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
   move_cursor_to 50
-  text "This text will flow to the next page. " * 20
+  text 'This text will flow to the next page. ' * 20
 
   y_position = cursor - 50
-  bounding_box([0, y_position], :width => 200, :height => 150) do
+  bounding_box([0, y_position], width: 200, height: 150) do
     transparent(0.5) { stroke_bounds }
-    text "This text will flow along this bounding box we created for it. " * 5
+    text 'This text will flow along this bounding box we created for it. ' * 5
   end
 
-  bounding_box([300, y_position], :width => 200, :height => 150) do
+  bounding_box([300, y_position], width: 200, height: 150) do
     transparent(0.5) { stroke_bounds }  # This will stroke on one page
 
-    text "Now look what happens when the free flowing text reaches the end " +
-         "of a bounding box that is narrower than the margin box." +
-         " . " * 200 +
-         "It continues on the next page as if the previous bounding box " +
-         "was cloned. If we want it to have the same border as the one on " +
-         "the previous page we will need to stroke the boundaries again."
+    text 'Now look what happens when the free flowing text reaches the end ' \
+      'of a bounding box that is narrower than the margin box.' +
+      ' . ' * 200 +
+      'It continues on the next page as if the previous bounding box ' \
+      'was cloned. If we want it to have the same border as the one on ' \
+      'the previous page we will need to stroke the boundaries again.'
 
     transparent(0.5) { stroke_bounds }  # And this will stroke on the next
   end
 
   move_cursor_to 200
-  span(350, :position => :center) do
-    text "Span is a different kind of bounding box as it lets the text " +
-         "flow gracefully onto the next page. It doesn't matter if the text " +
-         "started on the middle of the previous page, when it flows to the " +
-         "next page it will start at the beginning." + " _ " * 500 +
-         "I told you it would start on the beginning of this page."
+  span(350, position: :center) do
+    text 'Span is a different kind of bounding box as it lets the text ' \
+      "flow gracefully onto the next page. It doesn't matter if the text " \
+      'started on the middle of the previous page, when it flows to the ' \
+      'next page it will start at the beginning.' + ' _ ' * 500 +
+      'I told you it would start on the beginning of this page.'
   end
 end

data/manual/text/inline.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Inline formatting gives you the option to format specific portions of a text.
 # It uses HTML-esque syntax inside the text string. Supported tags are:
 # <code>b</code> (bold), <code>i</code> (italic), <code>u</code> (underline),
@@ -10,32 +8,31 @@
 # <code>size</code>, <code>name</code>, and <code>character_spacing</code>;
 # <code>color</code> accepts <code>rgb</code> and <code>cmyk</code>;
 # <code>link</code> accepts <code>href</code> for external links.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
   %w[b i u strikethrough sub sup].each do |tag|
-    text "Just your regular text <#{tag}>except this portion</#{tag}> " +
-         "is using the #{tag} tag",
-         :inline_format => true
+    text "Just your regular text <#{tag}>except this portion</#{tag}> " \
+      "is using the #{tag} tag",
+      inline_format: true
     move_down 10
   end
 
-  text "This <font size='18'>line</font> uses " +
-       "<font name='Courier'>all the font tag</font> attributes in " +
-       "<font character_spacing='2'>a single line</font>. ",
-       :inline_format => true
+  text "This <font size='18'>line</font> uses " \
+    "<font name='Courier'>all the font tag</font> attributes in " \
+    "<font character_spacing='2'>a single line</font>. ",
+    inline_format: true
   move_down 10
 
-  text "Coloring in <color rgb='FF00FF'>both RGB</color> " +
-       "<color c='100' m='0' y='0' k='0'>and CMYK</color>",
-       :inline_format => true
+  text "Coloring in <color rgb='FF00FF'>both RGB</color> " \
+    "<color c='100' m='0' y='0' k='0'>and CMYK</color>",
+    inline_format: true
   move_down 10
 
-  text "This an external link to the " +
-       "<u><link href='https://github.com/prawnpdf/prawn/wiki'>Prawn wiki" +
-       "</link></u>",
-       :inline_format => true
+  text 'This an external link to the ' \
+    "<u><link href='https://github.com/prawnpdf/prawn/wiki'>Prawn wiki" \
+    '</link></u>',
+    inline_format: true
 end