zstd-ruby 1.5.2.0 → 1.5.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c33df57662a35d3eae35eb7b82afecf5e91191152edcef555b88aab4b803a3a
-  data.tar.gz: e3d5d34ff446b9a280bcb4e0fc103b4f6cb3312c37756145a578a05bfc237672
+  metadata.gz: cb64917059ca60a73732ee8f460f31ab3fbd36bce1eb20b844f8e36de8c9ec75
+  data.tar.gz: 01a248c444714b1404b934745f47c73aac8a2acb1bd1b0cb36993b1b61593d33
 SHA512:
-  metadata.gz: 3f0f2cab5053a1bd6ffc3af753aae2ba2d61c20623738e8c4214a9b67dedd6a76df1fdec888b1fe21fbc3334457d8fe4ed03c9ff17dcfbe19f55022846291ea3
-  data.tar.gz: 59ee08ebad25d6c1f21d3b611f7352db6b4cb219a047fe0d9782c9eaae17aa6972bc70e4818c91289e8f7c03cab0dea9db7ac06ce372295c718fa0dae5046c94
+  metadata.gz: 629f566ee687ad0e3cf0afd7329f32d67bc10bb58a316541fec249913cb5b7a81323138dd1eef10aed986fbdf57838214fa65218cb3c5ae1fb20b6ffb880aa99
+  data.tar.gz: f6ca1102e9fd7c1147b0a2187575eca9fe6539375e4eff0b3a90635fb973b739402ed0951cd8b8f68d55d33a1996593c5da4e6078b39b8a5d2be77d311004110

data/.gitignore

@@ -17,3 +17,5 @@ vendor/
 
 # rspec failure tracking
 .rspec_status
+
+.ruby-version

data/README.md

@@ -34,20 +34,85 @@ Or install it yourself as:
 require 'zstd-ruby'
 ```
 
-### compression
+### Simple Compression
 
 ```ruby
 compressed_data = Zstd.compress(data)
 compressed_data = Zstd.compress(data, complession_level) # default compression_level is 0
 ```
 
+### Compression using Dictionary
+```ruby
+# dictionary is supposed to have been created using `zstd --train`
+compressed_using_dict = Zstd.compress_using_dict("", IO.read('dictionary_file'))
+```
 
-### decompression
+### Streaming Compression
+```
+stream = Zstd::StreamingCompress.new
+stream << "abc" << "def"
+res = stream.flush
+stream << "ghi"
+res << stream.finish
+```
+
+or
+
+```
+stream = Zstd::StreamingCompress.new
+res = stream.compress("abc")
+res << stream.flush
+res << stream.compress("def")
+res << stream.finish
+```
+
+### Simple Decompression
 
 ```ruby
 data = Zstd.decompress(compressed_data)
 ```
 
+### Decomporession using Dictionary
+```ruby
+# dictionary is supposed to have been created using `zstd --train`
+Zstd.decompress_using_dict(compressed_using_dict, IO.read('dictionary_file'))
+```
+
+### Streaming Decompression
+```
+cstr = "" # Compressed data
+stream = Zstd::StreamingDecompress.new
+result = ''
+result << stream.decompress(cstr[0, 10])
+result << stream.decompress(cstr[10..-1])
+```
+
+
+## JRuby
+This gem does not support JRuby.
+
+Please consider using https://github.com/luben/zstd-jni.
+
+Sample code is below.
+
+```
+require 'java'
+require_relative './zstd-jni-1.5.2-3.jar'
+
+str = "testtest"
+compressed = com.github.luben.zstd.Zstd.compress(str.to_java_bytes)
+puts com.github.luben.zstd.Zstd.decompress(compressed, str.length)
+```
+
+```
+% ls
+test.rb              zstd-jni-1.5.2-3.jar
+% ruby -v
+jruby 9.3.2.0 (2.6.8) 2021-12-01 0b8223f905 OpenJDK 64-Bit Server VM 11.0.12+0 on 11.0.12+0 +jit [darwin-x86_64]
+% ruby test.rb
+testtest
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -56,7 +121,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/SpringMT/zstd_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/SpringMT/zstd-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/Rakefile

@@ -17,6 +17,12 @@ task :default => [:clobber, :compile, :spec]
 
 desc 'Sync zstd libs dirs to ext/zstdruby/libzstd'
 task :zstd_update do
-  FileUtils.rm_r('ext/zstdruby/libzstd')
-  FileUtils.cp_r('zstd/lib', 'ext/zstdruby/libzstd')
+  FileUtils.rm_r("ext/zstdruby/libzstd")
+  FileUtils.mkdir_p("ext/zstdruby/libzstd")
+  ["common", "compress", "decompress", "dictBuilder"].each do |dir|
+    FileUtils.cp_r("zstd/lib/#{dir}", "ext/zstdruby/libzstd/#{dir}")
+  end
+  FileUtils.cp_r('zstd/lib/zdict.h', 'ext/zstdruby/libzstd')
+  FileUtils.cp_r('zstd/lib/zstd.h', 'ext/zstdruby/libzstd')
+  FileUtils.cp_r('zstd/lib/zstd_errors.h', 'ext/zstdruby/libzstd')
 end

data/ext/zstdruby/common.h

@@ -0,0 +1,15 @@
+#ifndef ZSTD_RUBY_H
+#define ZSTD_RUBY_H 1
+
+#include "ruby.h"
+#include "./libzstd/zstd.h"
+
+static int convert_compression_level(VALUE compression_level_value)
+{
+  if (NIL_P(compression_level_value)) {
+    return ZSTD_CLEVEL_DEFAULT;
+  }
+  return NUM2INT(compression_level_value);
+}
+
+#endif /* ZSTD_RUBY_H */

data/ext/zstdruby/main.c

@@ -0,0 +1,14 @@
+#include <common.h>
+VALUE rb_mZstd;
+void zstd_ruby_init(void);
+void zstd_ruby_streaming_compress_init(void);
+void zstd_ruby_streaming_decompress_init(void);
+
+void
+Init_zstdruby(void)
+{
+  rb_mZstd = rb_define_module("Zstd");
+  zstd_ruby_init();
+  zstd_ruby_streaming_compress_init();
+  zstd_ruby_streaming_decompress_init();
+}

data/ext/zstdruby/streaming_compress.c

@@ -0,0 +1,177 @@
+#include <common.h>
+#include <streaming_compress.h>
+
+struct streaming_compress_t {
+  ZSTD_CCtx* ctx;
+  VALUE buf;
+  size_t buf_size;
+};
+
+static void
+streaming_compress_mark(void *p)
+{
+  struct streaming_compress_t *sc = p;
+  rb_gc_mark(sc->buf);
+}
+
+static void
+streaming_compress_free(void *p)
+{
+  struct streaming_compress_t *sc = p;
+  ZSTD_CCtx* ctx = sc->ctx;
+  if (ctx != NULL) {
+    ZSTD_freeCCtx(ctx);
+  }
+  xfree(sc);
+}
+
+static size_t
+streaming_compress_memsize(const void *p)
+{
+    return sizeof(struct streaming_compress_t);
+}
+
+static const rb_data_type_t streaming_compress_type = {
+    "streaming_compress",
+    { streaming_compress_mark, streaming_compress_free, streaming_compress_memsize, },
+     0, 0, RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+static VALUE
+rb_streaming_compress_allocate(VALUE klass)
+{
+  struct streaming_compress_t* sc;
+  VALUE obj = TypedData_Make_Struct(klass, struct streaming_compress_t, &streaming_compress_type, sc);
+  sc->ctx = NULL;
+  sc->buf = Qnil;
+  sc->buf_size = 0;
+  return obj;
+}
+
+static VALUE
+rb_streaming_compress_initialize(int argc, VALUE *argv, VALUE obj)
+{
+  VALUE compression_level_value;
+  rb_scan_args(argc, argv, "01", &compression_level_value);
+  int compression_level = convert_compression_level(compression_level_value);
+
+  struct streaming_compress_t* sc;
+  TypedData_Get_Struct(obj, struct streaming_compress_t, &streaming_compress_type, sc);
+  size_t const buffOutSize = ZSTD_CStreamOutSize();
+
+  ZSTD_CCtx* ctx = ZSTD_createCCtx();
+  if (ctx == NULL) {
+    rb_raise(rb_eRuntimeError, "%s", "ZSTD_createCCtx error");
+  }
+  ZSTD_CCtx_setParameter(ctx, ZSTD_c_compressionLevel, compression_level);
+  sc->ctx = ctx;
+  sc->buf = rb_str_new(NULL, buffOutSize);
+  sc->buf_size = buffOutSize;
+
+  return obj;
+}
+
+#define FIXNUMARG(val, ifnil) \
+    (NIL_P((val)) ? (ifnil) \
+    : (FIX2INT((val))))
+#define ARG_CONTINUE(val)     FIXNUMARG((val), ZSTD_e_continue)
+
+static VALUE
+no_compress(struct streaming_compress_t* sc, ZSTD_EndDirective endOp)
+{
+  ZSTD_inBuffer input = { NULL, 0, 0 };
+  const char* output_data = RSTRING_PTR(sc->buf);
+  VALUE result = rb_str_new(0, 0);
+  size_t ret;
+  do {
+    ZSTD_outBuffer output = { (void*)output_data, sc->buf_size, 0 };
+
+    size_t const ret = ZSTD_compressStream2(sc->ctx, &output, &input, endOp);
+    if (ZSTD_isError(ret)) {
+      rb_raise(rb_eRuntimeError, "flush error error code: %s", ZSTD_getErrorName(ret));
+    }
+    rb_str_cat(result, output.dst, output.pos);
+  } while (ret > 0);
+  return result;
+}
+
+static VALUE
+rb_streaming_compress_compress(VALUE obj, VALUE src)
+{
+  StringValue(src);
+  const char* input_data = RSTRING_PTR(src);
+  size_t input_size = RSTRING_LEN(src);
+  ZSTD_inBuffer input = { input_data, input_size, 0 };
+
+  struct streaming_compress_t* sc;
+  TypedData_Get_Struct(obj, struct streaming_compress_t, &streaming_compress_type, sc);
+  const char* output_data = RSTRING_PTR(sc->buf);
+  VALUE result = rb_str_new(0, 0);
+  while (input.pos < input.size) {
+    ZSTD_outBuffer output = { (void*)output_data, sc->buf_size, 0 };
+    size_t const ret = ZSTD_compressStream2(sc->ctx, &output, &input, ZSTD_e_continue);
+    if (ZSTD_isError(ret)) {
+      rb_raise(rb_eRuntimeError, "compress error error code: %s", ZSTD_getErrorName(ret));
+    }
+    rb_str_cat(result, output.dst, output.pos);
+  }
+  return result;
+}
+
+static VALUE
+rb_streaming_compress_addstr(VALUE obj, VALUE src)
+{
+  StringValue(src);
+  const char* input_data = RSTRING_PTR(src);
+  size_t input_size = RSTRING_LEN(src);
+  ZSTD_inBuffer input = { input_data, input_size, 0 };
+
+  struct streaming_compress_t* sc;
+  TypedData_Get_Struct(obj, struct streaming_compress_t, &streaming_compress_type, sc);
+  const char* output_data = RSTRING_PTR(sc->buf);
+
+  while (input.pos < input.size) {
+    ZSTD_outBuffer output = { (void*)output_data, sc->buf_size, 0 };
+    size_t const result = ZSTD_compressStream2(sc->ctx, &output, &input, ZSTD_e_continue);
+    if (ZSTD_isError(result)) {
+      rb_raise(rb_eRuntimeError, "compress error error code: %s", ZSTD_getErrorName(result));
+    }
+  }
+  return obj;
+}
+
+static VALUE
+rb_streaming_compress_flush(VALUE obj)
+{
+  struct streaming_compress_t* sc;
+  TypedData_Get_Struct(obj, struct streaming_compress_t, &streaming_compress_type, sc);
+  VALUE result = no_compress(sc, ZSTD_e_flush);
+  return result;
+}
+
+static VALUE
+rb_streaming_compress_finish(VALUE obj)
+{
+  struct streaming_compress_t* sc;
+  TypedData_Get_Struct(obj, struct streaming_compress_t, &streaming_compress_type, sc);
+  VALUE result = no_compress(sc, ZSTD_e_end);
+  return result;
+}
+
+extern VALUE rb_mZstd, cStreamingCompress;
+void
+zstd_ruby_streaming_compress_init(void)
+{
+  VALUE cStreamingCompress = rb_define_class_under(rb_mZstd, "StreamingCompress", rb_cObject);
+  rb_define_alloc_func(cStreamingCompress, rb_streaming_compress_allocate);
+  rb_define_method(cStreamingCompress, "initialize", rb_streaming_compress_initialize, -1);
+  rb_define_method(cStreamingCompress, "compress", rb_streaming_compress_compress, 1);
+  rb_define_method(cStreamingCompress, "<<", rb_streaming_compress_addstr, 1);
+  rb_define_method(cStreamingCompress, "flush", rb_streaming_compress_flush, 0);
+  rb_define_method(cStreamingCompress, "finish", rb_streaming_compress_finish, 0);
+
+  rb_define_const(cStreamingCompress, "CONTINUE", INT2FIX(ZSTD_e_continue));
+  rb_define_const(cStreamingCompress, "FLUSH", INT2FIX(ZSTD_e_flush));
+  rb_define_const(cStreamingCompress, "END", INT2FIX(ZSTD_e_end));
+}
+

data/ext/zstdruby/streaming_compress.h

@@ -0,0 +1,5 @@
+#if !defined(STREAMING_COMPRESS_H)
+#define STREAMING_COMPRESS_H
+
+
+#endif // STREAMING_COMPRESS_H

data/ext/zstdruby/streaming_decompress.c

@@ -0,0 +1,123 @@
+#include <common.h>
+
+struct streaming_decompress_t {
+  ZSTD_DCtx* ctx;
+  VALUE buf;
+  size_t buf_size;
+};
+
+static void
+streaming_decompress_mark(void *p)
+{
+  struct streaming_decompress_t *sd = p;
+  rb_gc_mark(sd->buf);
+}
+
+static void
+streaming_decompress_free(void *p)
+{
+  struct streaming_decompress_t *sd = p;
+  ZSTD_DCtx* ctx = sd->ctx;
+  if (ctx != NULL) {
+    ZSTD_freeDCtx(ctx);
+  }
+  xfree(sd);
+}
+
+static size_t
+streaming_decompress_memsize(const void *p)
+{
+    return sizeof(struct streaming_decompress_t);
+}
+
+static const rb_data_type_t streaming_decompress_type = {
+    "streaming_decompress",
+    { streaming_decompress_mark, streaming_decompress_free, streaming_decompress_memsize, },
+     0, 0, RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+static VALUE
+rb_streaming_decompress_allocate(VALUE klass)
+{
+  struct streaming_decompress_t* sd;
+  VALUE obj = TypedData_Make_Struct(klass, struct streaming_decompress_t, &streaming_decompress_type, sd);
+  sd->ctx = NULL;
+  sd->buf = Qnil;
+  sd->buf_size = 0;
+  return obj;
+}
+
+static VALUE
+rb_streaming_decompress_initialize(VALUE obj)
+{
+  struct streaming_decompress_t* sd;
+  TypedData_Get_Struct(obj, struct streaming_decompress_t, &streaming_decompress_type, sd);
+  size_t const buffOutSize = ZSTD_DStreamOutSize();
+
+  ZSTD_DCtx* ctx = ZSTD_createDCtx();
+  if (ctx == NULL) {
+    rb_raise(rb_eRuntimeError, "%s", "ZSTD_createDCtx error");
+  }
+  sd->ctx = ctx;
+  sd->buf = rb_str_new(NULL, buffOutSize);
+  sd->buf_size = buffOutSize;
+
+  return obj;
+}
+
+static VALUE
+rb_streaming_decompress_decompress(VALUE obj, VALUE src)
+{
+  StringValue(src);
+  const char* input_data = RSTRING_PTR(src);
+  size_t input_size = RSTRING_LEN(src);
+  ZSTD_inBuffer input = { input_data, input_size, 0 };
+
+  struct streaming_decompress_t* sd;
+  TypedData_Get_Struct(obj, struct streaming_decompress_t, &streaming_decompress_type, sd);
+  const char* output_data = RSTRING_PTR(sd->buf);
+  VALUE result = rb_str_new(0, 0);
+  while (input.pos < input.size) {
+    ZSTD_outBuffer output = { (void*)output_data, sd->buf_size, 0 };
+    size_t const ret = ZSTD_decompressStream(sd->ctx, &output, &input);
+    if (ZSTD_isError(ret)) {
+      rb_raise(rb_eRuntimeError, "compress error error code: %s", ZSTD_getErrorName(ret));
+    }
+    rb_str_cat(result, output.dst, output.pos);
+  }
+  return result;
+}
+
+static VALUE
+rb_streaming_decompress_addstr(VALUE obj, VALUE src)
+{
+  StringValue(src);
+  const char* input_data = RSTRING_PTR(src);
+  size_t input_size = RSTRING_LEN(src);
+  ZSTD_inBuffer input = { input_data, input_size, 0 };
+
+  struct streaming_decompress_t* sd;
+  TypedData_Get_Struct(obj, struct streaming_decompress_t, &streaming_decompress_type, sd);
+  const char* output_data = RSTRING_PTR(sd->buf);
+
+  while (input.pos < input.size) {
+    ZSTD_outBuffer output = { (void*)output_data, sd->buf_size, 0 };
+    size_t const result = ZSTD_decompressStream(sd->ctx, &output, &input);
+    if (ZSTD_isError(result)) {
+      rb_raise(rb_eRuntimeError, "compress error error code: %s", ZSTD_getErrorName(result));
+    }
+  }
+  return obj;
+}
+
+extern VALUE rb_mZstd, cStreamingDecompress;
+void
+zstd_ruby_streaming_decompress_init(void)
+{
+  VALUE cStreamingDecompress = rb_define_class_under(rb_mZstd, "StreamingDecompress", rb_cObject);
+  rb_define_alloc_func(cStreamingDecompress, rb_streaming_decompress_allocate);
+  rb_define_method(cStreamingDecompress, "initialize", rb_streaming_decompress_initialize, 0);
+  rb_define_method(cStreamingDecompress, "decompress", rb_streaming_decompress_decompress, 1);
+  rb_define_method(cStreamingDecompress, "<<", rb_streaming_decompress_addstr, 1);
+}
+

data/ext/zstdruby/zstdruby.c

@@ -1,5 +1,6 @@
-#include "zstdruby.h"
-#include "./libzstd/zstd.h"
+#include <common.h>
+
+extern VALUE rb_mZstd;
 
 static VALUE zstdVersion(VALUE self)
 {
@@ -7,41 +8,74 @@ static VALUE zstdVersion(VALUE self)
   return INT2NUM(version);
 }
 
-static VALUE compress(int argc, VALUE *argv, VALUE self)
+static VALUE rb_compress(int argc, VALUE *argv, VALUE self)
 {
   VALUE input_value;
   VALUE compression_level_value;
   rb_scan_args(argc, argv, "11", &input_value, &compression_level_value);
+  int compression_level = convert_compression_level(compression_level_value);
 
   StringValue(input_value);
-  const char* input_data = RSTRING_PTR(input_value);
+  char* input_data = RSTRING_PTR(input_value);
   size_t input_size = RSTRING_LEN(input_value);
+  size_t max_compressed_size = ZSTD_compressBound(input_size);
 
-  int compression_level;
-  if (NIL_P(compression_level_value)) {
-    compression_level = 0; // The default. See ZSTD_CLEVEL_DEFAULT in zstd_compress.c
-  } else {
-    compression_level = NUM2INT(compression_level_value);
+  VALUE output = rb_str_new(NULL, max_compressed_size);
+  char* output_data = RSTRING_PTR(output);
+  size_t compressed_size = ZSTD_compress((void*)output_data, max_compressed_size,
+                                         (void*)input_data, input_size, compression_level);
+  if (ZSTD_isError(compressed_size)) {
+    rb_raise(rb_eRuntimeError, "%s: %s", "compress failed", ZSTD_getErrorName(compressed_size));
   }
 
-  // do compress
+  rb_str_resize(output, compressed_size);
+  return output;
+}
+
+static VALUE rb_compress_using_dict(int argc, VALUE *argv, VALUE self)
+{
+  VALUE input_value;
+  VALUE dict;
+  VALUE compression_level_value;
+  rb_scan_args(argc, argv, "21", &input_value, &dict, &compression_level_value);
+  int compression_level = convert_compression_level(compression_level_value);
+
+  StringValue(input_value);
+  char* input_data = RSTRING_PTR(input_value);
+  size_t input_size = RSTRING_LEN(input_value);
   size_t max_compressed_size = ZSTD_compressBound(input_size);
 
+  char* dict_buffer = RSTRING_PTR(dict);
+  size_t dict_size = RSTRING_LEN(dict);
+
+  ZSTD_CDict* const cdict = ZSTD_createCDict(dict_buffer, dict_size, compression_level);
+  if (cdict == NULL) {
+    rb_raise(rb_eRuntimeError, "%s", "ZSTD_createCDict failed");
+  }
+  ZSTD_CCtx* const ctx = ZSTD_createCCtx();
+  if (ctx == NULL) {
+    ZSTD_freeCDict(cdict);
+    rb_raise(rb_eRuntimeError, "%s", "ZSTD_createCCtx failed");
+  }
+
   VALUE output = rb_str_new(NULL, max_compressed_size);
   char* output_data = RSTRING_PTR(output);
-
-  size_t compressed_size = ZSTD_compress((void*)output_data, max_compressed_size,
-                                         (const void*)input_data, input_size, compression_level);
+  size_t const compressed_size = ZSTD_compress_usingCDict(ctx, (void*)output_data, max_compressed_size,
+                                             (void*)input_data, input_size, cdict);
 
   if (ZSTD_isError(compressed_size)) {
+    ZSTD_freeCDict(cdict);
+    ZSTD_freeCCtx(ctx);
     rb_raise(rb_eRuntimeError, "%s: %s", "compress failed", ZSTD_getErrorName(compressed_size));
-  } else {
-    rb_str_resize(output, compressed_size);
   }
 
+  rb_str_resize(output, compressed_size);
+  ZSTD_freeCDict(cdict);
+  ZSTD_freeCCtx(ctx);
   return output;
 }
 
+
 static VALUE decompress_buffered(const char* input_data, size_t input_size)
 {
   const size_t outputBufferSize = 4096;
@@ -57,7 +91,6 @@ static VALUE decompress_buffered(const char* input_data, size_t input_size)
     rb_raise(rb_eRuntimeError, "%s: %s", "ZSTD_initDStream failed", ZSTD_getErrorName(initResult));
   }
 
-
   VALUE output_string = rb_str_new(NULL, 0);
   ZSTD_outBuffer output = { NULL, 0, 0 };
 
@@ -79,23 +112,24 @@ static VALUE decompress_buffered(const char* input_data, size_t input_size)
   return output_string;
 }
 
-static VALUE decompress(VALUE self, VALUE input)
+static VALUE rb_decompress(VALUE self, VALUE input_value)
 {
-  StringValue(input);
-  const char* input_data = RSTRING_PTR(input);
-  size_t input_size = RSTRING_LEN(input);
-
-  uint64_t uncompressed_size = ZSTD_getDecompressedSize(input_data, input_size);
+  StringValue(input_value);
+  char* input_data = RSTRING_PTR(input_value);
+  size_t input_size = RSTRING_LEN(input_value);
 
-  if (uncompressed_size == 0) {
+  unsigned long long const uncompressed_size = ZSTD_getFrameContentSize(input_data, input_size);
+  if (uncompressed_size == ZSTD_CONTENTSIZE_ERROR) {
+    rb_raise(rb_eRuntimeError, "%s: %s", "not compressed by zstd", ZSTD_getErrorName(uncompressed_size));
+  }
+  if (uncompressed_size == ZSTD_CONTENTSIZE_UNKNOWN) {
     return decompress_buffered(input_data, input_size);
   }
 
   VALUE output = rb_str_new(NULL, uncompressed_size);
   char* output_data = RSTRING_PTR(output);
-
-  size_t decompress_size = ZSTD_decompress((void*)output_data, uncompressed_size,
-                                           (const void*)input_data, input_size);
+  size_t const decompress_size = ZSTD_decompress((void*)output_data, uncompressed_size,
+                                           (void*)input_data, input_size);
 
   if (ZSTD_isError(decompress_size)) {
     rb_raise(rb_eRuntimeError, "%s: %s", "decompress error", ZSTD_getErrorName(decompress_size));
@@ -104,13 +138,61 @@ static VALUE decompress(VALUE self, VALUE input)
   return output;
 }
 
-VALUE rb_mZstd;
+static VALUE rb_decompress_using_dict(int argc, VALUE *argv, VALUE self)
+{
+  VALUE input_value;
+  VALUE dict;
+  rb_scan_args(argc, argv, "20", &input_value, &dict);
+
+  StringValue(input_value);
+  char* input_data = RSTRING_PTR(input_value);
+  size_t input_size = RSTRING_LEN(input_value);
+  unsigned long long const uncompressed_size = ZSTD_getFrameContentSize(input_data, input_size);
+  if (uncompressed_size == ZSTD_CONTENTSIZE_ERROR) {
+    rb_raise(rb_eRuntimeError, "%s: %s", "not compressed by zstd", ZSTD_getErrorName(uncompressed_size));
+  }
+  if (uncompressed_size == ZSTD_CONTENTSIZE_UNKNOWN) {
+    return decompress_buffered(input_data, input_size);
+  }
+  VALUE output = rb_str_new(NULL, uncompressed_size);
+  char* output_data = RSTRING_PTR(output);
+
+  char* dict_buffer = RSTRING_PTR(dict);
+  size_t dict_size = RSTRING_LEN(dict);
+  ZSTD_DDict* const ddict = ZSTD_createDDict(dict_buffer, dict_size);
+  if (ddict == NULL) {
+    rb_raise(rb_eRuntimeError, "%s", "ZSTD_createDDict failed");
+  }
+
+  unsigned const expected_dict_id = ZSTD_getDictID_fromDDict(ddict);
+  unsigned const actual_dict_id = ZSTD_getDictID_fromFrame(input_data, input_size);
+  if (expected_dict_id != actual_dict_id) {
+    ZSTD_freeDDict(ddict);
+    rb_raise(rb_eRuntimeError, "%s: %s", "DictID mismatch", ZSTD_getErrorName(uncompressed_size));
+  }
+
+  ZSTD_DCtx* const ctx = ZSTD_createDCtx();
+  if (ctx == NULL) {
+    ZSTD_freeDDict(ddict);
+    rb_raise(rb_eRuntimeError, "%s", "ZSTD_createDCtx failed");
+  }
+  size_t const decompress_size = ZSTD_decompress_usingDDict(ctx, output_data, uncompressed_size, input_data, input_size, ddict);
+  if (ZSTD_isError(decompress_size)) {
+    ZSTD_freeDDict(ddict);
+    ZSTD_freeDCtx(ctx);
+    rb_raise(rb_eRuntimeError, "%s: %s", "decompress error", ZSTD_getErrorName(decompress_size));
+  }
+  ZSTD_freeDDict(ddict);
+  ZSTD_freeDCtx(ctx);
+  return output;
+}
 
 void
-Init_zstdruby(void)
+zstd_ruby_init(void)
 {
-  rb_mZstd = rb_define_module("Zstd");
   rb_define_module_function(rb_mZstd, "zstd_version", zstdVersion, 0);
-  rb_define_module_function(rb_mZstd, "compress", compress, -1);
-  rb_define_module_function(rb_mZstd, "decompress", decompress, 1);
+  rb_define_module_function(rb_mZstd, "compress", rb_compress, -1);
+  rb_define_module_function(rb_mZstd, "compress_using_dict", rb_compress_using_dict, -1);
+  rb_define_module_function(rb_mZstd, "decompress", rb_decompress, 1);
+  rb_define_module_function(rb_mZstd, "decompress_using_dict", rb_decompress_using_dict, -1);
 }

data/lib/zstd-ruby/version.rb

@@ -1,3 +1,3 @@
 module Zstd
-  VERSION = "1.5.2.0"
+  VERSION = "1.5.2.3"
 end

data/lib/zstd-ruby.rb

@@ -2,5 +2,4 @@ require "zstd-ruby/version"
 require "zstd-ruby/zstdruby"
 
 module Zstd
-  # Your code goes here...
 end