prawn 0.12.0 → 0.13.0

data/lib/prawn/graphics/transparency.rb

@@ -86,7 +86,7 @@ module Prawn
                                     )
 
           dictionary_name = "Tr#{next_opacity_dictionary_id}"
-          opacity_dictionary_registry[key] = { :name => dictionary_name, 
+          opacity_dictionary_registry[key] = { :name => dictionary_name,
                                                :obj  => dictionary }
         end
 

data/lib/prawn/image_handler.rb

@@ -0,0 +1,30 @@
+module Prawn
+  def self.image_handler
+    @image_handler ||= ImageHandler.new
+  end
+
+  class ImageHandler
+    def initialize
+      @handlers = []
+    end
+
+    def register(handler)
+      @handlers.delete(handler)
+      @handlers.push handler
+    end
+
+    def register!(handler)
+      @handlers.delete(handler)
+      @handlers.unshift handler
+    end
+
+    def find(image_blob)
+      handler = @handlers.find{ |h| h.can_render? image_blob }
+
+      return handler if handler
+
+      raise Prawn::Errors::UnsupportedImageType,
+            "image file is an unrecognised format"
+    end
+  end
+end

data/lib/prawn/images.rb

@@ -6,16 +6,17 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 require 'digest/sha1'
+require 'pathname'
 
 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:
+    # NOTE: Prawn is very slow at rendering PNGs with alpha channels, and this
+    # uses a lot of RAM. The workaround for those who don't mind installing
+    # RMagick is to use:
     #
     # http://github.com/amberbit/prawn-fast-png
     #
@@ -25,22 +26,22 @@ module Prawn
     # 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>: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   
+    #   Prawn::Document.generate("image2.pdf", :page_layout => :landscape) do
+    #     pigs = "#{Prawn::DATADIR}/images/pigs.jpg"
+    #     image pigs, :at => [50,450], :width => 450
+    #
+    #     dice = "#{Prawn::DATADIR}/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 
+    # proportionally.  When both are provided, the image will be stretched to
     # fit the dimensions without maintaining the aspect ratio.
     #
     #
@@ -54,25 +55,30 @@ module Prawn
     #
     #   require "open-uri"
     #
-    #   Prawn::Document.generate("remote_images.pdf") do 
+    #   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. 
+    # 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, 
+      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
-      
+      pdf_obj, info = build_image_object(file)
+      embed_image(pdf_obj, info, options)
+
+      info
+    end
+
+    # Builds an info object (Prawn::Images::*) and a PDF reference representing
+    # the given image. Return a pair: [pdf_obj, info].
+    #
+    def build_image_object(file)
+      io = verify_and_open_image(file)
+      image_content = io.read
       image_sha1 = Digest::SHA1.hexdigest(image_content)
 
       # if this image has already been embedded, just reuse it
@@ -81,11 +87,7 @@ module Prawn
         image_obj = image_registry[image_sha1][:obj]
       else
         # Build the image object
-        klass = case detect_image_format(image_content)
-                when :jpg then Prawn::Images::JPG
-                when :png then Prawn::Images::PNG
-                end
-        info = klass.new(image_content)
+        info = Prawn.image_handler.find(image_content).new(image_content)
 
         # Bump PDF version if the image requires it
         min_version(info.min_pdf_version) if info.respond_to?(:min_pdf_version)
@@ -95,43 +97,58 @@ module Prawn
         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)
+      [image_obj, info]
+    end
+
+    # Given a PDF image resource <tt>pdf_obj</tt> that has been added to the
+    # page's resources and an <tt>info</tt> object (the pair returned from
+    # build_image_object), embed the image according to the <tt>options</tt>
+    # given.
+    #
+    def embed_image(pdf_obj, info, options)
+      # find where the image will be placed and how big it will be
+      w,h = info.calc_image_dimensions(options)
 
-      if options[:at]     
-        x,y = map_to_absolute(options[:at]) 
-      else                  
-        x,y = image_position(w,h,options) 
-        move_text_position h   
+      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 )
+      state.page.xobjects.merge!(label => pdf_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   
-    
+    private
+
+    def verify_and_open_image(io_or_path)
+      # File or IO
+      if io_or_path.respond_to?(:rewind)
+        io = io_or_path
+        # Rewind if the object we're passed is an IO, so that multiple embeds of
+        # the same IO object will work
+        io.rewind
+        # read the file as binary so the size is calculated correctly
+        # guard binmode because some objects acting io-like don't implement it
+        io.binmode if io.respond_to?(:binmode)
+        return io
+      end
+      # String or Pathname
+      io_or_path = Pathname.new(io_or_path)
+      raise ArgumentError, "#{io_or_path} not found" unless io_or_path.file?
+      io = io_or_path.open('rb')
+      io
+    end
+
     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
@@ -145,66 +162,30 @@ module Prawn
       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
+
+      x = case options[:position]
+      when :left
+        bounds.left_side
+      when :center
+        bounds.left_side + (bounds.width - w) / 2.0
+      when :right
+        bounds.right_side - w
+      when Numeric
+        options[:position] + bounds.left_side
       end
-    end 
-    
-    def overruns_page?(h)
-      (self.y - h) < reference_bounds.absolute_bottom 
+
+      return [x,y]
     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
+    def determine_y_with_page_flow(h)
+      if overruns_page?(h)
+        bounds.move_past_bottom
       end
-      info.scaled_width = w
-      info.scaled_height = h
-      [w,h]
+      self.y
     end
 
-    def detect_image_format(content)
-      top = content[0,128]                       
-
-      # Unpack before comparing for JPG header, so as to avoid having to worry
-      # about the source string encoding. We just want a byte-by-byte compare.
-      if top[0, 3].unpack("C*") == [255, 216, 255]
-        return :jpg
-      elsif top[0, 8].unpack("C*") == [137, 80, 78, 71, 13, 10, 26, 10]
-        return :png
-      else
-        raise Errors::UnsupportedImageType, "image file is an unrecognised format"
-      end
+    def overruns_page?(h)
+      (self.y - h) < reference_bounds.absolute_bottom
     end
 
     def image_registry

data/lib/prawn/images/image.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+# image.rb : Base class for image info objects
+#
+# Copyright September 2011, Brad Ediger. All rights reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'digest/sha1'
+
+module Prawn
+  module Images
+    class Image
+
+      def calc_image_dimensions(options)
+        w = options[:width] || width
+        h = options[:height] || height
+
+        if options[:width] && !options[:height]
+          wp = w / width.to_f
+          w = width * wp
+          h = height * wp
+        elsif options[:height] && !options[:width]
+          hp = h / height.to_f
+          w = width * hp
+          h = height * hp
+        elsif options[:scale]
+          w = width * options[:scale]
+          h = height * options[:scale]
+        elsif options[:fit]
+          bw, bh = options[:fit]
+          bp = bw / bh.to_f
+          ip = width / height.to_f
+          if ip > bp
+            w = bw
+            h = bw / ip
+          else
+            h = bh
+            w = bh * ip
+          end
+        end
+        self.scaled_width = w
+        self.scaled_height = h
+
+        [w,h]
+      end
+    end
+  end
+end

data/lib/prawn/images/jpg.rb

@@ -13,20 +13,25 @@ module Prawn
     # 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 
+    class JPG < Image
       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)
 
+      def self.can_render?(image_blob)
+        image_blob[0, 3].unpack("C*") == [255, 216, 255]
+      end
+
       # Process a new JPG image
       #
       # <tt>:data</tt>:: A binary string of JPEG data
       #
       def initialize(data)
-        @data = data
-        data = StringIO.new(data.dup)
+        @data = data.dup
+        ruby_19 { data.force_encoding("binary") }
+        data = StringIO.new(data)
 
         c_marker = "\xff" # Section marker.
         data.read(2)   # Skip the first two bytes of JPEG identifier.
@@ -39,7 +44,7 @@ module Prawn
             break
           end
 
-          buffer = data.read(length - 2)
+          data.read(length - 2)
         end
       end
 
@@ -61,13 +66,11 @@ module Prawn
         obj = document.ref!(
           :Type             => :XObject,
           :Subtype          => :Image,
-          :Filter           => :DCTDecode,
           :ColorSpace       => color_space,
           :BitsPerComponent => bits,
           :Width            => width,
-          :Height           => height,
-          :Length           => @data.size
-        ) 
+          :Height           => height
+        )
 
         # add extra decode params for CMYK images. By swapping the
         # min and max values from the default, we invert the colours. See
@@ -76,7 +79,8 @@ module Prawn
           obj.data[:Decode] = [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ]
         end
 
-        obj << @data
+        obj.stream << @data
+        obj.stream.filters << :DCTDecode
         obj
       end
 

data/lib/prawn/images/png.rb

@@ -16,13 +16,17 @@ module Prawn
     # A convenience class that wraps the logic for extracting the parts
     # of a PNG image that we need to embed them in a PDF
     #
-    class PNG
+    class PNG < Image
       attr_reader :palette, :img_data, :transparency
       attr_reader :width, :height, :bits
       attr_reader :color_type, :compression_method, :filter_method
       attr_reader :interlace_method, :alpha_channel
       attr_accessor :scaled_width, :scaled_height
 
+      def self.can_render?(image_blob)
+        image_blob[0, 8].unpack("C*") == [137, 80, 78, 71, 13, 10, 26, 10]
+      end
+
       # Process a new PNG image
       #
       # <tt>data</tt>:: A binary string of PNG data
@@ -88,6 +92,8 @@ module Prawn
 
           data.read(4)  # Skip the CRC
         end
+
+        @img_data = Zlib::Inflate.inflate(@img_data)
       end
 
       # number of color components to each pixel
@@ -168,31 +174,35 @@ module Prawn
           :Subtype          => :Image,
           :Height           => height,
           :Width            => width,
-          :BitsPerComponent => bits,
-          :Length           => img_data.size,
-          :Filter           => :FlateDecode
+          :BitsPerComponent => bits
         )
 
-        unless alpha_channel
-          obj.data[:DecodeParms] = {:Predictor => 15,
-                                    :Colors    => colors,
-                                    :BitsPerComponent => bits,
-                                    :Columns   => width}
-        end
-
         # append the actual image data to the object as a stream
         obj << img_data
-        
+
+        if alpha_channel
+          obj.stream.compress!
+        else
+          obj.stream.filters << {
+            :FlateDecode => {
+              :Predictor => 15,
+              :Colors    => colors,
+              :BitsPerComponent => bits,
+              :Columns   => width
+            }
+          }
+        end
+
         # sort out the colours of the image
         if palette.empty?
           obj.data[:ColorSpace] = color
         else
           # embed the colour palette in the PDF as a object stream
-          palette_obj = document.ref!(:Length => palette.size)
+          palette_obj = document.ref!({})
           palette_obj << palette
 
           # build the color space array for the image
-          obj.data[:ColorSpace] = [:Indexed, 
+          obj.data[:ColorSpace] = [:Indexed,
                                    :DeviceRGB,
                                    (palette.size / 3) -1,
                                    palette_obj]
@@ -234,12 +244,11 @@ module Prawn
             :Height           => height,
             :Width            => width,
             :BitsPerComponent => alpha_channel_bits,
-            :Length           => alpha_channel.size,
-            :Filter           => :FlateDecode,
             :ColorSpace       => :DeviceGray,
             :Decode           => [0, 1]
           )
-          smask_obj << alpha_channel
+          smask_obj.stream << alpha_channel
+          smask_obj.stream.compress!
           obj.data[:SMask] = smask_obj
         end
 
@@ -262,7 +271,8 @@ module Prawn
       private
 
       def unfilter_image_data
-        data = Zlib::Inflate.inflate(@img_data).unpack 'C*'
+        data = @img_data.dup
+
         @img_data = ""
         @alpha_channel = ""
 
@@ -270,36 +280,42 @@ module Prawn
         scanline_length = pixel_bytes * self.width + 1
         row = 0
         pixels = []
+        row_data = [] # reused for each row of the image
         paeth, pa, pb, pc = nil
-        until data.empty? do
-          row_data = data.slice! 0, scanline_length
+
+        data.bytes.each do |byte|
+          # accumulate a whole scanline of bytes, and then process it all at once
+          # we could do this with Enumerable#each_slice, but it allocates memory,
+          #   and we are trying to avoid that
+          row_data << byte
+          next if row_data.length < scanline_length
+
           filter = row_data.shift
           case filter
           when 0 # None
           when 1 # Sub
-            row_data.each_with_index do |byte, index|
+            row_data.each_with_index do |row_byte, index|
               left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
-              row_data[index] = (byte + left) % 256
-              #p [byte, left, row_data[index]]
+              row_data[index] = (row_byte + left) % 256
             end
           when 2 # Up
-            row_data.each_with_index do |byte, index|
-              col = index / pixel_bytes
+            row_data.each_with_index do |row_byte, index|
+              col = (index / pixel_bytes).floor
               upper = row == 0 ? 0 : pixels[row-1][col][index % pixel_bytes]
-              row_data[index] = (upper + byte) % 256
+              row_data[index] = (upper + row_byte) % 256
             end
           when 3  # Average
-            row_data.each_with_index do |byte, index|
-              col = index / pixel_bytes
+            row_data.each_with_index do |row_byte, index|
+              col = (index / pixel_bytes).floor
               upper = row == 0 ? 0 : pixels[row-1][col][index % pixel_bytes]
               left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
 
-              row_data[index] = (byte + ((left + upper)/2).floor) % 256
+              row_data[index] = (row_byte + ((left + upper)/2).floor) % 256
             end
           when 4 # Paeth
             left = upper = upper_left = nil
-            row_data.each_with_index do |byte, index|
-              col = index / pixel_bytes
+            row_data.each_with_index do |row_byte, index|
+              col = (index / pixel_bytes).floor
 
               left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
               if row.zero?
@@ -323,7 +339,7 @@ module Prawn
                 upper_left
               end
 
-              row_data[index] = (byte + paeth) % 256
+              row_data[index] = (row_byte + paeth) % 256
             end
           else
             raise ArgumentError, "Invalid filter algorithm #{filter}"
@@ -335,9 +351,10 @@ module Prawn
           end
           pixels << s
           row += 1
+          row_data.clear
         end
 
-        # convert the pixel data to seperate strings for colours and alpha
+        # convert the pixel data to separate strings for colours and alpha
         color_byte_size = self.colors * self.bits / 8
         alpha_byte_size = alpha_channel_bits / 8
         pixels.each do |this_row|
@@ -346,10 +363,6 @@ module Prawn
             @alpha_channel << pixel[color_byte_size, alpha_byte_size].pack("C*")
           end
         end
-
-        # compress the data
-        @img_data = Zlib::Deflate.deflate(@img_data)
-        @alpha_channel = Zlib::Deflate.deflate(@alpha_channel)
       end
     end
   end