prawn 2.1.0 → 2.2.0

data/manual/graphics/soft_masks.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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
@@ -11,8 +9,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,3 @@
-# encoding: utf-8
-#
 # 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 +9,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
@@ -25,7 +22,7 @@ Prawn::ManualBuilder::Example.generate(filename) do
     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,3 @@
-# encoding: utf-8
-#
 # This sets the dashed pattern for lines and curves. The (dash) length defines
 # how long each dash will be.
 #
@@ -12,18 +10,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 +31,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,11 @@
-# encoding: utf-8
-#
 # 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

data/manual/graphics/translate.rb

@@ -1,10 +1,7 @@
-# encoding: utf-8
-#
 # 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 +14,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,3 @@
-# encoding: utf-8
-#
 # 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 +5,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,10 @@
-# encoding: utf-8
-#
 # 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 +19,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.
 

data/manual/images/absolute_position.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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 +6,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,18 @@
-# encoding: utf-8
-#
 # <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,22 @@
-# encoding: utf-8
-#
 # 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
+      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,37 +1,39 @@
-# encoding: utf-8
-#
 # Examples for embedding images.
-#
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-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"
+require_relative '../example_helper'
+
+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.
+      prose <<-END
+        Embedding images on PDF documents is fairly easy. Prawn supports both
+        JPG and PNG images.
 
-      The examples show:")
+        The examples show:
+      END
 
-      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"
-          )
+      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,3 @@
-# encoding: utf-8
-#
 # 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 +5,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,19 @@
-# encoding: utf-8
-#
 # 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,25 @@
-# encoding: utf-8
-#
 # 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
+      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