prawn 0.13.0 → 2.4.0

data/manual/graphics/gradients.rb

@@ -1,37 +1,43 @@
-# encoding: utf-8
-#
+# 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.
 
-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
-  stroke_axis
+Prawn::ManualBuilder::Example.generate(filename) do
   self.line_width = 10
 
-  fill_gradient [50, 300], [150, 200], 'ff0000', '0000ff'
-  fill_rectangle [50, 300], 100, 100
+  # Linear Gradients
+  fill_gradient [0, 250], [100, 150], 'ff0000', '0000ff'
+  fill_rectangle [0, 250], 100, 100
+
+  stroke_gradient [150, 150], [250, 250], '00ffff', 'ffff00'
+  stroke_rectangle [150, 250], 100, 100
 
-  stroke_gradient [200, 200], [300, 300], '00ffff', 'ffff00'
-  stroke_rectangle [200, 300], 100, 100
+  fill_gradient [300, 250], [400, 150], 'ff0000', '0000ff'
+  stroke_gradient [300, 150], [400, 250], '00ffff', 'ffff00'
+  fill_and_stroke_rectangle [300, 250], 100, 100
 
-  fill_gradient [350, 300], [450, 200], 'ff0000', '0000ff'
-  stroke_gradient [350, 200], [450, 300], '00ffff', 'ffff00'
-  fill_and_stroke_rectangle [350, 300], 100, 100
+  rotate 45, origin: [500, 200] do
+    stops = { 0 => 'ff0000', 0.6 => '999900', 0.8 => '00cc00', 1 => '4444ff' }
+    fill_gradient from: [460, 240], to: [540, 160], stops: stops
+    fill_rectangle [460, 240], 80, 80
+  end
 
-  fill_gradient [100, 100], 0, [100, 100], 70.71, 'ff0000', '0000ff'
-  fill_rectangle [50, 150], 100, 100
+  # Radial gradients
+  fill_gradient [50, 50], 0, [50, 50], 70.71, 'ff0000', '0000ff'
+  fill_rectangle [0, 100], 100, 100
 
-  stroke_gradient [250, 100], 45, [250, 100], 70.71, '00ffff', 'ffff00'
-  stroke_rectangle [200, 150], 100, 100
+  stroke_gradient [200, 50], 45, [200, 50], 70.71, '00ffff', 'ffff00'
+  stroke_rectangle [150, 100], 100, 100
 
-  stroke_gradient [400, 100], 45, [400, 100], 70.71, '00ffff', 'ffff00'
-  fill_gradient [400, 100], 0, [400, 100], 70.71, 'ff0000', '0000ff'
-  fill_and_stroke_rectangle [350, 150], 100, 100
+  stroke_gradient [350, 50], 45, [350, 50], 70.71, '00ffff', 'ffff00'
+  fill_gradient [350, 50], 0, [350, 50], 70.71, 'ff0000', '0000ff'
+  fill_and_stroke_rectangle [300, 100], 100, 100
 
-  fill_gradient [500, 300], 15, [500, 50], 0, 'ff0000', '0000ff'
-  fill_rectangle [485, 300], 30, 250
+  fill_gradient [500, 100], 50, [500, 0], 0, 'ff0000', '0000ff'
+  fill_rectangle [450, 100], 100, 100
 end

data/manual/graphics/graphics.rb

@@ -1,58 +1,64 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Examples for the Graphics package.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
-
-Prawn::Example.generate("graphics.pdf", :page_size => "FOLIO") do
-  
-  package "graphics" do |p|
-    
-    p.section "Basics" do |s|
-      s.example "helper"
-      s.example "fill_and_stroke"
+
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
+  package 'graphics' do |p|
+    p.section 'Basics' do |s|
+      s.example 'helper'
+      s.example 'fill_and_stroke'
     end
-    
-    p.section "Shapes" do |s|
-      s.example "lines_and_curves"
-      s.example "common_lines"
-      s.example "rectangle"
-      s.example "polygon"
-      s.example "circle_and_ellipse"
+
+    p.section 'Shapes' do |s|
+      s.example 'lines_and_curves'
+      s.example 'common_lines'
+      s.example 'rectangle'
+      s.example 'polygon'
+      s.example 'circle_and_ellipse'
     end
-    
-    p.section "Fill and Stroke settings" do |s|
-      s.example "line_width"
-      s.example "stroke_cap"
-      s.example "stroke_join"
-      s.example "stroke_dash"
-      s.example "color"
-      s.example "gradients"
-      s.example "transparency"
-      s.example "soft_masks"
-      s.example "fill_rules"
+
+    p.section 'Fill and Stroke settings' do |s|
+      s.example 'line_width'
+      s.example 'stroke_cap'
+      s.example 'stroke_join'
+      s.example 'stroke_dash'
+      s.example 'color'
+      s.example 'gradients'
+      s.example 'transparency'
+      s.example 'soft_masks'
+      s.example 'blend_mode'
+      s.example 'fill_rules'
     end
-    
-    p.section "Transformations" do |s|
-      s.example "rotate"
-      s.example "translate"
-      s.example "scale"
+
+    p.section 'Transformations' do |s|
+      s.example 'rotate'
+      s.example 'translate'
+      s.example 'scale'
     end
-    
+
     p.intro do
-      prose("Here we show all the drawing methods provided by Prawn. Use them to draw the most beautiful imaginable things.
+      prose <<-TEXT
+        Here we show all the drawing methods provided by Prawn. Use them to draw
+        the most beautiful imaginable things.
 
-      Most of the content that you'll add to your pdf document will use the graphics package. Even text is rendered on a page just like a rectangle so even if you never use any of the shapes described here you should at least read the basic examples.
+        Most of the content that you'll add to your pdf document will use the
+        graphics package. Even text is rendered on a page just like a rectangle
+        so even if you never use any of the shapes described here you should at
+        least read the basic examples.
 
-      The examples show:")
+        The examples show:
+      TEXT
 
-      list( "All the possible ways that you can fill or stroke shapes on a page",
-            "How to draw all the shapes that Prawn has to offer from a measly line to a mighty polygon or ellipse",
-            "The configuration options for stroking lines and filling shapes",
-            "How to apply transformations to your drawing space"
-          )
+      list(
+        'All the possible ways that you can fill or stroke shapes on a page',
+        'How to draw all the shapes that Prawn has to offer from a measly '\
+          'line to a mighty polygon or ellipse',
+        'The configuration options for stroking lines and filling shapes',
+        'How to apply transformations to your drawing space'
+      )
     end
-    
   end
 end

data/manual/graphics/helper.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # To produce this manual we use the <code>stroke_axis</code> helper method
 # within the examples.
 #
@@ -10,15 +10,25 @@
 # Note that the examples define a custom <code>:height</code> option so that
 # only the example canvas is used (as seen with the output of the first line of
 # the example 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
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  stroke_axis(:at => [70, 70], :height => 200, :step_length => 50,
-              :negative_axes_length => 5, :color => '0000FF')
-  stroke_axis(:at => [140, 140], :width => 200, :height => cursor.to_i - 140,
-              :step_length => 20, :negative_axes_length => 40, :color => 'FF00')
+  stroke_axis(
+    at: [70, 70],
+    height: 200,
+    step_length: 50,
+    negative_axes_length: 5,
+    color: '0000FF'
+  )
+  stroke_axis(
+    at: [140, 140],
+    width: 200,
+    height: cursor.to_i - 140,
+    step_length: 20,
+    negative_axes_length: 40,
+    color: 'FF0000'
+  )
 end

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,29 +7,30 @@
 # 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::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  
+
   y = 250
-  
+
   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
-    
+
     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,28 +14,27 @@
 #
 # 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::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  
+
   # line_to and curve_to
   stroke do
     move_to 0, 0
-  
+
     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]]
+    line [300, 200], [400, 50]
+    curve [500, 0], [400, 200], bounds: [[600, 300], [300, 390]]
   end
 end

data/manual/graphics/polygon.rb

@@ -1,29 +1,27 @@
-# 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::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
 
   # Triangle
   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,21 +1,20 @@
-# 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::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  
+
   stroke do
     rectangle [100, 300], 100, 200
-    
+
     rounded_rectangle [300, 300], 100, 200, 20
   end
 end

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,22 +7,19 @@
 # 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::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  
+
   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,41 +1,42 @@
-# 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::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  
+
   width = 100
   height = 50
-  
+
   x = 50
   y = 200
 
   stroke_rectangle [x, y], width, height
-  text_box "reference rectangle", :at => [x + 10, y - 10], :width => width - 20
-  
-  scale(2, :origin => [x, y]) do
+  text_box 'reference rectangle', at: [x + 10, y - 10], width: width - 20
+
+  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
-  
-  scale(2, :origin => [x + width / 2, y - height / 2]) do
+  text_box 'reference rectangle', at: [x + 10, y - 10], width: width - 20
+
+  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,11 +11,10 @@
 # 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::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   save_graphics_state do
     soft_mask do
       0.upto 15 do |i|
@@ -42,5 +41,4 @@ Prawn::Example.generate(filename) do
     fill_color '61bb46'
     fill_rectangle [0, 160], 600, 20
   end
-
 end

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,21 +11,20 @@
 #
 # 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::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  
+
   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
+
+    y = 250 - i * 100
+    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,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::Example.generate(filename) do
+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,25 +1,24 @@
-# 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::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
-  
+
   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)