origamindee 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 593f3f22174161d77e20e75ff2a7a9ae577662861a59881073f78f2c51ac89df
-  data.tar.gz: fe531fa4cc790be0639dcc9703c782bb4f64d9f38ff29a468950fbc131369e52
+  metadata.gz: 40b6702a0d5d7660322722b8a4a14ca8cf216cebe42aaebeb7355d41a66bd83a
+  data.tar.gz: 3c33400d7d5b8db653770eb1d1ca4d8e2ee5919267b3089b12ca02b6f4d889f7
 SHA512:
-  metadata.gz: 92eb2ab3d99b12da581091ecc5958ac21e3a692294d1c41cca586aa38be18f9d0c91a667cdaeee40be40cd3bd8f593747b03bf6528c675d9dd5df91fa671a4b0
-  data.tar.gz: 9aef422a383150380c49a548429d48cd34905982fae8ef1a0a88f782e5103f5d95944f0c22b037ea2c9781575314f73e84a0f6a780b1164047806a79177cba9d
+  metadata.gz: 5e7395d76443c6ad6a354f291eb0d3a02b898dc39d448144558fbbf755bb2fc01cd9bb4dd12724ba7d315f14f401588bab1a2036c2c00e392b6fd51556c51b3f
+  data.tar.gz: 5e18ca5e74f693c424c206ff92d786346dab5162687ee012646359147858968c218db24ca8832be6d3cb50fb2b6ed90352306b2c5230e4a67eb2399bd617a7b4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+3.1.0
+-----
+* Add page deletion methods
+* Add running tests on Ruby 3.2
+
 3.0.0
 -----
 * Replaced Colorize with Rainbow for LGPL compatibility

data/README.md

@@ -27,7 +27,7 @@ Origami is able to parse PDF, FDF and PPKLite (Adobe certificate store) files.
 
 Requirements
 ------------
-The following Ruby versions are tested and supported: 2.6, 2.7, 3.0, 3.1
+The following Ruby versions are tested and supported: 2.6, 2.7, 3.0, 3.1, 3.2
 
 Some optional features require additional gems:
 

data/bin/shell/console.rb

@@ -1,128 +1,128 @@
-=begin
-
-    This file is part of Origami, PDF manipulation framework for Ruby
-    Copyright (C) 2016	Guillaume Delugré.
-
-    Origami is free software: you can redistribute it and/or modify
-    it under the terms of the GNU Lesser General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    Origami 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 Lesser General Public License for more details.
-
-    You should have received a copy of the GNU Lesser General Public License
-    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
-
-=end
-
-require 'tempfile'
-require 'hexdump'
-require 'colorize'
-
-String.disable_colorization(false)
-
-module Origami
-    module Object
-        def inspect
-            to_s
-        end
-    end
-
-    class Stream
-        def edit(editor = ENV['EDITOR'])
-            Tempfile.open("origami") do |tmpfile|
-                tmpfile.write(self.data)
-                tmpfile.flush
-
-                Process.wait Kernel.spawn "#{editor} #{tmpfile.path}"
-
-                self.data = File.read(tmpfile.path)
-                tmpfile.unlink
-            end
-
-            true
-        end
-
-        def inspect
-            self.data.hexdump
-        end
-    end
-
-    class Page < Dictionary
-        def edit
-            each_content_stream do |stream|
-                stream.edit
-            end
-        end
-    end
-
-    class PDF
-        if defined?(PDF::JavaScript::Engine)
-            class JavaScript::Engine
-                def shell
-                    loop do
-                        print "js > ".magenta
-                        break if (line = gets).nil?
-
-                        begin
-                            puts exec(line)
-                        rescue V8::JSError => e
-                            puts "Error: #{e.message}"
-                        end
-                    end
-                end
-            end
-        end
-
-        class Revision
-            def to_s
-                puts "----------  Body  ----------".white.bold
-                @body.each_value do |obj|
-                    print "#{obj.reference.to_s.rjust(8,' ')}".ljust(10).magenta
-                    puts "#{obj.type}".yellow
-                end
-
-                puts "---------- Trailer ---------".white.bold
-                if not @trailer.dictionary
-                    puts "  [x] No trailer found.".blue
-                else
-                    @trailer.dictionary.each_pair do |entry, value|
-                        print "  [*] ".magenta
-                        print "#{entry}: ".yellow
-                        puts "#{value}".red
-                    end
-
-                    print "  [+] ".magenta
-                    print "startxref: ".yellow
-                    puts "#{@trailer.startxref}".red
-                end
-            end
-
-            def inspect
-                to_s
-            end
-        end
-
-        def to_s
-            puts
-
-            puts "---------- Header ----------".white.bold
-            print "  [+] ".magenta
-            print "Version: ".yellow
-            puts "#{@header.major_version}.#{@header.minor_version}".red
-
-            @revisions.each do |revision|
-                revision.to_s
-            end
-            puts
-        end
-
-        def inspect
-            to_s
-        end
-    end
-
-end
+=begin
+
+    This file is part of Origami, PDF manipulation framework for Ruby
+    Copyright (C) 2016	Guillaume Delugré.
+
+    Origami is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Origami 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 Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+require 'tempfile'
+require 'hexdump'
+require 'colorize'
+
+String.disable_colorization(false)
+
+module Origami
+    module Object
+        def inspect
+            to_s
+        end
+    end
+
+    class Stream
+        def edit(editor = ENV['EDITOR'])
+            Tempfile.open("origami") do |tmpfile|
+                tmpfile.write(self.data)
+                tmpfile.flush
+
+                Process.wait Kernel.spawn "#{editor} #{tmpfile.path}"
+
+                self.data = File.read(tmpfile.path)
+                tmpfile.unlink
+            end
+
+            true
+        end
+
+        def inspect
+            self.data.hexdump
+        end
+    end
+
+    class Page < Dictionary
+        def edit
+            each_content_stream do |stream|
+                stream.edit
+            end
+        end
+    end
+
+    class PDF
+        if defined?(PDF::JavaScript::Engine)
+            class JavaScript::Engine
+                def shell
+                    loop do
+                        print "js > ".magenta
+                        break if (line = gets).nil?
+
+                        begin
+                            puts exec(line)
+                        rescue V8::JSError => e
+                            puts "Error: #{e.message}"
+                        end
+                    end
+                end
+            end
+        end
+
+        class Revision
+            def to_s
+                puts "----------  Body  ----------".white.bold
+                @body.each_value do |obj|
+                    print "#{obj.reference.to_s.rjust(8,' ')}".ljust(10).magenta
+                    puts "#{obj.type}".yellow
+                end
+
+                puts "---------- Trailer ---------".white.bold
+                if not @trailer.dictionary
+                    puts "  [x] No trailer found.".blue
+                else
+                    @trailer.dictionary.each_pair do |entry, value|
+                        print "  [*] ".magenta
+                        print "#{entry}: ".yellow
+                        puts "#{value}".red
+                    end
+
+                    print "  [+] ".magenta
+                    print "startxref: ".yellow
+                    puts "#{@trailer.startxref}".red
+                end
+            end
+
+            def inspect
+                to_s
+            end
+        end
+
+        def to_s
+            puts
+
+            puts "---------- Header ----------".white.bold
+            print "  [+] ".magenta
+            print "Version: ".yellow
+            puts "#{@header.major_version}.#{@header.minor_version}".red
+
+            @revisions.each do |revision|
+                revision.to_s
+            end
+            puts
+        end
+
+        def inspect
+            to_s
+        end
+    end
+
+end

data/lib/origami/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 =begin
 
     This file is part of Origami, PDF manipulation framework for Ruby
@@ -57,6 +59,28 @@ module Origami
             self
         end
 
+        #
+        # Deletes a page at position _index_ from the document.
+        # _index_:: Page index (starting from one).
+        #
+        def delete_page_at(index)
+            init_page_tree
+
+            self.Catalog.Pages.delete_page_at(index)
+            self
+        end
+
+        #
+        # Deletes a page at position _index_ from the document.
+        # _index_:: Page index (starting from one).
+        #
+        def delete_pages_at(delete_idx)
+            init_page_tree
+
+            self.Catalog.Pages.delete_pages_at(delete_idx)
+            self
+        end
+
         #
         # Returns an Enumerator of Page
         #
@@ -107,7 +131,7 @@ module Origami
             end
 
             unless self.Catalog.Pages.is_a?(PageTreeNode)
-                raise InvalidPageTreeError, "Root page node is not a PageTreeNode"
+                raise InvalidPageTreeError, 'Root page node is not a PageTreeNode'
             end
         end
     end
@@ -250,11 +274,11 @@ module Origami
         field   EXTGSTATE,    :Type => Dictionary
         field   COLORSPACE,   :Type => Dictionary
         field   PATTERN,      :Type => Dictionary
-        field   SHADING,      :Type => Dictionary, :Version => "1.3"
+        field   SHADING,      :Type => Dictionary, :Version => '1.3'
         field   XOBJECT,      :Type => Dictionary
         field   FONT,         :Type => Dictionary
         field   :ProcSet,     :Type => Array.of(Name)
-        field   PROPERTIES,   :Type => Dictionary, :Version => "1.2"
+        field   PROPERTIES,   :Type => Dictionary, :Version => '1.2'
 
         def pre_build
             add_font(Font::Type1::Standard::Helvetica.new.pre_build) unless self.Font
@@ -294,11 +318,11 @@ module Origami
         # Inserts a page into the node at a specified position (starting from 1).
         #
         def insert_page(n, page)
-            raise IndexError, "Page numbers are referenced starting from 1" if n < 1
+            raise IndexError, 'Page numbers are referenced starting from 1' if n < 1
 
             kids = self.Kids
             unless kids.is_a?(Array)
-                raise InvalidPageTreeError, "Kids must be an Array"
+                raise InvalidPageTreeError, 'Kids must be an Array'
             end
 
             count = 0
@@ -323,15 +347,87 @@ module Origami
                         return self
                     end
                 else
-                    raise InvalidPageTreeError, "not a Page or PageTreeNode"
+                    raise InvalidPageTreeError, 'not a Page or PageTreeNode'
                 end
             end
 
-            raise IndexError, "Out of order page index" unless count + 1 == n
+            raise IndexError, 'Out of order page index' unless count + 1 == n
 
             self.append_page(page)
         end
 
+        #
+        # Delete a page in the node at the specified position (starting from 1).
+        #
+        def delete_page_at(n)
+            raise IndexError, 'Page numbers are referenced starting from 1' if n < 1
+
+            kids = self.Kids
+            unless kids.is_a?(Array)
+                raise InvalidPageTreeError, 'Kids must be an Array'
+            end
+
+            count = 0
+            kids.each_with_index do |kid, index|
+                node = kid.solve
+
+                case node
+                when Page
+                    count = count + 1
+                    if count == n
+                        kids.delete_at(index)
+                        self.Count -= 1
+                        return self
+                    end
+
+                when PageTreeNode
+                    count = count + node.Count
+                    if count >= n
+                        node.delete_page_at(n - count + node.Count)
+                        self.Count -= 1
+                        return self
+                    end
+                else
+                    raise InvalidPageTreeError, 'not a Page or PageTreeNode'
+                end
+            end
+
+            raise IndexError, 'Out of order page index' unless count + 1 == n
+        end
+
+        #
+        # Delete a set of page in the node at the specified positions (starting from 0).
+        #
+        def delete_pages_at(delete_idx, offset = 0)
+            kids = self.Kids
+            unless kids.is_a?(Array)
+                raise InvalidPageTreeError, 'Kids must be an Array'
+            end
+
+            deleted = 0
+            kids.delete_if.with_index do |kid, idx|
+                node = kid.solve
+                idx = idx + offset
+
+                case node
+                when Page
+                    if delete_idx.include?(idx)
+                        deleted += 1
+                        true
+                    else
+                        false
+                    end
+                when PageTreeNode
+                    deleted += node.delete_pages_at(delete_idx, idx)
+                    false
+                else
+                    raise InvalidPageTreeError, 'not a Page or PageTreeNode'
+                end
+            end
+            self.Count -= deleted
+            deleted
+        end
+
         #
         # Returns an Array of Pages inheriting this tree node.
         #
@@ -346,11 +442,11 @@ module Origami
             return enum_for(__method__) { self.Count.to_i } unless block_given?
 
             if browsed_nodes.any?{|node| node.equal?(self)}
-                raise InvalidPageTreeError, "Cyclic tree graph detected"
+                raise InvalidPageTreeError, 'Cyclic tree graph detected'
             end
 
             unless self.Kids.is_a?(Array)
-                raise InvalidPageTreeError, "Kids must be an Array"
+                raise InvalidPageTreeError, 'Kids must be an Array'
             end
 
             browsed_nodes.push(self)
@@ -363,7 +459,7 @@ module Origami
                     when PageTreeNode then node.each_page(browsed_nodes: browsed_nodes, &block)
                     when Page then yield(node)
                     else
-                        raise InvalidPageTreeError, "not a Page or PageTreeNode"
+                        raise InvalidPageTreeError, 'not a Page or PageTreeNode'
                     end
                 end
             end
@@ -375,10 +471,10 @@ module Origami
         # Get the n-th Page object in this node, starting from 1.
         #
         def get_page(n)
-            raise IndexError, "Page numbers are referenced starting from 1" if n < 1
-            raise IndexError, "Page not found" if n > self.Count.to_i
+            raise IndexError, 'Page numbers are referenced starting from 1' if n < 1
+            raise IndexError, 'Page not found' if n > self.Count.to_i
 
-            self.each_page.lazy.drop(n - 1).first or raise IndexError, "Page not found"
+            self.each_page.lazy.drop(n - 1).first or raise IndexError, 'Page not found'
         end
 
         #
@@ -481,8 +577,8 @@ module Origami
         class AdditionalActions < Dictionary
             include StandardObject
 
-            field   :O,   :Type => Dictionary, :Version => "1.2" # Page Open
-            field   :C,   :Type => Dictionary, :Version => "1.2" # Page Close
+            field   :O,   :Type => Dictionary, :Version => '1.2' # Page Open
+            field   :C,   :Type => Dictionary, :Version => '1.2' # Page Close
         end
 
         module Format
@@ -513,34 +609,34 @@ module Origami
 
         field   :Type,                  :Type => Name, :Default => :Page, :Required => true
         field   :Parent,                :Type => PageTreeNode, :Required => true
-        field   :LastModified,          :Type => String, :Version => "1.3"
+        field   :LastModified,          :Type => String, :Version => '1.3'
         field   :Resources,             :Type => Resources, :Required => true
         field   :MediaBox,              :Type => Rectangle, :Default => Format::A4, :Required => true
         field   :CropBox,               :Type => Rectangle
-        field   :BleedBox,              :Type => Rectangle, :Version => "1.3"
-        field   :TrimBox,               :Type => Rectangle, :Version => "1.3"
-        field   :ArtBox,                :Type => Rectangle, :Version => "1.3"
-        field   :BoxColorInfo,          :Type => BoxColorInformation, :Version => "1.4"
+        field   :BleedBox,              :Type => Rectangle, :Version => '1.3'
+        field   :TrimBox,               :Type => Rectangle, :Version => '1.3'
+        field   :ArtBox,                :Type => Rectangle, :Version => '1.3'
+        field   :BoxColorInfo,          :Type => BoxColorInformation, :Version => '1.4'
         field   :Contents,              :Type => [ ContentStream, Array.of(ContentStream) ]
         field   :Rotate,                :Type => Integer, :Default => 0
-        field   :Group,                 :Type => Dictionary, :Version => "1.4"
+        field   :Group,                 :Type => Dictionary, :Version => '1.4'
         field   :Thumb,                 :Type => Graphics::ImageXObject
-        field   :B,                     :Type => Array, :Version => "1.1"
-        field   :Dur,                   :Type => Integer, :Version => "1.1"
-        field   :Trans,                 :Type => Dictionary, :Version => "1.1"
+        field   :B,                     :Type => Array, :Version => '1.1'
+        field   :Dur,                   :Type => Integer, :Version => '1.1'
+        field   :Trans,                 :Type => Dictionary, :Version => '1.1'
         field   :Annots,                :Type => Array.of(Annotation)
-        field   :AA,                    :Type => AdditionalActions, :Version => "1.2"
-        field   :Metadata,              :Type => MetadataStream, :Version => "1.4"
-        field   :PieceInfo,             :Type => Dictionary, :Version => "1.2"
-        field   :StructParents,         :Type => Integer, :Version => "1.3"
+        field   :AA,                    :Type => AdditionalActions, :Version => '1.2'
+        field   :Metadata,              :Type => MetadataStream, :Version => '1.4'
+        field   :PieceInfo,             :Type => Dictionary, :Version => '1.2'
+        field   :StructParents,         :Type => Integer, :Version => '1.3'
         field   :ID,                    :Type => String
         field   :PZ,                    :Type => Number
-        field   :SeparationInfo,        :Type => Dictionary, :Version => "1.3"
-        field   :Tabs,                  :Type => Name, :Version => "1.5"
-        field   :TemplateAssociated,    :Type => Name, :Version => "1.5"
-        field   :PresSteps,             :Type => NavigationNode, :Version => "1.5"
-        field   :UserUnit,              :Type => Number, :Default => 1.0, :Version => "1.6"
-        field   :VP,                    :Type => Dictionary, :Version => "1.6"
+        field   :SeparationInfo,        :Type => Dictionary, :Version => '1.3'
+        field   :Tabs,                  :Type => Name, :Version => '1.5'
+        field   :TemplateAssociated,    :Type => Name, :Version => '1.5'
+        field   :PresSteps,             :Type => NavigationNode, :Version => '1.5'
+        field   :UserUnit,              :Type => Number, :Default => 1.0, :Version => '1.6'
+        field   :VP,                    :Type => Dictionary, :Version => '1.6'
 
         def initialize(hash = {}, parser = nil)
             super(hash, parser)

data/lib/origami/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 =begin
 
     This file is part of Origami, PDF manipulation framework for Ruby
@@ -19,5 +21,5 @@
 =end
 
 module Origami
-    VERSION   = "3.0.0"
+    VERSION   = '3.1.0'
 end 

data/test/test_pages.rb

@@ -51,10 +51,33 @@ class TestPages < Minitest::Test
         assert_raises(IndexError) { @target.insert_page(1000, Page.new) }
     end
 
-    def test_example_write_page
+    def test_example_write_delete_page
         @target.append_page
-        @target.pages.first.write 'Hello, world!', size: 30
+        @target.pages.last.write 'Hello, page 1 world!', size: 30
+        @target.append_page
+        @target.pages.last.write 'Hello, page 2 world!', size: 30
+        @target.save(@output)
+        assert_equal @target.Catalog.Pages.Count, 2
+
+        @target.delete_page_at(1)
         @target.save(@output)
         assert_equal @target.Catalog.Pages.Count, 1
     end
+
+    def test_delete_pages_generated
+        to_append = [Page.new, Page.new, Page.new, PageTreeNode.new, Page.new, Page.new, Page.new]
+        to_append.each { |page| @target.append_page(page) }
+        to_del = [0,1]
+        assert_equal @target.Catalog.Pages.Count, to_append.length
+        @target.delete_pages_at(to_del)
+        assert_equal @target.Catalog.Pages.Count, to_append.length - to_del.length
+    end
+
+    def test_delete_pages_parsed
+        file = File.join(__dir__, 'dataset', '3_pages.pdf')
+        pdf = PDF.read(file, ignore_errors: false, verbosity: Parser::VERBOSE_QUIET)
+        assert_equal pdf.Catalog.Pages.Count, 3
+        pdf.delete_pages_at([0,2])
+        assert_equal pdf.Catalog.Pages.Count, 1
+    end
 end

data/test/test_pdf_parse.rb

@@ -1,18 +1,11 @@
 require 'minitest/autorun'
 
 class TestPDFParser < Minitest::Test
-    def setup
-        @files =
-            %w{
-              dataset/empty.pdf
-              dataset/calc.pdf
-              dataset/crypto.pdf
-              }
-    end
 
     def test_parse_pdf
-        @files.each do |file|
-            pdf = PDF.read(File.join(__dir__, file), ignore_errors: false, verbosity: Parser::VERBOSE_QUIET)
+        dir = File.join(__dir__, 'dataset')
+        Dir.children(dir).each do | filename |
+            pdf = PDF.read(File.join(dir, filename), ignore_errors: false, verbosity: Parser::VERBOSE_QUIET)
 
             assert_instance_of PDF, pdf
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: origamindee
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Guillaume Delugré
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -232,9 +232,12 @@ files:
 - lib/origami/xfa/xfdf.rb
 - lib/origami/xfa/xmpmeta.rb
 - lib/origami/xreftable.rb
+- test/dataset/3_pages.pdf
 - test/dataset/calc.pdf
 - test/dataset/crypto.pdf
 - test/dataset/empty.pdf
+- test/dataset/image_only.pdf
+- test/dataset/invoice.pdf
 - test/test_actions.rb
 - test/test_annotations.rb
 - test/test_forms.rb