msgpack 1.6.0 → 1.7.2

data/doclib/msgpack/unpacker.rb

@@ -1,183 +0,0 @@
-module MessagePack
-
-  #
-  # MessagePack::Unpacker is a class to deserialize objects.
-  #
-  class Unpacker
-    #
-    # Creates a MessagePack::Unpacker instance.
-    #
-    # @overload initialize(options={})
-    #   @param options [Hash]
-    #
-    # @overload initialize(io, options={})
-    #   @param io [IO]
-    #   @param options [Hash]
-    #   This unpacker reads data from the _io_ to fill the internal buffer.
-    #   _io_ must respond to readpartial(length [,string]) or read(length [,string]) method.
-    #
-    # Supported options:
-    #
-    # * *:symbolize_keys* deserialize keys of Hash objects as Symbol instead of String
-    # * *:allow_unknown_ext* allow to deserialize ext type object with unknown type id as ExtensionValue instance. Otherwise (by default), unpacker throws UnknownExtTypeError.
-    #
-    # See also Buffer#initialize for other options.
-    #
-    def initialize(*args)
-    end
-
-    #
-    # Register a new ext type to deserialize it. This method should be called with
-    # Class and its class method name, or block, which returns a instance object.
-    #
-    # @overload register_type(type, &block)
-    #   @param type [Fixnum] type id (0-127) user defined type id for specified deserializer block
-    #   @yieldparam data [String] bytes(ASCII-8BIT String) represents serialized object, to be deserialized
-    #
-    # @overload register_type(type, klass, class_method_name)
-    #   @param type [Fixnum] type id (0-127) user defined type id for specified Class
-    #   @param klass [Class] Class to be serialized with specified type id
-    #   @param class_method_name [Symbol] class method which returns an instance object
-    #
-    # @return nil
-    #
-    def register_type(type, klass, method_name, &block)
-    end
-
-    #
-    # Returns a list of registered types, ordered by type id.
-    # Each element is a Hash object includes keys :type, :class and :unpacker.
-    #
-    # @return Array
-    #
-    def registered_types
-    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
-    # @return true or false
-    #
-    def type_registered?(klass_or_type)
-    end
-
-    #
-    # Internal buffer
-    #
-    # @return [MessagePack::Buffer]
-    #
-    attr_reader :buffer
-
-    #
-    # Deserializes an object from the io or internal buffer and returns it.
-    #
-    # This method reads data from io into the internal buffer and deserializes an object
-    # from the buffer. It repeats reading data from the io until enough data is available
-    # to deserialize at least one object. After deserializing one object, unused data is
-    # left in the internal buffer.
-    #
-    # 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.
-    #
-    # @return [Object] deserialized object
-    #
-    def read
-    end
-
-    alias unpack read
-
-    #
-    # Deserializes an object and ignores it. This method is faster than _read_.
-    #
-    # This method could raise the same errors with _read_.
-    #
-    # @return nil
-    #
-    def skip
-    end
-
-    #
-    # Deserializes a nil value if it exists and returns _true_.
-    # Otherwise, if a byte exists but the byte doesn't represent nil value,
-    # returns _false_.
-    #
-    # If there're not enough data, this method raises EOFError.
-    #
-    # @return [Boolean]
-    #
-    def skip_nil
-    end
-
-    #
-    # Read a header of an array and returns its size.
-    # It converts a serialized array into a stream of elements.
-    #
-    # If the serialized object is not an array, it raises MessagePack::UnexpectedTypeError.
-    # If there're not enough data, this method raises EOFError.
-    #
-    # @return [Integer] size of the array
-    #
-    def read_array_header
-    end
-
-    #
-    # Reads a header of an map and returns its size.
-    # It converts a serialized map into a stream of key-value pairs.
-    #
-    # If the serialized object is not a map, it raises MessagePack::UnexpectedTypeError.
-    # If there're not enough data, this method raises EOFError.
-    #
-    # @return [Integer] size of the map
-    #
-    def read_map_header
-    end
-
-    #
-    # Appends data into the internal buffer.
-    # This method is equivalent to unpacker.buffer.append(data).
-    #
-    # @param data [String]
-    # @return [Unpacker] self
-    #
-    def feed(data)
-    end
-
-    #
-    # Repeats to deserialize objects.
-    #
-    # It repeats until the io or internal buffer does not include any complete objects.
-    #
-    # If an IO is set, it repeats to read data from the IO when the buffer
-    # becomes empty until the IO raises EOFError.
-    #
-    # This method could raise same errors with _read_ excepting EOFError.
-    #
-    # @yieldparam object [Object] deserialized object
-    # @return nil
-    #
-    def each(&block)
-    end
-
-    #
-    # Appends data into the internal buffer and repeats to deserialize objects.
-    # This method is equivalent to unpacker.feed(data) && unpacker.each { ... }.
-    #
-    # @param data [String]
-    # @yieldparam object [Object] deserialized object
-    # @return nil
-    #
-    def feed_each(data, &block)
-    end
-
-    #
-    # Clears the internal buffer and resets deserialization state of the unpacker.
-    #
-    # @return nil
-    #
-    def reset
-    end
-  end
-
-end

data/doclib/msgpack.rb

@@ -1,87 +0,0 @@
-
-module MessagePack
-  #
-  # Serializes an object into an IO or String.
-  #
-  # @overload dump(obj, options={})
-  #   @param obj [Object] object to be serialized
-  #   @param options [Hash]
-  #   @return [String] serialized data
-  #
-  # @overload dump(obj, io, options={})
-  #   @param obj [Object] object to be serialized
-  #   @param io [IO]
-  #   @param options [Hash]
-  #   @return [nil]
-  #
-  # See Packer#initialize for supported options.
-  #
-  def self.dump(obj)
-  end
-
-  #
-  # Serializes an object into an IO or String. Alias of dump.
-  #
-  # @overload pack(obj, options={})
-  #   @param obj [Object] object to be serialized
-  #   @param options [Hash]
-  #   @return [String] serialized data
-  #
-  # @overload pack(obj, io, options={})
-  #   @param obj [Object] object to be serialized
-  #   @param io [IO]
-  #   @param options [Hash]
-  #   @return [nil]
-  #
-  # See Packer#initialize for supported options.
-  #
-  def self.pack(obj)
-  end
-
-  #
-  # Deserializes an object from an IO or String.
-  #
-  # @overload load(string, options={})
-  #   @param string [String] data to deserialize
-  #   @param options [Hash]
-  #
-  # @overload load(io, options={})
-  #   @param io [IO]
-  #   @param options [Hash]
-  #
-  # @return [Object] deserialized object
-  #
-  # See Unpacker#initialize for supported options.
-  #
-  def self.load(src, options={})
-  end
-
-  #
-  # Deserializes an object from an IO or String. Alias of load.
-  #
-  # @overload unpack(string, options={})
-  #   @param string [String] data to deserialize
-  #   @param options [Hash]
-  #
-  # @overload unpack(io, options={})
-  #   @param io [IO]
-  #   @param options [Hash]
-  #
-  # @return [Object] deserialized object
-  #
-  # See Unpacker#initialize for supported options.
-  #
-  def self.unpack(src, options={})
-  end
-
-  #
-  # An instance of Factory class. DefaultFactory is also used
-  # by global pack/unpack methods such as MessagePack.dump/load,
-  # Hash#to_msgpack, and other to_msgpack methods.
-  #
-  # Calling DefaultFactory.register_type lets you add an extension
-  # type globally.
-  #
-  DefaultFactory = Factory.new
-end
-

data/msgpack.org.md

@@ -1,46 +0,0 @@
-# MessagePack for Ruby
-
-```
-require 'msgpack'
-msg = [1,2,3].to_msgpack  #=> "\x93\x01\x02\x03"
-MessagePack.unpack(msg)   #=> [1,2,3]
-```
-
-## Install
-
-```
-gem install msgpack
-```
-
-## Use cases
-
-* Create REST API returing MessagePack using Rails + [RABL](https://github.com/nesquena/rabl)
-* Store objects efficiently in memcached or Redis
-* Upload data in efficient format from mobile devices. See also MessagePack for [Objective-C](https://github.com/msgpack/msgpack-objectivec) and [Java](https://github.com/msgpack/msgpack-java)
-
-## Links
-
-* [Github](https://github.com/msgpack/msgpack-ruby)
-* [API document](http://ruby.msgpack.org/)
-
-## Streaming API
-
-```
-# serialize a 2-element array [e1, e2]
-pk = MessagePack::Packer.new(io)
-pk.write_array_header(2).write(e1).write(e2).flush
-```
-
-```
-# deserialize objects from an IO
-u = MessagePack::Unpacker.new(io)
-u.each { |obj| ... }
-```
-
-```
-# event-driven deserialization
-def on_read(data)
-  @u ||= MessagePack::Unpacker.new
-  @u.feed_each(data) { |obj| ... }
-end
-```

data/spec/bigint_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-describe MessagePack::Bigint do
-  it 'serialize and deserialize arbitrary sized integer' do
-    [
-      1,
-      -1,
-      120938120391283122132313,
-      -21903120391203912391023920332103,
-      210290021321301203912933021323,
-    ].each do |int|
-      expect(MessagePack::Bigint.from_msgpack_ext(MessagePack::Bigint.to_msgpack_ext(int))).to be == int
-    end
-  end
-
-  it 'has a stable format' do
-    {
-      120938120391283122132313 => "\x00\x9F\xF4UY\x11\x92\x9A?\x00\x00\x19\x9C".b,
-      -21903120391203912391023920332103 => "\x01/\xB2\xBDG\xBD\xDE\xAA\xEBt\xCC\x8A\xC1\x00\x00\x01\x14".b,
-      210290021321301203912933021323 => "\x00\xC4\xD8\x96\x8Bm\xCB\xC7\x03\xA7{\xD4\"\x00\x00\x00\x02".b,
-    }.each do |int, payload|
-      expect(MessagePack::Bigint.to_msgpack_ext(int)).to be == payload
-      expect(MessagePack::Bigint.from_msgpack_ext(payload)).to be == int
-    end
-  end
-end

data/spec/cases.json

@@ -1 +0,0 @@
-[false,true,null,0,0,0,0,0,0,0,0,0,-1,-1,-1,-1,-1,127,127,255,65535,4294967295,-32,-32,-128,-32768,-2147483648,0.0,-0.0,1.0,-1.0,"a","a","a","","","",[0],[0],[0],[],[],[],{},{},{},{"a":97},{"a":97},{"a":97},[[]],[["a"]]]

data/spec/cases_spec.rb

@@ -1,39 +0,0 @@
-require 'spec_helper'
-require 'json'
-
-describe MessagePack do
-  here = File.dirname(__FILE__)
-  CASES         = File.read("#{here}/cases.msg")
-  CASES_JSON    = File.read("#{here}/cases.json")
-  CASES_COMPACT = File.read("#{here}/cases_compact.msg")
-
-  it 'compare with json' do
-    ms = []
-    MessagePack::Unpacker.new.feed_each(CASES) {|m|
-      ms << m
-    }
-
-    js = JSON.load(CASES_JSON)
-
-    ms.zip(js) {|m,j|
-      m.should == j
-    }
-  end
-
-  it 'compare with compat' do
-    ms = []
-    MessagePack::Unpacker.new.feed_each(CASES) {|m|
-      ms << m
-    }
-
-    cs = []
-    MessagePack::Unpacker.new.feed_each(CASES_COMPACT) {|c|
-      cs << c
-    }
-
-    ms.zip(cs) {|m,c|
-      m.should == c
-    }
-  end
-end
-

data/spec/cruby/buffer_io_spec.rb

@@ -1,255 +0,0 @@
-require 'spec_helper'
-require 'random_compat'
-
-require 'stringio'
-if defined?(Encoding)
-  Encoding.default_external = 'ASCII-8BIT'
-end
-
-describe Buffer do
-  r = Random.new
-  random_seed = r.seed
-  puts "buffer_io random seed: 0x#{random_seed.to_s(16)}"
-
-  let :source do
-    ''
-  end
-
-  def set_source(s)
-    source.replace(s)
-  end
-
-  let :io do
-    StringIO.new(source.dup)
-  end
-
-  let :buffer do
-    Buffer.new(io)
-  end
-
-  it 'io returns internal io' do
-    buffer.io.should == io
-  end
-
-  it 'close closes internal io' do
-    expect(io).to receive(:close)
-    buffer.close
-  end
-
-  it 'short feed and read all' do
-    set_source 'aa'
-    buffer.read.should == 'aa'
-  end
-
-  it 'short feed and read short' do
-    set_source 'aa'
-    buffer.read(1).should == 'a'
-    buffer.read(1).should == 'a'
-    buffer.read(1).should == nil
-  end
-
-  it 'long feed and read all' do
-    set_source ' '*(1024*1024)
-    s = buffer.read
-    s.size.should == source.size
-    s.should == source
-  end
-
-  it 'long feed and read mixed' do
-    set_source ' '*(1024*1024)
-    buffer.read(10).should == source.slice!(0, 10)
-    buffer.read(10).should == source.slice!(0, 10)
-    buffer.read(10).should == source.slice!(0, 10)
-    s = buffer.read
-    s.size.should == source.size
-    s.should == source
-  end
-
-  it 'eof' do
-    set_source ''
-    buffer.read.should == ''
-  end
-
-  it 'eof 2' do
-    set_source 'a'
-    buffer.read.should == 'a'
-    buffer.read.should == ''
-  end
-
-  it 'write short once and flush' do
-    buffer.write('aa')
-    buffer.flush
-    io.string.should == 'aa'
-  end
-
-  it 'write short twice and flush' do
-    buffer.write('a')
-    buffer.write('a')
-    buffer.flush
-    io.string.should == 'aa'
-  end
-
-  it 'write long once and flush' do
-    s = ' '*(1024*1024)
-    buffer.write s
-    buffer.flush
-    io.string.size.should == s.size
-    io.string.should == s
-  end
-
-  it 'write short multi and flush' do
-    s = ' '*(1024*1024)
-    1024.times {
-      buffer.write ' '*1024
-    }
-    buffer.flush
-    io.string.size.should == s.size
-    io.string.should == s
-  end
-
-  it 'random read' do
-    r = Random.new(random_seed)
-
-    50.times {
-      fragments = []
-
-      r.rand(4).times do
-        n = r.rand(1024*1400)
-        s = r.bytes(n)
-        fragments << s
-      end
-
-      io = StringIO.new(fragments.join)
-      b = Buffer.new(io)
-
-      fragments.each {|s|
-        x = b.read(s.size)
-        x.size.should == s.size
-        x.should == s
-      }
-      b.empty?.should == true
-      b.read.should == ''
-    }
-  end
-
-  it 'random read_all' do
-    r = Random.new(random_seed)
-
-    50.times {
-      fragments = []
-      r.bytes(0)
-
-      r.rand(4).times do
-        n = r.rand(1024*1400)
-        s = r.bytes(n)
-        fragments << s
-      end
-
-      io = StringIO.new(fragments.join)
-      b = Buffer.new(io)
-
-      fragments.each {|s|
-        x = b.read_all(s.size)
-        x.size.should == s.size
-        x.should == s
-      }
-      b.empty?.should == true
-      lambda {
-        b.read_all(1)
-      }.should raise_error(EOFError)
-    }
-  end
-
-  it 'random skip' do
-    r = Random.new(random_seed)
-
-    50.times {
-      fragments = []
-
-      r.rand(4).times do
-        n = r.rand(1024*1400)
-        s = r.bytes(n)
-        fragments << s
-      end
-
-      io = StringIO.new(fragments.join)
-      b = Buffer.new(io)
-
-      fragments.each {|s|
-        b.skip(s.size).should == s.size
-      }
-      b.empty?.should == true
-      b.skip(1).should == 0
-    }
-  end
-
-  it 'random skip_all' do
-    r = Random.new(random_seed)
-
-    50.times {
-      fragments = []
-
-      r.rand(4).times do
-        n = r.rand(1024*1400)
-        s = r.bytes(n)
-        fragments << s
-      end
-
-      io = StringIO.new(fragments.join)
-      b = Buffer.new(io)
-
-      fragments.each {|s|
-        lambda {
-          b.skip_all(s.size)
-        }.should_not raise_error
-      }
-      b.empty?.should == true
-      lambda {
-        b.skip_all(1)
-      }.should raise_error(EOFError)
-    }
-  end
-
-  it 'random write and flush' do
-    r = Random.new(random_seed)
-
-    50.times {
-      s = r.bytes(0)
-      io = StringIO.new
-      b = Buffer.new(io)
-
-      r.rand(4).times do
-        n = r.rand(1024*1400)
-        x = r.bytes(n)
-        s << x
-        b.write(x)
-      end
-
-      (io.string.size + b.size).should == s.size
-
-      b.flush
-
-      io.string.size.should == s.size
-      io.string.should == s
-    }
-  end
-
-  it 'random write and clear' do
-    r = Random.new(random_seed)
-    b = Buffer.new
-
-    50.times {
-      s = r.bytes(0)
-
-      r.rand(4).times do
-        n = r.rand(1024*1400)
-        x = r.bytes(n)
-        s << x
-        b.write(x)
-      end
-
-      b.size.should == s.size
-      b.clear
-    }
-  end
-end

data/spec/cruby/buffer_packer.rb

@@ -1,29 +0,0 @@
-# encoding: ascii-8bit
-require 'spec_helper'
-
-require 'stringio'
-if defined?(Encoding)
-  Encoding.default_external = 'ASCII-8BIT'
-end
-
-describe Packer do
-  let :packer do
-    Packer.new
-  end
-
-  it 'initialize' do
-    Packer.new
-    Packer.new(nil)
-    Packer.new(StringIO.new)
-    Packer.new({})
-    Packer.new(StringIO.new, {})
-  end
-
-  it 'buffer' do
-    o1 = packer.buffer.object_id
-    packer.buffer << 'frsyuki'
-    packer.buffer.to_s.should == 'frsyuki'
-    packer.buffer.object_id.should == o1
-  end
-end
-