origami 1.2.7 → 2.0.0

data/lib/origami/filters/crypt.rb

@@ -1,47 +1,38 @@
 =begin
 
-= File
-	filters/crypt.rb
-
-= Info
-	This file is part of Origami, PDF manipulation framework for Ruby
-	Copyright (C) 2010	Guillaume Delugré <guillaume AT security-labs DOT org>
-	All right reserved.
-	
-  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/>.
 
 =end
 
 module Origami
 
-  module Filter
+    module Filter
 
-    #
-    # Class representing a Crypt Filter.
-    # TODO.
-    #
-    class Crypt
-      include Filter
+        module Crypt
 
-      class DecodeParms < Dictionary
-        include StandardObject
+            #
+            # Parameters for a Crypt Filter.
+            #
+            class DecodeParms < Dictionary
+                include StandardObject
 
-        field   :Type,      :Type => Name, :Default => :Crypt
-        field   :Name,      :Type => Name, :Default => :Identity
-      end
+                field   :Type,      :Type => Name, :Default => :Crypt
+                field   :Name,      :Type => Name, :Default => :Identity
+            end
+        end
     end
-    
-  end
 end
-

data/lib/origami/filters/dct.rb

@@ -1,61 +1,55 @@
 =begin
 
-= File
-	filters/dct.rb
-
-= Info
-	This file is part of Origami, PDF manipulation framework for Ruby
-	Copyright (C) 2010	Guillaume Delugré <guillaume AT security-labs DOT org>
-	All right reserved.
-	
-  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/>.
 
 =end
 
 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)
-        stream
-      end
-      
-      #
-      # DCTDecode implies that data is a JPEG image container.
-      # Just returns the raw JPEG image as is.
-      #
-      def decode(stream)
-        stream
-      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
 end
 

data/lib/origami/filters/flate.rb

@@ -1,25 +1,20 @@
 =begin
 
-= File
-	filters/flate.rb
-
-= Info
-	This file is part of Origami, PDF manipulation framework for Ruby
-	Copyright (C) 2010	Guillaume Delugré <guillaume AT security-labs DOT org>
-	All right reserved.
-	
-  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/>.
 
 =end
 
@@ -27,82 +22,88 @@ require 'zlib'
 require 'origami/filters/predictors'
 
 module Origami
-  
-  module Filter
-
-    class InvalidFlateDataError < InvalidFilterDataError; end #:nodoc:
-    
-    #
-    # Class representing a Filter used to encode and decode data with zlib/Flate compression algorithm.
-    #
-    class Flate
-      include Filter
-      
-      EOD = 257 #:nodoc:
- 
-      class DecodeParms < Dictionary
-        include StandardObject
-
-        field   :Predictor,         :Type => Integer, :Default => 1
-        field   :Colors,            :Type => Integer, :Default => 1
-        field   :BitsPerComponent,  :Type => Integer, :Default => 8
-        field   :Columns,           :Type => Integer, :Default => 1
-      end
-      
-      #
-      # Create a new Flate Filter.
-      # _parameters_:: A hash of filter options (ignored).
-      #
-      def initialize(parameters = {})
-        super(DecodeParms.new(parameters))
-      end
-      
-      #
-      # Encodes data using zlib/Deflate compression method.
-      # _stream_:: The data to encode.
-      #
-      def encode(stream)
-        if @params.Predictor.is_a?(Integer)
-          colors  = @params.Colors.is_a?(Integer) ? @params.Colors.to_i : 1
-          bpc     = @params.BitsPerComponent.is_a?(Integer) ? @params.BitsPerComponent.to_i : 8
-          columns = @params.Columns.is_a?(Integer) ? @params.Columns.to_i : 1
-
-          stream = Predictor.do_pre_prediction(stream, @params.Predictor.to_i, colors, bpc, columns)
-        end       
-        
-        Zlib::Deflate.deflate(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, uncompressed)
-          end
-        end
 
-        if @params.Predictor.is_a?(Integer)
-          colors  = @params.Colors.is_a?(Integer) ? @params.Colors.to_i : 1
-          bpc     = @params.BitsPerComponent.is_a?(Integer) ? @params.BitsPerComponent.to_i : 8
-          columns = @params.Columns.is_a?(Integer) ? @params.Columns.to_i : 1
-
-          uncompressed = Predictor.do_post_prediction(uncompressed, @params.Predictor.to_i, colors, bpc, columns)
+    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
+
+            EOD = 257 #:nodoc:
+
+            class DecodeParms < Dictionary
+                include StandardObject
+
+                field   :Predictor,         :Type => Integer, :Default => 1
+                field   :Colors,            :Type => Integer, :Default => 1
+                field   :BitsPerComponent,  :Type => Integer, :Default => 8
+                field   :Columns,           :Type => Integer, :Default => 1
+            end
+
+            #
+            # Create a new Flate Filter.
+            # _parameters_:: A hash of filter options (ignored).
+            #
+            def initialize(parameters = {})
+                super(DecodeParms.new(parameters))
+            end
+
+            #
+            # Encodes data using zlib/Deflate compression method.
+            # _stream_:: The data to encode.
+            #
+            def encode(stream)
+                if @params.Predictor.is_a?(Integer)
+                    colors  = @params.Colors.is_a?(Integer) ? @params.Colors.to_i : 1
+                    bpc     = @params.BitsPerComponent.is_a?(Integer) ? @params.BitsPerComponent.to_i : 8
+                    columns = @params.Columns.is_a?(Integer) ? @params.Columns.to_i : 1
+
+                    stream = Predictor.do_pre_prediction(stream, 
+                                                         predictor: @params.Predictor.to_i, 
+                                                         colors: colors, 
+                                                         bpc: bpc, 
+                                                         columns: columns)
+                end
+
+                Zlib::Deflate.deflate(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
+
+                if @params.Predictor.is_a?(Integer)
+                    colors  = @params.Colors.is_a?(Integer) ? @params.Colors.to_i : 1
+                    bpc     = @params.BitsPerComponent.is_a?(Integer) ? @params.BitsPerComponent.to_i : 8
+                    columns = @params.Columns.is_a?(Integer) ? @params.Columns.to_i : 1
+
+                    uncompressed = Predictor.do_post_prediction(uncompressed, 
+                                                                predictor: @params.Predictor.to_i, 
+                                                                colors: colors, 
+                                                                bpc: bpc, 
+                                                                columns: columns)
+                end
+
+                uncompressed
+            end
         end
-
-        uncompressed
-      end
+        Fl = Flate
 
     end
-    Fl = Flate
-  end
 end
-

data/lib/origami/filters/jbig2.rb

@@ -1,63 +1,57 @@
 =begin
 
-= File
-	filters/jbig2.rb
-
-= Info
-	This file is part of Origami, PDF manipulation framework for Ruby
-	Copyright (C) 2010	Guillaume Delugré <guillaume AT security-labs DOT org>
-	All right reserved.
-	
-  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/>.
 
 =end
 
 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, "#{self.class} is not yet supported"
-      end
-      
-      #
-      # Not supported.
-      #
-      def decode(stream)
-        raise NotImplementedError, "#{self.class} is not yet supported"
-      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
 end
-