prawn 2.0.2 → 2.3.0

data/manual/graphics/line_width.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # The <code>line_width=</code> method sets the stroke width for subsequent
 # stroke calls.
 #
@@ -7,9 +7,9 @@
 # assignment is a local temporary, rather than a setter method, if you are using
 # the block call to <code>Prawn::Document.generate</code> without passing params
 # you will need to call <code>line_width</code> on self.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+# rubocop: disable Lint/UselessAssignment
+require_relative '../example_helper'
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
 Prawn::ManualBuilder::Example.generate(filename) do
@@ -19,13 +19,13 @@ Prawn::ManualBuilder::Example.generate(filename) do
 
   3.times do |i|
     case i
-    when 0 then line_width = 10        # This call will have no effect
+    when 0 then line_width = 10 # This call will have no effect
     when 1 then self.line_width = 10
     when 2 then self.line_width = 25
     end
 
     stroke do
-      horizontal_line 50, 150, :at => y
+      horizontal_line 50, 150, at: y
       rectangle [275, y + 25], 50, 50
       circle [500, y], 25
     end
@@ -33,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,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Prawn supports drawing both lines and curves starting either at the current
 # position, or from a specified starting position.
 #
@@ -14,9 +14,8 @@
 #
 # Both curve methods define a Bezier curve bounded by two aditional points
 # provided as the <code>:bounds</code> param.
-#
-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,13 +28,13 @@ Prawn::ManualBuilder::Example.generate(filename) do
     line_to 100, 100
     line_to 0, 100
 
-    curve_to [150, 250], :bounds => [[20, 200], [120, 200]]
-    curve_to [200, 0],   :bounds => [[150, 200], [450, 10]]
+    curve_to [150, 250], bounds: [[20, 200], [120, 200]]
+    curve_to [200, 0],   bounds: [[150, 200], [450, 10]]
   end
 
   # line and curve
   stroke do
     line [300, 200], [400, 50]
-    curve [500, 0], [400, 200], :bounds => [[600, 300], [300, 390]]
+    curve [500, 0], [400, 200], bounds: [[600, 300], [300, 390]]
   end
 end

data/manual/graphics/polygon.rb

@@ -1,14 +1,13 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Drawing polygons in Prawn is easy, just pass a sequence of points to one of
 # the polygon family of methods.
 #
 # Just like <code>rounded_rectangle</code> we also have
 # <code>rounded_polygon</code>. The only difference is the radius param comes
 # before the polygon points.
-#
-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
@@ -18,12 +17,11 @@ Prawn::ManualBuilder::Example.generate(filename) do
   stroke_polygon [50, 200], [50, 300], [150, 300]
 
   # Hexagon
-  fill_polygon [50, 150], [150, 200], [250, 150],
-               [250, 50], [150, 0], [50, 50]
+  fill_polygon [50, 150], [150, 200], [250, 150], [250, 50], [150, 0], [50, 50]
 
   # Pentagram
   pentagon_points = [500, 100], [430, 5], [319, 41], [319, 159], [430, 195]
-  pentagram_points = [0, 2, 4, 1, 3].map{ |i| pentagon_points[i] }
+  pentagram_points = [0, 2, 4, 1, 3].map { |i| pentagon_points[i] }
 
   stroke_rounded_polygon(20, *pentagram_points)
 end

data/manual/graphics/rectangle.rb

@@ -1,13 +1,12 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # To draw a rectangle, just provide the upper-left corner, width and height to
 # the <code>rectangle</code> method.
 #
 # There's also <code>rounded_rectangle</code>. Just provide an additional radius
 # value for the rounded corners.
-#
-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

data/manual/graphics/rotate.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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.
@@ -7,9 +7,8 @@
 # The angle is in degrees.
 #
 # If you omit the <code>:origin</code> option the page origin will be used.
-#
-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
@@ -18,9 +17,9 @@ Prawn::ManualBuilder::Example.generate(filename) do
   fill_circle [250, 200], 2
 
   12.times do |i|
-    rotate(i * 30, :origin => [250, 200]) do
+    rotate(i * 30, origin: [250, 200]) do
       stroke_rectangle [350, 225], 100, 50
-      draw_text "Rotated #{i * 30}°", :size => 10, :at => [360, 205]
+      draw_text "Rotated #{i * 30}°", size: 10, at: [360, 205]
     end
   end
 end

data/manual/graphics/scale.rb

@@ -1,13 +1,12 @@
-# encoding: utf-8
-#
+# 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.
 #
 # If you omit the <code>:origin</code> option the page origin will be used.
-#
-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
@@ -20,24 +19,24 @@ Prawn::ManualBuilder::Example.generate(filename) do
   y = 200
 
   stroke_rectangle [x, y], width, height
-  text_box "reference rectangle", :at => [x + 10, y - 10], :width => width - 20
+  text_box 'reference rectangle', at: [x + 10, y - 10], width: width - 20
 
-  scale(2, :origin => [x, y]) do
+  scale(2, origin: [x, y]) do
     stroke_rectangle [x, y], width, height
-    text_box "rectangle scaled from upper-left corner",
-             :at => [x, y - height - 5],
-             :width => width
+    text_box 'rectangle scaled from upper-left corner',
+      at: [x, y - height - 5],
+      width: width
   end
 
   x = 350
 
   stroke_rectangle [x, y], width, height
-  text_box "reference rectangle", :at => [x + 10, y - 10], :width => width - 20
+  text_box 'reference rectangle', at: [x + 10, y - 10], width: width - 20
 
-  scale(2, :origin => [x + width / 2, y - height / 2]) do
+  scale(2, origin: [x + width / 2, y - height / 2]) do
     stroke_rectangle [x, y], width, height
-    text_box "rectangle scaled from center",
-             :at => [x, y - height - 5],
-             :width => width
+    text_box 'rectangle scaled from center',
+      at: [x, y - height - 5],
+      width: width
   end
 end

data/manual/graphics/soft_masks.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
-#
-# Soft masks are user for more complex alpha channel manipulations. You can use
+# 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
 # precise). So while you can use any combination of colors for soft masks it's
@@ -11,8 +11,7 @@
 # only to a part of page you need to enclose drawing instructions in
 # <code>save_graphics_state</code> block.
 
-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

data/manual/graphics/stroke_cap.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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>
@@ -11,9 +11,8 @@
 #
 # Just like <code>line_width=</code> the <code>cap_style=</code> method needs an
 # explicit receiver to work.
-#
-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,11 +20,11 @@ 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
-    stroke_horizontal_line 100, 300, :at => y
+    stroke_horizontal_line 100, 300, at: y
     stroke_circle [400, y], 15
   end
 end

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,18 +12,17 @@
 # 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
 
@@ -34,15 +33,15 @@ Prawn::ManualBuilder::Example.generate(filename) do
 
     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
     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,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,10 +1,9 @@
-# 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
@@ -17,13 +16,13 @@ Prawn::ManualBuilder::Example.generate(filename) 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,20 +7,19 @@
 # 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|

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,12 +21,12 @@ 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.