msgpack 0.6.2 → 0.7.0dev1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 504d2e79f6495ca1e39421dc878ec2108f317fc5
-  data.tar.gz: b433d02ec1d26ac55341af24c04384b5e8442dee
+  metadata.gz: e934ddd7840719b64ca248c14b5cb3e81ed4c0fd
+  data.tar.gz: 2bd6ef14c3c873241be2911fe0666dc5526e9351
 SHA512:
-  metadata.gz: 45aaa1839c144714fc3efed75acf446e01f455a20010c92951fba275f27cd652319cd444b2a18eb59ffcd11e5d328fad133d410f4087f7ceb9fad7f60145be04
-  data.tar.gz: b9320514ce04bda3cd8f7ffd344a32251db8ccdef7ea8d81c39a044a0b89f55e3536f6e122b7e4f7e580a227bbadd52f4fcf56de3c4d597fa6d3d1858f4b6b27
+  metadata.gz: 857b591765e1b4bb0a0efac427e729e278168eee8bdfdd47bc9b1a86f30edfdecedc4a81626709da5d21fb25988485c243532d3d87d9c3cde1b9a47c30c2624b
+  data.tar.gz: a616c639a3c3cc8029d1bc93d8821f60ad85799995016e7cf579a0875380de21b598a0dbad608db728fc8301ce993453db1d7605ae189e51af2aa04f2e712624

data/.rubocop.yml

@@ -0,0 +1,33 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-03-09 17:42:55 +0100 using RuboCop version 0.29.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Lint/AmbiguousOperator:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# Offense count: 1
+Lint/Eval:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Offense count: 35
+# Cop supports --auto-correct.
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# Offense count: 128
+Lint/Void:
+  Enabled: false

data/README.rdoc

@@ -123,16 +123,12 @@ Then, you can run the tasks as follows:
 
 == How to build -mingw32 rubygems
 
-MessagePack mingw32/64 rubygems build process uses {Docker}[https://docs.docker.com/].
+MessagePack mingw32/64 rubygems build process uses {rake-compiler-dock}[https://github.com/rake-compiler/rake-compiler-dock]. Run:
 
-Set up docker environment at first, and then run docker container to build gems, with shared directory "pkg".
-
-    docker run -it --rm -v `pwd`/pkg:/home/ubuntu/msgpack-ruby/pkg msgpack/msgpack-rubygem-crosscompile
+    rake build:windows
 
 Once this step successes, target gems exist in pkg/msgpack-*-{x86,x64}-mingw32.gem.
 
-See also: https://registry.hub.docker.com/u/msgpack/msgpack-rubygem-crosscompile/
-
 = Copyright
 
 Author::    Sadayuki Furuhashi <frsyuki@gmail.com>

data/Rakefile

@@ -52,6 +52,7 @@ else
     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
 
@@ -63,6 +64,14 @@ else
   end
 end
 
+namespace :build do
+  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'
+  end
+end
+
 CLEAN.include('lib/msgpack/msgpack.*')
 
 task :default => [:spec, :build, :doc]

data/appveyor.yml

@@ -0,0 +1,18 @@
+---
+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/doclib/msgpack/error.rb

@@ -9,6 +9,11 @@ module MessagePack
   class StackError < UnpackError
   end
 
-  class TypeError < StandardError
+  class UnexpectedTypeError < UnpackError
+    include TypeError
+  end
+
+  class UnknownExtTypeError < UnpackError
+    include TypeError
   end
 end

data/doclib/msgpack/extension_value.rb

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,68 @@
+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
+
+    #
+    # 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
+
+    #
+    # Register a type and Class to be registered for packer and/or unpacker.
+    # If options are not speicified, 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
+    #
+    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
+  end
+end

data/doclib/msgpack/packer.rb

@@ -26,6 +26,44 @@ module MessagePack
     def initialize(*args)
     end
 
+    #
+    # Register a new ext type to serialize it. This method should be called with one of
+    # method name or block, which returns bytes(ASCII-8BIT String) representation of
+    # object to be serialized.
+    #
+    # @overload register_type(type, klass, &block)
+    #   @param type [Fixnum] type id (0-127) user defined type id for specified Class
+    #   @param klass [Class] Class to be serialized with speicifed type id
+    #   @yieldparam object [Object] object to be serialized
+    #
+    # @overload register_type(type, klass, method_name)
+    #   @param type [Fixnum] type id (0-127) user defined type id for specified Class
+    #   @param klass [Class] Class to be serialized with speicifed type id
+    #   @param method_name [Symbol] method which returns bytes of serialized representation
+    #
+    # @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 :packer.
+    #
+    # @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
     #

data/doclib/msgpack/unpacker.rb

@@ -19,12 +19,49 @@ module MessagePack
     # 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 speicifed 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
     #
@@ -77,7 +114,7 @@ module MessagePack
     # 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::TypeError.
+    # 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
@@ -89,7 +126,7 @@ module MessagePack
     # 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::TypeError.
+    # 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

data/ext/java/org/msgpack/jruby/Buffer.java

@@ -81,6 +81,10 @@ public class Buffer extends RubyObject {
 
   @JRubyMethod(name = "clear")
   public IRubyObject clear(ThreadContext ctx) {
+    if (!writeMode) {
+      buffer.compact();
+      writeMode = true;
+    }
     buffer.clear();
     return ctx.getRuntime().getNil();
   }

data/ext/java/org/msgpack/jruby/Decoder.java

@@ -29,6 +29,7 @@ public class Decoder implements Iterator<IRubyObject> {
   private final Encoding utf8Encoding;
   private final RubyClass unpackErrorClass;
   private final RubyClass underflowErrorClass;
+  private final RubyClass unexpectedTypeErrorClass;
 
   private ByteBuffer buffer;
   private boolean symbolizeKeys;
@@ -47,6 +48,7 @@ public class Decoder implements Iterator<IRubyObject> {
     this.utf8Encoding = UTF8Encoding.INSTANCE;
     this.unpackErrorClass = runtime.getModule("MessagePack").getClass("UnpackError");
     this.underflowErrorClass = runtime.getModule("MessagePack").getClass("UnderflowError");
+    this.unexpectedTypeErrorClass = runtime.getModule("MessagePack").getClass("UnexpectedTypeError");
     feed(bytes, offset, length);
   }
 
@@ -135,6 +137,48 @@ public class Decoder implements Iterator<IRubyObject> {
     return buffer.remaining() > 0;
   }
 
+  public IRubyObject read_array_header() {
+    int position = buffer.position();
+    try {
+      byte b = buffer.get();
+      if ((b & 0xf0) == 0x90) {
+	return runtime.newFixnum(b & 0x0f);
+      } else if (b == ARY16) {
+	return runtime.newFixnum(buffer.getShort() & 0xffff);
+      } else if (b == ARY32) {
+	return runtime.newFixnum(buffer.getInt());
+      }
+      throw runtime.newRaiseException(unexpectedTypeErrorClass, "unexpected type");
+    } catch (RaiseException re) {
+      buffer.position(position);
+      throw re;
+    } catch (BufferUnderflowException bue) {
+      buffer.position(position);
+      throw runtime.newRaiseException(underflowErrorClass, "Not enough bytes available");
+    }
+  }
+
+  public IRubyObject read_map_header() {
+    int position = buffer.position();
+    try {
+      byte b = buffer.get();
+      if ((b & 0xf0) == 0x80) {
+	return runtime.newFixnum(b & 0x0f);
+      } else if (b == MAP16) {
+	return runtime.newFixnum(buffer.getShort() & 0xffff);
+      } else if (b == MAP32) {
+	return runtime.newFixnum(buffer.getInt());
+      }
+      throw runtime.newRaiseException(unexpectedTypeErrorClass, "unexpected type");
+    } catch (RaiseException re) {
+      buffer.position(position);
+      throw re;
+    } catch (BufferUnderflowException bue) {
+      buffer.position(position);
+      throw runtime.newRaiseException(underflowErrorClass, "Not enough bytes available");
+    }
+  }
+
   @Override
   public IRubyObject next() {
     int position = buffer.position();

data/ext/java/org/msgpack/jruby/Encoder.java

@@ -25,7 +25,6 @@ import org.jcodings.specific.UTF8Encoding;
 
 import static org.msgpack.jruby.Types.*;
 
-
 public class Encoder {
 
   private static final int CACHE_LINE_SIZE = 64;
@@ -105,10 +104,10 @@ public class Encoder {
       appendArray((RubyArray) object);
     } else if (object instanceof RubyHash) {
       appendHash((RubyHash) object);
-    } else if (object.respondsTo("to_msgpack")) {
-      appendCustom(object, destination);
+    } else if (object instanceof ExtensionValue) {
+      appendExtensionValue((ExtensionValue) object);
     } else {
-      throw runtime.newArgumentError(String.format("Cannot pack type: %s", object.getClass().getName()));
+      appendCustom(object, destination);
     }
   }
 
@@ -296,6 +295,49 @@ public class Encoder {
     }
   }
 
+  private void appendExtensionValue(ExtensionValue object) {
+    long type = ((RubyFixnum)object.get_type()).getLongValue();
+    if (type < -128 || type > 127) {
+	    throw object.getRuntime().newRangeError(String.format("integer %d too big to convert to `signed char'", type));
+    }
+    ByteList payloadBytes = ((RubyString)object.payload()).getByteList();
+    int payloadSize = payloadBytes.length();
+    int outputSize = 0;
+    boolean fixSize = payloadSize == 1 || payloadSize == 2 || payloadSize == 4 || payloadSize == 8 || payloadSize == 16;
+    if (fixSize) {
+      outputSize = 2 + payloadSize;
+    } else if (payloadSize < 0x100) {
+      outputSize = 3 + payloadSize;
+    } else if (payloadSize < 0x10000) {
+      outputSize = 4 + payloadSize;
+    } else {
+      outputSize = 6 + payloadSize;
+    }
+    ensureRemainingCapacity(outputSize);
+    if (payloadSize == 1) {
+      buffer.put(FIXEXT1);
+    } else if (payloadSize == 2) {
+      buffer.put(FIXEXT2);
+    } else if (payloadSize == 4) {
+      buffer.put(FIXEXT4);
+    } else if (payloadSize == 8) {
+      buffer.put(FIXEXT8);
+    } else if (payloadSize == 16) {
+      buffer.put(FIXEXT16);
+    } else if (payloadSize < 0x100) {
+      buffer.put(VAREXT8);
+      buffer.put((byte) payloadSize);
+    } else if (payloadSize < 0x10000) {
+      buffer.put(VAREXT16);
+      buffer.putShort((short) payloadSize);
+    } else {
+      buffer.put(VAREXT32);
+      buffer.putInt(payloadSize);
+    }
+    buffer.put((byte) type);
+    buffer.put(payloadBytes.unsafeBytes(), payloadBytes.begin(), payloadSize);
+  }
+
   private void appendCustom(IRubyObject object, IRubyObject destination) {
     if (destination == null) {
       IRubyObject result = object.callMethod(runtime.getCurrentContext(), "to_msgpack");