prawn 1.1.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,8 +11,6 @@
 # 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
@@ -26,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
@@ -34,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'
@@ -68,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
@@ -92,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)
@@ -101,11 +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
+          3
         end
       end
 
@@ -113,11 +108,20 @@ module Prawn
       # where it's required.
       #
       def split_alpha_channel!
-        split_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
+        return true if color_type == 4 || color_type == 6
+        return @transparency.any? if color_type == 3
+
+        false
       end
 
       # Build a PDF object representing this image in +document+, and return
@@ -155,22 +159,22 @@ 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
 
         obj.stream.filters << {
-          :FlateDecode => {
-            :Predictor => 15,
-            :Colors    => colors,
-            :BitsPerComponent => bits,
-            :Columns   => width
+          FlateDecode: {
+            Predictor: 15,
+            Colors: colors,
+            BitsPerComponent: bits,
+            Columns: width
           }
         }
 
@@ -183,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
 
         # *************************************
@@ -207,35 +213,31 @@ 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 => 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.filters << {
-            :FlateDecode => {
-              :Predictor => 15,
-              :Colors    => 1,
-              :BitsPerComponent => bits,
-              :Columns   => width
+            FlateDecode: {
+              Predictor: 15,
+              Colors: 1,
+              BitsPerComponent: bits,
+              Columns: width
             }
           }
           obj.data[:SMask] = smask_obj
@@ -263,9 +265,9 @@ module Prawn
         alpha_bytes = bits / 8
         color_bytes = colors * bits / 8
 
-        scanline_length  = (color_bytes + alpha_bytes) * self.width + 1
+        scanline_length = (color_bytes + alpha_bytes) * width + 1
         scanlines = @img_data.bytesize / scanline_length
-        pixels = self.width * self.height
+        pixels = width * height
 
         data = StringIO.new(@img_data)
         data.binmode
@@ -286,7 +288,7 @@ module Prawn
           color.putc filter
           alpha.putc filter
 
-          self.width.times do
+          width.times do
             color.write data.read(color_bytes)
             alpha.write data.read(alpha_bytes)
           end
@@ -294,6 +296,37 @@ module Prawn
 
         @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
     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,7 +12,6 @@ require 'digest/sha1'
 require 'pathname'
 
 module Prawn
-
   module Images
     # @group Stable API
 
@@ -18,16 +20,19 @@ module Prawn
     # images with alpha channels can be processor and memory intensive.)
     #
     # Arguments:
-    # <tt>file</tt>:: path to file or an object that responds to #read and #rewind
+    # <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"
@@ -53,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)
@@ -70,14 +77,12 @@ module Prawn
       info
     end
 
-
     # 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
@@ -89,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]
@@ -107,28 +114,27 @@ module Prawn
     # @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

data/lib/prawn/measurement_extensions.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 # measurement_extensions.rb: Core extensions for Prawn::Measurements
 #
 # Copyright December 2008, Florian Witteler.  All Rights Reserved.
@@ -17,34 +18,34 @@ class Numeric
   # @group Experimental API
 
   def mm
-    return mm2pt(self)
+    mm2pt(self)
   end
 
   def cm
-    return cm2pt(self)
+    cm2pt(self)
   end
 
   def dm
-    return dm2pt(self)
+    dm2pt(self)
   end
 
   def m
-    return m2pt(self)
+    m2pt(self)
   end
 
   def in
-    return in2pt(self)
+    in2pt(self)
   end
 
   def yd
-    return yd2pt(self)
+    yd2pt(self)
   end
 
   def ft
-    return ft2pt(self)
+    ft2pt(self)
   end
 
   def pt
-    return pt2pt(self)
+    pt2pt(self)
   end
 end

data/lib/prawn/measurements.rb

@@ -1,77 +1,74 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 # measurements.rb: Conversions from other measurements to PDF points
 #
 # Copyright December 2008, Florian Witteler.  All Rights Reserved.
 #
+
+# rubocop: disable Naming/MethodParameterName
 module Prawn
   # @group Stable API
 
   module Measurements
-
-    # ============================================================================
-    #metric conversions
+    # metric conversions
     def cm2mm(cm)
-      return cm*10
+      cm * 10
     end
 
     def dm2mm(dm)
-      return dm*100
+      dm * 100
     end
 
     def m2mm(m)
-      return m*1000
+      m * 1000
     end
 
-    # ============================================================================
     # imperial conversions
     # from http://en.wikipedia.org/wiki/Imperial_units
-
     def ft2in(ft)
-      return ft * 12
+      ft * 12
     end
 
     def yd2in(yd)
-      return yd*36
+      yd * 36
     end
 
-
-    # ============================================================================
     # PostscriptPoint-converisons
-
     def pt2pt(pt)
-      return pt
+      pt
     end
 
     def in2pt(inch)
-      return inch * 72
+      inch * 72
     end
 
     def ft2pt(ft)
-      return in2pt(ft2in(ft))
+      in2pt(ft2in(ft))
     end
 
     def yd2pt(yd)
-      return in2pt(yd2in(yd))
+      in2pt(yd2in(yd))
     end
 
     def mm2pt(mm)
-        return mm*(72 / 25.4)
+      mm * (72 / 25.4)
     end
 
     def cm2pt(cm)
-      return mm2pt(cm2mm(cm))
+      mm2pt(cm2mm(cm))
     end
 
     def dm2pt(dm)
-      return mm2pt(dm2mm(dm))
+      mm2pt(dm2mm(dm))
     end
 
     def m2pt(m)
-      return mm2pt(m2mm(m))
+      mm2pt(m2mm(m))
     end
 
     def pt2mm(pt)
-      return pt * 1 / mm2pt(1)# (25.4 / 72)
+      pt * 1 / mm2pt(1) # (25.4 / 72)
     end
   end
 end
+# rubocop: enable Naming/MethodParameterName