hexapdf 0.11.9 → 0.13.0

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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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
@@ -54,8 +54,7 @@ module HexaPDF
     # HexaPDF::Revision object's trailer dictionary is always of this type. Only when a
     # cross-reference stream is written is the trailer integrated into the stream's dictionary.
     #
-    # See: PDF1.7 s7.5.5, s14.4
-    #      XRefStream
+    # See: PDF1.7 s7.5.5, s14.4; XRefStream
     class Trailer < Dictionary
 
       define_type :XXTrailer
@@ -98,7 +97,7 @@ module HexaPDF
       private
 
       # Validates the trailer.
-      def perform_validation
+      def perform_validation(&block)
         super
         unless value[:ID]
           msg = if value[:Encrypt]
@@ -112,8 +111,7 @@ module HexaPDF
 
         unless value[:Root]
           yield("A PDF document must have a Catalog dictionary", true)
-          value[:Root] = document.add({Type: :Catalog})
-          value[:Root].validate {|message, correctable| yield(message, correctable) }
+          catalog.validate(&block)
         end
 
         if value[:Encrypt] && (!document.security_handler ||

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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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
@@ -43,45 +43,59 @@ module HexaPDF
 
       # Creates a bit field for managing the integer attribute +name+.
       #
-      # The +mapping+ argument specifies the mapping of names to bit indices which allows one to use
-      # either the bit name or its index when getting or setting. When using an unknown bit name or
-      # bit index, an error is raised.
+      # The +mapping+ argument specifies the mapping of names to zero-based bit indices which allows
+      # one to use either the bit name or its index when getting or setting. When using an unknown
+      # bit name or bit index, an error is raised.
       #
       # The calling class needs to respond to \#name and \#name= because these methods are used to
-      # get and set the raw integer value.
+      # get and set the raw integer value; or provide custom method names using the +value_getter+
+      # and +value_setter+ arguments.
       #
-      # After invoking the method the calling class has three new instance methods:
+      # After invoking the method the calling class has four new instance methods:
       #
       # * NAME_values which returns an array of bit names representing the set bits.
       # * NAME_include?(bit) which returns true if the given bit is set.
       # * set_NAME(*bits, clear_existing: false) for setting the given bits.
+      # * unset_NAME(*bits) for clearing the given bits.
       #
-      # The method names can be overridden using the arguments +lister+, +getter+ and +setter+.
+      # The method names can be overridden using the arguments +lister+, +getter+, +setter+ and
+      # +unsetter+.
       def bit_field(name, mapping, lister: "#{name}_values", getter: "#{name}_include?",
-                    setter: "set_#{name}")
-        bit_names = mapping.keys
+                    setter: "set_#{name}", unsetter: "unset_#{name}", value_getter: name,
+                    value_setter: "self.#{name}")
         mapping.default_proc = proc do |h, k|
           if h.value?(k)
-            h[k] = k
+            k
           else
             raise ArgumentError, "Invalid bit field name or index '#{k}' for #{self.name}##{name}"
           end
         end
-        value_getter = name
-        value_setter = "#{name}="
 
-        define_method(lister) do
-          bit_names.map {|n| send(getter, n) ? n : nil }.compact
-        end
-        define_method(getter) do |bit|
-          (send(value_getter) || 0)[mapping[bit]] == 1
-        end
-        define_method(setter) do |*bits, clear_existing: false|
-          send(value_setter, 0) if clear_existing || send(value_getter).nil?
-          result = send(value_getter)
-          bits.each {|bit| result |= 1 << mapping[bit] }
-          send(value_setter, result)
-        end
+        module_eval(<<-EOF, __FILE__, __LINE__ + 1)
+          #{name.upcase}_BIT_MAPPING = mapping.freeze
+
+          def #{lister}
+            self.class::#{name.upcase}_BIT_MAPPING.keys.map {|n| #{getter}(n) ? n : nil }.compact
+          end
+
+          def #{getter}(bit)
+            (#{value_getter} || 0)[self.class::#{name.upcase}_BIT_MAPPING[bit]] == 1
+          end
+
+          def #{setter}(*bits, clear_existing: false)
+            #{value_setter} = 0 if clear_existing || #{value_getter}.nil?
+            result = #{value_getter}
+            bits.each {|bit| result |= 1 << self.class::#{name.upcase}_BIT_MAPPING[bit] }
+            #{value_setter} =  result
+          end
+
+          def #{unsetter}(*bits)
+            result = #{value_getter} || 0
+            return if result == 0
+            bits.each {|bit| result &= ~(1 << self.class::#{name.upcase}_BIT_MAPPING[bit]) }
+            #{value_setter} = result
+          end
+        EOF
       end
 
     end

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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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
@@ -143,12 +143,12 @@ module HexaPDF
         stack.reverse_each.inject do |nested_node, node|
           if (!nested_node[container_name] || nested_node[container_name].empty?) &&
               (!nested_node[:Kids] || nested_node[:Kids].empty?)
-            node[:Kids].delete_at(node[:Kids].index {|n| document.deref(n) == nested_node })
+            node[:Kids].delete(nested_node)
             document.delete(nested_node)
           end
           if !node[:Kids].empty? && node[:Limits]
-            node[:Limits][0] = document.deref(node[:Kids][0])[:Limits][0]
-            node[:Limits][1] = document.deref(node[:Kids][-1])[:Limits][1]
+            node[:Limits][0] = node[:Kids][0][:Limits][0]
+            node[:Limits][1] = node[:Kids][-1][:Limits][1]
           end
           node
         end
@@ -167,11 +167,11 @@ module HexaPDF
           if node.key?(container_name)
             index = find_in_leaf_node(node[container_name], key)
             if node[container_name][index] == key
-              result = document.deref(node[container_name][index + 1])
+              result = node[container_name][index + 1]
             end
           elsif node.key?(:Kids)
             index = find_in_intermediate_node(node[:Kids], key)
-            node = document.deref(node[:Kids][index])
+            node = node[:Kids][index]
             break unless key >= node[:Limits][0] && key <= node[:Limits][1]
           else
             break
@@ -192,12 +192,12 @@ module HexaPDF
         container_name = leaf_node_container_name
         stack = [self]
         until stack.empty?
-          node = document.deref(stack.pop)
+          node = stack.pop
           if node.key?(container_name)
             data = node[container_name]
             index = 0
             while index < data.length
-              yield(data[index], document.deref(data[index + 1]))
+              yield(data[index], data[index + 1])
               index += 2
             end
           elsif node.key?(:Kids)
@@ -215,7 +215,7 @@ module HexaPDF
       def path_to_key(node, key, stack)
         return unless node.key?(:Kids)
         index = find_in_intermediate_node(node[:Kids], key)
-        stack << document.deref(node[:Kids][index])
+        stack << node[:Kids][index]
         path_to_key(stack.last, key, stack)
       end
 
@@ -226,7 +226,7 @@ module HexaPDF
         right = array.length - 1
         while left < right
           mid = (left + right) / 2
-          limits = document.deref(array[mid])[:Limits]
+          limits = array[mid][:Limits]
           if limits[1] < key
             left = mid + 1
           elsif limits[0] > key
@@ -295,7 +295,7 @@ module HexaPDF
           node[container_name] = leaf_node[container_name].slice!(split_point..-1)
           node[:Limits] = node[container_name].values_at(0, -2)
           leaf_node[:Limits][1] = leaf_node[container_name][-2]
-          index = 1 + parent[:Kids].index {|o| document.deref(o) == leaf_node }
+          index = 1 + parent[:Kids].index {|o| o == leaf_node }
           parent[:Kids].insert(index, node)
         end
       end
@@ -307,10 +307,10 @@ module HexaPDF
 
         # All kids entries must be indirect objects
         if key?(:Kids)
-          self[:Kids].each do |kid|
-            unless (kid.kind_of?(HexaPDF::Object) && kid.indirect?) ||
-                kid.kind_of?(HexaPDF::Reference)
-              yield("Child entries of sorted tree nodes must be indirect objects", false)
+          self[:Kids].each_with_index do |kid, index|
+            unless kid.kind_of?(HexaPDF::Object) && kid.indirect?
+              yield("Child entries of sorted tree nodes must be indirect objects", true)
+              value[:Kids][index] = document.add(kid)
             end
           end
         end
@@ -321,15 +321,18 @@ module HexaPDF
           container = self[container_name]
           if container.length.odd?
             yield("Sorted tree leaf node contains odd number of entries", false)
+            return
           end
           index = 0
           old = nil
           while index < container.length
-            key = document.unwrap(container[index])
+            key = container[index]
             if !key.kind_of?(key_type)
               yield("A key must be a #{key_type} object, not a #{key.class}", false)
+              return
             elsif old && old > key
               yield("Sorted tree leaf node entries are not correctly sorted", false)
+              return
             end
             old = key
             index += 2

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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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.11.9'
+  VERSION = '0.13.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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/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-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/common_tokenizer_tests.rb

@@ -121,6 +121,11 @@ module CommonTokenizerTests
     assert(token.kind_of?(HexaPDF::Tokenizer::Token))
   end
 
+  it "next_token: should not fail when reading super long numbers" do
+    create_tokenizer("1" << "0" * 10_000)
+    assert_equal(10**10_000, @tokenizer.next_token)
+  end
+
   it "next_object: works for all PDF object types, including array and dictionary" do
     create_tokenizer(<<-EOF.chomp.gsub(/^ {8}/, ''))
         true false null 123 34.5 (string) <4E6F76> /Name
@@ -157,7 +162,7 @@ module CommonTokenizerTests
   end
 
   it "returns the correct position on operations" do
-    create_tokenizer("hallo du" + " " * 50000 + "hallo du")
+    create_tokenizer("hallo du" << " " * 50000 << "hallo du")
     @tokenizer.next_token
     assert_equal(5, @tokenizer.pos)
 

data/test/hexapdf/content/common.rb

@@ -29,10 +29,10 @@ module TestHelper
   end
 
   # Asserts that the content string contains the operators.
-  def assert_operators(content, operators, only_names: false)
+  def assert_operators(content, operators, only_names: false, range: 0..-1)
     processor = TestHelper::OperatorRecorder.new
     HexaPDF::Content::Parser.new.parse(content, processor)
-    result = processor.recorded_ops
+    result = processor.recorded_ops[range]
     result.map!(&:first) if only_names
     assert_equal(operators, result)
   end

data/test/hexapdf/content/graphic_object/test_arc.rb

@@ -68,14 +68,14 @@ describe HexaPDF::Content::GraphicObject::Arc do
       arc.max_curves = 4
       curves = arc.curves
       assert_equal(2, curves.size)
-      assert_curve_values([0, 1, p1: [1, 0.548584], p2: [0.548584, 1]], curves[0])
-      assert_curve_values([-1, 0, p1: [-0.548584, 1], p2: [-1, 0.548584]], curves[1])
+      assert_curve_values([0, 1, {p1: [1, 0.548584], p2: [0.548584, 1]}], curves[0])
+      assert_curve_values([-1, 0, {p1: [-0.548584, 1], p2: [-1, 0.548584]}], curves[1])
 
       arc.configure(clockwise: true)
       curves = arc.curves
       assert_equal(2, curves.size)
-      assert_curve_values([0, -1, p1: [1, -0.548584], p2: [0.548584, -1]], curves[0])
-      assert_curve_values([-1, 0, p1: [-0.548584, -1], p2: [-1, -0.548584]], curves[1])
+      assert_curve_values([0, -1, {p1: [1, -0.548584], p2: [0.548584, -1]}], curves[0])
+      assert_curve_values([-1, 0, {p1: [-0.548584, -1], p2: [-1, -0.548584]}], curves[1])
     end
   end
 

data/test/hexapdf/content/test_canvas.rb

@@ -531,7 +531,7 @@ describe HexaPDF::Content::Canvas do
     end
 
     it "invokes the polygon method when radius != 0" do
-      args = [0, 0, 10, 0, 10, 10, 0, 10, radius: 5]
+      args = [0, 0, 10, 0, 10, 10, 0, 10, {radius: 5}]
       assert_method_invoked(@canvas, :polygon, args) do
         @canvas.rectangle(0, 0, 10, 10, radius: 5)
       end
@@ -631,7 +631,7 @@ describe HexaPDF::Content::Canvas do
 
   describe "circle" do
     it "uses arc for the hard work" do
-      assert_method_invoked(@canvas, :arc, [5, 6, a: 7]) do
+      assert_method_invoked(@canvas, :arc, [5, 6, {a: 7}]) do
         @canvas.graphics_object = :path
         @canvas.circle(5, 6, 7)
       end
@@ -651,7 +651,7 @@ describe HexaPDF::Content::Canvas do
 
   describe "ellipse" do
     it "uses arc for the hard work" do
-      assert_method_invoked(@canvas, :ellipse, [5, 6, a: 7, b: 5, inclination: 10]) do
+      assert_method_invoked(@canvas, :ellipse, [5, 6, {a: 7, b: 5, inclination: 10}]) do
         @canvas.ellipse(5, 6, a: 7, b: 5, inclination: 10)
       end
     end

data/test/hexapdf/content/test_color_space.rb

@@ -27,6 +27,10 @@ module CommonColorSpaceTests
     assert_equal(@color_space_family, @color_space.family)
   end
 
+  it "the color space returns the correct color space definition" do
+    assert_equal(@color_space_definition, @color_space.definition)
+  end
+
   it "the color responds to :components" do
     assert(@color.respond_to?(:components))
   end
@@ -43,14 +47,70 @@ module CommonColorSpaceTests
     assert_equal(@components, @color_space.color(*@components).components)
   end
 
+  it "normalizes the colors when using the #color method" do
+    return unless defined?(@colors)
+    assert_equal(@components, @color_space.color(*@colors).components)
+  end
+
+  it "doesn't normalize the colors when using the #prenormalized_color method" do
+    return unless defined?(@colors)
+    assert_equal(@colors, @color_space.prenormalized_color(*@colors).components)
+  end
+
+end
+
+describe HexaPDF::Content::ColorSpace do
+  before do
+    @class = HexaPDF::Content::ColorSpace
+  end
+
+  describe "self.device_color_from_specification" do
+    it "works for gray values" do
+      assert_equal([0.2], @class.device_color_from_specification(51).components)
+    end
+
+    it "works for RGB values" do
+      assert_equal([0.2, 1, 0], @class.device_color_from_specification(51, 255, 0).components)
+    end
+
+    it "works for RGB values given as string" do
+      assert_equal([0.2, 1, 0], @class.device_color_from_specification("33FF00").components)
+    end
+
+    it "works for CMYK values" do
+      assert_equal([0.51, 0.9, 1, 0.5],
+                   @class.device_color_from_specification(51, 90, 100, 50).components)
+    end
+
+    it "works when an array is given" do
+      assert_equal([0.2], @class.device_color_from_specification([51]).components)
+    end
+  end
+
+  it "returns a device color object for prenormalized color values" do
+    assert_equal([5, 6, 7], @class.prenormalized_device_color([5, 6, 7]).components)
+  end
+
+  describe "self.for_components" do
+    it "returns the correct device color space name" do
+      assert_equal(:DeviceGray, @class.for_components([1]))
+      assert_equal(:DeviceRGB, @class.for_components([1, 2, 3]))
+      assert_equal(:DeviceCMYK, @class.for_components([1, 2, 3, 4]))
+    end
+
+    it "fails if an array with an invalid length is passed" do
+      assert_raises(ArgumentError) { @class.for_components([]) }
+    end
+  end
 end
 
 describe HexaPDF::Content::ColorSpace::Universal do
   include CommonColorSpaceTests
 
   before do
-    @color_space = HexaPDF::Content::ColorSpace::Universal.new([:test])
+    @color_space = HexaPDF::Content::ColorSpace::Universal.new([:test, :value])
     @color_space_family = :test
+    @color_space_definition = [:test, :value]
     @color = @color_space.default_color
     @other_color = @color_space.color(128, 5, 6, 7, 8)
     @components = [5, 6, 7, 8]
@@ -58,7 +118,7 @@ describe HexaPDF::Content::ColorSpace::Universal do
 
   it "can be compared to another universal color space" do
     other = HexaPDF::Content::ColorSpace::Universal.new([:other])
-    same = HexaPDF::Content::ColorSpace::Universal.new([:test])
+    same = HexaPDF::Content::ColorSpace::Universal.new([:test, :value])
     assert_equal(same, @color_space)
     refute_equal(other, @color_space)
   end
@@ -69,10 +129,11 @@ describe HexaPDF::Content::ColorSpace::DeviceRGB do
 
   before do
     @color_space = HexaPDF::Content::ColorSpace::DeviceRGB.new
-    @color_space_family = :DeviceRGB
+    @color_space_family = @color_space_definition = :DeviceRGB
     @color = @color_space.default_color
     @other_color = @color_space.color(128, 0, 0)
-    @components = [0.5, 0.2, 0.3]
+    @colors = [128, 0, 255]
+    @components = @colors.map {|c| c.to_f / 255 }
   end
 end
 
@@ -81,10 +142,11 @@ describe HexaPDF::Content::ColorSpace::DeviceCMYK do
 
   before do
     @color_space = HexaPDF::Content::ColorSpace::DeviceCMYK.new
-    @color_space_family = :DeviceCMYK
+    @color_space_family = @color_space_definition = :DeviceCMYK
     @color = @color_space.default_color
     @other_color = @color_space.color(128, 0, 0, 128)
-    @components = [0.1, 0.2, 0.3, 0.4]
+    @colors = [0, 20, 40, 80]
+    @components = [0.0, 0.2, 0.4, 0.8]
   end
 end
 
@@ -93,9 +155,10 @@ describe HexaPDF::Content::ColorSpace::DeviceGray do
 
   before do
     @color_space = HexaPDF::Content::ColorSpace::DeviceGray.new
-    @color_space_family = :DeviceGray
+    @color_space_family = @color_space_definition = :DeviceGray
     @color = @color_space.default_color
     @other_color = @color_space.color(128)
-    @components = [0.1]
+    @colors = [128]
+    @components = [128.0 / 255]
   end
 end