zstd-ruby 1.5.4.0 → 1.5.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5025a83454e6841492b428638df26d5bbacfae564e3e0dcaabce5955e2bd3688
-  data.tar.gz: f50bf1bb09958e116917344fddaa8bf1d45088894769d791bbe3664a74a3b907
+  metadata.gz: 20843652df6bf499ef8cbf75a75e9b9c2bf1a445d7dc1ae9fc48faa07e8af768
+  data.tar.gz: 52939d134568bf22f7633a28624ebb1574b72cc33711759c62da8a7971828a57
 SHA512:
-  metadata.gz: c754293689a65269f3f262605ad07cd72c0e162dde804dab2d0e144b67c251cbeaf5306db451ac15878388113617d09aaef5c065349c893b233804d6f0883812
-  data.tar.gz: f2bc576e57766984c1d81e05f69a499461ffc437383f084d6cd83f22f3621f368a9ee668ad786165d537780112b42ade0c7d3e43b8fb35ac77634fbbad12d5c8
+  metadata.gz: 4eee9c6badff4d9cbd516b94ec5ec488bff58d25a59ec9a6de9e7aa5afcb117b8eb6e69bc319e9dd8a8f69b8c5dbd1504e0001cf7e312b27fad8c0ed63bdcf64
+  data.tar.gz: 518fffdbde3535b6e104d0733529db99db98304b99f3b0cc5d27edfabfe3c5922d05d0e0e4cb7cf1bc051dfb4651a886921b3faf5a61b24dec2a99f472150551

data/README.md

@@ -10,7 +10,7 @@ See https://github.com/facebook/zstd
 Fork from https://github.com/jarredholman/ruby-zstd.
 
 ## Zstd version
-v1.5.2 (https://github.com/facebook/zstd/tree/v1.5.2)
+v1.5.4 (https://github.com/facebook/zstd/tree/v1.5.4)
 
 ## Installation
 
@@ -87,6 +87,14 @@ result << stream.decompress(cstr[0, 10])
 result << stream.decompress(cstr[10..-1])
 ```
 
+### Skippable flame
+
+```ruby
+compressed_data_with_skippable_frame = Zstd.write_skippable_frame(compressed_data, "sample data")
+
+Zstd.read_skippable_frame(compressed_data_with_skippable_frame)
+# => "sample data"
+```
 
 ## JRuby
 This gem does not support JRuby.

data/ext/zstdruby/extconf.rb

@@ -1,6 +1,6 @@
 require "mkmf"
 
-$CFLAGS = '-I. -O3 -std=c99'
+$CFLAGS = '-I. -O3 -std=c99 -DZSTD_STATIC_LINKING_ONLY'
 $CPPFLAGS += " -fdeclspec" if CONFIG['CXX'] =~ /clang/
 
 Dir.chdir File.expand_path('..', __FILE__) do

data/ext/zstdruby/main.c

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

data/ext/zstdruby/skippable_frame.c

@@ -0,0 +1,63 @@
+#include <common.h>
+
+extern VALUE rb_mZstd;
+
+static VALUE rb_write_skippable_frame(int argc, VALUE *argv, VALUE self)
+{
+  VALUE input_value;
+  VALUE skip_value;
+  VALUE kwargs;
+  rb_scan_args(argc, argv, "2:", &input_value, &skip_value, &kwargs);
+
+  ID kwargs_keys[1];
+  kwargs_keys[0] = rb_intern("magic_variant");
+  VALUE kwargs_values[1];
+  rb_get_kwargs(kwargs, kwargs_keys, 0, 1, kwargs_values);
+  unsigned magic_variant = (kwargs_values[0] != Qundef) ? (NUM2INT(kwargs_values[0])) : 0;
+
+  StringValue(input_value);
+  StringValue(skip_value);
+  char* input_data = RSTRING_PTR(input_value);
+  size_t input_size = RSTRING_LEN(input_value);
+  char* skip_data = RSTRING_PTR(skip_value);
+  size_t skip_size = RSTRING_LEN(skip_value);
+
+  size_t dst_size = input_size + ZSTD_SKIPPABLEHEADERSIZE + skip_size;
+  VALUE output = rb_str_new(input_data, dst_size);
+  char* output_data = RSTRING_PTR(output);
+  size_t output_size = ZSTD_writeSkippableFrame((void*)output_data, dst_size, (const void*)skip_data, skip_size, magic_variant);
+  if (ZSTD_isError(output_size)) {
+    rb_raise(rb_eRuntimeError, "%s: %s", "write skippable frame failed", ZSTD_getErrorName(output_size));
+  }
+
+  rb_str_resize(output, output_size);
+  return output;
+}
+
+static VALUE rb_read_skippable_frame(VALUE self, VALUE input_value)
+{
+  char* input_data = RSTRING_PTR(input_value);
+  size_t input_size = RSTRING_LEN(input_value);
+
+  if (ZSTD_isSkippableFrame(input_data, input_size) == 0) {
+    return Qnil;
+  }
+  // ref https://github.com/facebook/zstd/blob/321490cd5b9863433b3d44816d04012874e5ecdb/tests/fuzzer.c#L2096
+  size_t const skipLen = 129 * 1024;
+  VALUE output = rb_str_new(NULL, skipLen);
+  char* output_data = RSTRING_PTR(output);
+  unsigned readMagic;
+  size_t output_size = ZSTD_readSkippableFrame((void*)output_data, skipLen, &readMagic, (const void*)input_data, input_size);
+  if (ZSTD_isError(output_size)) {
+    rb_raise(rb_eRuntimeError, "%s: %s", "read skippable frame failed", ZSTD_getErrorName(output_size));
+  }
+  rb_str_resize(output, output_size);
+  return output;
+}
+
+void
+zstd_ruby_skippable_frame_init(void)
+{
+  rb_define_module_function(rb_mZstd, "write_skippable_frame", rb_write_skippable_frame, -1);
+  rb_define_module_function(rb_mZstd, "read_skippable_frame", rb_read_skippable_frame, 1);
+}

data/lib/zstd-ruby/version.rb

@@ -1,3 +1,3 @@
 module Zstd
-  VERSION = "1.5.4.0"
+  VERSION = "1.5.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zstd-ruby
 version: !ruby/object:Gem::Version
-  version: 1.5.4.0
+  version: 1.5.4.1
 platform: ruby
 authors:
 - SpringMT
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,7 @@ files:
 - ext/zstdruby/libzstd/zstd.h
 - ext/zstdruby/libzstd/zstd_errors.h
 - ext/zstdruby/main.c
+- ext/zstdruby/skippable_frame.c
 - ext/zstdruby/streaming_compress.c
 - ext/zstdruby/streaming_compress.h
 - ext/zstdruby/streaming_decompress.c