prawn 2.1.0 → 2.2.0

data/manual/text/kerning_and_character_spacing.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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 +6,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,3 @@
-# encoding: utf-8
-#
 # Leading is the additional space between lines of text.
 #
 # The leading can be set using the <code>default_leading</code> method which
@@ -7,19 +5,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,57 @@
-# encoding: utf-8
-#
 # 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]))
+
+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,3 @@
-# encoding: utf-8
-#
 # Prawn strips all whitespace from the beginning and the end of strings so there
 # are two ways to indent paragraphs:
 #
@@ -9,25 +7,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

data/manual/text/positioned_text.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Sometimes we want the text on a specific position on the page. The
 # <code>text</code> method just won't help us.
 #
@@ -16,23 +14,22 @@
 # will flow to a new line if it reaches the right border.
 #
 # Given that, <code>text_box</code> is the better option available.
-#
-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
-  draw_text "This draw_text line is absolute positioned. However don't " +
-            "expect it to flow even if it hits the document border",
-            :at => [200, 300]
+  draw_text "This draw_text line is absolute positioned. However don't " \
+    'expect it to flow even if it hits the document border',
+    at: [200, 300]
 
-  text_box "This is a text box, you can control where it will flow by " +
-           "specifying the :height and :width options",
-           :at => [100, 250],
-           :height => 100,
-           :width => 100
+  text_box 'This is a text box, you can control where it will flow by ' \
+    'specifying the :height and :width options',
+    at: [100, 250],
+    height: 100,
+    width: 100
 
-  text_box "Another text box with no :width option passed, so it will " +
-           "flow to a new line whenever it reaches the right margin. ",
-           :at => [200, 100]
+  text_box 'Another text box with no :width option passed, so it will ' \
+    'flow to a new line whenever it reaches the right margin. ',
+    at: [200, 100]
 end

data/manual/text/registering_families.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Registering font families will help you when you want to use a font over and
 # over or if you would like to take advantage of the <code>:style</code> option
 # of the text methods and the <code>b</code> and <code>i</code> tags when using
@@ -7,46 +5,45 @@
 #
 # To register a font family update the <code>font_families</code>
 # hash with the font path for each style you want to use.
-#
-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
   # Registering a single TTF font
   font_families.update(
-    "DejaVu Sans" => {
-      :normal => "#{Prawn::DATADIR}/fonts/DejaVuSans.ttf"
+    'DejaVu Sans' => {
+      normal: "#{Prawn::DATADIR}/fonts/DejaVuSans.ttf"
     }
   )
 
-  font("DejaVu Sans") do
-    text "Using the DejaVu Sans font providing only its name to the font method"
+  font('DejaVu Sans') do
+    text 'Using the DejaVu Sans font providing only its name to the font method'
   end
   move_down 20
 
   # Registering a DFONT package
   font_path = "#{Prawn::DATADIR}/fonts/Panic+Sans.dfont"
   font_families.update(
-    "Panic Sans" => {
-      :normal      => { :file => font_path, :font => "PanicSans" },
-      :italic      => { :file => font_path, :font => "PanicSans-Italic" },
-      :bold        => { :file => font_path, :font => "PanicSans-Bold" },
-      :bold_italic => { :file => font_path, :font => "PanicSans-BoldItalic" }
+    'Panic Sans' => {
+      normal: { file: font_path, font: 'PanicSans' },
+      italic: { file: font_path, font: 'PanicSans-Italic' },
+      bold: { file: font_path, font: 'PanicSans-Bold' },
+      bold_italic: { file: font_path, font: 'PanicSans-BoldItalic' }
     }
   )
 
-  font "Panic Sans"
-  text "Also using Panic Sans by providing only its name"
+  font 'Panic Sans'
+  text 'Also using Panic Sans by providing only its name'
   move_down 20
 
-  text "Taking <b>advantage</b> of the <i>inline formatting</i>",
-       :inline_format => true
+  text 'Taking <b>advantage</b> of the <i>inline formatting</i>',
+    inline_format: true
   move_down 20
 
   [:bold, :bold_italic, :italic, :normal].each do |style|
     text "Using the #{style} style option.",
-         :style => style
+      style: style
     move_down 10
   end
 end

data/manual/text/rendering_and_color.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # You have already seen how to set the text color using both inline formatting
 # and the format text methods. There is another way by using the graphics
 # methods <code>fill_color</code> and <code>stroke_color</code>.
@@ -11,27 +9,26 @@
 # being filled (the default mode) or just stroked or both filled and stroked.
 # This can be set using the <code>text_rendering_mode</code> method or the
 # <code>:mode</code> option on 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
-  fill_color   "00ff00"
-  stroke_color "0000ff"
+  fill_color   '00ff00'
+  stroke_color '0000ff'
 
   font_size(40) do
     # normal rendering mode: fill
-    text "This text is filled with green."
+    text 'This text is filled with green.'
     move_down 20
 
     # inline rendering mode: stroke
-    text "This text is stroked with blue", :mode => :stroke
+    text 'This text is stroked with blue', mode: :stroke
     move_down 20
 
     # block rendering mode: fill and stroke
     text_rendering_mode(:fill_stroke) do
-      text "This text is filled with green and stroked with blue"
+      text 'This text is filled with green and stroked with blue'
     end
   end
 end

data/manual/text/right_to_left_text.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Prawn can be used with right-to-left text. The direction can be set
 # document-wide, on particular text, or on a text-box. Setting the direction to
 # <code>:rtl</code> automatically changes the default alignment to
@@ -13,35 +11,42 @@
 # 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]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
   # set the direction document-wide
   self.text_direction = :rtl
 
-  font("#{Prawn::DATADIR}/fonts/gkai00mp.ttf", :size => 16) do
-    long_text = "写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小"
+  font("#{Prawn::DATADIR}/fonts/gkai00mp.ttf", size: 16) do
+    long_text = '写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个'\
+      '小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事写个小爬虫把你的页'\
+      '面上的关键信息顺次爬下来也不是什么难事写个小'
     text long_text
     move_down 20
 
-    text "You can override the document direction.", :direction => :ltr
+    text 'You can override the document direction.', direction: :ltr
     move_down 20
 
-    formatted_text [{ :text => "更可怕的是，同质化竞争对手可以按照" },
-                    { :text => "URL", :direction => :ltr },
-                    { :text => "中后面这个" },
-                    { :text => "ID",  :direction => :ltr },
-                    { :text => "来遍历您的" },
-                    { :text => "DB",  :direction => :ltr },
-                    { :text => "中的内容，写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事，这样的话，你就非常被动了。" }]
+    formatted_text [
+      { text: '更可怕的是，同质化竞争对手可以按照' },
+      { text: 'URL', direction: :ltr },
+      { text: '中后面这个' },
+      { text: 'ID', direction: :ltr },
+      { text: '来遍历您的' },
+      { text: 'DB', direction: :ltr },
+      { text: '中的内容，写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么'\
+        '难事，这样的话，你就非常被动了。' }
+    ]
     move_down 20
 
-    formatted_text [{ :text => "更可怕的是，同质化竞争对手可以按照" },
-                    { :text => "this",  :direction => :ltr },
-                    { :text => "won't", :direction => :ltr, :size => 24 },
-                    { :text => "work",  :direction => :ltr },
-                    { :text => "中的内容，写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事" }]
+    formatted_text [
+      { text: '更可怕的是，同质化竞争对手可以按照' },
+      { text: 'this',  direction: :ltr },
+      { text: "won't", direction: :ltr, size: 24 },
+      { text: 'work',  direction: :ltr },
+      { text: '中的内容，写个小爬虫把你的页面上的关键信息顺次爬下来也不是什么难事' }
+    ]
   end
 end

data/manual/text/rotation.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,36 +5,41 @@
 # 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::ManualBuilder::Example.generate(filename) do
-  width  = 100
+  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)
+  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
+  [: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