python-pickle 0.1.0

data/lib/python/pickle/instructions/readonly_buffer.rb

@@ -0,0 +1,26 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `READONLY_BUFFER` instruction.
+      #
+      # @note introduced in protocol 5.
+      #
+      class ReadonlyBuffer < Instruction
+
+        #
+        # Initializes the `READONLY_BUFFER` instruction.
+        #
+        def initialize
+          super(:READONLY_BUFFER)
+        end
+
+      end
+
+      # The `READONLY_BUFFER` instruction.
+      READONLY_BUFFER = ReadonlyBuffer.new
+    end
+  end
+end

data/lib/python/pickle/instructions/reduce.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `REDUCE` instruction.
+      #
+      class Reduce < Instruction
+
+        #
+        # Initializes the `REDUCE` instruction.
+        #
+        def initialize
+          super(:REDUCE)
+        end
+
+      end
+
+      # The `REDUCE` instruction.
+      REDUCE = Reduce.new
+    end
+  end
+end

data/lib/python/pickle/instructions/set_item.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `SETITEM` instruction.
+      #
+      class SetItem < Instruction
+
+        #
+        # Initializes the `SETITEM` instruction.
+        #
+        def initialize
+          super(:SETITEM)
+        end
+
+      end
+
+      # The `SETITEM` instruction.
+      SETITEM = SetItem.new
+    end
+  end
+end

data/lib/python/pickle/instructions/set_items.rb

@@ -0,0 +1,26 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `SETITEMS` instruction.
+      #
+      # @note Introduced in protocol 1.
+      #
+      class SetItems < Instruction
+
+        #
+        # Initializes the `SETITEMS` instruction.
+        #
+        def initialize
+          super(:SETITEMS)
+        end
+
+      end
+
+      # The `SETITEMS` instruction.
+      SETITEMS = SetItems.new
+    end
+  end
+end

data/lib/python/pickle/instructions/short_bin_bytes.rb

@@ -0,0 +1,32 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_length_and_value'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents the `SHORT_BINBYTES` instruction.
+      #
+      # @note introduces in protocol 3.
+      #
+      class ShortBinBytes < Instruction
+
+        include HasLengthAndValue
+
+        #
+        # Initializes the `SHORT_BINBYTES` instruction.
+        #
+        # @param [Integer] length
+        #   The length of the `SHORT_BINBYTES` value.
+        #
+        # @param [String] value
+        #   The `SHORT_BINBYTES` instruction's value.
+        #
+        def initialize(length,value)
+          super(:SHORT_BINBYTES,length,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/short_bin_string.rb

@@ -0,0 +1,32 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_length_and_value'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents the `SHORT_BINSTRING` instruction.
+      #
+      # @note introduces in protocol 1.
+      #
+      class ShortBinString < Instruction
+
+        include HasLengthAndValue
+
+        #
+        # Initializes the `SHORT_BINSTRING` instruction.
+        #
+        # @param [Integer] length
+        #   The length of the `SHORT_BINSTRING` value.
+        #
+        # @param [String] value
+        #   The `SHORT_BINSTRING` instruction's value.
+        #
+        def initialize(length,value)
+          super(:SHORT_BINSTRING,length,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/short_bin_unicode.rb

@@ -0,0 +1,32 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_length_and_value'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents the `SHORT_BINUNICODE` instruction.
+      #
+      # @note introduces in protocol 4.
+      #
+      class ShortBinUnicode < Instruction
+
+        include HasLengthAndValue
+
+        #
+        # Initializes the `SHORT_BINUNICODE` instruction.
+        #
+        # @param [Integer] length
+        #   The length of the `SHORT_BINUNICODE` value.
+        #
+        # @param [String] value
+        #   The `SHORT_BINUNICODE` instruction's value.
+        #
+        def initialize(length,value)
+          super(:SHORT_BINUNICODE,length,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/stack_global.rb

@@ -0,0 +1,26 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `STACK_GLOBAL` instruction.
+      #
+      # @note introduced in protocol 4.
+      #
+      class StackGlobal < Instruction
+
+        #
+        # Initializes the `STACK_GLOBAL` instruction.
+        #
+        def initialize
+          super(:STACK_GLOBAL)
+        end
+
+      end
+
+      # The `STACK_GLOBAL` instruction.
+      STACK_GLOBAL = StackGlobal.new
+    end
+  end
+end

data/lib/python/pickle/instructions/stop.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `STOP` instruction.
+      #
+      class Stop < Instruction
+
+        #
+        # Initializes the `STOP` instruction.
+        #
+        def initialize
+          super(:STOP)
+        end
+
+      end
+
+      # The `STOP` instruction.
+      STOP = Stop.new
+    end
+  end
+end

data/lib/python/pickle/instructions/string.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_value'
+
+module Python
+  module Pickle
+    module Instructions
+      class String < Instruction
+
+        include HasValue
+
+        #
+        # Initializes the `STRING` instruction.
+        #
+        # @param [String] value
+        #   The `STRING` instruction's value.
+        #
+        def initialize(value)
+          super(:STRING,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/tuple.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `TUPLE` instruction.
+      #
+      class Tuple < Instruction
+
+        #
+        # Initializes the `TUPLE` instruction.
+        #
+        def initialize
+          super(:TUPLE)
+        end
+
+      end
+
+      # The `TUPLE` instruction.
+      TUPLE = Tuple.new
+    end
+  end
+end

data/lib/python/pickle/instructions/tuple1.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `TUPLE1` instruction.
+      #
+      class Tuple1 < Instruction
+
+        #
+        # Initializes the `TUPLE1` instruction.
+        #
+        def initialize
+          super(:TUPLE1)
+        end
+
+      end
+
+      # The `TUPLE1` instruction.
+      TUPLE1 = Tuple1.new
+    end
+  end
+end

data/lib/python/pickle/instructions/tuple2.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `TUPLE2` instruction.
+      #
+      class Tuple2 < Instruction
+
+        #
+        # Initializes the `TUPLE2` instruction.
+        #
+        def initialize
+          super(:TUPLE2)
+        end
+
+      end
+
+      # The `TUPLE2` instruction.
+      TUPLE2 = Tuple2.new
+    end
+  end
+end

data/lib/python/pickle/instructions/tuple3.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `TUPLE3` instruction.
+      #
+      class Tuple3 < Instruction
+
+        #
+        # Initializes the `TUPLE3` instruction.
+        #
+        def initialize
+          super(:TUPLE3)
+        end
+
+      end
+
+      # The `TUPLE3` instruction.
+      TUPLE3 = Tuple3.new
+    end
+  end
+end

data/lib/python/pickle/protocol.rb

@@ -0,0 +1,56 @@
+module Python
+  module Pickle
+    #
+    # Common base class for all protocol implementations.
+    #
+    class Protocol
+
+      # The Pickle stream to read or write to.
+      #
+      # @return [IO]
+      attr_reader :io
+
+      #
+      # Initializes the protocol.
+      #
+      # @param [IO] io
+      #   The Pickle stream to read or write to.
+      #
+      def initialize(io)
+        @io = io
+      end
+
+      #
+      # Reads all instructions from the Pickle stream.
+      #
+      # @yield [instruction]
+      #   If a block is given, it will be passed each parsed Pickle instruction.
+      #
+      # @yieldparam [Instruction] instruction
+      #   A parsed Pickle instruction from the Pickle stream.
+      #
+      # @return [Array<Instruction>]
+      #   All parsed Pickle instructions from the Pickle stream.
+      #
+      def read
+        return enum_for(__method__).to_a unless block_given?
+
+        until @io.eof?
+          yield read_instruction
+        end
+      end
+
+      #
+      # Reads an instruction from the pickle stream.
+      #
+      # @return [Instruction]
+      #
+      # @abstract
+      #
+      def read_instruction
+        raise(NotImplementedError,"#{self.class}##{__method__} was not implemented")
+      end
+
+    end
+  end
+end