hexapdf 0.21.1 → 0.24.0

data/lib/hexapdf/type/image.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
@@ -163,13 +163,23 @@ module HexaPDF
           result.color_space = :cmyk
           result.components = 4
           result.writable = false if result.type == :png
+        when :ICCBased
+          result.color_space = :icc
+          result.components = self[:ColorSpace][1][:N]
+          result.writable = false if result.type == :png && result.components == 4
         else
           result.color_space = :other
           result.components = -1
           result.writable = false if result.type == :png
         end
 
-        result.writable = false if self[:SMask]
+        smask = self[:SMask]
+        if smask && (result.type != :png ||
+                     !(result.bits_per_component == 8 || result.bits_per_component == 16) ||
+                     result.bits_per_component != smask[:BitsPerComponent] ||
+                     result.width != smask[:Width] || result.height != smask[:Height])
+          result.writable = false
+        end
 
         result
       end
@@ -224,10 +234,18 @@ module HexaPDF
                        ImageLoader::PNG::INDEXED
                      elsif info.color_space == :rgb
                        ImageLoader::PNG::TRUECOLOR
+                     elsif info.color_space == :icc
+                       info.components == 3 ? ImageLoader::PNG::TRUECOLOR : ImageLoader::PNG::GREYSCALE
                      else
                        ImageLoader::PNG::GREYSCALE
                      end
 
+        if self[:SMask] && color_type != ImageLoader::PNG::INDEXED
+          color_type += 4 # change it to TrueColor/Greyscale with Alpha
+        end
+
+        flate_decode = config.constantize('filter.map', :FlateDecode)
+
         io << png_chunk('IHDR', [info.width, info.height, info.bits_per_component,
                                  color_type, 0, 0, 0].pack('N2C5'))
 
@@ -239,6 +257,12 @@ module HexaPDF
             png_chunk('cHRM', [31270, 32900, 64000, 33000, 30000, 60000, 15000, 6000].pack('N8'))
         end
 
+        if info.color_space == :icc
+          _, stream = *self[:ColorSpace]
+          data = flate_decode.encoder(stream.stream_decoder)
+          io << png_chunk('iCCP', "ICCProfile\x00\x00".b << Filter.string_from_source(data))
+        end
+
         if color_type == ImageLoader::PNG::INDEXED
           palette_data = self[:ColorSpace][3]
           palette_data = palette_data.stream unless palette_data.kind_of?(String)
@@ -258,11 +282,14 @@ module HexaPDF
 
         filter, = *self[:Filter]
         decode_parms, = *self[:DecodeParms]
-        if filter == :FlateDecode && decode_parms && decode_parms[:Predictor].to_i >= 10
+        if self[:SMask]
+          data = flate_decode.encoder(Fiber.new { png_combine_image_and_soft_mask(info) }, Predictor: 15,
+                                      Colors: info.components + 1, Columns: info.width,
+                                      BitsPerComponent: info.bits_per_component)
+        elsif filter == :FlateDecode && decode_parms && decode_parms[:Predictor].to_i >= 10
           data = stream_source
         else
           colors = (color_type == ImageLoader::PNG::INDEXED ? 1 : info.components)
-          flate_decode = config.constantize('filter.map', :FlateDecode)
           data = flate_decode.encoder(stream_decoder, Predictor: 15,
                                       Colors: colors, Columns: info.width,
                                       BitsPerComponent: info.bits_per_component)
@@ -277,6 +304,23 @@ module HexaPDF
         [data.length].pack("N") << type << data << [Zlib.crc32(data, Zlib.crc32(type))].pack("N")
       end
 
+      # Combines the image data with the soft mask data as needed for a PNG data stream.
+      def png_combine_image_and_soft_mask(info)
+        bytes_per_colors = info.bits_per_component * info.components / 8
+        bytes_per_alpha = info.bits_per_component / 8
+        image_data = stream
+        mask_data = self[:SMask].stream
+
+        data = ''.b
+        ii = im = 0
+        while ii < image_data.length
+          data << image_data[ii, bytes_per_colors] << mask_data[im, bytes_per_alpha]
+          ii += bytes_per_colors
+          im += bytes_per_alpha
+        end
+        data
+      end
+
     end
 
   end

data/lib/hexapdf/type/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

data/lib/hexapdf/type/names.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
@@ -63,6 +63,19 @@ module HexaPDF
       define_field :AlternatePresentations, type: NameTreeNode, version: '1.4'
       define_field :Renditions,             type: NameTreeNode, version: '1.5'
 
+      # Returns the destinations name tree containing a mapping from names to destination objects.
+      #
+      # The name tree will be created if needed.
+      #
+      # Note: It is possible to use this name tree directly, but HexaPDF::Document::Destinations
+      # provides a much easier to work with convenience interface for working with destination
+      # objects.
+      #
+      # See: PDF1.7 s12.3.2
+      def destinations
+        self[:Dests] ||= document.add({}, type: NameTreeNode)
+      end
+
     end
 
   end

data/lib/hexapdf/type/object_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-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/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-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/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-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
@@ -207,9 +207,26 @@ module HexaPDF
         end
 
         parent = page[:Parent]
+        prev_index = page.index
+        prev_kid_index = parent[:Kids].index(page)
+        if to_index < 0
+          to_index = self[:Count] + to_index + 1
+        elsif prev_index < to_index
+          to_index += 1
+        end
+
         insert_page(to_index, page)
+
         ancestors.each {|node| node[:Count] -= 1 }
-        parent[:Kids].delete(page)
+        if page[:Parent] == parent
+          if prev_index < to_index
+            parent[:Kids].delete_at(prev_kid_index)
+          else
+            parent[:Kids].delete_at(prev_kid_index + 1)
+          end
+        else
+          parent[:Kids].delete(page)
+        end
       end
 
       # :call-seq:

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-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/type/signature/adbe_pkcs7_detached.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/type/signature/adbe_x509_rsa_sha1.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/type/signature/handler.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/type/signature/verification_result.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/type/signature.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/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-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
@@ -69,7 +69,7 @@ module HexaPDF
 
       # Returns the document's Catalog (see Type::Catalog), creating it if needed.
       def catalog
-        self[:Root] ||= document.add({Type: :Catalog})
+        self[:Root] ||= document.add({Type: :Catalog}, type: :Catalog)
       end
 
       # Returns the document's information dictionary (see Type::Info), creating it if needed.

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-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/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-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
@@ -93,7 +93,8 @@ module HexaPDF
       #
       # See: Type::Trailer
       def trailer
-        Trailer.each_field.with_object({}) do |(name, _data), hash|
+        trailer = {Type: :XRef}
+        Trailer.each_field.with_object(trailer) do |(name, _data), hash|
           hash[name] = value[name] if key?(name)
         end
       end

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-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/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-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/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-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/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-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/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-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/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-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/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-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/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-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/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-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
@@ -168,11 +168,13 @@ module HexaPDF
             index = find_in_leaf_node(node[container_name], key)
             if node[container_name][index] == key
               result = node[container_name][index + 1]
+            else
+              break
             end
           elsif node.key?(:Kids)
             index = find_in_intermediate_node(node[:Kids], key)
             node = node[:Kids][index]
-            break unless key >= node[:Limits][0] && key <= node[:Limits][1]
+            break unless node && key >= node[:Limits][0] && key <= node[:Limits][1]
           else
             break
           end

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-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
@@ -37,6 +37,6 @@
 module HexaPDF
 
   # The version of HexaPDF.
-  VERSION = '0.21.1'
+  VERSION = '0.24.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-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
@@ -72,8 +72,10 @@ module HexaPDF
       @use_xref_streams = false
     end
 
-    # Writes the document to the IO object and returns the last XRefSection written.
+    # Writes the document to the IO object and returns the file position of the start of the last
+    # cross-reference section and the last XRefSection written.
     def write
+      move_modified_objects_into_current_revision
       write_file_header
 
       pos = xref_section = nil
@@ -82,11 +84,12 @@ module HexaPDF
         pos, xref_section = write_revision(rev, pos)
       end
 
-      xref_section
+      [pos, xref_section]
     end
 
     # Writes the complete source document unmodified to the IO and then one revision containing all
-    # changes. Returns the XRefSection of that one revision.
+    # changes. Returns the file position of the start of the cross-reference section and the
+    # XRefSection object of that one revision.
     #
     # For this method to work the document must have been created from an existing file.
     def write_incremental
@@ -103,15 +106,15 @@ module HexaPDF
       @io << "\n"
 
       @rev_size = @document.revisions.current.next_free_oid
-      @use_xref_streams = parser.contains_xref_streams?
+      @use_xref_streams = @document.revisions.any? {|rev| rev.trailer[:Type] == :XRef }
 
       revision = Revision.new(@document.revisions.current.trailer)
+      @document.trailer.info[:Producer] = "HexaPDF version #{HexaPDF::VERSION}"
       @document.revisions.each do |rev|
         rev.each_modified_object {|obj| revision.send(:add_without_check, obj) }
       end
-      _pos, xref_section = write_revision(revision, @document.revisions.parser.startxref_offset)
 
-      xref_section
+      write_revision(revision, parser.startxref_offset)
     end
 
     private
@@ -123,6 +126,18 @@ module HexaPDF
       @io << "%PDF-#{@document.version}\n%\xCF\xEC\xFF\xE8\xD7\xCB\xCD\n"
     end
 
+    # Moves all modified objects into the current revision to avoid invalid references and such.
+    def move_modified_objects_into_current_revision
+      return if @document.revisions.count == 1
+
+      revision = @document.revisions.add
+      @document.revisions.all[0..-2].each do |rev|
+        rev.each_modified_object {|obj| revision.send(:add_without_check, obj) }
+        rev.reset_objects
+      end
+      @document.revisions.merge(-2..-1)
+    end
+
     # Writes the given revision.
     #
     # The optional +previous_xref_pos+ argument needs to contain the byte position of the previous
@@ -190,7 +205,7 @@ module HexaPDF
       end
 
       if (!object_streams.empty? || @use_xref_streams) && xref_stream.nil?
-        xref_stream = @document.wrap({Type: :XRef}, oid: rev.next_free_oid)
+        xref_stream = @document.wrap({Type: :XRef}, oid: @document.revisions.next_oid)
         rev.add(xref_stream)
       end
 

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-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.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/test/hexapdf/content/graphic_object/test_geom2d.rb

@@ -57,7 +57,7 @@ describe HexaPDF::Content::GraphicObject::Geom2D do
       @obj.draw(@canvas)
       assert_operators(@canvas.contents,
                        [[:move_to, [5, 6]], [:line_to, [10, 11]], [:line_to, [7, 9]],
-                        [:stroke_path]])
+                        [:close_subpath], [:stroke_path]])
     end
 
     it "draws a Geom2D::PolygonSet onto the canvas" do