piglop-prawn 0.10.2.1

data/lib/prawn/graphics/transformation.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+#
+# transformation.rb: Implements rotate, translate, skew, scale and a generic
+#                     transformation_matrix 
+#
+# Copyright January 2010, Michael Witrant. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  module Graphics
+    module Transformation
+      
+      # Rotate the user space.  If a block is not provided, then you must save
+      # and restore the graphics state yourself.
+      #
+      # == Options
+      # <tt>:origin</tt>:: <tt>[number, number]</tt>. The point around which to
+      #                    rotate. A block must be provided if using the :origin
+      #
+      # raises <tt>Prawn::Errors::BlockRequired</tt> if an :origin option is
+      # provided, but no block is given
+      #
+      # Example without a block:
+      #   
+      #   save_graphics_state
+      #   rotate 30
+      #   text "rotated text"
+      #   restore_graphics_state
+      #
+      # Example with a block: rotating a rectangle around its upper-left corner
+      #
+      #   x = 300
+      #   y = 300
+      #   width = 150
+      #   height = 200
+      #   angle = 30
+      #   pdf.rotate(angle, :origin => [x, y]) do
+      #     pdf.stroke_rectangle([x, y], width, height)
+      #   end
+      #
+      def rotate(angle, options={}, &block)
+        Prawn.verify_options(:origin, options)
+        rad = degree_to_rad(angle)
+        cos = Math.cos(rad)
+        sin = Math.sin(rad)
+        if options[:origin].nil?
+          transformation_matrix(cos, sin, -sin, cos, 0, 0, &block)
+        else
+          raise Prawn::Errors::BlockRequired unless block_given?
+          x = options[:origin][0] + bounds.absolute_left
+          y = options[:origin][1] + bounds.absolute_bottom
+          x_prime = x * cos - y * sin
+          y_prime = x * sin + y * cos
+          translate(x - x_prime, y - y_prime) do
+            transformation_matrix(cos, sin, -sin, cos, 0, 0, &block)
+          end
+        end
+      end
+
+      # Translate the user space.  If a block is not provided, then you must save
+      # and restore the graphics state yourself.
+      #
+      # Example without a block: move the text up and over 10
+      #   
+      #   save_graphics_state
+      #   translate(10, 10)
+      #   text "scaled text"
+      #   restore_graphics_state
+      #
+      # Example with a block: draw a rectangle with its upper-left corner at
+      #                       x + 10, y + 10
+      #
+      #   x = 300
+      #   y = 300
+      #   width = 150
+      #   height = 200
+      #   pdf.translate(10, 10) do
+      #     pdf.stroke_rectangle([x, y], width, height)
+      #   end
+      #
+      def translate(x, y, &block)
+        transformation_matrix(1, 0, 0, 1, x, y, &block)
+      end
+      
+      # Scale the user space.  If a block is not provided, then you must save
+      # and restore the graphics state yourself.
+      #
+      # == Options
+      # <tt>:origin</tt>:: <tt>[number, number]</tt>. The point from which to
+      #                    scale. A block must be provided if using the :origin
+      #
+      # raises <tt>Prawn::Errors::BlockRequired</tt> if an :origin option is
+      # provided, but no block is given
+      #
+      # Example without a block:
+      #   
+      #   save_graphics_state
+      #   scale 1.5
+      #   text "scaled text"
+      #   restore_graphics_state
+      #
+      # Example with a block: scale a rectangle from its upper-left corner
+      #
+      #   x = 300
+      #   y = 300
+      #   width = 150
+      #   height = 200
+      #   factor = 1.5
+      #   pdf.scale(angle, :origin => [x, y]) do
+      #     pdf.stroke_rectangle([x, y], width, height)
+      #   end
+      #
+      def scale(factor, options={}, &block)
+        Prawn.verify_options(:origin, options)
+        if options[:origin].nil?
+          transformation_matrix(factor, 0, 0, factor, 0, 0, &block)
+        else
+          raise Prawn::Errors::BlockRequired unless block_given?
+          x = options[:origin][0] + bounds.absolute_left
+          y = options[:origin][1] + bounds.absolute_bottom
+          x_prime = factor * x
+          y_prime = factor * y
+          translate(x - x_prime, y - y_prime) do
+            transformation_matrix(factor, 0, 0, factor, 0, 0, &block)
+          end
+        end
+      end
+      
+      # The following definition of skew would only work in a clearly
+      # predicatable manner when if the document had no margin. don't provide
+      # this shortcut until it behaves in a clearly understood manner
+      #
+      # def skew(a, b, &block)
+      #   transformation_matrix(1,
+      #                         Math.tan(degree_to_rad(a)),
+      #                         Math.tan(degree_to_rad(b)),
+      #                         1, 0, 0, &block)
+      # end
+      
+      # Transform the user space (see notes for rotate regarding graphics state)
+      # Generally, one would use the rotate, scale, translate, and skew
+      # convenience methods instead of calling transformation_matrix directly
+      def transformation_matrix(a, b, c, d, e, f)
+        values = [a, b, c, d, e, f].map { |x| "%.5f" % x }.join(" ")
+        save_graphics_state if block_given?
+        add_content "#{values} cm"
+        if block_given?
+          yield
+          restore_graphics_state
+        end
+      end
+      
+    end
+  end
+end

data/lib/prawn/graphics/transparency.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+#
+# transparency.rb : Implements transparency
+#
+# Copyright October 2009, Daniel Nelson. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+
+module Prawn
+  module Graphics
+
+    # The Prawn::Transparency module is used to place transparent
+    # content on the page. It has the capacity for separate
+    # transparency values for stroked content and all other content.
+    #
+    # Example:
+    #   # both the fill and stroke will be at 50% opacity
+    #   pdf.transparent(0.5) do
+    #     pdf.text("hello world")
+    #     pdf.fill_and_stroke_circle_at([x, y], :radius => 25)
+    #   end
+    #
+    #   # the fill will be at 50% opacity, but the stroke will
+    #   # be at 75% opacity
+    #   pdf.transparent(0.5, 0.75) do
+    #     pdf.text("hello world")
+    #     pdf.fill_and_stroke_circle_at([x, y], :radius => 25)
+    #   end
+    #
+    module Transparency
+
+      # Sets the <tt>opacity</tt> and <tt>stroke_opacity</tt> for all
+      # the content within the <tt>block</tt>
+      # If <tt>stroke_opacity</tt> is not provided, then it takes on
+      # the same value as <tt>opacity</tt>
+      #
+      # Valid ranges for both paramters are 0.0 to 1.0
+      #
+      # Example:
+      #   # both the fill and stroke will be at 50% opacity
+      #   pdf.transparent(0.5) do
+      #     pdf.text("hello world")
+      #     pdf.fill_and_stroke_circle_at([x, y], :radius => 25)
+      #   end
+      #
+      #   # the fill will be at 50% opacity, but the stroke will
+      #   # be at 75% opacity
+      #   pdf.transparent(0.5, 0.75) do
+      #     pdf.text("hello world")
+      #     pdf.fill_and_stroke_circle_at([x, y], :radius => 25)
+      #   end
+      #
+      def transparent(opacity, stroke_opacity=opacity, &block)
+        min_version(1.4)
+
+        opacity        = [[opacity, 0.0].max, 1.0].min
+        stroke_opacity = [[stroke_opacity, 0.0].max, 1.0].min
+
+        save_graphics_state
+        add_content "/#{opacity_dictionary_name(opacity, stroke_opacity)} gs"
+        yield if block_given?
+        restore_graphics_state
+      end
+
+      private
+
+      def opacity_dictionary_registry
+        @opacity_dictionary_registry ||= {}
+      end
+
+      def next_opacity_dictionary_id
+        opacity_dictionary_registry.length + 1
+      end
+
+      def opacity_dictionary_name(opacity, stroke_opacity)
+        key = "#{opacity}_#{stroke_opacity}"
+
+        if opacity_dictionary_registry[key]
+          dictionary =  opacity_dictionary_registry[key][:obj]
+          dictionary_name =  opacity_dictionary_registry[key][:name]
+        else
+          dictionary = ref!(:Type => :ExtGState,
+                                    :CA   => stroke_opacity,
+                                    :ca   => opacity
+                                    )
+
+          dictionary_name = "Tr#{next_opacity_dictionary_id}"
+          opacity_dictionary_registry[key] = { :name => dictionary_name, 
+                                               :obj  => dictionary }
+        end
+
+        page.ext_gstates.merge!(dictionary_name => dictionary)
+        dictionary_name
+      end
+
+    end
+  end
+end

data/lib/prawn/graphics.rb

@@ -0,0 +1,321 @@
+# encoding: utf-8
+
+# graphics.rb : Implements PDF drawing primitives
+#
+# Copyright April 2008, Gregory Brown.  All Rights Reserved.
+#
+# 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"
+
+module Prawn
+
+  # Implements the drawing facilities for Prawn::Document.
+  # Use this to draw the most beautiful imaginable things.
+  #
+  # This file lifts and modifies several of PDF::Writer's graphics functions
+  # ruby-pdf.rubyforge.org
+  #
+  module Graphics
+
+    include Color
+    include Dash
+    include CapStyle
+    include JoinStyle
+    include Transparency
+    include Transformation
+
+    #######################################################################
+    # Low level drawing operations must map the point to absolute coords! #
+    #######################################################################
+
+    # Moves the drawing position to a given point.  The point can be
+    # specified as a tuple or a flattened argument list
+    #
+    #   pdf.move_to [100,50]
+    #   pdf.move_to(100,50)
+    #
+    def move_to(*point)
+      x,y = map_to_absolute(point)
+      add_content("%.3f %.3f m" % [ x, y ])
+    end
+
+    # Draws a line from the current drawing position to the specified point.
+    # The destination may be described as a tuple or a flattened list:
+    #
+    #   pdf.line_to [50,50]
+    #   pdf.line_to(50,50)
+    #
+    def line_to(*point)
+      x,y = map_to_absolute(point)
+      add_content("%.3f %.3f l" % [ x, y ])
+    end
+
+    # Draws a Bezier curve from the current drawing position to the
+    # specified point, bounded by two additional points.
+    #
+    #   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]]"
+
+       curve_points = (options[:bounds] << dest).map { |e| map_to_absolute(e) }
+       add_content("%.3f %.3f %.3f %.3f %.3f %.3f c" %
+                     curve_points.flatten )
+    end
+
+    # Draws a rectangle given <tt>point</tt>, <tt>width</tt> and
+    # <tt>height</tt>.  The rectangle is bounded by its upper-left corner.
+    #
+    #    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 ])
+    end
+    
+    # Draws a rounded rectangle given <tt>point</tt>, <tt>width</tt> and
+    # <tt>height</tt> and <tt>radius</tt> for the rounded corner. The rectangle 
+    # is bounded by its upper-left corner.
+    #
+    #    pdf.rounded_rectangle [300,300], 100, 200, 10
+    #
+    def rounded_rectangle(point,width,height,radius)
+      x, y = point
+      rounded_polygon(radius, point, [x + width, y], [x + width, y - height], [x, y - height])
+    end
+    
+
+    ###########################################################
+    #  Higher level functions: May use relative coords        #
+    ###########################################################
+
+    # Sets line thickness to the <tt>width</tt> specified.
+    #
+    def line_width=(width)
+      @line_width = width
+      add_content("#{width} w")
+    end
+
+    # When called without an argument, returns the current line thickness.
+    # When called with an argument, sets the line thickness to the specified
+    # value (in PDF points)
+    #
+    #   pdf.line_width #=> 1
+    #   pdf.line_width(5)
+    #   pdf.line_width #=> 5
+    #
+    def line_width(width=nil)
+      if width
+        self.line_width = width
+      else
+        (defined?(@line_width) && @line_width) || 1
+      end
+    end
+
+    # Draws a line from one point to another. Points may be specified as
+    # tuples or flattened argument list:
+    #
+    #   pdf.line [100,100], [200,250]
+    #   pdf.line(100,100,200,250)
+    #
+    def line(*points)
+      x0,y0,x1,y1 = points.flatten
+      move_to(x0, y0)
+      line_to(x1, y1)
+    end
+
+    # Draws a horizontal line from <tt>x1</tt> to <tt>x2</tt> at the
+    # current <tt>y</tt> position, or the position specified by the :at option.
+    #
+    #  # 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
+      
+      line(x1,y1,x2,y1)
+    end
+
+    # Draws a horizontal line from the left border to the right border of the
+    # bounding box at the current <tt>y</tt> position.
+    #
+    def horizontal_rule
+      horizontal_line(bounds.left, bounds.right)
+    end
+
+    # Draws a vertical line at the x cooordinate given by :at from y1 to y2.
+    #
+    #   # 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)
+    end
+
+    # Draws a Bezier curve between two points, bounded by two additional
+    # points
+    #
+    #    pdf.curve [50,100], [100,100], :bounds => [[90,90],[75,75]]
+    #
+    def curve(origin,dest, options={})
+      move_to(*origin)
+      curve_to(dest,options)
+    end
+
+    # This constant is used to approximate a symmetrical arc using a cubic
+    # Bezier curve.
+    #
+    KAPPA = 4.0 * ((Math.sqrt(2) - 1.0) / 3.0)
+
+    # 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_at [100,100], :radius => 25
+    #
+    def circle_at(point, options)
+      x,y = point
+      ellipse_at [x, y], options[:radius]
+    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 with x-radius 25 and y-radius 50
+    #    pdf.ellipse_at [100,100], 25, 50
+    #
+    def ellipse_at(point, r1, r2 = r1)
+      x, y = point
+      l1 = r1 * KAPPA
+      l2 = r2 * KAPPA
+
+      move_to(x + r1, y)
+
+      # Upper right hand corner
+      curve_to [x,  y + r2],
+        :bounds => [[x + r1, y + l1], [x + l2, y + r2]]
+
+      # Upper left hand corner
+      curve_to [x - r1, y],
+        :bounds => [[x - l2, y + r2], [x - r1, y + l1]]
+
+      # Lower left hand corner
+      curve_to [x, y - r2],
+        :bounds => [[x - r1, y - l1], [x - l2, y - r2]]
+
+      # Lower right hand corner
+      curve_to [x + r1, y],
+        :bounds => [[x + l2, y - r2], [x + r1, y - l1]]
+
+      move_to(x, y)
+    end
+
+    # Draws a polygon from the specified points.
+    #
+    #    # draws a snazzy triangle
+    #    pdf.polygon [100,100], [100,200], [200,200]
+    #
+    def polygon(*points)
+      move_to points[0]
+      (points[1..-1] << points[0]).each do |point|
+        line_to(*point)
+      end
+    end
+    
+    # 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])
+    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|
+        rounded_vertex(radius, points[i], points[i + 1], points[i + 2])
+      end
+    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.
+    def rounded_vertex(radius, *points)
+      x0,y0,x1,y1,x2,y2 = points.flatten
+      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])
+    end      
+
+    # Strokes and closes the current path. See Graphic::Color for color details
+    #
+    def stroke
+      yield if block_given?
+      add_content "S"
+    end
+    
+    # Draws and strokes a rectangle represented by the current bounding box
+    #
+    def stroke_bounds
+      stroke_rectangle bounds.top_left, bounds.width, bounds.height
+    end
+
+    # Fills and closes the current path. See Graphic::Color for color details
+    #
+    def fill
+      yield if block_given?
+      add_content "f"
+    end
+
+    # Fills, strokes, and closes the current path. See Graphic::Color for color details
+    #
+    def fill_and_stroke
+      yield if block_given?
+      add_content "b"
+    end
+    
+    private
+
+    def map_to_absolute(*point)
+      x,y = point.flatten
+      [@bounding_box.absolute_left + x, @bounding_box.absolute_bottom + y]
+    end
+
+    def map_to_absolute!(point)
+      point.replace(map_to_absolute(point))
+    end
+
+    def degree_to_rad(angle)
+       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
+    def point_on_line(distance_from_end, *points)
+      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, yr]
+    end
+    
+  end
+end

data/lib/prawn/images/jpg.rb

@@ -0,0 +1,46 @@
+# encoding: ASCII-8BIT
+
+# jpg.rb : Extracts the data from a JPG that is needed for embedding
+#
+# Copyright April 2008, James Healy.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'stringio'
+
+module Prawn
+  module Images
+    # A convenience class that wraps the logic for extracting the parts
+    # of a JPG image that we need to embed them in a PDF
+    #
+    class JPG 
+      attr_reader :width, :height, :bits, :channels
+      attr_accessor :scaled_width, :scaled_height
+      
+      JPEG_SOF_BLOCKS = %W(\xc0 \xc1 \xc2 \xc3 \xc5 \xc6 \xc7 \xc9 \xca \xcb \xcd \xce \xcf)
+      JPEG_APP_BLOCKS = %W(\xe0 \xe1 \xe2 \xe3 \xe4 \xe5 \xe6 \xe7 \xe8 \xe9 \xea \xeb \xec \xed \xee \xef)
+
+      # Process a new JPG image
+      #
+      # <tt>:data</tt>:: A binary string of JPEG data
+      #
+      def initialize(data)
+        data = StringIO.new(data.dup)
+
+        c_marker = "\xff" # Section marker.
+        data.read(2)   # Skip the first two bytes of JPEG identifier.
+        loop do
+          marker, code, length = data.read(4).unpack('aan')
+          raise "JPEG marker not found!" if marker != c_marker
+
+          if JPEG_SOF_BLOCKS.include?(code)
+            @bits, @height, @width, @channels = data.read(6).unpack("CnnC")
+            break
+          end
+
+          buffer = data.read(length - 2)
+        end
+      end
+    end
+  end
+end