prawn 2.1.0 → 2.2.0

data/lib/prawn/security.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # encryption.rb : Implements encrypted PDF and access permissions.
 #
 # Copyright August 2008, Brad Ediger. All Rights Reserved.
@@ -89,13 +87,13 @@ module Prawn
       #
       def encrypt_document(options = {})
         Prawn.verify_options [:user_password, :owner_password, :permissions],
-                             options
-        @user_password = options.delete(:user_password) || ""
+          options
+        @user_password = options.delete(:user_password) || ''
 
         @owner_password = options.delete(:owner_password) || @user_password
         if @owner_password == :random
           # Generate a completely ridiculous password
-          @owner_password = (1..32).map{ rand(256) }.pack("c*")
+          @owner_password = (1..32).map { rand(256) }.pack('c*')
         end
 
         self.permissions = options.delete(:permissions) || {}
@@ -124,28 +122,35 @@ module Prawn
 
       # Provides the values for the trailer encryption dictionary.
       def encryption_dictionary
-        { :Filter => :Standard, # default PDF security handler
-          :V      => 1,         # "Algorithm 3.1", PDF reference 1.3
-          :R      => 2,         # Revision 2 of the algorithm
-          :O      => PDF::Core::ByteString.new(owner_password_hash),
-          :U      => PDF::Core::ByteString.new(user_password_hash),
-          :P      => permissions_value }
+        {
+          Filter: :Standard, # default PDF security handler
+          V: 1,         # "Algorithm 3.1", PDF reference 1.3
+          R: 2,         # Revision 2 of the algorithm
+          O: PDF::Core::ByteString.new(owner_password_hash),
+          U: PDF::Core::ByteString.new(user_password_hash),
+          P: permissions_value
+        }
       end
 
       # Flags in the permissions word, numbered as LSB = 1
-      PermissionsBits = { :print_document     => 3,
-                          :modify_contents    => 4,
-                          :copy_contents      => 5,
-                          :modify_annotations => 6 }
+      PermissionsBits = {
+        print_document: 3,
+        modify_contents: 4,
+        copy_contents: 5,
+        modify_annotations: 6
+      }.freeze
 
-      FullPermissions = 0b1111_1111_1111_1111_1111_1111_1111_1111
+      FULL_PERMISSIONS = 0b1111_1111_1111_1111_1111_1111_1111_1111
 
       def permissions=(perms = {})
-        @permissions ||= FullPermissions
+        @permissions ||= FULL_PERMISSIONS
         perms.each do |key, value|
           unless PermissionsBits[key]
-            fail ArgumentError, "Unknown permission :#{key}. Valid options: " +
-              PermissionsBits.keys.map(&:inspect).join(", ")
+            raise(
+              ArgumentError,
+              "Unknown permission :#{key}. Valid options: " +
+                PermissionsBits.keys.map(&:inspect).join(', ')
+            )
           end
 
           # 0-based bit number, from LSB
@@ -160,12 +165,12 @@ module Prawn
       end
 
       def permissions_value
-        @permissions || FullPermissions
+        @permissions || FULL_PERMISSIONS
       end
 
       PasswordPadding =
-        "28BF4E5E4E758A4164004E56FFFA01082E2E00B6D0683E802F0CA9FE6453697A".
-        scan(/../).map{ |x| x.to_i(16) }.pack("c*")
+        '28BF4E5E4E758A4164004E56FFFA01082E2E00B6D0683E802F0CA9FE6453697A'
+          .scan(/../).map { |x| x.to_i(16) }.pack('c*')
 
       # Pads or truncates a password to 32 bytes as per Alg 3.2.
       def pad_password(password)
@@ -178,7 +183,7 @@ module Prawn
           md5 = Digest::MD5.new
           md5 << pad_password(@user_password)
           md5 << owner_password_hash
-          md5 << [permissions_value].pack("V")
+          md5 << [permissions_value].pack('V')
           md5.digest[0, 5]
         end
       end
@@ -204,46 +209,53 @@ module PDF
   module Core
     module_function
 
-    # Like PdfObject, but returns an encrypted result if required.
+    # Like pdf_object, but returns an encrypted result if required.
     # For direct objects, requires the object identifier and generation number
     # from the indirect object referencing obj.
     #
     # @private
-    def EncryptedPdfObject(obj, key, id, gen, in_content_stream = false)
+    def encrypted_pdf_object(obj, key, id, gen, in_content_stream = false)
       case obj
       when Array
-        "[" << obj.map { |e|
-          EncryptedPdfObject(e, key, id, gen, in_content_stream)
-        }.join(' ') << "]"
+        '[' << obj.map do |e|
+          encrypted_pdf_object(e, key, id, gen, in_content_stream)
+        end.join(' ') << ']'
       when LiteralString
-        obj = ByteString.new(Prawn::Document::Security.encrypt_string(obj, key, id, gen)).gsub(/[\\\n\(\)]/) { |m| "\\#{m}" }
+        obj = ByteString.new(
+          Prawn::Document::Security.encrypt_string(obj, key, id, gen)
+        ).gsub(/[\\\n\(\)]/) { |m| "\\#{m}" }
         "(#{obj})"
       when Time
-        obj = obj.strftime("D:%Y%m%d%H%M%S%z").chop.chop + "'00'"
-        obj = ByteString.new(Prawn::Document::Security.encrypt_string(obj, key, id, gen)).gsub(/[\\\n\(\)]/) { |m| "\\#{m}" }
+        obj = obj.strftime('D:%Y%m%d%H%M%S%z').chop.chop + "'00'"
+        obj = ByteString.new(
+          Prawn::Document::Security.encrypt_string(obj, key, id, gen)
+        ).gsub(/[\\\n\(\)]/) { |m| "\\#{m}" }
         "(#{obj})"
       when String
-        PdfObject(
+        pdf_object(
           ByteString.new(
-            Prawn::Document::Security.encrypt_string(obj, key, id, gen)),
-          in_content_stream)
+            Prawn::Document::Security.encrypt_string(obj, key, id, gen)
+          ),
+          in_content_stream
+        )
       when ::Hash
-        output = "<< "
+        output = '<< '
         obj.each do |k, v|
-          unless String === k || Symbol === k
-            fail PDF::Core::Errors::FailedObjectConversion,
-                 "A PDF Dictionary must be keyed by names"
+          unless k.is_a?(String) || k.is_a?(Symbol)
+            raise PDF::Core::Errors::FailedObjectConversion,
+              'A PDF Dictionary must be keyed by names'
           end
-          output << PdfObject(k.to_sym, in_content_stream) << " " << EncryptedPdfObject(v, key, id, gen, in_content_stream) << "\n"
+          output << pdf_object(k.to_sym, in_content_stream) << ' ' <<
+            encrypted_pdf_object(v, key, id, gen, in_content_stream) << "\n"
         end
-        output << ">>"
+        output << '>>'
       when NameTree::Value
-        PdfObject(obj.name) + " " +
-          EncryptedPdfObject(obj.value, key, id, gen, in_content_stream)
+        pdf_object(obj.name) + ' ' +
+          encrypted_pdf_object(obj.value, key, id, gen, in_content_stream)
       when PDF::Core::OutlineRoot, PDF::Core::OutlineItem
-        EncryptedPdfObject(obj.to_hash, key, id, gen, in_content_stream)
-      else # delegate back to PdfObject
-        PdfObject(obj, in_content_stream)
+        encrypted_pdf_object(obj.to_hash, key, id, gen, in_content_stream)
+      else # delegate back to pdf_object
+        pdf_object(obj, in_content_stream)
       end
     end
 
@@ -251,7 +263,10 @@ module PDF
     class Stream
       def encrypted_object(key, id, gen)
         if filtered_stream
-          "stream\n#{Prawn::Document::Security.encrypt_string filtered_stream, key, id, gen}\nendstream\n"
+          "stream\n" +
+            Prawn::Document::Security.encrypt_string(
+              filtered_stream, key, id, gen
+            ) + "\nendstream\n"
         else
           ''
         end
@@ -267,9 +282,12 @@ module PDF
 
         output = "#{@identifier} #{gen} obj\n"
         if @stream.empty?
-          output << PDF::Core::EncryptedPdfObject(data, key, @identifier, gen) << "\n"
+          output <<
+            PDF::Core.encrypted_pdf_object(data, key, @identifier, gen) << "\n"
         else
-          output << PDF::Core::EncryptedPdfObject(data.merge(@stream.data), key, @identifier, gen) << "\n" <<
+          output << PDF::Core.encrypted_pdf_object(
+            data.merge(@stream.data), key, @identifier, gen
+          ) << "\n" <<
             @stream.encrypted_object(key, @identifier, gen)
         end
 

data/lib/prawn/security/arcfour.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Implementation of the "ARCFOUR" algorithm ("alleged RC4 (tm)"). Implemented
 # as described at:
 # http://www.mozilla.org/projects/security/pki/nss/draft-kaukonen-cipher-arcfour-03.txt
@@ -39,7 +37,7 @@ class Arcfour
   end
 
   def encrypt(string)
-    string.unpack('c*').map{ |byte| byte ^ key_byte }.pack('c*')
+    string.unpack('c*').map { |byte| byte ^ key_byte }.pack('c*')
   end
 
   private

data/lib/prawn/soft_mask.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # soft_mask.rb : Implements soft-masking
 #
 # Copyright September 2012, Alexander Mankuta. All Rights Reserved.
@@ -31,44 +29,44 @@ module Prawn
       renderer.min_version(1.4)
 
       group_attrs = ref!(
-        :Type => :Group,
-        :S => :Transparency,
-        :CS => :DeviceRGB,
-        :I => false,
-        :K => false
+        Type: :Group,
+        S: :Transparency,
+        CS: :DeviceRGB,
+        I: false,
+        K: false
       )
 
       group = ref!(
-        :Type => :XObject,
-        :Subtype => :Form,
-        :BBox => state.page.dimensions,
-        :Group => group_attrs
+        Type: :XObject,
+        Subtype: :Form,
+        BBox: state.page.dimensions,
+        Group: group_attrs
       )
 
       state.page.stamp_stream(group, &block)
 
       mask = ref!(
-        :Type => :Mask,
-        :S => :Luminosity,
-        :G => group
+        Type: :Mask,
+        S: :Luminosity,
+        G: group
       )
 
       g_state = ref!(
-        :Type => :ExtGState,
-        :SMask => mask,
+        Type: :ExtGState,
+        SMask: mask,
 
-        :AIS => false,
-        :BM => :Normal,
-        :OP => false,
-        :op => false,
-        :OPM => 1,
-        :SA => true
+        AIS: false,
+        BM: :Normal,
+        OP: false,
+        op: false,
+        OPM: 1,
+        SA: true
       )
 
       registry_key = {
-        :bbox => state.page.dimensions,
-        :mask => [group.stream.filters.normalized, group.stream.filtered_stream],
-        :page => state.page_count
+        bbox: state.page.dimensions,
+        mask: [group.stream.filters.normalized, group.stream.filtered_stream],
+        page: state.page_count
       }.hash
 
       if soft_mask_registry[registry_key]

data/lib/prawn/stamp.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # stamp.rb : Implements a repeatable stamp
 #
 # Copyright October 2009, Daniel Nelson. All Rights Reserved.
@@ -92,9 +90,9 @@ module Prawn
     end
 
     def stamp_dictionary(name)
-      fail Prawn::Errors::InvalidName if name.empty?
+      raise Prawn::Errors::InvalidName if name.empty?
       if stamp_dictionary_registry[name].nil?
-        fail Prawn::Errors::UndefinedObjectName
+        raise Prawn::Errors::UndefinedObjectName
       end
 
       dict = stamp_dictionary_registry[name]
@@ -105,20 +103,26 @@ module Prawn
     end
 
     def create_stamp_dictionary(name)
-      fail Prawn::Errors::InvalidName if name.empty?
-      fail Prawn::Errors::NameTaken unless stamp_dictionary_registry[name].nil?
+      raise Prawn::Errors::InvalidName if name.empty?
+      raise Prawn::Errors::NameTaken unless stamp_dictionary_registry[name].nil?
       # BBox origin is the lower left margin of the page, so we need
       # it to be the full dimension of the page, or else things that
       # should appear near the top or right margin are invisible
-      dictionary = ref!(:Type    => :XObject,
-                        :Subtype => :Form,
-                        :BBox    => [0, 0,
-                                     state.page.dimensions[2], state.page.dimensions[3]])
+      dictionary = ref!(
+        Type: :XObject,
+        Subtype: :Form,
+        BBox: [
+          0, 0,
+          state.page.dimensions[2], state.page.dimensions[3]
+        ]
+      )
 
       dictionary_name = "Stamp#{next_stamp_dictionary_id}"
 
-      stamp_dictionary_registry[name] = { :stamp_dictionary_name => dictionary_name,
-                                          :stamp_dictionary      => dictionary }
+      stamp_dictionary_registry[name] = {
+        stamp_dictionary_name: dictionary_name,
+        stamp_dictionary: dictionary
+      }
       dictionary
     end
 

data/lib/prawn/text.rb

@@ -1,17 +1,15 @@
-# encoding: utf-8
-
 # text.rb : Implements PDF text primitives
 #
 # Copyright May 2008, Gregory Brown. All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require "zlib"
+require 'zlib'
 
-require "pdf/core/text"
+require 'pdf/core/text'
 
-require_relative "text/formatted"
-require_relative "text/box"
+require_relative 'text/formatted'
+require_relative 'text/box'
 
 module Prawn
   module Text
@@ -19,11 +17,11 @@ module Prawn
     include Prawn::Text::Formatted
 
     # No-Break Space
-    Prawn::Text::NBSP = " "
+    NBSP = "\u00A0".freeze
     # Zero Width Space (indicate word boundaries without a space)
-    Prawn::Text::ZWSP = [8203].pack("U")
+    ZWSP = "\u200B".freeze
     # Soft Hyphen (invisible, except when causing a line break)
-    Prawn::Text::SHY = "­"
+    SHY = "\u00AD".freeze
 
     # @group Stable API
 
@@ -139,9 +137,9 @@ module Prawn
     #                       each line is included below the last line;
     #                       otherwise, document.y is placed just below the
     #                       descender of the last line printed [true]
-    # <tt>:mode</tt>:: The text rendering mode to use. Use this to specify if the
-    #                  text should render with the fill color, stroke color or
-    #                  both. See the comments to text_rendering_mode() to see
+    # <tt>:mode</tt>:: The text rendering mode to use. Use this to specify if
+    #                  the text should render with the fill color, stroke color
+    #                  or both. See the comments to text_rendering_mode() to see
     #                  a list of valid options. [0]
     #
     # == Exceptions
@@ -156,12 +154,13 @@ module Prawn
       # we modify the options. don't change the user's hash
       options = options.dup
 
-      if p = options[:inline_format]
+      p = options[:inline_format]
+      if p
         p = [] unless p.is_a?(Array)
         options.delete(:inline_format)
-        array = self.text_formatter.format(string, *p)
+        array = text_formatter.format(string, *p)
       else
-        array = [{ :text => string }]
+        array = [{ text: string }]
       end
 
       formatted_text(array, options)
@@ -190,14 +189,15 @@ module Prawn
     def formatted_text(array, options = {})
       options = inspect_options_for_text(options.dup)
 
-      if color = options.delete(:color)
+      color = options.delete(:color)
+      if color
         array = array.map do |fragment|
-          fragment[:color] ? fragment : fragment.merge(:color => color)
+          fragment[:color] ? fragment : fragment.merge(color: color)
         end
       end
 
       if @indent_paragraphs
-        self.text_formatter.array_paragraphs(array).each do |paragraph|
+        text_formatter.array_paragraphs(array).each do |paragraph|
           remaining_text = draw_indented_formatted_line(paragraph, options)
 
           if @no_text_printed
@@ -208,8 +208,10 @@ module Prawn
             end
           end
 
-          remaining_text = fill_formatted_text_box(remaining_text, options)
-          draw_remaining_formatted_text_on_new_pages(remaining_text, options)
+          unless @all_text_printed
+            remaining_text = fill_formatted_text_box(remaining_text, options)
+            draw_remaining_formatted_text_on_new_pages(remaining_text, options)
+          end
         end
       else
         remaining_text = fill_formatted_text_box(array, options)
@@ -236,7 +238,8 @@ module Prawn
     # == Rotation
     #
     # Text can be rotated before it is placed on the canvas by specifying the
-    # <tt>:rotate</tt> option with a given angle. Rotation occurs counter-clockwise.
+    # <tt>:rotate</tt> option with a given angle. Rotation occurs
+    # counter-clockwise.
     #
     # == Encoding
     #
@@ -253,7 +256,8 @@ module Prawn
     #
     # == Options (default values marked in [])
     #
-    # <tt>:at</tt>:: <tt>[x, y]</tt>(required). The position at which to start the text
+    # <tt>:at</tt>:: <tt>[x, y]</tt>(required). The position at which to start
+    #                the text
     # <tt>:kerning</tt>:: <tt>boolean</tt>. Whether or not to use kerning (if it
     #                     is available with the current font)
     #                     [value of default_kerning?]
@@ -317,7 +321,7 @@ module Prawn
     # any text
     #
     def height_of(string, options = {})
-      height_of_formatted([{ :text => string }], options)
+      height_of_formatted([{ text: string }], options)
     end
 
     # Gets height of formatted text in PDF points.
@@ -332,15 +336,15 @@ module Prawn
     #
     def height_of_formatted(array, options = {})
       if options[:indent_paragraphs]
-        fail NotImplementedError, ":indent_paragraphs option not available" \
-          "with height_of"
+        raise NotImplementedError, ':indent_paragraphs option not available' \
+          'with height_of'
       end
       process_final_gap_option(options)
       box = Text::Formatted::Box.new(
         array,
-        options.merge(:height => 100000000, :document => self)
+        options.merge(height: 100_000_000, document: self)
       )
-      box.render(:dry_run => true)
+      box.render(dry_run: true)
 
       height = box.height
       height += box.line_gap + box.leading if @final_gap
@@ -350,7 +354,7 @@ module Prawn
     private
 
     def draw_remaining_formatted_text_on_new_pages(remaining_text, options)
-      while remaining_text.length > 0
+      until remaining_text.empty?
         @bounding_box.move_past_bottom
         previous_remaining_text = remaining_text
         remaining_text = fill_formatted_text_box(remaining_text, options)
@@ -359,14 +363,14 @@ module Prawn
     end
 
     def draw_indented_formatted_line(string, options)
-      if options.fetch(:direction, text_direction) == :ltr
-        gap = [@indent_paragraphs, 0]
-      else
-        gap = [0, @indent_paragraphs]
-      end
+      gap = if options.fetch(:direction, text_direction) == :ltr
+              [@indent_paragraphs, 0]
+            else
+              [0, @indent_paragraphs]
+            end
 
       indent(*gap) do
-        fill_formatted_text_box(string, options.dup.merge(:single_line => true))
+        fill_formatted_text_box(string, options.dup.merge(single_line: true))
       end
     end
 
@@ -384,22 +388,28 @@ module Prawn
     end
 
     def merge_text_box_positioning_options(options)
-      bottom = @bounding_box.stretchy? ? @margin_box.absolute_bottom :
-                                         @bounding_box.absolute_bottom
+      bottom =
+        if @bounding_box.stretchy?
+          @margin_box.absolute_bottom
+        else
+          @bounding_box.absolute_bottom
+        end
 
       options[:height] = y - bottom
       options[:width] = bounds.width
-      options[:at] = [@bounding_box.left_side - @bounding_box.absolute_left,
-                      y - @bounding_box.absolute_bottom]
+      options[:at] = [
+        @bounding_box.left_side - @bounding_box.absolute_left,
+        y - @bounding_box.absolute_bottom
+      ]
     end
 
     def inspect_options_for_draw_text(options)
       if options[:at].nil?
-        fail ArgumentError, "The :at option is required for draw_text"
+        raise ArgumentError, 'The :at option is required for draw_text'
       elsif options[:align]
-        fail ArgumentError, "The :align option does not work with draw_text"
+        raise ArgumentError, 'The :align option does not work with draw_text'
       end
-      if options[:kerning].nil? then
+      if options[:kerning].nil?
         options[:kerning] = default_kerning?
       end
       valid_options = PDF::Core::Text::VALID_OPTIONS + [:at, :rotate]
@@ -409,8 +419,8 @@ module Prawn
 
     def inspect_options_for_text(options)
       if options[:at]
-        fail ArgumentError, ":at is no longer a valid option with text." \
-                             "use draw_text or text_box instead"
+        raise ArgumentError, ':at is no longer a valid option with text.' \
+                             'use draw_text or text_box instead'
       end
       process_final_gap_option(options)
       process_indent_paragraphs_option(options)
@@ -429,8 +439,12 @@ module Prawn
     end
 
     def move_text_position(dy)
-      bottom = @bounding_box.stretchy? ? @margin_box.absolute_bottom :
-                                         @bounding_box.absolute_bottom
+      bottom =
+        if @bounding_box.stretchy?
+          @margin_box.absolute_bottom
+        else
+          @bounding_box.absolute_bottom
+        end
 
       @bounding_box.move_past_bottom if (y - dy) < bottom