prawn 2.1.0 → 2.4.0

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.

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,15 +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 = [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
@@ -30,18 +37,19 @@ module Prawn
       # <tt>:data</tt>:: A binary string of JPEG data
       #
       def initialize(data)
+        super()
         @data = data
         d = StringIO.new(@data)
         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 FormatError, '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 +61,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

@@ -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'
@@ -72,11 +73,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).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
@@ -86,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)
@@ -95,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
 
@@ -128,18 +129,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 +153,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 +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
 
         # *************************************
@@ -210,30 +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
+          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
@@ -261,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
@@ -284,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
@@ -318,7 +322,7 @@ module Prawn
           alpha.putc filter
 
           width.times do
-            color = data.read(1).unpack('C').first
+            color = data.read(1).unpack1('C')
             alpha.putc alpha_palette[color]
           end
         end

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,70 +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
     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