origami-docspring 2.2.0 → 2.3.0

data/lib/origami/parsers/pdf.rb

@@ -1,118 +1,120 @@
-=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é.
+require 'origami/parser'
 
-    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.
+module Origami
+  class PDF
+    class Parser < Origami::Parser
+      def initialize(params = {})
+        options =
+          {
+            decrypt: true,                # Attempt to decrypt to document if encrypted (recommended).
+            password: '',                 # Default password being tried when opening a protected document.
+            prompt_password: lambda do    # Callback procedure to prompt password when document is encrypted.
+              require 'io/console'
+              $stderr.print "Password: "
+              $stdin.noecho(&:gets).chomp
+            rescue Errno::ENODEV, LoadError
+              # If we can't use noecho (e.g., in a non-interactive environment)
+              $stderr.print "Password (will be visible): "
+              $stdin.gets.chomp
+            end,
+            force: false                  # Force PDF header detection
+          }.update(params)
+
+        super(options)
+      end
+
+      private
+
+      def parse_initialize # :nodoc:
+        if @options[:force] == true
+          @data.skip_until(/%PDF-/).nil?
+          @data.pos = @data.pos - 5
+        end
 
-    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.
+        pdf = PDF.new(self)
 
-    You should have received a copy of the GNU Lesser General Public License
-    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+        info "...Reading header..."
+        begin
+          pdf.header = PDF::Header.parse(@data)
+          @options[:callback].call(pdf.header)
+        rescue InvalidHeaderError
+          raise unless @options[:ignore_errors]
+          warn "PDF header is invalid, ignoring..."
+        end
 
-=end
+        pdf
+      end
 
-require 'origami/parser'
+      def parse_finalize(pdf) # :nodoc:
+        cast_trailer_objects(pdf)
 
-module Origami
+        warn "This file has been linearized." if pdf.linearized?
+
+        propagate_types(pdf) if Origami::OPTIONS[:enable_type_propagation]
+
+        #
+        # Decrypt encrypted file contents
+        #
+        if pdf.encrypted?
+          warn "This document contains encrypted data!"
 
-    class PDF
-        class Parser < Origami::Parser
-            def initialize(params = {})
-                options =
-                {
-                    decrypt: true,                # Attempt to decrypt to document if encrypted (recommended).
-                    password: '',                 # Default password being tried when opening a protected document.
-                    prompt_password: lambda do    # Callback procedure to prompt password when document is encrypted.
-                        require 'io/console'
-                        STDERR.print "Password: "
-                        STDIN.noecho(&:gets).chomp
-                    end,
-                    force: false                  # Force PDF header detection
-                }.update(params)
-
-                super(options)
-            end
-
-            private
-
-            def parse_initialize #:nodoc:
-                if @options[:force] == true
-                    @data.skip_until(/%PDF-/).nil?
-                    @data.pos = @data.pos - 5
-                end
-
-                pdf = PDF.new(self)
-
-                info "...Reading header..."
-                begin
-                    pdf.header = PDF::Header.parse(@data)
-                    @options[:callback].call(pdf.header)
-                rescue InvalidHeaderError
-                    raise unless @options[:ignore_errors]
-                    warn "PDF header is invalid, ignoring..."
-                end
-
-                pdf
-            end
-
-            def parse_finalize(pdf) #:nodoc:
-                cast_trailer_objects(pdf)
-
-                warn "This file has been linearized." if pdf.linearized?
-
-                propagate_types(pdf) if Origami::OPTIONS[:enable_type_propagation]
-
-                #
-                # Decrypt encrypted file contents
-                #
-                if pdf.encrypted?
-                    warn "This document contains encrypted data!"
-
-                    decrypt_document(pdf) if @options[:decrypt]
-                end
-
-                warn "This document has been signed!" if pdf.signed?
-
-                pdf
-            end
-
-            def cast_trailer_objects(pdf) #:nodoc:
-                trailer = pdf.trailer
-
-                if trailer[:Root].is_a?(Reference)
-                    pdf.cast_object(trailer[:Root], Catalog)
-                end
-
-                if trailer[:Info].is_a?(Reference)
-                    pdf.cast_object(trailer[:Info], Metadata)
-                end
-
-                if trailer[:Encrypt].is_a?(Reference)
-                    pdf.cast_object(trailer[:Encrypt], Encryption::Standard::Dictionary)
-                end
-            end
-
-            def decrypt_document(pdf) #:nodoc:
-                passwd = @options[:password]
-                begin
-                    pdf.decrypt(passwd)
-                rescue EncryptionInvalidPasswordError
-                    if passwd.empty?
-                        passwd = @options[:prompt_password].call
-                        retry unless passwd.empty?
-                    end
-
-                    raise
-                end
-            end
+          decrypt_document(pdf) if @options[:decrypt]
         end
-    end
 
+        warn "This document has been signed!" if pdf.signed?
+
+        pdf
+      end
+
+      def cast_trailer_objects(pdf) # :nodoc:
+        trailer = pdf.trailer
+
+        if trailer[:Root].is_a?(Reference)
+          pdf.cast_object(trailer[:Root], Catalog)
+        end
+
+        if trailer[:Info].is_a?(Reference)
+          pdf.cast_object(trailer[:Info], Metadata)
+        end
+
+        if trailer[:Encrypt].is_a?(Reference)
+          pdf.cast_object(trailer[:Encrypt], Encryption::Standard::Dictionary)
+        end
+      end
+
+      def decrypt_document(pdf) # :nodoc:
+        passwd = @options[:password]
+        begin
+          pdf.decrypt(passwd)
+        rescue EncryptionInvalidPasswordError
+          if passwd.empty?
+            passwd = @options[:prompt_password].call
+            retry unless passwd.empty?
+          end
+
+          raise
+        end
+      end
+    end
+  end
 end

data/lib/origami/parsers/ppklite.rb

@@ -1,57 +1,55 @@
-=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 'origami/parser'
 
 module Origami
+  class PPKLite
+    class Parser < Origami::Parser
+      def parse(stream) # :nodoc:
+        super
+
+        address_book = PPKLite.new(self)
+        address_book.header = PPKLite::Header.parse(@data)
+        @options[:callback].call(address_book.header)
+
+        loop do
+          break if (object = parse_object).nil?
+          address_book.insert(object)
+        end
 
-    class PPKLite
-
-        class Parser < Origami::Parser
-            def parse(stream) #:nodoc:
-                super
-
-                address_book = PPKLite.new(self)
-                address_book.header = PPKLite::Header.parse(@data)
-                @options[:callback].call(address_book.header)
-
-                loop do
-                    break if (object = parse_object).nil?
-                    address_book.insert(object)
-                end
-
-                address_book.revisions.first.xreftable = parse_xreftable
-                address_book.revisions.first.trailer = parse_trailer
-
-                if Origami::OPTIONS[:enable_type_propagation]
-                    trailer = address_book.revisions.first.trailer
+        address_book.revisions.first.xreftable = parse_xreftable
+        address_book.revisions.first.trailer = parse_trailer
 
-                    if trailer[:Root].is_a?(Reference)
-                        address_book.cast_object(trailer[:Root], PPKLite::Catalog)
-                    end
+        if Origami::OPTIONS[:enable_type_propagation]
+          trailer = address_book.revisions.first.trailer
 
-                    propagate_types(address_book)
-                end
+          if trailer[:Root].is_a?(Reference)
+            address_book.cast_object(trailer[:Root], PPKLite::Catalog)
+          end
 
-                address_book
-            end
+          propagate_types(address_book)
         end
+
+        address_book
+      end
     end
+  end
 end