prawn 0.13.0 → 2.4.0

data/manual/bounding_box/creation.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-# 
+# 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.
@@ -9,15 +9,14 @@
 # A bounding box can be created with the <code>bounding_box</code> method. Just
 # provide the top left corner, a required <code>:width</code> option and an
 # optional <code>:height</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::Example.generate(filename) do
-  bounding_box([200, cursor - 100], :width => 200, :height => 100) do
-    text "Just your regular bounding box"
-    
+Prawn::ManualBuilder::Example.generate(filename) do
+  bounding_box([200, cursor - 100], width: 200, height: 100) do
+    text 'Just your regular bounding box'
+
     transparent(0.5) { stroke_bounds }
   end
 end

data/manual/bounding_box/indentation.rb

@@ -1,44 +1,43 @@
-# encoding: utf-8
-# 
+# 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.
 #
 # Just provide a number for it to indent all content generated inside the
-# block. 
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# block.
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  text "No indentation on the margin box."
+Prawn::ManualBuilder::Example.generate(filename) do
+  text 'No indentation on the margin box.'
   indent(20) do
-    text "Some indentation inside an indent block."
+    text 'Some indentation inside an indent block.'
   end
   move_down 20
-  
-  bounding_box([50, cursor], :width => 400, :height => cursor) do
+
+  bounding_box([50, cursor], width: 400, height: cursor) do
     transparent(0.5) { stroke_bounds }
-    
+
     move_down 10
-    text "No indentation inside this bounding box."
+    text 'No indentation inside this bounding box.'
     indent(40) do
-      text "Inside an indent block. And so is this horizontal line:"
-      
+      text 'Inside an indent block. And so is this horizontal line:'
+
       stroke_horizontal_rule
     end
     move_down 10
-    text "No indentation"
-    
+    text 'No indentation'
+
     move_down 20
     indent(60) do
-      text "Another indent block."
-      
-      bounding_box([0, cursor], :width => 200) do
-        text "Note that this bounding box coordinates are relative to the " +
-             "indent block"
-        
+      text 'Another indent block.'
+
+      bounding_box([0, cursor], width: 200) do
+        text 'Note that this bounding box coordinates are relative to the ' \
+          'indent block'
+
         transparent(0.5) { stroke_bounds }
       end
     end

data/manual/bounding_box/nesting.rb

@@ -1,45 +1,52 @@
-# encoding: utf-8
-# 
+# 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
-# coordinates are relative to the outter bounding box.
+# coordinates are relative to the outer bounding box.
 #
 # This example shows some nested bounding boxes with fixed and stretchy heights.
 # Note how the <code>cursor</code> method returns coordinates relative to
 # the current bounding box.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   def box_content(string)
     text string
     transparent(0.5) { stroke_bounds }
   end
-  
+
   gap = 20
-  bounding_box([50, cursor], :width => 400, :height => 200) do
-    box_content("Fixed height")
-    
-    bounding_box([gap, cursor - gap], :width => 300) do
-      text "Stretchy height"
-      
-      bounding_box([gap, bounds.top - gap], :width => 100) do
-        text "Stretchy height"
-        transparent(0.5) { dash(1); stroke_bounds; undash }
+  bounding_box([50, cursor], width: 400, height: 200) do
+    box_content('Fixed height')
+
+    bounding_box([gap, cursor - gap], width: 300) do
+      text 'Stretchy height'
+
+      bounding_box([gap, bounds.top - gap], width: 100) do
+        text 'Stretchy height'
+        transparent(0.5) do
+          dash(1)
+          stroke_bounds
+          undash
+        end
       end
-      
-      bounding_box([gap * 7, bounds.top - gap], :width => 100, :height => 50) do
-        box_content("Fixed height")
+
+      bounding_box([gap * 7, bounds.top - gap], width: 100, height: 50) do
+        box_content('Fixed height')
+      end
+
+      transparent(0.5) do
+        dash(1)
+        stroke_bounds
+        undash
       end
-      
-      transparent(0.5) { dash(1); stroke_bounds; undash }
     end
-    
-    bounding_box([gap, cursor - gap], :width => 300, :height => 50) do
-      box_content("Fixed height")
+
+    bounding_box([gap, cursor - gap], width: 300, height: 50) do
+      box_content('Fixed height')
     end
   end
 end

data/manual/bounding_box/russian_boxes.rb

@@ -1,40 +1,40 @@
-# encoding: utf-8
-#
+# 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.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
-  def combine(a1, a2)
+Prawn::ManualBuilder::Example.generate(filename) do
+  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
   end
 
-  def recurse_bounding_box(max_depth=4, depth=1)
-    width = (bounds.width-15)/2
-    height = (bounds.height-15)/2
-    left_top_corners = combine([5, bounds.right-width-5],
-                               [bounds.top-5, height+5])
+  def recurse_bounding_box(max_depth = 4, depth = 1)
+    width = (bounds.width - 15) / 2
+    height = (bounds.height - 15) / 2
+    left_top_corners = combine(
+      [5, bounds.right - width - 5],
+      [bounds.top - 5, height + 5]
+    )
     left_top_corners.each do |lt|
-      bounding_box(lt, :width => width, :height => height) do
+      bounding_box(lt, width: width, height: height) do
         stroke_bounds
-        recurse_bounding_box(max_depth, depth+1) if depth < max_depth
+        recurse_bounding_box(max_depth, depth + 1) if depth < max_depth
       end
     end
   end
 
   # Set up a bbox from the dashed line to the bottom of the page
-  bounding_box([0, cursor], :width => bounds.width, :height => cursor) do
+  bounding_box([0, cursor], width: bounds.width, height: cursor) do
     recurse_bounding_box
   end
 end
-

data/manual/bounding_box/stretchy.rb

@@ -1,31 +1,29 @@
-# encoding: utf-8
-# 
+# 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.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   y_position = cursor
-  bounding_box([0, y_position], :width => 200, :height => 100) do
-    text "This bounding box has a height of 100. If this text gets too large " +
-         "it will flow to the next page."
-    
+  bounding_box([0, y_position], width: 200, height: 100) do
+    text 'This bounding box has a height of 100. If this text gets too large ' \
+      'it will flow to the next page.'
+
     transparent(0.5) { stroke_bounds }
   end
-  
-  bounding_box([300, y_position], :width => 200) do
-    text "This bounding box has variable height. No matter how much text is " +
-         "written here, the height will expand to fit."
-    
-    text " _" * 100
-    
-    text " *" * 100
-    
+
+  bounding_box([300, y_position], width: 200) do
+    text 'This bounding box has variable height. No matter how much text is ' \
+      'written here, the height will expand to fit.'
+
+    text ' _' * 100
+
+    text ' *' * 100
+
     transparent(0.5) { stroke_bounds }
   end
-  
 end

data/manual/contents.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Generates the Prawn by example manual.
+
+require_relative 'example_helper'
+
+def prawn_manual_document
+  old_default_external_encoding = Encoding.default_external
+  Encoding.default_external = Encoding::UTF_8
+
+  Prawn::ManualBuilder::Example.new(
+    skip_page_creation: true,
+    page_size: 'FOLIO'
+  ) do
+    load_page '', 'cover'
+    load_page '', 'how_to_read_this_manual'
+
+    # Core chapters
+    load_package 'basic_concepts'
+    load_package 'graphics'
+    load_package 'text'
+    load_package 'bounding_box'
+
+    # Remaining chapters
+    load_package 'layout'
+    load_page '', 'table'
+    load_package 'images'
+    load_package 'document_and_page_options'
+    load_package 'outline'
+    load_package 'repeatable_content'
+    load_package 'security'
+  end
+ensure
+  Encoding.default_external = old_default_external_encoding
+end

data/manual/cover.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Prawn manual how to read this manual page.
+
+require_relative 'example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  move_down 200
+
+  image "#{Prawn::DATADIR}/images/prawn.png",
+    scale: 0.9,
+    at: [10, cursor]
+
+  formatted_text_box(
+    [{ text: "Prawn\n", styles: [:bold], size: 100 }],
+    at: [170, cursor - 50]
+  )
+
+  formatted_text_box(
+    [{ text: 'by example', font: 'Courier', size: 60 }],
+    at: [170, cursor - 160]
+  )
+
+  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" \
+          "Prawn Version: #{Prawn::VERSION}\n#{git_commit}",
+        size: 12
+      }],
+      at: [390, cursor - 620]
+    )
+  end
+end

data/manual/document_and_page_options/background.rb

@@ -1,27 +1,29 @@
-# encoding: utf-8
-#
+# 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. 
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# This option can only be used on document creation.
+
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 
 img = "#{Prawn::DATADIR}/images/letterhead.jpg"
 
-Prawn::Document.generate("background.pdf",
-                         :background => img,
-                         :margin => 100
-) do
-  text "My report caption", :size => 18, :align => :right
+Prawn::Document.generate(filename, background: img, margin: 100) do
+  text 'My report caption', size: 18, align: :right
 
   move_down font.height * 2
 
-  text "Here is my text explaning this report. " * 20, 
-       :size => 12, :align => :left, :leading => 2
+  text 'Here is my text explaning this report. ' * 20,
+    size: 12,
+    align: :left,
+    leading: 2
 
   move_down font.height
 
   text "I'm using a soft background. " * 40,
-       :size => 12, :align => :left, :leading => 2
+    size: 12,
+    align: :left,
+    leading: 2
 end

data/manual/document_and_page_options/document_and_page_options.rb

@@ -1,31 +1,34 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Examples for stamps and repeaters.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-Prawn::Example.generate("document_and_page_options.pdf",
-                        :page_size => "FOLIO") do
-  
-  package "document_and_page_options" do |p|
-    
-    p.example "page_size",    :eval_source => false, :full_source => true
-    p.example "page_margins", :eval_source => false, :full_source => true
-    p.example "background",   :eval_source => false, :full_source => true
-    p.example "metadata",     :eval_source => false, :full_source => true
-    
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
+  package 'document_and_page_options' do |p|
+    p.example 'page_size', eval_source: false, full_source: true
+    p.example 'page_margins', eval_source: false, full_source: true
+    p.example 'background', eval_source: false, full_source: true
+    p.example 'metadata', eval_source: false, full_source: true
+    p.example 'print_scaling', eval_source: false, full_source: true
+
     p.intro do
-      prose("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.
+      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:")
+        The examples show:
+      TEXT
 
-      list( "How to configure page size",
-            "How to configure page margins",
-            "How to use a background image",
-            "How to add metadata to the generated PDF"
-          )
+      list(
+        'How to configure page size',
+        'How to configure page margins',
+        'How to use a background image',
+        'How to add metadata to the generated PDF'
+      )
     end
-    
   end
 end

data/manual/document_and_page_options/metadata.rb

@@ -1,23 +1,25 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # To set the document metadata just pass a hash to the <code>:info</code>
 # option when creating new documents.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# The keys in the example below are arbitrary, so you may add whatever keys you
+# want.
+
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+
+info = {
+  Title: 'My title',
+  Author: 'John Doe',
+  Subject: 'My Subject',
+  Keywords: 'test metadata ruby pdf dry',
+  Creator: 'ACME Soft App',
+  Producer: 'Prawn',
+  CreationDate: Time.now
+}
 
-Prawn::Document.generate("metadata.pdf",
-  :info => {
-    :Title        => "My title",
-    :Author       => "John Doe",
-    :Subject      => "My Subject",
-    :Keywords     => "test metadata ruby pdf dry",
-    :Creator      => "ACME Soft App", 
-    :Producer     => "Prawn",
-    :CreationDate => Time.now,
-    :Grok         => "Test Property"
-  }) do
-  
-  text "This is a test of setting metadata properties via the info option."
-  text "It allows one to specify non standard properties like 'Grok'."
+Prawn::Document.generate(filename, info: info) do
+  text 'This is a test of setting metadata properties via the info option.'
+  text 'While the keys are arbitrary, the above example sets common attributes.'
 end

data/manual/document_and_page_options/page_margins.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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>,
@@ -7,32 +7,30 @@
 #
 # These options are available both for starting new pages and creating new
 # documents.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-Prawn::Document.generate("page_margins.pdf",
-                         :margin => 100
-) do
-  text "100 pts margins."
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Document.generate(filename, margin: 100) do
+  text '100 pts margins.'
   stroke_bounds
 
-  start_new_page(:left_margin => 300)
-  text "300 pts margin on the left."
+  start_new_page(left_margin: 300)
+  text '300 pts margin on the left.'
   stroke_bounds
-  
-  start_new_page(:top_margin => 300)
-  text "300 pts margin both on the top and on the left. Notice that whenever " +
-       "you set an option for a new page it will remain the default for the " +
-       "following pages."
+
+  start_new_page(top_margin: 300)
+  text '300 pts margin both on the top and on the left. Notice that whenever ' \
+    'you set an option for a new page it will remain the default for the ' \
+    'following pages.'
   stroke_bounds
 
-  start_new_page(:margin => 50)
-  text "50 pts margins. Using the margin option will reset previous specific " +
-       "calls to left, right, top and bottom margins."
+  start_new_page(margin: 50)
+  text '50 pts margins. Using the margin option will reset previous specific ' \
+    'calls to left, right, top and bottom margins.'
   stroke_bounds
-  
-  start_new_page(:margin => [50, 100, 150, 200])
-  text "There is also the shorthand CSS like syntax used here."
+
+  start_new_page(margin: [50, 100, 150, 200])
+  text 'There is also the shorthand CSS like syntax used here.'
   stroke_bounds
 end

data/manual/document_and_page_options/page_size.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -11,24 +11,24 @@
 # You may also define the orientation of the page to be either portrait
 # (default) or landscape. Use <code>:page_layout</code> when creating new
 # documents and <code>:layout</code> when starting new pages.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-Prawn::Document.generate("page_size.pdf",
-                         :page_size   => "EXECUTIVE",
-                         :page_layout => :landscape
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Document.generate(
+  filename,
+  page_size: 'EXECUTIVE',
+  page_layout: :landscape
 ) do
-  text "EXECUTIVE landscape page."
+  text 'EXECUTIVE landscape page.'
 
   custom_size = [275, 326]
-  
-  ["A4", "TABLOID", "B7", custom_size ].each do |size|
-    
-    start_new_page(:size => size, :layout => :portrait)
+
+  ['A4', 'TABLOID', 'B7', custom_size].each do |size|
+    start_new_page(size: size, layout: :portrait)
     text "#{size} portrait page."
-    
-    start_new_page(:size => size, :layout => :landscape)
+
+    start_new_page(size: size, layout: :landscape)
     text "#{size} landscape page."
   end
 end

data/manual/document_and_page_options/print_scaling.rb

@@ -0,0 +1,23 @@
+# 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
+# <code>AppDefault</code>, which indicates that applications should use the
+# current print scaling.  If this entry has an unrecognized value, applications
+# should use the current print scaling.  Default value: <code>AppDefault</code>.
+#
+# Note: If the print dialog is suppressed and its parameters are provided
+# directly by the application, the value of this entry should still be used.
+
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::Document.generate(
+  filename,
+  page_layout: :landscape,
+  print_scaling: :none
+) do
+  text 'When you print this document, the scale to fit in print preview '\
+    'should be disabled by default.'
+end