prawn 2.1.0 → 2.2.0

data/lib/prawn/graphics/transformation.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # transformation.rb: Implements rotate, translate, skew, scale and a generic
 #                     transformation_matrix
 #
@@ -48,7 +46,7 @@ module Prawn
         if options[:origin].nil?
           transformation_matrix(cos, sin, -sin, cos, 0, 0, &block)
         else
-          fail Prawn::Errors::BlockRequired unless block_given?
+          raise Prawn::Errors::BlockRequired unless block_given?
           x = options[:origin][0] + bounds.absolute_left
           y = options[:origin][1] + bounds.absolute_bottom
           x_prime = x * cos - y * sin
@@ -59,8 +57,8 @@ module Prawn
         end
       end
 
-      # Translate the user space.  If a block is not provided, then you must save
-      # and restore the graphics state yourself.
+      # Translate the user space.  If a block is not provided, then you must
+      # save and restore the graphics state yourself.
       #
       # Example without a block: move the text up and over 10
       #
@@ -117,7 +115,7 @@ module Prawn
         if options[:origin].nil?
           transformation_matrix(factor, 0, 0, factor, 0, 0, &block)
         else
-          fail Prawn::Errors::BlockRequired unless block_given?
+          raise Prawn::Errors::BlockRequired unless block_given?
           x = options[:origin][0] + bounds.absolute_left
           y = options[:origin][1] + bounds.absolute_bottom
           x_prime = factor * x
@@ -142,11 +140,15 @@ module Prawn
       # Transform the user space (see notes for rotate regarding graphics state)
       # Generally, one would use the rotate, scale, translate, and skew
       # convenience methods instead of calling transformation_matrix directly
-      def transformation_matrix(a, b, c, d, e, f)
-        values = [a, b, c, d, e, f].map { |x| "%.5f" % x }.join(" ")
+      def transformation_matrix(*matrix)
+        if matrix.length != 6
+          raise ArgumentError,
+            'Transformation matrix must have exacty 6 elements'
+        end
+        values = matrix.map { |x| format '%.5f', x }.join(' ')
         save_graphics_state if block_given?
 
-        add_to_transformation_stack(a, b, c, d, e, f)
+        add_to_transformation_stack(*matrix)
 
         renderer.add_content "#{values} cm"
         if block_given?

data/lib/prawn/graphics/transparency.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # transparency.rb : Implements transparency
 #
 # Copyright October 2009, Daniel Nelson. All Rights Reserved.
@@ -51,14 +49,16 @@ module Prawn
       #     pdf.fill_and_stroke_circle([x, y], 25)
       #   end
       #
-      def transparent(opacity, stroke_opacity = opacity, &block)
+      def transparent(opacity, stroke_opacity = opacity)
         renderer.min_version(1.4)
 
-        opacity        = [[opacity, 0.0].max, 1.0].min
+        opacity = [[opacity, 0.0].max, 1.0].min
         stroke_opacity = [[stroke_opacity, 0.0].max, 1.0].min
 
         save_graphics_state
-        renderer.add_content "/#{opacity_dictionary_name(opacity, stroke_opacity)} gs"
+        renderer.add_content(
+          "/#{opacity_dictionary_name(opacity, stroke_opacity)} gs"
+        )
         yield
         restore_graphics_state
       end
@@ -77,21 +77,23 @@ module Prawn
         key = "#{opacity}_#{stroke_opacity}"
 
         if opacity_dictionary_registry[key]
-          dictionary =  opacity_dictionary_registry[key][:obj]
-          dictionary_name =  opacity_dictionary_registry[key][:name]
+          dictionary = opacity_dictionary_registry[key][:obj]
+          dictionary_name = opacity_dictionary_registry[key][:name]
         else
           dictionary = ref!(
-            :Type => :ExtGState,
-            :CA   => stroke_opacity,
-            :ca   => opacity
+            Type: :ExtGState,
+            CA: stroke_opacity,
+            ca: opacity
           )
 
           dictionary_name = "Tr#{next_opacity_dictionary_id}"
-          opacity_dictionary_registry[key] = { :name => dictionary_name,
-                                               :obj  => dictionary }
+          opacity_dictionary_registry[key] = {
+            name: dictionary_name,
+            obj: dictionary
+          }
         end
 
-        page.ext_gstates.merge!(dictionary_name => dictionary)
+        page.ext_gstates[dictionary_name] = dictionary
         dictionary_name
       end
     end

data/lib/prawn/grid.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # grid.rb: Provides a basic grid layout system for Prawn
 #
 # Contributed by Andrew O'Brien in March 2009
@@ -40,7 +38,8 @@ module Prawn
       else
         g1, g2 = args
 
-        if g1.class == Array && g2.class == Array && g1.length == 2 && g2.length == 2
+        if g1.is_a?(Array) && g2.is_a?(Array) && g1.length == 2 &&
+            g2.length == 2
           @boxes[args] = multi_box(single_box(*g1), single_box(*g2))
         else
           @boxes[args] = single_box(g1, g2)
@@ -63,7 +62,7 @@ module Prawn
         @pdf = pdf
         @columns = options[:columns]
         @rows = options[:rows]
-        set_gutter(options)
+        apply_gutter(options)
       end
 
       # Calculates the base width of boxes.
@@ -77,9 +76,9 @@ module Prawn
       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|
+      def show_all(color = 'CCCCCC')
+        rows.times do |i|
+          columns.times do |j|
             pdf.grid(i, j).show(color)
           end
         end
@@ -91,12 +90,13 @@ module Prawn
         (total.to_f - (gutter * (num - 1).to_f)) / num.to_f
       end
 
-      def set_gutter(options)
+      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
@@ -121,7 +121,7 @@ module Prawn
       # col_num, row_num
       #
       def name
-        "#{@i.to_s},#{@j.to_s}"
+        "#{@i},#{@j}"
       end
 
       # :nodoc
@@ -186,16 +186,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
@@ -219,7 +219,7 @@ module Prawn
       end
 
       def name
-        @bs.map(&:name).join(":")
+        @bs.map(&:name).join(':')
       end
 
       def total_height
@@ -257,19 +257,19 @@ module Prawn
       private
 
       def left_box
-        @left_box ||= @bs.min { |a, b| a.left <=> b.left }
+        @left_box ||= @bs.min_by(&:left)
       end
 
       def right_box
-        @right_box ||= @bs.max { |a, b| a.right <=> b.right }
+        @right_box ||= @bs.max_by(&:right)
       end
 
       def top_box
-        @top_box ||= @bs.max { |a, b| a.top <=> b.top }
+        @top_box ||= @bs.max_by(&:top)
       end
 
       def bottom_box
-        @bottom_box ||= @bs.min { |a, b| a.bottom <=> b.bottom }
+        @bottom_box ||= @bs.min_by(&:bottom)
       end
     end
 

data/lib/prawn/image_handler.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # ImageHandler provides a way to register image processors with Prawn
 #
 # Contributed by Evan Sharp in November 2013.
@@ -29,16 +27,16 @@ module Prawn
     end
 
     def unregister(handler)
-      @handlers.reject!{ |h| h == 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
 
-      fail Prawn::Errors::UnsupportedImageType,
-           "image file is an unrecognised format"
+      raise Prawn::Errors::UnsupportedImageType,
+        'image file is an unrecognised format'
     end
   end
 end

data/lib/prawn/images.rb

@@ -17,16 +17,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"
@@ -52,7 +55,7 @@ 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
@@ -60,8 +63,10 @@ module Prawn
     # (See also: Prawn::Images::PNG , Prawn::Images::JPG)
     #
     def image(file, options = {})
-      Prawn.verify_options [:at, :position, :vposition, :height,
-                            :width, :scale, :fit], options
+      Prawn.verify_options [
+        :at, :position, :vposition, :height,
+        :width, :scale, :fit
+      ], options
 
       pdf_obj, info = build_image_object(file)
       embed_image(pdf_obj, info, options)
@@ -87,11 +92,13 @@ module Prawn
         info = Prawn.image_handler.find(image_content).new(image_content)
 
         # Bump PDF version if the image requires it
-        renderer.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]
@@ -117,9 +124,9 @@ module Prawn
       # 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
 
-      cm_params = PDF::Core.real_params([ w, 0, 0, h, x, y - h])
+      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
 
@@ -139,7 +146,7 @@ module Prawn
       end
       # String or Pathname
       io_or_path = Pathname.new(io_or_path)
-      fail ArgumentError, "#{io_or_path} not found" unless io_or_path.file?
+      raise ArgumentError, "#{io_or_path} not found" unless io_or_path.file?
       io = io_or_path.open('rb')
       io
     end
@@ -171,18 +178,18 @@ module Prawn
             options[:position] + bounds.left_side
           end
 
-      return [x, y]
+      [x, y]
     end
 
     def determine_y_with_page_flow(h)
       if overruns_page?(h)
         bounds.move_past_bottom
       end
-      self.y
+      y
     end
 
     def overruns_page?(h)
-      (self.y - h) < reference_bounds.absolute_bottom
+      (y - h) < reference_bounds.absolute_bottom
     end
 
     def image_registry

data/lib/prawn/images/image.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # image.rb : Base class for image info objects
 #
 # Copyright September 2011, Brad Ediger. All rights reserved.

data/lib/prawn/images/jpg.rb

@@ -19,10 +19,13 @@ module Prawn
       attr_reader :width, :height, :bits, :channels
       attr_accessor :scaled_width, :scaled_height
 
-      JPEG_SOF_BLOCKS = [0xC0, 0xC1, 0xC2, 0xC3, 0xC5, 0xC6, 0xC7, 0xC9, 0xCA, 0xCB, 0xCD, 0xCE, 0xCF]
+      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
@@ -35,13 +38,13 @@ module Prawn
         d.binmode
 
         c_marker = 0xff # Section marker.
-        d.seek(2)    # Skip the first two bytes of JPEG identifier.
+        d.seek(2) # Skip the first two bytes of JPEG identifier.
         loop do
           marker, code, length = d.read(4).unpack('CCn')
-          fail "JPEG marker not found!" if marker != c_marker
+          raise 'JPEG marker not found!' if marker != c_marker
 
           if JPEG_SOF_BLOCKS.include?(code)
-            @bits, @height, @width, @channels = d.read(6).unpack("CnnC")
+            @bits, @height, @width, @channels = d.read(6).unpack('CnnC')
             break
           end
 
@@ -53,31 +56,32 @@ 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
-                        fail 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

data/lib/prawn/images/png.rb

@@ -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
@@ -36,28 +36,28 @@ module Prawn
       def initialize(data)
         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).unpack('N')[0]
+          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'
@@ -72,11 +72,11 @@ module Prawn
             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).unpack('n').first
               @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
@@ -86,7 +86,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)
@@ -95,7 +95,7 @@ module Prawn
       # number of color components to each pixel
       #
       def colors
-        case self.color_type
+        case color_type
         when 0, 3, 4
           return 1
         when 2, 6
@@ -128,18 +128,18 @@ module Prawn
       #
       def build_pdf_object(document)
         if compression_method != 0
-          fail Errors::UnsupportedImageType,
-               'PNG uses an unsupported compression method'
+          raise Errors::UnsupportedImageType,
+            'PNG uses an unsupported compression method'
         end
 
         if filter_method != 0
-          fail Errors::UnsupportedImageType,
-               'PNG uses an unsupported filter method'
+          raise Errors::UnsupportedImageType,
+            'PNG uses an unsupported filter method'
         end
 
         if interlace_method != 0
-          fail Errors::UnsupportedImageType,
-               'PNG uses unsupported interlace method'
+          raise Errors::UnsupportedImageType,
+            'PNG uses unsupported interlace method'
         end
 
         # some PNG types store the colour and alpha channel data together,
@@ -152,28 +152,28 @@ module Prawn
         when 3
           color = :DeviceRGB
         else
-          fail Errors::UnsupportedImageType,
-               "PNG uses an unsupported number of colors (#{png.colors})"
+          raise Errors::UnsupportedImageType,
+            "PNG uses an unsupported number of colors (#{png.colors})"
         end
 
         # 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
           }
         }
 
@@ -186,10 +186,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
 
         # *************************************
@@ -213,27 +215,28 @@ module Prawn
           obj.data[:Mask] = rgb.collect { |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
@@ -261,9 +264,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
@@ -284,7 +287,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