origami-docspring 2.2.0 → 2.3.0

data/lib/origami/metadata.rb

@@ -1,92 +1,113 @@
-=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/>.
+#
 
 require 'rexml/document'
 
 module Origami
+  class PDF
+    #
+    # Returns true if the document has a document information dictionary.
+    #
+    def document_info?
+      trailer_key? :Info
+    end
 
-    class PDF
-        #
-        # Returns true if the document has a document information dictionary.
-        #
-        def document_info?
-            trailer_key? :Info
-        end
+    #
+    # Returns the document information dictionary if present.
+    #
+    def document_info
+      trailer_key :Info
+    end
 
-        #
-        # Returns the document information dictionary if present.
-        #
-        def document_info
-            trailer_key :Info
-        end
+    def title
+      get_document_info_field(:Title)
+    end
 
-        def title; get_document_info_field(:Title) end
-        def author; get_document_info_field(:Author) end
-        def subject; get_document_info_field(:Subject) end
-        def keywords; get_document_info_field(:Keywords) end
-        def creator; get_document_info_field(:Creator) end
-        def producer; get_document_info_field(:Producer) end
-        def creation_date; get_document_info_field(:CreationDate) end
-        def mod_date; get_document_info_field(:ModDate) end
-
-        #
-        # Returns true if the document has a catalog metadata stream.
-        #
-        def metadata?
-            self.Catalog.Metadata.is_a?(Stream)
-        end
+    def author
+      get_document_info_field(:Author)
+    end
+
+    def subject
+      get_document_info_field(:Subject)
+    end
+
+    def keywords
+      get_document_info_field(:Keywords)
+    end
 
-        #
-        # Returns a Hash of the information found in the metadata stream
-        #
-        def metadata
-            metadata_stm = self.Catalog.Metadata
+    def creator
+      get_document_info_field(:Creator)
+    end
 
-            if metadata_stm.is_a?(Stream)
-                doc = REXML::Document.new(metadata_stm.data)
-                info = {}
+    def producer
+      get_document_info_field(:Producer)
+    end
 
-                doc.elements.each('*/*/rdf:Description') do |description|
+    def creation_date
+      get_document_info_field(:CreationDate)
+    end
 
-                    description.attributes.each_attribute do |attr|
-                        case attr.prefix
-                        when 'pdf','xap'
-                            info[attr.name] = attr.value
-                        end
-                    end
+    def mod_date
+      get_document_info_field(:ModDate)
+    end
 
-                    description.elements.each('*') do |element|
-                        value = (element.elements['.//rdf:li'] || element).text
-                        info[element.name] = value.to_s
-                    end
-                end
+    #
+    # Returns true if the document has a catalog metadata stream.
+    #
+    def metadata?
+      self.Catalog.Metadata.is_a?(Stream)
+    end
 
-                info
+    #
+    # Returns a Hash of the information found in the metadata stream
+    #
+    def metadata
+      metadata_stm = self.Catalog.Metadata
+
+      if metadata_stm.is_a?(Stream)
+        doc = REXML::Document.new(metadata_stm.data)
+        info = {}
+
+        doc.elements.each('*/*/rdf:Description') do |description|
+          description.attributes.each_attribute do |attr|
+            case attr.prefix
+            when 'pdf', 'xap'
+              info[attr.name] = attr.value
             end
+          end
+
+          description.elements.each('*') do |element|
+            value = (element.elements['.//rdf:li'] || element).text
+            info[element.name] = value.to_s
+          end
         end
 
-        #
-        # Modifies or creates a metadata stream.
-        #
-        def create_metadata(info = {})
-            skeleton = <<-XMP
+        info
+      end
+    end
+
+    #
+    # Modifies or creates a metadata stream.
+    #
+    def create_metadata(info = {})
+      skeleton = <<-XMP
             <?packet begin="\xef\xbb\xbf" id="W5M0MpCehiHzreSzNTczkc9d"?>
               <x:xmpmeta xmlns:x="adobe:ns:meta/">
                 <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
@@ -95,78 +116,78 @@ module Origami
                 </rdf:RDF>
               </x:xmpmeta>
             <?xpacket end="w"?>
-            XMP
-
-            xml =
-                if self.Catalog.Metadata.is_a?(Stream)
-                    self.Catalog.Metadata.data
-                else
-                    skeleton
-                end
+      XMP
 
-            doc = REXML::Document.new(xml)
-            desc = doc.elements['*/*/rdf:Description']
-
-            info.each do |name, value|
-                elt = REXML::Element.new "pdf:#{name}"
-                elt.text = value
-
-                desc.elements << elt
-            end
+      xml =
+        if self.Catalog.Metadata.is_a?(Stream)
+          self.Catalog.Metadata.data
+        else
+          skeleton
+        end
 
-            xml = ""; doc.write(xml, 4)
+      doc = REXML::Document.new(xml)
+      desc = doc.elements['*/*/rdf:Description']
 
-            if self.Catalog.Metadata.is_a?(Stream)
-                self.Catalog.Metadata.data = xml
-            else
-               self.Catalog.Metadata = Stream.new(xml)
-            end
+      info.each do |name, value|
+        elt = REXML::Element.new "pdf:#{name}"
+        elt.text = value
 
-            self.Catalog.Metadata
-        end
+        desc.elements << elt
+      end
 
-        private
+      xml = ""
+      doc.write(xml, 4)
 
-        def get_document_info_field(field) #:nodoc:
-            if self.document_info?
-                doc_info = self.document_info
+      if self.Catalog.Metadata.is_a?(Stream)
+        self.Catalog.Metadata.data = xml
+      else
+        self.Catalog.Metadata = Stream.new(xml)
+      end
 
-                if doc_info.key?(field)
-                    case obj = doc_info[field].solve
-                    when String then obj.value
-                    when Stream then obj.data
-                    end
-                end
-            end
-        end
+      self.Catalog.Metadata
     end
 
-    #
-    # Class representing an information Dictionary, containing title, author, date of creation and the like.
-    #
-    class Metadata < Dictionary
-        include StandardObject
-
-        field   :Title,                   :Type => String, :Version => "1.1"
-        field   :Author,                  :Type => String
-        field   :Subject,                 :Type => String, :Version => "1.1"
-        field   :Keywords,                :Type => String, :Version => "1.1"
-        field   :Creator,                 :Type => String
-        field   :Producer,                :Type => String
-        field   :CreationDate,            :Type => String
-        field   :ModDate,                 :Type => String, :Version => "1.1"
-        field   :Trapped,                 :Type => Name, :Default => :Unknown, :Version => "1.3"
-    end
+    private
 
-    #
-    # Class representing a metadata Stream.
-    # This stream can contain the same information as the Metadata dictionary, but is storing in XML data.
-    #
-    class MetadataStream < Stream
-        include StandardObject
+    def get_document_info_field(field) # :nodoc:
+      if document_info?
+        doc_info = document_info
 
-        field   :Type,                    :Type => Name, :Default => :Metadata, :Required => true
-        field   :Subtype,                 :Type => Name, :Default =>:XML, :Required => true
+        if doc_info.key?(field)
+          case obj = doc_info[field].solve
+          when String then obj.value
+          when Stream then obj.data
+          end
+        end
+      end
     end
-
+  end
+
+  #
+  # Class representing an information Dictionary, containing title, author, date of creation and the like.
+  #
+  class Metadata < Dictionary
+    include StandardObject
+
+    field :Title, Type: String, Version: "1.1"
+    field :Author, Type: String
+    field :Subject, Type: String, Version: "1.1"
+    field :Keywords, Type: String, Version: "1.1"
+    field :Creator, Type: String
+    field :Producer, Type: String
+    field :CreationDate, Type: String
+    field :ModDate, Type: String, Version: "1.1"
+    field :Trapped, Type: Name, Default: :Unknown, Version: "1.3"
+  end
+
+  #
+  # Class representing a metadata Stream.
+  # This stream can contain the same information as the Metadata dictionary, but is storing in XML data.
+  #
+  class MetadataStream < Stream
+    include StandardObject
+
+    field :Type, Type: Name, Default: :Metadata, Required: true
+    field :Subtype, Type: Name, Default: :XML, Required: true
+  end
 end

data/lib/origami/name.rb

@@ -1,135 +1,133 @@
-=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é.
-
-    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
+  REGULARCHARS = "([^ \\t\\r\\n\\0\\[\\]<>()%\\/]|#[a-fA-F0-9][a-fA-F0-9])*" # :nodoc:
 
-=end
+  class InvalidNameObjectError < InvalidObjectError # :nodoc:
+  end
 
-module Origami
+  #
+  # Class representing a Name Object.
+  # Name objects are strings which identify some PDF file inner structures.
+  #
+  class Name
+    include Origami::Object
+    include Comparable
 
-    REGULARCHARS = "([^ \\t\\r\\n\\0\\[\\]<>()%\\/]|#[a-fA-F0-9][a-fA-F0-9])*" #:nodoc:
+    TOKENS = %w[/] # :nodoc:
 
-    class InvalidNameObjectError < InvalidObjectError #:nodoc:
-    end
+    @@regexp = Regexp.new(WHITESPACES + TOKENS.first + "(?<name>#{REGULARCHARS})" + WHITESPACES) # :nodoc
 
     #
-    # Class representing a Name Object.
-    # Name objects are strings which identify some PDF file inner structures.
+    # Creates a new Name.
+    # _name_:: A symbol representing the new Name value.
     #
-    class Name
-        include Origami::Object
-        include Comparable
-
-        TOKENS = %w{ / } #:nodoc:
-
-        @@regexp = Regexp.new(WHITESPACES + TOKENS.first + "(?<name>#{REGULARCHARS})" + WHITESPACES) #:nodoc
+    def initialize(name = "")
+      unless name.is_a?(Symbol) || name.is_a?(::String)
+        raise TypeError, "Expected type Symbol or String, received #{name.class}."
+      end
 
-        #
-        # Creates a new Name.
-        # _name_:: A symbol representing the new Name value.
-        #
-        def initialize(name = "")
-            unless name.is_a?(Symbol) or name.is_a?(::String)
-                raise TypeError, "Expected type Symbol or String, received #{name.class}."
-            end
+      @value = name.to_s
 
-            @value = name.to_s
-
-            super()
-        end
-
-        def value
-            @value.to_sym
-        end
-        alias to_sym value
-
-        def <=>(name)
-            return unless name.is_a?(Name)
+      super()
+    end
 
-            self.value <=> name.value
-        end
+    def value
+      @value.to_sym
+    end
+    alias_method :to_sym, :value
 
-        def ==(object) #:nodoc:
-            self.eql?(object) or @value.to_sym == object
-        end
+    def <=>(other)
+      return unless other.is_a?(Name)
 
-        def eql?(object) #:nodoc:
-            object.is_a?(Name) and self.value.eql?(object.value)
-        end
+      value <=> other.value
+    end
 
-        def hash #:nodoc:
-            @value.hash
-        end
+    def ==(other) # :nodoc:
+      eql?(other) or @value.to_sym == other
+    end
 
-        def to_s(eol: $/) #:nodoc:
-            super(TOKENS.first + Name.expand(@value), eol: eol)
-        end
+    def eql?(other) # :nodoc:
+      other.is_a?(Name) and value.eql?(other.value)
+    end
 
-        def self.parse(stream, _parser = nil) #:nodoc:
-            scanner = Parser.init_scanner(stream)
-            offset = scanner.pos
+    def hash # :nodoc:
+      @value.hash
+    end
 
-            name =
-                if scanner.scan(@@regexp).nil?
-                    raise InvalidNameObjectError, "Bad name format"
-                else
-                    value = scanner['name']
+    def to_s(eol: $/) # :nodoc:
+      super(TOKENS.first + Name.expand(@value), eol: eol)
+    end
 
-                    Name.new(value.include?('#') ? contract(value) : value)
-                end
+    def self.parse(stream, _parser = nil) # :nodoc:
+      scanner = Parser.init_scanner(stream)
+      offset = scanner.pos
 
-            name.file_offset = offset
+      name =
+        if scanner.scan(@@regexp).nil?
+          raise InvalidNameObjectError, "Bad name format"
+        else
+          value = scanner['name']
 
-            name
+          Name.new(value.include?('#') ? contract(value) : value)
         end
 
-        def self.contract(name) #:nodoc:
-            i = 0
-            name = name.dup
+      name.file_offset = offset
 
-            while i < name.length
-                if name[i] == "#"
-                    digits = name[i+1, 2]
+      name
+    end
 
-                    unless digits =~ /^[A-Za-z0-9]{2}$/
-                        raise InvalidNameObjectError, "Irregular use of # token"
-                    end
+    def self.contract(name) # :nodoc:
+      i = 0
+      name = name.dup
 
-                    char = digits.hex.chr
+      while i < name.length
+        if name[i] == "#"
+          digits = name[i + 1, 2]
 
-                    if char == "\0"
-                        raise InvalidNameObjectError, "Null byte forbidden inside name definition"
-                    end
+          unless digits =~ /^[A-Za-z0-9]{2}$/
+            raise InvalidNameObjectError, "Irregular use of # token"
+          end
 
-                    name[i, 3] = char
-                end
+          char = digits.hex.chr
 
-                i = i + 1
-            end
+          if char == "\0"
+            raise InvalidNameObjectError, "Null byte forbidden inside name definition"
+          end
 
-            name
+          name[i, 3] = char
         end
 
-        def self.expand(name) #:nodoc:
-            forbiddenchars = /[ #\t\r\n\0\[\]<>()%\/]/
+        i += 1
+      end
 
-            name.gsub(forbiddenchars) do |c|
-                "#" + c.ord.to_s(16).rjust(2,"0")
-            end
-        end
+      name
     end
 
+    def self.expand(name) # :nodoc:
+      forbiddenchars = /[ #\t\r\n\0\[\]<>()%\/]/
+
+      name.gsub(forbiddenchars) do |c|
+        "#" + c.ord.to_s(16).rjust(2, "0")
+      end
+    end
+  end
 end

data/lib/origami/null.rb

@@ -1,65 +1,63 @@
-=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 InvalidNullObjectError < InvalidObjectError # :nodoc:
+  end
+
+  #
+  # Class representing  Null Object.
+  #
+  class Null
+    include Origami::Object
 
-    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.
+    TOKENS = %w[null] # :nodoc:
+    @@regexp = Regexp.new(WHITESPACES + TOKENS.first)
 
-    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.
+    def initialize
+      super
+    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/>.
+    def self.parse(stream, _parser = nil) # :nodoc:
+      scanner = Parser.init_scanner(stream)
+      offset = scanner.pos
 
-=end
+      if scanner.skip(@@regexp).nil?
+        raise InvalidNullObjectError
+      end
 
-module Origami
+      null = Null.new
+      null.file_offset = offset
 
-    class InvalidNullObjectError < InvalidObjectError #:nodoc:
+      null
     end
 
     #
-    # Class representing  Null Object.
+    # Returns *nil*.
     #
-    class Null
-        include Origami::Object
-
-        TOKENS = %w{ null } #:nodoc:
-        @@regexp = Regexp.new(WHITESPACES + TOKENS.first)
-
-        def initialize
-            super
-        end
-
-        def self.parse(stream, _parser = nil) #:nodoc:
-            scanner = Parser.init_scanner(stream)
-            offset = scanner.pos
-
-            if scanner.skip(@@regexp).nil?
-                raise InvalidNullObjectError
-            end
-
-            null = Null.new
-            null.file_offset = offset
-
-            null
-        end
-
-        #
-        # Returns *nil*.
-        #
-        def value
-            nil
-        end
-
-        def to_s(eol: $/) #:nodoc:
-            super(TOKENS.first, eol: eol)
-        end
+    def value
+      nil
     end
 
+    def to_s(eol: $/) # :nodoc:
+      super(TOKENS.first, eol: eol)
+    end
+  end
 end