origami-docspring 2.2.0 → 2.3.0

data/lib/origami/filters/crypt.rb

@@ -1,38 +1,35 @@
-=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
-
-    module Filter
-
-        module Crypt
-
-            #
-            # Parameters for a Crypt Filter.
-            #
-            class DecodeParms < Dictionary
-                include StandardObject
-
-                field   :Type,      :Type => Name, :Default => :CryptFilterDecodeParms
-                field   :Name,      :Type => Name, :Default => :Identity
-            end
-        end
+  module Filter
+    module Crypt
+      #
+      # Parameters for a Crypt Filter.
+      #
+      class DecodeParms < Dictionary
+        include StandardObject
+
+        field :Type, Type: Name, Default: :CryptFilterDecodeParms
+        field :Name, Type: Name, Default: :Identity
+      end
     end
+  end
 end

data/lib/origami/filters/dct.rb

@@ -1,54 +1,51 @@
-=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
-
-    module Filter
-
-        #
-        # Class representing a Filter used to encode and decode data with DCT (JPEG) compression algorithm.
-        #
-        class DCT
-            include Filter
-
-            class DecodeParms < Dictionary
-                include StandardObject
-
-                field   :ColorTransform,    :Type => Integer
-            end
-
-            def initialize(parameters = {})
-                super(DecodeParms.new(parameters))
-            end
-
-            def encode(stream)
-                raise NotImplementedError.new("DCT filter is not supported", input_data: stream)
-            end
-
-            #
-            # DCTDecode implies that data is a JPEG image container.
-            #
-            def decode(stream)
-                raise NotImplementedError.new("DCT filter is not supported", input_data: stream)
-            end
-        end
-
+  module Filter
+    #
+    # Class representing a Filter used to encode and decode data with DCT (JPEG) compression algorithm.
+    #
+    class DCT
+      include Filter
+
+      class DecodeParms < Dictionary
+        include StandardObject
+
+        field :ColorTransform, Type: Integer
+      end
+
+      def initialize(parameters = {})
+        super(DecodeParms.new(parameters))
+      end
+
+      def encode(stream)
+        raise NotImplementedError.new("DCT filter is not supported", input_data: stream)
+      end
+
+      #
+      # DCTDecode implies that data is a JPEG image container.
+      #
+      def decode(stream)
+        raise NotImplementedError.new("DCT filter is not supported", input_data: stream)
+      end
     end
+  end
 end

data/lib/origami/filters/flate.rb

@@ -1,69 +1,66 @@
-=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 'zlib'
 require 'origami/filters/predictors'
 
 module Origami
-
-    module Filter
-
-        class InvalidFlateDataError < DecodeError; end #:nodoc:
-
-        #
-        # Class representing a Filter used to encode and decode data with zlib/Flate compression algorithm.
-        #
-        class Flate
-            include Filter
-            include Predictor
-
-            EOD = 257 #:nodoc:
-
-            #
-            # Encodes data using zlib/Deflate compression method.
-            # _stream_:: The data to encode.
-            #
-            def encode(stream)
-                Zlib::Deflate.deflate(pre_prediction(stream), Zlib::BEST_COMPRESSION)
-            end
-
-            #
-            # Decodes data using zlib/Inflate decompression method.
-            # _stream_:: The data to decode.
-            #
-            def decode(stream)
-                zlib_stream = Zlib::Inflate.new
-                begin
-                    uncompressed = zlib_stream.inflate(stream)
-                rescue Zlib::DataError => zlib_except
-                    uncompressed = zlib_stream.flush_next_out
-
-                    unless Origami::OPTIONS[:ignore_zlib_errors]
-                        raise InvalidFlateDataError.new(zlib_except.message, input_data: stream, decoded_data: uncompressed)
-                    end
-                end
-
-                post_prediction(uncompressed)
-            end
+  module Filter
+    class InvalidFlateDataError < DecodeError; end # :nodoc:
+
+    #
+    # Class representing a Filter used to encode and decode data with zlib/Flate compression algorithm.
+    #
+    class Flate
+      include Filter
+      include Predictor
+
+      EOD = 257 # :nodoc:
+
+      #
+      # Encodes data using zlib/Deflate compression method.
+      # _stream_:: The data to encode.
+      #
+      def encode(stream)
+        Zlib::Deflate.deflate(pre_prediction(stream), Zlib::BEST_COMPRESSION)
+      end
+
+      #
+      # Decodes data using zlib/Inflate decompression method.
+      # _stream_:: The data to decode.
+      #
+      def decode(stream)
+        zlib_stream = Zlib::Inflate.new
+        begin
+          uncompressed = zlib_stream.inflate(stream)
+        rescue Zlib::DataError => zlib_except
+          uncompressed = zlib_stream.flush_next_out
+
+          unless Origami::OPTIONS[:ignore_zlib_errors]
+            raise InvalidFlateDataError.new(zlib_except.message, input_data: stream, decoded_data: uncompressed)
+          end
         end
-        Fl = Flate
 
+        post_prediction(uncompressed)
+      end
     end
+    Fl = Flate
+  end
 end

data/lib/origami/filters/jbig2.rb

@@ -1,57 +1,54 @@
-=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
-
-    module Filter
-
-        #
-        # Class representing a Filter used to encode and decode data with JBIG2 compression algorithm.
-        #
-        class JBIG2
-            include Filter
-
-            class DecodeParms < Dictionary
-                include StandardObject
-
-                field   :JBIG2Globals,    :Type => Stream
-            end
-
-            def initialize(parameters = {})
-                super(DecodeParms.new(parameters))
-            end
-
-            #
-            # Not supported.
-            #
-            def encode(stream)
-                raise NotImplementedError.new("#{self.class} is not yet supported", input_data: stream)
-            end
-
-            #
-            # Not supported.
-            #
-            def decode(stream)
-                raise NotImplementedError.new("#{self.class} is not yet supported", input_data: stream)
-            end
-        end
-
+  module Filter
+    #
+    # Class representing a Filter used to encode and decode data with JBIG2 compression algorithm.
+    #
+    class JBIG2
+      include Filter
+
+      class DecodeParms < Dictionary
+        include StandardObject
+
+        field :JBIG2Globals, Type: Stream
+      end
+
+      def initialize(parameters = {})
+        super(DecodeParms.new(parameters))
+      end
+
+      #
+      # Not supported.
+      #
+      def encode(stream)
+        raise NotImplementedError.new("#{self.class} is not yet supported", input_data: stream)
+      end
+
+      #
+      # Not supported.
+      #
+      def decode(stream)
+        raise NotImplementedError.new("#{self.class} is not yet supported", input_data: stream)
+      end
     end
+  end
 end

data/lib/origami/filters/jpx.rb

@@ -1,47 +1,44 @@
-=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
-
-    module Filter
-
-        #
-        # Class representing a Filter used to encode and decode data with JPX compression algorithm.
-        #
-        class JPX
-            include Filter
-
-            #
-            # Not supported.
-            #
-            def encode(stream)
-                raise NotImplementedError.new("#{self.class} is not yet supported", input_data: stream)
-            end
-
-            #
-            # Not supported.
-            #
-            def decode(stream)
-                raise NotImplementedError.new("#{self.class} is not yet supported", input_data: stream)
-            end
-        end
-
+  module Filter
+    #
+    # Class representing a Filter used to encode and decode data with JPX compression algorithm.
+    #
+    class JPX
+      include Filter
+
+      #
+      # Not supported.
+      #
+      def encode(stream)
+        raise NotImplementedError.new("#{self.class} is not yet supported", input_data: stream)
+      end
+
+      #
+      # Not supported.
+      #
+      def decode(stream)
+        raise NotImplementedError.new("#{self.class} is not yet supported", input_data: stream)
+      end
     end
+  end
 end