prawn 0.13.0 → 2.4.0

data/lib/prawn/{layout/grid.rb → grid.rb}

@@ -1,11 +1,26 @@
+# frozen_string_literal: true
+
+# grid.rb: Provides a basic grid layout system for Prawn
+#
+# Contributed by Andrew O'Brien in March 2009
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
 module Prawn
   class Document
+    # @group Experimental API
 
     # Defines the grid system for a particular document.  Takes the number of
     # rows and columns and the width to use for the gutter as the
     # keys :rows, :columns, :gutter, :row_gutter, :column_gutter
     #
+    # Note that a completely new grid object is built each time define_grid()
+    # is called. This means that all subsequent calls to grid() will use
+    # the newly defined Grid object -- grids are not nestable like
+    # bounding boxes are.
+
     def define_grid(options = {})
+      @boxes = nil
       @grid = Grid.new(self, options)
     end
 
@@ -13,36 +28,43 @@ module Prawn
     # or work with the grid system directly.
     #
     #   @pdf.grid                 # Get the Grid directly
-    #   @pdf.grid([0,1])          # Get the box at [0,1]
+    #   @pdf.grid([0,1])          # Get the GridBox at [0,1]
     #   @pdf.grid([0,1], [1,2])   # Get a multi-box spanning from [0,1] to [1,2]
     #
     def grid(*args)
       @boxes ||= {}
-      @boxes[args] ||= if args.empty?
-        @grid
-      else
-        g1, g2 = args
-        if(g1.class == Array && g2.class == Array &&
-          g1.length == 2 && g2.length == 2)
-          multi_box(single_box(*g1), single_box(*g2))
-        else
-          single_box(g1, g2)
+      @boxes[args] ||=
+        begin
+          if args.empty?
+            @grid
+          else
+            g1, g2 = args
+
+            if g1.is_a?(Array) && g2.is_a?(Array) &&
+                g1.length == 2 && g2.length == 2
+              multi_box(single_box(*g1), single_box(*g2))
+            else
+              single_box(g1, g2)
+            end
+          end
         end
-      end
     end
 
     # A Grid represents the entire grid system of a Page and calculates
     # the column width and row height of the base box.
+    #
+    # @group Experimental API
     class Grid
       attr_reader :pdf, :columns, :rows, :gutter, :row_gutter, :column_gutter
+
       def initialize(pdf, options = {}) # :nodoc:
-        valid_options = [:columns, :rows, :gutter, :row_gutter, :column_gutter]
+        valid_options = %i[columns rows gutter row_gutter column_gutter]
         Prawn.verify_options valid_options, options
 
         @pdf = pdf
         @columns = options[:columns]
         @rows = options[:rows]
-        set_gutter(options)
+        apply_gutter(options)
       end
 
       # Calculates the base width of boxes.
@@ -52,14 +74,14 @@ module Prawn
 
       # Calculates the base height of boxes.
       def row_height
-       @row_height ||= subdivide(pdf.bounds.height, rows, row_gutter)
+        @row_height ||= subdivide(pdf.bounds.height, rows, row_gutter)
       end
 
       # Diagnostic tool to show all of the grids.  Defaults to gray.
-      def show_all(color = "CCCCCC")
-        self.rows.times do |i|
-          self.columns.times do |j|
-            pdf.grid(i,j).show(color)
+      def show_all(color = 'CCCCCC')
+        rows.times do |row|
+          columns.times do |column|
+            pdf.grid(row, column).show(color)
           end
         end
       end
@@ -70,12 +92,13 @@ module Prawn
         (total.to_f - (gutter * (num - 1).to_f)) / num.to_f
       end
 
-      def set_gutter(options)
-        if options.has_key?(:gutter)
+      def apply_gutter(options)
+        if options.key?(:gutter)
           @gutter = options[:gutter].to_f
-          @row_gutter, @column_gutter = @gutter, @gutter
+          @row_gutter = @gutter
+          @column_gutter = @gutter
         else
-          @row_gutter    = options[:row_gutter].to_f
+          @row_gutter = options[:row_gutter].to_f
           @column_gutter = options[:column_gutter].to_f
           @gutter = 0
         end
@@ -86,20 +109,21 @@ module Prawn
     # A Grid object has methods that allow easy access to the coordinates of
     # its corners, which can be plugged into most existing prawnmethods.
     #
-    class Box #:nodoc:
+    # @group Experimental API
+    class GridBox
       attr_reader :pdf
 
-      def initialize(pdf, i, j)
+      def initialize(pdf, rows, columns)
         @pdf = pdf
-        @i = i
-        @j = j
+        @rows = rows
+        @columns = columns
       end
 
       # Mostly diagnostic method that outputs the name of a box as
       # col_num, row_num
       #
       def name
-        "#{@i.to_s},#{@j.to_s}"
+        "#{@rows},#{@columns}"
       end
 
       # :nodoc
@@ -124,7 +148,7 @@ module Prawn
 
       # x-coordinate of left side
       def left
-        @left ||= (width + grid.column_gutter) * @j.to_f
+        @left ||= (width + grid.column_gutter) * @columns.to_f
       end
 
       # x-coordinate of right side
@@ -134,7 +158,7 @@ module Prawn
 
       # y-coordinate of the top
       def top
-        @top ||= total_height - ((height + grid.row_gutter) * @i.to_f)
+        @top ||= total_height - ((height + grid.row_gutter) * @rows.to_f)
       end
 
       # y-coordinate of the bottom
@@ -164,16 +188,16 @@ module Prawn
 
       # Creates a standard bounding box based on the grid box.
       def bounding_box(&blk)
-        pdf.bounding_box(top_left, :width => width, :height => height, &blk)
+        pdf.bounding_box(top_left, width: width, height: height, &blk)
       end
 
       # Diagnostic method
-      def show(grid_color = "CCCCCC")
-        self.bounding_box do
+      def show(grid_color = 'CCCCCC')
+        bounding_box do
           original_stroke_color = pdf.stroke_color
 
           pdf.stroke_color = grid_color
-          pdf.text self.name
+          pdf.text name
           pdf.stroke_bounds
 
           pdf.stroke_color = original_stroke_color
@@ -181,24 +205,29 @@ module Prawn
       end
 
       private
+
       def grid
         pdf.grid
       end
     end
 
     # A MultiBox is specified by 2 Boxes and spans the areas between.
-    class MultiBox < Box #:nodoc:
-      def initialize(pdf, b1, b2)
+    #
+    # @group Experimental API
+    class MultiBox
+      def initialize(pdf, box1, box2)
         @pdf = pdf
-        @bs = [b1, b2]
+        @boxes = [box1, box2]
       end
 
+      attr_reader :pdf
+
       def name
-        @bs.map {|b| b.name}.join(":")
+        @boxes.map(&:name).join(':')
       end
 
       def total_height
-        @bs[0].total_height
+        @boxes[0].total_height
       end
 
       def width
@@ -210,7 +239,7 @@ module Prawn
       end
 
       def gutter
-        @bs[0].gutter
+        @boxes[0].gutter
       end
 
       def left
@@ -229,31 +258,65 @@ module Prawn
         bottom_box.bottom
       end
 
+      def top_left
+        [left, top]
+      end
+
+      def top_right
+        [right, top]
+      end
+
+      def bottom_left
+        [left, bottom]
+      end
+
+      def bottom_right
+        [right, bottom]
+      end
+
+      def bounding_box(&blk)
+        pdf.bounding_box(top_left, width: width, height: height, &blk)
+      end
+
+      def show(grid_color = 'CCCCCC')
+        bounding_box do
+          original_stroke_color = pdf.stroke_color
+
+          pdf.stroke_color = grid_color
+          pdf.text name
+          pdf.stroke_bounds
+
+          pdf.stroke_color = original_stroke_color
+        end
+      end
+
       private
+
       def left_box
-        @left_box ||= @bs.min {|a,b| a.left <=> b.left}
+        @left_box ||= @boxes.min_by(&:left)
       end
 
       def right_box
-        @right_box ||= @bs.max {|a,b| a.right <=> b.right}
+        @right_box ||= @boxes.max_by(&:right)
       end
 
       def top_box
-        @top_box ||= @bs.max {|a,b| a.top <=> b.top}
+        @top_box ||= @boxes.max_by(&:top)
       end
 
       def bottom_box
-        @bottom_box ||= @bs.min {|a,b| a.bottom <=> b.bottom}
+        @bottom_box ||= @boxes.min_by(&:bottom)
       end
     end
 
     private
-    def single_box(i, j)
-      Box.new(self, i, j)
+
+    def single_box(rows, columns)
+      GridBox.new(self, rows, columns)
     end
 
-    def multi_box(b1, b2)
-      MultiBox.new(self, b1, b2)
+    def multi_box(box1, box2)
+      MultiBox.new(self, box1, box2)
     end
   end
 end

data/lib/prawn/image_handler.rb

@@ -1,4 +1,14 @@
+# frozen_string_literal: true
+
+# ImageHandler provides a way to register image processors with Prawn
+#
+# Contributed by Evan Sharp in November 2013.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
 module Prawn
+  # @group Extension API
+
   def self.image_handler
     @image_handler ||= ImageHandler.new
   end
@@ -18,13 +28,17 @@ 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 }
+      handler = @handlers.find { |h| h.can_render? image_blob }
 
       return handler if handler
 
       raise Prawn::Errors::UnsupportedImageType,
-            "image file is an unrecognised format"
+        'image file is an unrecognised format'
     end
   end
 end

data/lib/prawn/images/image.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 # image.rb : Base class for image info objects
 #
 # Copyright September 2011, Brad Ediger. All rights reserved.
@@ -10,6 +11,7 @@ require 'digest/sha1'
 module Prawn
   module Images
     class Image
+      # @group Extension API
 
       def calc_image_dimensions(options)
         w = options[:width] || width
@@ -41,7 +43,7 @@ module Prawn
         self.scaled_width = w
         self.scaled_height = h
 
-        [w,h]
+        [w, h]
       end
     end
   end

data/lib/prawn/images/jpg.rb

@@ -1,5 +1,7 @@
 # encoding: ASCII-8BIT
 
+# frozen_string_literal: true
+
 # jpg.rb : Extracts the data from a JPG that is needed for embedding
 #
 # Copyright April 2008, James Healy.  All Rights Reserved.
@@ -14,14 +16,20 @@ module Prawn
     # of a JPG image that we need to embed them in a PDF
     #
     class JPG < Image
+      class FormatError < StandardError; end
+
+      # @group Extension API
+
       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
+      ].freeze
 
       def self.can_render?(image_blob)
-        image_blob[0, 3].unpack("C*") == [255, 216, 255]
+        image_blob[0, 3].unpack('C*') == [255, 216, 255]
       end
 
       # Process a new JPG image
@@ -29,22 +37,23 @@ 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)
+        super()
+        @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')
-          raise "JPEG marker not found!" if marker != c_marker
+          marker, code, length = d.read(4).unpack('CCn')
+          raise FormatError, '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
 
@@ -52,38 +61,38 @@ module Prawn
       # a Reference to it.
       #
       def build_pdf_object(document)
-        color_space = case channels
-        when 1
-          :DeviceGray
-        when 3
-          :DeviceRGB
-        when 4
-          :DeviceCMYK
-        else
-          raise ArgumentError, 'JPG uses an unsupported number of channels'
-        end
+        color_space =
+          case channels
+          when 1
+            :DeviceGray
+          when 3
+            :DeviceRGB
+          when 4
+            :DeviceCMYK
+          else
+            raise ArgumentError, 'JPG uses an unsupported number of channels'
+          end
 
         obj = document.ref!(
-          :Type             => :XObject,
-          :Subtype          => :Image,
-          :ColorSpace       => color_space,
-          :BitsPerComponent => bits,
-          :Width            => width,
-          :Height           => height
+          Type: :XObject,
+          Subtype: :Image,
+          ColorSpace: color_space,
+          BitsPerComponent: bits,
+          Width: width,
+          Height: height
         )
 
         # add extra decode params for CMYK images. By swapping the
         # min and max values from the default, we invert the colours. See
         # section 4.8.4 of the spec.
         if color_space == :DeviceCMYK
-          obj.data[:Decode] = [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ]
+          obj.data[:Decode] = [1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0]
         end
 
         obj.stream << @data
         obj.stream.filters << :DCTDecode
         obj
       end
-
     end
   end
 end