hexapdf 0.6.0 → 0.7.0

data/lib/hexapdf/encryption/ruby_arc4.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -70,8 +70,8 @@ module HexaPDF
         end
         result
       end
-      alias :decrypt :process
-      alias :encrypt :process
+      alias decrypt process
+      alias encrypt process
 
       private
 

data/lib/hexapdf/encryption/security_handler.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -144,12 +144,12 @@ module HexaPDF
         # Creates a new encrypted stream data object by utilizing the given stream data object as
         # template. The arguments +key+ and +algorithm+ are used for decrypting purposes.
         def initialize(obj, key, algorithm)
-          obj.instance_variables.each {|v| instance_variable_set(v, obj.instance_variable_get(v))}
+          obj.instance_variables.each {|v| instance_variable_set(v, obj.instance_variable_get(v)) }
           @key = key
           @algorithm = algorithm
         end
 
-        alias :undecrypted_fiber :fiber
+        alias undecrypted_fiber fiber
 
         # Returns a fiber like HexaPDF::StreamData#fiber, but one wrapped in a decrypting fiber.
         def fiber(*args)
@@ -215,7 +215,6 @@ module HexaPDF
         handler.freeze
       end
 
-
       # A hash containing information about the used encryption. This information is only
       # available once the security handler has been set up for decryption or encryption.
       #
@@ -310,11 +309,11 @@ module HexaPDF
       #   The encryption algorithm. Possible values are :arc4 for ARC4 encryption with key lengths
       #   of 40 to 128 bit or :aes for AES encryption with key lengths of 128 or 256 bit.
       #
-      # force_V4::
+      # force_v4::
       #   Forces the use of protocol version 4 when key_length=128 and algorithm=:arc4.
       #
       # See: PDF1.7 s7.6.1, PDF2.0 s7.6.1
-      def set_up_encryption(key_length: 128, algorithm: :aes, force_V4: false, **options)
+      def set_up_encryption(key_length: 128, algorithm: :aes, force_v4: false, **options)
         @dict = document.wrap({}, type: encryption_dictionary_class)
 
         dict[:V] =
@@ -324,7 +323,7 @@ module HexaPDF
           when 48, 56, 64, 72, 80, 88, 96, 104, 112, 120
             2
           when 128
-            (algorithm == :aes || force_V4 ? 4 : 2)
+            (algorithm == :aes || force_v4 ? 4 : 2)
           when 256
             5
           else
@@ -473,8 +472,8 @@ module HexaPDF
         key = encryption_key
         return key if dict[:V] == 5
 
-        key += [oid, gen].pack('VXv'.freeze)
-        key << "sAlT".freeze if algorithm.ancestors.include?(AES)
+        key += [oid, gen].pack('VXv')
+        key << "sAlT" if algorithm.ancestors.include?(AES)
         n_plus_5 = key_length + 5
         Digest::MD5.digest(key)[0, (n_plus_5 > 16 ? 16 : n_plus_5)]
       end
@@ -508,9 +507,9 @@ module HexaPDF
       def each_string_in_object(obj, &block) # :yields: str
         case obj
         when Hash
-          obj.each_value {|val| each_string_in_object(val, &block)}
+          obj.each_value {|val| each_string_in_object(val, &block) }
         when Array
-          obj.each {|inner_o| each_string_in_object(inner_o, &block)}
+          obj.each {|inner_o| each_string_in_object(inner_o, &block) }
         when String
           yield(obj)
         end

data/lib/hexapdf/encryption/standard_security_handler.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -78,7 +78,6 @@ module HexaPDF
 
     end
 
-
     # The password-based standard security handler of the PDF specification, identified by a
     # /Filter value of /Standard.
     #
@@ -99,7 +98,6 @@ module HexaPDF
     # See: PDF1.7 s7.6.3, PDF2.0 s7.6.3
     class StandardSecurityHandler < SecurityHandler
 
-
       # Defines all available permissions.
       #
       # It is possible to use an array of permission symbols instead of an integer to describe the
@@ -168,7 +166,6 @@ module HexaPDF
 
       end
 
-
       # Defines all possible options that can be passed to a StandardSecurityHandler when setting
       # up encryption.
       class EncryptionOptions
@@ -202,7 +199,7 @@ module HexaPDF
           @permissions = process_permissions(data.delete(:permissions) { Permissions::ALL })
           @algorithm = data.delete(:algorithm) { :arc4 }
           @encrypt_metadata = data.delete(:encrypt_metadata) { true }
-          if data.size > 0
+          unless data.empty?
             raise ArgumentError, "Invalid encryption options: #{data.keys.join(', ')}"
           end
         end
@@ -420,7 +417,7 @@ module HexaPDF
 
           data = arc4_algorithm.encrypt(key, user_password)
           if dict[:R] >= 3
-            19.times {|i| data = arc4_algorithm.encrypt(xor_key(key, i + 1), data)}
+            19.times {|i| data = arc4_algorithm.encrypt(xor_key(key, i + 1), data) }
           end
 
           data
@@ -459,7 +456,7 @@ module HexaPDF
           key = compute_user_encryption_key(password)
           data = Digest::MD5.digest(PASSWORD_PADDING + document.trailer[:ID][0])
           data = arc4_algorithm.encrypt(key, data)
-          19.times {|i| data = arc4_algorithm.encrypt(xor_key(key, i + 1), data)}
+          19.times {|i| data = arc4_algorithm.encrypt(xor_key(key, i + 1), data) }
           data << "hexapdfhexapdfhe"
         elsif dict[:R] == 6
           validation_salt = random_bytes(8)
@@ -548,7 +545,7 @@ module HexaPDF
           userpwd = arc4_algorithm.decrypt(key, dict[:O])
         else
           userpwd = dict[:O]
-          20.times {|i| userpwd = arc4_algorithm.decrypt(xor_key(key, 19 - i), userpwd)}
+          20.times {|i| userpwd = arc4_algorithm.decrypt(xor_key(key, 19 - i), userpwd) }
         end
 
         userpwd

data/lib/hexapdf/error.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -42,18 +42,16 @@ module HexaPDF
     # The byte position in the PDF file where the error occured.
     attr_reader :pos
 
-    # Creates a new malformed PDF error object for the given exception or exception message.
+    # Creates a new malformed PDF error object for the given exception message.
     #
-    # The byte position where the error occured can be given via the optional +pos+ argument.
-    def initialize(msg_or_error, pos: nil)
-      super(msg_or_error)
-      set_backtrace(msg_or_error.backtrace) if msg_or_error.kind_of?(Exception)
+    # The byte position where the error occured has to be given via the +pos+ argument.
+    def initialize(message, pos:)
+      super(message)
       @pos = pos
     end
 
     def message # :nodoc:
-      pos_msg = @pos.nil? ? '' : " around position #{pos}"
-      "PDF malformed#{pos_msg}: #{super}"
+      "PDF malformed around position #{pos}: #{super}"
     end
 
   end

data/lib/hexapdf/filter.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -52,7 +52,6 @@ module HexaPDF
 
   end
 
-
   # == Overview
   #
   # A stream filter is used to compress a stream or to encode it in an ASCII compatible way; or

data/lib/hexapdf/filter/ascii85_decode.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -149,7 +149,7 @@ module HexaPDF
               VALUE_TO_CHAR[num / POW85_2 % 85] << VALUE_TO_CHAR[num / POW85_1 % 85] <<
               VALUE_TO_CHAR[num % 85])[0, rlen + 1] << "~>").force_encoding(Encoding::BINARY)
           else
-            "~>".force_encoding(Encoding::BINARY)
+            "~>".b
           end
         end
       end

data/lib/hexapdf/filter/ascii_hex_decode.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/filter/dct_decode.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/filter/encryption.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/filter/flate_decode.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -45,45 +45,24 @@ module HexaPDF
     # See: HexaPDF::Filter, PDF1.7 s7.4.4
     module FlateDecode
 
-      class Pool #:nodoc:
-
-        # Creates a new Zlib::Stream pool. A block must be given that returns a new Zlib::Stream
-        # instance.
-        def initialize(&block)
-          @creator = block
-          @pool = []
-        end
-
-        # Returns the next available stream of the pool, already reset to its initial state.
-        def next_available
-          @pool.find(-> { e = @creator.call; @pool << e; e }, &:finished?).tap(&:reset)
-        end
-
-      end
-
-      @inflate_pool = Pool.new { Zlib::Inflate.new }
-      @deflate_pool = Pool.new do
-        Zlib::Deflate.new(HexaPDF::GlobalConfiguration['filter.flate_compression'],
-                          Zlib::MAX_WBITS,
-                          HexaPDF::GlobalConfiguration['filter.flate_memory'])
-      end
-
       # See HexaPDF::Filter
       def self.decoder(source, options = nil)
         fib = Fiber.new do
-          inflater = @inflate_pool.next_available
+          inflater = Zlib::Inflate.new
           while source.alive? && (data = source.resume)
             begin
               data = inflater.inflate(data)
-            rescue
-              raise FilterError, "Problem while decoding Flate encoded stream: #{$!}"
+            rescue StandardError => e
+              raise FilterError, "Problem while decoding Flate encoded stream: #{e}"
             end
             Fiber.yield(data)
           end
           begin
-            (data = inflater.finish).empty? ? nil : data
-          rescue
-            raise FilterError, "Problem while decoding Flate encoded stream: #{$!}"
+            data = (data = inflater.finish).empty? ? nil : data
+            inflater.close
+            data
+          rescue StandardError => e
+            raise FilterError, "Problem while decoding Flate encoded stream: #{e}"
           end
         end
 
@@ -101,12 +80,16 @@ module HexaPDF
         end
 
         Fiber.new do
-          deflater = @deflate_pool.next_available
+          deflater = Zlib::Deflate.new(HexaPDF::GlobalConfiguration['filter.flate_compression'],
+                                       Zlib::MAX_WBITS,
+                                       HexaPDF::GlobalConfiguration['filter.flate_memory'])
           while source.alive? && (data = source.resume)
             data = deflater.deflate(data)
             Fiber.yield(data)
           end
-          deflater.finish
+          data = deflater.finish
+          deflater.close
+          data
         end
       end
 

data/lib/hexapdf/filter/jpx_decode.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as

data/lib/hexapdf/filter/lzw_decode.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -52,12 +52,12 @@ module HexaPDF
       EOD = 257 # :nodoc:
 
       INITIAL_ENCODER_TABLE = {} #:nodoc:
-      0.upto(255) {|i| INITIAL_ENCODER_TABLE[i.chr.freeze] = i}
+      0.upto(255) {|i| INITIAL_ENCODER_TABLE[i.chr.freeze] = i }
       INITIAL_ENCODER_TABLE[CLEAR_TABLE] = CLEAR_TABLE
       INITIAL_ENCODER_TABLE[EOD] = EOD
 
       INITIAL_DECODER_TABLE = {} #:nodoc:
-      0.upto(255) {|i| INITIAL_DECODER_TABLE[i] = i.chr}
+      0.upto(255) {|i| INITIAL_DECODER_TABLE[i] = i.chr }
       INITIAL_DECODER_TABLE[CLEAR_TABLE] = CLEAR_TABLE
       INITIAL_DECODER_TABLE[EOD] = EOD
 

data/lib/hexapdf/filter/predictor.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding: utf-8; frozen_string_literal: true -*-
 #
 #--
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2017 Thomas Leitner
+# Copyright (C) 2014-2018 Thomas Leitner
 #
 # HexaPDF is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Affero General Public License version 3 as
@@ -161,8 +161,6 @@ module HexaPDF
             line = data[pos + 1, bytes_per_row - 1]
 
             case data.getbyte(pos)
-            when PREDICTOR_PNG_NONE
-              # nothing to do
             when PREDICTOR_PNG_SUB
               bytes_per_pixel.upto(bytes_per_row - 2) do |i|
                 line.setbyte(i, line.getbyte(i) + line.getbyte(i - bytes_per_pixel))
@@ -202,8 +200,6 @@ module HexaPDF
             next_last_line = line.dup
 
             case predictor
-            when PREDICTOR_PNG_NONE
-              # nothing to do
             when PREDICTOR_PNG_SUB
               bytes_per_row.downto(bytes_per_pixel + 1) do |i|
                 line.setbyte(i, line.getbyte(i) - line.getbyte(i - bytes_per_pixel))