prawn 0.13.0 → 2.4.0

data/lib/prawn/graphics.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # graphics.rb : Implements PDF drawing primitives
 #
@@ -6,16 +6,16 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require "prawn/graphics/color"
-require "prawn/graphics/dash"
-require "prawn/graphics/cap_style"
-require "prawn/graphics/join_style"
-require "prawn/graphics/transparency"
-require "prawn/graphics/transformation"
-require "prawn/graphics/patterns"
+require_relative 'graphics/blend_mode'
+require_relative 'graphics/color'
+require_relative 'graphics/dash'
+require_relative 'graphics/cap_style'
+require_relative 'graphics/join_style'
+require_relative 'graphics/transparency'
+require_relative 'graphics/transformation'
+require_relative 'graphics/patterns'
 
 module Prawn
-
   # Implements the drawing facilities for Prawn::Document.
   # Use this to draw the most beautiful imaginable things.
   #
@@ -23,7 +23,7 @@ module Prawn
   # ruby-pdf.rubyforge.org
   #
   module Graphics
-
+    include BlendMode
     include Color
     include Dash
     include CapStyle
@@ -32,6 +32,8 @@ module Prawn
     include Transformation
     include Patterns
 
+    # @group Stable API
+
     #######################################################################
     # Low level drawing operations must map the point to absolute coords! #
     #######################################################################
@@ -43,8 +45,8 @@ module Prawn
     #   pdf.move_to(100,50)
     #
     def move_to(*point)
-      x,y = map_to_absolute(point)
-      add_content("%.3f %.3f m" % [ x, y ])
+      xy = PDF::Core.real_params(map_to_absolute(point))
+      renderer.add_content("#{xy} m")
     end
 
     # Draws a line from the current drawing position to the specified point.
@@ -54,8 +56,8 @@ module Prawn
     #   pdf.line_to(50,50)
     #
     def line_to(*point)
-      x,y = map_to_absolute(point)
-      add_content("%.3f %.3f l" % [ x, y ])
+      xy = PDF::Core.real_params(map_to_absolute(point))
+      renderer.add_content("#{xy} l")
     end
 
     # Draws a Bezier curve from the current drawing position to the
@@ -63,14 +65,18 @@ module Prawn
     #
     #   pdf.curve_to [100,100], :bounds => [[90,90],[75,75]]
     #
-    def curve_to(dest,options={})
-       options[:bounds] or raise Prawn::Errors::InvalidGraphicsPath,
-         "Bounding points for bezier curve must be specified "+
-         "as :bounds => [[x1,y1],[x2,y2]]"
+    def curve_to(dest, options = {})
+      options[:bounds] || raise(
+        Prawn::Errors::InvalidGraphicsPath,
+        'Bounding points for bezier curve must be specified ' \
+        'as :bounds => [[x1,y1],[x2,y2]]'
+      )
+
+      curve_points = PDF::Core.real_params(
+        (options[:bounds] << dest).flat_map { |e| map_to_absolute(e) }
+      )
 
-       curve_points = (options[:bounds] << dest).map { |e| map_to_absolute(e) }
-       add_content("%.3f %.3f %.3f %.3f %.3f %.3f c" %
-                     curve_points.flatten )
+      renderer.add_content("#{curve_points} c")
     end
 
     # Draws a rectangle given <tt>point</tt>, <tt>width</tt> and
@@ -78,9 +84,11 @@ module Prawn
     #
     #    pdf.rectangle [300,300], 100, 200
     #
-    def rectangle(point,width,height)
-      x,y = map_to_absolute(point)
-      add_content("%.3f %.3f %.3f %.3f re" % [ x, y - height, width, height ])
+    def rectangle(point, width, height)
+      x, y = map_to_absolute(point)
+      box = PDF::Core.real_params([x, y - height, width, height])
+
+      renderer.add_content("#{box} re")
     end
 
     # Draws a rounded rectangle given <tt>point</tt>, <tt>width</tt> and
@@ -89,12 +97,13 @@ module Prawn
     #
     #    pdf.rounded_rectangle [300,300], 100, 200, 10
     #
-    def rounded_rectangle(point,width,height,radius)
+    def rounded_rectangle(point, width, height, radius)
       x, y = point
-      rounded_polygon(radius, point, [x + width, y], [x + width, y - height], [x, y - height])
+      rounded_polygon(
+        radius, point, [x + width, y], [x + width, y - height], [x, y - height]
+      )
     end
 
-
     ###########################################################
     #  Higher level functions: May use relative coords        #
     ###########################################################
@@ -114,7 +123,7 @@ module Prawn
     #   pdf.line_width(5)
     #   pdf.line_width #=> 5
     #
-    def line_width(width=nil)
+    def line_width(width = nil)
       if width
         self.line_width = width
       else
@@ -129,7 +138,7 @@ module Prawn
     #   pdf.line(100,100,200,250)
     #
     def line(*points)
-      x0,y0,x1,y1 = points.flatten
+      x0, y0, x1, y1 = points.flatten
       move_to(x0, y0)
       line_to(x1, y1)
     end
@@ -140,14 +149,10 @@ module Prawn
     #  # draw a line from [25, 75] to [100, 75]
     #  horizontal_line 25, 100, :at => 75
     #
-    def horizontal_line(x1,x2,options={})
-      if options[:at]
-        y1 = options[:at]
-      else
-        y1 = y - bounds.absolute_bottom
-      end
+    def horizontal_line(x1, x2, options = {})
+      y1 = options[:at] || y - bounds.absolute_bottom
 
-      line(x1,y1,x2,y1)
+      line(x1, y1, x2, y1)
     end
 
     # Draws a horizontal line from the left border to the right border of the
@@ -162,8 +167,8 @@ module Prawn
     #   # draw a line from [25, 100] to [25, 300]
     #   vertical_line 100, 300, :at => 25
     #
-    def vertical_line(y1,y2,params)
-      line(params[:at],y1,params[:at],y2)
+    def vertical_line(y1, y2, params)
+      line(params[:at], y1, params[:at], y2)
     end
 
     # Draws a Bezier curve between two points, bounded by two additional
@@ -171,9 +176,9 @@ module Prawn
     #
     #    pdf.curve [50,100], [100,100], :bounds => [[90,90],[75,75]]
     #
-    def curve(origin,dest, options={})
+    def curve(origin, dest, options = {})
       move_to(*origin)
-      curve_to(dest,options)
+      curve_to(dest, options)
     end
 
     # This constant is used to approximate a symmetrical arc using a cubic
@@ -181,16 +186,9 @@ module Prawn
     #
     KAPPA = 4.0 * ((Math.sqrt(2) - 1.0) / 3.0)
 
-    # <b>DEPRECATED:</b> Please use <tt>circle</tt> instead.
-    def circle_at(point, options)
-      warn "[DEPRECATION] 'circle_at' is deprecated in favor of 'circle'. " +
-           "'circle_at' will be removed in release 1.1"
-      circle(point, options[:radius])
-    end
-
-    # Draws a circle of radius <tt>radius</tt> with the centre-point at <tt>point</tt>
-    # as a complete subpath. The drawing point will be moved to the
-    # centre-point upon completion of the drawing the circle.
+    # Draws a circle of radius <tt>radius</tt> with the centre-point at
+    # <tt>point</tt> as a complete subpath. The drawing point will be moved to
+    # the centre-point upon completion of the drawing the circle.
     #
     #    pdf.circle [100,100], 25
     #
@@ -198,43 +196,36 @@ module Prawn
       ellipse(center, radius, radius)
     end
 
-    # <b>DEPRECATED:</b> Please use <tt>ellipse</tt> instead.
-    def ellipse_at(point, r1, r2=r1)
-      warn "[DEPRECATION] 'ellipse_at' is deprecated in favor of 'ellipse'. " +
-           "'ellipse_at' will be removed in release 1.1"
-      ellipse(point, r1, r2)
-    end
-
-    # Draws an ellipse of +x+ radius <tt>r1</tt> and +y+ radius <tt>r2</tt>
-    # with the centre-point at <tt>point</tt> as a complete subpath. The
-    # drawing point will be moved to the centre-point upon completion of the
-    # drawing the ellipse.
+    # Draws an ellipse of +x+ radius <tt>radius1</tt> and +y+ radius
+    # <tt>radius2</tt> with the centre-point at <tt>point</tt> as a complete
+    # subpath. The drawing point will be moved to the centre-point upon
+    # completion of the drawing the ellipse.
     #
     #    # draws an ellipse with x-radius 25 and y-radius 50
     #    pdf.ellipse [100,100], 25, 50
     #
-    def ellipse(point, r1, r2 = r1)
+    def ellipse(point, radius1, radius2 = radius1)
       x, y = point
-      l1 = r1 * KAPPA
-      l2 = r2 * KAPPA
+      l1 = radius1 * KAPPA
+      l2 = radius2 * KAPPA
 
-      move_to(x + r1, y)
+      move_to(x + radius1, y)
 
       # Upper right hand corner
-      curve_to [x,  y + r2],
-        :bounds => [[x + r1, y + l2], [x + l1, y + r2]]
+      curve_to [x, y + radius2],
+        bounds: [[x + radius1, y + l2], [x + l1, y + radius2]]
 
       # Upper left hand corner
-      curve_to [x - r1, y],
-        :bounds => [[x - l1, y + r2], [x - r1, y + l2]]
+      curve_to [x - radius1, y],
+        bounds: [[x - l1, y + radius2], [x - radius1, y + l2]]
 
       # Lower left hand corner
-      curve_to [x, y - r2],
-        :bounds => [[x - r1, y - l2], [x - l1, y - r2]]
+      curve_to [x, y - radius2],
+        bounds: [[x - radius1, y - l2], [x - l1, y - radius2]]
 
       # Lower right hand corner
-      curve_to [x + r1, y],
-        :bounds => [[x + l1, y - r2], [x + r1, y - l2]]
+      curve_to [x + radius1, y],
+        bounds: [[x + l1, y - radius2], [x + radius1, y - l2]]
 
       move_to(x, y)
     end
@@ -250,36 +241,47 @@ module Prawn
         line_to(*point)
       end
       # close the path
-      add_content "h"
+      renderer.add_content 'h'
     end
 
-    # Draws a rounded polygon from specified points using the radius to define bezier curves
+    # Draws a rounded polygon from specified points using the radius to define
+    # bezier curves
     #
-    #  # draws a rounded filled in polygon
-    #   pdf.fill_and_stroke_rounded_polygon(10, [100, 250], [200, 300], [300, 250],
-    #                 [300, 150], [200, 100], [100, 150])
+    #   # draws a rounded filled in polygon
+    #   pdf.fill_and_stroke_rounded_polygon(
+    #     10, [100, 250], [200, 300], [300, 250], [300, 150], [200, 100],
+    #     [100, 150]
+    #   )
     def rounded_polygon(radius, *points)
       move_to point_on_line(radius, points[1], points[0])
       sides = points.size
       points << points[0] << points[1]
-      (sides).times do |i|
+      sides.times do |i|
         rounded_vertex(radius, points[i], points[i + 1], points[i + 2])
       end
       # close the path
-      add_content "h"
+      renderer.add_content 'h'
     end
 
-
-    # Creates a rounded vertex for a line segment used for building a rounded polygon
-    # requires a radius to define bezier curve and three points. The first two points define
-    # the line segment and the third point helps define the curve for the vertex.
+    # Creates a rounded vertex for a line segment used for building a rounded
+    # polygon requires a radius to define bezier curve and three points. The
+    # first two points define the line segment and the third point helps define
+    # the curve for the vertex.
     def rounded_vertex(radius, *points)
-      radial_point_1 = point_on_line(radius, points[0], points[1])
-      bezier_point_1 = point_on_line((radius - radius*KAPPA), points[0], points[1] )
-      radial_point_2 = point_on_line(radius, points[2], points[1])
-      bezier_point_2 = point_on_line((radius - radius*KAPPA), points[2], points[1])
-      line_to(radial_point_1)
-      curve_to(radial_point_2, :bounds => [bezier_point_1, bezier_point_2])
+      radial_point1 = point_on_line(radius, points[0], points[1])
+      bezier_point1 = point_on_line(
+        (radius - radius * KAPPA),
+        points[0],
+        points[1]
+      )
+      radial_point2 = point_on_line(radius, points[2], points[1])
+      bezier_point2 = point_on_line(
+        (radius - radius * KAPPA),
+        points[2],
+        points[1]
+      )
+      line_to(radial_point1)
+      curve_to(radial_point2, bounds: [bezier_point1, bezier_point2])
     end
 
     # Strokes the current path. If a block is provided, yields to the block
@@ -287,7 +289,7 @@ module Prawn
     #
     def stroke
       yield if block_given?
-      add_content "S"
+      renderer.add_content 'S'
     end
 
     # Closes and strokes the current path. If a block is provided, yields to
@@ -295,7 +297,7 @@ module Prawn
     #
     def close_and_stroke
       yield if block_given?
-      add_content "s"
+      renderer.add_content 's'
     end
 
     # Draws and strokes a rectangle represented by the current bounding box
@@ -330,38 +332,56 @@ module Prawn
     #
     def stroke_axis(options = {})
       options = {
-        :at => [0,0],
-        :height => bounds.height.to_i - (options[:at] || [0,0])[1],
-        :width => bounds.width.to_i - (options[:at] || [0,0])[0],
-        :step_length => 100,
-        :negative_axes_length => 20,
-        :color => "000000",
+        at: [0, 0],
+        height: bounds.height.to_i - (options[:at] || [0, 0])[1],
+        width: bounds.width.to_i - (options[:at] || [0, 0])[0],
+        step_length: 100,
+        negative_axes_length: 20,
+        color: '000000'
       }.merge(options)
 
-      Prawn.verify_options([:at, :width, :height, :step_length,
-                            :negative_axes_length, :color], options)
+      Prawn.verify_options(
+        %i[at width height step_length negative_axes_length color],
+        options
+      )
 
       save_graphics_state do
         fill_color(options[:color])
         stroke_color(options[:color])
 
-        dash(1, :space => 4)
-        stroke_horizontal_line(options[:at][0] - options[:negative_axes_length],
-                               options[:at][0] + options[:width], :at => options[:at][1])
-        stroke_vertical_line(options[:at][1] - options[:negative_axes_length],
-                             options[:at][1] + options[:height], :at => options[:at][0])
+        dash(1, space: 4)
+        stroke_horizontal_line(
+          options[:at][0] - options[:negative_axes_length],
+          options[:at][0] + options[:width],
+          at: options[:at][1]
+        )
+        stroke_vertical_line(
+          options[:at][1] - options[:negative_axes_length],
+          options[:at][1] + options[:height],
+          at: options[:at][0]
+        )
         undash
 
         fill_circle(options[:at], 1)
 
-        (options[:step_length]..options[:width]).step(options[:step_length]) do |point|
+        (options[:step_length]..options[:width])
+          .step(options[:step_length]) do |point|
           fill_circle([options[:at][0] + point, options[:at][1]], 1)
-          draw_text(point, :at => [options[:at][0] + point - 5, options[:at][1] - 10], :size => 7)
+          draw_text(
+            point,
+            at: [options[:at][0] + point - 5, options[:at][1] - 10],
+            size: 7
+          )
         end
 
-        (options[:step_length]..options[:height]).step(options[:step_length]) do |point|
+        (options[:step_length]..options[:height])
+          .step(options[:step_length]) do |point|
           fill_circle([options[:at][0], options[:at][1] + point], 1)
-          draw_text(point, :at => [options[:at][0] - 17, options[:at][1] + point - 2], :size => 7)
+          draw_text(
+            point,
+            at: [options[:at][0] - 17, options[:at][1] + point - 2],
+            size: 7
+          )
         end
       end
     end
@@ -373,9 +393,9 @@ module Prawn
     # will be used. See the PDF reference, "Graphics -> Path Construction and
     # Painting -> Clipping Path Operators" for details on the difference.
     #
-    def fill(options={})
+    def fill(options = {})
       yield if block_given?
-      add_content(options[:fill_rule] == :even_odd ? "f*" : "f")
+      renderer.add_content(options[:fill_rule] == :even_odd ? 'f*' : 'f')
     end
 
     # Closes, fills, and strokes the current path. If a block is provided,
@@ -387,15 +407,15 @@ module Prawn
     # will be used. See the PDF reference, "Graphics -> Path Construction and
     # Painting -> Clipping Path Operators" for details on the difference.
     #
-    def fill_and_stroke(options={})
+    def fill_and_stroke(options = {})
       yield if block_given?
-      add_content(options[:fill_rule] == :even_odd ? "b*" : "b")
+      renderer.add_content(options[:fill_rule] == :even_odd ? 'b*' : 'b')
     end
 
     # Closes the current path.
     #
     def close_path
-      add_content "h"
+      renderer.add_content 'h'
     end
 
     ##
@@ -604,12 +624,20 @@ module Prawn
     # :call-seq:
     #   fill_and_stroke_rounded_polygon(radius, *points)
 
-    ops    = %w{fill stroke fill_and_stroke}
-    shapes = %w{line_to curve_to rectangle rounded_rectangle line horizontal_line horizontal_rule vertical_line
-                curve circle_at circle ellipse_at ellipse polygon rounded_polygon rounded_vertex}
+    ops = %w[fill stroke fill_and_stroke]
+    shapes = %w[
+      line_to curve_to rectangle rounded_rectangle line horizontal_line
+      horizontal_rule vertical_line curve circle_at circle ellipse_at ellipse
+      polygon rounded_polygon rounded_vertex
+    ]
 
-    ops.product(shapes).each do |operation,shape|
-      class_eval "def #{operation}_#{shape}(*args); #{shape}(*args); #{operation}; end"
+    ops.product(shapes).each do |operation, shape|
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def #{operation}_#{shape}(*args)    # def fill_polygon(*args)
+          #{shape}(*args)                   #   polygon(*args)
+          #{operation}                      #   fill
+        end                                 # end
+      METHOD
     end
 
     private
@@ -623,11 +651,11 @@ module Prawn
     end
 
     def write_line_width
-      add_content("#{current_line_width} w")
+      renderer.add_content("#{current_line_width} w")
     end
 
     def map_to_absolute(*point)
-      x,y = point.flatten
+      x, y = point.flatten
       [@bounding_box.absolute_left + x, @bounding_box.absolute_bottom + y]
     end
 
@@ -636,19 +664,18 @@ module Prawn
     end
 
     def degree_to_rad(angle)
-       angle * Math::PI / 180
+      angle * Math::PI / 180
     end
 
-    # Returns the coordinates for a point on a line that is a given distance away from the second
-    # point defining the line segement
+    # Returns the coordinates for a point on a line that is a given distance
+    # away from the second point defining the line segement
     def point_on_line(distance_from_end, *points)
-      x0,y0,x1,y1 = points.flatten
+      x0, y0, x1, y1 = points.flatten
       length = Math.sqrt((x1 - x0)**2 + (y1 - y0)**2)
       p = (length - distance_from_end) / length
-      xr = x0 + p*(x1 - x0)
-      yr = y0 + p*(y1 - y0)
+      xr = x0 + p * (x1 - x0)
+      yr = y0 + p * (y1 - y0)
       [xr, yr]
     end
-
   end
 end