msgpack 0.7.4 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 452730fc6dbf9e301355b759c9f5ff7080bb88ad
-  data.tar.gz: 7bd19e617d2298a59be2505929f0888167c39d1c
+SHA256:
+  metadata.gz: 40d206a80a2ab99957b78f2d054417dc273933da4accf5f39a25ff4b16ec30ce
+  data.tar.gz: e39c06187017d057a44e71d3690662455934c2c1acafc667d49e91aaf626fbd9
 SHA512:
-  metadata.gz: f42256792f53a9188e688222f0f44c461bdc3849614bd155f0340a48de437fde596d294341a8b30de27269c69f4ef984da40cca12c76f76c312b83d08a8bf58d
-  data.tar.gz: eab376976af6d888b3422a25cd49a4a7dbbe9e11071a0b8ae40491700505cb10d7e5b7768fc8f459aa93e3a58d7f9fe940d0fb70e268244e76f67f3757dfad32
+  metadata.gz: d20c8da71f90435f264c0e1c9c90e4a5c8c09c014d33076149e6e5faa3b849ac5192d2f086b917f09eb199bcfd8cc748093d6f59e3f5fcb7c228199f549c23c5
+  data.tar.gz: dd5c662d5abbf45901d59a7400f2b92a6c296b2298035fecc55a31f82b19b4e9206ca3b0a7cab090d9cc9768bea015b74ad9bf5a997a763eb6ba3387b6a7fc30

data/.gitignore

@@ -18,4 +18,6 @@ tmp
 .project
 .settings
 /nbproject/private/
-
+coverage/
+.idea/
+.ruby-version

data/.rubocop.yml

@@ -5,6 +5,9 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+AllCops:
+  TargetRubyVersion: 2.3
+
 # Offense count: 3
 Lint/AmbiguousOperator:
   Enabled: false

data/.travis.yml

@@ -1,17 +1,5 @@
 language: ruby
 
-rvm:
-  - 2.0.0
-  - 2.1.6
-  - 2.2.2
-  - ruby-head
-  - jruby-19mode
-  - jruby-head
-
-os:
-  - linux
-  - osx
-
 sudo: false
 
 branches:
@@ -21,10 +9,35 @@ branches:
 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:
-  allow_failures:
+  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: rbx-2
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-19mode

data/ChangeLog

@@ -1,3 +1,91 @@
+2020-02-05 version 1.3.3:
+
+* Hotfix release for Windows environments: 1.3.2 missed including binaries
+
+2020-02-04 version 1.3.2:
+
+* Add Ruby 2.7.0 binary in gem releases for Windows
+
+2019-08-05 version 1.3.1:
+
+* Fix timestamp ext type bug about timestamps with seconds larger than 32bit int (after 2106-02-07 06:28:16 UTC)
+
+2019-06-20 verison 1.3.0:
+
+* Add timestamp ext type (id:-1) support
+
+2019-04-19 version 1.2.10:
+
+* Optimze MessagePack.unpack not to copy source string
+
+2019-03-13 version 1.2.9:
+
+* Hotfix release only for JRuby: 1.2.8-java was built incorrectly
+
+2019-03-11 version 1.2.8:
+
+* Fix a regression that MessagePack#unpack raises error if IO is assigned as the (only) argument
+* Improve compatibility that MessagePack#pack returns nil if IO is assigned as 2nd argument
+
+2019-03-01 version 1.2.7:
+
+* Add Packer#write_bin and Packer#write_bin_header methods
+
+2019-01-08 verison 1.2.6:
+
+* Update Ruby version 2.6 dependency (especially for Windows environment)
+* (version 1.2.4 and 1.2.5 were also releases for updated Ruby versions)
+
+2018-03-02 version 1.2.3:
+
+* Add Ruby 2.5.0 binary in gem releases for Windows
+
+2018-01-11 version 1.2.2:
+
+* Fix bug to occur SEGV occasionally (depends on GC timing) when exttype is used
+* Fix bug to encode an ext type with wrong type id if superclass is also registered as ext type
+
+2017-12-08 version 1.2.1:
+
+* Hotfix release only for JRuby: 1.2.0-java was built in incorrect way
+
+2017-12-07 version 1.2.0:
+
+* Add MessagePack::Factory#dump and MessagePack::Factory#load as convenient methods
+  like MessagePack.dump and MessagePack.load
+* Fix bug to accept MessagePack::Factory#register_type after #freeze
+
+2017-02-28 version 1.1.0:
+
+* Fix the extension type handling to accept modules in addition to classes
+
+2017-01-24 version 1.0.3:
+
+* Support Ruby 2.4
+
+2016-10-17 version 1.0.2:
+
+* Bump version up to release newer version to fix broken gem release for JRuby
+
+2016-10-17 version 1.0.1:
+
+* Fix a bug to crash at packer when ext type is registered for superclass of packed object
+* Fix JRuby implementation about inconsistent API of Unpacker constructor
+
+2016-07-08 version 1.0.0:
+
+* Fix to be able to pack Symbol with ext types
+* Fix for MRI 2.4 (Integer unification)
+
+2016-05-10 version 0.7.6:
+
+* Fix bug to raise IndexOutOfBoundsException for Bignum value with small int in JRuby
+
+2016-04-06 version 0.7.5:
+
+* Improved support for i386/armel/armhf environments
+* Fix bug for negative ext type id and some architectures (arm*)
+
 2016-01-08 version 0.7.4:
 
 * Improved compatibility of Packer between CRuby and JRuby about argument IO-ish object values.
@@ -17,7 +105,7 @@
 
 2015-10-24 version 0.7.0:
 
-* Add extention types support.
+* Add extension types support.
 * Fix to share almost all test cases between CRuby and JRuby implementations.
 * Fixed JRuby implementation to raise UnknownExtTypeError for unregistered ext type ids
   instead to generate MessagePack::ExtensionValue instances.

data/Gemfile

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

data/README.rdoc

@@ -91,6 +91,52 @@ or event-driven style which works well with EventMachine:
 
 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].
@@ -105,7 +151,7 @@ Packer and Unpacker support {Extension types of MessagePack}[https://github.com/
     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 extention types.
+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
@@ -146,6 +192,14 @@ Then, you can run the tasks as follows:
 
     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:

data/Rakefile

@@ -62,10 +62,14 @@ RSpec::Core::RakeTask.new(:spec) do |t|
 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'
-    RakeCompilerDock.sh 'bundle && rake cross native gem RUBY_CC_VERSION=1.9.3:2.0.0:2.1.6:2.2.2:2.3.0'
+    # 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
 

data/bench/pack_symbols.rb

@@ -0,0 +1,28 @@
+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_symbols.sh

@@ -0,0 +1,26 @@
+#!/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/doclib/msgpack.rb

@@ -12,7 +12,7 @@ module MessagePack
   #   @param obj [Object] object to be serialized
   #   @param io [IO]
   #   @param options [Hash]
-  #   @return [IO]
+  #   @return [nil]
   #
   # See Packer#initialize for supported options.
   #
@@ -31,7 +31,7 @@ module MessagePack
   #   @param obj [Object] object to be serialized
   #   @param io [IO]
   #   @param options [Hash]
-  #   @return [IO]
+  #   @return [nil]
   #
   # See Packer#initialize for supported options.
   #

data/doclib/msgpack/core_ext.rb

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