prawn 0.13.0 → 2.4.0

data/lib/prawn/images/png.rb

@@ -1,5 +1,7 @@
 # encoding: ASCII-8BIT
 
+# frozen_string_literal: true
+
 # png.rb : Extracts the data from a PNG that is needed for embedding
 #
 # Based on some similar code in PDF::Writer by Austin Ziegler
@@ -9,14 +11,14 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 require 'stringio'
-require 'enumerator'
-
 module Prawn
   module Images
     # 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 < Image
+      # @group Extension API
+
       attr_reader :palette, :img_data, :transparency
       attr_reader :width, :height, :bits
       attr_reader :color_type, :compression_method, :filter_method
@@ -24,7 +26,7 @@ module Prawn
       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]
+        image_blob[0, 8].unpack('C*') == [137, 80, 78, 71, 13, 10, 26, 10]
       end
 
       # Process a new PNG image
@@ -32,30 +34,31 @@ module Prawn
       # <tt>data</tt>:: A binary string of PNG data
       #
       def initialize(data)
+        super()
         data = StringIO.new(data.dup)
 
-        data.read(8)  # Skip the default header
+        data.read(8) # Skip the default header
 
-        @palette  = ""
-        @img_data = ""
+        @palette = +''
+        @img_data = +''
         @transparency = {}
 
         loop do
-          chunk_size  = data.read(4).unpack("N")[0]
-          section     = data.read(4)
+          chunk_size = data.read(4).unpack1('N')
+          section = data.read(4)
           case section
           when 'IHDR'
             # we can grab other interesting values from here (like width,
             # height, etc)
-            values = data.read(chunk_size).unpack("NNCCCCC")
+            values = data.read(chunk_size).unpack('NNCCCCC')
 
-            @width              = values[0]
-            @height             = values[1]
-            @bits               = values[2]
-            @color_type         = values[3]
+            @width = values[0]
+            @height = values[1]
+            @bits = values[2]
+            @color_type = values[3]
             @compression_method = values[4]
-            @filter_method      = values[5]
-            @interlace_method   = values[6]
+            @filter_method = values[5]
+            @interlace_method = values[6]
           when 'PLTE'
             @palette << data.read(chunk_size)
           when 'IDAT'
@@ -66,21 +69,15 @@ module Prawn
             @transparency = {}
             case @color_type
             when 3
-              # Indexed colour, RGB. Each byte in this chunk is an alpha for
-              # the palette index in the PLTE ("palette") chunk up until the
-              # last non-opaque entry. Set up an array, stretching over all
-              # palette entries which will be 0 (opaque) or 1 (transparent).
-              @transparency[:indexed]  = data.read(chunk_size).unpack("C*")
-              short = 255 - @transparency[:indexed].size
-              @transparency[:indexed] += ([255] * short) if short > 0
+              @transparency[:palette] = data.read(chunk_size).unpack('C*')
             when 0
               # Greyscale. Corresponding to entries in the PLTE chunk.
               # Grey is two bytes, range 0 .. (2 ^ bit-depth) - 1
-              grayval = data.read(chunk_size).unpack("n").first
+              grayval = data.read(chunk_size).unpack1('n')
               @transparency[:grayscale] = grayval
             when 2
               # True colour with proper alpha channel.
-              @transparency[:rgb] = data.read(chunk_size).unpack("nnn")
+              @transparency[:rgb] = data.read(chunk_size).unpack('nnn')
             end
           when 'IEND'
             # we've got everything we need, exit the loop
@@ -90,7 +87,7 @@ module Prawn
             data.seek(data.pos + chunk_size)
           end
 
-          data.read(4)  # Skip the CRC
+          data.read(4) # Skip the CRC
         end
 
         @img_data = Zlib::Inflate.inflate(@img_data)
@@ -99,21 +96,11 @@ module Prawn
       # number of color components to each pixel
       #
       def colors
-        case self.color_type
+        case color_type
         when 0, 3, 4
-          return 1
+          1
         when 2, 6
-          return 3
-        end
-      end
-
-      # number of bits used per pixel
-      #
-      def pixel_bitlength
-        if alpha_channel?
-          self.bits * (self.colors + 1)
-        else
-          self.bits * self.colors
+          3
         end
       end
 
@@ -121,18 +108,20 @@ module Prawn
       # where it's required.
       #
       def split_alpha_channel!
-        unfilter_image_data if alpha_channel?
+        if alpha_channel?
+          if color_type == 3
+            generate_alpha_channel
+          else
+            split_image_data
+          end
+        end
       end
 
       def alpha_channel?
-        @color_type == 4 || @color_type == 6
-      end
+        return true if color_type == 4 || color_type == 6
+        return @transparency.any? if color_type == 3
 
-      # Adobe Reader can't handle 16-bit png channels -- chop off the second
-      # byte (least significant)
-      #
-      def alpha_channel_bits
-        8
+        false
       end
 
       # Build a PDF object representing this image in +document+, and return
@@ -170,28 +159,24 @@ module Prawn
 
         # build the image dict
         obj = document.ref!(
-          :Type             => :XObject,
-          :Subtype          => :Image,
-          :Height           => height,
-          :Width            => width,
-          :BitsPerComponent => bits
+          Type: :XObject,
+          Subtype: :Image,
+          Height: height,
+          Width: width,
+          BitsPerComponent: bits
         )
 
         # 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
-            }
+        obj.stream.filters << {
+          FlateDecode: {
+            Predictor: 15,
+            Colors: colors,
+            BitsPerComponent: bits,
+            Columns: width
           }
-        end
+        }
 
         # sort out the colours of the image
         if palette.empty?
@@ -202,10 +187,12 @@ module Prawn
           palette_obj << palette
 
           # build the color space array for the image
-          obj.data[:ColorSpace] = [:Indexed,
-                                   :DeviceRGB,
-                                   (palette.size / 3) -1,
-                                   palette_obj]
+          obj.data[:ColorSpace] = [
+            :Indexed,
+            :DeviceRGB,
+            (palette.size / 3) - 1,
+            palette_obj
+          ]
         end
 
         # *************************************
@@ -226,29 +213,33 @@ module Prawn
           # - An array with N elements, where N is two times the number of color
           #   components.
           rgb = transparency[:rgb]
-          obj.data[:Mask] = rgb.collect { |x| [x,x] }.flatten
-        elsif 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] = transparency[:indexed]
+          obj.data[:Mask] = rgb.map { |x| [x, x] }.flatten
         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
+        # 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 alpha_channel?
           smask_obj = document.ref!(
-            :Type             => :XObject,
-            :Subtype          => :Image,
-            :Height           => height,
-            :Width            => width,
-            :BitsPerComponent => alpha_channel_bits,
-            :ColorSpace       => :DeviceGray,
-            :Decode           => [0, 1]
+            Type: :XObject,
+            Subtype: :Image,
+            Height: height,
+            Width: width,
+            BitsPerComponent: bits,
+            ColorSpace: :DeviceGray,
+            Decode: [0, 1]
           )
           smask_obj.stream << alpha_channel
-          smask_obj.stream.compress!
+
+          smask_obj.stream.filters << {
+            FlateDecode: {
+              Predictor: 15,
+              Colors: 1,
+              BitsPerComponent: bits,
+              Columns: width
+            }
+          }
           obj.data[:SMask] = smask_obj
         end
 
@@ -270,97 +261,69 @@ module Prawn
 
       private
 
-      def unfilter_image_data
-        data = @img_data.dup
-
-        @img_data = ""
-        @alpha_channel = ""
-
-        pixel_bytes     = pixel_bitlength / 8
-        scanline_length = pixel_bytes * self.width + 1
-        row = 0
-        pixels = []
-        row_data = [] # reused for each row of the image
-        paeth, pa, pb, pc = nil
-
-        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 |row_byte, index|
-              left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
-              row_data[index] = (row_byte + left) % 256
-            end
-          when 2 # Up
-            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 + row_byte) % 256
-            end
-          when 3  # Average
-            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]
+      def split_image_data
+        alpha_bytes = bits / 8
+        color_bytes = colors * bits / 8
 
-              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 |row_byte, index|
-              col = (index / pixel_bytes).floor
-
-              left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
-              if row.zero?
-                upper = upper_left = 0
-              else
-                upper = pixels[row-1][col][index % pixel_bytes]
-                upper_left = col.zero? ? 0 :
-                  pixels[row-1][col-1][index % pixel_bytes]
-              end
-
-              p = left + upper - upper_left
-              pa = (p - left).abs
-              pb = (p - upper).abs
-              pc = (p - upper_left).abs
-
-              paeth = if pa <= pb && pa <= pc
-                left
-              elsif pb <= pc
-                upper
-              else
-                upper_left
-              end
-
-              row_data[index] = (row_byte + paeth) % 256
-            end
-          else
-            raise ArgumentError, "Invalid filter algorithm #{filter}"
-          end
+        scanline_length = (color_bytes + alpha_bytes) * width + 1
+        scanlines = @img_data.bytesize / scanline_length
+        pixels = width * height
+
+        data = StringIO.new(@img_data)
+        data.binmode
+
+        color_data = [0x00].pack('C') * (pixels * color_bytes + scanlines)
+        color = StringIO.new(color_data)
+        color.binmode
+
+        @alpha_channel = [0x00].pack('C') * (pixels * alpha_bytes + scanlines)
+        alpha = StringIO.new(@alpha_channel)
+        alpha.binmode
+
+        scanlines.times do |line|
+          data.seek(line * scanline_length)
+
+          filter = data.getbyte
+
+          color.putc filter
+          alpha.putc filter
 
-          s = []
-          row_data.each_slice pixel_bytes do |slice|
-            s << slice
+          width.times do
+            color.write data.read(color_bytes)
+            alpha.write data.read(alpha_bytes)
           end
-          pixels << s
-          row += 1
-          row_data.clear
         end
 
-        # 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|
-          this_row.each do |pixel|
-            @img_data << pixel[0, color_byte_size].pack("C*")
-            @alpha_channel << pixel[color_byte_size, alpha_byte_size].pack("C*")
+        @img_data = color_data
+      end
+
+      def generate_alpha_channel
+        alpha_palette = Hash.new(0xff)
+        0.upto(palette.bytesize / 3) do |n|
+          alpha_palette[n] = @transparency[:palette][n] || 0xff
+        end
+
+        scanline_length = width + 1
+        scanlines = @img_data.bytesize / scanline_length
+        pixels = width * height
+
+        data = StringIO.new(@img_data)
+        data.binmode
+
+        @alpha_channel = [0x00].pack('C') * (pixels + scanlines)
+        alpha = StringIO.new(@alpha_channel)
+        alpha.binmode
+
+        scanlines.times do |line|
+          data.seek(line * scanline_length)
+
+          filter = data.getbyte
+
+          alpha.putc filter
+
+          width.times do
+            color = data.read(1).unpack1('C')
+            alpha.putc alpha_palette[color]
           end
         end
       end

data/lib/prawn/images.rb

@@ -1,4 +1,7 @@
 # encoding: ASCII-8BIT
+
+# frozen_string_literal: true
+
 # images.rb : Implements PDF image embedding
 #
 # Copyright April 2008, James Healy, Gregory Brown.  All Rights Reserved.
@@ -9,28 +12,27 @@ require 'digest/sha1'
 require 'pathname'
 
 module Prawn
-
   module Images
+    # @group Stable API
+
     # 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, 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
+    # JPG and PNG files are supported. (Note that processing PNG
+    # images with alpha channels can be processor and memory intensive.)
     #
     # Arguments:
-    # <tt>file</tt>:: path to file or an object that responds to #read
+    # <tt>file</tt>:: path to file or an object that responds to #read and
+    #   #rewind
     #
     # Options:
-    # <tt>:at</tt>:: an array [x,y] with the location of the top left corner of the image.
+    # <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, :bottom) 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]
+    # <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::DATADIR}/images/pigs.jpg"
@@ -56,16 +58,18 @@ module Prawn
     #   require "open-uri"
     #
     #   Prawn::Document.generate("remote_images.pdf") do
-    #     image open("http://prawn.majesticseacreature.com/media/prawn_logo.png")
+    #     image open("http://prawnpdf.org/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
+    def image(file, options = {})
+      Prawn.verify_options(
+        %i[at position vposition height width scale fit],
+        options
+      )
 
       pdf_obj, info = build_image_object(file)
       embed_image(pdf_obj, info, options)
@@ -76,9 +80,9 @@ module Prawn
     # Builds an info object (Prawn::Images::*) and a PDF reference representing
     # the given image. Return a pair: [pdf_obj, info].
     #
+    # @private
     def build_image_object(file)
-      io = verify_and_open_image(file)
-      image_content = io.read
+      image_content = verify_and_read_image(file)
       image_sha1 = Digest::SHA1.hexdigest(image_content)
 
       # if this image has already been embedded, just reuse it
@@ -90,11 +94,13 @@ module Prawn
         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)
+        if info.respond_to?(:min_pdf_version)
+          renderer.min_version(info.min_pdf_version)
+        end
 
         # Add the image to the PDF and register it in case we see it again.
         image_obj = info.build_pdf_object(self)
-        image_registry[image_sha1] = {:obj => image_obj, :info => info}
+        image_registry[image_sha1] = { obj: image_obj, info: info }
       end
 
       [image_obj, info]
@@ -105,30 +111,30 @@ module Prawn
     # build_image_object), embed the image according to the <tt>options</tt>
     # given.
     #
+    # @private
     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)
+      w, h = info.calc_image_dimensions(options)
 
       if options[:at]
-        x,y = map_to_absolute(options[:at])
+        x, y = map_to_absolute(options[:at])
       else
-        x,y = image_position(w,h,options)
+        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 => pdf_obj)
+      state.page.xobjects[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 ]
+      cm_params = PDF::Core.real_params([w, 0, 0, h, x, y - h])
+      renderer.add_content("\nq\n#{cm_params} cm\n/#{label} Do\nQ")
     end
 
     private
 
-    def verify_and_open_image(io_or_path)
+    def verify_and_read_image(io_or_path)
       # File or IO
       if io_or_path.respond_to?(:rewind)
         io = io_or_path
@@ -138,54 +144,56 @@ module Prawn
         # 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
+        return io.read
       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
+
+      io_or_path.binread
     end
 
-    def image_position(w,h,options)
+    def image_position(width, height, options)
       options[:position] ||= :left
 
-      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
-
-      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
-
-      return [x,y]
+      y =
+        case options[:vposition]
+        when :top
+          bounds.absolute_top
+        when :center
+          bounds.absolute_top - (bounds.height - height) / 2.0
+        when :bottom
+          bounds.absolute_bottom + height
+        when Numeric
+          bounds.absolute_top - options[:vposition]
+        else
+          determine_y_with_page_flow(height)
+        end
+
+      x =
+        case options[:position]
+        when :left
+          bounds.left_side
+        when :center
+          bounds.left_side + (bounds.width - width) / 2.0
+        when :right
+          bounds.right_side - width
+        when Numeric
+          options[:position] + bounds.left_side
+        end
+
+      [x, y]
     end
 
-    def determine_y_with_page_flow(h)
-      if overruns_page?(h)
+    def determine_y_with_page_flow(height)
+      if overruns_page?(height)
         bounds.move_past_bottom
       end
-      self.y
+      y
     end
 
-    def overruns_page?(h)
-      (self.y - h) < reference_bounds.absolute_bottom
+    def overruns_page?(height)
+      (y - height) < reference_bounds.absolute_bottom
     end
 
     def image_registry