prawn-core 0.5.0.1

data/lib/prawn/graphics.rb

@@ -0,0 +1,257 @@
+# 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 "enumerator"
+require "prawn/graphics/color"
+
+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
+
+    #######################################################################
+    # Low level drawing operations must translate 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 = translate(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 = translate(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| translate(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 = translate(point)
+      add_content("%.3f %.3f %.3f %.3f re" % [ x, y - height, width, 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
+        @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
+
+    # 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 translate(*point)
+      x,y = point.flatten
+      [@bounding_box.absolute_left + x, @bounding_box.absolute_bottom + y]
+    end
+
+    def translate!(point)
+      point.replace(translate(point))
+    end
+
+  end
+end

data/lib/prawn/graphics/color.rb

@@ -0,0 +1,141 @@
+# encoding: utf-8   
+
+# color.rb : Implements color handling
+#
+# Copyright June 2008, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Graphics
+    module Color   
+      
+      # Sets the fill color.  
+      #
+      # If a single argument is provided, it should be a 6 digit HTML color 
+      # code.
+      # 
+      #   pdf.fill_color "f0ffc1"
+      #
+      # If 4 arguments are provided, the color is assumed to be a CMYK value
+      # Values range from 0 - 100.
+      # 
+      #   pdf.fill_color 0, 99, 95, 0
+      #
+      def fill_color(*color)  
+        return @fill_color if color.empty? 
+        @fill_color = process_color(*color) 
+        set_fill_color
+      end 
+
+      alias_method :fill_color=, :fill_color                                                                     
+
+      # Sets the line stroking color.  6 digit HTML color codes are used.
+      #
+      # If a single argument is provided, it should be a 6 digit HTML color 
+      # code.
+      # 
+      #   pdf.stroke_color "f0ffc1"
+      #
+      # If 4 arguments are provided, the color is assumed to be a CMYK value
+      # Values range from 0 - 100.
+      # 
+      #   pdf.stroke_color 0, 99, 95, 0
+      #
+      def stroke_color(*color)   
+        return @stroke_color if color.empty?
+        @stroke_color = process_color(*color)
+        set_stroke_color
+      end
+
+      alias_method :stroke_color=, :stroke_color
+
+      # Provides the following shortcuts:
+      #
+      #    stroke_some_method(*args) #=> some_method(*args); stroke
+      #    fill_some_method(*args) #=> some_method(*args); fill
+      #    fill_and_stroke_some_method(*args) #=> some_method(*args); fill_and_stroke
+      #
+      def method_missing(id,*args,&block)
+        case(id.to_s) 
+        when /^fill_and_stroke_(.*)/
+          send($1,*args,&block); fill_and_stroke
+        when /^stroke_(.*)/
+          send($1,*args,&block); stroke 
+        when /^fill_(.*)/
+          send($1,*args,&block); fill
+        else
+          super
+        end
+      end   
+      
+      module_function
+        
+      # Converts RGB value array to hex string suitable for use with fill_color 
+      # and stroke_color  
+      #
+      #   >> Prawn::Graphics::Color.rgb2hex([255,120,8])
+      #   => "ff7808"     
+      #
+      def rgb2hex(rgb)
+        rgb.map { |e| "%02x" % e }.join
+      end  
+       
+      # Converts hex string into RGB value array:
+      #
+      #  >> Prawn::Graphics::Color.hex2rgb("ff7808")
+      #  => [255, 120, 8]
+      #
+      def hex2rgb(hex)
+        r,g,b = hex[0..1], hex[2..3], hex[4..5]
+        [r,g,b].map { |e| e.to_i(16) }
+      end 
+      
+      private
+      
+      def process_color(*color)   
+        case(color.size)
+        when 1    
+          color[0]    
+        when 4
+          color
+        else
+          raise ArgumentError, 'wrong number of arguments supplied'    
+        end
+      end  
+      
+      def set_fill_color             
+        case @fill_color
+        when String
+          r,g,b = hex2rgb(@fill_color)
+          add_content "%.3f %.3f %.3f rg" % 
+             [r / 255.0, g / 255.0, b / 255.0]
+        when Array     
+          c,m,y,k = *@fill_color
+          add_content "%.3f %.3f %.3f %.3f k" % 
+            [c / 100.0, m / 100.0, y / 100.0, k / 100.0]
+        end
+      end
+
+      def set_stroke_color       
+        case @stroke_color
+        when String
+          r,g,b = hex2rgb(@stroke_color)
+          add_content "%.3f %.3f %.3f RG" %  
+            [r / 255.0, g / 255.0, b / 255.0]
+        when Array
+          c,m,y,k = *@stroke_color
+          add_content "%.3f %.3f %.3f %.3f K" %  
+            [c / 100.0, m / 100.0, y / 100.0, k / 100.0]
+        end
+      end                                       
+
+      def update_colors 
+        @fill_color   ||= "000000"
+        @stroke_color ||= "000000"
+        set_fill_color
+        set_stroke_color
+      end     
+    end
+  end
+end

data/lib/prawn/images.rb

@@ -0,0 +1,339 @@
+# encoding: ASCII-8BIT
+# images.rb : Implements PDF image embedding
+#
+# Copyright April 2008, James Healy, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'digest/sha1'
+
+module Prawn
+
+  module Images
+
+    # Add the image at filename to the current page. Currently only
+    # JPG and PNG files are supported.
+    #
+    # Arguments:
+    # <tt>file</tt>:: path to file or an object that responds to #read
+    #
+    # Options:
+    # <tt>:at</tt>:: an array [x,y] with the location of the top left corner of the image.
+    # <tt>:position</tt>::  One of (:left, :center, :right) or an x-offset
+    # <tt>:vposition</tt>::  One of (:top, :center, :center) or an y-offset    
+    # <tt>:height</tt>:: the height of the image [actual height of the image]
+    # <tt>:width</tt>:: the width of the image [actual width of the image]
+    # <tt>:scale</tt>:: scale the dimensions of the image proportionally
+    # <tt>:fit</tt>:: scale the dimensions of the image proportionally to fit inside [width,height]
+    # 
+    #   Prawn::Document.generate("image2.pdf", :page_layout => :landscape) do     
+    #     pigs = "#{Prawn::BASEDIR}/data/images/pigs.jpg" 
+    #     image pigs, :at => [50,450], :width => 450                                      
+    #
+    #     dice = "#{Prawn::BASEDIR}/data/images/dice.png"
+    #     image dice, :at => [50, 450], :scale => 0.75 
+    #   end   
+    #
+    # If only one of :width / :height are provided, the image will be scaled
+    # proportionally.  When both are provided, the image will be stretched to 
+    # fit the dimensions without maintaining the aspect ratio.
+    #
+    #
+    # If :at is provided, the image will be place in the current page but
+    # the text position will not be changed.
+    #
+    #
+    # If instead of an explicit filename, an object with a read method is
+    # passed as +file+, you can embed images from IO objects and things
+    # that act like them (including Tempfiles and open-uri objects).
+    #
+    #   require "open-uri"
+    #
+    #   Prawn::Document.generate("remote_images.pdf") do 
+    #     image open("http://prawn.majesticseacreature.com/media/prawn_logo.png")
+    #   end
+    #
+    # This method returns an image info object which can be used to check the
+    # dimensions of an image object if needed. 
+    # (See also: Prawn::Images::PNG , Prawn::Images::JPG)
+    # 
+    def image(file, options={})
+      Prawn.verify_options [:at, :position, :vposition, :height, 
+                            :width, :scale, :fit], options
+
+      if file.respond_to?(:read)
+        image_content = file.read
+      else      
+        raise ArgumentError, "#{file} not found" unless File.file?(file)  
+        image_content =  File.binread(file)
+      end
+      
+      image_sha1 = Digest::SHA1.hexdigest(image_content)
+
+      # register the fact that the current page uses images
+      proc_set :ImageC
+
+      # if this image has already been embedded, just reuse it
+      if image_registry[image_sha1]
+        info = image_registry[image_sha1][:info]
+        image_obj = image_registry[image_sha1][:obj]
+      else
+        # build the image object and embed the raw data
+        image_obj = case detect_image_format(image_content)
+        when :jpg then
+          info = Prawn::Images::JPG.new(image_content)
+          build_jpg_object(image_content, info)
+        when :png then
+          info = Prawn::Images::PNG.new(image_content)
+          build_png_object(image_content, info)
+        end
+        image_registry[image_sha1] = {:obj => image_obj, :info => info}
+      end
+
+      # find where the image will be placed and how big it will be  
+      w,h = calc_image_dimensions(info, options)
+
+      if options[:at]     
+        x,y = translate(options[:at]) 
+      else                  
+        x,y = image_position(w,h,options) 
+        move_text_position h   
+      end
+
+      # add a reference to the image object to the current page
+      # resource list and give it a label
+      label = "I#{next_image_id}"
+      page_xobjects.merge!( label => image_obj )
+
+      # add the image to the current page
+      instruct = "\nq\n%.3f 0 0 %.3f %.3f %.3f cm\n/%s Do\nQ"
+      add_content instruct % [ w, h, x, y - h, label ]
+      
+      return info
+    end
+
+    private   
+    
+    def image_position(w,h,options)
+      options[:position] ||= :left
+      
+      x = case options[:position] 
+      when :left
+        bounds.absolute_left
+      when :center
+        bounds.absolute_left + (bounds.width - w) / 2.0 
+      when :right
+        bounds.absolute_right - w
+      when Numeric
+        options[:position] + bounds.absolute_left
+      end
+
+      y = case options[:vposition]
+      when :top
+        bounds.absolute_top
+      when :center
+        bounds.absolute_top - (bounds.height - h) / 2.0
+      when :bottom
+        bounds.absolute_bottom + h
+      when Numeric
+        bounds.absolute_top - options[:vposition]
+      else
+        self.y
+      end
+      return [x,y]
+    end
+
+    def build_jpg_object(data, jpg) 
+      color_space = case jpg.channels
+      when 1
+        :DeviceGray
+      when 3
+        :DeviceRGB
+      when 4
+        :DeviceCMYK
+      else
+        raise ArgumentError, 'JPG uses an unsupported number of channels'
+      end
+      obj = ref(:Type       => :XObject,
+          :Subtype          => :Image,
+          :Filter           => :DCTDecode,
+          :ColorSpace       => color_space,
+          :BitsPerComponent => jpg.bits,
+          :Width            => jpg.width,
+          :Height           => jpg.height,
+          :Length           => data.size ) 
+
+      # add extra decode params for CMYK images. By swapping the
+      # min and max values from the default, we invert the colours. See
+      # section 4.8.4 of the spec.
+      if color_space == :DeviceCMYK
+        obj.data[:Decode] = [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ]
+      end
+
+      obj << data
+      return obj
+    end
+
+    def build_png_object(data, png)
+
+      if png.compression_method != 0
+        raise Errors::UnsupportedImageType, 'PNG uses an unsupported compression method'
+      end
+
+      if png.filter_method != 0
+        raise Errors::UnsupportedImageType, 'PNG uses an unsupported filter method'
+      end
+
+      if png.interlace_method != 0
+        raise Errors::UnsupportedImageType, 'PNG uses unsupported interlace method'
+      end
+
+      # some PNG types store the colour and alpha channel data together,
+      # which the PDF spec doesn't like, so split it out.
+      png.split_alpha_channel!
+
+      case png.colors
+      when 1
+        color = :DeviceGray
+      when 3
+        color = :DeviceRGB
+      else
+        raise Errors::UnsupportedImageType, "PNG uses an unsupported number of colors (#{png.colors})"
+      end
+
+      # build the image dict
+      obj = ref(:Type             => :XObject,
+                :Subtype          => :Image,
+                :Height           => png.height,
+                :Width            => png.width,
+                :BitsPerComponent => png.bits,
+                :Length           => png.img_data.size,
+                :Filter           => :FlateDecode
+               )
+
+      unless png.alpha_channel
+        obj.data[:DecodeParms] = {:Predictor => 15,
+                                  :Colors    => png.colors,
+                                  :BitsPerComponent => png.bits,
+                                  :Columns   => png.width}
+      end
+
+      # append the actual image data to the object as a stream
+      obj << png.img_data
+      
+      # sort out the colours of the image
+      if png.palette.empty?
+        obj.data[:ColorSpace] = color
+      else
+        # embed the colour palette in the PDF as a object stream
+        palette_obj = ref(:Length => png.palette.size)
+        palette_obj << png.palette
+
+        # build the color space array for the image
+        obj.data[:ColorSpace] = [:Indexed, 
+                                 :DeviceRGB,
+                                 (png.palette.size / 3) -1,
+                                 palette_obj]
+      end
+
+      # *************************************
+      # add transparency data if necessary
+      # *************************************
+
+      # For PNG color types 0, 2 and 3, the transparency data is stored in
+      # a dedicated PNG chunk, and is exposed via the transparency attribute
+      # of the PNG class.
+      if png.transparency[:grayscale]
+        # Use Color Key Masking (spec section 4.8.5)
+        # - An array with N elements, where N is two times the number of color
+        #   components.
+        val = png.transparency[:grayscale]
+        obj.data[:Mask] = [val, val]
+      elsif png.transparency[:rgb]
+        # Use Color Key Masking (spec section 4.8.5)
+        # - An array with N elements, where N is two times the number of color
+        #   components.
+        rgb = png.transparency[:rgb]
+        obj.data[:Mask] = rgb.collect { |val| [val,val] }.flatten
+      elsif png.transparency[:indexed]
+        # TODO: broken. I was attempting to us Color Key Masking, but I think
+        #       we need to construct an SMask i think. Maybe do it inside
+        #       the PNG class, and store it in alpha_channel
+        #obj.data[:Mask] = png.transparency[:indexed]
+      end
+
+      # For PNG color types 4 and 6, the transparency data is stored as a alpha
+      # channel mixed in with the main image data. The PNG class seperates
+      # it out for us and makes it available via the alpha_channel attribute
+      if png.alpha_channel
+        smask_obj = ref(:Type             => :XObject,
+                        :Subtype          => :Image,
+                        :Height           => png.height,
+                        :Width            => png.width,
+                        :BitsPerComponent => png.bits,
+                        :Length           => png.alpha_channel.size,
+                        :Filter           => :FlateDecode,
+                        :ColorSpace       => :DeviceGray,
+                        :Decode           => [0, 1]
+                       )
+        smask_obj << png.alpha_channel
+        obj.data[:SMask] = smask_obj
+      end
+
+      return obj
+    end
+
+    def calc_image_dimensions(info, options)
+      w = options[:width] || info.width
+      h = options[:height] || info.height
+
+      if options[:width] && !options[:height]
+        wp = w / info.width.to_f 
+        w = info.width * wp
+        h = info.height * wp
+      elsif options[:height] && !options[:width]         
+        hp = h / info.height.to_f
+        w = info.width * hp
+        h = info.height * hp   
+      elsif options[:scale] 
+        w = info.width * options[:scale]
+        h = info.height * options[:scale]
+      elsif options[:fit] 
+        bw, bh = options[:fit]
+        bp = bw / bh.to_f
+        ip = info.width / info.height.to_f
+        if ip > bp
+          w = bw
+          h = bw / ip
+        else
+          h = bh
+          w = bh * ip
+        end
+      end
+      info.scaled_width = w
+      info.scaled_height = h
+      [w,h]
+    end
+
+    def detect_image_format(content)
+      top = content[0,128]                       
+
+      if top[0, 3] == "\xff\xd8\xff"
+        return :jpg
+      elsif top[0, 8]  == "\x89PNG\x0d\x0a\x1a\x0a"
+        return :png
+      else
+        raise Errors::UnsupportedImageType, "image file is an unrecognised format"
+      end
+    end
+
+    def image_registry
+      @image_registry ||= {}
+    end
+
+    def next_image_id
+      @image_counter ||= 0
+      @image_counter += 1
+    end
+  end
+end