prawn 0.13.0 → 0.14.0

data/lib/prawn/font.rb

@@ -6,10 +6,10 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
-require "prawn/font/afm"
-require "prawn/font/ttf"
-require "prawn/font/dfont"
-require "prawn/font_metric_cache"
+require_relative "font/afm"
+require_relative "font/ttf"
+require_relative "font/dfont"
+require_relative "font_metric_cache"
 
 module Prawn
 
@@ -174,10 +174,9 @@ module Prawn
     # wish to support.
     #
     # By default the styles :bold, :italic, :bold_italic, and :normal are
-    # defined for fonts "Courier", "Times-Roman" and "Helvetica".
-    #
-    # You probably want to provide those four styles, but are free to define
-    # custom ones, like :thin, and use them in font calls.
+    # defined for fonts "Courier", "Times-Roman" and "Helvetica". When
+    # defining your own font families, you can map any or all of these
+    # styles to whatever font files you'd like.
     #
     def font_families
       @font_families ||= {}.merge!(

data/lib/prawn/graphics.rb

@@ -6,13 +6,14 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require "prawn/graphics/color"
-require "prawn/graphics/dash"
-require "prawn/graphics/cap_style"
-require "prawn/graphics/join_style"
-require "prawn/graphics/transparency"
-require "prawn/graphics/transformation"
-require "prawn/graphics/patterns"
+
+require_relative "graphics/color"
+require_relative "graphics/dash"
+require_relative "graphics/cap_style"
+require_relative "graphics/join_style"
+require_relative "graphics/transparency"
+require_relative "graphics/transformation"
+require_relative "graphics/patterns"
 
 module Prawn
 

data/lib/prawn/image_handler.rb

@@ -18,6 +18,10 @@ module Prawn
       @handlers.unshift handler
     end
 
+    def unregister(handler)
+      @handlers.reject!{ |h| h == handler }
+    end
+
     def find(image_blob)
       handler = @handlers.find{ |h| h.can_render? image_blob }
 

data/lib/prawn/images/jpg.rb

@@ -17,8 +17,7 @@ module Prawn
       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)
+      JPEG_SOF_BLOCKS = [0xC0, 0xC1, 0xC2, 0xC3, 0xC5, 0xC6, 0xC7, 0xC9, 0xCA, 0xCB, 0xCD, 0xCE, 0xCF]
 
       def self.can_render?(image_blob)
         image_blob[0, 3].unpack("C*") == [255, 216, 255]
@@ -29,22 +28,22 @@ module Prawn
       # <tt>:data</tt>:: A binary string of JPEG data
       #
       def initialize(data)
-        @data = data.dup
-        ruby_19 { data.force_encoding("binary") }
-        data = StringIO.new(data)
+        @data = data
+        d = StringIO.new(@data)
+        d.binmode
 
-        c_marker = "\xff" # Section marker.
-        data.read(2)   # Skip the first two bytes of JPEG identifier.
+        c_marker = 0xff # Section marker.
+        d.seek(2)    # Skip the first two bytes of JPEG identifier.
         loop do
-          marker, code, length = data.read(4).unpack('aan')
+          marker, code, length = d.read(4).unpack('CCn')
           raise "JPEG marker not found!" if marker != c_marker
 
           if JPEG_SOF_BLOCKS.include?(code)
-            @bits, @height, @width, @channels = data.read(6).unpack("CnnC")
+            @bits, @height, @width, @channels = d.read(6).unpack("CnnC")
             break
           end
 
-          data.read(length - 2)
+          d.seek(length - 2, IO::SEEK_CUR)
         end
       end
 

data/lib/prawn/images/png.rb

@@ -107,34 +107,17 @@ module Prawn
         end
       end
 
-      # number of bits used per pixel
-      #
-      def pixel_bitlength
-        if alpha_channel?
-          self.bits * (self.colors + 1)
-        else
-          self.bits * self.colors
-        end
-      end
-
       # split the alpha channel data from the raw image data in images
       # where it's required.
       #
       def split_alpha_channel!
-        unfilter_image_data if alpha_channel?
+        split_image_data if alpha_channel?
       end
 
       def alpha_channel?
         @color_type == 4 || @color_type == 6
       end
 
-      # Adobe Reader can't handle 16-bit png channels -- chop off the second
-      # byte (least significant)
-      #
-      def alpha_channel_bits
-        8
-      end
-
       # Build a PDF object representing this image in +document+, and return
       # a Reference to it.
       #
@@ -180,18 +163,14 @@ module Prawn
         # 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?
@@ -243,12 +222,20 @@ module Prawn
             :Subtype          => :Image,
             :Height           => height,
             :Width            => width,
-            :BitsPerComponent => alpha_channel_bits,
+            :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,99 +257,40 @@ module Prawn
 
       private
 
-      def unfilter_image_data
-        data = @img_data.dup
+      def split_image_data
+        alpha_bytes = bits / 8
+        color_bytes = colors * bits / 8
 
-        @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]
+        scanline_length  = (color_bytes + alpha_bytes) * self.width + 1
+        scanlines = @img_data.bytesize / scanline_length
+        pixels = self.width * self.height
 
-              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
+        data = StringIO.new(@img_data)
+        data.binmode
 
-          s = []
-          row_data.each_slice pixel_bytes do |slice|
-            s << slice
-          end
-          pixels << s
-          row += 1
-          row_data.clear
-        end
+        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
 
-        # 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*")
+        scanlines.times do |line|
+          data.seek(line * scanline_length)
+
+          filter = data.getbyte
+
+          color.putc filter
+          alpha.putc filter
+
+          self.width.times do
+            color.write data.read(color_bytes)
+            alpha.write data.read(alpha_bytes)
           end
         end
+
+        @img_data = color_data
       end
     end
   end

data/lib/prawn/images.rb

@@ -12,13 +12,8 @@ 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, 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

data/lib/prawn/layout.rb

@@ -1,5 +1,5 @@
-require "prawn/table"
-require 'prawn/layout/grid'
+require_relative "table"
+require_relative "layout/grid"
 
 module Prawn
 

data/lib/prawn/measurement_extensions.rb

@@ -5,7 +5,7 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require 'prawn/measurements'
+require_relative 'measurements'
 
 class Numeric
   include Prawn::Measurements

data/lib/prawn/table/cells.rb

@@ -240,6 +240,9 @@ module Prawn
           end
         end
 
+        #if there are only colspanned or rowspanned cells in a table
+        spanned_width_needs_fixing = true
+
         each do |cell|
           index = cell.send(row_or_column)
           if cell.colspan > 1
@@ -251,8 +254,9 @@ module Prawn
 
             #calculate future return value
             new_sum = cell.send(meth) * cell.colspan
+            spanned_width_needs_fixing = (new_sum > old_sum)
 
-            if new_sum >= old_sum
+            if spanned_width_needs_fixing
               #not entirely sure why we need this line, but with it the tests pass
               values[index] = [values[index], cell.send(meth)].compact.send(aggregate)
               #overwrite the old values with the new ones, but only if all entries existed
@@ -263,7 +267,7 @@ module Prawn
               }
             end
           else
-            if cell.class == Prawn::Table::Cell::SpanDummy
+            if spanned_width_needs_fixing && cell.class == Prawn::Table::Cell::SpanDummy
               values[index] = [values[index], cell.send(meth)].compact.send(aggregate)
             end
           end

data/lib/prawn/table/column_width_calculator.rb

@@ -0,0 +1,55 @@
+module Prawn
+  class Table
+    class ColumnWidthCalculator
+      def initialize(cells)
+        @cells = cells
+
+        @widths_by_column        = Hash.new(0)
+        @rows_with_a_span_dummy  = Hash.new(false)
+      end
+
+      def natural_widths
+        @cells.each do |cell|
+          @rows_with_a_span_dummy[cell.row] = true if cell.is_a?(Cell::SpanDummy)
+        end
+
+        #calculate natural column width for all rows that do not include a span dummy
+        @cells.each do |cell|
+          unless @rows_with_a_span_dummy[cell.row]
+            @widths_by_column[cell.column] = 
+              [@widths_by_column[cell.column], cell.width.to_f].max
+          end
+        end
+
+        #integrate natural column widths for all rows that do include a span dummy
+        @cells.each do |cell|
+          next unless @rows_with_a_span_dummy[cell.row]
+          #the width of a SpanDummy cell will be calculated by the "mother" cell
+          next if cell.is_a?(Cell::SpanDummy)
+
+          if cell.colspan == 1
+            @widths_by_column[cell.column] = 
+              [@widths_by_column[cell.column], cell.width.to_f].max
+          else
+            #calculate the current with of all cells that will be spanned by the current cell
+            current_width_of_spanned_cells = 
+              @widths_by_column.to_a[cell.column..(cell.column + cell.colspan - 1)]
+                               .collect{|key, value| value}.inject(0, :+)
+
+            #update the Hash only if the new with is at least equal to the old one
+            if cell.width.to_f > current_width_of_spanned_cells
+              # Split the width of colspanned cells evenly by columns
+              width_per_column = cell.width.to_f / cell.colspan
+              # Update the Hash
+              cell.colspan.times do |i|
+                @widths_by_column[cell.column + i] = width_per_column
+              end
+            end
+          end
+        end
+
+        @widths_by_column.sort_by { |col, _| col }.map { |_, w| w }
+      end
+    end
+  end
+end

data/lib/prawn/table.rb

@@ -6,13 +6,14 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require 'prawn/table/cells'
-require 'prawn/table/cell'
-require 'prawn/table/cell/in_table'
-require 'prawn/table/cell/text'
-require 'prawn/table/cell/subtable'
-require 'prawn/table/cell/image'
-require 'prawn/table/cell/span_dummy'
+require_relative 'table/column_width_calculator'
+require_relative 'table/cells'
+require_relative 'table/cell'
+require_relative 'table/cell/in_table'
+require_relative 'table/cell/text'
+require_relative 'table/cell/subtable'
+require_relative 'table/cell/image'
+require_relative 'table/cell/span_dummy'
 
 module Prawn
 
@@ -549,21 +550,7 @@ module Prawn
     # Returns an array of each column's natural (unconstrained) width.
     #
     def natural_column_widths
-      @natural_column_widths ||=
-        begin
-          widths_by_column = Hash.new(0)
-          cells.each do |cell|
-            next if cell.is_a?(Cell::SpanDummy)
-
-            # Split the width of colspanned cells evenly by columns
-            width_per_column = cell.width.to_f / cell.colspan
-            cell.colspan.times do |i|
-              widths_by_column[cell.column + i] =
-                [widths_by_column[cell.column + i], width_per_column].max
-            end
-          end
-          widths_by_column.sort_by { |col, _| col }.map { |_, w| w }
-        end
+      @natural_column_widths ||= ColumnWidthCalculator.new(cells).natural_widths
     end
 
     # Returns the "natural" (unconstrained) width of the table. This may be

data/lib/prawn/templates.rb

@@ -0,0 +1,75 @@
+warn "Templates are no longer supported in Prawn!\n" +
+     "This code is for experimental testing only, and\n" +
+     "will extracted into its own gem in a future Prawn release"
+
+module Prawn
+  module Templates
+    def initialize_first_page(options)
+      return super unless options[:template]
+
+      fresh_content_streams(options)
+      go_to_page(1)
+    end
+   
+    ## FIXME: This is going to be terribly brittle because
+    # it copy-pastes the start_new_page method. But at least
+    # it should only run when templates are used.
+
+    def start_new_page(options = {})
+      return super unless options[:template]
+
+      if last_page = state.page
+        last_page_size    = last_page.size
+        last_page_layout  = last_page.layout
+        last_page_margins = last_page.margins
+      end
+
+      page_options = {:size => options[:size] || last_page_size,
+                      :layout  => options[:layout] || last_page_layout,
+                      :margins => last_page_margins}
+      if last_page
+        new_graphic_state = last_page.graphic_state.dup  if last_page.graphic_state
+        #erase the color space so that it gets reset on new page for fussy pdf-readers
+        new_graphic_state.color_space = {} if new_graphic_state
+        page_options.merge!(:graphic_state => new_graphic_state)
+      end
+
+      merge_template_options(page_options, options)
+
+      state.page = PDF::Core::Page.new(self, page_options)
+
+      apply_margin_options(options)
+      generate_margin_box
+
+      # Reset the bounding box if the new page has different size or layout
+      if last_page && (last_page.size != state.page.size ||
+                       last_page.layout != state.page.layout)
+        @bounding_box = @margin_box
+      end
+
+      state.page.new_content_stream
+      use_graphic_settings(true)
+      forget_text_rendering_mode!
+
+      unless options[:orphan]
+        state.insert_page(state.page, @page_number)
+        @page_number += 1
+
+        canvas { image(@background, :scale => @background_scale, :at => bounds.top_left) } if @background
+        @y = @bounding_box.absolute_top
+
+        float do
+          state.on_page_create_action(self)
+        end
+      end
+    end
+
+    def merge_template_options(page_options, options)
+      object_id = state.store.import_page(options[:template], options[:template_page] || 1)
+      page_options.merge!(:object_id => object_id, :page_template => true)
+    end
+  end
+end
+
+Prawn::Document::VALID_OPTIONS << :template
+Prawn::Document.extensions << Prawn::Templates

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

@@ -52,11 +52,7 @@ module Prawn
             raise "Lines must be finalized before calling #line"
           end
           @fragments.collect do |fragment|
-            if ruby_18 { true }
-              fragment.text
-            else
-              fragment.text.dup.force_encoding("utf-8")
-            end
+            fragment.text.dup.force_encoding(::Encoding::UTF_8)
           end.join
         end
 

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

@@ -392,7 +392,7 @@ module Prawn
           # all fonts
           fallback_fonts << fragment_font
 
-          hash[:text].unicode_characters do |char|
+          hash[:text].each_char do |char|
             @document.font(fragment_font)
             font_glyph_pairs << [find_font_for_this_glyph(char,
                                                           @document.font.family,

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

@@ -212,11 +212,7 @@ module Prawn
           end
           case direction
           when :rtl
-            if ruby_18 { true }
-              string.scan(/./mu).reverse.join
-            else
-              string.reverse
-            end
+            string.reverse
           else
             string
           end
@@ -232,11 +228,9 @@ module Prawn
 
         def process_soft_hyphens(string)
           if string.length > 0 && normalized_soft_hyphen
-            ruby_19 {
-              if string.encoding != normalized_soft_hyphen.encoding
-                string.force_encoding(normalized_soft_hyphen.encoding)
-              end
-            }
+            if string.encoding != normalized_soft_hyphen.encoding
+              string.force_encoding(normalized_soft_hyphen.encoding)
+            end
             string[0..-2].gsub(normalized_soft_hyphen, "") + string[-1..-1]
           else
             string
@@ -244,7 +238,7 @@ module Prawn
         end
 
         def strip_zero_width_spaces(string)
-          if !"".respond_to?(:encoding) || string.encoding.to_s == "UTF-8"
+          if string.encoding == ::Encoding::UTF_8
             string.gsub(Prawn::Text::ZWSP, "")
           else
             string