origami-docspring 2.2.0 → 2.3.0

data/lib/origami/collections.rb

@@ -1,144 +1,143 @@
-=begin
+# 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/>.
+#
 
-    This file is part of Origami, PDF manipulation framework for Ruby
-    Copyright (C) 2016	Guillaume Delugré.
+module Origami
+  class PDF
+    #
+    # Returns true if the document behaves as a portfolio for embedded files.
+    #
+    def portfolio?
+      self.Catalog.Collection.is_a?(Dictionary)
+    end
+  end
 
-    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.
+  class Collection < Dictionary
+    include StandardObject
 
-    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.
+    module View
+      DETAILS = :D
+      TILE = :T
+      HIDDEN = :H
+    end
 
-    You should have received a copy of the GNU Lesser General Public License
-    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+    class Schema < Dictionary
+      include StandardObject
 
-=end
+      field :Type, Type: Name, Default: :CollectionSchema
+    end
 
-module Origami
+    class Navigator < Dictionary
+      include StandardObject
+
+      module Type
+        FLEX = :Module
+        FLASH = :Default
+      end
+
+      field :SWF, Type: String, Required: true
+      field :Name, Type: String, Required: true
+      field :Desc, Type: String
+      field :Category, Type: String
+      field :ID, Type: String, Required: true
+      field :Version, Type: String
+      field :APIVersion, Type: String, Required: true
+      field :LoadType, Type: Name, Default: Type::FLASH
+      field :Icon, Type: String
+      field :Locale, Type: String
+      field :Strings, Type: NameTreeNode.of(String)
+      field :InitialFields, Type: Schema
+      field :Resources, Type: NameTreeNode.of(Stream), Required: true
+    end
 
-    class PDF
-        #
-        # Returns true if the document behaves as a portfolio for embedded files.
-        #
-        def portfolio?
-            self.Catalog.Collection.is_a?(Dictionary)
-        end
+    class Color < Dictionary
+      include StandardObject
+
+      field :Background, Type: Array.of(Number, length: 3)
+      field :CardBackground, Type: Array.of(Number, length: 3)
+      field :CardBorder, Type: Array.of(Number, length: 3)
+      field :PrimaryText, Type: Array.of(Number, length: 3)
+      field :SecondaryText, Type: Array.of(Number, length: 3)
     end
 
-    class Collection < Dictionary
-        include StandardObject
-        
-        module View
-            DETAILS = :D
-            TILE    = :T
-            HIDDEN  = :H
-        end
-
-        class Schema < Dictionary
-            include StandardObject
-
-            field   :Type,              :Type => Name, :Default => :CollectionSchema
-        end
-
-        class Navigator < Dictionary
-            include StandardObject
-            
-            module Type
-                FLEX    = :Module
-                FLASH   = :Default
-            end
-
-            field   :SWF,               :Type => String, :Required => true
-            field   :Name,              :Type => String, :Required => true
-            field   :Desc,              :Type => String
-            field   :Category,          :Type => String
-            field   :ID,                :Type => String, :Required => true
-            field   :Version,           :Type => String
-            field   :APIVersion,        :Type => String, :Required => true
-            field   :LoadType,          :Type => Name, :Default => Type::FLASH
-            field   :Icon,              :Type => String
-            field   :Locale,            :Type => String
-            field   :Strings,           :Type => NameTreeNode.of(String)
-            field   :InitialFields,     :Type => Schema
-            field   :Resources,         :Type => NameTreeNode.of(Stream), :Required => true
-        end
-
-        class Color < Dictionary
-            include StandardObject
-
-            field   :Background,        :Type => Array.of(Number, length: 3)
-            field   :CardBackground,    :Type => Array.of(Number, length: 3)
-            field   :CardBorder,        :Type => Array.of(Number, length: 3)
-            field   :PrimaryText,       :Type => Array.of(Number, length: 3)
-            field   :SecondaryText,     :Type => Array.of(Number, length: 3)
-        end
-
-        class Split < Dictionary
-            include StandardObject
-            
-            HORIZONTAL  = :H
-            VERTICAL    = :V
-            NONE        = :N
-
-            field   :Direction,         :Type => Name
-            field   :Position,          :Type => Number
-        end
-
-        class Item < Dictionary
-            include StandardObject
-
-            field   :Type,              :Type => Name, :Default => :CollectionItem
-        end
-
-        class Subitem < Dictionary
-            include StandardObject
-
-            field   :Type,              :Type => Name, :Default => :CollectionSubitem
-            field   :D,                 :Type => [ String, Number ]
-            field   :P,                 :Type => String
-        end
-
-        class Folder < Dictionary
-            include StandardObject
-
-            field   :Type,              :Type => Name, :Default => :Folder
-            field   :ID,                :Type => Integer, :Required => true
-            field   :Name,              :Type => String, :Required => true
-            field   :Parent,            :Type => Folder
-            field   :Child,             :Type => Folder
-            field   :Next,              :Type => Folder
-            field   :CI,                :Type => Item
-            field   :Desc,              :Type => String
-            field   :CreationDate,      :Type => String
-            field   :ModDate,           :Type => String
-            field   :Thumb,             :Type => Stream
-            field   :Free,              :Type => Array.of(Array.of(Integer, length: 2))
-        end
-
-        class Sort < Dictionary
-            include StandardObject
-
-            field   :Type,              :Type => Name, :Default => :CollectionSort
-            field   :S,                 :Type => [ Name, Array.of(Name) ]
-            field   :A,                 :Type => [ Boolean, Array.of(Boolean) ]
-        end
-
-        #
-        # Collection fields.
-        #
-        field   :Type,              :Type => Name, :Default => :Collection
-        field   :Schema,            :Type => Schema
-        field   :D,                 :Type => String
-        field   :View,              :Type => Name, :Default => View::DETAILS
-        field   :Sort,              :Type => Sort
-        field   :Navigator,         :Type => Navigator, :ExtensionLevel => 3
-        field   :Resources,         :Type => NameTreeNode.of(Stream), :ExtensionLevel => 3
-        field   :Colors,            :Type => Color, :ExtensionLevel => 3
-        field   :Folders,           :Type => Folder, :ExtensionLevel => 3
-        field   :Split,             :Type => Split, :ExtensionLevel => 3
+    class Split < Dictionary
+      include StandardObject
+
+      HORIZONTAL = :H
+      VERTICAL = :V
+      NONE = :N
+
+      field :Direction, Type: Name
+      field :Position, Type: Number
     end
+
+    class Item < Dictionary
+      include StandardObject
+
+      field :Type, Type: Name, Default: :CollectionItem
+    end
+
+    class Subitem < Dictionary
+      include StandardObject
+
+      field :Type, Type: Name, Default: :CollectionSubitem
+      field :D, Type: [String, Number]
+      field :P, Type: String
+    end
+
+    class Folder < Dictionary
+      include StandardObject
+
+      field :Type, Type: Name, Default: :Folder
+      field :ID, Type: Integer, Required: true
+      field :Name, Type: String, Required: true
+      field :Parent, Type: Folder
+      field :Child, Type: Folder
+      field :Next, Type: Folder
+      field :CI, Type: Item
+      field :Desc, Type: String
+      field :CreationDate, Type: String
+      field :ModDate, Type: String
+      field :Thumb, Type: Stream
+      field :Free, Type: Array.of(Array.of(Integer, length: 2))
+    end
+
+    class Sort < Dictionary
+      include StandardObject
+
+      field :Type, Type: Name, Default: :CollectionSort
+      field :S, Type: [Name, Array.of(Name)]
+      field :A, Type: [Boolean, Array.of(Boolean)]
+    end
+
+    #
+    # Collection fields.
+    #
+    field :Type, Type: Name, Default: :Collection
+    field :Schema, Type: Schema
+    field :D, Type: String
+    field :View, Type: Name, Default: View::DETAILS
+    field :Sort, Type: Sort
+    field :Navigator, Type: Navigator, ExtensionLevel: 3
+    field :Resources, Type: NameTreeNode.of(Stream), ExtensionLevel: 3
+    field :Colors, Type: Color, ExtensionLevel: 3
+    field :Folders, Type: Folder, ExtensionLevel: 3
+    field :Split, Type: Split, ExtensionLevel: 3
+  end
 end

data/lib/origami/compound.rb

@@ -1,161 +1,157 @@
-=begin
-
-    This file is part of Origami, PDF manipulation framework for Ruby
-    Copyright (C) 2017	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 'set'
+# frozen_string_literal: true
+
+#
+#     This file is part of Origami, PDF manipulation framework for Ruby
+#     Copyright (C) 2017	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
+  #
+  # Module for maintaining internal caches of objects for fast lookup.
+  #
+  module ObjectCache
+    attr_reader :strings_cache, :names_cache, :xref_cache
 
-    #
-    # Module for maintaining internal caches of objects for fast lookup.
-    #
-    module ObjectCache
-        attr_reader :strings_cache, :names_cache, :xref_cache
-
-        def initialize(*args)
-            super(*args)
+    def initialize(*args)
+      super
 
-            init_caches
-        end
+      init_caches
+    end
 
-        def rebuild_caches
-            self.each do |*items|
-                items.each do |object|
-                    object.rebuild_caches if object.is_a?(CompoundObject)
-                    cache_object(object)
-                end
-            end
+    def rebuild_caches
+      each do |*items|
+        items.each do |object|
+          object.rebuild_caches if object.is_a?(CompoundObject)
+          cache_object(object)
         end
+      end
+    end
 
-        private
+    private
 
-        def init_caches
-            @strings_cache = Set.new
-            @names_cache = Set.new
-            @xref_cache = {}
-        end
+    def init_caches
+      @strings_cache = Set.new
+      @names_cache = Set.new
+      @xref_cache = {}
+    end
 
-        def cache_object(object)
-            case object
-            when String then cache_string(object)
-            when Name then cache_name(object)
-            when Reference then cache_reference(object)
-            when CompoundObject then cache_compound(object)
-            end
+    def cache_object(object)
+      case object
+      when String then cache_string(object)
+      when Name then cache_name(object)
+      when Reference then cache_reference(object)
+      when CompoundObject then cache_compound(object)
+      end
 
-            object
-        end
+      object
+    end
 
-        def cache_compound(object)
-            @strings_cache.merge(object.strings_cache)
-            @names_cache.merge(object.names_cache)
-            @xref_cache.update(object.xref_cache) do |_, cache1, cache2|
-                cache1.concat(cache2)
-            end
+    def cache_compound(object)
+      @strings_cache.merge(object.strings_cache)
+      @names_cache.merge(object.names_cache)
+      @xref_cache.update(object.xref_cache) do |_, cache1, cache2|
+        cache1.concat(cache2)
+      end
 
-            object.strings_cache.clear
-            object.names_cache.clear
-            object.xref_cache.clear
-        end
+      object.strings_cache.clear
+      object.names_cache.clear
+      object.xref_cache.clear
+    end
 
-        def cache_string(str)
-            @strings_cache.add(str)
-        end
+    def cache_string(str)
+      @strings_cache.add(str)
+    end
 
-        def cache_name(name)
-            @names_cache.add(name)
-        end
+    def cache_name(name)
+      @names_cache.add(name)
+    end
 
-        def cache_reference(ref)
-            @xref_cache[ref] ||= []
-            @xref_cache[ref].push(self)
-        end
+    def cache_reference(ref)
+      @xref_cache[ref] ||= []
+      @xref_cache[ref].push(self)
     end
+  end
+
+  #
+  # Module for objects containing other objects.
+  #
+  module CompoundObject
+    include Origami::Object
+    include ObjectCache
+    using TypeConversion
 
     #
-    # Module for objects containing other objects.
+    # Returns true if the item is present in the compound object.
     #
-    module CompoundObject
-        include Origami::Object
-        include ObjectCache
-        using TypeConversion
-
-        #
-        # Returns true if the item is present in the compound object.
-        #
-        def include?(item)
-            super(item.to_o)
-        end
-
-        #
-        # Removes the item from the compound object if present.
-        #
-        def delete(item)
-            obj = super(item.to_o)
-            unlink_object(obj) unless obj.nil?
-        end
+    def include?(item)
+      super(item.to_o)
+    end
 
-        #
-        # Creates a deep copy of the compound object.
-        # This method can be quite expensive as nested objects are copied too.
-        #
-        def copy
-            obj = self.update_values(&:copy)
+    #
+    # Removes the item from the compound object if present.
+    #
+    def delete(item)
+      obj = super(item.to_o)
+      unlink_object(obj) unless obj.nil?
+    end
 
-            transfer_attributes(obj)
-        end
+    #
+    # Creates a deep copy of the compound object.
+    # This method can be quite expensive as nested objects are copied too.
+    #
+    def copy
+      obj = update_values(&:copy)
 
-        #
-        # Returns a new compound object with updated values based on the provided block.
-        #
-        def update_values(&b)
-            return enum_for(__method__) unless block_given?
-            return self.class.new self.transform_values(&b) if self.respond_to?(:transform_values)
-            return self.class.new self.map(&b) if self.respond_to?(:map)
+      transfer_attributes(obj)
+    end
 
-            raise NotImplementedError, "This object does not implement this method"
-        end
+    #
+    # Returns a new compound object with updated values based on the provided block.
+    #
+    def update_values(&b)
+      return enum_for(__method__) unless block_given?
+      return self.class.new transform_values(&b) if respond_to?(:transform_values)
+      return self.class.new map(&b) if respond_to?(:map)
 
-        #
-        # Modifies the compound object's values based on the provided block.
-        #
-        def update_values!(&b)
-            return enum_for(__method__) unless block_given?
-            return self.transform_values!(&b) if self.respond_to?(:transform_values!)
-            return self.map!(&b) if self.respond_to?(:map!)
+      raise NotImplementedError, "This object does not implement this method"
+    end
 
-            raise NotImplementedError, "This object does not implement this method"
-        end
+    #
+    # Modifies the compound object's values based on the provided block.
+    #
+    def update_values!(&b)
+      return enum_for(__method__) unless block_given?
+      return transform_values!(&b) if respond_to?(:transform_values!)
+      return map!(&b) if respond_to?(:map!)
 
-        private
+      raise NotImplementedError, "This object does not implement this method"
+    end
 
-        def link_object(item)
-            obj = item.to_o
-            obj.parent = self unless obj.indirect?
+    private
 
-            cache_object(obj)
-        end
+    def link_object(item)
+      obj = item.to_o
+      obj.parent = self unless obj.indirect?
 
-        def unlink_object(obj)
-            obj.parent = nil 
-            obj
-        end
+      cache_object(obj)
     end
 
+    def unlink_object(obj)
+      obj.parent = nil
+      obj
+    end
+  end
 end