prawn 2.1.0 → 2.2.0

data/manual/images/width_and_height.rb

@@ -1,25 +1,22 @@
-# encoding: utf-8
-#
 # The image size can be set with the <code>:width</code> and
 # <code>:height</code> options.
 #
 # If only one of those is provided, the image will be scaled proportionally.
 # When both are provided, the image will be stretched to fit the dimensions
 # without maintaining the aspect ratio.
-#
-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  "Scale by setting only the width"
-  image "#{Prawn::DATADIR}/images/pigs.jpg", :width => 150
+  text  'Scale by setting only the width'
+  image "#{Prawn::DATADIR}/images/pigs.jpg", width: 150
   move_down 20
 
-  text  "Scale by setting only the height"
-  image "#{Prawn::DATADIR}/images/pigs.jpg", :height => 100
+  text  'Scale by setting only the height'
+  image "#{Prawn::DATADIR}/images/pigs.jpg", height: 100
   move_down 20
 
-  text  "Stretch to fit the width and height provided"
-  image "#{Prawn::DATADIR}/images/pigs.jpg", :width => 500, :height => 100
+  text  'Stretch to fit the width and height provided'
+  image "#{Prawn::DATADIR}/images/pigs.jpg", width: 500, height: 100
 end

data/manual/layout/boxes.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # After defined the grid is there but nothing happens. To start taking effect
 # we need to use the grid boxes.
 #
@@ -7,15 +5,14 @@
 # received. With no arguments it will return the grid itself. With integers it
 # will return the grid box at those indices. With two arrays it will return a
 # multi-box spanning the region of the two grid boxes at the arrays indices.
-#
-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)
+  define_grid(columns: 5, rows: 8, gutter: 10)
 
   grid(4, 0).show
   grid(5, 1).show

data/manual/layout/content.rb

@@ -1,25 +1,22 @@
-# encoding: utf-8
-#
 # Now that we know how to access the boxes we might as well add some content
 # to them.
 #
 # This can be done by taping into the bounding box for a given grid box or
 # multi-box with the <code>bounding_box</code> method.
-#
-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)
+  define_grid(columns: 5, rows: 8, gutter: 10)
 
   grid([5, 0], [7, 1]).bounding_box do
-    text "Adding some content to this multi_box.\n" + " _ " * 200
+    text "Adding some content to this multi_box.\n" + ' _ ' * 200
   end
 
   grid(6, 3).bounding_box do
-    text "Just a little snippet here.\n" + " _ " * 10
+    text "Just a little snippet here.\n" + ' _ ' * 10
   end
 end

data/manual/layout/layout.rb

@@ -1,25 +1,25 @@
-# encoding: utf-8
-#
 # Examples for using grid layouts.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-Prawn::ManualBuilder::Example.generate("layout.pdf", :page_size => "FOLIO") do
-  package "layout" do |p|
-    p.example "simple_grid"
-    p.example "boxes"
-    p.example "content"
+require_relative '../example_helper'
+
+Prawn::ManualBuilder::Example.generate('layout.pdf', page_size: 'FOLIO') do
+  package 'layout' do |p|
+    p.example 'simple_grid'
+    p.example 'boxes'
+    p.example 'content'
 
     p.intro do
-      prose("Prawn has support for two-dimensional grid based layouts out of the box.
+      prose <<-END
+        Prawn has support for two-dimensional grid based layouts out of the box.
 
-      The examples show:")
+        The examples show:
+      END
 
-      list( "How to define the document grid",
-            "How to configure the grid rows and columns gutters",
-            "How to create boxes according to the grid"
-          )
+      list(
+        'How to define the document grid',
+        'How to configure the grid rows and columns gutters',
+        'How to create boxes according to the grid'
+      )
     end
   end
 end

data/manual/layout/simple_grid.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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 +5,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,3 @@
-# encoding: utf-8
-#
 # 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 +14,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 +26,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,3 @@
-# encoding: utf-8
-#
 # Another way to insert nodes into an existing outline is the
 # <code>insert_section_after</code> method.
 #
@@ -8,9 +6,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 +18,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,29 +1,31 @@
-# encoding: utf-8
-#
 # Examples for defining the document outline.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-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
+require_relative '../example_helper'
+
+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.
+      prose <<-END
+        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:")
+        The examples include:
+      END
 
-      list( "How to define sections and pages",
-            "How to insert sections and/or pages to a previously defined outline structure"
-          )
+      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,3 @@
-# encoding: utf-8
-#
 # The document outline tree is the set of links used to navigate through the
 # various document sections and pages.
 #
@@ -23,9 +21,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 +33,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

@@ -1,32 +1,34 @@
-# encoding: utf-8
-#
 # 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 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>"
-  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 }
+  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