hexapdf 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fdace78c8d34d39c345e2ccd04edda4755e2fc8076cc7320793a4ef16f48520
-  data.tar.gz: a0ec03dc2d579eb8663512ec0c84cadbc877b9ec43cabb8ea0d6ab58df337585
+  metadata.gz: 139f1864e4decd05c57468dc3b326a9cc4e749f1d35d4b5dadb3e0549215afd6
+  data.tar.gz: e7a0d34979abe6738a084dec2334f449ebc1db3eb479dd5f2374a81eeabd83d7
 SHA512:
-  metadata.gz: a8b18782359af03f0eda710658d0839554f0e95cd8068683dcaea56e8493c3b8a0b4cc30c9e39a3fdbe743df4d5e34b84ce4ab27125c8c14300b861ecbff16e9
-  data.tar.gz: 8d5c60a368d85fa9c2b118d955933943f5d0cf79e91d744348cf1e3f1c9435d44880033c844b58ab098c8ab8d1e2e7cd4c5e04710133b25543f31457277d0ba2
+  metadata.gz: 339c38737585eafdf447f7516a52ba7ce40b7e2e476336a2404e97a97645d5043b2956835d874296841b8b68d5935c53d97244ac90a2fd621d0471ce85ae8809
+  data.tar.gz: 4a4c843a32859c639fdf724ca1c6492fa3d387a1c8a92335a2341e82de42a5b9bc30663a3226c1cc0f2ca116dd638071e24b595b323e64fa1e0342d8681199bd

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.30.0 - 2023-01-13
+
+### Added
+
+* [HexaPDF::Document::Pages#create] for creating a page object without adding it
+  to the page tree
+
+### Changed
+
+* `HexaPDF::Type::FontSimple#perform_validation` to correct /Widths fields in
+  case it has an invalid number of entries
+
+### Fixed
+
+* [HexaPDF::DictionaryFields::DateConverter] to handle invalid months, day,
+  hour, minute and second values
+
+
 ## 0.29.0 - 2023-01-30
 
 ### Added

data/lib/hexapdf/dictionary_fields.rb

@@ -305,8 +305,13 @@ module HexaPDF
                      else
                        (m[7] == '-' ? -1 : 1) * (m[8].to_i * 3600 + m[9].to_i * 60).clamp(0, 86399)
                      end
-        Time.new(m[1].to_i, (m[2] ? m[2].to_i : 1), (m[3] ? m[3].to_i : 1),
-                 m[4].to_i, m[5].to_i, m[6].to_i, utc_offset)
+        begin
+          Time.new(m[1].to_i, (m[2] ? m[2].to_i : 1), (m[3] ? m[3].to_i : 1),
+                   m[4].to_i, m[5].to_i, m[6].to_i, utc_offset)
+        rescue ArgumentError
+          Time.new(m[1].to_i, m[2].to_i.clamp(1, 12), m[3].to_i.clamp(1, 31),
+                   m[4].to_i.clamp(0, 23), m[5].to_i.clamp(0, 59), m[6].to_i.clamp(0, 59), utc_offset)
+        end
       end
 
     end

data/lib/hexapdf/document/pages.rb

@@ -75,28 +75,45 @@ module HexaPDF
         @document.catalog.pages
       end
 
-      # :call-seq:
-      #   pages.add                                     -> new_page
-      #   pages.add(media_box, orientation: :portrait)  -> new_page
-      #   pages.add(page)                               -> page
+      # Creates a page object and returns it *without* adding it to the page tree.
+      #
+      # +media_box+::
+      #     If this argument is +nil+/not specified, the value is taken from the configuration
+      #     option 'page.default_media_box'.
+      #
+      #     If the resulting value is an array with four numbers (specifying the media box), the new
+      #     page will have these exact dimensions.
       #
-      # Adds the page or a new empty page at the end and returns it.
+      #     If the value is a symbol, it is taken as a reference to a pre-defined media box in
+      #     HexaPDF::Type::Page::PAPER_SIZE. The +orientation+ can then be used to specify the page
+      #     orientation.
       #
-      # If no argument is given, a new page with the default dimensions (see configuration option
-      # 'page.default_media_box') is used.
+      # +orientation+::
+      #     If this argument is not specified, it is taken from 'page.default_media_orientation'. It
+      #     is only used if +media_box+ is a symbol and not an array.
+      def create(media_box: nil, orientation: nil)
+        media_box ||= @document.config['page.default_media_box']
+        orientation ||= @document.config['page.default_media_orientation']
+        box = if media_box.kind_of?(Array)
+                media_box
+              else
+                Type::Page.media_box(media_box, orientation: orientation)
+              end
+        @document.add({Type: :Page, MediaBox: box})
+      end
+
+      # :call-seq:
+      #   pages.add                               -> new_page
+      #   pages.add(page)                         -> page
+      #   pages.add(media_box, orientation: nil)  -> new_page
       #
-      # If the single argument is an array with four numbers (specifying the media box), the new
-      # page will have these dimensions.
+      # Adds the given page or a new empty page at the end and returns it.
       #
-      # If the single argument is a symbol, it is taken as referencing a pre-defined media box in
-      # HexaPDF::Type::Page::PAPER_SIZE for the new page. The optional argument +orientation+ can be
-      # used to change the orientation to :landscape if needed.
-      def add(page = nil, orientation: :portrait)
-        if page.kind_of?(Array)
-          page = @document.add({Type: :Page, MediaBox: page})
-        elsif page.kind_of?(Symbol)
-          box = Type::Page.media_box(page, orientation: orientation)
-          page = @document.add({Type: :Page, MediaBox: box})
+      # If called with a page object as argument, that page object is used. Otherwise #create is
+      # called with the arguments +media_box+ and +orientation+ to create a new page.
+      def add(page = nil, orientation: nil)
+        unless page.kind_of?(HexaPDF::Type::Page)
+          page = create(media_box: page, orientation: orientation)
         end
         @document.catalog.pages.add_page(page)
       end

data/lib/hexapdf/encryption/standard_security_handler.rb

@@ -324,10 +324,10 @@ module HexaPDF
       def prepare_decryption(password: '', check_permissions: true)
         if dict[:Filter] != :Standard
           raise(HexaPDF::UnsupportedEncryptionError,
-                "Invalid /Filter value for standard security handler")
+                "Invalid /Filter value #{dict[:Filter]} for standard security handler")
         elsif ![2, 3, 4, 6].include?(dict[:R])
           raise(HexaPDF::UnsupportedEncryptionError,
-                "Invalid /R value for standard security handler")
+                "Invalid /R value #{dict[:R]} for standard security handler")
         elsif dict[:R] <= 4 && !document.trailer[:ID].kind_of?(PDFArray)
           document.trailer[:ID] = ['', '']
         end

data/lib/hexapdf/type/font_simple.rb

@@ -171,9 +171,21 @@ module HexaPDF
           yield("Required field #{field} is not set", false) if self[field].nil?
         end
 
+        widths = self[:Widths]
         if key?(:Widths) && key?(:LastChar) && key?(:FirstChar) &&
-            self[:Widths].length != (self[:LastChar] - self[:FirstChar] + 1)
-          yield("Invalid number of entries in field Widths", false)
+            widths.length != (self[:LastChar] - self[:FirstChar] + 1)
+          yield("Invalid number of entries in field Widths", true)
+          difference = self[:LastChar] - self[:FirstChar] + 1 - widths.length
+          if difference > 0
+            missing_value = if widths.count(widths[0]) == widths.length
+                              widths[0]
+                            else
+                              self[:FontDescriptor]&.[](:MissingWidth) || 0
+                            end
+            difference.times { widths << missing_value }
+          else
+            widths.slice!(difference, -difference)
+          end
         end
       end
 

data/lib/hexapdf/version.rb

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

data/test/hexapdf/document/test_pages.rb

@@ -14,6 +14,31 @@ describe HexaPDF::Document::Pages do
     end
   end
 
+  describe "create" do
+    it "uses the defaults from the configuration for missing arguments" do
+      page = @doc.pages.create
+      assert_equal([0, 0, 595, 842], page.box(:media).value)
+    end
+
+    it "allows specifying a reference to a predefined page size" do
+      page = @doc.pages.create(media_box: :A3)
+      assert_equal([0, 0, 842, 1191], page.box(:media).value)
+    end
+
+    it "allows specifying the orientation for a predefined page size" do
+      page = @doc.pages.create(media_box: :A4, orientation: :landscape)
+      assert_equal([0, 0, 842, 595], page.box(:media).value)
+
+      page = @doc.pages.create(orientation: :landscape)
+      assert_equal([0, 0, 842, 595], page.box(:media).value)
+    end
+
+    it "allows using a media box array" do
+      page = @doc.pages.create(media_box: [0, 0, 12, 24], orientation: :landscape)
+      assert_equal([0, 0, 12, 24], page.box(:media).value)
+    end
+  end
+
   describe "add" do
     it "adds a new empty page when no page is given" do
       page = @doc.pages.add

data/test/hexapdf/encryption/test_standard_security_handler.rb

@@ -213,14 +213,14 @@ describe HexaPDF::Encryption::StandardSecurityHandler do
       exp = assert_raises(HexaPDF::UnsupportedEncryptionError) do
         @handler.set_up_decryption({Filter: :NonStandard, V: 2})
       end
-      assert_match(/Invalid \/Filter/i, exp.message)
+      assert_match(/Invalid \/Filter value NonStandard/i, exp.message)
     end
 
     it "fails if the /R value is incorrect" do
       exp = assert_raises(HexaPDF::UnsupportedEncryptionError) do
         @handler.set_up_decryption({Filter: :Standard, V: 2, R: 5})
       end
-      assert_match(/Invalid \/R/i, exp.message)
+      assert_match(/Invalid \/R value 5/i, exp.message)
     end
 
     it "fails if the supplied password is invalid" do

data/test/hexapdf/test_dictionary_fields.rb

@@ -188,10 +188,15 @@ describe HexaPDF::DictionaryFields do
         ["D:19981223-08'00'", [1998, 12, 23, 00, 00, 00, "-08:00"]],
         ["D:199812-08'00'", [1998, 12, 01, 00, 00, 00, "-08:00"]],
         ["D:1998-08'00'", [1998, 01, 01, 00, 00, 00, "-08:00"]],
-        ["D:19981223195210-08", [1998, 12, 23, 19, 52, 10, "-08:00"]], # non-standard, missing '
-        ["D:19981223195210-08'00", [1998, 12, 23, 19, 52, 10, "-08:00"]], # non-standard, missing '
-        ["D:19981223195210-54'00", [1998, 12, 23, 19, 52, 10, "-23:59:59"]], # non-standard, TZ hour to large
-        ["D:19981223195210+10'65", [1998, 12, 23, 19, 52, 10, "+11:05"]], # non-standard, TZ min to large
+        ["D:19981223195210-08", [1998, 12, 23, 19, 52, 10, "-08:00"]], # missing '
+        ["D:19981223195210-08'00", [1998, 12, 23, 19, 52, 10, "-08:00"]], # missing '
+        ["D:19981223195210-54'00", [1998, 12, 23, 19, 52, 10, "-23:59:59"]], #  TZ hour too large
+        ["D:19981223195210+10'65", [1998, 12, 23, 19, 52, 10, "+11:05"]], # TZ min too large
+        ["D:19982423195210-08'00'", [1998, 12, 23, 19, 52, 10, "-08:00"]], # months too large
+        ["D:19981273195210-08'00'", [1998, 12, 31, 19, 52, 10, "-08:00"]], # day too large
+        ["D:19981223275210-08'00'", [1998, 12, 23, 23, 52, 10, "-08:00"]], # hour too large
+        ["D:19981223197710-08'00'", [1998, 12, 23, 19, 59, 10, "-08:00"]], # minute too large
+        ["D:19981223195280-08'00'", [1998, 12, 23, 19, 52, 59, "-08:00"]], # seconds too large
       ].each do |str, data|
         obj = @field.convert(str, self)
         assert_equal(Time.new(*data), obj, "date str used: #{str}")

data/test/hexapdf/test_writer.rb

@@ -40,7 +40,7 @@ describe HexaPDF::Writer do
       219
       %%EOF
       3 0 obj
-      <</Producer(HexaPDF version 0.29.0)>>
+      <</Producer(HexaPDF version 0.30.0)>>
       endobj
       xref
       3 1
@@ -72,7 +72,7 @@ describe HexaPDF::Writer do
       141
       %%EOF
       6 0 obj
-      <</Producer(HexaPDF version 0.29.0)>>
+      <</Producer(HexaPDF version 0.30.0)>>
       endobj
       2 0 obj
       <</Length 10>>stream
@@ -164,9 +164,9 @@ describe HexaPDF::Writer do
 
     document = HexaPDF::Document.new(io: io)
     assert_equal(3, document.revisions.count)
-    assert_equal(1, document.revisions.all[0].object(2)[:Kids].length)
-    assert_equal(2, document.revisions.all[1].object(2)[:Kids].length)
-    assert_equal(3, document.revisions.all[2].object(2)[:Kids].length)
+    assert_equal(1, document.revisions.all[0].object(3)[:Kids].length)
+    assert_equal(2, document.revisions.all[1].object(3)[:Kids].length)
+    assert_equal(3, document.revisions.all[2].object(3)[:Kids].length)
   end
 
   it "creates an xref stream if no xref stream is in a revision but object streams are" do
@@ -214,7 +214,7 @@ describe HexaPDF::Writer do
       <</Type/Page/MediaBox[0 0 595 842]/Parent 2 0 R/Resources<<>>>>
       endobj
       5 0 obj
-      <</Producer(HexaPDF version 0.29.0)>>
+      <</Producer(HexaPDF version 0.30.0)>>
       endobj
       4 0 obj
       <</Root 1 0 R/Info 5 0 R/Size 6/Type/XRef/W[1 1 2]/Index[0 6]/Filter/FlateDecode/DecodeParms<</Columns 4/Predictor 12>>/Length 33>>stream

data/test/hexapdf/type/test_font_simple.rb

@@ -15,7 +15,7 @@ describe HexaPDF::Type::FontSimple do
     EOF
     font_descriptor = @doc.add({Type: :FontDescriptor, FontName: :Embedded, Flags: 0b100,
                                 FontBBox: [0, 1, 2, 3], ItalicAngle: 0, Ascent: 900,
-                                Descent: -100, CapHeight: 800, StemV: 20})
+                                MissingWidth: 500, Descent: -100, CapHeight: 800, StemV: 20})
     @font = @doc.add({Type: :Font, Encoding: :WinAnsiEncoding,
                       BaseFont: :Embedded, FontDescriptor: font_descriptor, ToUnicode: cmap,
                       FirstChar: 32, LastChar: 34, Widths: [600, 0, 700]},
@@ -130,9 +130,7 @@ describe HexaPDF::Type::FontSimple do
     end
 
     it "returns the /MissingWidth of a /FontDescriptor if available and the width was not found" do
-      assert_equal(0, @font.width(0))
-      @font[:FontDescriptor][:MissingWidth] = 99
-      assert_equal(99, @font.width(0))
+      assert_equal(500, @font.width(0))
     end
 
     it "returns 0 for a missing code point when FontDescriptor is not available" do
@@ -169,8 +167,22 @@ describe HexaPDF::Type::FontSimple do
     end
 
     it "validates the lengths of the /Widths field" do
-      @font[:Widths] = [65]
-      refute(@font.validate)
+      @font[:Widths] = [65, 65]
+      assert(@font.validate)
+      assert_equal([65, 65, 65], @font[:Widths])
+
+      @font[:Widths] = [65, 70]
+      assert(@font.validate)
+      assert_equal([65, 70, 500], @font[:Widths])
+
+      @font[:Widths] = [65, 70]
+      @font.delete(:FontDescriptor)
+      assert(@font.validate)
+      assert_equal([65, 70, 0], @font[:Widths])
+
+      @font[:Widths] = [65, 65, 70, 90, 100]
+      assert(@font.validate)
+      assert_equal([65, 65, 70], @font[:Widths])
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse