prawn 2.1.0 → 2.4.0

data/manual/text/registering_families.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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 +7,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
+  # Registering a single external 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|
+  %i[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,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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 +11,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,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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 +13,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,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,36 +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::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
+  %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::ManualBuilder::Example.generate(filename) do
   # Using a TTF font file
   font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf") do
-    text "Written with the DejaVu Sans TTF font."
+    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/Panic+Sans.dfont") do
-    text "Written with the Panic Sans DFONT font"
+    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,70 +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::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"
+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 "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"
+    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",
-            "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::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
+  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
+  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]
+  text_box(
+    excess_text,
+    width: 300,
+    at: [100, y_position - 100]
+  )
 end