hexapdf 0.11.9 → 0.13.0

data/test/hexapdf/type/test_page_tree_node.rb

@@ -155,36 +155,44 @@ describe HexaPDF::Type::PageTreeNode do
     end
 
     it "deletes the correct page by index" do
-      assert_equal(@pages[2], @root.delete_page(2))
+      @root.delete_page(2)
       assert_equal(2, @kid12.page_count)
       assert_equal(4, @kid1.page_count)
       assert_equal(7, @root.page_count)
-      assert_nil(@pages[2][:Parent])
+      assert(@pages[2].null?)
 
-      assert_equal(@pages[5], @root.delete_page(4))
+      @root.delete_page(4)
       assert_equal(6, @root.page_count)
-      assert_nil(@pages[5][:Parent])
+      assert(@pages[5].null?)
     end
 
     it "deletes the given page" do
-      assert_equal(@pages[2], @root.delete_page(@pages[2]))
-      assert_equal(@pages[5], @root.delete_page(@pages[5]))
+      @root.delete_page(@pages[2])
+      assert(@pages[2].null?)
+      @root.delete_page(@pages[5])
+      assert(@pages[5].null?)
     end
 
     it "allows deleting a page from an intermediary node" do
-      assert_equal(@pages[2], @kid1.delete_page(@pages[2]))
+      @kid1.delete_page(@pages[2])
       assert_equal(7, @root.page_count)
     end
 
     it "does nothing if the page index is not valid" do
-      assert_nil(@root.delete_page(20))
-      assert_nil(@root.delete_page(-20))
+      @root.delete_page(20)
+      @root.delete_page(-20)
       assert_equal(8, @root.page_count)
     end
 
-    it "does nothing if the page is not in its parent's /Kids array" do
+    it "does nothing if the page has already been deleted" do
+      @root.delete_page(@pages[2])
+      @root.delete_page(@pages[2])
+      assert_equal(7, @root.page_count)
+    end
+
+    it "fails if the page is not in its parent's /Kids array" do
       @kid12[:Kids].delete_at(0)
-      assert_nil(@root.delete_page(@pages[2]))
+      assert_raises(HexaPDF::Error) { @root.delete_page(@pages[2]) }
       assert_equal(8, @root.page_count)
     end
 
@@ -193,11 +201,53 @@ describe HexaPDF::Type::PageTreeNode do
       page = @doc.add({Type: :Page, Parent: pages})
       pages[:Kids] << page
 
-      assert_nil(@root.delete_page(page))
+      @root.delete_page(page)
       assert_equal(8, @root.page_count)
     end
   end
 
+  describe "move_page" do
+    before do
+      define_multilevel_page_tree
+    end
+
+    it "moves the page to the first place" do
+      @root.move_page(@pages[1], 0)
+      assert_equal([@pages[1], @pages[0], *@pages[2..-1]], @root.each_page.to_a)
+      assert(@root.validate)
+    end
+
+    it "moves the page to the correct location with a positive index" do
+      @root.move_page(1, 3)
+      assert_equal([@pages[0], @pages[2], @pages[1], *@pages[3..-1]], @root.each_page.to_a)
+      assert(@root.validate)
+    end
+
+    it "moves the page to the last place" do
+      @root.move_page(1, -1)
+      assert_equal([@pages[0], *@pages[2..-1], @pages[1]], @root.each_page.to_a)
+      assert(@root.validate)
+    end
+
+    it "fails if the index to the moving page is invalid" do
+      assert_raises(HexaPDF::Error) { @root.move_page(10, 0) }
+    end
+
+    it "fails if the moving page was deleted/is null" do
+      @doc.delete(@pages[0])
+      assert_raises(HexaPDF::Error) { @root.move_page(@pages[0], 3) }
+    end
+
+    it "fails if the page was not yet added to a page tree" do
+      page = @doc.add({Type: :Page})
+      assert_raises(HexaPDF::Error) { @root.move_page(page, 3) }
+    end
+
+    it "fails if the page is not part of the page tree" do
+      assert_raises(HexaPDF::Error) { @kid1.move_page(@pages[6], 3) }
+    end
+  end
+
   describe "each_page" do
     before do
       define_multilevel_page_tree

data/test/hexapdf/type/test_resources.rb

@@ -25,6 +25,10 @@ describe HexaPDF::Type::Resources do
       assert_kind_of(HexaPDF::Content::ColorSpace::Universal, @res.color_space(:CSName))
     end
 
+    it "works for the Pattern color space" do
+      assert_kind_of(HexaPDF::Content::ColorSpace::Universal, @res.color_space(:Pattern))
+    end
+
     it "returns the universal color space for unknown color spaces, with resolved references" do
       data = @doc.add({Some: :data})
       @res[:ColorSpace] = {CSName: [:SomeUnknownColorSpace,
@@ -168,6 +172,22 @@ describe HexaPDF::Type::Resources do
     end
   end
 
+  describe "pattern" do
+    it "invokes the object_getter method" do
+      assert_method_invoked(@res, :object_getter, [:Pattern, :test]) do
+        @res.pattern(:test)
+      end
+    end
+  end
+
+  describe "add_pattern" do
+    it "invokes the object_setter method" do
+      assert_method_invoked(@res, :object_setter, [:Pattern, 'P', :test]) do
+        @res.add_pattern(:test)
+      end
+    end
+  end
+
   describe "validation" do
     it "assigns the default value if ProcSet is not set" do
       @res.validate

data/test/hexapdf/type/test_trailer.rb

@@ -9,12 +9,16 @@ describe HexaPDF::Type::Trailer do
   before do
     @doc = Object.new
     @doc.instance_variable_set(:@version, '1.2')
+
     def (@doc).version=(v); @version = v; end
+
     def (@doc).deref(obj); obj; end
+
     def (@doc).wrap(obj, *)
       (obj.kind_of?(Array) ? HexaPDF::PDFArray : HexaPDF::Dictionary).
         new(obj, oid: (obj.oid rescue 0))
     end
+
     root = HexaPDF::Dictionary.new({}, oid: 3)
     @obj = HexaPDF::Type::Trailer.new({Size: 10, Root: root}, document: @doc)
   end

data/test/hexapdf/utils/test_bit_field.rb

@@ -6,8 +6,11 @@ require 'hexapdf/utils/bit_field'
 class TestBitField
 
   extend HexaPDF::Utils::BitField
+
   attr_accessor :data
-  bit_field(:data, {bit0: 0, bit1: 1, bit5: 5}, lister: "list", getter: "get", setter: "set")
+
+  bit_field(:data, {bit0: 0, bit1: 1, bit5: 5}, lister: "list", getter: "get", setter: "set",
+            unsetter: 'unset')
 
 end
 
@@ -16,6 +19,10 @@ describe HexaPDF::Utils::BitField do
     @obj = TestBitField.new
   end
 
+  it "allows inspection of the defined bits" do
+    assert_equal({bit0: 0, bit1: 1, bit5: 5}, TestBitField::DATA_BIT_MAPPING)
+  end
+
   it "returns all bit names using the lister method" do
     @obj.data = 0b100011
     assert_equal([:bit0, :bit1, :bit5], @obj.list)
@@ -40,6 +47,13 @@ describe HexaPDF::Utils::BitField do
     assert_equal(0b100001, @obj.data)
   end
 
+  it "can unset a given bit via the unsetter method" do
+    @obj.set(:bit0, :bit5)
+    assert_equal(0b100001, @obj.data)
+    @obj.unset(:bit5)
+    assert_equal(0b000001, @obj.data)
+  end
+
   it "fails if an unknown bit name or bit index is used with one of the methods" do
     e = assert_raises(ArgumentError) { @obj.get(10) }
     assert_equal("Invalid bit field name or index '10' for TestBitField#data", e.message)

data/test/hexapdf/utils/test_sorted_tree_node.rb

@@ -13,9 +13,9 @@ describe HexaPDF::Utils::SortedTreeNode do
 
   def add_multilevel_entries
     @kid11 = @doc.add({Limits: ['c', 'f'], Names: ['c', 1, 'f', 1]}, type: HexaPDF::NameTreeNode)
-    @kid12 = @doc.add({Limits: ['i', 'm'], Names: ['i', 1, 'm', 1]})
+    @kid12 = @doc.add({Limits: ['i', 'm'], Names: ['i', 1, 'm', 1]}, type: HexaPDF::NameTreeNode)
     ref = HexaPDF::Reference.new(@kid11.oid, @kid11.gen)
-    @kid1 = @doc.add({Limits: ['c', 'm'], Kids: [ref, @kid12]})
+    @kid1 = @doc.add({Limits: ['c', 'm'], Kids: [ref, @kid12]}, type: HexaPDF::NameTreeNode)
     @kid21 = @doc.add({Limits: ['o', 'q'], Names: ['o', 1, 'q', 1]}, type: HexaPDF::NameTreeNode)
     @kid221 = @doc.add({Limits: ['s', 'u'], Names: ['s', 1, 'u', 1]}, type: HexaPDF::NameTreeNode)
     @kid22 = @doc.add({Limits: ['s', 'u'], Kids: [@kid221]}, type: HexaPDF::NameTreeNode)
@@ -73,11 +73,11 @@ describe HexaPDF::Utils::SortedTreeNode do
       @root.add_entry('p', 1)
       @root.add_entry('r', 1)
       @root.add_entry('v', 1)
-      assert_equal(['a', 'm'], @kid1[:Limits])
+      assert_equal(['a', 'm'], @kid1[:Limits].value)
       assert_equal(['a', 'f'], @kid11[:Limits].value)
       assert_equal(['a', 1, 'c', 1, 'e', 1, 'f', 1], @kid11[:Names].value)
-      assert_equal(['g', 'm'], @kid12[:Limits])
-      assert_equal(['g', 1, 'i', 1, 'j', 1, 'm', 1], @kid12[:Names])
+      assert_equal(['g', 'm'], @kid12[:Limits].value)
+      assert_equal(['g', 1, 'i', 1, 'j', 1, 'm', 1], @kid12[:Names].value)
       assert_equal(['n', 'v'], @kid2[:Limits].value)
       assert_equal(['n', 'q'], @kid21[:Limits].value)
       assert_equal(['n', 1, 'o', 1, 'p', 1, 'q', 1], @kid21[:Names].value)
@@ -193,15 +193,16 @@ describe HexaPDF::Utils::SortedTreeNode do
     end
 
     it "checks that all kid objects are indirect objects" do
-      @root[:Kids][0] = HexaPDF::Reference.new(@kid1.oid, @kid1.gen)
+      @root[:Kids][0] = ref = HexaPDF::Reference.new(@kid1.oid, @kid1.gen)
       assert(@root.validate)
 
-      @root[:Kids][0] = @kid1
+      @root[:Kids][0] = ref
       @kid1.oid = 0
-      refute(@root.validate do |message, c|
+      assert(@root.validate do |message, c|
                assert_match(/must be indirect objects/, message)
-               refute(c)
+               assert(c)
              end)
+      assert(@kid1.indirect?)
     end
 
     it "checks that leaf node containers have an even number of entries" do

data/test/test_helper.rb

@@ -53,4 +53,4 @@ module TestHelper
   end
 end
 
-Minitest::Spec.send(:include, TestHelper)
+Minitest::Spec.include(TestHelper)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 0.11.9
+  version: 0.13.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse
@@ -36,54 +36,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: reline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: '1.0'
 description: |
   HexaPDF is a pure Ruby library with an accompanying application for working with PDF
   files.
@@ -209,6 +211,7 @@ files:
 - examples/016-frame_automatic_box_placement.rb
 - examples/017-frame_text_flow.rb
 - examples/018-composer.rb
+- examples/019-acro_form.rb
 - examples/emoji-smile.png
 - examples/emoji-wink.png
 - examples/machupicchu.jpg
@@ -217,6 +220,7 @@ files:
 - lib/hexapdf/cli/batch.rb
 - lib/hexapdf/cli/command.rb
 - lib/hexapdf/cli/files.rb
+- lib/hexapdf/cli/form.rb
 - lib/hexapdf/cli/image2pdf.rb
 - lib/hexapdf/cli/images.rb
 - lib/hexapdf/cli/info.rb
@@ -263,11 +267,10 @@ files:
 - lib/hexapdf/filter.rb
 - lib/hexapdf/filter/ascii85_decode.rb
 - lib/hexapdf/filter/ascii_hex_decode.rb
-- lib/hexapdf/filter/dct_decode.rb
 - lib/hexapdf/filter/encryption.rb
 - lib/hexapdf/filter/flate_decode.rb
-- lib/hexapdf/filter/jpx_decode.rb
 - lib/hexapdf/filter/lzw_decode.rb
+- lib/hexapdf/filter/pass_through.rb
 - lib/hexapdf/filter/predictor.rb
 - lib/hexapdf/filter/run_length_decode.rb
 - lib/hexapdf/font/cmap.rb
@@ -350,8 +353,13 @@ files:
 - lib/hexapdf/tokenizer.rb
 - lib/hexapdf/type.rb
 - lib/hexapdf/type/acro_form.rb
+- lib/hexapdf/type/acro_form/appearance_generator.rb
+- lib/hexapdf/type/acro_form/button_field.rb
+- lib/hexapdf/type/acro_form/choice_field.rb
 - lib/hexapdf/type/acro_form/field.rb
 - lib/hexapdf/type/acro_form/form.rb
+- lib/hexapdf/type/acro_form/text_field.rb
+- lib/hexapdf/type/acro_form/variable_text_field.rb
 - lib/hexapdf/type/action.rb
 - lib/hexapdf/type/actions.rb
 - lib/hexapdf/type/actions/go_to.rb
@@ -580,8 +588,13 @@ files:
 - test/hexapdf/test_type.rb
 - test/hexapdf/test_writer.rb
 - test/hexapdf/test_xref_section.rb
+- test/hexapdf/type/acro_form/test_appearance_generator.rb
+- test/hexapdf/type/acro_form/test_button_field.rb
+- test/hexapdf/type/acro_form/test_choice_field.rb
 - test/hexapdf/type/acro_form/test_field.rb
 - test/hexapdf/type/acro_form/test_form.rb
+- test/hexapdf/type/acro_form/test_text_field.rb
+- test/hexapdf/type/acro_form/test_variable_text_field.rb
 - test/hexapdf/type/actions/test_launch.rb
 - test/hexapdf/type/actions/test_uri.rb
 - test/hexapdf/type/annotations/test_markup_annotation.rb

data/lib/hexapdf/filter/dct_decode.rb

@@ -1,60 +0,0 @@
-# -*- 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-2019 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/>.
-#++
-
-module HexaPDF
-  module Filter
-
-    # The DCTDecode filter is currently only implemented as a pass-through filter, ie. the source
-    # gets passed on unmodified. This also means that the :ColorTransform parameter is not
-    # evaluated!
-    #
-    # See: HexaPDF::Filter, PDF1.7 s7.4.8
-    module DCTDecode
-
-      # See HexaPDF::Filter
-      def self.decoder(source, _ = nil)
-        source
-      end
-
-      # See HexaPDF::Filter
-      def self.encoder(source, _ = nil)
-        source
-      end
-
-    end
-
-  end
-end