hexapdf 0.43.0 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24f6839e903fd945678915625b1e2ef6a12221f29a82cf1c7a6d8bcea38af288
-  data.tar.gz: 2f8309e2ef2406dd279e00643bf7fbf73ded63a1076c0067684a356fea8ee89e
+  metadata.gz: cd31e769d2a906198da2a4194085cb2a884fa3879442b75add168d7f81d67d8b
+  data.tar.gz: 43c2b4ba4df2f997d470835995f2581aa306c639c63ddc892e648d94605f3b22
 SHA512:
-  metadata.gz: 8c6ddd8ec6f19d39daa9a6422fdb3595d255b528fb93ca7907ef12dab0eca23c74de9fcfc27d02c15b3a9d3c24d47c7f7db6ea472f4c1ed34c2b7c06d4a8a351
-  data.tar.gz: 1d77c2da70d9048cbef6935afacde40fb6d4041414fce571a331a4bee33b0e3ee2ff59bb28eee02e515798c3c156a57f42f139356e946f64e878ea962756a1d8
+  metadata.gz: f17a303dba8104974564a213c72c0f0862c520964a3255b575544489ccb5a17a468d093d3970817903c4eb798e888592410db18447d3264d535f3a01a4a94c82
+  data.tar.gz: d5727e2f2bfb5ed827ac92eecc8cd9e0ba73044150ba07d03623dccde43dc29db1cddc2fbce24bfd63268522e7965519e188271c2bc9c00162b1a660fc468b74

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+## 0.45.0 - 2024-06-18
+
+### Added
+
+* [HexaPDF::Document::Layout#styles] and [HexaPDF::Composer#styles] for defining
+  multiple styles at once
+
+### Changed
+
+* [HexaPDF::Layout::Box#fit] to set width/height correctly for boxes with
+  position `:flow`
+
+### Fixed
+
+* Regression in [HexaPDF::Layout::ListBox] that leads to missing markers
+* [HexaPDF::Content::CanvasComposer#draw_box] to handle truncated boxes
+* [HexaPDF::Layout::TableBox::Cell] to handle too-big content in all cases
+
+
+## 0.44.0 - 2024-06-05
+
+### Added
+
+* Support for specifying the MIME type when embedding files
+* Support for adding custom XMP metadata
+
+### Changed
+
+* **Breaking change**: Refactored the box implementation of the document layout
+  system
+
+### Fixed
+
+* Parsing of invalid files with garbage bytes at the end
+
+
 ## 0.43.0 - 2024-05-26
 
 ### Added

data/examples/027-composer_optional_content.rb

@@ -16,8 +16,10 @@
 require 'hexapdf'
 
 HexaPDF::Composer.create('composer_optional_content.pdf') do |composer|
-  composer.style(:question, font_size: 16, margin: [0, 0, 16], fill_color: 'hp-blue')
-  composer.style(:answer, font: 'ZapfDingbats', fill_color: "green")
+  composer.styles(
+    question: {font_size: 16, margin: [0, 0, 16], fill_color: 'hp-blue'},
+    answer: {font: 'ZapfDingbats', fill_color: "green"},
+  )
 
   all = composer.document.optional_content.ocg('All answers')
   a1 = composer.document.optional_content.ocg('Answer 1')
@@ -38,7 +40,7 @@ HexaPDF::Composer.create('composer_optional_content.pdf') do |composer|
           answers.text('Guido van Rossum')
           answers.multiple do |answer|
             answer.text('Yukihiro “Matz” Matsumoto', position: :float)
-            answer.text("\u{a0}\u{a0}4", style: :answer,
+            answer.text("\u{a0}\u{a0}✔", style: :answer,
                         properties: {'optional_content' => a1})
           end
           answers.text('Rob Pike')
@@ -54,7 +56,7 @@ HexaPDF::Composer.create('composer_optional_content.pdf') do |composer|
           answers.text('1992')
           answers.multiple do |answer|
             answer.text('1993', position: :float)
-            answer.text("\u{a0}\u{a0}4", style: :answer,
+            answer.text("\u{a0}\u{a0}✔", style: :answer,
                         properties: {'optional_content' => a2})
           end
         end

data/examples/030-pdfa.rb

@@ -8,6 +8,7 @@
 # Usage:
 # : `ruby pdfa.rb`
 #
+
 require 'hexapdf'
 
 HexaPDF::Composer.create('pdfa.pdf') do |composer|
@@ -27,17 +28,18 @@ HexaPDF::Composer.create('pdfa.pdf') do |composer|
   }
 
   # Define all styles
-  composer.style(:base, font: 'Lato', font_size: 10, line_spacing: 1.3)
-  composer.style(:top, font_size: 8)
-  composer.style(:top_box, padding: [100, 0, 0], margin: [0, 0, 10], border: {width: [0, 0, 1]})
-  composer.style(:header, font: 'Lato bold', font_size: 20, margin: [50, 0, 20])
-  composer.style(:line_items, border: {width: 1, color: "eee"}, margin: [20, 0])
-  composer.style(:line_item_cell, font_size: 8)
-  composer.style(:footer, border: {width: [1, 0, 0], color: "darkgrey"},
-                 padding: [5, 0, 0], valign: :bottom)
-  composer.style(:footer_heading, font: 'Lato bold',
-                 font_size: 8, padding: [0, 0, 8])
-  composer.style(:footer_text,  font_size: 8, fill_color: "darkgrey")
+  composer.styles(
+    base: {font: 'Lato', font_size: 10, line_spacing: 1.3},
+    top: {font_size: 8},
+    top_box: {padding: [100, 0, 0], margin: [0, 0, 10], border: {width: [0, 0, 1]}},
+    header: {font: 'Lato bold', font_size: 20, margin: [50, 0, 20]},
+    line_items: {border: {width: 1, color: "eee"}, margin: [20, 0]},
+    line_item_cell: {font_size: 8},
+    footer: {border: {width: [1, 0, 0], color: "darkgrey"}, padding: [5, 0, 0],
+             valign: :bottom},
+    footer_heading: {font: 'Lato bold', font_size: 8, padding: [0, 0, 8]},
+    footer_text: {font_size: 8, fill_color: "darkgrey"},
+  )
 
   # Top part
   composer.box(:container, style: :top_box) do |container|

data/lib/hexapdf/composer.rb

@@ -254,6 +254,28 @@ module HexaPDF
       @document.layout.style(name, base: base, **properties)
     end
 
+    # :call-seq:
+    #    composer.styles              -> styles
+    #    composer.styles(**mapping)   -> styles
+    #
+    # Creates multiple named styles at once if +mapping+ is provided, and returns the style mapping.
+    #
+    # See HexaPDF::Document::Layout#styles for details; this method is just a thin wrapper around
+    # that method.
+    #
+    # Example:
+    #
+    #   composer.styles(
+    #     base: {font_size: 12, leading: 1.2},
+    #     header: {font: 'Helvetica', fill_color: "008"},
+    #     header1: {base: :header, font_size: 30}
+    #   )
+    #
+    # See: HexaPDF::Layout::Style
+    def styles(**mapping)
+      @document.layout.styles(**mapping)
+    end
+
     # :call-seq:
     #    composer.page_style(name)                                 -> page_style
     #    composer.page_style(name, **attributes, &template_block)  -> page_style
@@ -425,6 +447,7 @@ module HexaPDF
           if draw_box
             @frame.draw(@canvas, result)
             drawn_on_page = true
+            (box = draw_box; break) unless box
           elsif !@frame.find_next_region
             unless drawn_on_page
               raise HexaPDF::Error, "Box doesn't fit on empty page"

data/lib/hexapdf/content/canvas.rb

@@ -1127,7 +1127,7 @@ module HexaPDF
       #   canvas.rectangle(x, y, width, height, radius: 0)       => canvas
       #
       # Appends a rectangle to the current path as a complete subpath (drawn in counterclockwise
-      # direction), with the bottom left corner specified by +x+ and +y+ and the given +width+ and
+      # direction), with the bottom-left corner specified by +x+ and +y+ and the given +width+ and
       # +height+. Returns +self+.
       #
       # If +radius+ is greater than 0, the corners are rounded with the given radius.
@@ -1137,7 +1137,7 @@ module HexaPDF
       #
       # If there is no current path when the method is invoked, a new path is automatically begun.
       #
-      # The current point is set to the bottom left corner if +radius+ is zero, otherwise it is set
+      # The current point is set to the bottom-left corner if +radius+ is zero, otherwise it is set
       # to (x, y + radius).
       #
       # Examples:
@@ -1720,7 +1720,7 @@ module HexaPDF
       # If the filename or the IO specifies a PDF file, the first page of this file is used to
       # create a form XObject which is then drawn.
       #
-      # The +at+ argument has to be an array containing two numbers specifying the bottom left
+      # The +at+ argument has to be an array containing two numbers specifying the bottom-left
       # corner at which to draw the XObject.
       #
       # If +width+ and +height+ are specified, the drawn XObject will have exactly these

data/lib/hexapdf/content/canvas_composer.rb

@@ -96,6 +96,7 @@ module HexaPDF
             draw_box, box = @frame.split(result)
             if draw_box
               @frame.draw(@canvas, result)
+              (box = draw_box; break) unless box
             elsif !@frame.find_next_region
               raise HexaPDF::Error, "Frame for canvas composer is full and box doesn't fit anymore"
             end

data/lib/hexapdf/document/files.rb

@@ -70,6 +70,9 @@ module HexaPDF
       # description::
       #     A description of the file.
       #
+      # mime_type::
+      #     The MIME type that should be set for embedded files (so only used if +embed+ is +true+).
+      #
       # embed::
       #     When an IO object is given, it is always embedded and this option is ignored.
       #
@@ -77,7 +80,7 @@ module HexaPDF
       #     only a reference to it is stored.
       #
       # See: HexaPDF::Type::FileSpecification
-      def add(file_or_io, name: nil, description: nil, embed: true)
+      def add(file_or_io, name: nil, description: nil, mime_type: nil, embed: true)
         name ||= File.basename(file_or_io) if file_or_io.kind_of?(String)
         if name.nil?
           raise ArgumentError, "The name argument is mandatory when given an IO object"
@@ -86,7 +89,9 @@ module HexaPDF
         spec = @document.add({Type: :Filespec})
         spec.path = name
         spec[:Desc] = description if description
-        spec.embed(file_or_io, name: name, register: true) if embed || !file_or_io.kind_of?(String)
+        if embed || !file_or_io.kind_of?(String)
+          spec.embed(file_or_io, name: name, mime_type: mime_type, register: true)
+        end
         spec
       end
 

data/lib/hexapdf/document/layout.rb

@@ -175,9 +175,6 @@ module HexaPDF
 
       end
 
-      # The mapping of style name (a Symbol) to Layout::Style instance.
-      attr_reader :styles
-
       # Creates a new Layout object for the given PDF document.
       def initialize(document)
         @document = document
@@ -219,6 +216,21 @@ module HexaPDF
         style
       end
 
+      # :call-seq:
+      #    layout.styles            -> styles
+      #    layout.styles(**mapping)   -> styles
+      #
+      # Returns the mapping of style names to Layout::Style instances. If +mapping+ is provided,
+      # also defines the given styles using #style.
+      #
+      # The argument +mapping+ needs to be a hash mapping a style name (a Symbol) to style
+      # properties. The special key +:base+ can be used to define the base style. For details see
+      # #style.
+      def styles(**mapping)
+        mapping.each {|name, properties| style(name, **properties) } unless mapping.empty?
+        @styles
+      end
+
       # Creates an inline box for use together with text fragments.
       #
       # The +valign+ argument ist used to specify the vertical alignment of the box within the text

data/lib/hexapdf/document/metadata.rb

@@ -161,6 +161,7 @@ module HexaPDF
         @properties = PREDEFINED_PROPERTIES.transform_values(&:dup)
         @default_language = document.catalog[:Lang] || 'x-default'
         @metadata = Hash.new {|h, k| h[k] = {} }
+        @custom_metadata = []
         write_info_dict(true)
         write_metadata_stream(true)
         @document.register_listener(:complete_objects, &method(:write_metadata))
@@ -248,6 +249,16 @@ module HexaPDF
         end
       end
 
+      # Adds the given +data+ string as custom metadata to the XMP document.
+      #
+      # The +data+ string must contain a fully valid 'rdf:Description' element.
+      #
+      # Using this method allows adding metadata like PDF/A schema definitions for which there is no
+      # direct support by HexaPDF.
+      def custom_metadata(data)
+        @custom_metadata << data
+      end
+
       # :call-seq:
       #   metadata.delete
       #   metadata.delete(ns_prefix)
@@ -469,7 +480,7 @@ module HexaPDF
           <?xpacket begin="\u{FEFF}" id="#{SecureRandom.uuid.tr('-', '')}"?>
           <x:xmpmeta xmlns:x="adobe:ns:meta/">
           <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
-          #{data}
+          #{data}#{@custom_metadata.empty? ? '' : "\n#{@custom_metadata.join("\n")}"}
           </rdf:RDF>
           </x:xmpmeta>
           <?xpacket end="r"?>

data/lib/hexapdf/font/type1/character_metrics.rb

@@ -51,7 +51,7 @@ module HexaPDF
         attr_accessor :name
 
         # Character bounding box as array of four numbers, specifying the x- and y-coordinates of
-        # the bottom left corner and the x- and y-coordinates of the top right corner.
+        # the bottom-left corner and the x- and y-coordinates of the top-right corner.
         attr_accessor :bbox
 
       end

data/lib/hexapdf/font/type1/font_metrics.rb

@@ -63,7 +63,7 @@ module HexaPDF
         attr_accessor :weight
 
         # The font bounding box as array of four numbers, specifying the x- and y-coordinates of the
-        # bottom left corner and the x- and y-coordinates of the top right corner.
+        # bottom-left corner and the x- and y-coordinates of the top-right corner.
         attr_accessor :bounding_box
 
         # The y-value of the top of the capital H (or 0 or nil if the font doesn't contain a capital