origami-docspring 2.2.0 → 2.3.0

data/lib/origami/trailer.rb

@@ -1,190 +1,186 @@
-=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
+  class PDF
+    #
+    # Returns the current trailer.
+    # This might be either a Trailer or XRefStream.
+    #
+    def trailer
+      #
+      # First look for a standard trailer dictionary
+      #
+      trl = if @revisions.last.trailer.dictionary?
+        @revisions.last.trailer
+
+      #
+      # Otherwise look for a xref stream.
+      #
+      else
+        @revisions.last.xrefstm
+      end
+
+      raise InvalidPDFError, "No trailer found" if trl.nil?
+
+      trl
+    end
 
-    class PDF
-
-        #
-        # Returns the current trailer.
-        # This might be either a Trailer or XRefStream.
-        #
-        def trailer
-            #
-            # First look for a standard trailer dictionary
-            #
-            if @revisions.last.trailer.dictionary?
-                trl = @revisions.last.trailer
-
-            #
-            # Otherwise look for a xref stream.
-            #
-            else
-                trl = @revisions.last.xrefstm
-            end
-
-            raise InvalidPDFError, "No trailer found" if trl.nil?
-
-            trl
-        end
-
-        private
+    private
 
-        def trailer_key?(attr) #:nodoc:
-            !!trailer_key(attr)
-        end
+    def trailer_key?(attr) # :nodoc:
+      !!trailer_key(attr)
+    end
 
-        def trailer_key(attr) #:nodoc:
-            @revisions.reverse_each do |rev|
-                if rev.trailer.dictionary? and rev.trailer.key?(attr)
-                    return rev.trailer[attr].solve
-                elsif rev.xrefstm?
-                    xrefstm = rev.xrefstm
-                    if xrefstm.is_a?(XRefStream) and xrefstm.key?(attr)
-                        return xrefstm[attr].solve
-                    end
-                end
-            end
-
-            nil
+    def trailer_key(attr) # :nodoc:
+      @revisions.reverse_each do |rev|
+        if rev.trailer.dictionary? && rev.trailer.key?(attr)
+          return rev.trailer[attr].solve
+        elsif rev.xrefstm?
+          xrefstm = rev.xrefstm
+          if xrefstm.is_a?(XRefStream) && xrefstm.key?(attr)
+            return xrefstm[attr].solve
+          end
         end
+      end
 
-        def generate_id
-            id = HexaString.new Random.new.bytes 16
-            self.trailer.ID = [ id, id ]
-        end
+      nil
     end
 
-    class InvalidTrailerError < Error #:nodoc:
+    def generate_id
+      id = HexaString.new Random.new.bytes 16
+      trailer.ID = [id, id]
     end
+  end
 
-    # Forward declarations.
-    class Catalog < Dictionary; end
-    class Metadata < Dictionary; end
-
-    #
-    # Class representing a PDF file Trailer.
-    #
-    class Trailer
-        include StandardObject
+  class InvalidTrailerError < Error # :nodoc:
+  end
 
-        TOKENS = %w{ trailer %%EOF } #:nodoc:
-        XREF_TOKEN = "startxref" #:nodoc:
+  # Forward declarations.
+  class Catalog < Dictionary; end
 
-        @@regexp_open   = Regexp.new(WHITESPACES + TOKENS.first + WHITESPACES)
-        @@regexp_xref   = Regexp.new(WHITESPACES + XREF_TOKEN + WHITESPACES + "(?<startxref>\\d+)")
-        @@regexp_close  = Regexp.new(WHITESPACES + TOKENS.last + WHITESPACES)
+  class Metadata < Dictionary; end
 
-        attr_accessor :document
-        attr_accessor :startxref
-        attr_reader :dictionary
+  #
+  # Class representing a PDF file Trailer.
+  #
+  class Trailer
+    include StandardObject
 
-        field   :Size,      :Type => Integer, :Required => true
-        field   :Prev,      :Type => Integer
-        field   :Root,      :Type => Catalog, :Required => true
-        field   :Encrypt,   :Type => Encryption::Standard::Dictionary
-        field   :Info,      :Type => Metadata
-        field   :ID,        :Type => Array.of(String, length: 2)
-        field   :XRefStm,   :Type => Integer
+    TOKENS = %w[trailer %%EOF] # :nodoc:
+    XREF_TOKEN = "startxref" # :nodoc:
 
-        #
-        # Creates a new Trailer.
-        # _startxref_:: The file _offset_ to the XRef::Section.
-        # _dictionary_:: A hash of attributes to set in the Trailer Dictionary.
-        #
-        def initialize(startxref = 0, dictionary = {})
-            @startxref, self.dictionary = startxref, dictionary && Dictionary.new(dictionary)
-        end
+    @@regexp_open = Regexp.new(WHITESPACES + TOKENS.first + WHITESPACES)
+    @@regexp_xref = Regexp.new(WHITESPACES + XREF_TOKEN + WHITESPACES + "(?<startxref>\\d+)")
+    @@regexp_close = Regexp.new(WHITESPACES + TOKENS.last + WHITESPACES)
 
-        def self.parse(stream, parser = nil) #:nodoc:
-            scanner = Parser.init_scanner(stream)
+    attr_accessor :document
+    attr_accessor :startxref
+    attr_reader :dictionary
 
-            if scanner.skip(@@regexp_open)
-                dictionary = Dictionary.parse(scanner, parser)
-            else
-                dictionary = nil
-            end
+    field :Size, Type: Integer, Required: true
+    field :Prev, Type: Integer
+    field :Root, Type: Catalog, Required: true
+    field :Encrypt, Type: Encryption::Standard::Dictionary
+    field :Info, Type: Metadata
+    field :ID, Type: Array.of(String, length: 2)
+    field :XRefStm, Type: Integer
 
-            if not scanner.scan(@@regexp_xref)
-                raise InvalidTrailerError, "Cannot get startxref value"
-            end
+    #
+    # Creates a new Trailer.
+    # _startxref_:: The file _offset_ to the XRef::Section.
+    # _dictionary_:: A hash of attributes to set in the Trailer Dictionary.
+    #
+    def initialize(startxref = 0, dictionary = {})
+      @startxref, self.dictionary = startxref, dictionary && Dictionary.new(dictionary)
+    end
 
-            startxref = scanner['startxref'].to_i
+    def self.parse(stream, parser = nil) # :nodoc:
+      scanner = Parser.init_scanner(stream)
 
-            if not scanner.scan(@@regexp_close)
-                parser.warn("No %%EOF token found") if parser
-            end
+      dictionary = if scanner.skip(@@regexp_open)
+        Dictionary.parse(scanner, parser)
+      end
 
-            Trailer.new(startxref, dictionary)
-        end
+      if !scanner.scan(@@regexp_xref)
+        raise InvalidTrailerError, "Cannot get startxref value"
+      end
 
-        #
-        # Returns true if the specified key is present in the Trailer dictionary.
-        #
-        def key?(key)
-            self.dictionary? and @dictionary.key?(key)
-        end
+      startxref = scanner['startxref'].to_i
 
-        #
-        # Access a key in the trailer dictionary if present.
-        #
-        def [](key)
-            @dictionary[key] if dictionary?
-        end
+      if !scanner.scan(@@regexp_close)
+        parser&.warn("No %%EOF token found")
+      end
 
-        #
-        # Sets a value in the trailer dictionary.
-        #
-        def []=(key, value)
-            self.dictionary = Dictionary.new unless dictionary?
-            @dictionary[key] = value
-        end
+      Trailer.new(startxref, dictionary)
+    end
 
-        #
-        # Sets the trailer dictionary.
-        #
-        def dictionary=(dict)
-            dict.parent = self if dict
-            @dictionary = dict
-        end
+    #
+    # Returns true if the specified key is present in the Trailer dictionary.
+    #
+    def key?(key)
+      dictionary? and @dictionary.key?(key)
+    end
 
-        #
-        # Returns true if the Trailer contains a Dictionary.
-        #
-        def dictionary?
-            not @dictionary.nil?
-        end
+    #
+    # Access a key in the trailer dictionary if present.
+    #
+    def [](key)
+      @dictionary[key] if dictionary?
+    end
 
-        #
-        # Outputs self into PDF code.
-        #
-        def to_s(indent: 1, eol: $/)
-            content = ""
-            if self.dictionary?
-                content << TOKENS.first << eol << @dictionary.to_s(indent: indent, eol: eol) << eol
-            end
+    #
+    # Sets a value in the trailer dictionary.
+    #
+    def []=(key, value)
+      self.dictionary = Dictionary.new unless dictionary?
+      @dictionary[key] = value
+    end
 
-            content << XREF_TOKEN << eol << @startxref.to_s << eol << TOKENS.last << eol
+    #
+    # Sets the trailer dictionary.
+    #
+    def dictionary=(dict)
+      dict.parent = self if dict
+      @dictionary = dict
+    end
 
-            content
-        end
+    #
+    # Returns true if the Trailer contains a Dictionary.
+    #
+    def dictionary?
+      !@dictionary.nil?
     end
 
+    #
+    # Outputs self into PDF code.
+    #
+    def to_s(indent: 1, eol: $/)
+      content = +""
+      if dictionary?
+        content << TOKENS.first << eol << @dictionary.to_s(indent: indent, eol: eol) << eol
+      end
+
+      content << XREF_TOKEN << eol << @startxref.to_s << eol << TOKENS.last << eol
+
+      content
+    end
+  end
 end

data/lib/origami/tree.rb

@@ -1,62 +1,60 @@
-=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
-
-    class InvalidNameTreeError < Error #:nodoc:
+  class InvalidNameTreeError < Error # :nodoc:
+  end
+
+  #
+  # Class representing a node in a Name tree.
+  #
+  class NameTreeNode < Dictionary
+    include StandardObject
+
+    field :Kids, Type: Array.of(self)
+    field :Names, Type: Array.of(String, Object)
+    field :Limits, Type: Array.of(String, length: 2)
+
+    def self.of(klass)
+      Class.new(self) do
+        field :Kids, Type: Array.of(self)
+        field :Names, Type: Array.of(String, klass)
+      end
     end
-
-    #
-    # Class representing a node in a Name tree.
-    #
-    class NameTreeNode < Dictionary
-        include StandardObject
-
-        field   :Kids,              :Type => Array.of(self)
-        field   :Names,             :Type => Array.of(String, Object)
-        field   :Limits,            :Type => Array.of(String, length: 2)
-
-        def self.of(klass)
-            return Class.new(self) do
-                field   :Kids,      :Type => Array.of(self)
-                field   :Names,     :Type => Array.of(String, klass)
-            end
-        end
+  end
+
+  #
+  # Class representing a node in a Number tree.
+  #
+  class NumberTreeNode < Dictionary
+    include StandardObject
+
+    field :Kids, Type: Array.of(self)
+    field :Nums, Type: Array.of(Number, Object)
+    field :Limits, Type: Array.of(Number, length: 2)
+
+    def self.of(klass)
+      Class.new(self) do
+        field :Kids, Type: Array.of(self)
+        field :Nums, Type: Array.of(Number, klass)
+      end
     end
-
-    #
-    # Class representing a node in a Number tree.
-    #
-    class NumberTreeNode < Dictionary
-        include StandardObject
-
-        field   :Kids,              :Type => Array.of(self)
-        field   :Nums,              :Type => Array.of(Number, Object)
-        field   :Limits,            :Type => Array.of(Number, length: 2)
-
-        def self.of(klass)
-            return Class.new(self) do
-                field   :Kids,      :Type => Array.of(self)
-                field   :Nums,      :Type => Array.of(Number, klass)
-            end
-        end
-    end
-
+  end
 end

data/lib/origami/version.rb

@@ -1,23 +1,23 @@
-=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/>.
-
-=end
+#
+#     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
-    VERSION   = "2.2.0"
+  VERSION = "2.3.0"
 end