prawn 2.1.0 → 2.3.0

data/manual/images/horizontal.rb

@@ -1,25 +1,24 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The image may be positioned relatively to the current bounding box. The
 # horizontal position may be set with the <code>:position</code> option.
 #
 # It may be <code>:left</code>, <code>:center</code>, <code>:right</code> or a
 # number representing an x-offset from the left boundary.
-#
-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
-  bounding_box([50, cursor], :width => 400, :height => 450) do
+  bounding_box([50, cursor], width: 400, height: 450) do
     stroke_bounds
 
-    [:left, :center, :right].each do |position|
+    %i[left center right].each do |position|
       text  "Image aligned to the #{position}."
-      image "#{Prawn::DATADIR}/images/stef.jpg", :position => position
+      image "#{Prawn::DATADIR}/images/stef.jpg", position: position
     end
 
-    text  "The next image has a 50 point offset from the left boundary"
-    image "#{Prawn::DATADIR}/images/stef.jpg", :position => 50
+    text  'The next image has a 50 point offset from the left boundary'
+    image "#{Prawn::DATADIR}/images/stef.jpg", position: 50
   end
 end

data/manual/images/images.rb

@@ -1,37 +1,41 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Examples for embedding images.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::ManualBuilder::Example.generate("images.pdf", :page_size => "FOLIO") do
-  package "images" do |p|
-    p.section "Basics" do |s|
-      s.example "plain_image"
-      s.example "absolute_position"
+
+require_relative '../example_helper'
+
+Prawn::ManualBuilder::Example.generate('images.pdf', page_size: 'FOLIO') do
+  package 'images' do |p|
+    p.section 'Basics' do |s|
+      s.example 'plain_image'
+      s.example 'absolute_position'
     end
 
-    p.section "Relative Positioning" do |s|
-      s.example "horizontal"
-      s.example "vertical"
+    p.section 'Relative Positioning' do |s|
+      s.example 'horizontal'
+      s.example 'vertical'
     end
 
-    p.section "Size" do |s|
-      s.example "width_and_height"
-      s.example "scale"
-      s.example "fit"
+    p.section 'Size' do |s|
+      s.example 'width_and_height'
+      s.example 'scale'
+      s.example 'fit'
     end
 
     p.intro do
-      prose("Embedding images on PDF documents is fairly easy. Prawn supports both JPG and PNG images.
+      prose <<-TEXT
+        Embedding images on PDF documents is fairly easy. Prawn supports both
+        JPG and PNG images.
 
-      The examples show:")
+        The examples show:
+      TEXT
 
-      list( "How to add an image to a page",
-            "How place the image on a specific position",
-            "How to configure the image dimensions by setting the width and height or by scaling it"
-          )
+      list(
+        'How to add an image to a page',
+        'How place the image on a specific position',
+        'How to configure the image dimensions by setting the width and '\
+          'height or by scaling it'
+      )
     end
   end
 end

data/manual/images/plain_image.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # To embed images onto your PDF file use the <code>image</code> method.
 # It accepts the file path of the image to be loaded and some optional
 # arguments.
@@ -7,12 +7,11 @@
 # If only the image path is provided the image will be rendered starting on
 # the cursor position. No manipulation is done with the image even if it doesn't
 # fit entirely on the page like the following snippet.
-#
-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 image will go right below this line of text."
+  text 'The image will go right below this line of text.'
   image "#{Prawn::DATADIR}/images/pigs.jpg"
 end

data/manual/images/scale.rb

@@ -1,22 +1,21 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # To scale an image use the <code>:scale</code> option.
 #
 # It scales the image proportionally given the provided value.
-#
-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  "Normal size"
+  text  'Normal size'
   image "#{Prawn::DATADIR}/images/stef.jpg"
   move_down 20
 
-  text  "Scaled to 50%"
-  image "#{Prawn::DATADIR}/images/stef.jpg", :scale => 0.5
+  text  'Scaled to 50%'
+  image "#{Prawn::DATADIR}/images/stef.jpg", scale: 0.5
   move_down 20
 
-  text  "Scaled to 200%"
-  image "#{Prawn::DATADIR}/images/stef.jpg", :scale => 2
+  text  'Scaled to 200%'
+  image "#{Prawn::DATADIR}/images/stef.jpg", scale: 2
 end

data/manual/images/vertical.rb

@@ -1,28 +1,27 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # To set the vertical position of an image use the <code>:vposition</code>
 # option.
 #
 # It may be <code>:top</code>, <code>:center</code>, <code>:bottom</code> or a
 # number representing the y-offset from the top boundary.
-#
-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
-  bounding_box([0, cursor], :width => 500, :height => 450) do
+  bounding_box([0, cursor], width: 500, height: 450) do
     stroke_bounds
 
-    [:top, :center, :bottom].each do |vposition|
-      text "Image vertically aligned to the #{vposition}.", :valign => vposition
-      image "#{Prawn::DATADIR}/images/stef.jpg", :position  => 250,
-                                                 :vposition => vposition
+    %i[top center bottom].each do |vposition|
+      text "Image vertically aligned to the #{vposition}.", valign: vposition
+      image "#{Prawn::DATADIR}/images/stef.jpg",
+        position: 250, vposition: vposition
     end
 
-    text_box "The next image has a 100 point offset from the top boundary",
-             :at => [bounds.width - 110, bounds.top - 10], :width => 100
-    image "#{Prawn::DATADIR}/images/stef.jpg", :position  => :right,
-                                               :vposition => 100
+    text_box 'The next image has a 100 point offset from the top boundary',
+      at: [bounds.width - 110, bounds.top - 10], width: 100
+    image "#{Prawn::DATADIR}/images/stef.jpg",
+      position: :right, vposition: 100
   end
 end

data/manual/images/width_and_height.rb

@@ -1,25 +1,24 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # After defined the grid is there but nothing happens. To start taking effect
 # we need to use the grid boxes.
 #
@@ -7,15 +7,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,24 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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,27 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # 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 <<-TEXT
+        Prawn has support for two-dimensional grid based layouts out of the box.
 
-      The examples show:")
+        The examples show:
+      TEXT
 
-      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,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