prawn 2.2.2 → 2.3.0

data/lib/prawn/utilities.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 # utilities.rb : General-purpose utility classes which don't fit anywhere else
 #
 # Copyright August 2012, Alex Dowad. All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require 'thread'
-
 module Prawn
   # Throughout the Prawn codebase, repeated calculations which can benefit from
   # caching are made.

data/lib/prawn/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Prawn
-  VERSION = '2.2.2'.freeze
+  VERSION = '2.3.0'
 end

data/lib/prawn/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # prawn/view.rb : Implements a mixin for Prawn's DSL
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
@@ -9,6 +11,12 @@ module Prawn
   #     class Greeter
   #       include Prawn::View
   #
+  #       # Optional override: allows you to set document options or even use
+  #       # a custom document class
+  #       def document
+  #         @document ||= Prawn::Document.new(page_size: 'A4')
+  #       end
+  #
   #       def initialize(name)
   #         @name = name
   #       end
@@ -61,14 +69,14 @@ module Prawn
 
     # Delegates all unhandled calls to object returned by +document+ method.
     # (which is an instance of Prawn::Document by default)
-    def method_missing(m, *a, &b)
-      return super unless document.respond_to?(m)
+    def method_missing(method_name, *arguments, &block)
+      return super unless document.respond_to?(method_name)
 
-      document.send(m, *a, &b)
+      document.send(method_name, *arguments, &block)
     end
 
-    def respond_to_missing?
-      document.respond_to?(m)
+    def respond_to_missing?(method_name, _include_all = false)
+      document.respond_to?(method_name)
     end
 
     # Syntactic sugar that uses +instance_eval+ under the hood to provide
@@ -79,8 +87,8 @@ module Prawn
     #      say_goodbye
     #    end
     #
-    def update(&b)
-      instance_eval(&b)
+    def update(&block)
+      instance_eval(&block)
     end
 
     # Syntatic sugar that calls +document.render_file+ under the hood.

data/manual/basic_concepts/adding_pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A PDF document is a collection of pages. When we create a new document be it
 # with <code>Document.new</code> or on a <code>Document.generate</code> block
 # one initial page is created for us.

data/manual/basic_concepts/basic_concepts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Examples for Prawn basic concepts.
 #
 
@@ -15,7 +17,7 @@ Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
     p.example 'view', eval_source: false, full_source: true
 
     p.intro do
-      prose <<-END
+      prose <<-TEXT
         This chapter covers the minimum amount of functionality you'll need to
         start using Prawn.
 
@@ -24,7 +26,7 @@ Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
         Basics section of the Graphics, Bounding Box and Text sections.
 
         The examples show:
-      END
+      TEXT
 
       list(
         'How to create new pdf documents in every possible way',

data/manual/basic_concepts/creation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # There are three ways to create a PDF Document in Prawn: creating a new
 # <code>Prawn::Document</code> instance, or using the
 # <code>Prawn::Document.generate</code> method with and without block arguments.

data/manual/basic_concepts/cursor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # We normally write our documents from top to bottom and it is no different with
 # Prawn. Even if the origin is on the bottom left corner we still fill the page
 # from the top to the bottom. In other words the cursor for inserting content

data/manual/basic_concepts/measurement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The base unit in Prawn is the PDF Point. One PDF Point is equal to 1/72 of
 # an inch.
 #
@@ -15,7 +17,7 @@ filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
   require 'prawn/measurement_extensions'
 
-  [:mm, :cm, :dm, :m, :in, :yd, :ft].each do |measurement|
+  %i[mm cm dm m in yd ft].each do |measurement|
     text "1 #{measurement} in PDF Points: #{1.send(measurement)} pt"
     move_down 5.mm
   end

data/manual/basic_concepts/origin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This is the most important concept you need to learn about Prawn:
 #
 # PDF documents have the origin <code>[0,0]</code> at the bottom-left corner of

data/manual/basic_concepts/other_cursor_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Another group of helpers for changing the cursor position are the pad methods.
 # They accept a numeric value and a block. <code>pad</code> will use the numeric
 # value to move the cursor down both before and after the block content.

data/manual/basic_concepts/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The recommended way to extend Prawn's functionality is to include the
 # <code>Prawn::View</code> mixin in your own class, which will make all
 # <code>Prawn::Document</code> methods available to your custom objects.

data/manual/bounding_box/bounding_box.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Examples for bounding boxes.
 
 require_relative '../example_helper'
@@ -19,13 +21,13 @@ Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
     end
 
     p.intro do
-      prose <<-END
+      prose <<-TEXT
         Bounding boxes are the basic containers for structuring the content
         flow. Even being low level building blocks sometimes their simplicity is
         very welcome.
 
         The examples show:
-      END
+      TEXT
 
       list(
         'How to create bounding boxes with specific dimensions',

data/manual/bounding_box/bounds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The <code>bounds</code> method returns the current bounding box. This is
 # useful because the <code>Prawn::BoundingBox</code> exposes some nice boundary
 # helpers.
@@ -27,10 +29,10 @@ Prawn::ManualBuilder::Example.generate(filename) do
 
     move_down 10
 
-    text "absolute top: #{format '%.2f', bounds.absolute_top}"
-    text "absolute bottom: #{format '%.2f', bounds.absolute_bottom}"
-    text "absolute left: #{format '%.2f', bounds.absolute_left}"
-    text "absolute right: #{format '%.2f', bounds.absolute_right}"
+    text "absolute top: #{bounds.absolute_top.to_f.round(2)}"
+    text "absolute bottom: #{bounds.absolute_bottom.to_f.round(2)}"
+    text "absolute left: #{bounds.absolute_left.to_f.round(2)}"
+    text "absolute right: #{bounds.absolute_right.to_f.round(2)}"
   end
 
   text 'Margin box bounds:'

data/manual/bounding_box/canvas.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The origin example already mentions that a new document already comes with
 # a margin box whose bottom left corner is used as the origin for calculating
 # coordinates.

data/manual/bounding_box/creation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # If you've read the basic concepts examples you probably know that the origin
 # of a page is on the bottom left corner and that the content flows from top to
 # bottom.

data/manual/bounding_box/indentation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Sometimes you just need to indent a portion of the contents of a bounding box,
 # and using a nested bounding box is pure overkill. The <code>indent</code>
 # method is what you might need.

data/manual/bounding_box/nesting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Normally when we provide the top left corner of a bounding box we
 # express the coordinates relative to the margin box. This is not the
 # case when we have nested bounding boxes. Once nested the inner bounding box

data/manual/bounding_box/russian_boxes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This example is mostly just for fun, and shows how nested bounding boxes
 # can simplify calculations. See the "Bounding Box" section of the manual
 # for more basic uses.
@@ -6,11 +8,11 @@ require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
-  def combine(a1, a2)
+  def combine(horizontal_span, vertical_span)
     output = []
-    a1.each do |i1|
-      a2.each do |i2|
-        output += [[i1, i2]]
+    horizontal_span.each do |x|
+      vertical_span.each do |y|
+        output += [[x, y]]
       end
     end
     output

data/manual/bounding_box/stretchy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Bounding Boxes accept an optional <code>:height</code> parameter. Unless it
 # is provided the bounding box will be stretchy. It will expand the height to
 # fit all content generated inside it.

data/manual/contents.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Generates the Prawn by example manual.
 
 require_relative 'example_helper'

data/manual/cover.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Prawn manual how to read this manual page.
 
 require_relative 'example_helper'
@@ -20,14 +22,15 @@ Prawn::ManualBuilder::Example.generate(filename) do
     at: [170, cursor - 160]
   )
 
-  if Dir.exist?("#{Prawn::BASEDIR}/.git")
-    commit = `git show --pretty=%h`
-    git_commit = "git commit: #{commit.lines.first}"
-  else
-    git_commit = ''
-  end
-
   unless ENV['CI']
+    git_commit =
+      if Dir.exist?("#{Prawn::BASEDIR}/.git")
+        commit = `git show --pretty=%h`
+        "git commit: #{commit.lines.first}"
+      else
+        ''
+      end
+
     formatted_text_box(
       [{
         text: "Last Update: #{Time.now.strftime('%Y-%m-%d')}\n" \

data/manual/document_and_page_options/background.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Pass an image path to the <code>:background</code> option and it will be used
 # as the background for all pages.
 # This option can only be used on document creation.

data/manual/document_and_page_options/document_and_page_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Examples for stamps and repeaters.
 
 require_relative '../example_helper'
@@ -12,14 +14,14 @@ Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
     p.example 'print_scaling', eval_source: false, full_source: true
 
     p.intro do
-      prose <<-END
+      prose <<-TEXT
         So far we've already seen how to create new documents and start new
         pages. This chapter expands on the previous examples by showing other
         options avialable. Some of the options are only available when creating
         new documents.
 
         The examples show:
-      END
+      TEXT
 
       list(
         'How to configure page size',

data/manual/document_and_page_options/metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # To set the document metadata just pass a hash to the <code>:info</code>
 # option when creating new documents.
 # The keys in the example below are arbitrary, so you may add whatever keys you

data/manual/document_and_page_options/page_margins.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The default margin for pages is 0.5 inch but you can change that with the
 # <code>:margin</code> option or if you'd like to have different margins you
 # can use the <code>:left_margin</code>, <code>:right_margin</code>,

data/manual/document_and_page_options/page_size.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Prawn comes with support for most of the common page sizes so you'll only need
 # to provide specific values if your intended format is not supported. To see a
 # list with all supported sizes take a look at PDF::Core::PageGeometry

data/manual/document_and_page_options/print_scaling.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # (Optional; PDF 1.6) The page scaling option to be selected when a print dialog
 # is displayed for this document.  Valid values are <code>None</code>, which
 # indicates that the print dialog should reflect no page scaling, and

data/manual/example_helper.rb

@@ -1,5 +1,8 @@
-require_relative '../lib/prawn'
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(__dir__, '../lib')
+require 'prawn'
 require 'prawn/manual_builder'
 
 Prawn::ManualBuilder.manual_dir = File.dirname(__FILE__)
-Prawn::Font::AFM.hide_m17n_warning = true
+Prawn::Fonts::AFM.hide_m17n_warning = true

data/manual/graphics/blend_mode.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Blend modes can be used to change the way two layers (images, graphics,
 # text, etc.) are blended together. The <code>blend_mode</code> method
 # accepts a single blend mode or an array of blend modes. PDF viewers should
@@ -19,10 +21,10 @@ Prawn::ManualBuilder::Example.generate(filename) do
   # https://commons.wikimedia.org/wiki/File:Blend_modes_1.-top-layer.jpg#/media/File:Blend_modes_1.-top-layer.jpg
   top_layer = "#{Prawn::DATADIR}/images/blend_modes_top_layer.jpg"
 
-  blend_modes = [
-    :Normal, :Multiply, :Screen, :Overlay, :Darken, :Lighten, :ColorDodge,
-    :ColorBurn, :HardLight, :SoftLight, :Difference, :Exclusion, :Hue,
-    :Saturation, :Color, :Luminosity
+  blend_modes = %i[
+    Normal Multiply Screen Overlay Darken Lighten ColorDodge
+    ColorBurn HardLight SoftLight Difference Exclusion Hue
+    Saturation Color Luminosity
   ]
   blend_modes.each_with_index do |blend_mode, index|
     x = index % 4 * 135

data/manual/graphics/circle_and_ellipse.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # To define a <code>circle</code> all you need is the center point and the
 # radius.
 #

data/manual/graphics/color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # We can change the stroke and fill colors providing an HTML rgb 6 digit color
 # code string ("AB1234") or 4 values for CMYK.
 

data/manual/graphics/common_lines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Prawn provides helpers for drawing some commonly used lines:
 #
 # <code>vertical_line</code> and <code>horizontal_line</code> do just what their

data/manual/graphics/fill_and_stroke.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # There are two drawing primitives in Prawn: <code>fill</code> and
 # <code>stroke</code>.
 #

data/manual/graphics/fill_rules.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Prawn's fill operators (<code>fill</code> and <code>fill_and_stroke</code>
 # both accept a <code>:fill_rule</code> option. These rules determine which
 # parts of the page are counted as "inside" vs. "outside" the path. There are

data/manual/graphics/gradients.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Note that because of the way PDF renders radial gradients in order to get
 # solid fill your start circle must be fully inside your end circle.
 # Otherwise you will get triangle fill like illustrated in the example below.

data/manual/graphics/graphics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Examples for the Graphics package.
 
 require_relative '../example_helper'
@@ -38,7 +40,7 @@ Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
     end
 
     p.intro do
-      prose <<-END
+      prose <<-TEXT
         Here we show all the drawing methods provided by Prawn. Use them to draw
         the most beautiful imaginable things.
 
@@ -48,7 +50,7 @@ Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
         least read the basic examples.
 
         The examples show:
-      END
+      TEXT
 
       list(
         'All the possible ways that you can fill or stroke shapes on a page',

data/manual/graphics/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # To produce this manual we use the <code>stroke_axis</code> helper method
 # within the examples.
 #