msgpack 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a317e08b024ceca2cce0905f232be73ccaec7457966e2ee19f069090b423080
-  data.tar.gz: f092f4b4e4736acb54051d42c6ba390e592ba1f5661cc3745fdcd438bc185738
+  metadata.gz: c7d0ed046cdf407e2d23286375ec7b544cc35044f3bd4ee9835eeaa0b4aa172f
+  data.tar.gz: 76eeff0a8e1caa4f81628caa825104911e497a6caa472e2c6945b52f816d2f7d
 SHA512:
-  metadata.gz: bd511fc4978b2a2b3b70422bbef0376b808bd998332fdffdbebf830d48d20466fe809d1ef8ef23ad36f48062c4019a64e9296f0acbda0f325c5a6da932c99057
-  data.tar.gz: 6f6873b35b5c0daec144a04113f0df9e4159c20b46a85ca527a105cd0a7d26a357a1cbc3279b3a510f6ea67efbb038242c586fe66f7e8674bca13165c300be56
+  metadata.gz: 6b1f71db6217e6285c90f5329af40d89ddf8a305e5ea71ea479cb0b930fd88f886be28a1109aea2c48e4a2dd52930e4a28dcfc299d64f6d574d7a5f451f385af
+  data.tar.gz: 96f4af2162e098d1c7469359e4c1034f47762f88a02c904c2d04ce32fa80e2a74004d2e343ae142deb955566891844648be420b46dcb02e86f5e94fd4abd72cc

data/ChangeLog

@@ -1,3 +1,7 @@
+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)

data/doclib/msgpack/packer.rb

@@ -91,6 +91,12 @@ module MessagePack
     def write_nil
     end
 
+    #
+    # Serializes a string object as binary data. Same as write("string".encode(Encoding::BINARY)).
+    #
+    def write_bin(obj)
+    end
+
     #
     # Write a header of an array whose size is _n_.
     # For example, write_array_header(1).write(true) is same as write([ true ]).
@@ -109,6 +115,20 @@ module MessagePack
     def write_map_header(n)
     end
 
+    #
+    # Write a header of a binary string whose size is _n_. Useful if you want to append large binary data without loading it into memory at once.
+    # For example,
+    # MessagePack::Packer.new(io).write_bin_header(12).flush
+    # io.write('chunk1')
+    # io.write('chunk2')
+    # is the same as
+    # write('chunk1chunk2'.encode(Encoding::BINARY)).
+    #
+    # @return [Packer] self
+    #
+    def write_bin_header(n)
+    end
+
     #
     # Serializes _value_ as 32-bit single precision float into internal buffer.
     # _value_ will be approximated with the nearest possible single precision float, thus

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

@@ -91,6 +91,11 @@ public class Encoder {
     return readRubyString();
   }
 
+  public IRubyObject encodeBinHeader(int size) {
+    appendStringHeader(size, true);
+    return readRubyString();
+  }
+
   public IRubyObject encodeFloat32(RubyNumeric numeric) {
     appendFloat32(numeric);
     return readRubyString();
@@ -221,14 +226,7 @@ public class Encoder {
     buffer.putFloat(value);
   }
 
-  private void appendString(RubyString object) {
-    Encoding encoding = object.getEncoding();
-    boolean binary = !compatibilityMode && encoding == binaryEncoding;
-    if (encoding != utf8Encoding && encoding != binaryEncoding) {
-      object = (RubyString) ((RubyString) object).encode(runtime.getCurrentContext(), runtime.getEncodingService().getEncoding(utf8Encoding));
-    }
-    ByteList bytes = object.getByteList();
-    int length = bytes.length();
+  private void appendStringHeader(int length, boolean binary) {
     if (length < 32 && !binary) {
       ensureRemainingCapacity(1 + length);
       buffer.put((byte) (length | FIXSTR));
@@ -245,6 +243,17 @@ public class Encoder {
       buffer.put(binary ? BIN32 : STR32);
       buffer.putInt((int) length);
     }
+  }
+
+  private void appendString(RubyString object) {
+    Encoding encoding = object.getEncoding();
+    boolean binary = !compatibilityMode && encoding == binaryEncoding;
+    if (encoding != utf8Encoding && encoding != binaryEncoding) {
+      object = (RubyString) ((RubyString) object).encode(runtime.getCurrentContext(), runtime.getEncodingService().getEncoding(utf8Encoding));
+    }
+    ByteList bytes = object.getByteList();
+    int length = bytes.length();
+    appendStringHeader(length, binary);
     buffer.put(bytes.unsafeBytes(), bytes.begin(), length);
   }
 

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

@@ -21,6 +21,8 @@ import org.jruby.util.ByteList;
 import org.jruby.util.TypeConverter;
 import org.msgpack.jruby.ExtensionValue;
 
+import org.jcodings.Encoding;
+
 import static org.jruby.runtime.Visibility.PRIVATE;
 
 @JRubyClass(name="MessagePack::Packer")
@@ -29,6 +31,7 @@ public class Packer extends RubyObject {
   private Buffer buffer;
   private Encoder encoder;
   private boolean hasSymbolExtType;
+  private Encoding binaryEncoding;
 
   public Packer(Ruby runtime, RubyClass type, ExtensionRegistry registry, boolean hasSymbolExtType) {
     super(runtime, type);
@@ -58,6 +61,7 @@ public class Packer extends RubyObject {
     this.encoder = new Encoder(ctx.getRuntime(), compatibilityMode, registry, hasSymbolExtType);
     this.buffer = new Buffer(ctx.getRuntime(), ctx.getRuntime().getModule("MessagePack").getClass("Buffer"));
     this.buffer.initialize(ctx, args);
+    this.binaryEncoding = ctx.getRuntime().getEncodingService().getAscii8bitEncoding();
     return this;
   }
 
@@ -141,6 +145,13 @@ public class Packer extends RubyObject {
     return write(ctx, obj);
   }
 
+  @JRubyMethod(name = "write_bin")
+  public IRubyObject writeBin(ThreadContext ctx, IRubyObject obj) {
+    checkType(ctx, obj, org.jruby.RubyString.class);
+    obj = ((org.jruby.RubyString) obj).encode(ctx, ctx.runtime.getEncodingService().getEncoding(binaryEncoding));
+    return write(ctx, obj);
+  }
+
   @JRubyMethod(name = "write_hash")
   public IRubyObject writeHash(ThreadContext ctx, IRubyObject obj) {
     checkType(ctx, obj, org.jruby.RubyHash.class);
@@ -209,6 +220,13 @@ public class Packer extends RubyObject {
     return this;
   }
 
+  @JRubyMethod(name = "write_bin_header")
+  public IRubyObject writeBinHeader(ThreadContext ctx, IRubyObject size) {
+    int s = (int) size.convertToInteger().getLongValue();
+    buffer.write(ctx, encoder.encodeBinHeader(s));
+    return this;
+  }
+
   @JRubyMethod(name = "full_pack")
   public IRubyObject fullPack(ThreadContext ctx) {
     return toS(ctx);

data/ext/msgpack/packer_class.c

@@ -165,6 +165,18 @@ static VALUE Packer_write_string(VALUE self, VALUE obj)
     return self;
 }
 
+static VALUE Packer_write_bin(VALUE self, VALUE obj)
+{
+    PACKER(self, pk);
+    Check_Type(obj, T_STRING);
+
+    VALUE enc = rb_enc_from_encoding(rb_ascii8bit_encoding());
+    obj = rb_str_encode(obj, enc, 0, Qnil);
+
+    msgpack_packer_write_string_value(pk, obj);
+    return self;
+}
+
 static VALUE Packer_write_array(VALUE self, VALUE obj)
 {
     PACKER(self, pk);
@@ -232,6 +244,13 @@ static VALUE Packer_write_map_header(VALUE self, VALUE n)
     return self;
 }
 
+static VALUE Packer_write_bin_header(VALUE self, VALUE n)
+{
+    PACKER(self, pk);
+    msgpack_packer_write_bin_header(pk, NUM2UINT(n));
+    return self;
+}
+
 static VALUE Packer_write_float32(VALUE self, VALUE numeric)
 {
     if(!rb_obj_is_kind_of(numeric, rb_cNumeric)) {
@@ -416,6 +435,7 @@ void MessagePack_Packer_module_init(VALUE mMessagePack)
     rb_define_method(cMessagePack_Packer, "write_false", Packer_write_false, 0);
     rb_define_method(cMessagePack_Packer, "write_float", Packer_write_float, 1);
     rb_define_method(cMessagePack_Packer, "write_string", Packer_write_string, 1);
+    rb_define_method(cMessagePack_Packer, "write_bin", Packer_write_bin, 1);
     rb_define_method(cMessagePack_Packer, "write_array", Packer_write_array, 1);
     rb_define_method(cMessagePack_Packer, "write_hash", Packer_write_hash, 1);
     rb_define_method(cMessagePack_Packer, "write_symbol", Packer_write_symbol, 1);
@@ -423,6 +443,7 @@ void MessagePack_Packer_module_init(VALUE mMessagePack)
     rb_define_method(cMessagePack_Packer, "write_extension", Packer_write_extension, 1);
     rb_define_method(cMessagePack_Packer, "write_array_header", Packer_write_array_header, 1);
     rb_define_method(cMessagePack_Packer, "write_map_header", Packer_write_map_header, 1);
+    rb_define_method(cMessagePack_Packer, "write_bin_header", Packer_write_bin_header, 1);
     rb_define_method(cMessagePack_Packer, "write_ext", Packer_write_ext, 2);
     rb_define_method(cMessagePack_Packer, "write_float32", Packer_write_float32, 1);
     rb_define_method(cMessagePack_Packer, "flush", Packer_flush, 0);

data/lib/msgpack/version.rb

@@ -1,5 +1,5 @@
 module MessagePack
-  VERSION = "1.2.6"
+  VERSION = "1.2.7"
 
   # NOTE for msgpack-ruby maintainer:
   # Check these things to release new binaryes for new Ruby versions (especially for Windows):

data/spec/cruby/buffer_spec.rb

@@ -1,6 +1,11 @@
 require 'spec_helper'
 require 'random_compat'
 
+require 'stringio'
+if defined?(Encoding)
+  Encoding.default_external = 'ASCII-8BIT'
+end
+
 describe Buffer do
   STATIC_EXAMPLES = {}
   STATIC_EXAMPLES[:empty01] = ''
@@ -45,7 +50,7 @@ describe Buffer do
         b.read(n)
         s.slice!(0, n)
       end
-      key = :"random#{"%02d"%i}"
+      key = :"random#{"%02d" % i}"
       cases[key] = b
       examples[key] = s
     end

data/spec/packer_spec.rb

@@ -134,6 +134,41 @@ describe MessagePack::Packer do
     packer.to_s.should == "\x81"
   end
 
+  it 'write_bin_header 0' do
+    packer.write_bin_header(0)
+    packer.to_s.should == "\xC4\x00"
+  end
+
+  it 'write_bin_header 255' do
+    packer.write_bin_header(255)
+    packer.to_s.should == "\xC4\xFF"
+  end
+
+  it 'write_bin_header 256' do
+    packer.write_bin_header(256)
+    packer.to_s.should == "\xC5\x01\x00"
+  end
+
+  it 'write_bin_header 65535' do
+    packer.write_bin_header(65535)
+    packer.to_s.should == "\xC5\xFF\xFF"
+  end
+
+  it 'write_bin_header 65536' do
+    packer.write_bin_header(65536)
+    packer.to_s.should == "\xC6\x00\x01\x00\x00"
+  end
+
+  it 'write_bin_header 999999' do
+    packer.write_bin_header(999999)
+    packer.to_s.should == "\xC6\x00\x0F\x42\x3F"
+  end
+
+  it 'write_bin' do
+    packer.write_bin("hello")
+    packer.to_s.should == "\xC4\x05hello"
+  end
+
   describe '#write_float32' do
     tests = [
       ['small floats', 3.14, "\xCA\x40\x48\xF5\xC3"],
@@ -193,6 +228,7 @@ describe MessagePack::Packer do
     packer = MessagePack::Packer.new
     expect { packer.write_float "hello" }.to raise_error(TypeError)
     expect { packer.write_string 1 }.to raise_error(TypeError)
+    expect { packer.write_bin 1 }.to raise_error(TypeError)
     expect { packer.write_array "hello" }.to raise_error(TypeError)
     expect { packer.write_hash "hello" }.to raise_error(TypeError)
     expect { packer.write_symbol "hello" }.to raise_error(TypeError)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: msgpack
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Sadayuki Furuhashi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler