ruby-lzws 1.1.5 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a57fe20aab5886c14c0891ae6d61992532bb93a39a3ac3bac615d274666b9cee
-  data.tar.gz: '09fe72cfbf5aa061849efcbb3b73148dcb4481ccf9284544cbb74c2ee20de88d'
+  metadata.gz: 72fd9e1b55088bd5ba7a6d57edc857322ede1d9764b6b2eb3aeafe85193605ad
+  data.tar.gz: 2f08eb4371bef83f138233ab62a5a54b5fa01f5a2904d6d1f64ee00fb9aebd1c
 SHA512:
-  metadata.gz: 0c54fcae56fd3316e5a5ef3a84d381bc9a0c878c4f37a3b012a01cda98de8a8580809cfe03b81614260ba2518833aa691db6180a49862d0f41954f391ca8b1f2
-  data.tar.gz: 640e27b7c541376b0c816158749dda2b7f40926c0b773d48255135be98261f3110ed75711b7ee648d1ea1f316aaf4a951068d89eebc672b45e75013f993d4320
+  metadata.gz: beff1dd2f2016bb9660f26bd62f3eaf1fdab8af9e70c24a65bfda4090190c4c02ef66ff943346b9483f5b588ceff6b5964f33d32dfc15e017b3e7964877ce7f9
+  data.tar.gz: a5c0074902b21193725bb0f215cef8ebaad55b3a029e20d0d0b54c0382e527a86c3460feca7a36ed7754b96254497eacb4a08900a425c7bfda70fa44153e60b6

data/README.md

@@ -1,14 +1,14 @@
 # Ruby bindings for lzws library
 
-| Travis | AppVeyor | Cirrus | Circle | Codecov |
-| :---:  | :---:    | :---:  | :---:  | :---:   |
-| [![Travis test status](https://travis-ci.com/andrew-aladev/ruby-lzws.svg?branch=master)](https://travis-ci.com/andrew-aladev/ruby-lzws) | [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-lzws?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-lzws/branch/master) | [![Cirrus test status](https://api.cirrus-ci.com/github/andrew-aladev/ruby-lzws.svg?branch=master)](https://cirrus-ci.com/github/andrew-aladev/ruby-lzws) | [![Circle test status](https://circleci.com/gh/andrew-aladev/ruby-lzws/tree/master.svg?style=shield)](https://circleci.com/gh/andrew-aladev/ruby-lzws/tree/master) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-lzws/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-lzws) |
+| AppVeyor | Circle | Github actions | Codecov | Gem  |
+| :------: | :----: | :------------: | :-----: | :--: |
+| [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-lzws?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-lzws/branch/master) | [![Circle test status](https://circleci.com/gh/andrew-aladev/ruby-lzws/tree/master.svg?style=shield)](https://circleci.com/gh/andrew-aladev/ruby-lzws/tree/master) | [![Github Actions test status](https://github.com/andrew-aladev/ruby-lzws/workflows/test/badge.svg?branch=master)](https://github.com/andrew-aladev/ruby-lzws/actions) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-lzws/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-lzws) | [![Gem](https://img.shields.io/gem/v/ruby-lzws.svg)](https://rubygems.org/gems/ruby-lzws) |
 
 See [lzws library](https://github.com/andrew-aladev/lzws).
 
 ## Installation
 
-Please install lzws library first, use latest 1.3.0+ version.
+Please install lzws library first, use latest 1.4.0+ version.
 
 ```sh
 gem install ruby-lzws
@@ -21,6 +21,8 @@ rake gem
 gem install pkg/ruby-lzws-*.gem
 ```
 
+You can also use [overlay](https://github.com/andrew-aladev/overlay) for gentoo.
+
 ## Usage
 
 There are simple APIs: `String` and `File`. Also you can use generic streaming API: `Stream::Writer` and `Stream::Reader`.
@@ -59,8 +61,8 @@ ensure
 end
 ```
 
-You can create and read `tar.Z` archives with `minitar` for example.
-LZWS is compatible with UNIX compress (with default options).
+You can create and read `tar.Z` archives with [minitar](https://github.com/halostatue/minitar).
+LZWS is compatible with [UNIX compress](https://en.wikipedia.org/wiki/Compress) (with default options).
 
 ```ruby
 require "lzws"
@@ -82,66 +84,63 @@ LZWS::Stream::Reader.open "file.tar.Z" do |reader|
 end
 ```
 
-## Options
-
-Each API supports several options:
-
-```
-:source_buffer_length
-:destination_buffer_length
-```
-
-There are internal buffers for compressed and decompressed data.
-For example you want to use 1 KB as source buffer length for compressor - please use 256 B as destination buffer length.
-You want to use 256 B as source buffer length for decompressor - please use 1 KB as destination buffer length.
-
-Values: 0, 2 - infinity, default value: 0.
-0 means automatic buffer length selection.
-1 byte is not enough, 2 bytes is minimal buffer length.
-
-```
-:max_code_bit_length
-```
+You can also use `Content-Encoding: compress` with [sinatra](http://sinatrarb.com):
 
-Values: `LZWS::Option::LOWEST_MAX_CODE_BIT_LENGTH` - `LZWS::Option::BIGGEST_MAX_CODE_BIT_LENGTH`, default value: `LZWS::Option::BIGGEST_MAX_CODE_BIT_LENGTH`.
+```ruby
+require "lzws"
+require "sinatra"
 
-```
-:block_mode
+get "/" do
+  headers["Content-Encoding"] = "compress"
+  LZWS::String.compress "TOBEORNOTTOBEORTOBEORNOT"
+end
 ```
 
-Values: true/false, default value: true.
+All functionality (including streaming) can be used inside multiple threads with [parallel](https://github.com/grosser/parallel).
+This code will provide heavy load for your CPU.
 
-```
-:without_magic_header
-```
-
-Values: true/false, default value: false.
+```ruby
+require "lzws"
+require "parallel"
 
-```
-:msb
+Parallel.each large_datas do |large_data|
+  LZWS::String.compress large_data
+end
 ```
 
-Values: true/false, default value: false.
+## Options
 
-```
-:unaligned_bit_groups
-```
+| Option                      | Values     | Default  | Description |
+|-----------------------------|------------|----------|-------------|
+| `source_buffer_length`      | 0, 2 - inf | 0 (auto) | internal buffer length for source data |
+| `destination_buffer_length` | 0, 2 - inf | 0 (auto) | internal buffer length for description data |
+| `gvl`                       | true/false | false    | enables global VM lock where possible |
+| `max_code_bit_length`       | 9 - 16     | 16       | max code bit length |
+| `block_mode`                | true/false | true     | enables block mode |
+| `without_magic_header`      | true/false | false    | disables magic header |
+| `msb`                       | true/false | false    | enables most significant bit mode |
+| `unaligned_bit_groups`      | true/false | false    | enables unaligned bit groups |
+| `quiet`                     | true/false | false    | disables lzws library logging |
 
-Values: true/false, default value: false.
+There are internal buffers for compressed and decompressed data.
+For example you want to use 1 KB as `source_buffer_length` for compressor - please use 256 B as `destination_buffer_length`.
+You want to use 256 B as `source_buffer_length` for decompressor - please use 1 KB as `destination_buffer_length`.
 
-```
-:quiet
-```
+`gvl` is disabled by default, this mode allows running multiple compressors/decompressors in different threads simultaneously.
+Please consider enabling `gvl` if you don't want to launch processors in separate threads.
+If `gvl` is enabled ruby won't waste time on acquiring/releasing VM lock.
 
-Values: true/false, default value: false.
-Disables lzws library logging.
+You can also read lzws docs for more info about options.
 
-Please read lzws docs for more info about options.
+| Option                | Related constants |
+|-----------------------|-------------------|
+| `max_code_bit_length` | `LZWS::Option::LOWEST_MAX_CODE_BIT_LENGTH` = 9, `LZWS::Option::BIGGEST_MAX_CODE_BIT_LENGTH` = 16 |
 
 Possible compressor options:
 ```
 :source_buffer_length
 :destination_buffer_length
+:gvl
 :max_code_bit_length
 :block_mode
 :without_magic_header
@@ -154,6 +153,7 @@ Possible decompressor options:
 ```
 :source_buffer_length
 :destination_buffer_length
+:gvl
 :without_magic_header
 :msb
 :unaligned_bit_groups
@@ -169,18 +169,6 @@ data = LZWS::String.compress "TOBEORNOTTOBEORTOBEORNOT", :msb => true
 puts LZWS::String.decompress(data, :msb => true)
 ```
 
-Default options are compatible with UNIX compress (`Content-Encoding: compress`):
-
-```ruby
-require "lzws"
-require "sinatra"
-
-get "/" do
-  headers["Content-Encoding"] = "compress"
-  LZWS::String.compress "TOBEORNOTTOBEORTOBEORNOT"
-end
-```
-
 Please read more about compatibility in lzws docs.
 
 ## String
@@ -207,7 +195,7 @@ File maintains both source and destination buffers, it accepts both `source_buff
 
 ## Stream::Writer
 
-Its behaviour is similar to builtin [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html).
+Its behaviour is similar to builtin [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib/libdoc/zlib/rdoc/Zlib/GzipWriter.html).
 
 Writer maintains destination buffer only, so it accepts `destination_buffer_length` option only.
 
@@ -241,7 +229,7 @@ Set another encodings, `nil` is just for compatibility with `IO`.
 #tell
 ```
 
-See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
+See [`IO`](https://ruby-doc.org/core/IO.html) docs.
 
 ```
 #write(*objects)
@@ -251,7 +239,7 @@ See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 #closed?
 ```
 
-See [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
+See [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
 
 ```
 #write_nonblock(object, *options)
@@ -265,6 +253,9 @@ Special asynchronous methods missing in `Zlib::GzipWriter`.
 So it is possible to have asynchronous variants for these synchronous methods.
 Behaviour is the same as `IO#write_nonblock` method.
 
+All nonblock operations for file will raise `EBADF` error on Windows.
+Setting file into nonblocking mode is [not available on Windows](https://github.com/ruby/ruby/blob/master/win32/win32.c#L4388).
+
 ```
 #<<(object)
 #print(*objects)
@@ -273,11 +264,11 @@ Behaviour is the same as `IO#write_nonblock` method.
 #puts(*objects)
 ```
 
-Typical helpers, see [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
+Typical helpers, see [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
 
 ## Stream::Reader
 
-Its behaviour is similar to builtin [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html).
+Its behaviour is similar to builtin [`Zlib::GzipReader`](https://ruby-doc.org/stdlib/libdoc/zlib/rdoc/Zlib/GzipReader.html).
 
 Reader maintains both source and destination buffers, it accepts both `source_buffer_length` and `destination_buffer_length` options.
 
@@ -312,7 +303,7 @@ Set another encodings.
 #tell
 ```
 
-See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
+See [`IO`](https://ruby-doc.org/core/IO.html) docs.
 
 ```
 #read(bytes_to_read = nil, out_buffer = nil)
@@ -322,14 +313,14 @@ See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 #closed?
 ```
 
-See [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+See [`Zlib::GzipReader`](https://ruby-doc.org/stdlib/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
 
 ```
 #readpartial(bytes_to_read = nil, out_buffer = nil)
 #read_nonblock(bytes_to_read, out_buffer = nil, *options)
 ```
 
-See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
+See [`IO`](https://ruby-doc.org/core/IO.html) docs.
 
 ```
 #getbyte
@@ -352,16 +343,26 @@ See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 #ungetline(line)
 ```
 
-Typical helpers, see [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+Typical helpers, see [`Zlib::GzipReader`](https://ruby-doc.org/stdlib/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+
+## Thread safety
+
+`:gvl` option is disabled by default, you can use bindings effectively in multiple threads.
+Please be careful: bindings are not thread safe.
+You should lock all shared data between threads.
+
+For example: you should not use same compressor/decompressor inside multiple threads.
+Please verify that you are using each processor inside single thread at the same time.
+
+## Operating systems
+
+GNU/Linux, FreeBSD, OSX, Windows (MinGW).
 
 ## CI
 
-See universal test script [scripts/ci_test.sh](scripts/ci_test.sh) for CI.
 Please visit [scripts/test-images](scripts/test-images).
-You can run this test script using many native and cross images.
-
-Cirrus CI uses `x86_64-pc-linux-gnu` image, Circle CI - `x86_64-gentoo-linux-musl` image.
+See universal test script [scripts/ci_test.sh](scripts/ci_test.sh) for CI.
 
 ## License
 
-MIT license, see LICENSE and AUTHORS.
+MIT license, see [LICENSE](LICENSE) and [AUTHORS](AUTHORS).

data/ext/extconf.rb

@@ -3,6 +3,8 @@
 
 require "mkmf"
 
+have_func "rb_thread_call_without_gvl", "ruby/thread.h"
+
 def require_header(name, types = [])
   abort "Can't find #{name} header" unless find_header name
 
@@ -13,10 +15,10 @@ end
 
 require_header "lzws/buffer.h"
 require_header "lzws/common.h", %w[lzws_result_t]
-require_header "lzws/compressor/common.h"
+require_header "lzws/compressor/common.h", %w[lzws_compressor_options_t]
 require_header "lzws/compressor/main.h"
 require_header "lzws/compressor/state.h", %w[lzws_compressor_state_t]
-require_header "lzws/decompressor/common.h"
+require_header "lzws/decompressor/common.h", %w[lzws_decompressor_options_t]
 require_header "lzws/decompressor/main.h"
 require_header "lzws/decompressor/state.h", %w[lzws_decompressor_state_t]
 require_header "lzws/file.h"
@@ -66,7 +68,14 @@ $srcs = %w[
 .map { |name| "src/#{extension_name}/#{name}.c" }
 .freeze
 
-if ENV["CI"] || ENV["COVERAGE"]
+# Removing library duplicates.
+$libs = $libs.split(%r{\s})
+  .reject(&:empty?)
+  .sort
+  .uniq
+  .join " "
+
+if ENV["CI"]
   $CFLAGS << " --coverage"
   $LDFLAGS << " --coverage"
 end

data/ext/lzws_ext/buffer.c

@@ -12,10 +12,11 @@ VALUE lzws_ext_create_string_buffer(VALUE length)
   return rb_str_new(NULL, NUM2SIZET(length));
 }
 
-VALUE lzws_ext_resize_string_buffer(VALUE args)
+VALUE lzws_ext_resize_string_buffer(VALUE buffer_args)
 {
-  VALUE buffer = rb_ary_entry(args, 0);
-  VALUE length = rb_ary_entry(args, 1);
+  VALUE buffer = rb_ary_entry(buffer_args, 0);
+  VALUE length = rb_ary_entry(buffer_args, 1);
+
   return rb_str_resize(buffer, NUM2SIZET(length));
 }
 
@@ -23,8 +24,21 @@ void lzws_ext_buffer_exports(VALUE root_module)
 {
   VALUE module = rb_define_module_under(root_module, "Buffer");
 
-  rb_define_const(module, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR", SIZET2NUM(LZWS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR));
-  rb_define_const(module, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR", SIZET2NUM(LZWS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR));
-  rb_define_const(module, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR", SIZET2NUM(LZWS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR));
-  rb_define_const(module, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR", SIZET2NUM(LZWS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR));
+  rb_define_const(
+    module, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR", SIZET2NUM(LZWS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR));
+
+  rb_define_const(
+    module,
+    "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR",
+    SIZET2NUM(LZWS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR));
+
+  rb_define_const(
+    module,
+    "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR",
+    SIZET2NUM(LZWS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR));
+
+  rb_define_const(
+    module,
+    "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR",
+    SIZET2NUM(LZWS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR));
 }

data/ext/lzws_ext/buffer.h

@@ -11,12 +11,12 @@ VALUE lzws_ext_create_string_buffer(VALUE length);
 #define LZWS_EXT_CREATE_STRING_BUFFER(buffer, length, exception) \
   VALUE buffer = rb_protect(lzws_ext_create_string_buffer, SIZET2NUM(length), &exception);
 
-VALUE lzws_ext_resize_string_buffer(VALUE args);
+VALUE lzws_ext_resize_string_buffer(VALUE buffer_args);
 
-#define LZWS_EXT_RESIZE_STRING_BUFFER(buffer, length, exception)            \
-  VALUE args = rb_ary_new_from_args(2, buffer, SIZET2NUM(length));          \
-  buffer     = rb_protect(lzws_ext_resize_string_buffer, args, &exception); \
-  RB_GC_GUARD(args);
+#define LZWS_EXT_RESIZE_STRING_BUFFER(buffer, length, exception)                          \
+  VALUE buffer_args = rb_ary_new_from_args(2, buffer, SIZET2NUM(length));                 \
+  buffer            = rb_protect(lzws_ext_resize_string_buffer, buffer_args, &exception); \
+  RB_GC_GUARD(buffer_args);
 
 void lzws_ext_buffer_exports(VALUE root_module);
 

data/ext/lzws_ext/error.c

@@ -5,7 +5,7 @@
 
 #include "ruby.h"
 
-static inline NORETURN(void raise(const char* name, const char* description))
+static inline NORETURN(void raise_error(const char* name, const char* description))
 {
   VALUE module = rb_define_module(LZWS_EXT_MODULE_NAME);
   VALUE error  = rb_const_get(module, rb_intern(name));
@@ -16,28 +16,28 @@ void lzws_ext_raise_error(lzws_ext_result_t ext_result)
 {
   switch (ext_result) {
     case LZWS_EXT_ERROR_ALLOCATE_FAILED:
-      raise("AllocateError", "allocate error");
+      raise_error("AllocateError", "allocate error");
     case LZWS_EXT_ERROR_VALIDATE_FAILED:
-      raise("ValidateError", "validate error");
+      raise_error("ValidateError", "validate error");
 
     case LZWS_EXT_ERROR_USED_AFTER_CLOSE:
-      raise("UsedAfterCloseError", "used after closed");
+      raise_error("UsedAfterCloseError", "used after closed");
     case LZWS_EXT_ERROR_NOT_ENOUGH_SOURCE_BUFFER:
-      raise("NotEnoughSourceBufferError", "not enough source buffer");
+      raise_error("NotEnoughSourceBufferError", "not enough source buffer");
     case LZWS_EXT_ERROR_NOT_ENOUGH_DESTINATION_BUFFER:
-      raise("NotEnoughDestinationBufferError", "not enough destination buffer");
+      raise_error("NotEnoughDestinationBufferError", "not enough destination buffer");
     case LZWS_EXT_ERROR_DECOMPRESSOR_CORRUPTED_SOURCE:
-      raise("DecompressorCorruptedSourceError", "decompressor received corrupted source");
+      raise_error("DecompressorCorruptedSourceError", "decompressor received corrupted source");
 
     case LZWS_EXT_ERROR_ACCESS_IO:
-      raise("AccessIOError", "failed to access IO");
+      raise_error("AccessIOError", "failed to access IO");
     case LZWS_EXT_ERROR_READ_IO:
-      raise("ReadIOError", "failed to read IO");
+      raise_error("ReadIOError", "failed to read IO");
     case LZWS_EXT_ERROR_WRITE_IO:
-      raise("WriteIOError", "failed to write IO");
+      raise_error("WriteIOError", "failed to write IO");
 
     default:
       // LZWS_EXT_ERROR_UNEXPECTED
-      raise("UnexpectedError", "unexpected error");
+      raise_error("UnexpectedError", "unexpected error");
   }
 }

data/ext/lzws_ext/error.h

@@ -9,7 +9,8 @@
 
 // Results for errors listed in "lib/lzws/error" used in c extension.
 
-enum {
+enum
+{
   LZWS_EXT_ERROR_ALLOCATE_FAILED = 1,
   LZWS_EXT_ERROR_VALIDATE_FAILED,
 

data/ext/lzws_ext/gvl.h

@@ -0,0 +1,24 @@
+// Ruby bindings for lzws library.
+// Copyright (c) 2019 AUTHORS, MIT License.
+
+#if !defined(LZWS_EXT_GVL_H)
+#define LZWS_EXT_GVL_H
+
+#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+
+#include "ruby/thread.h"
+
+#define LZWS_EXT_GVL_WRAP(gvl, function, data)                             \
+  if (gvl) {                                                               \
+    function((void*) data);                                                \
+  } else {                                                                 \
+    rb_thread_call_without_gvl(function, (void*) data, RUBY_UBF_IO, NULL); \
+  }
+
+#else
+
+#define LZWS_EXT_GVL_WRAP(_gvl, function, data) function((void*) data);
+
+#endif
+
+#endif // LZWS_EXT_GVL_H