prawn 2.0.2 → 2.3.0

data/manual/document_and_page_options/print_scaling.rb

@@ -1,20 +1,22 @@
-# encoding: utf-8
-#
-# (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.
+# 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 File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+require_relative '../example_helper'
 
-Prawn::Document.generate("print_scaling.pdf",
-                         :page_layout => :landscape,
-                         :print_scaling => :none
+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."
+  text 'When you print this document, the scale to fit in print preview '\
+    'should be disabled by default.'
 end

data/manual/example_helper.rb

@@ -1,7 +1,8 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
-require_relative "../lib/prawn"
-require "prawn/manual_builder"
+$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

@@ -0,0 +1,52 @@
+# 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
+# blend the layers based on the first recognized blend mode.
+#
+# Valid blend modes in v1.4 of the PDF spec include :Normal, :Multiply, :Screen,
+# :Overlay, :Darken, :Lighten, :ColorDodge, :ColorBurn, :HardLight, :SoftLight,
+# :Difference, :Exclusion, :Hue, :Saturation, :Color, and :Luminosity.
+
+require_relative '../example_helper'
+
+filename = File.basename(__FILE__).gsub('.rb', '.pdf')
+Prawn::ManualBuilder::Example.generate(filename) do
+  start_new_page
+
+  # https://commons.wikimedia.org/wiki/File:Blend_modes_2.-bottom-layer.jpg#/media/File:Blend_modes_2.-bottom-layer.jpg
+  bottom_layer = "#{Prawn::DATADIR}/images/blend_modes_bottom_layer.jpg"
+
+  # 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 = %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
+    y = cursor - (index / 4 * 200)
+
+    image bottom_layer, at: [x, y], fit: [125, 125]
+    blend_mode(blend_mode) do
+      image top_layer, at: [x, y], fit: [125, 125]
+    end
+
+    y -= 130
+
+    fill_color '009ddc'
+    fill_rectangle [x, y], 75, 25
+    blend_mode(blend_mode) do
+      fill_color 'fdb827'
+      fill_rectangle [x + 50, y], 75, 25
+    end
+
+    y -= 30
+
+    fill_color '000000'
+    text_box blend_mode.to_s, at: [x, y]
+  end
+end

data/manual/graphics/circle_and_ellipse.rb

@@ -1,14 +1,13 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # To define a <code>circle</code> all you need is the center point and the
 # radius.
 #
 # To define an <code>ellipse</code> you provide the center point and two radii
 # (or axes) values. If the second radius value is ommitted, both radii will be
 # equal and you will end up drawing a circle.
-#
-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/color.rb

@@ -1,19 +1,17 @@
-# encoding: utf-8
-#
+# 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.
-#
-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
 
-  # Fill with Yellow using RGB
-  fill_color "FFFFCC"
-  fill_polygon [50, 150], [150, 200], [250, 150],
-               [250, 50], [150, 0], [50, 50]
+  # Fill with Yellow using RGB (Unlike css, there is no leading #)
+  fill_color 'FFFFCC'
+  fill_polygon [50, 150], [150, 200], [250, 150], [250, 50], [150, 0], [50, 50]
 
   # Stroke with Purple using CMYK
   stroke_color 50, 100, 0, 0

data/manual/graphics/common_lines.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -8,23 +8,22 @@
 #
 # <code>horizontal_rule</code> draws a horizontal line on the current bounding
 # box from border to border, using the current y position.
-#
-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
 
-  stroke_color "ff0000"
+  stroke_color 'ff0000'
 
   stroke do
     # just lower the current y position
     move_down 50
     horizontal_rule
 
-    vertical_line   100, 300, :at => 50
+    vertical_line   100, 300, at: 50
 
-    horizontal_line 200, 500, :at => 150
+    horizontal_line 200, 500, at: 150
   end
 end

data/manual/graphics/fill_and_stroke.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # There are two drawing primitives in Prawn: <code>fill</code> and
 # <code>stroke</code>.
 #
@@ -17,9 +17,8 @@
 # Most of the methods which define drawing paths have methods of the same name
 # starting with stroke_ and fill_ which create the drawing path and then stroke
 # or fill 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::ManualBuilder::Example.generate(filename) do

data/manual/graphics/fill_rules.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -15,9 +15,8 @@
 #
 # The differences between the fill rules only come into play with complex
 # paths; they are identical for simple shapes.
-#
-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
@@ -26,13 +25,13 @@ Prawn::ManualBuilder::Example.generate(filename) do
   stroke_color 'ff0000'
   line_width 2
 
-  text_box "Nonzero Winding Number", :at => [50, 215],
-                                     :width => 170,
-                                     :align => :center
+  text_box 'Nonzero Winding Number', at: [50, 215],
+                                     width: 170,
+                                     align: :center
   polygon(*pentagram.map { |x, y| [x + 50, y] })
   fill_and_stroke
 
-  text_box "Even-Odd", :at => [330, 215], :width => 170, :align => :center
+  text_box 'Even-Odd', at: [330, 215], width: 170, align: :center
   polygon(*pentagram.map { |x, y| [x + 330, y] })
-  fill_and_stroke(:fill_rule => :even_odd)
+  fill_and_stroke(fill_rule: :even_odd)
 end

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::ManualBuilder::Example.generate(filename) do
-  stroke_axis
   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,55 +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::ManualBuilder::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,18 @@
 # 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::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