prawn 0.8.4 → 0.11.1.pre

data/lib/prawn/graphics/dash.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8   
+
+# dash.rb : Implements stroke dashing
+#
+# Contributed by Daniel Nelson. October, 2009
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Graphics
+    module Dash
+
+      # Sets the dash pattern for stroked lines and curves
+      #
+      #   length is the length of the dash. If options is not present,
+      #   or options[:space] is nil, then length is also the length of
+      #   the space between dashes
+      #
+      #   options may contain :space and :phase
+      #      :space is the space between the dashes
+      #      :phase is where in the cycle to begin dashing. For
+      #             example, a phase of 0 starts at the beginning of
+      #             the dash; whereas, if the phase is equal to the
+      #             length of the dash, then stroking will begin at
+      #             the beginning of the space. Default is 0
+      #
+      #   integers or floats may be used for length and the options
+      #
+      #   dash units are in PDF points ( 1/72 in )
+      #   
+      def dash(length=nil, options={})
+        return @dash || undash_hash if length.nil?
+
+        @dash = { :dash  => length, 
+                  :space => options[:space] || length, 
+                  :phase => options[:phase] || 0 }
+
+        write_stroke_dash
+      end
+      
+      alias_method :dash=, :dash
+
+      # Stops dashing, restoring solid stroked lines and curves
+      #
+      def undash
+        @dash = undash_hash
+        write_stroke_dash
+      end
+      
+      # Returns when stroke is dashed, false otherwise
+      #
+      def dashed?
+        dash != undash_hash
+      end
+
+      private
+
+      def undash_hash
+        { :dash => nil, :space => nil, :phase => 0 }
+      end
+
+      def write_stroke_dash
+        if @dash[:dash].nil?
+          add_content "[] 0 d"
+          return
+        end
+        add_content "[#{@dash[:dash]} #{@dash[:space]}] #{@dash[:phase]} d"
+      end     
+    end
+  end
+end

data/lib/prawn/graphics/join_style.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8   
+
+# join_style.rb : Implements stroke join styling
+#
+# Contributed by Daniel Nelson. October, 2009
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Graphics
+    module JoinStyle
+      JOIN_STYLES = { :miter => 0, :round => 1, :bevel => 2 }
+      
+      # Sets the join style for stroked lines and curves
+      #
+      # style is one of :miter, :round, or :bevel
+      #
+      # NOTE: if this method is never called, :miter will be used for join style
+      # throughout the document
+      #
+      def join_style(style=nil)
+        return @join_style || :miter if style.nil?
+
+        @join_style = style
+
+        write_stroke_join_style
+      end
+      
+      alias_method :join_style=, :join_style
+
+      private
+
+      def write_stroke_join_style
+        add_content "#{JOIN_STYLES[@join_style]} j"
+      end
+    end
+  end
+end

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
+        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/images.rb

@@ -0,0 +1,361 @@
+# 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.
+    #
+    # NOTE: Prawn is very slow at rendering PNGs with alpha channels.  The
+    # workaround for those who don't mind installing RMagick is to use:
+    #
+    # http://github.com/amberbit/prawn-fast-png
+    #
+    # 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)
+
+      # 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)
+
+          # 16-bit color only supported in 1.5+ (ISO 32000-1:2008 8.9.5.1)
+          if info.bits > 8
+            min_version 1.5
+          end
+
+          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 = map_to_absolute(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}"
+      state.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
+        determine_y_with_page_flow(h)
+      end
+      return [x,y]
+    end 
+    
+    def determine_y_with_page_flow(h)
+      if overruns_page?(h)
+        start_new_page
+        bounds.absolute_top 
+      else
+        self.y
+      end
+    end 
+    
+    def overruns_page?(h)
+      (self.y - h) < bounds.absolute_bottom 
+    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 { |x| [x,x] }.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
+        min_version 1.4
+        smask_obj = ref!(:Type             => :XObject,
+                        :Subtype          => :Image,
+                        :Height           => png.height,
+                        :Width            => png.width,
+                        :BitsPerComponent => png.alpha_channel_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