hexapdf 0.17.1 → 0.17.2

data/test/hexapdf/type/test_xref_stream.rb

@@ -0,0 +1,143 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/type/xref_stream'
+
+describe HexaPDF::Type::XRefStream do
+  before do
+    @doc = Object.new
+    def (@doc).deref(obj); obj; end
+    def (@doc).wrap(obj, **); obj; end
+    @obj = HexaPDF::Type::XRefStream.new({}, oid: 1, document: @doc)
+  end
+
+  describe "xref_section" do
+    it "handles a missing /Index field" do
+      @obj[:Size] = 1
+      @obj[:W] = [2, 2, 2]
+      @obj.stream = [0, 65535, 1].pack('n*')
+      section = @obj.xref_section
+      assert_equal(1, section.each.to_a.size)
+      assert(section[0, 1].free?)
+    end
+
+    it "handles the three different field types and ignores unknown types" do
+      @obj[:Index] = [0, 4]
+      @obj[:W] = [2, 2, 2]
+      @obj.stream = [0, 65535, 1, 1, 200, 0, 2, 1, 5, 3, 0, 0].pack('n*')
+      section = @obj.xref_section
+      assert(section[0, 1].free?)
+      assert(section[1, 0].in_use?)
+      assert_equal(200, section[1, 0].pos)
+      assert(section[2, 0].compressed?)
+      assert_equal(1, section[2, 0].objstm)
+      assert_equal(5, section[2, 0].pos)
+    end
+
+    it "uses the default value for field one if its length is zero" do
+      @obj[:Index] = [3, 1]
+      @obj[:W] = [0, 1, 1]
+      @obj.stream = [200, 0].pack('C*')
+      section = @obj.xref_section
+      assert(section[3, 0].in_use?)
+      assert_equal(200, section[3, 0].pos)
+    end
+
+    it "uses the default value for field three if its length is zero" do
+      @obj[:Index] = [3, 1]
+      @obj[:W] = [1, 1, 0]
+      @obj.stream = [1, 200].pack('C*')
+      section = @obj.xref_section
+      assert(section[3, 0].in_use?)
+      assert_equal(200, section[3, 0].pos)
+    end
+
+    it "uses the default values for field one/three if their lengths are zero" do
+      @obj[:Index] = [3, 1]
+      @obj[:W] = [0, 1, 0]
+      @obj.stream = [200].pack('C*')
+      section = @obj.xref_section
+      assert(section[3, 0].in_use?)
+      assert_equal(200, section[3, 0].pos)
+    end
+
+    it "can handle multiple subsections" do
+      @obj[:Index] = [3, 1, 10, 1]
+      @obj[:W] = [0, 1, 0]
+      @obj.stream = [200, 250].pack('C*')
+      section = @obj.xref_section
+      assert(section[3, 0].in_use?)
+      assert_equal(200, section[3, 0].pos)
+      assert(section[10, 0].in_use?)
+      assert_equal(250, section[10, 0].pos)
+    end
+
+    it "fails if there is not enough data available" do
+      @obj[:Index] = [1, 2, 10, 4]
+      @obj[:W] = [1, 2, 1]
+      @obj.stream = "abcd"
+      assert_raises(HexaPDF::MalformedPDFError) { @obj.xref_section }
+    end
+  end
+
+  describe "trailer" do
+    it "returns a dictionary without xref stream specific values" do
+      @obj[:Size] = 5
+      @obj[:ID] = ["a", "b"]
+      @obj[:Root] = 'x'
+      @obj[:Index] = [0, 5]
+      @obj[:W] = [1, 2, 2]
+      dict = @obj.trailer
+      assert_equal(3, dict.length)
+      assert_equal(5, dict[:Size])
+      assert_equal(["a", "b"], dict[:ID])
+      assert_equal('x', dict[:Root])
+    end
+  end
+
+  describe "update_with_xref_section_and_trailer" do
+    before do
+      @section = HexaPDF::XRefSection.new
+      @section.add_free_entry(0, 65535)
+      @section.add_in_use_entry(1, 0, 200)
+      @section.add_compressed_entry(2, 1, 5)
+    end
+
+    it "sets all necessary dictionary values" do
+      @obj.update_with_xref_section_and_trailer(@section, Size: 100)
+      assert_equal(:XRef, @obj.value[:Type])
+      assert_equal(100, @obj.value[:Size])
+      assert_equal([0, 3], @obj.value[:Index])
+      assert_equal([1, 1, 2], @obj.value[:W])
+
+      @section.add_in_use_entry(1, 0, 256**2)
+      @obj.update_with_xref_section_and_trailer(@section, Size: 100)
+      assert_equal([1, 4, 2], @obj.value[:W])
+    end
+
+    it "updates the stream with the new information" do
+      @obj.update_with_xref_section_and_trailer(@section, Size: 100)
+      section = @obj.xref_section
+      @section.each do |oid, gen, data|
+        if section[oid, gen] == data
+          section.delete(oid)
+        else
+          flunk("Data for object p#{oid}, #{gen}] is not equal")
+        end
+      end
+      assert_equal(0, section.each.to_a.size)
+    end
+
+    it "can write multiple subsections" do
+      @section.add_free_entry(10, 1)
+      @section.add_in_use_entry(11, 1, 100)
+      @obj.update_with_xref_section_and_trailer(@section, Size: 100)
+      assert_equal([0, 3, 10, 2], @obj.value[:Index])
+    end
+
+    it "fails for unsupported cross-reference entry types" do
+      @section.send(:[]=, 3, 0, HexaPDF::XRefSection::Entry.new(:unknown, 3, 0))
+      assert_raises(HexaPDF::Error) { @obj.update_with_xref_section_and_trailer(@section, {}) }
+    end
+  end
+end

data/test/hexapdf/utils/test_bit_field.rb

@@ -0,0 +1,63 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+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",
+            unsetter: 'unset')
+
+end
+
+describe HexaPDF::Utils::BitField do
+  before 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)
+    @obj.data = 0b100001
+    assert_equal([:bit0, :bit5], @obj.list)
+  end
+
+  it "can check whether a given bit is set via the getter method" do
+    refute(@obj.get(:bit0))
+    @obj.data = 0b000001
+    assert(@obj.get(:bit0))
+    assert(@obj.get(0))
+    refute(@obj.get(:bit1))
+    refute(@obj.get(1))
+  end
+
+  it "can set a given bit via the setter method" do
+    assert_nil(@obj.data)
+    @obj.set(:bit0, :bit1, :bit5)
+    assert_equal(0b100011, @obj.data)
+    @obj.set(:bit0, 5, clear_existing: true)
+    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)
+    e = assert_raises(ArgumentError) { @obj.get(:bit10) }
+    assert_equal("Invalid bit field name or index 'bit10' for TestBitField#data", e.message)
+  end
+end

data/test/hexapdf/utils/test_bit_stream.rb

@@ -0,0 +1,69 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/utils/bit_stream'
+
+describe HexaPDF::Utils::BitStreamReader do
+  before do
+    @reader = HexaPDF::Utils::BitStreamReader.new
+  end
+
+  it "allows appending data" do
+    assert_equal(0, @reader.remaining_bits)
+    @reader << "data"
+    assert_equal(32, @reader.remaining_bits)
+    @reader << "some"
+    assert_equal(64, @reader.remaining_bits)
+    @reader.read(4)
+    assert_equal(60, @reader.remaining_bits)
+    @reader << "more"
+    assert_equal(92, @reader.remaining_bits)
+  end
+
+  it "allows checking whether a certain number of bits can be read" do
+    refute(@reader.read?(1))
+    @reader << "data"
+    assert(@reader.read?(1))
+    assert(@reader.read?(32))
+    refute(@reader.read?(33))
+  end
+
+  describe "read" do
+    it "allows reading any number of bits" do
+      @reader << "\xaa" * 8 # 10101010 * 8
+      assert_equal(1, @reader.read(1))
+      assert_equal(0, @reader.read(1))
+      assert_equal(2, @reader.read(2))
+      assert_equal(10, @reader.read(4))
+      assert_equal(5, @reader.read(3))
+      assert_equal((0b01010 << 8) | 0xaa, @reader.read(13))
+      assert_equal(5, @reader.read(3))
+      assert_equal((0b01010 << 7) | (0xaa >> 1), @reader.read(12))
+      assert_equal(2, @reader.read(3))
+    end
+
+    it "allows reading many bits" do
+      @reader << "\x80" << "\x00" * 20
+      assert_equal(2**127, @reader.read(128))
+    end
+
+    it "returns nil if enough bits are available" do
+      assert_nil(@reader.read(1))
+    end
+  end
+end
+
+describe HexaPDF::Utils::BitStreamWriter do
+  before do
+    @writer = HexaPDF::Utils::BitStreamWriter.new
+  end
+
+  it "allows writing any number of bits" do
+    result = @writer.write(1, 1)
+    result << @writer.write(0b101, 3)
+    result << @writer.write(0xff, 8)
+    result << @writer.write(0x5ddd, 15)
+    result << @writer.finalize
+    assert_equal("\xdf\xfb\xbb\xa0".b, result)
+  end
+end

data/test/hexapdf/utils/test_graphics_helpers.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/utils/graphics_helpers'
+
+describe HexaPDF::Utils::GraphicsHelpers do
+  include HexaPDF::Utils::GraphicsHelpers
+
+  describe "calculate_dimensions" do
+    it "returns the requested dimensions if both are specified" do
+      assert_equal([7, 8], calculate_dimensions(5, 6, rwidth: 7, rheight: 8))
+    end
+
+    it "returns the requested width and an adjusted height" do
+      assert_equal([10, 12], calculate_dimensions(5, 6, rwidth: 10))
+    end
+
+    it "returns the requested width and the given height if width is zero" do
+      assert_equal([10, 6], calculate_dimensions(0, 6, rwidth: 10))
+    end
+
+    it "returns the requested height and an adjusted width" do
+      assert_equal([10, 12], calculate_dimensions(5, 6, rheight: 12))
+    end
+
+    it "returns the requested height and the given width if height is zero" do
+      assert_equal([5, 12], calculate_dimensions(5, 0, rheight: 12))
+    end
+  end
+
+  describe "point_on_line" do
+    it "returns the correct point" do
+      assert_equal([5, 5], point_on_line(0, 0, 10, 10, distance: Math.sqrt(50)))
+      assert_equal([5, 5], point_on_line(10, 10, 0, 0, distance: Math.sqrt(50)))
+    end
+  end
+end

data/test/hexapdf/utils/test_lru_cache.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/utils/lru_cache'
+
+describe HexaPDF::Utils::LRUCache do
+  before do
+    @cache = HexaPDF::Utils::LRUCache.new(5)
+    5.times {|i| @cache[i] = i * 2 }
+  end
+
+  it "removes the LRU item when the size is reached" do
+    assert([1, 2], @cache.instance_variable_get(:@cache).first)
+    @cache[6] = 7
+    assert([2, 4], @cache.instance_variable_get(:@cache).first)
+  end
+
+  it "freshes an item on access" do
+    @cache[1]
+    assert([2, 4], @cache.instance_variable_get(:@cache).first)
+  end
+end

data/test/hexapdf/utils/test_object_hash.rb

@@ -0,0 +1,120 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/utils/object_hash'
+
+describe HexaPDF::Utils::ObjectHash do
+  before do
+    @hash = HexaPDF::Utils::ObjectHash.new
+  end
+
+  describe "[]" do
+    it "works with both an object number and a generation number" do
+      @hash[1, 5] = 5
+      assert_equal(5, @hash[1, 5])
+      assert_nil(@hash[1, 4])
+      assert_nil(@hash[2, 5])
+    end
+
+    it "works with an object number only" do
+      @hash[1, 5] = 5
+      assert_equal(5, @hash[1])
+      assert_nil(@hash[2])
+    end
+  end
+
+  describe "[]=" do
+    it "allows adding an entry" do
+      @hash[1, 5] = 5
+      assert_equal(5, @hash[1, 5])
+    end
+
+    it "allows overwriting an existing entry for an object number" do
+      @hash[1, 0] = 5
+      @hash[1, 0] = 6
+      assert_equal(6, @hash[1, 0])
+
+      @hash[1, 1] = 5
+      assert_equal(5, @hash[1, 1])
+      assert_nil(@hash[1, 0])
+    end
+  end
+
+  describe "entry?" do
+    it "checks if an entry for a specific object number exists" do
+      refute(@hash.entry?(1))
+      @hash[1, 1] = 5
+      assert(@hash.entry?(1))
+    end
+
+    it "checks if an entry for a specific object and generation number exists" do
+      refute(@hash.entry?(1, 1))
+      @hash[1, 1] = 5
+      assert(@hash.entry?(1, 1))
+      refute(@hash.entry?(1, 0))
+    end
+  end
+
+  it "returns the generation number for an object number with gen_for_oid" do
+    assert_nil(@hash.gen_for_oid(1))
+    @hash[1, 5] = 5
+    assert_equal(5, @hash.gen_for_oid(1))
+  end
+
+  it "deletes an entry via delete" do
+    @hash[1, 0] = 5
+    @hash.delete(1)
+    assert_nil(@hash[1])
+  end
+
+  describe "each" do
+    it "acts as an enumerable object" do
+      @hash[1, 0] = 5
+      @hash[2, 3] = 6
+      @hash[3, 2] = 7
+      assert_equal([[1, 0, 5], [2, 3, 6], [3, 2, 7]], @hash.each.to_a)
+
+      @hash.each do |oid, gen, data|
+        assert_equal(data, @hash[oid, gen])
+      end
+    end
+
+    it "allows key insertion during iteration" do
+      @hash[1, 0] = 5
+      count = 0
+      @hash.each { count += 1; @hash[2, 0] = 6 }
+      assert_equal(1, count)
+    end
+  end
+
+  describe "max_oid" do
+    it "is zero when no objects are stored" do
+      assert_equal(0, @hash.max_oid)
+      @hash[1, 0] = 5
+      @hash.delete(1)
+      assert_equal(0, @hash.max_oid)
+    end
+
+    it "changes accordingly when data is inserted" do
+      @hash[1, 0] = 5
+      assert_equal(1, @hash.max_oid)
+      @hash[5, 0] = 5
+      assert_equal(5, @hash.max_oid)
+      @hash[3, 0] = 5
+      assert_equal(5, @hash.max_oid)
+    end
+
+    it "changes accordingly when data is deleted" do
+      @hash[1, 0] = @hash[3, 0] = @hash[5, 0] = 5
+      @hash.delete(1)
+      assert_equal(5, @hash.max_oid)
+      @hash.delete(5)
+      assert_equal(3, @hash.max_oid)
+    end
+  end
+
+  it "can return a list of all object IDs" do
+    @hash[1, 0] = @hash[3, 1] = 7
+    assert_equal([3, 1], @hash.oids)
+  end
+end

data/test/hexapdf/utils/test_pdf_doc_encoding.rb

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/utils/pdf_doc_encoding'
+
+describe HexaPDF::Utils::PDFDocEncoding do
+  before do
+    @obj = HexaPDF::Utils::PDFDocEncoding
+  end
+
+  describe "convert_to_utf8" do
+    it "converts the given string to UTF-8" do
+      result = @obj.convert_to_utf8("Testing\x9c\x92".b)
+      assert_equal(Encoding::UTF_8, result.encoding)
+      assert_equal("Testing\u0153\u2122", result)
+    end
+  end
+end