prawn 1.1.0 → 2.4.0

data/manual/layout/simple_grid.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The document grid on Prawn is just a table-like structure with a defined
 # number of rows and columns. There are some helpers to create boxes of content
 # based on the grid coordinates.
@@ -7,16 +7,15 @@
 # <code>define_grid</code> accepts the following options which are pretty much
 # self-explanatory: <code>:rows</code>, <code>:columns</code>,
 # <code>:gutter</code>, <code>:row_gutter</code>, <code>:column_gutter</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
   # The grid only need to be defined once, but since all the examples should be
   # able to run alone we are repeating it on every example
-  define_grid(:columns => 5, :rows => 8, :gutter => 10)
-  text "We defined the grid, roll over to the next page to see its outline"
+  define_grid(columns: 5, rows: 8, gutter: 10)
+  text 'We defined the grid, roll over to the next page to see its outline'
 
   start_new_page
   grid.show_all

data/manual/outline/add_subsection_to.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # We have already seen how to define an outline tree sequentially.
 #
 # If you'd like to add nodes to the middle of an outline tree the
@@ -16,9 +16,8 @@
 #
 # If the parent title provided is the title of a page. The page will be
 # converted into a section to receive the subsection 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
@@ -29,33 +28,33 @@ Prawn::ManualBuilder::Example.generate(filename) do
   end
 
   outline.define do
-    section("Section 1", :destination => 1) do
-      page :title => "Page 2", :destination => 2
-      page :title => "Page 3", :destination => 3
+    section('Section 1', destination: 1) do
+      page title: 'Page 2', destination: 2
+      page title: 'Page 3', destination: 3
     end
   end
 
   # Now we will start adding nodes to the previous outline
-  outline.add_subsection_to("Section 1", :first) do
-    outline.section("Added later - first position") do
-      outline.page :title => "Page 4", :destination => 4
-      outline.page :title => "Page 5", :destination => 5
+  outline.add_subsection_to('Section 1', :first) do
+    outline.section('Added later - first position') do
+      outline.page title: 'Page 4', destination: 4
+      outline.page title: 'Page 5', destination: 5
     end
   end
 
-  outline.add_subsection_to("Section 1") do
-    outline.page :title => "Added later - last position",
-                 :destination => 6
+  outline.add_subsection_to('Section 1') do
+    outline.page title: 'Added later - last position',
+                 destination: 6
   end
 
-  outline.add_subsection_to("Added later - first position") do
-    outline.page :title => "Another page added later",
-                 :destination => 7
+  outline.add_subsection_to('Added later - first position') do
+    outline.page title: 'Another page added later',
+                 destination: 7
   end
 
   # The title provided is for a page which will be converted into a section
-  outline.add_subsection_to("Page 3") do
-    outline.page :title => "Last page added",
-                 :destination => 8
+  outline.add_subsection_to('Page 3') do
+    outline.page title: 'Last page added',
+                 destination: 8
   end
 end

data/manual/outline/insert_section_after.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Another way to insert nodes into an existing outline is the
 # <code>insert_section_after</code> method.
 #
@@ -8,9 +8,8 @@
 #
 # As is the case with <code>add_subsection_to</code> the section added
 # doesn't need to be a section, it may be just a page.
-#
-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
@@ -21,27 +20,27 @@ Prawn::ManualBuilder::Example.generate(filename) do
   end
 
   outline.define do
-    section("Section 1", :destination => 1) do
-      page :title => "Page 2", :destination => 2
-      page :title => "Page 3", :destination => 3
+    section('Section 1', destination: 1) do
+      page title: 'Page 2', destination: 2
+      page title: 'Page 3', destination: 3
     end
   end
 
   # Now we will start adding nodes to the previous outline
-  outline.insert_section_after("Page 2") do
-    outline.section("Section after Page 2") do
-      outline.page :title => "Page 4", :destination => 4
+  outline.insert_section_after('Page 2') do
+    outline.section('Section after Page 2') do
+      outline.page title: 'Page 4', destination: 4
     end
   end
 
-  outline.insert_section_after("Section 1") do
-    outline.section("Section after Section 1") do
-      outline.page :title => "Page 5", :destination => 5
+  outline.insert_section_after('Section 1') do
+    outline.section('Section after Section 1') do
+      outline.page title: 'Page 5', destination: 5
     end
   end
 
   # Adding just a page
-  outline.insert_section_after("Page 3") do
-    outline.page :title => "Page after Page 3", :destination => 6
+  outline.insert_section_after('Page 3') do
+    outline.page title: 'Page after Page 3', destination: 6
   end
 end

data/manual/outline/outline.rb

@@ -1,32 +1,33 @@
-# encoding: utf-8
-#
-# Examples for defining the document outline.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# frozen_string_literal: true
 
-Prawn::ManualBuilder::Example.generate("outline.pdf", :page_size => "FOLIO") do
+# Examples for defining the document outline.
 
-  package "outline" do |p|
+require_relative '../example_helper'
 
-    p.section "Basics" do |s|
-      s.example "sections_and_pages", :eval_source => false
+Prawn::ManualBuilder::Example.generate('outline.pdf', page_size: 'FOLIO') do
+  package 'outline' do |p|
+    p.section 'Basics' do |s|
+      s.example 'sections_and_pages', eval_source: false
     end
 
-    p.section "Adding nodes later" do |s|
-      s.example "add_subsection_to",    :eval_source => false
-      s.example "insert_section_after", :eval_source => false
+    p.section 'Adding nodes later' do |s|
+      s.example 'add_subsection_to', eval_source: false
+      s.example 'insert_section_after', eval_source: false
     end
 
     p.intro do
-      prose("The outline of a PDF document is the table of contents tab you see to the right or left of your PDF viewer.
-
-      The examples include:")
-
-      list( "How to define sections and pages",
-            "How to insert sections and/or pages to a previously defined outline structure"
-          )
+      prose <<-TEXT
+        The outline of a PDF document is the table of contents tab you see to
+        the right or left of your PDF viewer.
+
+        The examples include:
+      TEXT
+
+      list(
+        'How to define sections and pages',
+        'How to insert sections and/or pages to a previously defined outline '\
+        'structure'
+      )
     end
-
   end
 end

data/manual/outline/sections_and_pages.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The document outline tree is the set of links used to navigate through the
 # various document sections and pages.
 #
@@ -23,9 +23,8 @@
 # <code>section</code> and <code>page</code> may also be used without the
 # <code>define</code> method but they will need to instantiate the
 # <code>outline</code> object every time.
-#
-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
@@ -36,32 +35,32 @@ Prawn::ManualBuilder::Example.generate(filename) do
   end
 
   outline.define do
-    section("Section 1", :destination => 1) do
-      page :title => "Page 2", :destination => 2
-      page :title => "Page 3", :destination => 3
+    section('Section 1', destination: 1) do
+      page title: 'Page 2', destination: 2
+      page title: 'Page 3', destination: 3
     end
 
-    section("Section 2", :destination => 4) do
-      page :title => "Page 5", :destination => 5
+    section('Section 2', destination: 4) do
+      page title: 'Page 5', destination: 5
 
-      section("Subsection 2.1", :destination => 6, :closed => true) do
-        page :title => "Page 7", :destination => 7
+      section('Subsection 2.1', destination: 6, closed: true) do
+        page title: 'Page 7', destination: 7
       end
     end
   end
 
   # Outside of the define block
-  outline.section("Section 3", :destination => 8) do
-    outline.page :title => "Page 9", :destination => 9
+  outline.section('Section 3', destination: 8) do
+    outline.page title: 'Page 9', destination: 9
   end
 
-  outline.page :title => "Page 10", :destination => 10
+  outline.page title: 'Page 10', destination: 10
 
   # Section and Pages without links. While a section without a link may be
   # useful to group some pages, a page without a link is useless
-  outline.update do  # update is an alias to define
-    section("Section without link") do
-      page :title => "Page without link"
+  outline.update do # update is an alias to define
+    section('Section without link') do
+      page title: 'Page without link'
     end
   end
 end

data/manual/repeatable_content/alternate_page_numbering.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Below is the code to generate page numbers that alternate being rendered
+# on the right and left side of the page. The first page will have a "1" in
+# the bottom right corner. The second page will have a "2" in the bottom
+# left corner of the page. The third a "3" in the bottom right, etc.
+
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  text 'This is the first page!'
+
+  10.times do
+    start_new_page
+    text 'Here comes yet another page.'
+  end
+
+  string = '<page>'
+  odd_options = {
+    at: [bounds.right - 150, 0],
+    width: 150,
+    align: :right,
+    page_filter: :odd,
+    start_count_at: 1
+  }
+  even_options = {
+    at: [0, bounds.left],
+    width: 150,
+    align: :left,
+    page_filter: :even,
+    start_count_at: 2
+  }
+  number_pages string, odd_options
+  number_pages string, even_options
+end

data/manual/repeatable_content/page_numbering.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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 +20,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,31 +1,35 @@
-# encoding: utf-8
-#
-# Examples for stamps and repeaters.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# frozen_string_literal: true
 
-Prawn::ManualBuilder::Example.generate("repeatable_content.pdf", :page_size => "FOLIO") do
+# Examples for stamps and repeaters.
 
-  package "repeatable_content" do |p|
+require_relative '../example_helper'
 
-    p.example "repeater",       :eval_source => false
-    p.example "stamp"
-    p.example "page_numbering", :eval_source => false
+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.
-
-      There is also one very specific helper for numbering pages.
-
-      The examples show:")
-
-      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"
-          )
+      prose <<-TEXT
+        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.
+
+        The examples show:
+      TEXT
+
+      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,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The <code>repeat</code> method is quite versatile when it comes to define
 # the intervals at which the content block should repeat.
 #
@@ -14,42 +14,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]
+  repeat([1, 3, 7]) do
+    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,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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 +15,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,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The <code>encrypt_document</code> method, as you might have already guessed,
 # is used to encrypt the PDF document.
 #
@@ -12,20 +12,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,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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,25 +14,30 @@
 # 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