prawn 2.1.0 → 2.2.0

data/manual/repeatable_content/page_numbering.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # The <code>number_pages</code> method is a simple way to number the pages of
 # your document. It should be called towards the end of the document since
 # pages created after the call won't be numbered.
@@ -20,33 +18,34 @@
 # <code>color</code> which accepts the same values as <code>fill_color</code>
 #
 # As well as any option accepted by <code>text_box</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
-  text "This is the first page!"
+  text 'This is the first page!'
 
   10.times do
     start_new_page
-    text "Here comes yet another page."
+    text 'Here comes yet another page.'
   end
 
-  string = "page <page> of <total>"
+  string = 'page <page> of <total>'
   # Green page numbers 1 to 7
-  options = { :at => [bounds.right - 150, 0],
-              :width => 150,
-              :align => :right,
-              :page_filter => (1..7),
-              :start_count_at => 1,
-              :color => "007700" }
+  options = {
+    at: [bounds.right - 150, 0],
+    width: 150,
+    align: :right,
+    page_filter: (1..7),
+    start_count_at: 1,
+    color: '007700'
+  }
   number_pages string, options
 
   # Gray page numbers from 8 on up
-  options[:page_filter]    = lambda{ |pg| pg > 7 }
+  options[:page_filter] = ->(pg) { pg > 7 }
   options[:start_count_at] = 8
-  options[:color]          = "333333"
+  options[:color] = '333333'
   number_pages string, options
 
   start_new_page

data/manual/repeatable_content/repeatable_content.rb

@@ -1,29 +1,33 @@
-# encoding: utf-8
-#
 # Examples for stamps and repeaters.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-Prawn::ManualBuilder::Example.generate("repeatable_content.pdf", :page_size => "FOLIO") do
-  package "repeatable_content" do |p|
-    p.example "repeater",       :eval_source => false
-    p.example "stamp"
-    p.example "page_numbering", :eval_source => false
-    p.example "alternate_page_numbering", :eval_source => false
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
+  package 'repeatable_content' do |p|
+    p.example 'repeater', eval_source: false
+    p.example 'stamp'
+    p.example 'page_numbering', eval_source: false
+    p.example 'alternate_page_numbering', eval_source: false
 
     p.intro do
-      prose("Prawn offers two ways to handle repeatable content blocks. Repeater is useful for content that gets repeated at well defined intervals while Stamp is more appropriate if you need better control of when to repeat it.
+      prose <<-END
+        Prawn offers two ways to handle repeatable content blocks. Repeater is
+        useful for content that gets repeated at well defined intervals while
+        Stamp is more appropriate if you need better control of when to repeat
+        it.
 
-      There is also one very specific helper for numbering pages.
+        There is also one very specific helper for numbering pages.
 
-      The examples show:")
+        The examples show:
+      END
 
-      list( "How to repeat content on several pages with a single invocation",
-            "How to create a new Stamp",
-            'How to "stamp" the content block on the page',
-            "How to number the document pages with one simple call"
-          )
+      list(
+        'How to repeat content on several pages with a single invocation',
+        'How to create a new Stamp',
+        'How to "stamp" the content block on the page',
+        'How to number the document pages with one simple call'
+      )
     end
   end
 end

data/manual/repeatable_content/repeater.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # The <code>repeat</code> method is quite versatile when it comes to define
 # the intervals at which the content block should repeat.
 #
@@ -14,42 +12,41 @@
 #
 # It is also important to say that no matter where you define the repeater it
 # will be applied to all matching pages.
-#
-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
   repeat(:all) do
-    draw_text "All pages", :at => bounds.top_left
+    draw_text 'All pages', at: bounds.top_left
   end
 
   repeat(:odd) do
-    draw_text "Only odd pages", :at => [0, 0]
+    draw_text 'Only odd pages', at: [0, 0]
   end
 
   repeat(:even) do
-    draw_text "Only even pages", :at => [0, 0]
+    draw_text 'Only even pages', at: [0, 0]
   end
 
   repeat([1, 3, 7]) do
-    draw_text "Only on pages 1, 3 and 7", :at => [100, 0]
+    draw_text 'Only on pages 1, 3 and 7', at: [100, 0]
   end
 
   repeat(2..4) do
-    draw_text "From the 2nd to the 4th page", :at => [300, 0]
+    draw_text 'From the 2nd to the 4th page', at: [300, 0]
   end
 
-  repeat(lambda { |pg| pg % 3 == 0 }) do
-    draw_text "Every third page", :at => [250, 20]
+  repeat(->(pg) { (pg % 3).zero? }) do
+    draw_text 'Every third page', at: [250, 20]
   end
 
-  repeat(:all, :dynamic => true) do
-    draw_text page_number, :at => [500, 0]
+  repeat(:all, dynamic: true) do
+    draw_text page_number, at: [500, 0]
   end
 
   10.times do
     start_new_page
-    draw_text "A wonderful page", :at => [400, 400]
+    draw_text 'A wonderful page', at: [400, 400]
   end
 end

data/manual/repeatable_content/stamp.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Stamps should be used when you have content that will be included multiple
 # times in a document. Its advantages over creating the content anew each time
 # are:
@@ -15,27 +13,26 @@
 # There are two methods to render the stamp on a page <code>stamp</code> and
 # <code>stamp_at</code>. The first will render the stamp as is while the
 # second accepts a point to serve as an offset to the stamp content.
-#
-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
-  create_stamp("approved") do
-    rotate(30, :origin => [-5, -5]) do
-      stroke_color "FF3333"
+  create_stamp('approved') do
+    rotate(30, origin: [-5, -5]) do
+      stroke_color 'FF3333'
       stroke_ellipse [0, 0], 29, 15
-      stroke_color "000000"
+      stroke_color '000000'
 
-      fill_color "993333"
-      font("Times-Roman") do
-        draw_text "Approved", :at => [-23, -3]
+      fill_color '993333'
+      font('Times-Roman') do
+        draw_text 'Approved', at: [-23, -3]
       end
-      fill_color "000000"
+      fill_color '000000'
     end
   end
 
-  stamp "approved"
+  stamp 'approved'
 
-  stamp_at "approved", [200, 200]
+  stamp_at 'approved', [200, 200]
 end

data/manual/security/encryption.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # The <code>encrypt_document</code> method, as you might have already guessed,
 # is used to encrypt the PDF document.
 #
@@ -12,18 +10,17 @@
 # documentation (you can find it here:
 # https://github.com/prawnpdf/prawn/blob/master/lib/prawn/security.rb ) before
 # using this for anything super serious.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 # Bare encryption. No password needed.
-Prawn::ManualBuilder::Example.generate("bare_encryption.pdf") do
-  text "See, no password was asked but the document is still encrypted."
+Prawn::ManualBuilder::Example.generate('bare_encryption.pdf') do
+  text 'See, no password was asked but the document is still encrypted.'
   encrypt_document
 end
 
 # Simple password. All permissions granted.
-Prawn::ManualBuilder::Example.generate("simple_password.pdf") do
-  text "You was asked for a password."
-  encrypt_document(:user_password => 'foo', :owner_password => 'bar')
+Prawn::ManualBuilder::Example.generate('simple_password.pdf') do
+  text 'You was asked for a password.'
+  encrypt_document(user_password: 'foo', owner_password: 'bar')
 end

data/manual/security/permissions.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # Some permissions may be set for the regular user with the following options:
 # <code>:print_document</code>, <code>:modify_contents</code>,
 # <code>:copy_contents</code>, <code>:modify_annotations</code>. All this
@@ -14,23 +12,28 @@
 # documentation (you can find it here:
 # https://github.com/prawnpdf/prawn/blob/master/lib/prawn/security.rb ) before
 # using this for anything super serious.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 # User cannot print the document.
-Prawn::ManualBuilder::Example.generate("cannot_print.pdf") do
+Prawn::ManualBuilder::Example.generate('cannot_print.pdf') do
   text "If you used the user password you won't be able to print the doc."
-  encrypt_document(:user_password => 'foo', :owner_password => 'bar',
-                   :permissions => { :print_document => false })
+  encrypt_document(
+    user_password: 'foo', owner_password: 'bar',
+    permissions: { print_document: false }
+  )
 end
 
 # All permissions revoked and owner password set to random
-Prawn::ManualBuilder::Example.generate("no_permissions.pdf") do
+Prawn::ManualBuilder::Example.generate('no_permissions.pdf') do
   text "You may only view this and won't be able to use the owner password."
-  encrypt_document(:user_password => 'foo', :owner_password => :random,
-                   :permissions => { :print_document     => false,
-                                     :modify_contents    => false,
-                                     :copy_contents      => false,
-                                     :modify_annotations => false })
+  encrypt_document(
+    user_password: 'foo', owner_password: :random,
+    permissions: {
+      print_document: false,
+      modify_contents: false,
+      copy_contents: false,
+      modify_annotations: false
+    }
+  )
 end

data/manual/security/security.rb

@@ -1,25 +1,26 @@
-# encoding: utf-8
-#
 # Examples for document encryption.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. 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
+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 <<-END
+        Security lets you control who can read the document by defining
+        a password.
 
-      The examples include:")
+        The examples include:
+      END
 
-      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"
-          )
+      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

@@ -1,11 +1,9 @@
-# encoding: UTF-8
-
-require_relative "example_helper"
+require_relative 'example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 
 Prawn::ManualBuilder::Example.generate(filename) do
-  header("Prawn::Table")
+  header('Prawn::Table')
 
   prose <<-END_TEXT
     As of Prawn 1.2.0, Prawn::Table has been extracted into its own

data/manual/text/alignment.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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 +9,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::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
+  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,23 +1,22 @@
-# encoding: utf-8
-#
 # 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::ManualBuilder::Example.generate(filename) do
-  text "Default color is black"
+  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,20 +1,17 @@
-# encoding: utf-8
-#
 # 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::ManualBuilder::Example.generate(filename) do
-  text "The Prince",          :align => :center, :size => 18
-  text "Niccolò Machiavelli", :align => :center, :size => 14
+  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
+  column_box([0, cursor], columns: 2, width: bounds.width) do
     text((<<-END.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