origami-docspring 2.2.0 → 2.3.0

data/lib/origami.rb

@@ -1,46 +1,45 @@
-=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
+# frozen_string_literal: true
+
+#
+#     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/>.
+#
 
 module Origami
-
-    #
-    # Common Exception class for Origami errors.
-    #
-    class Error < StandardError
-    end
-  
-    #
-    # Global options for Origami.
-    #
-    OPTIONS = 
+  #
+  # Common Exception class for Origami errors.
+  #
+  class Error < StandardError
+  end
+
+  #
+  # Global options for Origami.
+  #
+  OPTIONS =
     {
-        enable_type_checking: true,      # set to false to disable type consistency checks during compilation.
-        enable_type_guessing: true,      # set to false to prevent the parser to guess the type of special dictionary and streams (not recommended).
-        enable_type_propagation: true,   # set to false to prevent the parser to propagate type from parents to children.
-        ignore_bad_references: false,    # set to interpret invalid references as Null objects, instead of raising an exception.
-        ignore_zlib_errors: false,       # set to true to ignore exceptions on invalid Flate streams.
-        ignore_png_errors: false,        # set to true to ignore exceptions on invalid PNG predictors.
+      enable_type_checking: true,      # set to false to disable type consistency checks during compilation.
+      enable_type_guessing: true,      # set to false to prevent the parser to guess the type of special dictionary and streams (not recommended).
+      enable_type_propagation: true,   # set to false to prevent the parser to propagate type from parents to children.
+      ignore_bad_references: false,    # set to interpret invalid references as Null objects, instead of raising an exception.
+      ignore_zlib_errors: false,       # set to true to ignore exceptions on invalid Flate streams.
+      ignore_png_errors: false,        # set to true to ignore exceptions on invalid PNG predictors.
     }
 
-    autoload :FDF, 'origami/extensions/fdf'
-    autoload :PPKLite, 'origami/extensions/ppklite'
+  autoload :FDF, 'origami/extensions/fdf'
+  autoload :PPKLite, 'origami/extensions/ppklite'
 end
 
 require 'origami/version'

data/test/test_actions.rb

@@ -1,27 +1,29 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 
-class TestActions < MiniTest::Test
-    def setup
-        @target = PDF.new
-        @page = Page.new
-        @action = Action::JavaScript "app.alert(null);"
-    end
+class TestActions < Minitest::Test
+  def setup
+    @target = PDF.new
+    @page = Page.new
+    @action = Action::JavaScript "app.alert(null);"
+  end
 
-    def test_pdf_actions
-        @target.onDocumentOpen @action
-        @target.onDocumentClose @action
-        @target.onDocumentPrint @action
+  def test_pdf_actions
+    @target.onDocumentOpen @action
+    @target.onDocumentClose @action
+    @target.onDocumentPrint @action
 
-        assert_equal @target.Catalog.OpenAction, @action
-        assert_equal @target.Catalog.AA.WC, @action
-        assert_equal @target.Catalog.AA.WP, @action
-    end
+    assert_equal @target.Catalog.OpenAction, @action
+    assert_equal @target.Catalog.AA.WC, @action
+    assert_equal @target.Catalog.AA.WP, @action
+  end
 
-    def test_page_actions
-        @page.onOpen @action
-        @page.onClose @action
+  def test_page_actions
+    @page.onOpen @action
+    @page.onClose @action
 
-        assert_equal @page.AA.O, @action
-        assert_equal @page.AA.C, @action
-    end
+    assert_equal @page.AA.O, @action
+    assert_equal @page.AA.C, @action
+  end
 end

data/test/test_annotations.rb

@@ -1,68 +1,70 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'stringio'
 
 class TestAnnotations < Minitest::Test
-    def setup
-        @target = PDF.new
-        @page = Page.new
-        @action = Action::JavaScript["app.alert(null);"]
-        @output = StringIO.new
+  def setup
+    @target = PDF.new
+    @page = Page.new
+    @action = Action::JavaScript["app.alert(null);"]
+    @output = StringIO.new
 
-        @types = [ 
-            Annotation::Circle, Annotation::Square,
-            Annotation::Text, Annotation::Link,
-            Annotation::FileAttachment, Annotation::Screen,
-            Annotation::Sound, Annotation::Widget::CheckBox,
-            Annotation::Widget::Radio, Annotation::Widget::Text,
-            Annotation::Widget::ComboBox, Annotation::Widget::ListBox,
-            Annotation::Widget::Signature
-        ]
-    end
+    @types = [
+      Annotation::Circle, Annotation::Square,
+      Annotation::Text, Annotation::Link,
+      Annotation::FileAttachment, Annotation::Screen,
+      Annotation::Sound, Annotation::Widget::CheckBox,
+      Annotation::Widget::Radio, Annotation::Widget::Text,
+      Annotation::Widget::ComboBox, Annotation::Widget::ListBox,
+      Annotation::Widget::Signature
+    ]
+  end
 
-    def test_annotations
-        @target.append_page @page
+  def test_annotations
+    @target.append_page @page
 
-        annotations = @types.map(&:new)
-        annotations.each do |annotation|
-            @page.add_annotation(annotation)
-        end
+    annotations = @types.map(&:new)
+    annotations.each do |annotation|
+      @page.add_annotation(annotation)
+    end
 
-        @page.each_annotation do |annotation|
-            assert_kind_of Annotation, annotation
+    @page.each_annotation do |annotation|
+      assert_kind_of Annotation, annotation
 
-            assert annotations.include?(annotation)
-        end
+      assert annotations.include?(annotation)
+    end
 
-        assert_equal @page.annotations.size, annotations.size
+    assert_equal @page.annotations.size, annotations.size
 
-        @target.save(@output)
-    end
+    @target.save(@output)
+  end
 
-    def test_annotation_actions
-        screen = Annotation::Screen.new
+  def test_annotation_actions
+    screen = Annotation::Screen.new
 
-        @page.add_annotation screen
+    @page.add_annotation screen
 
-        screen.onMouseOver @action
-        screen.onMouseOut @action
-        screen.onMouseDown @action
-        screen.onMouseUp @action
-        screen.onFocus @action
-        screen.onBlur @action
-        screen.onPageOpen @action
-        screen.onPageClose @action
-        screen.onPageVisible @action
-        screen.onPageInvisible @action
+    screen.onMouseOver @action
+    screen.onMouseOut @action
+    screen.onMouseDown @action
+    screen.onMouseUp @action
+    screen.onFocus @action
+    screen.onBlur @action
+    screen.onPageOpen @action
+    screen.onPageClose @action
+    screen.onPageVisible @action
+    screen.onPageInvisible @action
 
-        assert_equal screen.AA.E, @action
-        assert_equal screen.AA.X, @action
-        assert_equal screen.AA.D, @action
-        assert_equal screen.AA.U, @action
-        assert_equal screen.AA.Fo, @action
-        assert_equal screen.AA.Bl, @action
-        assert_equal screen.AA.PO, @action
-        assert_equal screen.AA.PC, @action
-        assert_equal screen.AA.PV, @action
-        assert_equal screen.AA.PI, @action
-    end
+    assert_equal screen.AA.E, @action
+    assert_equal screen.AA.X, @action
+    assert_equal screen.AA.D, @action
+    assert_equal screen.AA.U, @action
+    assert_equal screen.AA.Fo, @action
+    assert_equal screen.AA.Bl, @action
+    assert_equal screen.AA.PO, @action
+    assert_equal screen.AA.PC, @action
+    assert_equal screen.AA.PV, @action
+    assert_equal screen.AA.PI, @action
+  end
 end

data/test/test_forms.rb

@@ -1,30 +1,32 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 
 class TestForms < Minitest::Test
-    def setup
-        @target = PDF.new
-        @target.append_page
-    end
+  def setup
+    @target = PDF.new
+    @target.append_page
+  end
 
-    def test_create_acroform
-        fields = [
-            Annotation::Widget::Text.new.set_name('text'),
-            Annotation::Widget::PushButton.new.set_name('button')
-        ]
+  def test_create_acroform
+    fields = [
+      Annotation::Widget::Text.new.set_name('text'),
+      Annotation::Widget::PushButton.new.set_name('button')
+    ]
 
-        @target.create_form(*fields)
+    @target.create_form(*fields)
 
-        assert @target.form?
-        assert_kind_of InteractiveForm, @target.Catalog.AcroForm
-        assert_equal @target.fields.length, fields.length
+    assert @target.form?
+    assert_kind_of InteractiveForm, @target.Catalog.AcroForm
+    assert_equal @target.fields.length, fields.length
 
-        @target.each_field do |field|
-            assert_kind_of Field, field
-            assert %w{text button}.include?(field.name) 
-        end
-
-        assert_nil @target.get_field('not_existent_field')
-        assert_kind_of Field, @target.get_field('button')
-        assert_kind_of Field, @target.get_field('text')
+    @target.each_field do |field|
+      assert_kind_of Field, field
+      assert %w[text button].include?(field.name)
     end
+
+    assert_nil @target.get_field('not_existent_field')
+    assert_kind_of Field, @target.get_field('button')
+    assert_kind_of Field, @target.get_field('text')
+  end
 end

data/test/test_native_types.rb

@@ -1,83 +1,87 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'strscan'
+require 'origami'
 
 class TestPDFCreate < Minitest::Test
-    using Origami::TypeConversion
-
-    def test_type_string
-        assert_kind_of Origami::String, "".to_o
-        assert_kind_of ::String, "".to_o.value
-
-        assert_equal "<616263>", HexaString.new("abc").to_s
-        assert_equal "(test)", LiteralString.new("test").to_s
-        assert_equal '(\(\(\(\)\)\)\))', LiteralString.new("((())))").to_s
-        assert_equal "abc", "abc".to_s.to_o
-    end
-
-    def test_string_encoding
-        str = LiteralString.new("test")
-
-        assert_equal Origami::String::Encoding::PDFDocEncoding, str.encoding
-        assert_equal "UTF-8", str.to_utf8.encoding.to_s
-
-        assert_equal "\xFE\xFF\x00t\x00e\x00s\x00t".b, str.to_utf16be
-        assert_equal Origami::String::Encoding::UTF16BE, str.to_utf16be.to_o.encoding
-        assert_equal str, str.to_utf16be.to_o.to_pdfdoc
-    end
-
-    def test_type_null
-        assert_instance_of Null, nil.to_o
-        assert_nil Null.new.value
-        assert_equal Null.new.to_s, "null"
-    end
-
-    def test_type_name
-        assert_instance_of Name, :test.to_o
-        assert_instance_of Symbol, :test.to_o.value
-
-        assert_equal "/test", Name.new(:test).to_s
-        assert_equal "/#20#23#09#0d#0a#00#5b#5d#3c#3e#28#29#25#2f", Name.new(" #\t\r\n\0[]<>()%/").to_s
-        assert_equal " #\t\r\n\0[]<>()%/", Name.new(" #\t\r\n\0[]<>()%/").value.to_s
-    end
-
-    def test_type_boolean
-        assert_instance_of Boolean, true.to_o
-        assert_instance_of Boolean, false.to_o
-        assert Boolean.new(true).value
-        refute Boolean.new(false).value
-        assert_equal "true", true.to_o.to_s
-        assert_equal "false", false.to_o.to_s
-    end
-
-    def test_type_numeric
-        assert_instance_of Origami::Real, Math::PI.to_o
-        assert_instance_of Origami::Integer, 1.to_o
-
-        assert_equal "1.8", Origami::Real.new(1.8).to_s
-        assert_equal "100", Origami::Integer.new(100).to_s
-        assert_equal 1.8, 1.8.to_o.value
-        assert_equal 100, 100.to_o.value
-    end
-
-    def test_type_array
-        array = [1, "a", [], {}, :test, nil, true, 3.14]
-
-        assert_instance_of Origami::Array, [].to_o  
-        assert_instance_of ::Array, [].to_o.value
-
-        assert_equal array, array.to_o.value
-        assert_equal "[1 (a) [] <<>> /test null true 3.14]", array.to_o.to_s
-        assert array.to_o.all? {|o| o.is_a? Origami::Object} 
-    end
-
-    def test_type_dictionary
-        assert_instance_of Origami::Dictionary, {}.to_o
-        assert_instance_of Hash, {}.to_o.value
-
-        dict = {a: 1, b: false, c: nil, d: "abc", e: :abc, f: []}
-
-        assert_equal "<</a 1/b false/c null/d (abc)/e /abc/f []>>", dict.to_o.to_s(indent: 0)
-        assert_equal dict, dict.to_o.value
-        assert dict.to_o.all?{|k,v| k.is_a?(Name) and v.is_a?(Origami::Object)}
-    end
+  include Origami
+  using Origami::TypeConversion
+
+  def test_type_string
+    assert_kind_of Origami::String, "".to_o
+    assert_kind_of ::String, "".to_o.value
+
+    assert_equal "<616263>", HexaString.new("abc").to_s
+    assert_equal "(test)", LiteralString.new("test").to_s
+    assert_equal '(\(\(\(\)\)\)\))', LiteralString.new("((())))").to_s
+    assert_equal "abc", "abc".to_o
+  end
+
+  def test_string_encoding
+    str = LiteralString.new("test")
+
+    assert_equal Origami::String::Encoding::PDFDocEncoding, str.encoding
+    assert_equal "UTF-8", str.to_utf8.encoding.to_s
+
+    assert_equal "\xFE\xFF\x00t\x00e\x00s\x00t".b, str.to_utf16be
+    assert_equal Origami::String::Encoding::UTF16BE, str.to_utf16be.to_o.encoding
+    assert_equal str, str.to_utf16be.to_o.to_pdfdoc
+  end
+
+  def test_type_null
+    assert_instance_of Null, nil.to_o
+    assert_nil Null.new.value
+    assert_equal Null.new.to_s, "null"
+  end
+
+  def test_type_name
+    assert_instance_of Name, :test.to_o
+    assert_instance_of Symbol, :test.to_o.value
+
+    assert_equal "/test", Name.new(:test).to_s
+    assert_equal "/#20#23#09#0d#0a#00#5b#5d#3c#3e#28#29#25#2f", Name.new(" #\t\r\n\0[]<>()%/").to_s
+    assert_equal " #\t\r\n\0[]<>()%/", Name.new(" #\t\r\n\0[]<>()%/").value.to_s
+  end
+
+  def test_type_boolean
+    assert_instance_of Boolean, true.to_o
+    assert_instance_of Boolean, false.to_o
+    assert Boolean.new(true).value
+    refute Boolean.new(false).value
+    assert_equal "true", true.to_o.to_s
+    assert_equal "false", false.to_o.to_s
+  end
+
+  def test_type_numeric
+    assert_instance_of Origami::Real, Math::PI.to_o
+    assert_instance_of Origami::Integer, 1.to_o
+
+    assert_equal "1.8", Origami::Real.new(1.8).to_s
+    assert_equal "100", Origami::Integer.new(100).to_s
+    assert_equal 1.8, 1.8.to_o.value
+    assert_equal 100, 100.to_o.value
+  end
+
+  def test_type_array
+    array = [1, "a", [], {}, :test, nil, true, 3.14]
+
+    assert_instance_of Origami::Array, [].to_o
+    assert_instance_of ::Array, [].to_o.value
+
+    assert_equal array, array.to_o.value
+    assert_equal "[1 (a) [] <<>> /test null true 3.14]", array.to_o.to_s
+    assert array.to_o.all? { |o| o.is_a? Origami::Object }
+  end
+
+  def test_type_dictionary
+    assert_instance_of Origami::Dictionary, {}.to_o
+    assert_instance_of Hash, {}.to_o.value
+
+    dict = {a: 1, b: false, c: nil, d: "abc", e: :abc, f: []}
+
+    assert_equal "<</a 1/b false/c null/d (abc)/e /abc/f []>>", dict.to_o.to_s(indent: 0)
+    assert_equal dict, dict.to_o.value
+    assert dict.to_o.all? { |k, v| k.is_a?(Name) and v.is_a?(Origami::Object) }
+  end
 end

data/test/test_object_tree.rb

@@ -1,33 +1,34 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'stringio'
 
 class TestPDFObjectTree < Minitest::Test
+  def setup
+    @pdf = PDF.new.append_page
+    @contents = ContentStream.new("abc")
+    @pdf.pages.first.Contents = @contents
+    @pdf.Catalog.Loop = @pdf.Catalog
+    @pdf.save StringIO.new
+  end
 
-    def setup
-        @pdf = PDF.new.append_page
-        @contents = ContentStream.new("abc")
-        @pdf.pages.first.Contents = @contents
-        @pdf.Catalog.Loop = @pdf.Catalog
-        @pdf.save StringIO.new
-    end
-
-    def test_pdf_object_tree
-        assert_instance_of Catalog, @pdf.Catalog
-        assert_nil @pdf.Catalog.parent
+  def test_pdf_object_tree
+    assert_instance_of Catalog, @pdf.Catalog
+    assert_nil @pdf.Catalog.parent
 
-        @pdf.each_object(recursive: true) do |obj|
-            assert_kind_of Origami::Object, obj
-            assert_equal obj.document, @pdf
+    @pdf.each_object(recursive: true) do |obj|
+      assert_kind_of Origami::Object, obj
+      assert_equal obj.document, @pdf
 
-            unless obj.indirect?
-                assert_kind_of Origami::Object, obj.parent
-                assert_equal obj.parent.document, @pdf
-            end
-        end
-
-        enum = @pdf.each_object(recursive: true)
-        assert_kind_of Enumerator, enum
-        assert enum.include?(@pdf.Catalog.Pages)
-        assert enum.include?(@contents.dictionary)
+      unless obj.indirect?
+        assert_kind_of Origami::Object, obj.parent
+        assert_equal obj.parent.document, @pdf
+      end
     end
+
+    enum = @pdf.each_object(recursive: true)
+    assert_kind_of Enumerator, enum
+    assert enum.include?(@pdf.Catalog.Pages)
+    assert enum.include?(@contents.dictionary)
+  end
 end

data/test/test_pages.rb

@@ -1,60 +1,62 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'stringio'
 
 class TestPages < Minitest::Test
-    def setup
-        @target = PDF.new
-        @output = StringIO.new
-    end
+  def setup
+    @target = PDF.new
+    @output = StringIO.new
+  end
 
-    def test_append_page
-        p1, p2, p3 = Page.new, Page.new, Page.new
+  def test_append_page
+    p1, p2, p3 = Page.new, Page.new, Page.new
 
-        @target.append_page p1
-        @target.append_page p2
-        @target.append_page p3
+    @target.append_page p1
+    @target.append_page p2
+    @target.append_page p3
 
-        assert_equal @target.pages.count, 3
+    assert_equal @target.pages.count, 3
 
-        assert_equal @target.get_page(1), p1
-        assert_equal @target.get_page(2), p2
-        assert_equal @target.get_page(3), p3
+    assert_equal @target.get_page(1), p1
+    assert_equal @target.get_page(2), p2
+    assert_equal @target.get_page(3), p3
 
-        assert_raises(IndexError) { @target.get_page(0) }
-        assert_raises(IndexError) { @target.get_page(4) }
+    assert_raises(IndexError) { @target.get_page(0) }
+    assert_raises(IndexError) { @target.get_page(4) }
 
-        assert_equal @target.Catalog.Pages, p1.Parent
-        assert_equal @target.Catalog.Pages, p2.Parent
-        assert_equal @target.Catalog.Pages, p3.Parent
+    assert_equal @target.Catalog.Pages, p1.Parent
+    assert_equal @target.Catalog.Pages, p2.Parent
+    assert_equal @target.Catalog.Pages, p3.Parent
 
-        @target.save(@output)
+    @target.save(@output)
 
-        assert_equal @target.Catalog.Pages.Count, 3
-        assert_equal @target.pages, [p1, p2, p3]
-        assert_equal @target.each_page.to_a, [p1, p2, p3]
-    end
+    assert_equal @target.Catalog.Pages.Count, 3
+    assert_equal @target.pages, [p1, p2, p3]
+    assert_equal @target.each_page.to_a, [p1, p2, p3]
+  end
 
-    def test_insert_page
-        pages = Array.new(10) { Page.new }
+  def test_insert_page
+    pages = Array.new(10) { Page.new }
 
-        pages.each_with_index do |page, index|
-            @target.insert_page(index + 1, page)
-        end
+    pages.each_with_index do |page, index|
+      @target.insert_page(index + 1, page)
+    end
 
-        assert_equal @target.pages, pages
+    assert_equal @target.pages, pages
 
-        new_page = Page.new
-        @target.insert_page(1, new_page)
-        assert_equal @target.get_page(1), new_page
+    new_page = Page.new
+    @target.insert_page(1, new_page)
+    assert_equal @target.get_page(1), new_page
 
-        assert_raises(IndexError) { @target.insert_page(0, Page.new) }
-        assert_raises(IndexError) { @target.insert_page(1000, Page.new) }
-    end
+    assert_raises(IndexError) { @target.insert_page(0, Page.new) }
+    assert_raises(IndexError) { @target.insert_page(1000, Page.new) }
+  end
 
-    def test_example_write_page
-        @target.append_page
-        @target.pages.first.write 'Hello, world!', size: 30
-        @target.save(@output)
-        assert_equal @target.Catalog.Pages.Count, 1
-    end
+  def test_example_write_page
+    @target.append_page
+    @target.pages.first.write 'Hello, world!', size: 30
+    @target.save(@output)
+    assert_equal @target.Catalog.Pages.Count, 1
+  end
 end

data/test/test_pdf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 
 $:.unshift File.join(__dir__, "..", "lib")