prawn 2.0.2 → 2.3.0

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,37 +10,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 +52,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,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>.
 #
@@ -20,31 +20,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: %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
+  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,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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 +12,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,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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 +10,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

data/manual/text/kerning_and_character_spacing.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Kerning is the process of adjusting the spacing between characters in a
 # proportional font. It is usually done with specific letter pairs. We can
 # switch it on and off if it is available with the current font. Just pass a
@@ -8,32 +8,31 @@
 # Character Spacing is the space between characters. It can be increased or
 # decreased and will have effect on the whole text. Just pass a number to the
 # <code>:character_spacing</code> option from the 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
   font_size(30) do
-    text_box "With kerning:",    :kerning => true,  :at => [0, y - 40]
-    text_box "Without kerning:", :kerning => false, :at => [0, y - 80]
+    text_box 'With kerning:',    kerning: true,  at: [0, y - 40]
+    text_box 'Without kerning:', kerning: false, at: [0, y - 80]
 
-    text_box "Tomato", :kerning => true,  :at => [250, y - 40]
-    text_box "Tomato", :kerning => false, :at => [250, y - 80]
+    text_box 'Tomato', kerning: true,  at: [250, y - 40]
+    text_box 'Tomato', kerning: false, at: [250, y - 80]
 
-    text_box "WAR", :kerning => true,  :at => [400, y - 40]
-    text_box "WAR", :kerning => false, :at => [400, y - 80]
+    text_box 'WAR', kerning: true,  at: [400, y - 40]
+    text_box 'WAR', kerning: false, at: [400, y - 80]
 
-    text_box "F.", :kerning => true,  :at => [500, y - 40]
-    text_box "F.", :kerning => false, :at => [500, y - 80]
+    text_box 'F.', kerning: true,  at: [500, y - 40]
+    text_box 'F.', kerning: false, at: [500, y - 80]
   end
 
   move_down 80
 
-  string = "What have you done to the space between the characters?"
+  string = 'What have you done to the space between the characters?'
   [-2, -1, 0, 0.5, 1, 2].each do |spacing|
     move_down 20
     text "#{string} (character_spacing: #{spacing})",
-         :character_spacing => spacing
+      character_spacing: spacing
   end
 end

data/manual/text/leading.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Leading is the additional space between lines of text.
 #
 # The leading can be set using the <code>default_leading</code> method which
@@ -7,19 +7,18 @@
 # text methods with the <code>:leading</code> option.
 #
 # The default leading is <code>0</code>.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_require '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
-  string = "Hey, what did you do with the space between my lines? " * 10
-  text string, :leading => 0
+  string = 'Hey, what did you do with the space between my lines? ' * 10
+  text string, leading: 0
 
   move_down 20
   default_leading 5
   text string
 
   move_down 20
-  text string, :leading => 10
+  text string, leading: 10
 end

data/manual/text/line_wrapping.rb

@@ -1,41 +1,60 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Line wrapping happens on white space or hyphens. Soft hyphens can be used to
 # indicate where words can be hyphenated. Non-breaking spaces can be used to
 # display space without allowing for a break.
 #
 # For writing styles that do not make use of spaces, the zero width space serves
-# to mark word boundaries. Zero width spaces are available only with TTF fonts.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# to mark word boundaries. Zero width spaces are available only with external
+# fonts.
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
-  text "Hard hyphens:\n" +
-       "Slip-sliding away, slip sliding awaaaay. You know the " +
-       "nearer your destination the more you're slip-sliding away."
+  text "Hard hyphens:\n" \
+    'Slip-sliding away, slip sliding awaaaay. You know the ' \
+    "nearer your destination the more you're slip-sliding away."
   move_down 20
 
   shy = Prawn::Text::SHY
-  text "Soft hyphens:\n" +
-       "Slip slid#{shy}ing away, slip slid#{shy}ing away. You know the " +
-       "nearer your destinat#{shy}ion the more you're slip slid#{shy}ing away."
+  text "Soft hyphens:\n" \
+    "Slip slid#{shy}ing away, slip slid#{shy}ing away. You know the " \
+    "nearer your destinat#{shy}ion the more you're slip slid#{shy}ing away."
   move_down 20
 
   nbsp = Prawn::Text::NBSP
-  text "Non-breaking spaces:\n" +
-       "Slip#{nbsp}sliding away, slip#{nbsp}sliding awaaaay. You know the " +
-       "nearer your destination the more you're slip#{nbsp}sliding away."
+  text "Non-breaking spaces:\n" \
+    "Slip#{nbsp}sliding away, slip#{nbsp}sliding awaaaay. You know the " \
+    "nearer your destination the more you're slip#{nbsp}sliding away."
   move_down 20
 
-  font("#{Prawn::DATADIR}/fonts/gkai00mp.ttf", :size => 16) do
-    long_text = "No word boundaries:\n更可怕的是，同质化竞争对手可以按照URL中后面这个ID来遍历您的DB中的内容，写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事，这样的话，你就非常被动了。更可怕的是，同质化竞争对手可以按照URL中后面这个ID来遍历您的DB中的内容，写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事，这样的话，你就非常被动了。"
+  font("#{Prawn::DATADIR}/fonts/gkai00mp.ttf", size: 16) do
+    long_text = "No word boundaries:\n更可怕的是，"\
+      '同质化竞争对手可以按照URL中后面这个ID来遍历您的DB中的内容，'\
+      '写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事，'\
+      '这样的话，你就非常被动了。更可怕的是，'\
+      '同质化竞争对手可以按照URL中后面这个ID来遍历您的DB中的内容，'\
+      '写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事，'\
+      '这样的话，你就非常被动了。'
     text long_text
     move_down 20
 
     zwsp = Prawn::Text::ZWSP
-    long_text = "Invisible word boundaries:\n更#{zwsp}可怕的#{zwsp}是，#{zwsp}同质化#{zwsp}竞争#{zwsp}对#{zwsp}手#{zwsp}可以#{zwsp}按照#{zwsp}URL#{zwsp}中#{zwsp}后面#{zwsp}这个#{zwsp}ID#{zwsp}来#{zwsp}遍历#{zwsp}您的#{zwsp}DB#{zwsp}中的#{zwsp}内容，#{zwsp}写个#{zwsp}小爬虫#{zwsp}把#{zwsp}你的#{zwsp}页面#{zwsp}上的#{zwsp}关#{zwsp}键#{zwsp}信#{zwsp}息顺#{zwsp}次#{zwsp}爬#{zwsp}下来#{zwsp}也#{zwsp}不是#{zwsp}什么#{zwsp}难事，#{zwsp}这样的话，#{zwsp}你#{zwsp}就#{zwsp}非常#{zwsp}被动了。#{zwsp}更#{zwsp}可怕的#{zwsp}是，#{zwsp}同质化#{zwsp}竞争#{zwsp}对#{zwsp}手#{zwsp}可以#{zwsp}按照#{zwsp}URL#{zwsp}中#{zwsp}后面#{zwsp}这个#{zwsp}ID#{zwsp}来#{zwsp}遍历#{zwsp}您的#{zwsp}DB#{zwsp}中的#{zwsp}内容，#{zwsp}写个#{zwsp}小爬虫#{zwsp}把#{zwsp}你的#{zwsp}页面#{zwsp}上的#{zwsp}关#{zwsp}键#{zwsp}信#{zwsp}息顺#{zwsp}次#{zwsp}爬#{zwsp}下来#{zwsp}也#{zwsp}不是#{zwsp}什么#{zwsp}难事，#{zwsp}这样的话，#{zwsp}你#{zwsp}就#{zwsp}非常#{zwsp}被动了。"
+    long_text = "Invisible word boundaries:\n更#{zwsp}可怕的#{zwsp}是，"\
+      "#{zwsp}同质化#{zwsp}竞争#{zwsp}对#{zwsp}手#{zwsp}可以#{zwsp}按照#{zwsp}"\
+      "URL#{zwsp}中#{zwsp}后面#{zwsp}这个#{zwsp}ID#{zwsp}来#{zwsp}遍历#{zwsp}"\
+      "您的#{zwsp}DB#{zwsp}中的#{zwsp}内容，#{zwsp}写个#{zwsp}小爬虫#{zwsp}把"\
+      "#{zwsp}你的#{zwsp}页面#{zwsp}上的#{zwsp}关#{zwsp}键#{zwsp}信#{zwsp}息顺"\
+      "#{zwsp}次#{zwsp}爬#{zwsp}下来#{zwsp}也#{zwsp}不是#{zwsp}什么#{zwsp}"\
+      "难事，#{zwsp}这样的话，#{zwsp}你#{zwsp}就#{zwsp}非常#{zwsp}被动了。"\
+      "#{zwsp}更#{zwsp}可怕的#{zwsp}是，#{zwsp}同质化#{zwsp}竞争#{zwsp}对"\
+      "#{zwsp}手#{zwsp}可以#{zwsp}按照#{zwsp}URL#{zwsp}中#{zwsp}后面#{zwsp}"\
+      "这个#{zwsp}ID#{zwsp}来#{zwsp}遍历#{zwsp}您的#{zwsp}DB#{zwsp}中的#{zwsp}"\
+      "内容，#{zwsp}写个#{zwsp}小爬虫#{zwsp}把#{zwsp}你的#{zwsp}页面#{zwsp}"\
+      "上的#{zwsp}关#{zwsp}键#{zwsp}信#{zwsp}息顺#{zwsp}次#{zwsp}爬#{zwsp}下来"\
+      "#{zwsp}也#{zwsp}不是#{zwsp}什么#{zwsp}难事，#{zwsp}这样的话，#{zwsp}你"\
+      "#{zwsp}就#{zwsp}非常#{zwsp}被动了。"
     text long_text
   end
 end

data/manual/text/paragraph_indentation.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Prawn strips all whitespace from the beginning and the end of strings so there
 # are two ways to indent paragraphs:
 #
@@ -9,25 +9,24 @@
 # The other is to use the <code>:indent_paragraphs</code> option with the text
 # methods. Just pass a number with the space to indent the first line in each
 # paragraph.
-#
-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
   # Using non-breaking spaces
-  text " " * 10 + "This paragraph won't be indented. " * 10 +
-       "\n#{Prawn::Text::NBSP * 10}" + "This one will with NBSP. " * 10
+  text ' ' * 10 + "This paragraph won't be indented. " * 10 +
+    "\n#{Prawn::Text::NBSP * 10}" + 'This one will with NBSP. ' * 10
 
   move_down 20
-  text "This paragraph will be indented. " * 10 +
-       "\n" + "This one will too. " * 10,
-       :indent_paragraphs => 60
+  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
+  text 'FROM RIGHT TO LEFT:'
+  text 'This paragraph will be indented. ' * 10 +
+    "\n" + 'This one will too. ' * 10,
+    indent_paragraphs: 60, direction: :rtl
 end