prawn 2.2.2 → 2.3.0

data/manual/graphics/line_width.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The <code>line_width=</code> method sets the stroke width for subsequent
 # stroke calls.
 #
@@ -31,3 +33,4 @@ Prawn::ManualBuilder::Example.generate(filename) do
     y -= 100
   end
 end
+# rubocop: enable Lint/UselessAssignment

data/manual/graphics/lines_and_curves.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Prawn supports drawing both lines and curves starting either at the current
 # position, or from a specified starting position.
 #

data/manual/graphics/polygon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Drawing polygons in Prawn is easy, just pass a sequence of points to one of
 # the polygon family of methods.
 #

data/manual/graphics/rectangle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # To draw a rectangle, just provide the upper-left corner, width and height to
 # the <code>rectangle</code> method.
 #

data/manual/graphics/rotate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This transformation is used to rotate the user space. Give it an angle
 # and an <code>:origin</code> point about which to rotate and a block.
 # Everything inside the block will be drawn with the rotated coordinates.

data/manual/graphics/scale.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This transformation is used to scale the user space. Give it an scale factor
 # and an <code>:origin</code> point and everything inside the block will be
 # scaled using the origin point as reference.

data/manual/graphics/soft_masks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Soft masks are used for more complex alpha channel manipulations. You can use
 # arbitrary drawing functions for creation of soft masks. The resulting alpha
 # channel is made of greyscale version of the drawing (luminosity channel to be

data/manual/graphics/stroke_cap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The cap style defines how the edge of a line or curve will be drawn. There are
 # three types: <code>:butt</code> (the default), <code>:round</code> and
 # <code>:projecting_square</code>
@@ -18,7 +20,7 @@ Prawn::ManualBuilder::Example.generate(filename) do
 
   self.line_width = 25
 
-  [:butt, :round, :projecting_square].each_with_index do |cap, i|
+  %i[butt round projecting_square].each_with_index do |cap, i|
     self.cap_style = cap
 
     y = 250 - i * 100

data/manual/graphics/stroke_dash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This sets the dashed pattern for lines and curves. The (dash) length defines
 # how long each dash will be.
 #

data/manual/graphics/stroke_join.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The join style defines how the intersection between two lines is drawn. There
 # are three types: <code>:miter</code> (the default), <code>:round</code> and
 # <code>:bevel</code>
@@ -13,7 +15,7 @@ Prawn::ManualBuilder::Example.generate(filename) do
 
   self.line_width = 25
 
-  [:miter, :round, :bevel].each_with_index do |style, i|
+  %i[miter round bevel].each_with_index do |style, i|
     self.join_style = style
 
     y = 200 - i * 100

data/manual/graphics/translate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This transformation is used to translate the user space. Just provide the
 # x and y coordinates for the new origin.
 

data/manual/graphics/transparency.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Although the name of the method is <code>transparency</code>, what we are
 # actually setting is the opacity for fill and stroke. So <code>0</code> means
 # completely transparent and <code>1.0</code> means completely opaque

data/manual/how_to_read_this_manual.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Prawn manual how to read this manual page.
 
 require_relative 'example_helper'

data/manual/images/absolute_position.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # One of the options that the <code>image</code> method accepts is
 # <code>:at</code>. If you've read some of the graphics examples you are
 # probably already familiar with it. Just provide it the upper-left corner where

data/manual/images/fit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # <code>:fit</code> option is useful when you want the image to have the
 # maximum size within a container preserving the aspect ratio without
 # overlapping.

data/manual/images/horizontal.rb

@@ -1,3 +1,5 @@
+# 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.
 #
@@ -11,7 +13,7 @@ Prawn::ManualBuilder::Example.generate(filename) 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
     end

data/manual/images/images.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Examples for embedding images.
 
 require_relative '../example_helper'
@@ -21,12 +23,12 @@ Prawn::ManualBuilder::Example.generate('images.pdf', page_size: 'FOLIO') do
     end
 
     p.intro do
-      prose <<-END
+      prose <<-TEXT
         Embedding images on PDF documents is fairly easy. Prawn supports both
         JPG and PNG images.
 
         The examples show:
-      END
+      TEXT
 
       list(
         'How to add an image to a page',

data/manual/images/plain_image.rb

@@ -1,3 +1,5 @@
+# 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.

data/manual/images/scale.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # To scale an image use the <code>:scale</code> option.
 #
 # It scales the image proportionally given the provided value.

data/manual/images/vertical.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # To set the vertical position of an image use the <code>:vposition</code>
 # option.
 #
@@ -11,7 +13,7 @@ Prawn::ManualBuilder::Example.generate(filename) do
   bounding_box([0, cursor], width: 500, height: 450) do
     stroke_bounds
 
-    [:top, :center, :bottom].each do |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

data/manual/images/width_and_height.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The image size can be set with the <code>:width</code> and
 # <code>:height</code> options.
 #

data/manual/layout/boxes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # After defined the grid is there but nothing happens. To start taking effect
 # we need to use the grid boxes.
 #

data/manual/layout/content.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Now that we know how to access the boxes we might as well add some content
 # to them.
 #

data/manual/layout/layout.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Examples for using grid layouts.
 
 require_relative '../example_helper'
@@ -9,11 +11,11 @@ Prawn::ManualBuilder::Example.generate('layout.pdf', page_size: 'FOLIO') do
     p.example 'content'
 
     p.intro do
-      prose <<-END
+      prose <<-TEXT
         Prawn has support for two-dimensional grid based layouts out of the box.
 
         The examples show:
-      END
+      TEXT
 
       list(
         'How to define the document grid',

data/manual/layout/simple_grid.rb

@@ -1,3 +1,5 @@
+# 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.

data/manual/outline/add_subsection_to.rb

@@ -1,3 +1,5 @@
+# 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

data/manual/outline/insert_section_after.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Another way to insert nodes into an existing outline is the
 # <code>insert_section_after</code> method.
 #

data/manual/outline/outline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Examples for defining the document outline.
 
 require_relative '../example_helper'
@@ -14,12 +16,12 @@ Prawn::ManualBuilder::Example.generate('outline.pdf', page_size: 'FOLIO') do
     end
 
     p.intro do
-      prose <<-END
+      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:
-      END
+      TEXT
 
       list(
         'How to define sections and pages',

data/manual/outline/sections_and_pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The document outline tree is the set of links used to navigate through the
 # various document sections and pages.
 #

data/manual/repeatable_content/alternate_page_numbering.rb

@@ -1,3 +1,5 @@
+# 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

data/manual/repeatable_content/page_numbering.rb

@@ -1,3 +1,5 @@
+# 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.

data/manual/repeatable_content/repeatable_content.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Examples for stamps and repeaters.
 
 require_relative '../example_helper'
@@ -11,7 +13,7 @@ Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
     p.example 'alternate_page_numbering', eval_source: false
 
     p.intro do
-      prose <<-END
+      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
@@ -20,7 +22,7 @@ Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
         There is also one very specific helper for numbering pages.
 
         The examples show:
-      END
+      TEXT
 
       list(
         'How to repeat content on several pages with a single invocation',

data/manual/repeatable_content/repeater.rb

@@ -1,3 +1,5 @@
+# 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.
 #

data/manual/repeatable_content/stamp.rb

@@ -1,3 +1,5 @@
+# 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:

data/manual/security/encryption.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The <code>encrypt_document</code> method, as you might have already guessed,
 # is used to encrypt the PDF document.
 #

data/manual/security/permissions.rb

@@ -1,3 +1,5 @@
+# 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

data/manual/security/security.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Examples for document encryption.
 
 require_relative '../example_helper'
@@ -8,12 +10,12 @@ Prawn::ManualBuilder::Example.generate('security.pdf', page_size: 'FOLIO') do
     p.example 'permissions', eval_source: false, full_source: true
 
     p.intro do
-      prose <<-END
+      prose <<-TEXT
         Security lets you control who can read the document by defining
         a password.
 
         The examples include:
-      END
+      TEXT
 
       list(
         'How to encrypt the document without the need for a password',

data/manual/table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')

data/manual/text/alignment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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

data/manual/text/color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The <code>:color</code> attribute can give a block of text a default color,
 # in RGB hex format or 4-value CMYK.
 

data/manual/text/column_box.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -12,7 +14,7 @@ Prawn::ManualBuilder::Example.generate(filename) do
   move_down 12
 
   column_box([0, cursor], columns: 2, width: bounds.width) do
-    text((<<-END.gsub(/\s+/, ' ') + "\n\n") * 3)
+    text((<<-TEXT.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
       hereditary, in which the sovereignty is derived through an ancient line
@@ -23,6 +25,6 @@ Prawn::ManualBuilder::Example.generate(filename) do
       acquired have either been used to live under a Prince or have been free;
       and he who acquires them does so either by his own arms or by the arms of
       others, and either by good fortune or by merit.
-    END
+    TEXT
   end
 end

data/manual/text/fallback_fonts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Prawn enables the declaration of fallback fonts for those glyphs that may not
 # be present in the desired font. Use the <code>:fallback_fonts</code> option
 # with any of the text or text box methods, or set fallback_fonts document-wide.
@@ -24,7 +26,7 @@ Prawn::ManualBuilder::Example.generate(filename) do
       'to right.' \
       "\n\n" \
       "hello ƒ 你好\n再见 ƒ goodbye",
-      fallback_fonts: ['Times-Roman', 'Kai']
+      fallback_fonts: %w[Times-Roman Kai]
     )
   end
   move_down 20
@@ -34,6 +36,6 @@ Prawn::ManualBuilder::Example.generate(filename) do
       { text: 'Fallback fonts can even override' },
       { text: 'fragment fonts (你好)', font: 'Times-Roman' }
     ],
-    fallback_fonts: ['Times-Roman', 'Kai']
+    fallback_fonts: %w[Times-Roman Kai]
   )
 end

data/manual/text/font.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The <code>font</code> method can be used in three different ways.
 #
 # If we don't pass it any arguments it will return the current font being used

data/manual/text/font_size.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The <code>font_size</code> method works just like the <code>font</code>
 # method.
 #