msgpack 1.3.3 → 1.7.2

data/.travis.yml

@@ -1,43 +0,0 @@
-language: ruby
-
-sudo: false
-
-branches:
-  only:
-    - master
-
-gemfile:
-  - Gemfile
-
-before_install:
-  # This is only for Ruby 2.5.0, Bundler 1.16.1 and rubygems 2.7.3
-  # See https://github.com/travis-ci/travis-ci/issues/8969
-  - "[ \"x2.7.3\" = \"x\"$(gem --version) ] && gem update --system --no-document || echo \"no need to update rubygem\""
-
-# http://rubies.travis-ci.org/
-matrix:
-  include:
-    - rvm: 2.3.8
-      os: linux
-    - rvm: 2.4.5
-      os: linux
-    - rvm: 2.5.3
-      os: linux
-    - rvm: 2.6.1
-      os: linux
-    - rvm: 2.6.1
-      os: osx
-    - rvm: ruby-head
-      os: linux
-    - rvm: jruby-9.1.9.0
-      os: linux
-    - rvm: jruby-head
-      os: linux
-    - rvm: jruby-19mode
-      os: linux
-  allow_failures:
-    - rvm: 2.6.1
-      os: osx
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: jruby-19mode

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org/'
-
-gemspec
-
-## enable this line to run benchmarks
-# gem "viiite"
-
-gem "rubocop"
-gem "simplecov"

data/README.rdoc

@@ -1,225 +0,0 @@
-
-= MessagePack
-
-MessagePack[http://msgpack.org] is an efficient binary serialization format.
-It lets you exchange data among multiple languages like JSON but it's faster and smaller.
-For example, small integers (like flags or error code) are encoded into a single byte,
-and typical short strings only require an extra byte in addition to the strings themselves.
-
-If you ever wished to use JSON for convenience (storing an image with metadata) but could
-not for technical reasons (binary data, size, speed...), MessagePack is a perfect replacement.
-
-    require 'msgpack'
-    msg = [1,2,3].to_msgpack  #=> "\x93\x01\x02\x03"
-    MessagePack.unpack(msg)   #=> [1,2,3]
-
-Use RubyGems to install:
-
-    gem install msgpack
-
-or build msgpack-ruby and install:
-
-    bundle
-    rake
-    gem install --local pkg/msgpack
-
-
-= Use cases
-
-* Create REST API returing MessagePack using Rails + [RABL](https://github.com/nesquena/rabl)
-* Store objects efficiently serialized by msgpack on memcached or Redis
-  * In fact Redis supports msgpack in EVAL-scripts[http://redis.io/commands/eval]
-* Upload data in efficient format from mobile devices such as smartphones
-  * MessagePack works on iPhone/iPad and Android. See also Objective-C[https://github.com/msgpack/msgpack-objectivec] and Java[https://github.com/msgpack/msgpack-java] implementations
-* Design a portable protocol to communicate with embedded devices
-  * Check also Fluentd[http://fluentd.org/] which is a log collector which uses msgpack for the log format (they say it uses JSON but actually it's msgpack, which is compatible with JSON)
-* Exchange objects between software components written in different languages
-  * You'll need a flexible but efficient format so that components exchange objects while keeping compatibility
-
-= Portability
-
-MessagePack for Ruby should run on x86, ARM, PowerPC, SPARC and other CPU architectures.
-
-And it works with MRI (CRuby) and Rubinius.
-Patches to improve portability is highly welcomed.
-
-
-= Serializing objects
-
-Use *MessagePack.pack* or *to_msgpack*:
-
-    require 'msgpack'
-    msg = MessagePack.pack(obj)  # or
-    msg = obj.to_msgpack
-
-== Streaming serialization
-
-Packer provides advanced API to serialize objects in streaming style:
-
-    # serialize a 2-element array [e1, e2]
-    pk = MessagePack::Packer.new(io)
-    pk.write_array_header(2).write(e1).write(e2).flush
-
-See {API reference}[http://ruby.msgpack.org/MessagePack/Packer.html] for details.
-
-= Deserializing objects
-
-Use *MessagePack.unpack*:
-
-    require 'msgpack'
-    obj = MessagePack.unpack(msg)
-
-== Streaming deserialization
-
-Unpacker provides advanced API to deserialize objects in streaming style:
-
-    # deserialize objects from an IO
-    u = MessagePack::Unpacker.new(io)
-    u.each do |obj|
-      # ...
-    end
-
-or event-driven style which works well with EventMachine:
-
-    # event-driven deserialization
-    def on_read(data)
-      @u ||= MessagePack::Unpacker.new
-      @u.feed_each(data) {|obj|
-         # ...
-      }
-    end
-
-See {API reference}[http://ruby.msgpack.org/MessagePack/Unpacker.html] for details.
-
-= Serializing and deserializing symbols
-
-By default, symbols are serialized as strings:
-
-    packed = :symbol.to_msgpack     # => "\xA6symbol"
-    MessagePack.unpack(packed)      # => "symbol"
-
-This can be customized by registering an extension type for them:
-
-    MessagePack::DefaultFactory.register_type(0x00, Symbol)
-
-    # symbols now survive round trips
-    packed = :symbol.to_msgpack     # => "\xc7\x06\x00symbol"
-    MessagePack.unpack(packed)      # => :symbol
-
-The extension type for symbols is configurable like any other extension type.
-For example, to customize how symbols are packed you can just redefine
-Symbol#to_msgpack_ext. Doing this gives you an option to prevent symbols from
-being serialized altogether by throwing an exception:
-
-    class Symbol
-        def to_msgpack_ext
-            raise "Serialization of symbols prohibited"
-        end
-    end
-
-    MessagePack::DefaultFactory.register_type(0x00, Symbol)
-
-    [1, :symbol, 'string'].to_msgpack  # => RuntimeError: Serialization of symbols prohibited
-
-= Serializing and deserializing Time instances
-
-There are the timestamp extension type in MessagePack,
-but it is not registered by default.
-
-To map Ruby's Time to MessagePack's timestamp for the default factory:
-
-    MessagePack::DefaultFactory.register_type(
-      MessagePack::Timestamp::TYPE, # or just -1
-      Time,
-      packer: MessagePack::Time::Packer,
-      unpacker: MessagePack::Time::Unpacker
-    )
-
-See {API reference}[http://ruby.msgpack.org/] for details.
-
-= Extension Types
-
-Packer and Unpacker support {Extension types of MessagePack}[https://github.com/msgpack/msgpack/blob/master/spec.md#types-extension-type].
-
-    # register how to serialize custom class at first
-    pk = MessagePack::Packer.new(io)
-    pk.register_type(0x01, MyClass1, :to_msgpack_ext) # equal to pk.register_type(0x01, MyClass)
-    pk.register_type(0x02, MyClass2){|obj| obj.how_to_serialize() } # blocks also available
-    
-    # almost same API for unpacker
-    uk = MessagePack::Unpacker.new()
-    uk.register_type(0x01, MyClass1, :from_msgpack_ext)
-    uk.register_type(0x02){|data| MyClass2.create_from_serialized_data(data) }
-
-MessagePack::Factory is to create packer and unpacker which have same extension types.
-
-    factory = MessagePack::Factory.new
-    factory.register_type(0x01, MyClass1) # same with next line
-    factory.register_type(0x01, MyClass1, packer: :to_msgpack_ext, unpacker: :from_msgpack_ext)
-    pk = factory.packer(options_for_packer)
-    uk = factory.unpacker(options_for_unpacker)
-
-For *MessagePack.pack* and *MessagePack.unpack*, default packer/unpacker refer *MessagePack::DefaultFactory*. Call *MessagePack::DefaultFactory.register_type* to enable types process globally.
-
-    MessagePack::DefaultFactory.register_type(0x03, MyClass3)
-    MessagePack.unpack(data_with_ext_typeid_03) #=> MyClass3 instance
-
-= Buffer API
-
-MessagePack for Ruby provides a buffer API so that you can read or write data by hand, not via Packer or Unpacker API.
-
-This {MessagePack::Buffer}[http://ruby.msgpack.org/MessagePack/Buffer.html] is backed with a fixed-length shared memory pool which is very fast for small data (<= 4KB),
-and has zero-copy capability which significantly affects performance to handle large binary data.
-
-= How to build and run tests
-
-Before building msgpack, you need to install bundler and dependencies.
-
-    gem install bundler
-    bundle install
-
-Then, you can run the tasks as follows:
-
-* Build
-
-    bundle exec rake build
-
-* Run tests
-
-    bundle exec rake spec
-
-* Generating docs
-
-    bundle exec rake doc
-
-== How to build -java rubygems
-
-To build -java gems for JRuby, run:
-
-    rake build:java
-
-If this directory has Gemfile.lock (generated with MRI), remove it beforehand.
-
-== How to build -mingw32 rubygems
-
-MessagePack mingw32/64 rubygems build process uses {rake-compiler-dock}[https://github.com/rake-compiler/rake-compiler-dock]. Run:
-
-    rake build:windows
-
-Once this step successes, target gems exist in pkg/msgpack-*-{x86,x64}-mingw32.gem.
-
-== Updating documents
-
-Online documents (http://ruby.msgpack.org) is generated from gh-pages branch.
-Following commands update documents in gh-pages branch:
-
-    bundle exec rake doc
-    git checkout gh-pages
-    cp doc/* ./ -a
-
-= Copyright
-
-Author::    Sadayuki Furuhashi <frsyuki@gmail.com>
-Copyright:: Copyright (c) 2008-2015 Sadayuki Furuhashi
-License::   Apache License, Version 2.0
-

data/Rakefile

@@ -1,78 +0,0 @@
-
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'fileutils'
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-require 'yard'
-
-task :spec => :compile
-
-desc 'Run RSpec code examples and measure coverage'
-task :coverage do |t|
-  ENV['SIMPLE_COV'] = '1'
-  Rake::Task["spec"].invoke
-end
-
-desc 'Generate YARD document'
-YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files   = ['lib/msgpack/version.rb','doclib/**/*.rb']
-  t.options = []
-  t.options << '--debug' << '--verbose' if $trace
-end
-
-spec = eval File.read("msgpack.gemspec")
-
-if RUBY_PLATFORM =~ /java/
-  require 'rake/javaextensiontask'
-
-  Rake::JavaExtensionTask.new('msgpack', spec) do |ext|
-    ext.ext_dir = 'ext/java'
-    jruby_home = RbConfig::CONFIG['prefix']
-    jars = ["#{jruby_home}/lib/jruby.jar"]
-    ext.classpath = jars.map { |x| File.expand_path(x) }.join(':')
-    ext.lib_dir = File.join(*['lib', 'msgpack', ENV['FAT_DIR']].compact)
-    ext.source_version = '1.6'
-    ext.target_version = '1.6'
-  end
-else
-  require 'rake/extensiontask'
-
-  Rake::ExtensionTask.new('msgpack', spec) do |ext|
-    ext.ext_dir = 'ext/msgpack'
-    ext.cross_compile = true
-    ext.lib_dir = File.join(*['lib', 'msgpack', ENV['FAT_DIR']].compact)
-    # cross_platform names are of MRI's platform name
-    ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
-  end
-end
-
-test_pattern = case
-               when RUBY_PLATFORM =~ /java/ then 'spec/{,jruby/}*_spec.rb'
-               when RUBY_ENGINE =~ /rbx/ then 'spec/*_spec.rb'
-               else 'spec/{,cruby/}*_spec.rb' # MRI
-               end
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = ["-c", "-f progress"]
-  t.rspec_opts << "-Ilib"
-  t.pattern = test_pattern
-  t.verbose = true
-end
-
-namespace :build do
-  desc 'Build gem for JRuby after cleaning'
-  task :java => [:clean, :spec, :build]
-
-  desc 'Build gems for Windows per rake-compiler-dock'
-  task :windows do
-    require 'rake_compiler_dock'
-    # See RUBY_CC_VERSION in https://github.com/rake-compiler/rake-compiler-dock/blob/master/Dockerfile
-    RakeCompilerDock.sh 'bundle && gem i json && rake cross native gem RUBY_CC_VERSION=2.2.2:2.3.0:2.4.0:2.5.0:2.6.0:2.7.0'
-  end
-end
-
-CLEAN.include('lib/msgpack/msgpack.*')
-
-task :default => [:spec, :build, :doc]

data/appveyor.yml

@@ -1,18 +0,0 @@
----
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle install
-build: off
-test_script:
-  - bundle exec rake -rdevkit
-
-environment:
-  matrix:
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
-    - ruby_version: "22"
-    - ruby_version: "22-x64"

data/bench/pack.rb

@@ -1,23 +0,0 @@
-require 'viiite'
-require 'msgpack'
-
-data = { 'hello' => 'world', 'nested' => ['structure', {value: 42}] }
-data_sym = { hello: 'world', nested: ['structure', {value: 42}] }
-
-data = MessagePack.pack(:hello => 'world', :nested => ['structure', {:value => 42}])
-
-Viiite.bench do |b|
-  b.range_over([10_000, 100_000, 1000_000], :runs) do |runs|
-    b.report(:strings) do
-      runs.times do
-        MessagePack.pack(data)
-      end
-    end
-
-    b.report(:symbols) do
-      runs.times do
-        MessagePack.pack(data_sym)
-      end
-    end
-  end
-end

data/bench/pack_log.rb

@@ -1,33 +0,0 @@
-require 'viiite'
-require 'msgpack'
-
-data_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_structure = {
-  '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)',
-}
-
-Viiite.bench do |b|
-  b.range_over([10_000, 100_000, 1000_000], :runs) do |runs|
-    b.report(:plain) do
-      runs.times do
-        MessagePack.pack(data_plain)
-      end
-    end
-
-    b.report(:structure) do
-      runs.times do
-        MessagePack.pack(data_structure)
-      end
-    end
-  end
-end

data/bench/pack_log_long.rb

@@ -1,65 +0,0 @@
-# viiite report --regroup bench,threads bench/pack_log_long.rb
-
-require 'viiite'
-require 'msgpack'
-
-data_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_structure = {
-  '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)',
-}
-
-seconds = 3600 # 1 hour
-
-Viiite.bench do |b|
-  b.range_over([1, 2, 4, 8, 16], :threads) do |threads|
-    b.report(:plain) do
-      ths = []
-      end_at = Time.now + seconds
-      threads.times do
-        t = Thread.new do
-          packs = 0
-          while Time.now < end_at
-            10000.times do
-              MessagePack.pack(data_plain)
-            end
-            packs += 10000
-          end
-          packs
-        end
-        ths.push t
-      end
-      sum = ths.reduce(0){|r,t| r + t.value }
-      puts "MessagePack.pack, plain, #{threads} threads: #{sum} times, #{sum / seconds} times/second."
-    end
-
-    b.report(:structure) do
-      ths = []
-      end_at = Time.now + seconds
-      threads.times do
-        t = Thread.new do
-          packs = 0
-          while Time.now < end_at
-            10000.times do
-              MessagePack.pack(data_structure)
-            end
-            packs += 10000
-          end
-          packs
-        end
-        ths.push t
-      end
-      sum = ths.reduce(0){|r,t| r + t.value }
-      puts "MessagePack.pack, structured, #{threads} threads: #{sum} times, #{sum / seconds} times/second."
-    end
-  end
-end

data/bench/pack_symbols.rb

@@ -1,28 +0,0 @@
-require 'viiite'
-require 'msgpack'
-
-data = :symbol
-
-Viiite.bench do |b|
-  b.variation_point :branch, `git rev-parse --abbrev-ref HEAD`
-
-  b.range_over([:symbol, :none], :reg_type) do |reg_type|
-    packer = MessagePack::Packer.new
-    packer.register_type(0x00, Symbol, :to_msgpack_ext) if reg_type == :symbol
-
-    b.range_over([100_000, 1_000_000, 10_000_000], :count) do |count|
-      packer.clear
-      b.report(:multi_run) do
-        count.times do
-          packer.pack(data)
-        end
-      end
-
-      packer.clear
-      items_data = [].fill(data, 0, count)
-      b.report(:large_run) do
-        packer.pack(items_data)
-      end
-    end
-  end
-end

data/bench/run.sh

@@ -1,14 +0,0 @@
-#!/bin/sh
-
-# prerequisites
-# $ rbenv shell 2.2.1 (or jruby-x.x.x or ...)
-# $ rake install
-
-echo "pack"
-viiite report --regroup bench,runs bench/pack.rb 
-echo "unpack"
-viiite report --regroup bench,runs bench/unpack.rb 
-echo "pack log"
-viiite report --regroup bench,runs bench/pack_log.rb 
-echo "unpack log"
-viiite report --regroup bench,runs bench/unpack_log.rb 

data/bench/run_long.sh

@@ -1,35 +0,0 @@
-#!/bin/sh
-
-# prerequisites
-# $ sudo apt-get install sysstat
-# $ rbenv shell 2.2.1 (or jruby-x.x.x or ...)
-# $ rake install
-
-# 60 * 600 : 60*60 * 5[threads] * 2[bench]
-
-ruby -v
-
-echo "pack log long"
-viiite report --regroup bench,threads bench/pack_log_long.rb &
-sar -o pack_log_long.sar -r 60 600 > /dev/null 2>&1 &
-
-declare -i i=0
-while [ $i -lt 600 ]; do
-    ps auxww | grep ruby | grep -v grep | awk '{print $5,$6;}' >> pack_log_long.mem.txt
-    i=i+1
-    sleep 60
-done
-
-sleep 120 # cool down
-
-echo "unpack log long"
-viiite report --regroup bench,threads bench/unpack_log_long.rb &
-sar -o unpack_log_long.sar -r 60 600 > /dev/null 2>&1 &
-
-i=0
-while [ $i -lt 600 ]; do
-    ps auxww | grep ruby | grep -v grep | awk '{print $5,$6;}' >> pack_log_long.mem.txt
-    i=i+1
-    sleep 60
-done
-

data/bench/run_symbols.sh

@@ -1,26 +0,0 @@
-#!/bin/sh
-
-# so master and this branch have the benchmark file in any case
-cp bench/pack_symbols.rb bench/pack_symbols_tmp.rb
-
-benchmark=""
-current_branch=`git rev-parse --abbrev-ref HEAD`
-
-for branch in master $current_branch; do
-    echo "Testing branch $branch"
-    git checkout $branch
-
-    echo "Installing gem..."
-    rake install
-
-    echo "Running benchmark..."
-    if [ "$benchmark" ]; then
-        benchmark+=$'\n'
-    fi
-    benchmark+=$(viiite run bench/pack_symbols_tmp.rb)
-    echo
-done
-
-rm bench/pack_symbols_tmp.rb
-
-echo "$benchmark" | viiite report --regroup bench,reg_type,count,branch

data/bench/unpack.rb

@@ -1,21 +0,0 @@
-require 'viiite'
-require 'msgpack'
-
-data = MessagePack.pack(:hello => 'world', :nested => ['structure', {:value => 42}])
-
-Viiite.bench do |b|
-  b.range_over([10_000, 100_000, 1000_000], :runs) do |runs|
-    b.report(:strings) do
-      runs.times do
-        MessagePack.unpack(data)
-      end
-    end
-
-    b.report(:symbols) do
-      options = {:symbolize_keys => true}
-      runs.times do
-        MessagePack.unpack(data, options)
-      end
-    end
-  end
-end

data/bench/unpack_log.rb

@@ -1,34 +0,0 @@
-require 'viiite'
-require 'msgpack'
-
-data_plain = MessagePack.pack({ '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_structure = MessagePack.pack({
-  '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)',
-})
-
-Viiite.bench do |b|
-  b.range_over([10_000, 100_000, 1000_000], :runs) do |runs|
-    b.report(:plain) do
-      runs.times do
-        MessagePack.unpack(data_plain)
-      end
-    end
-
-    b.report(:structure) do
-      runs.times do
-        MessagePack.unpack(data_structure)
-      end
-    end
-  end
-end