prawn 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b05cc94288d323f650bc4a44529992282d42b69f
-  data.tar.gz: 71cb2515eb6667207083899502a96487807f8667
+  metadata.gz: e103cb901b7728d21af3dfe412f3072063a86835
+  data.tar.gz: 132ff9e3bf2aeeeb1e9b574e5b84115192e576dc
 SHA512:
-  metadata.gz: 4081995850066454b2ec29d3532ea5470812d8af92606a7e2d65d9514105242d3e4061927559e8280c180732c8223d11f37debc7423382ffeada0820dbfc8c8c
-  data.tar.gz: f1ef9c7346cddd535db2acde3a3522bdc4a128dcd8da2eb45439278203ca982e22543de1667a0d7f6435824884f73eb8ed046f6dbf128fa9ad3d721792bc4add
+  metadata.gz: 0cad684b3b096da6cdceb69e47b78c5629251687d28c8a3ab4f824fc64b842daa11e2f62122033d9b27f1cd4afe809bfad1c3cc2c150e909cae09f5480a442ec
+  data.tar.gz: 5ea7ffa1b819a00d71897150c87afd0a7b7cc08e1afc8c4b41a425fd262f5276c961e969ea0e6e0178dde6f74ded16842076674abe39afbc5ca9bfaf513d5aab

data/lib/prawn.rb

@@ -23,7 +23,7 @@ module Prawn
 
   FLOAT_PRECISION = 1.0e-9
 
-  # Whe set to true, Prawn will verify hash options to ensure only valid keys
+  # When set to true, Prawn will verify hash options to ensure only valid keys
   # are used.  Off by default.
   #
   # Example:
@@ -76,6 +76,7 @@ require_relative "prawn/images/png"
 require_relative "prawn/stamp"
 require_relative "prawn/soft_mask"
 require_relative "prawn/security"
+require_relative "prawn/transformation_stack"
 require_relative "prawn/document"
 require_relative "prawn/font"
 require_relative "prawn/measurements"

data/lib/prawn/document.rb

@@ -57,6 +57,7 @@ module Prawn
     include Prawn::Images
     include Prawn::Stamp
     include Prawn::SoftMask
+    include Prawn::TransformationStack
 
     # @group Extension API
 

data/lib/prawn/document/internals.rb

@@ -24,10 +24,18 @@ module Prawn
       # Perhaps they will become part of the extension API?
       # Anyway, for now it's not clear what we should do w. them.
       delegate [ :graphic_state,
-                 :save_graphics_state,
-                 :restore_graphics_state,
                  :on_page_create ] => :renderer
 
+      def save_graphics_state(state = nil, &block)
+        save_transformation_stack
+        renderer.save_graphics_state(state, &block)
+      end
+
+      def restore_graphics_state
+        restore_transformation_stack
+        renderer.restore_graphics_state
+      end
+
       # FIXME: This is a circular reference, because in theory Prawn should
       # be passing instances of renderer to PDF::Core::Page, but it's
       # passing Prawn::Document objects instead.

data/lib/prawn/font.rb

@@ -396,7 +396,20 @@ module Prawn
     # generate a font identifier that hasn't been used on the current page yet
     #
     def generate_unique_id
-      :"F#{@document.font_registry.size + 1}"
+      key = nil
+      font_count = @document.font_registry.size + 1
+      loop do
+        key = :"F#{font_count}"
+        break if key_is_unique?(key)
+        font_count += 1
+      end
+      key
+    end
+
+    def key_is_unique?(test_key)
+      !@document.state.page.fonts.keys.any? do |key|
+        key.to_s.start_with?("#{test_key}.")
+      end
     end
 
     def size

data/lib/prawn/graphics.rb

@@ -6,6 +6,7 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
+require_relative "graphics/blend_mode"
 require_relative "graphics/color"
 require_relative "graphics/dash"
 require_relative "graphics/cap_style"
@@ -22,6 +23,7 @@ module Prawn
   # ruby-pdf.rubyforge.org
   #
   module Graphics
+    include BlendMode
     include Color
     include Dash
     include CapStyle

data/lib/prawn/graphics/blend_mode.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+#
+# blend_mode.rb : Implements blend modes
+#
+# Contributed by John Ford. October, 2015
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+
+module Prawn
+  module Graphics
+    # The Prawn::BlendMode module is used to change the way
+    # two layers are blended together.
+    #
+    # Passing an array of blend modes is allowed. PDF viewers should
+    # blend layers based on the first recognized blend mode.
+    #
+    # Valid blend modes in v1.4 of the PDF spec include :Normal, :Multiply, :Screen,
+    # :Overlay, :Darken, :Lighten, :ColorDodge, :ColorBurn, :HardLight, :SoftLight,
+    # :Difference, :Exclusion, :Hue, :Saturation, :Color, and :Luminosity.
+    #
+    # Example:
+    #   pdf.fill_color('0000ff')
+    #   pdf.fill_rectangle([x, y+25], 50, 50)
+    #   pdf.blend_mode(:Multiply) do
+    #     pdf.fill_color('ff0000')
+    #     pdf.fill_circle([x, y], 25)
+    #   end
+    #
+    module BlendMode
+      # @group Stable API
+
+      def blend_mode(blend_mode = :Normal)
+        renderer.min_version(1.4)
+
+        save_graphics_state if block_given?
+        renderer.add_content "/#{blend_mode_dictionary_name(blend_mode)} gs"
+        if block_given?
+          yield
+          restore_graphics_state
+        end
+      end
+
+      private
+
+      def blend_mode_dictionary_registry
+        @blend_mode_dictionary_registry ||= {}
+      end
+
+      def blend_mode_dictionary_name(blend_mode)
+        key = Array(blend_mode).join('')
+        dictionary_name = "BM#{key}"
+
+        dictionary = blend_mode_dictionary_registry[dictionary_name] ||= ref!(
+          :Type => :ExtGState,
+          :BM   => blend_mode
+        )
+
+        page.ext_gstates.merge!(dictionary_name => dictionary)
+        dictionary_name
+      end
+    end
+  end
+end

data/lib/prawn/graphics/patterns.rb

@@ -14,16 +14,30 @@ module Prawn
 
       # Sets the fill gradient from color1 to color2.
       # old arguments: point, width, height, color1, color2, options = {}
-      # new arguments: from, to, color1, color1
-      #            or  from, r1, to, r2, color1, color2
+      # new arguments: from, to, color1, color1, options = {}
+      #            or  from, r1, to, r2, color1, color2, options = {}
+      #
+      # Option :apply_transformations, if set true, will transform the
+      # gradient's co-ordinate space so it matches the current co-ordinate
+      # space of the document.  This option will be the default from Prawn v3.
+      # The current default, false, will mean if you (for example) scale your
+      # document by 2 and put a gradient inside, you will have to manually
+      # multiply your co-ordinates by 2 so the gradient is correctly positioned.
       def fill_gradient(*args)
         set_gradient(:fill, *args)
       end
 
       # Sets the stroke gradient from color1 to color2.
       # old arguments: point, width, height, color1, color2, options = {}
-      # new arguments: from, to, color1, color2
-      #            or  from, r1, to, r2, color1, color2
+      # new arguments: from, to, color1, color2, options = {}
+      #            or  from, r1, to, r2, color1, color2, options = {}
+      #
+      # Option :apply_transformations, if set true, will transform the
+      # gradient's co-ordinate space so it matches the current co-ordinate
+      # space of the document.  This option will be the default from Prawn v3.
+      # The current default, false, will mean if you (for example) scale your
+      # document by 2 and put a gradient inside, you will have to manually
+      # multiply your co-ordinates by 2 so the gradient is correctly positioned.
       def stroke_gradient(*args)
         set_gradient(:stroke, *args)
       end
@@ -31,15 +45,17 @@ module Prawn
       private
 
       def set_gradient(type, *grad)
+        opts = grad.last.is_a?(Hash) ? grad.pop : {}
+
         patterns = page.resources[:Pattern] ||= {}
 
-        registry_key = gradient_registry_key grad
+        registry_key = gradient_registry_key grad, opts
 
         if patterns["SP#{registry_key}"]
           shading = patterns["SP#{registry_key}"]
         else
           unless shading = gradient_registry[registry_key]
-            shading = gradient(*grad)
+            shading = gradient(grad, opts)
             gradient_registry[registry_key] = shading
           end
 
@@ -59,18 +75,20 @@ module Prawn
         renderer.add_content "/SP#{registry_key} #{operator}"
       end
 
-      def gradient_registry_key(gradient)
+      def gradient_registry_key(gradient, opts)
+        _x1, _y1, x2, y2, transformation = gradient_coordinates(gradient, opts)
+
         if gradient[1].is_a?(Array) # axial
           [
-            map_to_absolute(gradient[0]),
-            map_to_absolute(gradient[1]),
+            transformation,
+            x2, y2,
             gradient[2], gradient[3]
           ]
         else # radial
           [
-            map_to_absolute(gradient[0]),
+            transformation,
+            x2, y2,
             gradient[1],
-            map_to_absolute(gradient[2]),
             gradient[3],
             gradient[4], gradient[5]
           ]
@@ -81,11 +99,15 @@ module Prawn
         @gradient_registry ||= {}
       end
 
-      def gradient(*args)
+      def gradient(args, opts)
         if args.length != 4 && args.length != 6
           fail ArgumentError, "Unknown type of gradient: #{args.inspect}"
         end
 
+        if opts[:apply_transformations].nil? && current_transformation_matrix_with_translation(0, 0) != [1, 0, 0, 1, 0, 0]
+          warn "Gradients in Prawn 2.x and lower are not correctly positioned when a transformation has been made to the document.  Pass 'apply_transformations: true' to correctly transform the gradient, or see https://github.com/prawnpdf/prawn/wiki/Gradient-Transformations for more information."
+        end
+
         color1 = normalize_color(args[-2]).dup.freeze
         color2 = normalize_color(args[-1]).dup.freeze
 
@@ -104,10 +126,12 @@ module Prawn
           :N => 1.0
         )
 
+        x1, y1, x2, y2, transformation = gradient_coordinates(args, opts)
+
         if args.length == 4
-          coords = [0, 0, args[1].first - args[0].first, args[1].last - args[0].last]
+          coords = [0, 0, x2 - x1, y2 - y1]
         else
-          coords = [0, 0, args[1], args[2].first - args[0].first, args[2].last - args[0].last, args[3]]
+          coords = [0, 0, args[1], x2 - x1, y2 - y1, args[3]]
         end
 
         shading = ref!(
@@ -121,10 +145,22 @@ module Prawn
         ref!(
           :PatternType => 2, # shading pattern
           :Shading => shading,
-          :Matrix => [1, 0,
-                      0, 1] + map_to_absolute(args[0])
+          :Matrix => transformation
         )
       end
+
+      def gradient_coordinates(args, opts)
+        x1, y1 = map_to_absolute(args[0])
+        x2, y2 = map_to_absolute(args[args.length == 4 ? 1 : 2])
+
+        transformation = if opts[:apply_transformations]
+                           current_transformation_matrix_with_translation(x1, y1)
+                         else
+                           [1, 0, 0, 1, x1, y1]
+                         end
+
+        [x1, y1, x2, y2, transformation]
+      end
     end
   end
 end

data/lib/prawn/graphics/transformation.rb

@@ -145,6 +145,9 @@ module Prawn
       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_to_transformation_stack(a, b, c, d, e, f)
+
         renderer.add_content "#{values} cm"
         if block_given?
           yield

data/lib/prawn/images/png.rb

@@ -68,9 +68,7 @@ module Prawn
             @transparency = {}
             case @color_type
             when 3
-              fail Errors::UnsupportedImageType,
-                   "Pallete-based transparency in PNG is not currently supported.\n" \
-                   "See https://github.com/prawnpdf/prawn/issues/783"
+              @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
@@ -109,11 +107,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
@@ -285,6 +292,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).unpack('C').first
+            alpha.putc alpha_palette[color]
+          end
+        end
+      end
     end
   end
 end

data/lib/prawn/text/formatted/arranger.rb

@@ -16,6 +16,7 @@ module Prawn
         attr_reader :max_line_height
         attr_reader :max_descender
         attr_reader :max_ascender
+        attr_reader :finalized
         attr_accessor :consumed
 
         # The following present only for testing purposes
@@ -31,34 +32,38 @@ module Prawn
         end
 
         def space_count
-          if @unfinalized_line
+          unless finalized
             fail "Lines must be finalized before calling #space_count"
           end
+
           @fragments.inject(0) do |sum, fragment|
             sum + fragment.space_count
           end
         end
 
         def line_width
-          if @unfinalized_line
+          unless finalized
             fail "Lines must be finalized before calling #line_width"
           end
+
           @fragments.inject(0) do |sum, fragment|
             sum + fragment.width
           end
         end
 
         def line
-          if @unfinalized_line
+          unless finalized
             fail "Lines must be finalized before calling #line"
           end
+
           @fragments.collect do |fragment|
             fragment.text.dup.force_encoding(::Encoding::UTF_8)
           end.join
         end
 
         def finalize_line
-          @unfinalized_line = false
+          @finalized = true
+
           omit_trailing_whitespace_from_line_width
           @fragments = []
           @consumed.each do |hash|
@@ -85,7 +90,7 @@ module Prawn
         end
 
         def initialize_line
-          @unfinalized_line = true
+          @finalized = false
           @max_line_height = 0
           @max_descender = 0
           @max_ascender = 0
@@ -99,24 +104,26 @@ module Prawn
         end
 
         def next_string
-          unless @unfinalized_line
+          if finalized
             fail "Lines must not be finalized when calling #next_string"
           end
-          hash = @unconsumed.shift
-          if hash.nil?
-            nil
-          else
-            @consumed << hash.dup
-            @current_format_state = hash.dup
+
+          next_unconsumed_hash = @unconsumed.shift
+
+          if next_unconsumed_hash
+            @consumed << next_unconsumed_hash.dup
+            @current_format_state = next_unconsumed_hash.dup
             @current_format_state.delete(:text)
-            hash[:text]
+
+            next_unconsumed_hash[:text]
           end
         end
 
         def preview_next_string
-          hash = @unconsumed.first
-          if hash.nil? then nil
-          else hash[:text]
+          next_unconsumed_hash = @unconsumed.first
+
+          if next_unconsumed_hash
+            next_unconsumed_hash[:text]
           end
         end
 
@@ -181,9 +188,10 @@ module Prawn
         end
 
         def retrieve_fragment
-          if @unfinalized_line
+          unless finalized
             fail "Lines must be finalized before fragments can be retrieved"
           end
+
           @fragments.shift
         end