hexapdf 0.37.2 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7633d38801df5768a809a8491de34a33ff90069c1ea55eed29a75d0ccd4e5c67
-  data.tar.gz: f74d51319f639d5e218e27cb264231e370943fa365b4b4c1ef9b0c47df123dfb
+  metadata.gz: b6df8bc8bdf189f60287c3dc0a0eccb1e1bca2a8b4310c1d5c2bb5d6661bae11
+  data.tar.gz: a28fc9d3319f596774bda74476fbc77fe40ba8e29a2dcd1e588c18f0928e8538
 SHA512:
-  metadata.gz: cfc63a537dacfece92e4df2116362b8a270b9f291e1350604368820a8e2e02ebc2e47b462391dcd74cf9a16ab498d9b3b72ab1a8ff063eab816ed65636405379
-  data.tar.gz: e90d2be37bc9150c9e040b06678fe98ea601c20dab39b75e689559418f043b63c0967784f0e5f0b0d11f1cce5ee10557d65a4e996099301bd27fb4962dcbe961
+  metadata.gz: 11a382eceaa702705fe15484314e8d8b21c26ce2bf50d082be5e4ae27749251562474bfe1f4d410e53008120b37b6f43b42b1f9ecaca0ce123a672a6868a0515
+  data.tar.gz: ef98043f0d6460bbfd4819ba34fd2fab4d9e7426b04d0005f1f65ae88d813ff92db6f9cb89cb3e88997c8b68dea7e7631ceb873f5091a6c1b8bd6aa72075ab32

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## 0.38.0 - 2024-03-10
+
+### Added
+
+* [HexaPDF::Task::PDFA] for creating PDF/A conforming PDF files
+* [HexaPDF::Type::OutputIntent] for defining output intents
+* [HexaPDF::Document::Metadata#delete] for deleting metadata properties
+* PDF/A metadata properties definitions
+* Added a /Name entry to the default optional content configuration dictionary
+  (needed by PDF/A)
+
+### Changed
+
+* Default language for XMP metadata from English to 'x-default'
+* [HexaPDF::Layout::ListBox] to use the style's font for drawing markers and to
+  fall back to Times and ZapfDingbats if necessary
+* [HexaPDF::Document::Layout#table_box] to merge the `:cell` keys that define
+  the cell style instead of using the last one
+* [HexaPDF::Document::Layout] style retrieval to fall back to using the font of
+  the `:base` style and only if that doesn't exist to 'Times'
+* XMP metadata stream contents to satisfy more PDF/A validators
+
+
 ## 0.37.2 - 2024-02-27
 
 ### Fixed

data/README.md

@@ -47,19 +47,19 @@ section](#License) for details.
 * [`hexapdf` binary][hp] for most common PDF manipulation tasks
 
 
-[canvas API]: https://hexapdf.gettalong.org/documentation/reference/api/HexaPDF/Content/Canvas.html
-[document composition engine]: https://hexapdf.gettalong.org/documentation/key-topics/document-layout.html
+[canvas API]: https://hexapdf.gettalong.org/documentation/api/HexaPDF/Content/Canvas.html
+[document composition engine]: https://hexapdf.gettalong.org/documentation/document-creation/document-layout.html
 [flowing text]: https://hexapdf.gettalong.org/examples/frame_text_flow.html
-[styles]: https://hexapdf.gettalong.org/documentation/reference/api/HexaPDF/Layout/Style/index.html
-[(un)ordered lists]: https://hexapdf.gettalong.org/documentation/reference/api/HexaPDF/Layout/ListBox.html
-[multi-column layout]: https://hexapdf.gettalong.org/documentation/reference/api/HexaPDF/Layout/ColumnBox.html
-[PDF forms]: https://hexapdf.gettalong.org/documentation/key-topics/forms.html
-[Document outline]: https://hexapdf.gettalong.org/documentation/reference/api/HexaPDF/Type/Outline.html
-[attaching files]: https://hexapdf.gettalong.org/documentation/reference/api/HexaPDF/Document/Files.html
-[Encryption]: https://hexapdf.gettalong.org/documentation/key-topics/encryption.html
-[Digital Signatures]: https://hexapdf.gettalong.org/documentation/key-topics/digital-signatures.html
+[styles]: https://hexapdf.gettalong.org/documentation/api/HexaPDF/Layout/Style/index.html
+[(un)ordered lists]: https://hexapdf.gettalong.org/documentation/api/HexaPDF/Layout/ListBox.html
+[multi-column layout]: https://hexapdf.gettalong.org/documentation/api/HexaPDF/Layout/ColumnBox.html
+[PDF forms]: https://hexapdf.gettalong.org/documentation/interactive-forms/index.html
+[Document outline]: https://hexapdf.gettalong.org/documentation/outline/index.html
+[attaching files]: https://hexapdf.gettalong.org/documentation/api/HexaPDF/Document/Files.html
+[Encryption]: https://hexapdf.gettalong.org/documentation/encryption/index.html
+[Digital Signatures]: https://hexapdf.gettalong.org/documentation/digital-signatures/index.html
 [File size optimization]: https://hexapdf.gettalong.org/documentation/benchmarks/optimization.html
-[hp]: https://hexapdf.gettalong.org/documentation/reference/hexapdf.1.html
+[hp]: https://hexapdf.gettalong.org/documentation/hexapdf.1.html
 
 
 ## Usage
@@ -126,7 +126,7 @@ featureful API when it comes to creating content, for individual pages as well a
 If you want to migrate from Prawn to HexaPDF, there is the [migration guide] with detailed
 information and examples, comparing the Prawn API to HexaPDF's equivalents.
 
-[migration guide]: https://hexapdf.gettalong.org/documentation/howtos/migrating-from-prawn.html
+[migration guide]: https://hexapdf.gettalong.org/documentation/document-creation/migrating-from-prawn.html
 
 Why use HexaPDF?
 
@@ -145,9 +145,10 @@ Why use HexaPDF?
   manipulating PDFs. This tool is intended to be a replacement for tools like `pdftk` and the
   various Poppler-based tools like `pdfinfo`, `pdfimages`, ...
 
-[Prawn]: http://prawnpdf.org
+[Prawn]: https://prawnpdf.org
 [page canvas API]: https://hexapdf.gettalong.org/api/HexaPDF/Content/Canvas.html
 
+
 ## Development
 
 Clone the repository and then run `rake dev:setup`. This will install the needed Rubygem
@@ -178,6 +179,9 @@ Some included files have a different license:
 * The AES test vector files in `test/data/aes-test-vectors` have been created using the test vector
   file available from <http://csrc.nist.gov/groups/STM/cavp/block-ciphers.html#test-vectors>.
 
+* The license of the file `data/hexapdf/sRGB2014.icc` is available in the
+  `data/hexapdf/sRGB2014.icc.LICENSE` file.
+
 
 ## Contributing
 

data/data/hexapdf/sRGB2014.icc.LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2015 International Color Consortium
+
+This profile is made available by the International Color Consortium,
+and may be copied, distributed, embedded, made, used, and sold without
+restriction. Altered versions of this profile shall have the original
+identification and copyright information removed and shall not be
+misrepresented as the original profile.

data/examples/030-pdfa.rb

@@ -0,0 +1,89 @@
+# # PDF/A Compliance
+#
+# This example shows how to create a PDF file that is PDF/A compliant.
+#
+# In this case we are creating a simple invoice, with multiple line
+# items that break across the page boundary.
+#
+# Usage:
+# : `ruby pdfa.rb`
+#
+require 'hexapdf'
+
+HexaPDF::Composer.create('pdfa.pdf') do |composer|
+  composer.document.task(:pdfa)
+  composer.document.config['font.map'] = {
+    'Lato' => {
+      none: '/usr/share/fonts/truetype/lato/Lato-Regular.ttf',
+      bold: '/usr/share/fonts/truetype/lato/Lato-Bold.ttf',
+      italic: '/usr/share/fonts/truetype/lato/Lato-Italic.ttf',
+      bold_italic: '/usr/share/fonts/truetype/lato/Lato-BoldItalic.ttf',
+    },
+  }
+
+  company = {
+    name: 'Sample Corp Limited',
+    address: ["Example Avenue 1", "12345 Runway"],
+  }
+
+  # 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', variant: :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', variant: :bold],
+                 font_size: 8, padding: [0, 0, 8])
+  composer.style(:footer_text,  font_size: 8, fill_color: "darkgrey")
+
+  # Top part
+  composer.box(:container, style: :top_box) do |container|
+    container.formatted_text([{text: company[:name], font: ['Lato', variant: :bold]},
+                              " - " + company[:address].join(' - ')], style: :top)
+  end
+  composer.text("Mega Client\nSmall Lane 5\n67890 Noonestown", mask_mode: :box)
+  cells = [["Invoice number:", "2024/01"],
+           ["Invoice date", "2024-03-10"],
+           ["Service date:", "2024-02-01"]]
+  composer.table(cells, column_widths: [150, 80], style: {align: :right}) do |args|
+    args[] = {cell: {border: {width: 0}, padding: 2}, text_align: :right}
+    args[0..-1, 0] = {font: ['Lato', variant: :bold]}
+  end
+
+  # Middle part
+  composer.text("Invoice - 2024/01", style: :header)
+  composer.text("Thank you for your order. Following are the items you purchased:")
+
+  cells = [["Description", "Price", "Amount", "Total"]]
+  max = 40
+  1.upto(max) do |index|
+    cells << ["Sample Item E.g. #{index}", "€ 250,00", index, "€ #{250 * index},00"]
+  end
+  cells << [nil, nil, nil, "€ #{250 * max * (max + 1) / 2},00"]
+  composer.table(cells, column_widths: [250, 80], style: :line_items) do |args|
+    args[] = {cell: {border: {width: 0}, padding: 8}, style: :line_item_cell}
+    args[0] = {cell: {background_color: "eee"}, font: ["Lato", variant: :bold]}
+    args[-1] = {cell: {background_color: "eee", border: {width: [2, 0, 0]}},
+                font: ["Lato", variant: :bold]}
+    args[0..-1, 1..-1] = {text_align: :right}
+  end
+
+  composer.text("Please transfer the total amount via SEPA transfer to the bank " \
+                "account below immediately after receiving the invoice - thank you.")
+
+  # Bottom part
+  l = composer.document.layout
+  cells = [
+    [l.text(company[:name], style: :footer_heading),
+     l.text(company[:address].join("\n"), style: :footer_text)],
+    [l.text('Contact', style: :footer_heading),
+     l.text("owner@samplecorp.com\nOwner: Me, Myself, And I", style: :footer_text)],
+    [l.text('Bank Account', style: :footer_heading),
+     l.text("Sample Corp Bank\nIBAN: SC01 2345 6789 0123 4567\nBIC: SACOZZB123",
+            style: :footer_text)],
+  ]
+  composer.table([cells], cell_style: {border: {width: 0}}, style: :footer)
+end

data/lib/hexapdf/configuration.rb

@@ -568,6 +568,7 @@ module HexaPDF
                       'task.map' => {
                         optimize: 'HexaPDF::Task::Optimize',
                         dereference: 'HexaPDF::Task::Dereference',
+                        pdfa: 'HexaPDF::Task::PDFA',
                       })
 
   # The global configuration object, providing the following options:
@@ -688,6 +689,8 @@ module HexaPDF
                         XXCIDSystemInfo: 'HexaPDF::Type::CIDFont::CIDSystemInfo',
                         Group: 'HexaPDF::Type::Form::Group',
                         Metadata: 'HexaPDF::Type::Metadata',
+                        OutputIntent: 'HexaPDF::Type::OutputIntent',
+                        XXDestOutputProfileRef: 'HexaPDF::Type::OutputIntent::DestOutputProfileRef',
                       },
                       'object.subtype_map' => {
                         nil => {
@@ -707,6 +710,9 @@ module HexaPDF
                           Link: 'HexaPDF::Type::Annotations::Link',
                           Widget: 'HexaPDF::Type::Annotations::Widget',
                           XML: 'HexaPDF::Type::Metadata',
+                          GTS_PDFX: 'HexaPDF::Type::OutputIntent',
+                          GTS_PDFA1: 'HexaPDF::Type::OutputIntent',
+                          ISO_PDFE1: 'HexaPDF::Type::OutputIntent',
                         },
                         XObject: {
                           Image: 'HexaPDF::Type::Image',
@@ -738,6 +744,11 @@ module HexaPDF
                           Ch: 'HexaPDF::Type::AcroForm::ChoiceField',
                           Sig: 'HexaPDF::Type::AcroForm::SignatureField',
                         },
+                        OutputIntent: {
+                          GTS_PDFX: 'HexaPDF::Type::OutputIntent',
+                          GTS_PDFA1: 'HexaPDF::Type::OutputIntent',
+                          ISO_PDFE1: 'HexaPDF::Type::OutputIntent',
+                        },
                       })
 
 end

data/lib/hexapdf/document/layout.rb

@@ -486,10 +486,14 @@ module HexaPDF
 
         # Retrieves the merged keyword arguments for the cell in +row+ and +col+.
         #
-        # Earlier defined arguments are overridden by later ones.
+        # Earlier defined arguments are overridden by later ones, except for the +:cell+ key which
+        # is merged.
         def retrieve_arguments_for(row, col)
           @argument_infos.each_with_object({}) do |arg_info, result|
             next unless arg_info.rows.cover?(row) && arg_info.cols.cover?(col)
+            if arg_info.args[:cell]
+              arg_info.args[:cell] = (result[:cell] || {}).merge(arg_info.args[:cell])
+            end
             result.update(arg_info.args)
           end
         end
@@ -635,15 +639,15 @@ module HexaPDF
       # If the +properties+ hash is not empty, the retrieved style is duplicated and the properties
       # hash is applied to it.
       #
-      # Finally, a default font is set if necessary to ensure that the style object works in all
-      # cases.
+      # Finally, a default font (the one from the :base style or otherwise 'Times') is set if
+      # necessary to ensure that the style object works in all cases.
       def retrieve_style(style, properties = nil)
         if style.kind_of?(Symbol) && !@styles.key?(style)
           raise HexaPDF::Error, "Style #{style} not defined"
         end
         style = HexaPDF::Layout::Style.create(@styles[style] || style || @styles[:base])
         style = style.dup.update(**properties) unless properties.nil? || properties.empty?
-        style.font('Times') unless style.font?
+        style.font(@styles[:base].font? && @styles[:base].font || 'Times') unless style.font?
         unless style.font.respond_to?(:pdf_object)
           name, options = *style.font
           style.font(@document.fonts.add(name, **(options || {})))

data/lib/hexapdf/document/metadata.rb

@@ -80,6 +80,10 @@ module HexaPDF
     # String::
     #     Maps to the XMP simple string value. Values need to be of type String.
     #
+    # Integer::
+    #     Maps to the XMP integer core value type and gets formatted as string. Values need to be of
+    #     type Integer.
+    #
     # Date::
     #     Maps to the XMP simple string value, correctly formatted. Values need to be of type Time,
     #     Date, or DateTime
@@ -123,6 +127,7 @@ module HexaPDF
         "pdf" => "http://ns.adobe.com/pdf/1.3/",
         "dc" => "http://purl.org/dc/elements/1.1/",
         "x" => "adobe:ns:meta/",
+        "pdfaid" => "http://www.aiim.org/pdfa/ns/id/",
       }.freeze
 
       # Contains a mapping of predefined XMP properties to their types, i.e. from namespace to
@@ -143,6 +148,10 @@ module HexaPDF
           'description' => 'LanguageArray',
           'title' => 'LanguageArray',
         }.freeze,
+        "http://www.aiim.org/pdfa/ns/id/" => {
+          'part' => 'Integer',
+          'conformance' => 'String',
+        }.freeze,
       }.freeze
 
       # Creates a new Metadata object for the given PDF document.
@@ -150,7 +159,7 @@ module HexaPDF
         @document = document
         @namespaces = PREDEFINED_NAMESPACES.dup
         @properties = PREDEFINED_PROPERTIES.transform_values(&:dup)
-        @default_language = document.catalog[:Lang] || 'en'
+        @default_language = document.catalog[:Lang] || 'x-default'
         @metadata = Hash.new {|h, k| h[k] = {} }
         write_info_dict(true)
         write_metadata_stream(true)
@@ -166,7 +175,7 @@ module HexaPDF
       # is given. Otherwise sets the default language to the given language.
       #
       # The initial default lanuage is taken from the document catalog's /Lang entry. If that is not
-      # set, the default language is assumed to be English ('en').
+      # set, the default language is assumed to be default language ('x-default').
       def default_language(value = :UNSET)
         if value == :UNSET
           @default_language
@@ -213,8 +222,8 @@ module HexaPDF
 
       # Registers the +property+ for the namespace specified via +prefix+ as the given +type+.
       #
-      # The argument +type+ has to be one of the following: 'String', 'Date', 'URI', 'Boolean',
-      # 'OrderedArray', 'UnorderedArray', or 'LanguageArray'.
+      # The argument +type+ has to be one of the following: 'String', 'Integer', 'Date', 'URI',
+      # 'Boolean', 'OrderedArray', 'UnorderedArray', or 'LanguageArray'.
       def register_property_type(prefix, property, type)
         (@properties[namespace(prefix)] ||= {})[property] = type
       end
@@ -240,13 +249,31 @@ module HexaPDF
       end
 
       # :call-seq:
-      #   metadata.title          -> title or nil
-      #   metadata.title(value    -> value
+      #   metadata.delete
+      #   metadata.delete(ns_prefix)
+      #   metadata.delete(ns_prefix, name)
+      #
+      # Deletes either all metadata properties, only the ones from a specific namespace, or a
+      # specific one.
+      def delete(ns = nil, property = nil)
+        if ns.nil? && property.nil?
+          @metadata.clear
+        elsif property.nil?
+          @metadata.delete(namespace(ns))
+        else
+          @metadata[namespace(ns)].delete(property)
+        end
+      end
+
+      # :call-seq:
+      #   metadata.title           -> title or nil
+      #   metadata.title(value)    -> value
       #
       # Returns the document's title if no argument is given. Otherwise sets the document's title to
       # the given value.
       #
-      # The language for the title is specified via #default_language.
+      # If the +value+ is a LocalizedString, the language for the title is taken from it. Otherwise
+      # the language specified via #default_language is used.
       #
       # The value +nil+ is returned if the property is not set. And by using +nil+ as +value+ the
       # property is deleted from the metadata.
@@ -278,7 +305,8 @@ module HexaPDF
       # Returns the subject of the document if no argument is given. Otherwise sets the subject to
       # the given value.
       #
-      # The language for the subject is specified via #default_language.
+      # If the +value+ is a LocalizedString, the language for the subject is taken from it.
+      # Otherwise the language specified via #default_language is used.
       #
       # The value +nil+ is returned if the property ist not set. And by using +nil+ as +value+ the
       # property is deleted from the metadata.
@@ -406,23 +434,30 @@ module HexaPDF
         ns_xmp = namespace('xmp')
         ns_pdf = namespace('pdf')
 
+        producer("HexaPDF version #{HexaPDF::VERSION}")
+
         if write_info_dict?
           info_dict = @document.trailer.info
           info_dict[:Title] = Array(@metadata[ns_dc]['title']).first
-          info_dict[:Author] = Array(@metadata[ns_dc]['creator']).join(', ')
+          if @metadata[ns_dc].key?('creator')
+            info_dict[:Author] = Array(@metadata[ns_dc]['creator']).join(', ')
+          end
           info_dict[:Subject] = Array(@metadata[ns_dc]['description']).first
           info_dict[:Creator] = @metadata[ns_xmp]['CreatorTool']
           info_dict[:CreationDate] = @metadata[ns_xmp]['CreateDate']
           info_dict[:ModDate] = @metadata[ns_xmp]['ModifyDate']
           info_dict[:Keywords] = @metadata[ns_pdf]['Keywords']
           info_dict[:Producer] = @metadata[ns_pdf]['Producer']
-          info_dict[:Trapped] = @metadata[ns_pdf]['Trapped'] ? :True : :False
+          if @metadata[ns_pdf].key?('Trapped')
+            info_dict[:Trapped] = @metadata[ns_pdf]['Trapped'] ? :True : :False
+          end
         end
 
         if write_metadata_stream?
           descriptions = @metadata.map do |namespace, values|
+            next if values.empty?
             xmp_description(@namespaces.key(namespace), values)
-          end.join("\n")
+          end.compact.join("\n")
           obj = @document.catalog[:Metadata] ||= @document.add({Type: :Metadata, Subtype: :XML})
           obj.stream = xmp_packet(descriptions)
         end
@@ -432,9 +467,11 @@ module HexaPDF
       def xmp_packet(data)
         <<~XMP
           <?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}
           </rdf:RDF>
+          </x:xmpmeta>
           <?xpacket end="r"?>
         XMP
       end
@@ -444,8 +481,8 @@ module HexaPDF
         values = values.map do |name, value|
           str = +"<#{ns_prefix}:#{name}"
           case (property_type = @properties[namespace(ns_prefix)][name])
-          when 'String'
-            str << ">#{xmp_escape(value)}</#{ns_prefix}:#{name}>"
+          when 'String', 'Integer'
+            str << ">#{xmp_escape(value.to_s)}</#{ns_prefix}:#{name}>"
           when 'Date'
             str << ">#{xmp_date(value)}</#{ns_prefix}:#{name}>"
           when 'URI'

data/lib/hexapdf/layout/list_box.rb

@@ -325,27 +325,30 @@ module HexaPDF
         return @marker_type.call(document, self, index) if @marker_type.kind_of?(Proc)
         return @item_marker_box if defined?(@item_marker_box)
 
+        marker_style = {
+          font: style.font? ? style.font : document.fonts.add("Times"),
+          font_size: style.font_size || 10, fill_color: style.fill_color
+        }
         fragment = case @marker_type
                    when :disc
-                     TextFragment.create("•", font: document.fonts.add("Times"),
-                                         font_size: style.font_size, fill_color: style.fill_color)
+                     TextFragment.create("•", marker_style)
                    when :circle
-                     TextFragment.create("❍", font: document.fonts.add("ZapfDingbats"),
+                     unless marker_style[:font].decode_codepoint("❍".ord).valid?
+                       marker_style[:font] = document.fonts.add("ZapfDingbats")
+                     end
+                     TextFragment.create("❍", **marker_style,
                                          font_size: style.font_size / 2.0,
-                                         fill_color: style.fill_color,
                                          text_rise: -style.font_size / 1.8)
                    when :square
-                     TextFragment.create("■", font: document.fonts.add("ZapfDingbats"),
+                     unless marker_style[:font].decode_codepoint("■".ord).valid?
+                       marker_style[:font] = document.fonts.add("ZapfDingbats")
+                     end
+                     TextFragment.create("■", **marker_style,
                                          font_size: style.font_size / 2.0,
-                                         fill_color: style.fill_color,
                                          text_rise: -style.font_size / 1.8)
                    when :decimal
                      text = (@start_number + index).to_s << "."
-                     decimal_style = {
-                       font: (style.font? ? style.font : document.fonts.add("Times")),
-                       font_size: style.font_size || 10, fill_color: style.fill_color
-                     }
-                     TextFragment.create(text, decimal_style)
+                     TextFragment.create(text, marker_style)
                    else
                      raise HexaPDF::Error, "Unknown list marker type #{@marker_type.inspect}"
                    end

data/lib/hexapdf/task/pdfa.rb

@@ -0,0 +1,87 @@
+# -*- 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-2024 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
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#
+# If the GNU Affero General Public License doesn't fit your need,
+# commercial licenses are available at <https://gettalong.at/hexapdf/>.
+#++
+
+require 'set'
+require 'hexapdf/serializer'
+require 'hexapdf/content/parser'
+require 'hexapdf/content/operator'
+require 'hexapdf/type/xref_stream'
+require 'hexapdf/type/object_stream'
+
+module HexaPDF
+  module Task
+
+    # Task for creating a PDF/A compliant document.
+    #
+    # It automatically
+    #
+    # * prevents the Standard 14 PDF fonts to be used.
+    # * adds an appropriate output intent if none is set.
+    # * adds the necessary PDF/A metadata properties.
+    module PDFA
+
+      # Performs the necessary tasks to make the document PDF/A compatible.
+      #
+      # +level+::
+      #     Specifies the PDF/A conformance level that should be used. Can be one of the following
+      #     strings: 2b, 2u, 3b, 3u.
+      def self.call(doc, level: '3u')
+        unless level.match?(/\A[23][bu]\z/)
+          raise ArgumentError, "The given PDF/A conformance level '#{level}' is not supported"
+        end
+        doc.config['font_loader'].delete('HexaPDF::FontLoader::Standard14')
+        doc.register_listener(:complete_objects) do
+          part, conformance = level.chars
+          doc.metadata.property('pdfaid', 'part', part)
+          doc.metadata.property('pdfaid', 'conformance', conformance.upcase)
+          add_srgb_icc_output_intent(doc) unless doc.catalog.key?(:OutputIntents)
+        end
+      end
+
+      SRGB_ICC = 'sRGB2014.icc' # :nodoc:
+
+      def self.add_srgb_icc_output_intent(doc) # :nodoc:
+        icc = doc.add({N: 3}, stream: File.binread(File.join(HexaPDF.data_dir, SRGB_ICC)))
+        doc.catalog[:OutputIntents] = [
+          doc.add({S: :GTS_PDFA1, OutputConditionIdentifier: SRGB_ICC, Info: SRGB_ICC,
+                   RegistryName: 'https://www.color.org', DestOutputProfile: icc}),
+        ]
+      end
+
+    end
+
+  end
+end

data/lib/hexapdf/task.rb

@@ -64,6 +64,7 @@ module HexaPDF
 
     autoload(:Optimize, 'hexapdf/task/optimize')
     autoload(:Dereference, 'hexapdf/task/dereference')
+    autoload(:PDFA, 'hexapdf/task/pdfa')
 
   end
 

data/lib/hexapdf/type/optional_content_properties.rb

@@ -136,7 +136,7 @@ module HexaPDF
         if hash
           self[:D] = hash
         else
-          self[:D] ||= {Creator: 'HexaPDF'}
+          self[:D] ||= {Name: 'Default', Creator: 'HexaPDF'}
         end
         self[:D]
       end
@@ -146,7 +146,7 @@ module HexaPDF
       def perform_validation(&block) # :nodoc:
         unless key?(:D)
           yield('The OptionalContentProperties dictionary needs a default configuration', true)
-          self[:D] = {Creator: 'HexaPDF'}
+          self[:D] = {Name: 'Default', Creator: 'HexaPDF'}
         end
         super
       end

data/lib/hexapdf/type/output_intent.rb

@@ -0,0 +1,85 @@
+# -*- 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-2024 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
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#
+# If the GNU Affero General Public License doesn't fit your need,
+# commercial licenses are available at <https://gettalong.at/hexapdf/>.
+#++
+
+require 'hexapdf/dictionary'
+
+module HexaPDF
+  module Type
+
+    # Represents an output intent dictionary.
+    #
+    # Such a dictionary may be referenced from the catalog's /OutputIntents entry or from the
+    # /OutputIntents entry of a page object.
+    #
+    # See: PDF2.0 s14.11.5, Catalog
+    class OutputIntent < Dictionary
+
+      # Represents a destination output profile reference dictionary.
+      #
+      # Such a dictionary is referenced from the /DestOutputProfileRef entry of an OutputIntent
+      # dictionary.
+      #
+      # See: PDF2.0 s14.11.5
+      class DestOutputProfileRef < Dictionary
+
+        define_type :XXDestOutputProfileRef
+
+        define_field :CheckSum,      type: String,   version: "2.0"
+        define_field :ColorantTable, type: PDFArray, version: "2.0"
+        define_field :ICCVersion,    type: String,   version: "2.0"
+        define_field :ProfileCS,     type: String,   version: "2.0"
+        define_field :ProfileName,   type: String,   version: "2.0"
+        define_field :URLs,          type: PDFArray, version: "2.0"
+
+      end
+
+      define_type :OutputIntent
+
+      define_field :Type, type: Symbol, required: false, default: type
+      define_field :S,    type: Symbol, required: true
+      define_field :OutputCondition,           type: String
+      define_field :OutputConditionIdentifier, type: String, required: true
+      define_field :RegistryName, type: String
+      define_field :Info,         type: String
+      define_field :DestOutputProfile,    type: Stream
+      define_field :DestOutputProfileRef, type: :XXDestOutputProfileRef, version: "2.0"
+      define_field :MixingHints,          type: Dictionary, version: "2.0"
+      define_field :SpectralData,         type: Dictionary, version: "2.0"
+
+    end
+
+  end
+end

data/lib/hexapdf/type.rb

@@ -81,6 +81,7 @@ module HexaPDF
     autoload(:OptionalContentProperties, 'hexapdf/type/optional_content_properties')
     autoload(:OptionalContentConfiguration, 'hexapdf/type/optional_content_configuration')
     autoload(:Metadata, 'hexapdf/type/metadata')
+    autoload(:OutputIntent, 'hexapdf/type/output_intent')
 
   end
 

data/lib/hexapdf/version.rb

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

data/test/hexapdf/document/test_layout.rb

@@ -104,6 +104,13 @@ describe HexaPDF::Document::Layout::CellArgumentCollector do
       @args[5, 6] = {e: :f}
       assert_equal({key: :value, a: :c, e: :f}, @args.retrieve_arguments_for(5, 6))
     end
+
+    it "deep merges the :cell keys" do
+      @args[] = {cell: {a: :b, c: :d}}
+      @args[3..7] = {cell: {a: :y, e: :f}}
+      @args[5, 6] = {cell: {a: :z}}
+      assert_equal({cell: {a: :z, c: :d, e: :f}}, @args.retrieve_arguments_for(5, 6))
+    end
   end
 end
 
@@ -229,6 +236,12 @@ describe HexaPDF::Document::Layout do
       assert_equal(20, box.style.font_size)
 
       box = @layout.text_box("Test", style: {font_size: 20})
+      assert_same(@doc.fonts.add("Times"), box.style.font)
+      assert_equal(20, box.style.font_size)
+
+      @layout.style(:base, font: ['Times', {variant: :bold}])
+      box = @layout.text_box("Test", style: {font_size: 20})
+      assert_same(@doc.fonts.add("Times", variant: :bold), box.style.font)
       assert_equal(20, box.style.font_size)
 
       @layout.style(:named, font_size: 20)

data/test/hexapdf/document/test_metadata.rb

@@ -27,8 +27,8 @@ describe HexaPDF::Document::Metadata do
       assert_equal("de", HexaPDF::Document::Metadata.new(@doc).default_language)
     end
 
-    it "falls back to English if the document doesn't have a default language set" do
-      assert_equal('en', @metadata.default_language)
+    it "falls back to the default language if the document doesn't have a default language set" do
+      assert_equal('x-default', @metadata.default_language)
     end
 
     it "allows changing the default language" do
@@ -80,6 +80,25 @@ describe HexaPDF::Document::Metadata do
     refute(@metadata.instance_variable_get(:@metadata)[@metadata.namespace('dc')].key?('title'))
   end
 
+  describe "delete" do
+    it "deletes all properties" do
+      @metadata.delete
+      assert(@metadata.instance_variable_get(:@metadata).empty?)
+    end
+
+    it "deletes all properties of a single namespace" do
+      @metadata.creator('Test')
+      @metadata.delete('dc')
+      assert_equal('Test', @metadata.creator)
+      refute(@metadata.instance_variable_get(:@metadata).key?(@metadata.namespace('dc')))
+    end
+
+    it "deletes a specific property" do
+      @metadata.delete('dc', 'title')
+      assert_nil(@metadata.title)
+    end
+  end
+
   it "allows reading and setting all info dictionary properties" do
     [['title', 'dc', 'title'], ['author', 'dc', 'creator'], ['subject', 'dc', 'description'],
      ['keywords', 'pdf', 'Keywords'], ['creator', 'xmp', 'CreatorTool'],
@@ -120,6 +139,17 @@ describe HexaPDF::Document::Metadata do
       assert_equal(:True, info[:Trapped])
     end
 
+    it "omits values in the info dictionary that are not set" do
+      @metadata.delete('pdf', 'Trapped')
+      @metadata.delete('dc', 'title')
+      @metadata.delete('dc', 'creator')
+      @doc.write(StringIO.new, update_fields: false)
+      info = @doc.trailer.info
+      refute(info.key?(:Title))
+      refute(info.key?(:Author))
+      refute(info.key?(:Trapped))
+    end
+
     it "uses a correctly updated modification date if set so by Document#write" do
       info = @doc.trailer.info
       sleep(0.1)
@@ -140,6 +170,23 @@ describe HexaPDF::Document::Metadata do
       assert_equal('Subject', info[:Subject])
     end
 
+    it "omits rdf:Description elements without values" do
+      @metadata.delete
+      @doc.write(StringIO.new, update_fields: false)
+      metadata = <<~XMP
+        <?xpacket begin="" id=""?>
+        <x:xmpmeta xmlns:x="adobe:ns:meta/">
+        <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+        <rdf:Description rdf:about="" xmlns:pdf="http://ns.adobe.com/pdf/1.3/">
+        <pdf:Producer>HexaPDF version #{HexaPDF::VERSION}</pdf:Producer>
+        </rdf:Description>
+        </rdf:RDF>
+        </x:xmpmeta>
+        <?xpacket end="r"?>
+      XMP
+      assert_equal(metadata, @doc.catalog[:Metadata].stream.sub(/(?<=id=")\w+/, ''))
+    end
+
     it "writes the XMP metadata" do
       title = HexaPDF::Document::Metadata::LocalizedString.new('Der Titel')
       title.language = 'de'
@@ -147,13 +194,16 @@ describe HexaPDF::Document::Metadata do
       @metadata.author(['Author 1', 'Author 2'])
       @metadata.register_property_type('dc', 'other', 'URI')
       @metadata.property('dc', 'other', 'https://test.org/example')
+      @metadata.property('pdfaid', 'part', 3)
+      @metadata.property('pdfaid', 'conformance', 'b')
       @doc.write(StringIO.new, update_fields: false)
       metadata = <<~XMP
         <?xpacket begin="" id=""?>
+        <x:xmpmeta xmlns:x="adobe:ns:meta/">
         <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
         <rdf:Description rdf:about="" xmlns:dc="http://purl.org/dc/elements/1.1/">
         <dc:title><rdf:Alt>
-        <rdf:li xml:lang="en">Title</rdf:li>
+        <rdf:li xml:lang="x-default">Title</rdf:li>
         <rdf:li xml:lang="de">Der Titel</rdf:li>
         </rdf:Alt></dc:title>
         <dc:creator><rdf:Seq>
@@ -161,13 +211,13 @@ describe HexaPDF::Document::Metadata do
         <rdf:li>Author 2</rdf:li>
         </rdf:Seq></dc:creator>
         <dc:description><rdf:Alt>
-        <rdf:li xml:lang="en">Subject</rdf:li>
+        <rdf:li xml:lang="x-default">Subject</rdf:li>
         </rdf:Alt></dc:description>
         <dc:other rdf:resource="https://test.org/example" />
         </rdf:Description>
         <rdf:Description rdf:about="" xmlns:pdf="http://ns.adobe.com/pdf/1.3/">
         <pdf:Keywords>Keywords</pdf:Keywords>
-        <pdf:Producer>Producer</pdf:Producer>
+        <pdf:Producer>HexaPDF version #{HexaPDF::VERSION}</pdf:Producer>
         <pdf:Trapped>True</pdf:Trapped>
         </rdf:Description>
         <rdf:Description rdf:about="" xmlns:xmp="http://ns.adobe.com/xap/1.0/">
@@ -175,7 +225,12 @@ describe HexaPDF::Document::Metadata do
         <xmp:CreateDate>#{@metadata.send(:xmp_date, @time)}</xmp:CreateDate>
         <xmp:ModifyDate>#{@metadata.send(:xmp_date, @time)}</xmp:ModifyDate>
         </rdf:Description>
+        <rdf:Description rdf:about="" xmlns:pdfaid="http://www.aiim.org/pdfa/ns/id/">
+        <pdfaid:part>3</pdfaid:part>
+        <pdfaid:conformance>b</pdfaid:conformance>
+        </rdf:Description>
         </rdf:RDF>
+        </x:xmpmeta>
         <?xpacket end="r"?>
       XMP
       assert_equal(metadata, @doc.catalog[:Metadata].stream.sub(/(?<=id=")\w+/, ''))

data/test/hexapdf/layout/test_list_box.rb

@@ -143,6 +143,7 @@ describe HexaPDF::Layout::ListBox do
       @canvas = @page.canvas
       draw_block = lambda {|canvas, box| }
       @fixed_size_boxes = 5.times.map { HexaPDF::Layout::Box.new(width: 20, height: 10, &draw_block) }
+      @helvetica = @doc.fonts.add('Helvetica')
     end
 
     it "draws the result" do
@@ -295,5 +296,24 @@ describe HexaPDF::Layout::ListBox do
       ]
       assert_operators(@canvas.contents, operators)
     end
+
+    it "uses the font set on the list box for the marker" do
+      box = create_box(children: @fixed_size_boxes[0, 1],
+                       style: {font: @helvetica, font_size: 12})
+      box.fit(100, 100, @frame)
+      box.draw(@canvas, 0, 100 - box.height)
+      assert_operators(@canvas.contents, [:set_font_and_size, [:F1, 12]], range: 1)
+      assert_equal(:Helvetica, @canvas.resources.font(:F1)[:BaseFont])
+    end
+
+    it "falls back to ZapfDingbats if the set font doesn't contain the necessary symbol" do
+      box = create_box(children: @fixed_size_boxes[0, 1], marker_type: :circle,
+                       style: {font: @helvetica})
+      box.fit(100, 100, @frame)
+      box.draw(@canvas, 0, 100 - box.height)
+      assert_operators(@canvas.contents, [:set_font_and_size, [:F1, 5]], range: 1)
+      assert_equal(:ZapfDingbats, @canvas.resources.font(:F1)[:BaseFont])
+    end
+
   end
 end

data/test/hexapdf/task/test_pdfa.rb

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+require 'stringio'
+require 'test_helper'
+require 'hexapdf/document'
+
+describe HexaPDF::Task::PDFA do
+  before do
+    @doc = HexaPDF::Document.new
+  end
+
+  it "fails if the given PDF/A level is invalid" do
+    assert_raises(ArgumentError) { @doc.task(:pdfa, level: '1a') }
+    assert_raises(ArgumentError) { @doc.task(:pdfa, level: '2a') }
+    assert_raises(ArgumentError) { @doc.task(:pdfa, level: '3a') }
+    assert_raises(ArgumentError) { @doc.task(:pdfa, level: '4e') }
+    assert_raises(ArgumentError) { @doc.task(:pdfa, level: 'something') }
+  end
+
+  it "removes the standard 14 PDF font loader" do
+    @doc.task(:pdfa)
+    assert_raises(HexaPDF::Error) { @doc.fonts.add('Helvetia') }
+  end
+
+  it "adds the necessary XMP metadata entries before the document is written" do
+    @doc.task(:pdfa, level: '3b')
+    @doc.write(StringIO.new)
+    assert_equal('3', @doc.metadata.property('pdfaid', 'part'))
+    assert_equal('B', @doc.metadata.property('pdfaid', 'conformance'))
+  end
+
+  it "adds an RGB output intent before the document is written" do
+    @doc.task(:pdfa)
+    @doc.write(StringIO.new)
+    oi = @doc.catalog[:OutputIntents].first
+    assert_equal(:GTS_PDFA1, oi[:S])
+    assert_equal('sRGB2014.icc', oi[:OutputConditionIdentifier])
+    assert_equal('sRGB2014.icc', oi[:Info])
+    assert_kind_of(HexaPDF::Stream, oi[:DestOutputProfile])
+  end
+end

data/test/hexapdf/test_writer.rb

@@ -40,7 +40,7 @@ describe HexaPDF::Writer do
       219
       %%EOF
       3 0 obj
-      <</Producer(HexaPDF version 0.37.2)>>
+      <</Producer(HexaPDF version #{HexaPDF::VERSION})>>
       endobj
       xref
       3 1
@@ -72,7 +72,7 @@ describe HexaPDF::Writer do
       141
       %%EOF
       6 0 obj
-      <</Producer(HexaPDF version 0.37.2)>>
+      <</Producer(HexaPDF version #{HexaPDF::VERSION})>>
       endobj
       2 0 obj
       <</Length 10>>stream

data/test/hexapdf/type/test_optional_content_properties.rb

@@ -85,7 +85,7 @@ describe HexaPDF::Type::OptionalContentProperties do
 
     it "sets and returns a default configuration dictionary if none is set" do
       @oc.delete(:D)
-      assert_equal({Creator: 'HexaPDF'}, @oc.default_configuration.value)
+      assert_equal({Name: 'Default', Creator: 'HexaPDF'}, @oc.default_configuration.value)
     end
 
     it "sets the default configuration dictionary to the given value" do
@@ -103,7 +103,7 @@ describe HexaPDF::Type::OptionalContentProperties do
       refute(@oc.validate(auto_correct: false))
       refute(@oc.key?(:D))
       assert(@oc.validate(auto_correct: true))
-      assert_equal({Creator: 'HexaPDF'}, @oc[:D].value)
+      assert_equal({Name: 'Default', Creator: 'HexaPDF'}, @oc[:D].value)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 0.37.2
+  version: 0.38.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse
@@ -274,6 +274,8 @@ files:
 - data/hexapdf/cmap/V
 - data/hexapdf/encoding/glyphlist.txt
 - data/hexapdf/encoding/zapfdingbats.txt
+- data/hexapdf/sRGB2014.icc
+- data/hexapdf/sRGB2014.icc.LICENSE
 - examples/001-hello_world.rb
 - examples/002-graphics.rb
 - examples/003-arcs.rb
@@ -303,6 +305,7 @@ files:
 - examples/027-composer_optional_content.rb
 - examples/028-frame_mask_mode.rb
 - examples/029-composer_fallback_fonts.rb
+- examples/030-pdfa.rb
 - examples/emoji-smile.png
 - examples/emoji-wink.png
 - examples/machupicchu.jpg
@@ -464,6 +467,7 @@ files:
 - lib/hexapdf/task.rb
 - lib/hexapdf/task/dereference.rb
 - lib/hexapdf/task/optimize.rb
+- lib/hexapdf/task/pdfa.rb
 - lib/hexapdf/test_utils.rb
 - lib/hexapdf/tokenizer.rb
 - lib/hexapdf/type.rb
@@ -515,6 +519,7 @@ files:
 - lib/hexapdf/type/optional_content_properties.rb
 - lib/hexapdf/type/outline.rb
 - lib/hexapdf/type/outline_item.rb
+- lib/hexapdf/type/output_intent.rb
 - lib/hexapdf/type/page.rb
 - lib/hexapdf/type/page_label.rb
 - lib/hexapdf/type/page_tree_node.rb
@@ -715,6 +720,7 @@ files:
 - test/hexapdf/layout/test_width_from_polygon.rb
 - test/hexapdf/task/test_dereference.rb
 - test/hexapdf/task/test_optimize.rb
+- test/hexapdf/task/test_pdfa.rb
 - test/hexapdf/test_composer.rb
 - test/hexapdf/test_configuration.rb
 - test/hexapdf/test_data_dir.rb