hexapdf 0.11.9 → 0.13.0

data/lib/hexapdf/content/graphic_object.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/content/graphic_object/arc.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
@@ -45,7 +45,7 @@ module HexaPDF
       # all either in clockwise or counterclockwise direction and optionally inclined in respect to
       # the x-axis.
       #
-      # See: ELL - https://www.spaceroots.org/documents/ellipse/elliptical-arc.pdf
+      # See: ELL - https://spaceroots.org/documents/ellipse/elliptical-arc.pdf
       class Arc
 
         include HexaPDF::Utils::MathHelpers
@@ -202,8 +202,8 @@ module HexaPDF
             p2x_prime, p2y_prime = derivative_evaluate(eta2)
 
             result << [p2x, p2y,
-                       p1: [p1x + alpha * p1x_prime, p1y + alpha * p1y_prime],
-                       p2: [p2x - alpha * p2x_prime, p2y - alpha * p2y_prime]]
+                       {p1: [p1x + alpha * p1x_prime, p1y + alpha * p1y_prime],
+                        p2: [p2x - alpha * p2x_prime, p2y - alpha * p2y_prime]}]
           end
 
           result

data/lib/hexapdf/content/graphic_object/endpoint_arc.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/content/graphic_object/geom2d.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/content/graphic_object/solid_arc.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/content/graphics_state.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/content/operator.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
@@ -397,7 +397,7 @@ module HexaPDF
 
         def invoke(processor, *operands) #:nodoc:
           processor.graphics_state.stroke_color =
-            processor.graphics_state.stroke_color.color_space.color(*operands)
+            processor.graphics_state.stroke_color.color_space.prenormalized_color(*operands)
         end
 
       end
@@ -409,7 +409,7 @@ module HexaPDF
 
         def invoke(processor, *operands) #:nodoc:
           processor.graphics_state.fill_color =
-            processor.graphics_state.fill_color.color_space.color(*operands)
+            processor.graphics_state.fill_color.color_space.prenormalized_color(*operands)
         end
 
       end
@@ -425,7 +425,7 @@ module HexaPDF
 
         def invoke(processor, gray) #:nodoc:
           processor.graphics_state.stroke_color =
-            processor.resources.color_space(:DeviceGray).color(gray)
+            processor.resources.color_space(:DeviceGray).prenormalized_color(gray)
         end
 
       end
@@ -442,7 +442,7 @@ module HexaPDF
 
         def invoke(processor, gray) #:nodoc:
           processor.graphics_state.fill_color =
-            processor.resources.color_space(:DeviceGray).color(gray)
+            processor.resources.color_space(:DeviceGray).prenormalized_color(gray)
         end
 
       end
@@ -459,7 +459,7 @@ module HexaPDF
 
         def invoke(processor, r, g, b) #:nodoc:
           processor.graphics_state.stroke_color =
-            processor.resources.color_space(:DeviceRGB).color(r, g, b)
+            processor.resources.color_space(:DeviceRGB).prenormalized_color(r, g, b)
         end
 
         def serialize(serializer, r, g, b) #:nodoc:
@@ -481,7 +481,7 @@ module HexaPDF
 
         def invoke(processor, r, g, b) #:nodoc:
           processor.graphics_state.fill_color =
-            processor.resources.color_space(:DeviceRGB).color(r, g, b)
+            processor.resources.color_space(:DeviceRGB).prenormalized_color(r, g, b)
         end
 
         def serialize(serializer, r, g, b) #:nodoc:
@@ -503,7 +503,7 @@ module HexaPDF
 
         def invoke(processor, c, m, y, k) #:nodoc:
           processor.graphics_state.stroke_color =
-            processor.resources.color_space(:DeviceCMYK).color(c, m, y, k)
+            processor.resources.color_space(:DeviceCMYK).prenormalized_color(c, m, y, k)
         end
 
         def serialize(serializer, c, m, y, k) #:nodoc:
@@ -525,7 +525,7 @@ module HexaPDF
 
         def invoke(processor, c, m, y, k) #:nodoc:
           processor.graphics_state.fill_color =
-            processor.resources.color_space(:DeviceCMYK).color(c, m, y, k)
+            processor.resources.color_space(:DeviceCMYK).prenormalized_color(c, m, y, k)
         end
 
         def serialize(serializer, c, m, y, k) #:nodoc:

data/lib/hexapdf/content/parser.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
@@ -162,12 +162,25 @@ module HexaPDF
     class Parser
 
       # Creates a new Parser object and calls #parse.
-      def self.parse(contents, processor)
-        new.parse(contents, processor)
+      def self.parse(contents, processor = nil, &block)
+        new.parse(contents, processor, &block)
       end
 
-      # Parses the contents and calls the processor object for each parsed operator.
-      def parse(contents, processor)
+      # Parses the contents and calls the processor object or the given block for each parsed
+      # operator.
+      #
+      # If a full-blown Processor is not needed (e.g. because the graphics state doesn't need to be
+      # maintained), one can use the block form to handle the parsed objects and their parameters.
+      #
+      # Note: The parameters array is reused for each processed operator, so duplicate it if
+      # necessary.
+      def parse(contents, processor = nil, &block) #:yields: object, params
+        raise ArgumentError, "Argument processor or block is needed" if processor.nil? && block.nil?
+        if processor.nil?
+          block.singleton_class.send(:alias_method, :process, :call)
+          processor = block
+        end
+
         tokenizer = Tokenizer.new(contents, raise_on_eos: true)
         params = []
         loop do

data/lib/hexapdf/content/processor.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/content/transformation_matrix.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/data_dir.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/dictionary.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
@@ -97,7 +97,7 @@ module HexaPDF
     #
     # version:: Specifies the minimum version of the PDF specification needed for this value.
     def self.define_field(name, type:, required: false, default: nil, indirect: nil,
-                          allowed_values: nil, version: '1.2')
+                          allowed_values: nil, version: '1.0')
       @fields ||= {}
       @fields[name] = Field.new(type, required: required, default: default, indirect: indirect,
                                 allowed_values: allowed_values, version: version)
@@ -163,7 +163,7 @@ module HexaPDF
                value[name] = field.default
              end
       value[name] = data = document.deref(data) if data.kind_of?(HexaPDF::Reference)
-      if data.class == HexaPDF::Object || (data.kind_of?(HexaPDF::Object) && data.value.nil?)
+      if data.instance_of?(HexaPDF::Object) || (data.kind_of?(HexaPDF::Object) && data.value.nil?)
         data = data.value
       end
       if (result = field&.convert(data, document))
@@ -182,7 +182,7 @@ module HexaPDF
         raise ArgumentError, "Only Symbol (Name) keys are allowed to be used in PDF dictionaries"
       end
 
-      if value[name].class == HexaPDF::Object && !data.kind_of?(HexaPDF::Object) &&
+      if value[name].instance_of?(HexaPDF::Object) && !data.kind_of?(HexaPDF::Object) &&
           !data.kind_of?(HexaPDF::Reference)
         value[name].value = data
       else
@@ -273,7 +273,7 @@ module HexaPDF
         # Check that required fields are set
         if field.required? && obj.nil?
           yield("Required field #{name} is not set", field.default?)
-          self[name] = obj = field.default
+          self[name] = obj = field.default if field.default?
         end
 
         # Check if the document version is set high enough

data/lib/hexapdf/dictionary_fields.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
@@ -151,17 +151,9 @@ module HexaPDF
       # Returns a duplicated default value, automatically taking unduplicatable classes into
       # account.
       def default
-        duplicatable_default? ? @default.dup : @default
+        @default.dup
       end
 
-      # Returns +true+ if the default value can safely be duplicated with #dup.
-      def duplicatable_default?
-        @duplicatable_default ||= HexaPDF::Object::NOT_DUPLICATABLE_CLASSES.none? do |klass|
-          @default.kind_of?(klass)
-        end
-      end
-      private :duplicatable_default?
-
       # Returns +true+ if the given object is valid for this field.
       def valid_object?(obj)
         type.any? {|t| obj.kind_of?(t) } ||

data/lib/hexapdf/document.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
@@ -55,6 +55,7 @@ require 'hexapdf/layout'
 begin
   require 'hexapdf/cext'
 rescue LoadError
+  # ignore error because the C-extension only makes things faster
 end
 
 # == HexaPDF API Documentation
@@ -68,15 +69,35 @@ module HexaPDF
 
   autoload(:Composer, 'hexapdf/composer')
 
+  # == HexaPDF::Document
+  #
   # Represents one PDF document.
   #
   # A PDF document consists of (indirect) objects, so the main job of this class is to provide
   # methods for working with these objects. However, since a PDF document may also be
   # incrementally updated and can therefore contain one or more revisions, there are also methods
-  # to work with these revisions.
+  # for working with these revisions.
   #
   # Note: This class provides everything to work on PDF documents on a low-level basis. This means
-  # that there are no convenience methods for higher PDF functionality whatsoever.
+  # that there are no convenience methods for higher PDF functionality. Those can be found in the
+  # objects linked from here, like #catalog.
+  #
+  # == Known Messages
+  #
+  # The document object provides a basic message dispatch system via #register_listener and
+  # #dispatch_message.
+  #
+  # Following are the messages that are used by HexaPDF itself:
+  #
+  # :complete_objects::
+  #      This message is called before the first step of writing a document. Listeners should
+  #      complete PDF objects that are missing some information.
+  #
+  #      For example, the font system uses this message to complete the font objects with
+  #      information that is only available once all the used glyphs are known.
+  #
+  # :before_write::
+  #      This message is called before a document is actually serialized and written.
   class Document
 
     autoload(:Pages, 'hexapdf/document/pages')
@@ -132,9 +153,10 @@ module HexaPDF
     #
     # decryption_opts:: A hash with options for decrypting the PDF objects loaded from the IO.
     #
-    # config:: A hash with configuration options that is deep-merged into the default
-    #          configuration (see DefaultDocumentConfiguration), meaning that direct sub-hashes
-    #          are merged instead of overwritten.
+    # config:: A hash with configuration options that is deep-merged into the default configuration
+    #          (see
+    #          HexaPDF::DefaultDocumentConfiguration[../index.html#DefaultDocumentConfiguration],
+    #          meaning that direct sub-hashes are merged instead of overwritten.
     def initialize(io: nil, decryption_opts: {}, config: {})
       @config = Configuration.with_defaults(config)
       @version = '1.2'
@@ -377,7 +399,7 @@ module HexaPDF
       case object
       when Hash
         seen[object] = true
-        object.each_with_object({}) {|(key, val), memo| memo[key] = unwrap(val, seen.dup) }
+        object.transform_values {|value| unwrap(value, seen.dup) }
       when Array
         seen[object] = true
         object.map {|inner_o| unwrap(inner_o, seen.dup) }
@@ -398,11 +420,11 @@ module HexaPDF
     # object in the PDF document. The block may either accept only the object or the object and the
     # revision it is in.
     #
-    # By default, only the current version of each object is returned which implies that each
-    # object number is yielded exactly once. If the +current+ option is +false+, all stored
-    # objects from newest to oldest are returned, not only the current version of each object.
+    # By default, only the current version of each object is returned which implies that each object
+    # number is yielded exactly once. If the +only_current+ option is +false+, all stored objects
+    # from newest to oldest are returned, not only the current version of each object.
     #
-    # The +current+ option can make a difference because the document can contain multiple
+    # The +only_current+ option can make a difference because the document can contain multiple
     # revisions:
     #
     # * Multiple revisions may contain objects with the same object and generation numbers, e.g.
@@ -440,6 +462,9 @@ module HexaPDF
     end
 
     # Dispatches the message +name+ with the given arguments to all registered listeners.
+    #
+    # See the main Document documentation for an overview of messages that are used by HexaPDF
+    # itself.
     def dispatch_message(name, *args)
       @listeners[name]&.each {|obj| obj.call(*args) }
     end
@@ -496,6 +521,13 @@ module HexaPDF
       @fonts ||= Fonts.new(self)
     end
 
+    # Returns the main AcroForm object for dealing with interactive forms.
+    #
+    # See HexaPDF::Type::Catalog#acro_form for details on the arguments.
+    def acro_form(create: false)
+      catalog.acro_form(create: create)
+    end
+
     # Executes the given task and returns its result.
     #
     # Tasks provide an extensible way for performing operations on a PDF document without
@@ -585,13 +617,9 @@ module HexaPDF
     # If a block is given, it is called on validation problems.
     #
     # See HexaPDF::Object#validate for more information.
-    def validate(auto_correct: true, only_loaded: false) #:yield: object, msg, correctable
-      cur_obj = trailer
-      block = (block_given? ? lambda {|msg, correctable| yield(cur_obj, msg, correctable) } : nil)
-
+    def validate(auto_correct: true, only_loaded: false, &block) #:yield: msg, correctable, object
       result = trailer.validate(auto_correct: auto_correct, &block)
       each(only_current: false, only_loaded: only_loaded) do |obj|
-        cur_obj = obj
         result &&= obj.validate(auto_correct: auto_correct, &block)
       end
       result
@@ -634,7 +662,7 @@ module HexaPDF
       end
 
       if validate
-        self.validate(auto_correct: true) do |obj, msg, correctable|
+        self.validate(auto_correct: true) do |msg, correctable, obj|
           next if correctable
           raise HexaPDF::Error, "Validation error for (#{obj.oid},#{obj.gen}): #{msg}"
         end

data/lib/hexapdf/document/files.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
@@ -117,7 +117,6 @@ module HexaPDF
 
           @document.pages.each do |page|
             page[:Annots]&.each do |annot|
-              annot = @document.deref(annot)
               next unless annot[:Subtype] == :FileAttachment
               spec = @document.deref(annot[:FS])
               yield(spec) unless seen.key?(spec)