hexapdf 0.37.1 → 0.38.0

data/lib/hexapdf/type/optional_content_properties.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2023 Thomas Leitner
+# 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
@@ -92,7 +92,6 @@ module HexaPDF
         self[:OCGs].uniq.compact
       end
 
-
       OCMD_POLICY_MAPPING = {any_on: :AnyOn, AnyOn: :AnyOn, any_off: :AnyOff, # :nodoc:
                              AnyOff: :AnyOff, all_off: :AllOff, AllOff: :AllOff}
 
@@ -137,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
@@ -147,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/outline.rb

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

data/lib/hexapdf/type/outline_item.rb

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

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/page.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2023 Thomas Leitner
+# 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
@@ -34,6 +34,7 @@
 # commercial licenses are available at <https://gettalong.at/hexapdf/>.
 #++
 
+require 'set'
 require 'hexapdf/error'
 require 'hexapdf/dictionary'
 require 'hexapdf/stream'
@@ -228,20 +229,33 @@ module HexaPDF
         if rectangle
           case type
           when :media, :crop, :bleed, :trim, :art
-            self["#{type.capitalize}Box".to_sym] = rectangle
+            self[:"#{type.capitalize}Box"] = rectangle
           else
             raise ArgumentError, "Unsupported page box type provided: #{type}"
           end
         else
-          case type
-          when :media then self[:MediaBox]
-          when :crop then self[:CropBox] || self[:MediaBox]
-          when :bleed then self[:BleedBox] || self[:CropBox] || self[:MediaBox]
-          when :trim then self[:TrimBox] || self[:CropBox] || self[:MediaBox]
-          when :art then self[:ArtBox] || self[:CropBox] || self[:MediaBox]
-          else
-            raise ArgumentError, "Unsupported page box type provided: #{type}"
+          media_box = self[:MediaBox]
+          result = case type
+                   when :media then media_box
+                   when :crop then self[:CropBox] || media_box
+                   when :bleed then self[:BleedBox] || self[:CropBox] || media_box
+                   when :trim then self[:TrimBox] || self[:CropBox] || media_box
+                   when :art then self[:ArtBox] || self[:CropBox] || media_box
+                   else
+                     raise ArgumentError, "Unsupported page box type provided: #{type}"
+                   end
+          unless result == media_box
+            if result.right < media_box.left || result.left > media_box.right ||
+                result.top < media_box.bottom || result.bottom > media_box.top
+              result.value = [0, 0, 0, 0]
+            else
+              result.left = media_box.left if result.left < media_box.left
+              result.right = media_box.right if result.right > media_box.right
+              result.top = media_box.top if result.top > media_box.top
+              result.bottom = media_box.bottom if result.bottom < media_box.bottom
+            end
           end
+          result
         end
       end
 
@@ -290,14 +304,15 @@ module HexaPDF
           delete(:Rotate)
           return if cw_angle == 0
 
+          pbox = box
           matrix = case cw_angle
-                   when 90  then Content::TransformationMatrix.new(0, -1, 1, 0, -box.bottom, box.right)
-                   when 180 then Content::TransformationMatrix.new(-1, 0, 0, -1, box.right, box.top)
-                   when 270 then Content::TransformationMatrix.new(0, 1, -1, 0, box.top, -box.left)
+                   when 90  then Content::TransformationMatrix.new(0, -1, 1, 0, -pbox.bottom, pbox.right)
+                   when 180 then Content::TransformationMatrix.new(-1, 0, 0, -1, pbox.right, pbox.top)
+                   when 270 then Content::TransformationMatrix.new(0, 1, -1, 0, pbox.top, -pbox.left)
                    end
 
           rotate_box = lambda do |box|
-            llx, lly, urx, ury = \
+            llx, lly, urx, ury =
               case cw_angle
               when 90  then [box.right, box.bottom, box.left, box.top]
               when 180 then [box.right, box.top, box.left, box.bottom]
@@ -568,7 +583,7 @@ module HexaPDF
           canvas.translate(-pos[0], -pos[1])
         end
 
-        to_delete = []
+        to_delete = Set.new
         not_flattened -= annotations
         annotations.each do |annotation|
           unless annotation?(annotation)

data/lib/hexapdf/type/page_label.rb

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

data/lib/hexapdf/type/page_tree_node.rb

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

data/lib/hexapdf/type/resources.rb

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

data/lib/hexapdf/type/trailer.rb

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

data/lib/hexapdf/type/viewer_preferences.rb

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

data/lib/hexapdf/type/xref_stream.rb

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

data/lib/hexapdf/type.rb

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

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

data/lib/hexapdf/utils/bit_stream.rb

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

data/lib/hexapdf/utils/graphics_helpers.rb

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

data/lib/hexapdf/utils/lru_cache.rb

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

data/lib/hexapdf/utils/math_helpers.rb

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

data/lib/hexapdf/utils/object_hash.rb

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

data/lib/hexapdf/utils/pdf_doc_encoding.rb

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

data/lib/hexapdf/utils/sorted_tree_node.rb

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

data/lib/hexapdf/utils.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2023 Thomas Leitner
+# 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
@@ -37,6 +37,8 @@
 require 'geom2d/utils'
 
 module HexaPDF
+
+  # This module contains helper methods for the whole library.
   module Utils
 
     # The precision with which to compare floating point numbers.
@@ -47,8 +49,6 @@ module HexaPDF
     # Best effort of setting Geom2D's precision to the one used by HexaPDF.
     ::Geom2D::Utils.precision = EPSILON
 
-    module_function
-
     private
 
     # Compares two floats whether they are equal using the FLOAT_EPSILON precision.

data/lib/hexapdf/version.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2023 Thomas Leitner
+# 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
@@ -37,6 +37,6 @@
 module HexaPDF
 
   # The version of HexaPDF.
-  VERSION = '0.37.1'
+  VERSION = '0.38.0'
 
 end

data/lib/hexapdf/writer.rb

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

data/lib/hexapdf/xref_section.rb

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

data/lib/hexapdf.rb

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

data/test/hexapdf/content/test_canvas.rb

@@ -1366,7 +1366,7 @@ describe HexaPDF::Content::Canvas do
     end
   end
 
-  describe "color_from_specification "do
+  describe "color_from_specification " do
     it "accepts a color string" do
       assert_equal([1, 0, 0], @canvas.color_from_specification("red").components)
     end

data/test/hexapdf/digital_signature/common.rb

@@ -129,7 +129,7 @@ module HexaPDF
                                               Logger: WEBrick::Log.new(StringIO.new), AccessLog: [])
         @tsa_server.mount_proc('/') do |request, response|
           @tsr = OpenSSL::Timestamp::Request.new(request.body)
-          case (@tsr.policy_id || '1.2.3.4.0')
+          case @tsr.policy_id || '1.2.3.4.0'
           when '1.2.3.4.0', '1.2.3.4.2'
             fac = OpenSSL::Timestamp::Factory.new
             fac.gen_time = Time.now

data/test/hexapdf/document/test_layout.rb

@@ -104,13 +104,20 @@ 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
 
 describe HexaPDF::Document::Layout do
   before do
     @doc = HexaPDF::Document.new
-    @doc.config['font.on_invalid_glyph'] = lambda do |codepoint, invalid_glyph|
+    @doc.config['font.on_invalid_glyph'] = lambda do |codepoint, _invalid_glyph|
       [@doc.fonts.add('ZapfDingbats').decode_codepoint(codepoint)]
     end
     @layout = @doc.layout
@@ -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)
@@ -267,7 +280,7 @@ describe HexaPDF::Document::Layout do
 
     it "allows setting custom properties on the whole box" do
       box = @layout.formatted_text_box([{text: "Test", properties: {key: :novalue}}],
-                                        properties: {key: :value})
+                                       properties: {key: :value})
       assert_equal({key: :value}, box.properties)
     end