msgpack 1.5.6 → 1.8.0

data/bench/bench.rb

@@ -1,78 +0,0 @@
-# % bundle install
-# % bundle exec ruby bench/bench.rb
-
-require 'msgpack'
-
-require 'benchmark/ips'
-
-object_plain = {
-  'message' => '127.0.0.1 - - [10/Oct/2000:13:55:36 -0700] "GET /apache_pb.gif HTTP/1.0" 200 2326 "http://www.example.com/start.html" "Mozilla/4.08 [en] (Win98; I ;Nav)"'
-}
-
-data_plain = MessagePack.pack(object_plain)
-
-object_structured = {
-  'remote_host' => '127.0.0.1',
-  'remote_user' => '-',
-  'date' => '10/Oct/2000:13:55:36 -0700',
-  'request' => 'GET /apache_pb.gif HTTP/1.0',
-  'method' => 'GET',
-  'path' => '/apache_pb.gif',
-  'protocol' => 'HTTP/1.0',
-  'status' => 200,
-  'bytes' => 2326,
-  'referer' => 'http://www.example.com/start.html',
-  'agent' => 'Mozilla/4.08 [en] (Win98; I ;Nav)',
-}
-
-data_structured = MessagePack.pack(object_structured)
-
-class Extended
-  def to_msgpack_ext
-    MessagePack.pack({})
-  end
-
-  def self.from_msgpack_ext(data)
-    MessagePack.unpack(data)
-    Extended.new
-  end
-end
-
-object_extended = {
-  'extended' => Extended.new
-}
-
-extended_packer = MessagePack::Packer.new
-extended_packer.register_type(0x00, Extended, :to_msgpack_ext)
-data_extended = extended_packer.pack(object_extended).to_s
-
-Benchmark.ips do |x|
-  x.report('pack-plain') do
-    MessagePack.pack(object_plain)
-  end
-
-  x.report('pack-structured') do
-    MessagePack.pack(object_structured)
-  end
-
-  x.report('pack-extended') do
-    packer = MessagePack::Packer.new
-    packer.register_type(0x00, Extended, :to_msgpack_ext)
-    packer.pack(object_extended).to_s
-  end
-
-  x.report('unpack-plain') do
-    MessagePack.unpack(data_plain)
-  end
-
-  x.report('unpack-structured') do
-    MessagePack.unpack(data_structured)
-  end
-
-  x.report('unpack-extended') do
-    unpacker = MessagePack::Unpacker.new
-    unpacker.register_type(0x00, Extended, :from_msgpack_ext)
-    unpacker.feed data_extended
-    unpacker.read
-  end
-end

data/doclib/msgpack/buffer.rb

@@ -1,193 +0,0 @@
-module MessagePack
-
-  class Buffer
-    #
-    # Creates a MessagePack::Buffer instance.
-    #
-    # @overload initialize(options={})
-    #   @param options [Hash]
-    #
-    # @overload initialize(io, options={})
-    #   @param io [IO]
-    #   @param options [Hash]
-    #   This buffer writes written data into the IO when it is filled.
-    #   This buffer reads data from the IO when it is empty.
-    #
-    # _io_ must respond to readpartial(length, [,string]) or read(string) method and
-    # write(string) or append(string) method.
-    #
-    # Supported options:
-    #
-    # * *:io_buffer_size* buffer size to read data from the internal IO. (default: 32768)
-    # * *:read_reference_threshold* the threshold size to enable zero-copy deserialize optimization. Read strings longer than this threshold will refer the original string instead of copying it. (default: 256) (supported in MRI only)
-    # * *:write_reference_threshold* the threshold size to enable zero-copy serialize optimization. The buffer refers written strings longer than this threshold instead of copying it. (default: 524288) (supported in MRI only)
-    #
-    def initialize(*args)
-    end
-
-    #
-    # Makes the buffer empty
-    #
-    # @return nil
-    #
-    def clear
-    end
-
-    #
-    # Returns byte size of the buffer.
-    #
-    # @return nil
-    #
-    def size
-    end
-
-    #
-    # Returns _true_ if the buffer is empty.
-    # This method is slightly faster than _size_.
-    #
-    # @return [Boolean]
-    #
-    def empty?
-    end
-
-    #
-    # Appends the given data to the buffer.
-    #
-    # @param data [String]
-    # @return [Integer] byte size written
-    #
-    def write(data)
-    end
-
-    #
-    # Appends the given data to the buffer.
-    #
-    # @param data [String]
-    # @return [Buffer] self
-    #
-    def <<(data)
-    end
-
-    #
-    # Consumes _n_ bytes from the head of the buffer and returns consumed data.
-    # If the size of the buffer is less than _n_, it reads all of data in the buffer.
-    #
-    # If _n_ is 0, it does nothing and returns an empty string.
-    # If the optional _buffer_ argument is given, the content of the string will be replaced with the consumed data.
-    #
-    # @overload read
-    #
-    # @overload read(n)
-    #   @param n [Integer] bytes to read
-    #
-    # @overload read(n, buffer)
-    #   @param n [Integer] bytes to read
-    #   @param buffer [String] buffer to read into
-    #
-    # @return [String]
-    #
-    def read(n)
-    end
-
-    #
-    # Consumes _n_ bytes from the head of the buffer and returns consumed data.
-    # If the size of the buffer is less than _n_, it does nothing and raises EOFError.
-    #
-    # If _n_ is 0, it does nothing and returns an empty string.
-    # If the optional _buffer_ argument is given, the content of the string will be replaced with the consumed data.
-    #
-    # @overload read_all
-    #
-    # @overload read_all(n)
-    #   @param n [Integer] bytes to read
-    #
-    # @overload read_all(n, buffer)
-    #   @param n [Integer] bytes to read
-    #   @param buffer [String] buffer to read into
-    #
-    # @return [String]
-    #
-    def read_all(n, buffer=nil)
-    end
-
-    #
-    # Consumes _n_ bytes from the head of the buffer.
-    # If the size of the buffer is less than _n_, it skips all of data in the buffer and returns integer less than _n_.
-    #
-    # If _n_ is 0, it does nothing and returns _0_.
-    #
-    # @param n [Integer] byte size to skip
-    # @return [Integer] byte size actually skipped
-    #
-    def skip(n)
-    end
-
-    #
-    # Consumes _n_ bytes from the head of the buffer.
-    # If the size of the buffer is less than _n_, it does nothing and raises EOFError.
-    # If _n_ is 0, it does nothing.
-    #
-    # @param n [Integer] byte size to skip
-    # @return [Buffer] self
-    #
-    def skip_all(n)
-    end
-
-    #
-    # Returns all data in the buffer as a string.
-    # Destructive update to the returned string does NOT effect the buffer.
-    #
-    # @return [String]
-    #
-    def to_str
-    end
-
-    #
-    # Returns content of the buffer as an array of strings.
-    #
-    # This method is sometimes faster than to_s because the internal
-    # structure of the buffer is a queue of buffer chunks.
-    #
-    # @return [Array] array of strings
-    #
-    def to_a
-    end
-
-    #
-    # Internal io
-    #
-    # @return IO
-    #
-    attr_reader :io
-
-    #
-    # Flushes data in the internal buffer to the internal IO.
-    # If internal IO is not set, it does nothing.
-    #
-    # @return [Buffer] self
-    #
-    def flush
-    end
-
-    #
-    # Closes internal IO if its set.
-    # If internal IO is not set, it does nothing
-    #
-    # @return nil
-    #
-    def close
-    end
-
-    #
-    # Writes all of data in the internal buffer into the given IO.
-    # This method consumes and removes data from the internal buffer.
-    # _io_ must respond to write(data) method.
-    #
-    # @param io [IO]
-    # @return [Integer] byte size of written data
-    #
-    def write_to(io)
-    end
-  end
-
-end

data/doclib/msgpack/core_ext.rb

@@ -1,101 +0,0 @@
-
-class NilClass
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class TrueClass
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class FalseClass
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Fixnum < Integer
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Bignum < Integer
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Float < Numeric
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class String
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Array
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Hash
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Symbol
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-

data/doclib/msgpack/error.rb

@@ -1,19 +0,0 @@
-module MessagePack
-
-  class UnpackError < StandardError
-  end
-
-  class MalformedFormatError < UnpackError
-  end
-
-  class StackError < UnpackError
-  end
-
-  class UnexpectedTypeError < UnpackError
-    include TypeError
-  end
-
-  class UnknownExtTypeError < UnpackError
-    include TypeError
-  end
-end

data/doclib/msgpack/extension_value.rb

@@ -1,9 +0,0 @@
-module MessagePack
-
-  #
-  # MessagePack::ExtensionValue is a struct to represent unknown ext type object.
-  # Its contents are accessed by type and payload (messagepack bytes representation) methods.
-  # And it is extended to add to_msgpack object.
-  #
-  ExtensionValue = Struct.new(:type, :payload)
-end

data/doclib/msgpack/factory.rb

@@ -1,145 +0,0 @@
-module MessagePack
-  #
-  # MessagePack::Factory is a class to generate Packer and Unpacker which has
-  # same set of ext types.
-  #
-  class Factory
-    #
-    # Creates a MessagePack::Factory instance
-    #
-    def initialize
-    end
-
-    #
-    # Creates a MessagePack::Packer instance, which has ext types already registered.
-    # Options are passed to MessagePack::Packer#initialized.
-    #
-    # See also Packer#initialize for options.
-    #
-    def packer(*args)
-    end
-
-    #
-    # Serialize the passed value
-    #
-    # If it could not serialize the object, it raises
-    # NoMethodError: undefined method `to_msgpack' for #<the_object>.
-    #
-    # @param obj [Object] object to serialize
-    # @param options [Hash]
-    # @return [String] serialized object
-    #
-    # See Packer#initialize for supported options.
-    #
-    def dump(obj, options=nil)
-    end
-    alias pack dump
-
-    #
-    # Creates a MessagePack::Unpacker instance, which has ext types already registered.
-    # Options are passed to MessagePack::Unpacker#initialized.
-    #
-    # See also Unpacker#initialize for options.
-    #
-    def unpacker(*args)
-    end
-
-    #
-    # Deserializes an object from the string or io and returns it.
-    #
-    # If there're not enough data to deserialize one object, this method raises EOFError.
-    # If data format is invalid, this method raises MessagePack::MalformedFormatError.
-    # If the object nests too deeply, this method raises MessagePack::StackError.
-    #
-    # @param data [String]
-    # @param options [Hash]
-    # @return [Object] deserialized object
-    #
-    # See Unpacker#initialize for supported options.
-    #
-    def load(data, options=nil)
-    end
-    alias unpack load
-
-    #
-    # Register a type and Class to be registered for packer and/or unpacker.
-    # If options are not specified, factory will use :to_msgpack_ext for packer, and
-    # :from_msgpack_ext for unpacker.
-    #
-    # @param type [Fixnum] type id of registered Class (0-127)
-    # @param klass [Class] Class to be associated with type id
-    # @param options [Hash] specify method name or Proc which are used by packer/unpacker
-    # @return nil
-    #
-    # Supported options:
-    #
-    # * *:packer* specify symbol or proc object for packer
-    # * *:unpacker* specify symbol or proc object for unpacker
-    # * *:optimized_symbols_parsing* specify true to use the optimized symbols parsing (not supported on JRuby now)
-    # * *recursive* specify true to receive the packer or unpacker as argument to generate the extension body manually.
-    #
-    def register_type(type, klass, options={})
-    end
-
-    #
-    # Returns a list of registered types, ordered by type id.
-    #
-    # @param selector [Symbol] specify to list types registered for :packer, :unpacker or :both (default)
-    # @return Array
-    #
-    def registered_types(selector=:both)
-    end
-
-    #
-    # Returns true/false which indicate specified class or type id is registered or not.
-    #
-    # @param klass_or_type [Class or Fixnum] Class or type id (0-127) to be checked
-    # @param selector [Symbol] specify to check for :packer, :unpacker or :both (default)
-    # @return true or false
-    #
-    def type_registered?(klass_or_type, selector=:both)
-    end
-
-    #
-    # Creates a MessagePack::PooledFactory instance of the given size.
-    #
-    # PooledFactory keeps Packer and Unpacker instance in a pool for improved performance.
-    # Note that the size defines how many instances are kept in cache, not the maximum of instances
-    # that can be created. If the pool limit is reached, a new instance is created anyway.
-    #
-    # @param size [Fixnum] specify how many Packer and Unpacker to keep in cache (default 1)
-    # @param options [Hash] Combined options for Packer and Unpacker. See Packer#initialize and Unpacker#initialize
-    #                       for supported options.
-    def pool(size=1, **options)
-    end
-
-    class Pool
-      #
-      # Deserializes an object from the string or io and returns it.
-      #
-      # If there're not enough data to deserialize one object, this method raises EOFError.
-      # If data format is invalid, this method raises MessagePack::MalformedFormatError.
-      # If the object nests too deeply, this method raises MessagePack::StackError.
-      #
-      # @param data [String]
-      # @return [Object] deserialized object
-      #
-      # See Unpacker#initialize for supported options.
-      #
-      def load(data)
-      end
-
-      #
-      # Serialize the passed value
-      #
-      # If it could not serialize the object, it raises
-      # NoMethodError: undefined method `to_msgpack' for #<the_object>.
-      #
-      # @param obj [Object] object to serialize
-      # @return [String] serialized object
-      #
-      def dump(object)
-      end
-    end
-  end
-end