hexapdf 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44eb3afec42bc0c5e0645c0ff6eb48f211083694866fb7c355a0b4ca3e3ad24a
-  data.tar.gz: 864792c029e975b0d8167d80326815ea6a7ebff90bc360c4d550c8a2d4a28003
+  metadata.gz: 7a94d8744657f89cf855604bdb363426637190a5db9615bbcb78e033f9aa5b0f
+  data.tar.gz: b5ea3789c402ce1affb937eca574aba6c3cd21864484f56015aa2aef4acb9b86
 SHA512:
-  metadata.gz: 19d415762cb49abfaf31df0d6dc8455c5a6a8b1eee40f18cc4d56b7a18e4d9e9aded8d5826a4f5a265bbc639d61f5a2fe081b1e672b626984d4be719115f4c9a
-  data.tar.gz: 6c8d31294566e9c408cb0fe8512ca4898d583edebe750191fda6d42fcb0a6cb44d83de90359abcac6cca1cf7b47f38e3515b5c94246456b485091d3d72c0be5c
+  metadata.gz: 6c7a881cc83213116e3f818c4df6063a9ebc758fe79d4120e5163d7bd78509ad358a32c122db0ffdfd6b1def50a6ec53a83e429ece1355aff02751b3a886e9a3
+  data.tar.gz: eb82b47d523c96403fd64afcbd5a3a867b74e059890819c816dadd71b8fac0595a431c9ff926dea8a45c2d949e8802fa9a2dccb776a24acb04922f677cac2b66

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## 1.0.1 - 2024-11-05
+## 1.0.3 - 2024-12-04
+
+### Fixed
+
+* Offsets and lengths of revisions shown using the `inspect rev` CLI command for
+  linearized PDF files
+* [HexaPDF::Type::AcroForm::Form#recalculate_fields] to only consider real
+  fields
+
+
+## 1.0.2 - 2024-11-05
 
 ### Added
 

data/lib/hexapdf/cli/inspect.rb

@@ -395,9 +395,12 @@ module HexaPDF
         end
         io = @doc.revisions.parser.io
 
-        startxrefs = @doc.revisions.map {|rev| rev.trailer[:Prev] }
         io.seek(0, IO::SEEK_END)
-        startxrefs.push(@doc.revisions.parser.startxref_offset, io.pos).shift
+        startxrefs = @doc.revisions.map {|rev| rev.trailer[:Prev] } <<
+                     @doc.revisions.parser.startxref_offset <<
+                     io.pos
+        startxrefs.sort!
+        startxrefs.shift
 
         @doc.revisions.each_with_index.map do |rev, index|
           end_index = 0

data/lib/hexapdf/encryption/arc4.rb

@@ -66,14 +66,14 @@ module HexaPDF
         # Encrypts the given +data+ with the +key+.
         #
         # See: PDF2.0 s7.6.3
-        def encrypt(key, data)
+        def encrypt(key, data, &_block)
           new(key).process(data)
         end
         alias decrypt encrypt
 
         # Returns a Fiber object that encrypts the data from the given source fiber with the
         # +key+.
-        def encryption_fiber(key, source)
+        def encryption_fiber(key, source, &_block)
           Fiber.new do
             algorithm = new(key)
             while source.alive? && (data = source.resume)

data/lib/hexapdf/test_utils.rb

@@ -92,8 +92,9 @@ module HexaPDF
     # Creates a fiber that yields the given string in +len+ length parts.
     def feeder(string, len = string.length)
       Fiber.new do
+        string = string.b
         until string.empty?
-          Fiber.yield(string.slice!(0, len).force_encoding('BINARY'))
+          Fiber.yield(string.slice!(0, len))
         end
       end
     end

data/lib/hexapdf/type/acro_form/form.rb

@@ -517,7 +517,7 @@ module HexaPDF
         #
         # See: JavaScriptActions
         def recalculate_fields
-          self[:CO]&.each do |field|
+          (each_field.to_a & self[:CO].to_a).each do |field|
             field = Field.wrap(document, field)
             next unless field && (calculation_action = field[:AA]&.[](:C))
             result = JavaScriptActions.calculate(self, calculation_action)

data/lib/hexapdf/version.rb

@@ -37,6 +37,6 @@
 module HexaPDF
 
   # The version of HexaPDF.
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 
 end

data/test/hexapdf/common_tokenizer_tests.rb

@@ -65,7 +65,7 @@ module CommonTokenizerTests
       :'The_Key_of_F#_Minor', :AB, :"",
       '[', 5, 6, :Name, ']', '[', 5, 6, :Name, ']',
       '<<', :Name, 5, '>>'
-    ].each {|t| t.force_encoding('BINARY') if t.respond_to?(:force_encoding) }
+    ].map {|t| t.respond_to?(:force_encoding) ? t.b : t }
 
     until expected_tokens.empty?
       expected_token = expected_tokens.shift
@@ -127,7 +127,7 @@ module CommonTokenizerTests
   end
 
   it "next_token: should not fail when reading super long numbers" do
-    create_tokenizer("1" << "0" * 10_000)
+    create_tokenizer("1" + "0" * 10_000)
     assert_equal(10**10_000, @tokenizer.next_token)
   end
 
@@ -182,7 +182,7 @@ module CommonTokenizerTests
   end
 
   it "returns the correct position on operations" do
-    create_tokenizer("hallo du" << " " * 50000 << "hallo du")
+    create_tokenizer("hallo du" + " " * 50000 + "hallo du")
     @tokenizer.next_token
     assert_equal(5, @tokenizer.pos)
 

data/test/hexapdf/encryption/common.rb

@@ -67,7 +67,7 @@ module ARC4EncryptionTests
     super
     @encrypted = ['BBF316E8D940AF0AD3', '1021BF0420', '45A01F645FC35B383552544B9BF5'].
       map {|c| [c].pack('H*') }
-    @plain = ['Plaintext', 'pedia', 'Attack at dawn'].each {|s| s.force_encoding('BINARY') }
+    @plain = ['Plaintext'.b, 'pedia'.b, 'Attack at dawn'.b]
     @keys = ['Key', 'Wiki', 'Secret']
   end
 

data/test/hexapdf/encryption/test_aes.rb

@@ -141,7 +141,7 @@ describe HexaPDF::Encryption::AES do
         collector(@algorithm_class.decryption_fiber('some' * 4, Fiber.new { 'a' * 40 }))
       end
       assert_raises(HexaPDF::EncryptionError) do
-        collector(@algorithm_class.decryption_fiber('some' * 4, Fiber.new { 'a' * 40 })) { true }
+        collector(@algorithm_class.decryption_fiber('some' * 4, Fiber.new { 'a' * 40 }) { true })
       end
     end
   end

data/test/hexapdf/encryption/test_arc4.rb

@@ -11,13 +11,13 @@ describe HexaPDF::Encryption::ARC4 do
       prepend HexaPDF::Encryption::ARC4
 
       def initialize(key)
-        @data = key
+        @data = +key
       end
 
       def process(data)
         raise if data.empty?
         result = @data << data
-        @data = ''
+        @data = +''
         result
       end
     end

data/test/hexapdf/encryption/test_security_handler.rb

@@ -236,7 +236,7 @@ describe HexaPDF::Encryption::SecurityHandler do
         dict[:Filter] = :Test
         @enc.strf = alg
         @enc.set_up_encryption(key_length: length, algorithm: (alg == :identity ? :aes : alg))
-        @obj[:X] = @enc.encrypt_string('data', @obj)
+        @obj[:X] = @enc.encrypt_string(+'data', @obj)
         @handler.set_up_decryption(dict)
         assert_equal('data', @handler.decrypt(@obj)[:X])
       end

data/test/hexapdf/filter/test_ascii85_decode.rb

@@ -33,7 +33,7 @@ describe HexaPDF::Filter::ASCII85Decode do
     end
 
     it "ignores data after the EOD marker" do
-      assert_equal(@decoded, collector(@obj.decoder(feeder(@encoded << "~>abcdefg"))))
+      assert_equal(@decoded, collector(@obj.decoder(feeder(@encoded + "~>abcdefg"))))
     end
 
     it "fails if the input contains invalid characters" do

data/test/hexapdf/filter/test_ascii_hex_decode.rb

@@ -24,7 +24,7 @@ describe HexaPDF::Filter::ASCIIHexDecode do
     end
 
     it "ignores data after the EOD marker" do
-      assert_equal(@decoded, collector(@obj.decoder(feeder(@encoded << '4e6f7gzz'))))
+      assert_equal(@decoded, collector(@obj.decoder(feeder(@encoded + '4e6f7gzz'))))
     end
 
     it "assumes the missing char is '0' if the input length is odd" do

data/test/hexapdf/filter/test_flate_decode.rb

@@ -8,11 +8,10 @@ describe HexaPDF::Filter::FlateDecode do
 
   before do
     @obj = HexaPDF::Filter::FlateDecode
-    @all_test_cases = [["abcdefg".force_encoding(Encoding::BINARY),
-                        "x\xDAKLJNIMK\a\x00\n\xDB\x02\xBD".force_encoding(Encoding::BINARY)]]
+    @all_test_cases = [["abcdefg".b, "x\xDAKLJNIMK\a\x00\n\xDB\x02\xBD".b]]
     @decoded = @all_test_cases[0][0]
     @encoded = @all_test_cases[0][1]
-    @encoded_predictor = "x\xDAcJdbD@\x00\x05\x8F\x00v".force_encoding(Encoding::BINARY)
+    @encoded_predictor = "x\xDAcJdbD@\x00\x05\x8F\x00v".b
     @predictor_opts = {Predictor: 12}
   end
 

data/test/hexapdf/font/cmap/test_writer.rb

@@ -5,7 +5,7 @@ require 'hexapdf/font/cmap/writer'
 
 describe HexaPDF::Font::CMap::Writer do
   before do
-    @to_unicode_cmap_data = <<~EOF
+    @to_unicode_cmap_data = +<<~EOF
       /CIDInit /ProcSet findresource begin
       12 dict begin
       begincmap
@@ -32,7 +32,7 @@ describe HexaPDF::Font::CMap::Writer do
       end
       end
     EOF
-    @cid_cmap_data = <<~EOF
+    @cid_cmap_data = +<<~EOF
       %!PS-Adobe-3.0 Resource-CMap
       %%DocumentNeededResources: ProcSet (CIDInit)
       %%IncludeResource: ProcSet (CIDInit)

data/test/hexapdf/font/encoding/test_glyph_list.rb

@@ -32,7 +32,7 @@ describe HexaPDF::Font::Encoding::GlyphList do
 
     it "maps special uXXXX[XX] names to unicode values" do
       assert_equal("A", @list.name_to_unicode(:u0041))
-      assert_equal("" << "1F000".hex, @list.name_to_unicode(:u1F000))
+      assert_equal(+'' << "1F000".hex, @list.name_to_unicode(:u1F000))
     end
 
     it "maps Zapf Dingbats glyph names to their unicode" do

data/test/hexapdf/font/test_true_type_wrapper.rb

@@ -51,7 +51,7 @@ describe HexaPDF::Font::TrueTypeWrapper do
       glyphs = @font_wrapper.decode_utf8("😁")
       assert_equal(1, glyphs.length)
       assert_kind_of(HexaPDF::Font::InvalidGlyph, glyphs.first)
-      assert_equal('' << 128_513, glyphs.first.str)
+      assert_equal(+'' << 128_513, glyphs.first.str)
     end
   end
 
@@ -81,7 +81,7 @@ describe HexaPDF::Font::TrueTypeWrapper do
       glyph = @font_wrapper.glyph(9999)
       assert_kind_of(HexaPDF::Font::InvalidGlyph, glyph)
       assert_equal(0, glyph.id)
-      assert_equal('' << 0xFFFD, glyph.str)
+      assert_equal(+'' << 0xFFFD, glyph.str)
     end
   end
 

data/test/hexapdf/font/test_type1_wrapper.rb

@@ -56,7 +56,7 @@ describe HexaPDF::Font::Type1Wrapper do
       glyphs = @times_wrapper.decode_utf8("😁")
       assert_equal(1, glyphs.length)
       assert_kind_of(HexaPDF::Font::InvalidGlyph, glyphs.first)
-      assert_equal('' << 128_513, glyphs.first.str)
+      assert_equal(+'' << 128_513, glyphs.first.str)
     end
   end
 

data/test/hexapdf/task/test_merge_acro_form.rb

@@ -81,7 +81,7 @@ describe HexaPDF::Task::MergeAcroForm do
   end
 
   it "updates the /DA entries of widgets and fields" do
-    @pages[0][:Annots][0][:DA] = '/F1 10 Tf'
+    @pages[0][:Annots][0][:DA] = +'/F1 10 Tf'
     @doc.task(:merge_acro_form, source: @doc1, pages: @pages)
     field = @doc.acro_form.field_by_name('merged_1.Text')
     assert_equal('0.0 g /F2 0 Tf', field[:DA])

data/test/hexapdf/test_filter.rb

@@ -8,7 +8,7 @@ require 'tempfile'
 describe HexaPDF::Filter do
   before do
     @obj = HexaPDF::Filter
-    @str = ''
+    @str = +''
     40.times { @str << [rand(2**32)].pack('N') }
   end
 

data/test/hexapdf/test_parser.rb

@@ -11,7 +11,7 @@ describe HexaPDF::Parser do
     @document.config['parser.try_xref_reconstruction'] = false
     @document.add(@document.wrap(10, oid: 1, gen: 0))
 
-    create_parser(<<~EOF)
+    create_parser(+<<~EOF)
       %PDF-1.7
 
       1 0 obj
@@ -354,7 +354,7 @@ describe HexaPDF::Parser do
   describe "startxref_offset" do
     it "caches the offset value" do
       assert_equal(330, @parser.startxref_offset)
-      @parser.instance_eval { @io }.string.sub!(/330\n/, "309\n")
+      @parser.instance_eval { @io.string = @io.string.sub(/330\n/, "309\n") }
       assert_equal(330, @parser.startxref_offset)
     end
 
@@ -363,7 +363,7 @@ describe HexaPDF::Parser do
     end
 
     it "ignores garbage at the end of the file" do
-      create_parser("startxref\n5\n%%EOF" << "\nhallo" * 150)
+      create_parser("startxref\n5\n%%EOF" + "\nhallo" * 150)
       assert_equal(5, @parser.startxref_offset)
     end
 
@@ -373,17 +373,17 @@ describe HexaPDF::Parser do
     end
 
     it "finds the startxref anywhere in file" do
-      create_parser("startxref\n5\n%%EOF" << "\nhallo" * 5000)
+      create_parser("startxref\n5\n%%EOF" + "\nhallo" * 5000)
       assert_equal(5, @parser.startxref_offset)
     end
 
     it "handles the case where %%EOF is the on the 1. line of the 1024 byte search block" do
-      create_parser("startxref\n5\n%%EOF\n" << "h" * 1018)
+      create_parser("startxref\n5\n%%EOF\n" + "h" * 1018)
       assert_equal(5, @parser.startxref_offset)
     end
 
     it "handles the case where %%EOF is the on the 2. line of the 1024 byte search block" do
-      create_parser("startxref\n5\n%%EOF\n" << "h" * 1017)
+      create_parser("startxref\n5\n%%EOF\n" + "h" * 1017)
       assert_equal(5, @parser.startxref_offset)
     end
 
@@ -421,7 +421,7 @@ describe HexaPDF::Parser do
 
     it "fails on strict parsing if the startxref is not in the last part of the file" do
       @document.config['parser.on_correctable_error'] = proc { true }
-      create_parser("startxref\n5\n%%EOF" << "\nhallo" * 5000)
+      create_parser("startxref\n5\n%%EOF" + "\nhallo" * 5000)
       exp = assert_raises(HexaPDF::MalformedPDFError) { @parser.startxref_offset }
       assert_match(/end-of-file marker not found/, exp.message)
     end
@@ -459,7 +459,7 @@ describe HexaPDF::Parser do
     end
 
     it "ignores junk at the beginning of the file and correctly calculates offset" do
-      create_parser("junk" * 200 << "\n%PDF-1.4\n")
+      create_parser("junk" * 200 + "\n%PDF-1.4\n")
       assert_equal('1.4', @parser.file_header_version)
       assert_equal(801, @parser.instance_variable_get(:@header_offset))
     end
@@ -670,13 +670,13 @@ describe HexaPDF::Parser do
     end
 
     it "handles cases where the line contains an invalid string that exceeds the read buffer" do
-      create_parser("(1" << "(abc" * 32188 << "\n1 0 obj\n6\nendobj\ntrailer\n<</Size 1>>")
+      create_parser("(1" + "(abc" * 32188 + "\n1 0 obj\n6\nendobj\ntrailer\n<</Size 1>>")
       assert_equal(6, @parser.load_object(@xref).value)
     end
 
     it "handles pathalogical cases which contain many opened literal strings" do
       time = Time.now
-      create_parser("(1" << "(abc\n" * 10000 << "\n1 0 obj\n6\nendobj\ntrailer\n<</Size 1>>")
+      create_parser("(1" + "(abc\n" * 10000 + "\n1 0 obj\n6\nendobj\ntrailer\n<</Size 1>>")
       assert_equal(6, @parser.load_object(@xref).value)
       assert(Time.now - time < 0.5, "Xref reconstruction takes too long")
     end

data/test/hexapdf/test_revisions.rb

@@ -359,7 +359,7 @@ describe HexaPDF::Revisions do
 
   describe "linearzied PDFs" do
     before  do
-      @io = StringIO.new(<<~EOF)
+      @io = StringIO.new(+<<~EOF)
         %PDF-1.2
         5 0 obj
         <</Linearized 1>>

data/test/hexapdf/test_serializer.rb

@@ -88,7 +88,7 @@ describe HexaPDF::Serializer do
     assert_serialized('/The_Key_of_F#23_Minor', :'The_Key_of_F#_Minor')
     assert_serialized('/ ', :"")
     assert_serialized('/H#c3#b6#c3#9fgang', :Hößgang)
-    assert_serialized('/H#e8lp', "H\xE8lp".force_encoding('BINARY').intern)
+    assert_serialized('/H#e8lp', "H\xE8lp".b.intern)
     assert_serialized('/#00#09#0a#0c#0d#20', :"\x00\t\n\f\r ")
   end
 
@@ -105,8 +105,7 @@ describe HexaPDF::Serializer do
   it "serializes strings" do
     assert_serialized("(Hallo)", "Hallo")
     assert_serialized("(Hallo\\r\n\t\\(\\)\\\\)", "Hallo\r\n\t()\\")
-    assert_serialized("(\xFE\xFF\x00H\x00a\x00l\x00\f\x00\b\x00\\()".force_encoding('BINARY'),
-                      "Hal\f\b(")
+    assert_serialized("(\xFE\xFF\x00H\x00a\x00l\x00\f\x00\b\x00\\()".b, "Hal\f\b(")
   end
 
   it "serializes time like objects" do

data/test/hexapdf/test_tokenizer.rb

@@ -38,7 +38,7 @@ describe HexaPDF::Tokenizer do
   end
 
   it "next_token: should not fail for strings due to use of an internal buffer" do
-    create_tokenizer("(" << ("a" * 8189) << "\\006)")
+    create_tokenizer("(" + ("a" * 8189) + "\\006)")
     assert_equal("a" * 8189 << "\x06", @tokenizer.next_token)
   end
 

data/test/hexapdf/test_writer.rb

@@ -98,7 +98,7 @@ describe HexaPDF::Writer do
   def assert_document_conversion(input_io)
     document = HexaPDF::Document.new(io: input_io)
     document.trailer.info[:Producer] = "unknown"
-    output_io = StringIO.new(''.force_encoding(Encoding::BINARY))
+    output_io = StringIO.new(''.b)
     start_xref_offset, xref_section = HexaPDF::Writer.write(document, output_io)
     assert_kind_of(HexaPDF::XRefSection, xref_section)
     assert_kind_of(Integer, start_xref_offset)
@@ -206,7 +206,7 @@ describe HexaPDF::Writer do
 
   it "doesn't create an xref stream if one was just used for an XRefStm entry" do
     # The following document's structure is built like a typical MS Word created PDF
-    input = StringIO.new(<<~EOF.force_encoding(Encoding::BINARY))
+    input = StringIO.new(<<~EOF.b)
       %PDF-1.2
       %\xCF\xEC\xFF\xE8\xD7\xCB\xCD
       1 0 obj

data/test/hexapdf/type/acro_form/test_form.rb

@@ -494,6 +494,14 @@ describe HexaPDF::Type::AcroForm::Form do
       @acro_form.recalculate_fields
       assert_equal("10", @text3.field_value)
     end
+
+    it "ensures that only entries in /CO that are actually fields are used" do
+      @text1.field_value = "10"
+      @text3.set_calculate_action(:sfn, fields: 'text1')
+      @acro_form[:CO] = [nil, 5, [:some, :array], @doc.pages.root, @text3]
+      @acro_form.recalculate_fields
+      assert_equal("10", @text3.field_value)
+    end
   end
 
   describe "perform_validation" do

data/test/hexapdf/type/test_image.rb

@@ -171,7 +171,7 @@ describe HexaPDF::Type::Image do
 
     def assert_valid_png(filename, original = nil)
       if PNG_CHECK_AVAILABLE
-        result = `pngcheck -q #{filename}`
+        result = `pngcheck -q #{filename} 2>/dev/null`
         assert(result.empty?, "pngcheck error: #{result}")
       else
         skip("Skipping PNG output validity check because pngcheck executable is missing")

data/test/hexapdf/type/test_page_tree_node.rb

@@ -326,9 +326,9 @@ describe HexaPDF::Type::PageTreeNode do
       assert(@root.validate(auto_correct: false) {|m, _| p m })
 
       @doc.delete(@pages[3])
-      refute(@root.validate(auto_correct: false)) do |msg, _|
+      refute(@root.validate(auto_correct: false) do |msg, _|
         assert_match(/invalid object/i, msg)
-      end
+      end)
       assert(@root.validate)
       assert_equal(2, @kid12[:Count])
       assert_equal([@pages[2], @pages[4]], @kid12[:Kids].value)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse