hexapdf 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f11a38da2472389966c1d103b86e46ba8cd858d2927b1a65f441f56e2e7dd5
-  data.tar.gz: 74ff92dcb6ede9f137303afc7c8b9d08e0baa42b0ab0b7d4436777e6db617ea4
+  metadata.gz: 9be9871c8033a23eb240dc0b6300bcb33ba8ccef107f35189cb8af3faf308a61
+  data.tar.gz: 875797999dc46cefdb39dd31f1649525a11716915af5a83a6c38c0dc100cca2e
 SHA512:
-  metadata.gz: 468e0a5a24e06574b4a802408daafbdb59b3a1dc460ad2b6bf9f543088d1210d8295b843847819a872436ea4c380df85240822e28b548dd88b55f74b30ff8ab3
-  data.tar.gz: 29e95def1e7ccf0d55bca3cf5ad4d95a070d5910a0e1b8645d2884e0e5022367c63e14e2df3ecc0bac7cdfc329d88698c01060dc8005e1c1025a0c8337367afc
+  metadata.gz: 8700678297a316b14a604045ab7da8c371d7cbcebb771d8c878fff4306e36ff7e72b898fb4c63e98599493a7b93480a34bd099dc102ef0e431d825fe1e11ae41
+  data.tar.gz: 4892bb8868475b4bfe65c5938097589f9544bb4b7b9bef568b1ac60a7932eced09f2eee53edc38212654e522c4cc4e5edd8fde7cb6b6078e27ccf18e131e96aa

data/CHANGELOG.md

@@ -1,3 +1,69 @@
+## 0.24.0 - 2022-08-01
+
+### Added
+
+* [HexaPDF::Layout::ListBox] for rendering ordered and unordered lists
+* [HexaPDF::Layout::ColumnBox] for rendering content inside columns
+* [HexaPDF::Layout::BoxFitter] for placing boxes into multiple frames
+* New configuration option 'debug' for enabling debug output
+* [HexaPDF::Document::Pages#move] for moving pages around the same document
+* [HexaPDF::Composer#box] for drawing arbitrary, registered boxes
+* [HexaPDF::Layout::Box#split_box?] for determining whether a box is a split
+  box, i.e. the continuation of another box
+* [HexaPDF::Document::Layout::ChildrenCollector] to provide an easy method for
+  defining children boxes of a container box
+
+### Changed
+
+* **Breaking change**: Refactored [HexaPDF::Layout::Frame] and associated data
+  structures so that the complete result of fitting a box is returned
+* [HexaPDF::Layout::Frame] to use a better algorithm for trimming the shape
+* [HexaPDF::Layout::Frame::new] to allow setting the initial shape
+* **Breaking change**: Removed contour line from [HexaPDF::Layout::Frame]
+* **Breaking change**: Changed positional arguments of
+  [HexaPDF::Layout::TextBox::new] and [HexaPDF::Layout::ImageBox::new] to
+  keyword arguments for a consistent box initialization interface
+* [HexaPDF::Layout::Box#split] to provide a default implementation that is
+  useful for most subclasses
+* Layout box implementations to provide a `#supports_position_flow?` method that
+  indicates whether the box supports flowing its content around other content.
+* `hexapdf info --check` to only check the current version of each object
+* [HexaPDF::Writer] to make sure the producer information is written when
+  writing the file incrementally
+
+### Fixed
+
+* [HexaPDF::Layout::TextLayouter] to freeze the new items when a text fragment
+  needs to be split
+* [HexaPDF::Layout::TextLayouter] to avoid the possible splitting of a text
+  fragment if there would not be enough height left anyway
+* [HexaPDF::Layout::WidthFromPolygon] to work correctly in case of very small
+  floating point errors
+* HexaPDF::Layout::TextFragment#inspect to work in case of interspersed
+  numbers
+* [HexaPDF::Layout::TextBox#split] to work for position :flow when box is wider
+  than the initial available width
+* [HexaPDF::Layout::Frame#fit] to create minimally sized mask rectangles
+* [HexaPDF::Content::GraphicObject::Geom2D] to close the path when drawing
+  polygons
+* [HexaPDF::Layout::WidthFromPolygon] to work for all counterclockwise polygons
+* [HexaPDF::Type::PageTreeNode#move_page] to work in case the parent node of the
+  moved node doesn't change
+* [HexaPDF::Type::PageTreeNode#move_page] to use the correct target position
+  when the moved node is before the target position
+* [HexaPDF::Document::Signatures#add] to work in case the signature object is
+  the last object written
+* CLI command `hexapdf inspect` to show correct byte range of the last revision
+* [HexaPDF::Writer#write_incremental] to only use a cross-reference stream if a
+  revision directly used one and not through an `/XRefStm` entry
+* [HexaPDF::Encryption::FastARC4] to use RubyARC4 as fallback if OpenSSL has RC4
+  disabled
+* [HexaPDF::Font::Encoding::GlyphList] to use binary reading to avoid problems
+  on Windows
+* [HexaPDF::Document::Signatures#add] to use binary writing to avoid problems on
+  Windows
+
+
 ## 0.23.0 - 2022-05-26
 
 ### Added

data/LICENSE

@@ -1,5 +1,5 @@
 HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-Copyright (C) 2014-2021 Thomas Leitner
+Copyright (C) 2014-2022 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/Rakefile

@@ -47,7 +47,7 @@ namespace :dev do
   end
 
   task :test_all do
-    versions = `rbenv versions --bare | grep -i 2.[567]\\\\\\|3.`.split("\n")
+    versions = `rbenv versions --bare | grep -i 2.[67]\\\\\\|3.`.split("\n")
     versions.each do |version|
       sh "eval \"$(rbenv init -)\"; rbenv shell #{version} && ruby -v && rake test"
     end

data/examples/016-frame_automatic_box_placement.rb

@@ -43,8 +43,13 @@ draw_box = lambda do |**args|
 
   drawn = false
   until drawn
-    drawn = frame.draw(canvas, b)
-    frame.find_next_region unless drawn
+    result = frame.fit(b)
+    if result.success?
+      frame.draw(canvas, result)
+      drawn = true
+    else
+      frame.find_next_region
+    end
   end
 
   canvas.line_width(3).draw(:geom2d, object: frame.shape)

data/examples/017-frame_text_flow.rb

@@ -19,31 +19,18 @@ include HexaPDF::Utils::GraphicsHelpers
 
 doc = HexaPDF::Document.new
 
-sample_text = "Lorem ipsum dolor sit amet, con\u{00AD}sectetur
-adipis\u{00AD}cing elit, sed do eiusmod tempor incididunt ut labore et
-dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation
-ullamco laboris nisi ut aliquip ex ea commodo consequat.
-".tr("\n", ' ') * 10
-items = [TextFragment.create(sample_text, font: doc.fonts.add("Times"))]
-
 page = doc.pages.add
 media_box = page.box(:media)
-canvas = page.canvas
 frame = Frame.new(media_box.left + 20, media_box.bottom + 20,
                   media_box.width - 40, media_box.height - 40)
 
-image = doc.images.add(File.join(__dir__, 'machupicchu.jpg'))
-iw, ih = calculate_dimensions(image.width, image.height, rwidth: 100)
-
 boxes = []
-boxes << Box.create(width: iw, height: ih,
-                    margin: [10, 30], position: :float) do |canv, box|
-  canv.image(image, at: [0, 0], width: 100)
-end
+boxes << doc.layout.image_box(File.join(__dir__, 'machupicchu.jpg'),
+                              width: 100, margin: [10, 30], position: :float)
 boxes << Box.create(width: 50, height: 50, margin: 20,
                     position: :float, position_hint: :right,
                     border: {width: 1, color: [[255, 0, 0]]})
-boxes << TextBox.new(items, style: {position: :flow, align: :justify})
+boxes << doc.layout.lorem_ipsum_box(count: 3, position: :flow, align: :justify)
 
 i = 0
 frame_filled = false
@@ -51,8 +38,13 @@ until frame_filled
   box = boxes[i]
   drawn = false
   until drawn || frame_filled
-    drawn = frame.draw(canvas, box)
-    frame_filled = !frame.find_next_region unless drawn
+    result = frame.fit(box)
+    if result.success?
+      frame.draw(page.canvas, result)
+      drawn = true
+    else
+      frame_filled = !frame.find_next_region
+    end
   end
   i = (i + 1) % boxes.length
 end

data/examples/020-column_box.rb

@@ -0,0 +1,40 @@
+# # Column Box
+#
+# This example shows how [HexaPDF::Layout::ColumnBox] can be used to place
+# contents into columns.
+#
+# Three boxes are placed repeatedly onto the frame until it is filled: two
+# floating boxes (one left, one right) and a text box. The text box is styled to
+# flow its content around the other two boxes.
+#
+# Usage:
+# : `ruby column_box.rb`
+#
+
+require 'hexapdf'
+
+doc = HexaPDF::Document.new
+page = doc.pages.add
+media_box = page.box(:media)
+frame = HexaPDF::Layout::Frame.new(media_box.left + 20, media_box.bottom + 20,
+                                   media_box.width - 40, media_box.height - 40)
+
+boxes = []
+5.times do
+  boxes << doc.layout.image_box(File.join(__dir__, 'machupicchu.jpg'), width: 100,
+                                style: {margin: [10, 30], position: :float})
+  boxes << HexaPDF::Layout::Box.create(width: 50, height: 50, margin: 20,
+                                       position: :float, position_hint: :right,
+                                       border: {width: 1, color: [[255, 0, 0]]})
+  boxes << doc.layout.lorem_ipsum_box(count: 2, position: :flow, align: :justify)
+end
+
+polygon = Geom2D::Polygon([200, 350], [400, 350], [400, 450], [200, 450])
+frame.remove_area(polygon)
+page.canvas.draw(:geom2d, object: polygon)
+
+columns = doc.layout.box(:column, children: boxes, columns: 2, style: {position: :flow})
+result = frame.fit(columns)
+frame.draw(page.canvas, result)
+
+doc.write("column_box.pdf", optimize: true)

data/examples/021-list_box.rb

@@ -0,0 +1,26 @@
+# # List Box
+#
+# This example shows how [HexaPDF::Layout::ListBox] can be used to place
+# contents into lists.
+#
+# The list box class provides several options to style the item marker
+# and its general appearance.
+#
+# Usage:
+# : `ruby list_box.rb`
+#
+
+require 'hexapdf'
+
+HexaPDF::Composer.create("list_box.pdf") do |composer|
+  composer.box(:list, content_indentation: 40, item_spacing: 20) do |list|
+    list.lorem_ipsum_box
+    list.image(File.join(__dir__, 'machupicchu.jpg'), height: 100)
+    list.box(:list, item_type: :decimal) do |sub_list|
+      1.upto(10) {|i| sub_list.text("Item #{i}") }
+    end
+    list.box(:column) do |column|
+      column.lorem_ipsum_box(count: 3)
+    end
+  end
+end

data/lib/hexapdf/cli/batch.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/command.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/files.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/fonts.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/form.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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
@@ -270,7 +270,7 @@ module HexaPDF
         else
           raise "Field type #{field.concrete_field_type} not yet supported"
         end
-      rescue
+      rescue StandardError
         raise "Error while setting '#{field.full_field_name}': #{$!.message}"
       end
 

data/lib/hexapdf/cli/image2pdf.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/images.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/info.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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
@@ -103,7 +103,7 @@ module HexaPDF
                 "#{correctable ? '(correctable)' : ''}"
             end
             doc.trailer.validate(auto_correct: true, &validation_block)
-            doc.each(only_current: false, only_loaded: false) do |obj|
+            doc.each(only_current: true, only_loaded: false) do |obj|
               indirect_object = obj
               obj.validate(auto_correct: true, &validation_block)
             end

data/lib/hexapdf/cli/inspect.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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
@@ -354,7 +354,7 @@ module HexaPDF
             buffer = ''.b
             while io.pos < startxrefs[index + 1]
               buffer << io.read(1_000)
-              if (buffer_index = buffer.index(/(?:\n|\r\n?)\s*%%EOF\s*(?:\n|\r\n?)/))
+              if (buffer_index = buffer.index(/(?:\n|\r\n?)\s*%%EOF\s*(?:\n|\r\n?)?/))
                 end_index = io.pos - buffer.size + buffer_index + $~[0].size
                 break
               end

data/lib/hexapdf/cli/merge.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/modify.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/optimize.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/split.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli/watermark.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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/cli.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2021 Thomas Leitner
+# Copyright (C) 2014-2022 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