prawn 1.1.0 → 2.4.0

data/manual/graphics/stroke_dash.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # This sets the dashed pattern for lines and curves. The (dash) length defines
 # how long each dash will be.
 #
@@ -12,37 +12,36 @@
 # Complex dash patterns can be specified by using an array with alternating
 # dash/gap lengths for the first parameter (note that the <code>:space</code>
 # option is ignored in this case).
-#
-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
   stroke_axis
 
-  dash([1, 2, 3, 2, 1, 5], :phase => 6)
-  stroke_horizontal_line 50, 500, :at => 230
+  dash([1, 2, 3, 2, 1, 5], phase: 6)
+  stroke_horizontal_line 50, 500, at: 230
   dash([1, 2, 3, 4, 5, 6, 7, 8])
-  stroke_horizontal_line 50, 500, :at => 220
+  stroke_horizontal_line 50, 500, at: 220
 
   base_y = 210
 
   24.times do |i|
     length = (i / 4) + 1
-    space = length            # space between dashes same length as dash
-    phase = 0                 # start with dash
+    space = length # space between dashes same length as dash
+    phase = 0 # start with dash
 
     case i % 4
     when 0 then base_y -= 5
-    when 1 then phase = length        # start with space between dashes
-    when 2 then space = length * 0.5  # space between dashes half as long as dash
+    when 1 then phase = length # start with space between dashes
+    when 2 then space = length * 0.5 # space between dashes half as long as dash
     when 3
-      space = length * 0.5    # space between dashes half as long as dash
-      phase = length          # start with space between dashes
+      space = length * 0.5 # space between dashes half as long as dash
+      phase = length # start with space between dashes
     end
     base_y -= 5
 
-    dash(length, :space => space, :phase => phase)
-    stroke_horizontal_line 50, 500, :at => base_y - (2 * i)
+    dash(length, space: space, phase: phase)
+    stroke_horizontal_line 50, 500, at: base_y - (2 * i)
   end
 end

data/manual/graphics/stroke_join.rb

@@ -1,14 +1,13 @@
-# encoding: utf-8
-#
+# 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>
 #
 # Just like <code>cap_style</code>, the difference between styles is better
 # seen with thicker lines.
-#
-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
@@ -16,10 +15,10 @@ 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
+    y = 200 - i * 100
     stroke do
       move_to(100, y)
       line_to(200, y + 100)

data/manual/graphics/translate.rb

@@ -1,29 +1,29 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # This transformation is used to translate the user space. Just provide the
 # x and y coordinates for the new origin.
-#
-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
   stroke_axis
 
   1.upto(3) do |i|
-
     x = i * 50
     y = i * 100
     translate(x, y) do
-
       # Draw a point on the new origin
       fill_circle [0, 0], 2
       draw_text "New origin after translation to [#{x}, #{y}]",
-                :at => [5, -2], :size => 8
+        at: [5, -2],
+        size: 8
 
       stroke_rectangle [100, 75], 100, 50
-      text_box "Top left corner at [100,75]",
-                :at => [110, 65], :width => 80, :size => 8
+      text_box 'Top left corner at [100,75]',
+        at: [110, 65],
+        width: 80,
+        size: 8
     end
   end
 end

data/manual/graphics/transparency.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -7,24 +7,22 @@
 # You may call it providing one or two values. The first value sets fill opacity
 # and the second value sets stroke opacity. If the second value is omitted fill
 # and stroke will have the same opacity.
-#
-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
   stroke_axis
 
   self.line_width = 5
-  fill_color "ff0000"
+  fill_color 'ff0000'
   fill_rectangle [0, 100], 500, 100
 
-  fill_color "000000"
-  stroke_color "ffffff"
+  fill_color '000000'
+  stroke_color 'ffffff'
 
   base_x = 100
   [[0.5, 1], 0.5, [1, 0.5]].each do |args|
-
     transparent(*args) do
       fill_circle [base_x, 100], 50
       stroke_rectangle [base_x - 20, 100], 40, 80

data/manual/how_to_read_this_manual.rb

@@ -1,12 +1,12 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Prawn manual how to read this manual page.
 
-require_relative "example_helper"
+require_relative 'example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
-  header("How to read this manual")
+  header('How to read this manual')
 
   prose <<-END_TEXT
   This manual is a collection of examples categorized by theme and organized from the least to the most complex. While it covers most of the common use cases it is not a comprehensive guide.
@@ -21,20 +21,19 @@ Prawn::ManualBuilder::Example.generate(filename) do
   END_TEXT
 
   move_down(Prawn::ManualBuilder::Example::BOX_MARGIN)
-  header("Reading the examples")
+  header('Reading the examples')
 
   prose <<-END_TEXT
   The title of each example is the relative path from the Prawn source manual/ folder.
 
-  The first body of text is the introductory text for the example. Generaly it is a short description of the features illustrated by the example.
+  The first body of text is the introductory text for the example. Generally it is a short description of the features illustrated by the example.
 
   Next comes the example source code block in fixed width font.
 
   Most of the example snippets illustrate features that alter the page in place. The effect of these snippets is shown right below a dashed line. If it doesn't make sense to evaluate the snippet inline, a box with the link for the example file is shown instead.
 
-  Note that the <code>stroke_axis</code> method, used occasionally in the manual, is not part of standard Prawn and is used for demonstrative purposes. It is defined in this file:
+  Note that the <code>stroke_axis</code> method used throughout the manual is part of standard Prawn. It is defined in this file:
 
-  https://github.com/prawnpdf/prawn/blob/master/manual/example_helper.rb
+  https://github.com/prawnpdf/prawn/blob/master/lib/prawn/graphics.rb
   END_TEXT
-
 end

data/manual/images/absolute_position.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -8,16 +8,15 @@
 # While sometimes useful this option won't be practical. Notice that the cursor
 # won't be moved after the image is rendered and there is nothing forbidding the
 # text to overlap with the image.
-#
-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
   y_position = cursor
   text "The image won't go below this line of text."
 
-  image "#{Prawn::DATADIR}/images/fractal.jpg", :at => [200, y_position]
+  image "#{Prawn::DATADIR}/images/fractal.jpg", at: [200, y_position]
 
-  text "And this line of text will go just below the previous one."
+  text 'And this line of text will go just below the previous one.'
 end

data/manual/images/fit.rb

@@ -1,21 +1,20 @@
-# encoding: utf-8
-#
+# 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.
 #
 # Just provide the container width and height pair.
-#
-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
   size = 300
 
-  text "Using the fit option"
-  bounding_box([0, cursor], :width => size, :height => size) do
-    image "#{Prawn::DATADIR}/images/pigs.jpg", :fit => [size, size]
+  text 'Using the fit option'
+  bounding_box([0, cursor], width: size, height: size) do
+    image "#{Prawn::DATADIR}/images/pigs.jpg", fit: [size, size]
     stroke_bounds
   end
 end

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|
-      text  "Image aligned to the #{position}."
-      image "#{Prawn::DATADIR}/images/stef.jpg", :position => position
+    %i[left center right].each do |position|
+      text "Image aligned to the #{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,40 +1,41 @@
-# encoding: utf-8
-#
-# Examples for embedding images.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# frozen_string_literal: true
 
-Prawn::ManualBuilder::Example.generate("images.pdf", :page_size => "FOLIO") do
+# Examples for embedding images.
 
-  package "images" do |p|
+require_relative '../example_helper'
 
-    p.section "Basics" do |s|
-      s.example "plain_image"
-      s.example "absolute_position"
+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.
-
-      The examples show:")
-
-      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"
-          )
+      prose <<-TEXT
+        Embedding images on PDF documents is fairly easy. Prawn supports both
+        JPG and PNG images.
+
+        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'
+      )
     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,30 @@
-# 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,21 +7,20 @@
 # 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
+  grid(4, 0).show
+  grid(5, 1).show
 
-  grid([6,2], [7,3]).show
+  grid([6, 2], [7, 3]).show
 
-  grid([4,4], [7,4]).show
-  grid([7,0], [7,1]).show
+  grid([4, 4], [7, 4]).show
+  grid([7, 0], [7, 1]).show
 end

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
+  grid([5, 0], [7, 1]).bounding_box do
+    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
+  grid(6, 3).bounding_box do
+    text "Just a little snippet here.\n#{' _ ' * 10}"
   end
 end

data/manual/layout/layout.rb

@@ -1,28 +1,27 @@
-# encoding: utf-8
-#
-# Examples for using grid layouts.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+# frozen_string_literal: true
 
-Prawn::ManualBuilder::Example.generate("layout.pdf", :page_size => "FOLIO") do
+# Examples for using grid layouts.
 
-  package "layout" do |p|
+require_relative '../example_helper'
 
-    p.example "simple_grid"
-    p.example "boxes"
-    p.example "content"
+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