ruby-brs 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 779dc2709fa1dc4c1316cafb41ec7ca289ddab6e3e93302c8c9d730d5e13062c
-  data.tar.gz: b9e44118ae67ccc3ddc80a4976c946ef1b4d0801192b5b2f7f286bbf7b6f1446
+  metadata.gz: 76cee1124501f374a5f27ca52ecd1b632058bfb3136e2fa3c1f447ae292d9f23
+  data.tar.gz: 4436a321a655174132a371e8140a892f18fcd365efbd4fd3da4ee2f1683d2c19
 SHA512:
-  metadata.gz: fd2f3127fa61d8e5d1523c331edbb96823976622d81ba61ff4d10965ed9f536773a2abbea59c3fd1a03b9d6df9b4fbe9662a0d47cdaed5aa19e481544cc9952a
-  data.tar.gz: d487532c19995e7307f68b1b5ccc091e9445e02b8a53c3c9039765e8fbb6dd11960563d6860aaba236dc7b7b424674d12f471163cd52940511dbd4803799a250
+  metadata.gz: 1b9d0d1bead338ba24ee95dad6c6387a8ab31bb1e037147d4c15955176eaf1314120b1c0ced1bc68dc6c7c498ade16b22be90f0d89b76eaf31542c48c562ac09
+  data.tar.gz: 470a2e6fab1f66d787d92dc352094f2c34e9c0f788545bc08a3643e3cc4faa6369804c24ec5499666894b130600630e9455b70f5c0b2c9b38148eb979111f188

data/README.md

@@ -1,13 +1,14 @@
 # Ruby bindings for brotli library
 
-[![Travis build status](https://travis-ci.org/andrew-aladev/ruby-brs.svg?branch=master)](https://travis-ci.org/andrew-aladev/ruby-brs)
-[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-brs?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-brs/branch/master)
+| Travis | AppVeyor | Cirrus | Circle |
+| :---:  | :---:    | :---:  | :---:  |
+| [![Travis test status](https://travis-ci.com/andrew-aladev/ruby-brs.svg?branch=master)](https://travis-ci.com/andrew-aladev/ruby-brs) | [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-brs?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-brs/branch/master) | [![Cirrus test status](https://api.cirrus-ci.com/github/andrew-aladev/ruby-brs.svg?branch=master)](https://cirrus-ci.com/github/andrew-aladev/ruby-brs) | [![Circle test status](https://circleci.com/gh/andrew-aladev/ruby-brs/tree/master.svg?style=shield)](https://circleci.com/gh/andrew-aladev/ruby-brs/tree/master) |
 
 See [brotli library](https://github.com/google/brotli).
 
 ## Installation
 
-Please install brotli library first.
+Please install brotli library first, use latest 1.0.0+ version.
 
 ```sh
 gem install ruby-brs
@@ -79,25 +80,25 @@ Values: 0 - infinity, default value: 0.
 :mode
 ```
 
-Values: [`:text`, `:font`, `:generic`], default value: `:generic`.
+Values: `BRS::Option::MODES`, default value: `:generic`.
 
 ```
 :quality
 ```
 
-Values: 0 - 11, default value: 11.
+Values: `BRS::Option::MIN_QUALITY` - `BRS::Option::MAX_QUALITY`, default value: `BRS::Option::MAX_QUALITY`.
 
 ```
 :lgwin
 ```
 
-Values: 10 - 24, default value: 22.
+Values: `BRS::Option::MIN_LGWIN` - `BRS::Option::MAX_LGWIN`, default value: `22`.
 
 ```
 :lgblock
 ```
 
-Values: 16 - 24, default value: none.
+Values: `BRS::Option::MIN_LGBLOCK` - `BRS::Option::MAX_LGBLOCK`, default value: none.
 
 ```
 :disable_literal_context_modeling
@@ -116,6 +117,8 @@ Values: true/false, default value: false.
 ```
 
 Values: 0 - infinity, default value: 0.
+It is reasonable to provide size of input (if known) for streaming api.
+`String` and `File` will set `:size_hint` automaticaly.
 
 ```
 :large_window
@@ -151,7 +154,7 @@ data = BRS::String.compress "sample string", :quality => 5
 puts BRS::String.decompress(data, :disable_ring_buffer_reallocation => true)
 ```
 
-Default options are compatible with HTTP (`Content-Encoding: br`):
+HTTP encoding (`Content-Encoding: br`) using default options:
 
 ```ruby
 require "brs"
@@ -198,6 +201,8 @@ Writer maintains destination buffer only, so it accepts `destination_buffer_leng
 Open file path and create stream writer associated with opened file.
 Data will be transcoded to `:external_encoding` using `:transcode_options` before compressing.
 
+It may be tricky to use both `:size_hint` and `:transcode_options`. You have to provide size of transcoded input.
+
 ```
 ::new(destination_io, options = {}, :external_encoding => nil, :transcode_options => {})
 ```
@@ -205,6 +210,8 @@ Data will be transcoded to `:external_encoding` using `:transcode_options` befor
 Create stream writer associated with destination io.
 Data will be transcoded to `:external_encoding` using `:transcode_options` before compressing.
 
+It may be tricky to use both `:size_hint` and `:transcode_options`. You have to provide size of transcoded input.
+
 ```
 #set_encoding(external_encoding, nil, transcode_options)
 ```
@@ -334,6 +341,12 @@ See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
 
 Typical helpers, see [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
 
+## CI
+
+Travis and Appveyor CI uses [scripts/ci_test.sh](scripts/ci_test.sh) directly.
+Cirrus and Circle CI uses prebuilt [scripts/test-images](scripts/test-images).
+Cirrus CI uses amd64 image, Circle CI - i686.
+
 ## License
 
 MIT license, see LICENSE and AUTHORS.

data/ext/brs_ext/buffer.c

@@ -5,12 +5,24 @@
 
 #include "ruby.h"
 
+VALUE brs_ext_create_string_buffer(VALUE length)
+{
+  return rb_str_new(NULL, NUM2SIZET(length));
+}
+
+VALUE brs_ext_resize_string_buffer(VALUE args)
+{
+  VALUE buffer = rb_ary_entry(args, 0);
+  VALUE length = rb_ary_entry(args, 1);
+  return rb_str_resize(buffer, NUM2SIZET(length));
+}
+
 void brs_ext_buffer_exports(VALUE root_module)
 {
-  VALUE option = rb_define_module_under(root_module, "Buffer");
+  VALUE module = rb_define_module_under(root_module, "Buffer");
 
-  rb_define_const(option, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR", UINT2NUM(BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR));
-  rb_define_const(option, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR", UINT2NUM(BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR));
-  rb_define_const(option, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR", UINT2NUM(BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR));
-  rb_define_const(option, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR", UINT2NUM(BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR));
+  rb_define_const(module, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR", SIZET2NUM(BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR));
+  rb_define_const(module, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR", SIZET2NUM(BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR));
+  rb_define_const(module, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR", SIZET2NUM(BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR));
+  rb_define_const(module, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR", SIZET2NUM(BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR));
 }

data/ext/brs_ext/buffer.h

@@ -12,6 +12,18 @@
 #define BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR (1 << 16)      // 64 KB
 #define BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR (1 << 18) // 256 KB
 
+VALUE brs_ext_create_string_buffer(VALUE length);
+
+#define BRS_EXT_CREATE_STRING_BUFFER(buffer, length, exception) \
+  VALUE buffer = rb_protect(brs_ext_create_string_buffer, SIZET2NUM(length), &exception);
+
+VALUE brs_ext_resize_string_buffer(VALUE args);
+
+#define BRS_EXT_RESIZE_STRING_BUFFER(buffer, length, exception)            \
+  VALUE args = rb_ary_new_from_args(2, buffer, SIZET2NUM(length));         \
+  buffer     = rb_protect(brs_ext_resize_string_buffer, args, &exception); \
+  RB_GC_GUARD(args);
+
 void brs_ext_buffer_exports(VALUE root_module);
 
 #endif // BRS_EXT_BUFFER_H

data/ext/brs_ext/error.c

@@ -47,9 +47,9 @@ static inline NORETURN(void raise(const char* name, const char* description))
   rb_raise(error, "%s", description);
 }
 
-void brs_ext_raise_error(brs_ext_result_t result)
+void brs_ext_raise_error(brs_ext_result_t ext_result)
 {
-  switch (result) {
+  switch (ext_result) {
     case BRS_EXT_ERROR_ALLOCATE_FAILED:
       raise("AllocateError", "allocate error");
     case BRS_EXT_ERROR_VALIDATE_FAILED:

data/ext/brs_ext/error.h

@@ -29,6 +29,6 @@ enum {
 
 brs_ext_result_t brs_ext_get_decompressor_error(BrotliDecoderErrorCode error_code);
 
-NORETURN(void brs_ext_raise_error(brs_ext_result_t result));
+NORETURN(void brs_ext_raise_error(brs_ext_result_t ext_result));
 
 #endif // BRS_EXT_ERROR_H

data/ext/brs_ext/io.c

@@ -5,6 +5,7 @@
 
 #include <brotli/decode.h>
 #include <brotli/encode.h>
+#include <brotli/types.h>
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -116,29 +117,43 @@ static inline brs_ext_result_t read_more_source(
   return 0;
 }
 
-#define BUFFERED_READ_SOURCE(function, ...)                \
-  while (true) {                                           \
-    ext_result = function(__VA_ARGS__);                    \
-    if (ext_result != 0) {                                 \
-      return ext_result;                                   \
-    }                                                      \
-                                                           \
-    ext_result = read_more_source(                         \
-      source_file,                                         \
-      &source, &source_length,                             \
-      source_buffer, source_buffer_length);                \
-                                                           \
-    if (ext_result == BRS_EXT_FILE_READ_FINISHED) {        \
-      if (source_length != 0) {                            \
-        /* Brotli wont provide any remainder by design. */ \
-        return BRS_EXT_ERROR_READ_IO;                      \
-      }                                                    \
-      break;                                               \
-    }                                                      \
-    else if (ext_result != 0) {                            \
-      return ext_result;                                   \
-    }                                                      \
-  }
+#define BUFFERED_READ_SOURCE(function, ...)                   \
+  do {                                                        \
+    bool is_function_called = false;                          \
+                                                              \
+    while (true) {                                            \
+      ext_result = read_more_source(                          \
+        source_file,                                          \
+        &source, &source_length,                              \
+        source_buffer, source_buffer_length);                 \
+                                                              \
+      if (ext_result == BRS_EXT_FILE_READ_FINISHED) {         \
+        if (source_length != 0) {                             \
+          /* Brotli won't provide any remainder by design. */ \
+          return BRS_EXT_ERROR_READ_IO;                       \
+        }                                                     \
+        break;                                                \
+      }                                                       \
+      else if (ext_result != 0) {                             \
+        return ext_result;                                    \
+      }                                                       \
+                                                              \
+      ext_result = function(__VA_ARGS__);                     \
+      if (ext_result != 0) {                                  \
+        return ext_result;                                    \
+      }                                                       \
+                                                              \
+      is_function_called = true;                              \
+    }                                                         \
+                                                              \
+    if (!is_function_called) {                                \
+      /* Function should be called at least once. */          \
+      ext_result = function(__VA_ARGS__);                     \
+      if (ext_result != 0) {                                  \
+        return ext_result;                                    \
+      }                                                       \
+    }                                                         \
+  } while (false);
 
 // Algorithm has written data into destination buffer.
 // We need to write this data into file.
@@ -192,6 +207,7 @@ static inline brs_ext_result_t buffered_compress(
   const uint8_t** source_ptr, size_t* source_length_ptr,
   FILE* destination_file, uint8_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
 {
+  BROTLI_BOOL      result;
   brs_ext_result_t ext_result;
 
   while (true) {
@@ -199,7 +215,7 @@ static inline brs_ext_result_t buffered_compress(
     size_t   remaining_destination_buffer_length      = destination_buffer_length - *destination_length_ptr;
     size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
 
-    BROTLI_BOOL result = BrotliEncoderCompressStream(
+    result = BrotliEncoderCompressStream(
       state_ptr,
       BROTLI_OPERATION_PROCESS,
       source_length_ptr, source_ptr,
@@ -234,6 +250,7 @@ static inline brs_ext_result_t buffered_compressor_finish(
   BrotliEncoderState* state_ptr,
   FILE* destination_file, uint8_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
 {
+  BROTLI_BOOL      result;
   brs_ext_result_t ext_result;
 
   const uint8_t* source        = NULL;
@@ -244,7 +261,7 @@ static inline brs_ext_result_t buffered_compressor_finish(
     size_t   remaining_destination_buffer_length      = destination_buffer_length - *destination_length_ptr;
     size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
 
-    BROTLI_BOOL result = BrotliEncoderCompressStream(
+    result = BrotliEncoderCompressStream(
       state_ptr,
       BROTLI_OPERATION_FINISH,
       &source_length, &source,
@@ -368,14 +385,15 @@ static inline brs_ext_result_t buffered_decompress(
   const uint8_t** source_ptr, size_t* source_length_ptr,
   FILE* destination_file, uint8_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
 {
-  brs_ext_result_t ext_result;
+  BrotliDecoderResult result;
+  brs_ext_result_t    ext_result;
 
   while (true) {
     uint8_t* remaining_destination_buffer             = destination_buffer + *destination_length_ptr;
     size_t   remaining_destination_buffer_length      = destination_buffer_length - *destination_length_ptr;
     size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
 
-    BrotliDecoderResult result = BrotliDecoderDecompressStream(
+    result = BrotliDecoderDecompressStream(
       state_ptr,
       source_length_ptr, source_ptr,
       &remaining_destination_buffer_length, &remaining_destination_buffer,

data/ext/brs_ext/option.c

@@ -6,12 +6,14 @@
 #include <brotli/decode.h>
 #include <brotli/encode.h>
 #include <stdbool.h>
-#include <stdint.h>
+#include <stdlib.h>
 
 #include "brs_ext/common.h"
 #include "brs_ext/error.h"
 #include "ruby.h"
 
+// -- values --
+
 static inline VALUE get_raw_option_value(VALUE options, const char* name)
 {
   return rb_funcall(options, rb_intern("[]"), 1, ID2SYM(rb_intern(name)));
@@ -27,14 +29,14 @@ static inline bool get_bool_option_value(VALUE raw_value)
   return raw_type == T_TRUE;
 }
 
-static inline unsigned long get_fixnum_option_value(VALUE raw_value)
+static inline unsigned int get_uint_option_value(VALUE raw_value)
 {
   Check_Type(raw_value, T_FIXNUM);
 
   return NUM2UINT(raw_value);
 }
 
-static inline uint_fast8_t get_mode_option_value(VALUE raw_value)
+static inline BrotliEncoderMode get_mode_option_value(VALUE raw_value)
 {
   Check_Type(raw_value, T_SYMBOL);
 
@@ -68,8 +70,8 @@ void brs_ext_get_option(VALUE options, brs_ext_option_t* option, brs_ext_option_
     case BRS_EXT_OPTION_TYPE_BOOL:
       value = get_bool_option_value(raw_value) ? 1 : 0;
       break;
-    case BRS_EXT_OPTION_TYPE_FIXNUM:
-      value = (brs_ext_option_value_t)get_fixnum_option_value(raw_value);
+    case BRS_EXT_OPTION_TYPE_UINT:
+      value = (brs_ext_option_value_t)get_uint_option_value(raw_value);
       break;
     case BRS_EXT_OPTION_TYPE_MODE:
       value = (brs_ext_option_value_t)get_mode_option_value(raw_value);
@@ -81,13 +83,17 @@ void brs_ext_get_option(VALUE options, brs_ext_option_t* option, brs_ext_option_
   option->value = value;
 }
 
-unsigned long brs_ext_get_fixnum_option_value(VALUE options, const char* name)
+size_t brs_ext_get_size_option_value(VALUE options, const char* name)
 {
   VALUE raw_value = get_raw_option_value(options, name);
 
-  return get_fixnum_option_value(raw_value);
+  Check_Type(raw_value, T_FIXNUM);
+
+  return NUM2SIZET(raw_value);
 }
 
+// -- set params --
+
 #define SET_OPTION_VALUE(function, state_ptr, param, option)           \
   if (option.has_value && !function(state_ptr, param, option.value)) { \
     return BRS_EXT_ERROR_VALIDATE_FAILED;                              \
@@ -120,24 +126,25 @@ brs_ext_result_t brs_ext_set_decompressor_options(BrotliDecoderState* state_ptr,
   return 0;
 }
 
+// -- exports --
+
+#define EXPORT_PARAM_BOUNDS(module, param, name)                      \
+  rb_define_const(module, "MIN_" name, UINT2NUM(BROTLI_MIN_##param)); \
+  rb_define_const(module, "MAX_" name, UINT2NUM(BROTLI_MAX_##param));
+
 void brs_ext_option_exports(VALUE root_module)
 {
-  VALUE option = rb_define_module_under(root_module, "Option");
+  VALUE module = rb_define_module_under(root_module, "Option");
 
   VALUE modes = rb_ary_new_from_args(
     3,
     ID2SYM(rb_intern("text")),
     ID2SYM(rb_intern("font")),
     ID2SYM(rb_intern("generic")));
-  rb_define_const(option, "MODES", modes);
+  rb_define_const(module, "MODES", modes);
   RB_GC_GUARD(modes);
 
-  rb_define_const(option, "MIN_QUALITY", UINT2NUM(BROTLI_MIN_QUALITY));
-  rb_define_const(option, "MAX_QUALITY", UINT2NUM(BROTLI_MAX_QUALITY));
-
-  rb_define_const(option, "MIN_LGWIN", UINT2NUM(BROTLI_MIN_WINDOW_BITS));
-  rb_define_const(option, "MAX_LGWIN", UINT2NUM(BROTLI_MAX_WINDOW_BITS));
-
-  rb_define_const(option, "MIN_LGBLOCK", UINT2NUM(BROTLI_MIN_INPUT_BLOCK_BITS));
-  rb_define_const(option, "MAX_LGBLOCK", UINT2NUM(BROTLI_MAX_INPUT_BLOCK_BITS));
+  EXPORT_PARAM_BOUNDS(module, QUALITY, "QUALITY");
+  EXPORT_PARAM_BOUNDS(module, WINDOW_BITS, "LGWIN");
+  EXPORT_PARAM_BOUNDS(module, INPUT_BLOCK_BITS, "LGBLOCK");
 }

data/ext/brs_ext/option.h

@@ -18,7 +18,7 @@
 
 enum {
   BRS_EXT_OPTION_TYPE_BOOL = 1,
-  BRS_EXT_OPTION_TYPE_FIXNUM,
+  BRS_EXT_OPTION_TYPE_UINT,
   BRS_EXT_OPTION_TYPE_MODE
 };
 
@@ -54,11 +54,11 @@ void brs_ext_get_option(VALUE options, brs_ext_option_t* option, brs_ext_option_
   brs_ext_compressor_options_t compressor_options;                                                             \
                                                                                                                \
   BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_MODE, mode);                             \
-  BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_FIXNUM, quality);                        \
-  BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_FIXNUM, lgwin);                          \
-  BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_FIXNUM, lgblock);                        \
+  BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, quality);                          \
+  BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, lgwin);                            \
+  BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, lgblock);                          \
   BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_BOOL, disable_literal_context_modeling); \
-  BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_FIXNUM, size_hint);                      \
+  BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, size_hint);                        \
   BRS_EXT_GET_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_BOOL, large_window);
 
 #define BRS_EXT_GET_DECOMPRESSOR_OPTIONS(options)                                                                \
@@ -67,10 +67,10 @@ void brs_ext_get_option(VALUE options, brs_ext_option_t* option, brs_ext_option_
   BRS_EXT_GET_OPTION(options, decompressor_options, BRS_EXT_OPTION_TYPE_BOOL, disable_ring_buffer_reallocation); \
   BRS_EXT_GET_OPTION(options, decompressor_options, BRS_EXT_OPTION_TYPE_BOOL, large_window);
 
-unsigned long brs_ext_get_fixnum_option_value(VALUE options, const char* name);
+size_t brs_ext_get_size_option_value(VALUE options, const char* name);
 
 #define BRS_EXT_GET_BUFFER_LENGTH_OPTION(options, name) \
-  size_t name = brs_ext_get_fixnum_option_value(options, #name);
+  size_t name = brs_ext_get_size_option_value(options, #name);
 
 brs_ext_result_t brs_ext_set_compressor_options(BrotliEncoderState* state_ptr, brs_ext_compressor_options_t* options);
 brs_ext_result_t brs_ext_set_decompressor_options(BrotliDecoderState* state_ptr, brs_ext_decompressor_options_t* options);

data/ext/brs_ext/stream/compressor.c

@@ -4,6 +4,7 @@
 #include "brs_ext/stream/compressor.h"
 
 #include <brotli/encode.h>
+#include <brotli/types.h>
 #include <stdint.h>
 #include <stdlib.h>
 
@@ -116,7 +117,7 @@ VALUE brs_ext_compress(VALUE self, VALUE source_value)
     brs_ext_raise_error(BRS_EXT_ERROR_UNEXPECTED);
   }
 
-  VALUE bytes_written          = UINT2NUM(source_length - remaining_source_length);
+  VALUE bytes_written          = SIZET2NUM(source_length - remaining_source_length);
   VALUE needs_more_destination = BrotliEncoderHasMoreOutput(state_ptr) ? Qtrue : Qfalse;
 
   return rb_ary_new_from_args(2, bytes_written, needs_more_destination);
@@ -221,9 +222,10 @@ VALUE brs_ext_compressor_close(VALUE self)
 
 void brs_ext_compressor_exports(VALUE root_module)
 {
-  VALUE stream = rb_define_module_under(root_module, "Stream");
+  VALUE module = rb_define_module_under(root_module, "Stream");
+
+  VALUE compressor = rb_define_class_under(module, "NativeCompressor", rb_cObject);
 
-  VALUE compressor = rb_define_class_under(stream, "NativeCompressor", rb_cObject);
   rb_define_alloc_func(compressor, brs_ext_allocate_compressor);
   rb_define_method(compressor, "initialize", brs_ext_initialize_compressor, 1);
   rb_define_method(compressor, "write", brs_ext_compress, 1);

data/ext/brs_ext/stream/decompressor.c

@@ -117,10 +117,10 @@ VALUE brs_ext_decompress(VALUE self, VALUE source_value)
     brs_ext_raise_error(brs_ext_get_decompressor_error(error_code));
   }
 
-  VALUE bytes_written          = UINT2NUM(source_length - remaining_source_length);
+  VALUE bytes_read             = SIZET2NUM(source_length - remaining_source_length);
   VALUE needs_more_destination = result == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT ? Qtrue : Qfalse;
 
-  return rb_ary_new_from_args(2, bytes_written, needs_more_destination);
+  return rb_ary_new_from_args(2, bytes_read, needs_more_destination);
 }
 
 VALUE brs_ext_decompressor_read_result(VALUE self)
@@ -170,9 +170,10 @@ VALUE brs_ext_decompressor_close(VALUE self)
 
 void brs_ext_decompressor_exports(VALUE root_module)
 {
-  VALUE stream = rb_define_module_under(root_module, "Stream");
+  VALUE module = rb_define_module_under(root_module, "Stream");
+
+  VALUE decompressor = rb_define_class_under(module, "NativeDecompressor", rb_cObject);
 
-  VALUE decompressor = rb_define_class_under(stream, "NativeDecompressor", rb_cObject);
   rb_define_alloc_func(decompressor, brs_ext_allocate_decompressor);
   rb_define_method(decompressor, "initialize", brs_ext_initialize_decompressor, 1);
   rb_define_method(decompressor, "read", brs_ext_decompress, 1);

data/ext/brs_ext/string.c

@@ -5,6 +5,7 @@
 
 #include <brotli/decode.h>
 #include <brotli/encode.h>
+#include <brotli/types.h>
 #include <stdint.h>
 #include <stdlib.h>
 
@@ -17,26 +18,6 @@
 
 // -- buffer --
 
-static inline VALUE create_buffer(VALUE length)
-{
-  return rb_str_new(NULL, NUM2UINT(length));
-}
-
-#define CREATE_BUFFER(buffer, length, exception) \
-  VALUE buffer = rb_protect(create_buffer, UINT2NUM(length), &exception);
-
-static inline VALUE resize_buffer(VALUE args)
-{
-  VALUE buffer = rb_ary_entry(args, 0);
-  VALUE length = rb_ary_entry(args, 1);
-  return rb_str_resize(buffer, NUM2UINT(length));
-}
-
-#define RESIZE_BUFFER(buffer, length, exception)                                        \
-  VALUE resize_buffer_args = rb_ary_new_from_args(2, buffer, UINT2NUM(length));         \
-  buffer                   = rb_protect(resize_buffer, resize_buffer_args, &exception); \
-  RB_GC_GUARD(resize_buffer_args);
-
 static inline brs_ext_result_t increase_destination_buffer(
   VALUE destination_value, size_t destination_length,
   size_t* remaining_destination_buffer_length_ptr, size_t destination_buffer_length)
@@ -48,7 +29,7 @@ static inline brs_ext_result_t increase_destination_buffer(
 
   int exception;
 
-  RESIZE_BUFFER(destination_value, destination_length + destination_buffer_length, exception);
+  BRS_EXT_RESIZE_STRING_BUFFER(destination_value, destination_length + destination_buffer_length, exception);
   if (exception != 0) {
     return BRS_EXT_ERROR_ALLOCATE_FAILED;
   }
@@ -60,23 +41,25 @@ static inline brs_ext_result_t increase_destination_buffer(
 
 // -- utils --
 
-#define GET_SOURCE_DATA(source_value)                                 \
-  Check_Type(source_value, T_STRING);                                 \
-                                                                      \
-  const char*    source                  = RSTRING_PTR(source_value); \
-  size_t         source_length           = RSTRING_LEN(source_value); \
-  const uint8_t* remaining_source        = (const uint8_t*)source;    \
-  size_t         remaining_source_length = source_length;
+#define GET_SOURCE_DATA(source_value)                    \
+  Check_Type(source_value, T_STRING);                    \
+                                                         \
+  const char* source        = RSTRING_PTR(source_value); \
+  size_t      source_length = RSTRING_LEN(source_value);
 
 // -- compress --
 
 static inline brs_ext_result_t compress(
   BrotliEncoderState* state_ptr,
-  const uint8_t* remaining_source, size_t remaining_source_length,
+  const char* source, size_t source_length,
   VALUE destination_value, size_t destination_buffer_length)
 {
+  BROTLI_BOOL      result;
   brs_ext_result_t ext_result;
 
+  const uint8_t* remaining_source        = (const uint8_t*)source;
+  size_t         remaining_source_length = source_length;
+
   size_t destination_length                  = 0;
   size_t remaining_destination_buffer_length = destination_buffer_length;
 
@@ -84,7 +67,7 @@ static inline brs_ext_result_t compress(
     uint8_t* remaining_destination_buffer             = (uint8_t*)RSTRING_PTR(destination_value) + destination_length;
     size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
 
-    BROTLI_BOOL result = BrotliEncoderCompressStream(
+    result = BrotliEncoderCompressStream(
       state_ptr,
       BROTLI_OPERATION_FINISH,
       &remaining_source_length, &remaining_source,
@@ -114,7 +97,7 @@ static inline brs_ext_result_t compress(
 
   int exception;
 
-  RESIZE_BUFFER(destination_value, destination_length, exception);
+  BRS_EXT_RESIZE_STRING_BUFFER(destination_value, destination_length, exception);
   if (exception != 0) {
     return BRS_EXT_ERROR_ALLOCATE_FAILED;
   }
@@ -146,7 +129,7 @@ VALUE brs_ext_compress_string(VALUE BRS_EXT_UNUSED(self), VALUE source_value, VA
 
   int exception;
 
-  CREATE_BUFFER(destination_value, destination_buffer_length, exception);
+  BRS_EXT_CREATE_STRING_BUFFER(destination_value, destination_buffer_length, exception);
   if (exception != 0) {
     BrotliEncoderDestroyInstance(state_ptr);
     brs_ext_raise_error(BRS_EXT_ERROR_ALLOCATE_FAILED);
@@ -154,7 +137,7 @@ VALUE brs_ext_compress_string(VALUE BRS_EXT_UNUSED(self), VALUE source_value, VA
 
   ext_result = compress(
     state_ptr,
-    remaining_source, remaining_source_length,
+    source, source_length,
     destination_value, destination_buffer_length);
 
   BrotliEncoderDestroyInstance(state_ptr);
@@ -170,10 +153,14 @@ VALUE brs_ext_compress_string(VALUE BRS_EXT_UNUSED(self), VALUE source_value, VA
 
 static inline brs_ext_result_t decompress(
   BrotliDecoderState* state_ptr,
-  const uint8_t* remaining_source, size_t remaining_source_length,
+  const char* source, size_t source_length,
   VALUE destination_value, size_t destination_buffer_length)
 {
-  brs_ext_result_t ext_result;
+  BrotliDecoderResult result;
+  brs_ext_result_t    ext_result;
+
+  const uint8_t* remaining_source        = (const uint8_t*)source;
+  size_t         remaining_source_length = source_length;
 
   size_t destination_length                  = 0;
   size_t remaining_destination_buffer_length = destination_buffer_length;
@@ -182,7 +169,7 @@ static inline brs_ext_result_t decompress(
     uint8_t* remaining_destination_buffer             = (uint8_t*)RSTRING_PTR(destination_value) + destination_length;
     size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
 
-    BrotliDecoderResult result = BrotliDecoderDecompressStream(
+    result = BrotliDecoderDecompressStream(
       state_ptr,
       &remaining_source_length, &remaining_source,
       &remaining_destination_buffer_length, &remaining_destination_buffer,
@@ -215,7 +202,7 @@ static inline brs_ext_result_t decompress(
 
   int exception;
 
-  RESIZE_BUFFER(destination_value, destination_length, exception);
+  BRS_EXT_RESIZE_STRING_BUFFER(destination_value, destination_length, exception);
   if (exception != 0) {
     brs_ext_raise_error(BRS_EXT_ERROR_ALLOCATE_FAILED);
   }
@@ -247,7 +234,7 @@ VALUE brs_ext_decompress_string(VALUE BRS_EXT_UNUSED(self), VALUE source_value,
 
   int exception;
 
-  CREATE_BUFFER(destination_value, destination_buffer_length, exception);
+  BRS_EXT_CREATE_STRING_BUFFER(destination_value, destination_buffer_length, exception);
   if (exception != 0) {
     BrotliDecoderDestroyInstance(state_ptr);
     brs_ext_raise_error(BRS_EXT_ERROR_ALLOCATE_FAILED);
@@ -255,7 +242,7 @@ VALUE brs_ext_decompress_string(VALUE BRS_EXT_UNUSED(self), VALUE source_value,
 
   ext_result = decompress(
     state_ptr,
-    remaining_source, remaining_source_length,
+    source, source_length,
     destination_value, destination_buffer_length);
 
   BrotliDecoderDestroyInstance(state_ptr);

data/ext/extconf.rb

@@ -3,46 +3,52 @@
 
 require "mkmf"
 
-def require_header(name)
+def require_header(name, types = [])
   abort "Can't find #{name} header" unless find_header name
+
+  types.each do |type|
+    abort "Can't find #{type} type in #{name} header" unless find_type type, nil, name
+  end
 end
 
-require_header "brotli/encode.h"
-require_header "brotli/decode.h"
+require_header "brotli/types.h", %w[BROTLI_BOOL]
+require_header "brotli/encode.h", ["BrotliEncoderState *", "BrotliEncoderMode"]
+require_header "brotli/decode.h", ["BrotliDecoderState *", "BrotliDecoderResult", "BrotliDecoderErrorCode"]
 
 def require_library(name, functions)
   functions.each do |function|
-    abort "Can't find #{name} library and #{function} function" unless find_library name, function
+    abort "Can't find #{function} function in #{name} library" unless find_library name, function
   end
 end
 
-encoder_functions = %w[
-  BrotliEncoderCreateInstance
-  BrotliEncoderSetParameter
-  BrotliEncoderCompressStream
-  BrotliEncoderHasMoreOutput
-  BrotliEncoderIsFinished
-  BrotliEncoderDestroyInstance
-]
-.freeze
+require_library(
+  "brotlienc",
+  %w[
+    BrotliEncoderCreateInstance
+    BrotliEncoderSetParameter
+    BrotliEncoderCompressStream
+    BrotliEncoderHasMoreOutput
+    BrotliEncoderIsFinished
+    BrotliEncoderDestroyInstance
+  ]
+)
 
-require_library "brotlienc", encoder_functions
-
-decoder_functions = %w[
-  BrotliDecoderCreateInstance
-  BrotliDecoderSetParameter
-  BrotliDecoderDecompressStream
-  BrotliDecoderGetErrorCode
-  BrotliDecoderDestroyInstance
-]
-.freeze
-
-require_library "brotlidec", decoder_functions
+require_library(
+  "brotlidec",
+  %w[
+    BrotliDecoderCreateInstance
+    BrotliDecoderSetParameter
+    BrotliDecoderDecompressStream
+    BrotliDecoderGetErrorCode
+    BrotliDecoderDestroyInstance
+  ]
+)
 
 extension_name = "brs_ext".freeze
 dir_config extension_name
 
-sources = %w[
+# rubocop:disable Style/GlobalVars
+$srcs = %w[
   stream/compressor
   stream/decompressor
   buffer
@@ -52,13 +58,9 @@ sources = %w[
   option
   string
 ]
+.map { |name| "src/#{extension_name}/#{name}.c" }
 .freeze
 
-# rubocop:disable Style/GlobalVars
-$srcs = sources
-  .map { |name| "src/#{extension_name}/#{name}.c" }
-  .freeze
-
 $CFLAGS << " -Wno-declaration-after-statement"
 $VPATH << "$(srcdir)/#{extension_name}:$(srcdir)/#{extension_name}/stream"
 # rubocop:enable Style/GlobalVars

data/lib/brs/file.rb

@@ -17,6 +17,8 @@ module BRS
 
       options = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
 
+      options[:size_hint] = ::File.size source
+
       open_files(source, destination) do |source_io, destination_io|
         BRS._native_compress_io source_io, destination_io, options
       end

data/lib/brs/option.rb

@@ -1,6 +1,8 @@
 # Ruby bindings for brotli library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "brs_ext"
+
 require_relative "error"
 require_relative "validation"
 
@@ -14,7 +16,6 @@ module BRS
       :lgwin                            => nil,
       :lgblock                          => nil,
       :disable_literal_context_modeling => nil,
-      :size_hint                        => nil,
       :large_window                     => nil
     }
     .freeze
@@ -40,20 +41,26 @@ module BRS
       end
 
       quality = options[:quality]
-      Validation.validate_not_negative_integer quality unless quality.nil?
+      unless quality.nil?
+        Validation.validate_not_negative_integer quality
+        raise ValidateError, "invalid quality" if quality < MIN_QUALITY || quality > MAX_QUALITY
+      end
 
       lgwin = options[:lgwin]
-      Validation.validate_not_negative_integer lgwin unless lgwin.nil?
+      unless lgwin.nil?
+        Validation.validate_not_negative_integer lgwin
+        raise ValidateError, "invalid lgwin" if lgwin < MIN_LGWIN || lgwin > MAX_LGWIN
+      end
 
       lgblock = options[:lgblock]
-      Validation.validate_not_negative_integer lgblock unless lgblock.nil?
+      unless lgblock.nil?
+        Validation.validate_not_negative_integer lgblock
+        raise ValidateError, "invalid lgblock" if lgblock < MIN_LGBLOCK || lgblock > MAX_LGBLOCK
+      end
 
       disable_literal_context_modeling = options[:disable_literal_context_modeling]
       Validation.validate_bool disable_literal_context_modeling unless disable_literal_context_modeling.nil?
 
-      size_hint = options[:size_hint]
-      Validation.validate_not_negative_integer size_hint unless size_hint.nil?
-
       large_window = options[:large_window]
       Validation.validate_bool large_window unless large_window.nil?
 

data/lib/brs/stream/raw/compressor.rb

@@ -15,7 +15,11 @@ module BRS
         BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
 
         def initialize(options = {})
-          options       = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
+          options = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
+
+          size_hint = options[:size_hint]
+          Validation.validate_not_negative_integer size_hint unless size_hint.nil?
+
           native_stream = NativeCompressor.new options
 
           super native_stream

data/lib/brs/string.rb

@@ -15,6 +15,8 @@ module BRS
 
       options = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
 
+      options[:size_hint] = source.bytesize
+
       BRS._native_compress_string source, options
     end
 

data/lib/brs/version.rb

@@ -2,5 +2,5 @@
 # Copyright (c) 2019 AUTHORS, MIT License.
 
 module BRS
-  VERSION = "1.0.1".freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/brs.rb

@@ -5,3 +5,4 @@ require_relative "brs/stream/reader"
 require_relative "brs/stream/writer"
 require_relative "brs/file"
 require_relative "brs/string"
+require_relative "brs/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Aladjev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.12'
+- !ruby/object:Gem::Dependency
+  name: ocg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '0.75'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '0.75'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 description: 
 email: aladjev.andrew@gmail.com
 executables: []