ruby-lzws 1.1.1 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c705cd3581e745a96ee58e79c8b9b9ca69a55294d499db00ed5a073be0efa42b
-  data.tar.gz: 4925c44f35575a3be67419285b0ca911e6f10e74d52c63c42f9277a249de9a01
+  metadata.gz: e18e16b625bf41931b87a5f3c46346bc13fa4cf7a3f616661e0d62ea5bdc58bf
+  data.tar.gz: e5708e1e0f82c370285d62062ec0581eff2673de586d608cbda14bb91e4c6c3c
 SHA512:
-  metadata.gz: f879b4d19f3de43d0304a6e70ce86c262b4d0085e2f3f7d101308a80785ccd808d1240372a85f8f49929526566682824f28c61b90bb0b9a1649e75c6726dabae
-  data.tar.gz: f2bbb94977b0eecb1e00a3bf655b4dcf08d428b256bebebcb95b37e9da7bf135a9958e7f38f6a0fe2ce5abdfb9bf413e0a3864e1ade7885102726a1541c884ed
+  metadata.gz: d19f703370a41e61e0b0fe5092377c18817a44f0c0ba3f3a2124a4fb171ce646366db4d200ffb2ac85111bde7c7f8239096c7073120a649045fb942f8f6e34e7
+  data.tar.gz: 80b07074716893223ce74610cf3a2f4a86cacc20880cfc4ca8df03b80a5aaa4b881addc21c7cebd59eb7ddf3457c37a604e98a09c35d88d3c3c1d93d377d37f7

data/README.md

@@ -1,8 +1,8 @@
 # Ruby bindings for lzws library
 
-| Travis | AppVeyor | Cirrus | Circle |
-| :---:  | :---:    | :---:  | :---:  |
-| [![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) |
+| Travis | AppVeyor | 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) | [![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) |
 
 See [lzws library](https://github.com/andrew-aladev/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`.
@@ -36,6 +38,27 @@ LZWS::File.decompress "file.txt.Z", "file.txt"
 
 LZWS::Stream::Writer.open("file.txt.Z") { |writer| writer << "TOBEORNOTTOBEORTOBEORNOT" }
 puts LZWS::Stream::Reader.open("file.txt.Z") { |reader| reader.read }
+
+writer = LZWS::Stream::Writer.new output_socket
+begin
+  bytes_written = writer.write_nonblock "TOBEORNOTTOBEORTOBEORNOT"
+  # handle "bytes_written"
+rescue IO::WaitWritable
+  # handle wait
+ensure
+  writer.close
+end
+
+reader = LZWS::Stream::Reader.new input_socket
+begin
+  puts reader.read_nonblock(512)
+rescue IO::WaitReadable
+  # handle wait
+rescue ::EOFError
+  # handle eof
+ensure
+  reader.close
+end
 ```
 
 You can create and read `tar.Z` archives with `minitar` for example.
@@ -63,59 +86,26 @@ end
 
 ## Options
 
-Each API supports several options:
-
-```
-:source_buffer_length
-:destination_buffer_length
-```
+| 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 |
+| `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 |
 
 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
-```
-
-Values: `LZWS::Option::LOWEST_MAX_CODE_BIT_LENGTH` - `LZWS::Option::BIGGEST_MAX_CODE_BIT_LENGTH`, default value: `LZWS::Option::BIGGEST_MAX_CODE_BIT_LENGTH`.
-
-```
-:block_mode
-```
-
-Values: true/false, default value: true.
-
-```
-:without_magic_header
-```
-
-Values: true/false, default value: false.
-
-```
-:msb
-```
-
-Values: true/false, default value: false.
-
-```
-:unaligned_bit_groups
-```
-
-Values: true/false, default value: false.
-
-```
-:quiet
-```
+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: 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:
 ```
@@ -186,7 +176,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.6.1/libdoc/zlib/rdoc/Zlib/GzipWriter.html).
+Its behaviour is similar to builtin [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html).
 
 Writer maintains destination buffer only, so it accepts `destination_buffer_length` option only.
 
@@ -220,7 +210,7 @@ Set another encodings, `nil` is just for compatibility with `IO`.
 #tell
 ```
 
-See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
+See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 
 ```
 #write(*objects)
@@ -230,7 +220,7 @@ See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
 #closed?
 ```
 
-See [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
+See [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
 
 ```
 #write_nonblock(object, *options)
@@ -252,11 +242,11 @@ Behaviour is the same as `IO#write_nonblock` method.
 #puts(*objects)
 ```
 
-Typical helpers, see [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
+Typical helpers, see [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
 
 ## Stream::Reader
 
-Its behaviour is similar to builtin [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipReader.html).
+Its behaviour is similar to builtin [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html).
 
 Reader maintains both source and destination buffers, it accepts both `source_buffer_length` and `destination_buffer_length` options.
 
@@ -291,7 +281,7 @@ Set another encodings.
 #tell
 ```
 
-See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
+See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 
 ```
 #read(bytes_to_read = nil, out_buffer = nil)
@@ -301,14 +291,14 @@ See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
 #closed?
 ```
 
-See [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+See [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/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.6.1/IO.html) docs.
+See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 
 ```
 #getbyte
@@ -331,13 +321,13 @@ See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
 #ungetline(line)
 ```
 
-Typical helpers, see [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+Typical helpers, see [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/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.
+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.
 
 ## License
 

data/ext/extconf.rb

@@ -66,7 +66,20 @@ $srcs = %w[
 .map { |name| "src/#{extension_name}/#{name}.c" }
 .freeze
 
+# Removing library duplicates.
+$libs = $libs.split(%r{\s})
+  .reject(&:empty?)
+  .sort
+  .uniq
+  .join " "
+
+if ENV["CI"] || ENV["COVERAGE"]
+  $CFLAGS << " --coverage"
+  $LDFLAGS << " --coverage"
+end
+
 $CFLAGS << " -Wno-declaration-after-statement"
+
 $VPATH << "$(srcdir)/#{extension_name}:$(srcdir)/#{extension_name}/stream"
 # rubocop:enable Style/GlobalVars
 

data/ext/lzws_ext/common.h

@@ -10,4 +10,7 @@
 
 typedef uint_fast8_t lzws_ext_result_t;
 
+typedef uint8_t      lzws_ext_byte_t;
+typedef uint_fast8_t lzws_ext_byte_fast_t;
+
 #endif // LZWS_EXT_COMMON_H

data/ext/lzws_ext/error.c

@@ -3,7 +3,6 @@
 
 #include "lzws_ext/error.h"
 
-#include "lzws_ext/common.h"
 #include "ruby.h"
 
 static inline NORETURN(void raise(const char* name, const char* description))

data/ext/lzws_ext/io.c

@@ -6,7 +6,6 @@
 #include <lzws/common.h>
 #include <lzws/file.h>
 
-#include "lzws_ext/common.h"
 #include "lzws_ext/error.h"
 #include "lzws_ext/io.h"
 #include "lzws_ext/macro.h"

data/ext/lzws_ext/main.c

@@ -2,7 +2,6 @@
 // Copyright (c) 2019 AUTHORS, MIT License.
 
 #include "lzws_ext/buffer.h"
-#include "lzws_ext/common.h"
 #include "lzws_ext/io.h"
 #include "lzws_ext/stream/compressor.h"
 #include "lzws_ext/stream/decompressor.h"

data/ext/lzws_ext/option.c

@@ -3,9 +3,6 @@
 
 #include "lzws_ext/option.h"
 
-#include <stdbool.h>
-#include <stdlib.h>
-
 #include "lzws_ext/error.h"
 #include "ruby.h"
 

data/ext/lzws_ext/option.h

@@ -7,6 +7,7 @@
 #include <stdbool.h>
 #include <stdlib.h>
 
+#include "lzws_ext/common.h"
 #include "ruby.h"
 
 bool         lzws_ext_get_bool_option_value(VALUE options, const char* name);
@@ -22,12 +23,12 @@ size_t       lzws_ext_get_size_option_value(VALUE options, const char* name);
 #define LZWS_EXT_GET_SIZE_OPTION(options, name) \
   size_t name = lzws_ext_get_size_option_value(options, #name);
 
-#define LZWS_EXT_GET_COMPRESSOR_OPTIONS(options)                        \
-  LZWS_EXT_GET_BOOL_OPTION(options, without_magic_header);              \
-  LZWS_EXT_GET_UINT_OPTION(options, uint_fast8_t, max_code_bit_length); \
-  LZWS_EXT_GET_BOOL_OPTION(options, block_mode);                        \
-  LZWS_EXT_GET_BOOL_OPTION(options, msb);                               \
-  LZWS_EXT_GET_BOOL_OPTION(options, unaligned_bit_groups);              \
+#define LZWS_EXT_GET_COMPRESSOR_OPTIONS(options)                                \
+  LZWS_EXT_GET_BOOL_OPTION(options, without_magic_header);                      \
+  LZWS_EXT_GET_UINT_OPTION(options, lzws_ext_byte_fast_t, max_code_bit_length); \
+  LZWS_EXT_GET_BOOL_OPTION(options, block_mode);                                \
+  LZWS_EXT_GET_BOOL_OPTION(options, msb);                                       \
+  LZWS_EXT_GET_BOOL_OPTION(options, unaligned_bit_groups);                      \
   LZWS_EXT_GET_BOOL_OPTION(options, quiet);
 
 #define LZWS_EXT_GET_DECOMPRESSOR_OPTIONS(options)         \

data/ext/lzws_ext/stream/compressor.c

@@ -8,8 +8,6 @@
 #include <lzws/compressor/common.h>
 #include <lzws/compressor/main.h>
 #include <lzws/compressor/state.h>
-#include <stdint.h>
-#include <stdlib.h>
 
 #include "lzws_ext/error.h"
 #include "lzws_ext/option.h"
@@ -22,7 +20,7 @@ static void free_compressor(lzws_ext_compressor_t* compressor_ptr)
     lzws_compressor_free_state(state_ptr);
   }
 
-  uint8_t* destination_buffer = compressor_ptr->destination_buffer;
+  lzws_ext_byte_t* destination_buffer = compressor_ptr->destination_buffer;
   if (destination_buffer != NULL) {
     free(destination_buffer);
   }
@@ -73,7 +71,7 @@ VALUE lzws_ext_initialize_compressor(VALUE self, VALUE options)
     }
   }
 
-  uint8_t* destination_buffer;
+  lzws_ext_byte_t* destination_buffer;
 
   result = lzws_create_destination_buffer_for_compressor(&destination_buffer, &destination_buffer_length, quiet);
   if (result != 0) {
@@ -95,13 +93,13 @@ VALUE lzws_ext_initialize_compressor(VALUE self, VALUE options)
     lzws_ext_raise_error(LZWS_EXT_ERROR_USED_AFTER_CLOSE);                               \
   }
 
-#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); \
-  uint8_t*    remaining_source        = (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); \
+  lzws_ext_byte_t* remaining_source        = (lzws_ext_byte_t*)source;  \
+  size_t           remaining_source_length = source_length;
 
 VALUE lzws_ext_compress(VALUE self, VALUE source_value)
 {
@@ -151,9 +149,9 @@ VALUE lzws_ext_compressor_read_result(VALUE self)
   GET_COMPRESSOR(self);
   DO_NOT_USE_AFTER_CLOSE(compressor_ptr);
 
-  uint8_t* destination_buffer                  = compressor_ptr->destination_buffer;
-  size_t   destination_buffer_length           = compressor_ptr->destination_buffer_length;
-  size_t   remaining_destination_buffer_length = compressor_ptr->remaining_destination_buffer_length;
+  lzws_ext_byte_t* destination_buffer                  = compressor_ptr->destination_buffer;
+  size_t           destination_buffer_length           = compressor_ptr->destination_buffer_length;
+  size_t           remaining_destination_buffer_length = compressor_ptr->remaining_destination_buffer_length;
 
   const char* result        = (const char*)destination_buffer;
   size_t      result_length = destination_buffer_length - remaining_destination_buffer_length;
@@ -178,7 +176,7 @@ VALUE lzws_ext_compressor_close(VALUE self)
     compressor_ptr->state_ptr = NULL;
   }
 
-  uint8_t* destination_buffer = compressor_ptr->destination_buffer;
+  lzws_ext_byte_t* destination_buffer = compressor_ptr->destination_buffer;
   if (destination_buffer != NULL) {
     free(destination_buffer);
 

data/ext/lzws_ext/stream/compressor.h

@@ -5,16 +5,16 @@
 #define LZWS_EXT_STREAM_COMPRESSOR_H
 
 #include <lzws/compressor/state.h>
-#include <stdint.h>
 #include <stdlib.h>
 
+#include "lzws_ext/common.h"
 #include "ruby.h"
 
 typedef struct {
   lzws_compressor_state_t* state_ptr;
-  uint8_t*                 destination_buffer;
+  lzws_ext_byte_t*         destination_buffer;
   size_t                   destination_buffer_length;
-  uint8_t*                 remaining_destination_buffer;
+  lzws_ext_byte_t*         remaining_destination_buffer;
   size_t                   remaining_destination_buffer_length;
 } lzws_ext_compressor_t;
 

data/ext/lzws_ext/stream/decompressor.c

@@ -8,8 +8,6 @@
 #include <lzws/decompressor/common.h>
 #include <lzws/decompressor/main.h>
 #include <lzws/decompressor/state.h>
-#include <stdint.h>
-#include <stdlib.h>
 
 #include "lzws_ext/error.h"
 #include "lzws_ext/option.h"
@@ -22,7 +20,7 @@ static void free_decompressor(lzws_ext_decompressor_t* decompressor_ptr)
     lzws_decompressor_free_state(state_ptr);
   }
 
-  uint8_t* destination_buffer = decompressor_ptr->destination_buffer;
+  lzws_ext_byte_t* destination_buffer = decompressor_ptr->destination_buffer;
   if (destination_buffer != NULL) {
     free(destination_buffer);
   }
@@ -71,7 +69,7 @@ VALUE lzws_ext_initialize_decompressor(VALUE self, VALUE options)
     }
   }
 
-  uint8_t* destination_buffer;
+  lzws_ext_byte_t* destination_buffer;
 
   result = lzws_create_destination_buffer_for_decompressor(&destination_buffer, &destination_buffer_length, quiet);
   if (result != 0) {
@@ -93,13 +91,13 @@ VALUE lzws_ext_initialize_decompressor(VALUE self, VALUE options)
     lzws_ext_raise_error(LZWS_EXT_ERROR_USED_AFTER_CLOSE);                                   \
   }
 
-#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); \
-  uint8_t*    remaining_source        = (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); \
+  lzws_ext_byte_t* remaining_source        = (lzws_ext_byte_t*)source;  \
+  size_t           remaining_source_length = source_length;
 
 VALUE lzws_ext_decompress(VALUE self, VALUE source_value)
 {
@@ -137,9 +135,9 @@ VALUE lzws_ext_decompressor_read_result(VALUE self)
   GET_DECOMPRESSOR(self);
   DO_NOT_USE_AFTER_CLOSE(decompressor_ptr);
 
-  uint8_t* destination_buffer                  = decompressor_ptr->destination_buffer;
-  size_t   destination_buffer_length           = decompressor_ptr->destination_buffer_length;
-  size_t   remaining_destination_buffer_length = decompressor_ptr->remaining_destination_buffer_length;
+  lzws_ext_byte_t* destination_buffer                  = decompressor_ptr->destination_buffer;
+  size_t           destination_buffer_length           = decompressor_ptr->destination_buffer_length;
+  size_t           remaining_destination_buffer_length = decompressor_ptr->remaining_destination_buffer_length;
 
   const char* result        = (const char*)destination_buffer;
   size_t      result_length = destination_buffer_length - remaining_destination_buffer_length;
@@ -164,7 +162,7 @@ VALUE lzws_ext_decompressor_close(VALUE self)
     decompressor_ptr->state_ptr = NULL;
   }
 
-  uint8_t* destination_buffer = decompressor_ptr->destination_buffer;
+  lzws_ext_byte_t* destination_buffer = decompressor_ptr->destination_buffer;
   if (destination_buffer != NULL) {
     free(destination_buffer);
 

data/ext/lzws_ext/stream/decompressor.h

@@ -5,16 +5,16 @@
 #define LZWS_EXT_STREAM_DECOMPRESSOR_H
 
 #include <lzws/decompressor/state.h>
-#include <stdint.h>
 #include <stdlib.h>
 
+#include "lzws_ext/common.h"
 #include "ruby.h"
 
 typedef struct {
   lzws_decompressor_state_t* state_ptr;
-  uint8_t*                   destination_buffer;
+  lzws_ext_byte_t*           destination_buffer;
   size_t                     destination_buffer_length;
-  uint8_t*                   remaining_destination_buffer;
+  lzws_ext_byte_t*           remaining_destination_buffer;
   size_t                     remaining_destination_buffer_length;
 } lzws_ext_decompressor_t;
 

data/ext/lzws_ext/string.c

@@ -11,7 +11,6 @@
 #include <lzws/decompressor/common.h>
 #include <lzws/decompressor/main.h>
 #include <lzws/decompressor/state.h>
-#include <stdint.h>
 #include <stdlib.h>
 
 #include "lzws_ext/buffer.h"
@@ -53,34 +52,34 @@ static inline lzws_ext_result_t increase_destination_buffer(
 
 // -- compress --
 
-#define BUFFERED_COMPRESS(function, ...)                                                                               \
-  while (true) {                                                                                                       \
-    uint8_t* remaining_destination_buffer             = (uint8_t*)RSTRING_PTR(destination_value) + destination_length; \
-    size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;                           \
-                                                                                                                       \
-    result = function(__VA_ARGS__, &remaining_destination_buffer, &remaining_destination_buffer_length);               \
-                                                                                                                       \
-    if (                                                                                                               \
-      result != 0 &&                                                                                                   \
-      result != LZWS_COMPRESSOR_NEEDS_MORE_DESTINATION) {                                                              \
-      return LZWS_EXT_ERROR_UNEXPECTED;                                                                                \
-    }                                                                                                                  \
-                                                                                                                       \
-    destination_length += prev_remaining_destination_buffer_length - remaining_destination_buffer_length;              \
-                                                                                                                       \
-    if (result == LZWS_COMPRESSOR_NEEDS_MORE_DESTINATION) {                                                            \
-      ext_result = increase_destination_buffer(                                                                        \
-        destination_value, destination_length,                                                                         \
-        &remaining_destination_buffer_length, destination_buffer_length);                                              \
-                                                                                                                       \
-      if (ext_result != 0) {                                                                                           \
-        return ext_result;                                                                                             \
-      }                                                                                                                \
-                                                                                                                       \
-      continue;                                                                                                        \
-    }                                                                                                                  \
-                                                                                                                       \
-    break;                                                                                                             \
+#define BUFFERED_COMPRESS(function, ...)                                                                                               \
+  while (true) {                                                                                                                       \
+    lzws_ext_byte_t* remaining_destination_buffer             = (lzws_ext_byte_t*)RSTRING_PTR(destination_value) + destination_length; \
+    size_t           prev_remaining_destination_buffer_length = remaining_destination_buffer_length;                                   \
+                                                                                                                                       \
+    result = function(__VA_ARGS__, &remaining_destination_buffer, &remaining_destination_buffer_length);                               \
+                                                                                                                                       \
+    if (                                                                                                                               \
+      result != 0 &&                                                                                                                   \
+      result != LZWS_COMPRESSOR_NEEDS_MORE_DESTINATION) {                                                                              \
+      return LZWS_EXT_ERROR_UNEXPECTED;                                                                                                \
+    }                                                                                                                                  \
+                                                                                                                                       \
+    destination_length += prev_remaining_destination_buffer_length - remaining_destination_buffer_length;                              \
+                                                                                                                                       \
+    if (result == LZWS_COMPRESSOR_NEEDS_MORE_DESTINATION) {                                                                            \
+      ext_result = increase_destination_buffer(                                                                                        \
+        destination_value, destination_length,                                                                                         \
+        &remaining_destination_buffer_length, destination_buffer_length);                                                              \
+                                                                                                                                       \
+      if (ext_result != 0) {                                                                                                           \
+        return ext_result;                                                                                                             \
+      }                                                                                                                                \
+                                                                                                                                       \
+      continue;                                                                                                                        \
+    }                                                                                                                                  \
+                                                                                                                                       \
+    break;                                                                                                                             \
   }
 
 static inline lzws_ext_result_t compress(
@@ -91,8 +90,8 @@ static inline lzws_ext_result_t compress(
   lzws_result_t     result;
   lzws_ext_result_t ext_result;
 
-  uint8_t* remaining_source        = (uint8_t*)source;
-  size_t   remaining_source_length = source_length;
+  lzws_ext_byte_t* remaining_source        = (lzws_ext_byte_t*)source;
+  size_t           remaining_source_length = source_length;
 
   size_t destination_length                  = 0;
   size_t remaining_destination_buffer_length = destination_buffer_length;
@@ -170,15 +169,15 @@ static inline lzws_ext_result_t decompress(
   lzws_result_t     result;
   lzws_ext_result_t ext_result;
 
-  uint8_t* remaining_source        = (uint8_t*)source;
-  size_t   remaining_source_length = source_length;
+  lzws_ext_byte_t* remaining_source        = (lzws_ext_byte_t*)source;
+  size_t           remaining_source_length = source_length;
 
   size_t destination_length                  = 0;
   size_t remaining_destination_buffer_length = destination_buffer_length;
 
   while (true) {
-    uint8_t* remaining_destination_buffer             = (uint8_t*)RSTRING_PTR(destination_value) + destination_length;
-    size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
+    lzws_ext_byte_t* remaining_destination_buffer             = (lzws_ext_byte_t*)RSTRING_PTR(destination_value) + destination_length;
+    size_t           prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
 
     result = lzws_decompress(
       state_ptr,

data/lib/lzws/file.rb

@@ -20,6 +20,8 @@ module LZWS
       open_files(source, destination) do |source_io, destination_io|
         LZWS._native_compress_io source_io, destination_io, options
       end
+
+      nil
     end
 
     def self.decompress(source, destination, options = {})
@@ -31,6 +33,8 @@ module LZWS
       open_files(source, destination) do |source_io, destination_io|
         LZWS._native_decompress_io source_io, destination_io, options
       end
+
+      nil
     end
 
     private_class_method def self.open_files(source, destination, &_block)

data/lib/lzws/stream/abstract.rb

@@ -17,23 +17,19 @@ module LZWS
 
       include Delegates
 
-      attr_reader :io
-      attr_reader :stat
-      attr_reader :external_encoding
-      attr_reader :internal_encoding
-      attr_reader :transcode_options
-      attr_reader :pos
+      attr_reader :io, :stat, :external_encoding, :internal_encoding, :transcode_options, :pos
+
       alias tell pos
 
-      def initialize(io, external_encoding: nil, internal_encoding: nil, transcode_options: {})
+      def initialize(io, options = {})
         @raw_stream = create_raw_stream
 
         Validation.validate_io io
         @io = io
 
-        @stat = Stat.new @io.stat
+        @stat = Stat.new @io.stat if @io.respond_to? :stat
 
-        set_encoding external_encoding, internal_encoding, transcode_options
+        set_encoding options[:external_encoding], options[:internal_encoding], options[:transcode_options]
         reset_buffer
         reset_io_advise
 
@@ -50,8 +46,8 @@ module LZWS
 
       protected def reset_io_advise
         # Both compressor and decompressor need sequential io access.
-        @io.advise :sequential
-      rescue ::Errno::ESPIPE # rubocop:disable Lint/HandleExceptions
+        @io.advise :sequential if @io.respond_to? :advise
+      rescue ::Errno::ESPIPE
         # ok
       end
 
@@ -126,7 +122,8 @@ module LZWS
       def rewind
         @raw_stream = create_raw_stream
 
-        @io.rewind
+        @io.rewind if @io.respond_to? :rewind
+
         reset_buffer
         reset_io_advise
 

data/lib/lzws/stream/raw/abstract.rb

@@ -27,9 +27,9 @@ module LZWS
           nil
         end
 
-        protected def flush_destination_buffer(&writer)
+        protected def more_destination(&writer)
           result_bytesize = write_result(&writer)
-          raise NotEnoughDestinationError, "not enough destination" if result_bytesize == 0
+          raise NotEnoughDestinationError, "not enough destination" if result_bytesize.zero?
         end
 
         protected def write_result(&_writer)
@@ -50,6 +50,8 @@ module LZWS
 
           @native_stream.close
           @is_closed = true
+
+          nil
         end
 
         def closed?

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

@@ -35,13 +35,15 @@ module LZWS
 
             if need_more_destination
               source = source.byteslice bytes_written, source.bytesize - bytes_written
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
             unless bytes_written == source.bytesize
+              # :nocov:
               # Compressor write should eat all provided "source" without remainder.
               raise UnexpectedError, "unexpected error"
+              # :nocov:
             end
 
             break
@@ -59,7 +61,7 @@ module LZWS
             need_more_destination = @native_stream.finish
 
             if need_more_destination
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -67,8 +69,6 @@ module LZWS
           end
 
           super
-
-          nil
         end
       end
     end

data/lib/lzws/stream/raw/decompressor.rb

@@ -34,7 +34,7 @@ module LZWS
 
             if need_more_destination
               source = source.byteslice bytes_read, source.bytesize - bytes_read
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -51,8 +51,6 @@ module LZWS
           Validation.validate_proc writer
 
           super
-
-          nil
         end
       end
     end

data/lib/lzws/stream/reader.rb

@@ -20,79 +20,60 @@ module LZWS
 
         initialize_source_buffer_length
         reset_io_remainder
+        reset_need_to_flush
 
         @lineno = 0
       end
 
+      protected def create_raw_stream
+        Raw::Decompressor.new @options
+      end
+
       protected def initialize_source_buffer_length
         source_buffer_length = @options[:source_buffer_length]
         Validation.validate_not_negative_integer source_buffer_length unless source_buffer_length.nil?
 
         source_buffer_length = Buffer::DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR \
-          if source_buffer_length == 0 || source_buffer_length.nil?
+          if source_buffer_length.nil? || source_buffer_length.zero?
 
         @source_buffer_length = source_buffer_length
       end
 
-      protected def create_raw_stream
-        Raw::Decompressor.new @options
-      end
-
       protected def reset_io_remainder
         @io_remainder = ::String.new :encoding => ::Encoding::BINARY
       end
 
+      protected def reset_need_to_flush
+        @need_to_flush = false
+      end
+
       # -- synchronous --
 
       def read(bytes_to_read = nil, out_buffer = nil)
         Validation.validate_not_negative_integer bytes_to_read unless bytes_to_read.nil?
         Validation.validate_string out_buffer unless out_buffer.nil?
 
-        return ::String.new :encoding => ::Encoding::BINARY if bytes_to_read == 0
-
         unless bytes_to_read.nil?
+          return ::String.new :encoding => ::Encoding::BINARY if bytes_to_read.zero?
           return nil if eof?
 
-          read_more_from_buffer until @buffer.bytesize >= bytes_to_read || @io.eof?
+          append_io_data @io.read(@source_buffer_length) while @buffer.bytesize < bytes_to_read && !@io.eof?
+          flush_io_data if @buffer.bytesize < bytes_to_read
 
           return read_bytes_from_buffer bytes_to_read, out_buffer
         end
 
-        read_more_from_buffer until @io.eof?
-
-        result = @buffer
-        reset_buffer
-        @pos += result.bytesize
+        append_io_data @io.read(@source_buffer_length) until @io.eof?
+        flush_io_data
 
-        result.force_encoding @external_encoding unless @external_encoding.nil?
-        result = transcode_to_internal result
-        result = out_buffer.replace result unless out_buffer.nil?
-
-        result
-      end
-
-      protected def read_more_from_buffer
-        io_data = @io.read @source_buffer_length
-        append_io_data_to_buffer io_data
-      end
-
-      def readpartial(bytes_to_read = nil, out_buffer = nil)
-        raise ::EOFError if eof?
-
-        readpartial_from_buffer until @buffer.bytesize >= bytes_to_read || @io.eof?
-
-        read_bytes_from_buffer bytes_to_read, out_buffer
-      end
-
-      protected def readpartial_from_buffer
-        io_data = @io.readpartial @source_buffer_length
-        append_io_data_to_buffer io_data
+        read_buffer out_buffer
       end
 
       def rewind
         raw_wrapper :close
 
         reset_io_remainder
+        reset_need_to_flush
 
         super
       end
@@ -103,25 +84,61 @@ module LZWS
         super
       end
 
+      def eof?
+        empty? && @io.eof?
+      end
+
       # -- asynchronous --
 
+      def readpartial(bytes_to_read, out_buffer = nil)
+        read_more_nonblock(bytes_to_read, out_buffer) { @io.readpartial @source_buffer_length }
+      end
+
       def read_nonblock(bytes_to_read, out_buffer = nil, *options)
-        raise ::EOFError if eof?
+        read_more_nonblock(bytes_to_read, out_buffer) { @io.read_nonblock(@source_buffer_length, *options) }
+      end
+
+      protected def read_more_nonblock(bytes_to_read, out_buffer, &_block)
+        Validation.validate_not_negative_integer bytes_to_read
+        Validation.validate_string out_buffer unless out_buffer.nil?
+
+        return ::String.new :encoding => ::Encoding::BINARY if bytes_to_read.zero?
+
+        io_provided_eof_error = false
 
-        read_more_from_buffer_nonblock(*options) until @buffer.bytesize >= bytes_to_read || @io.eof?
+        if @buffer.bytesize < bytes_to_read
+          begin
+            append_io_data yield
+          rescue ::EOFError
+            io_provided_eof_error = true
+          end
+        end
+
+        flush_io_data if @buffer.bytesize < bytes_to_read
+        raise ::EOFError if empty? && io_provided_eof_error
 
         read_bytes_from_buffer bytes_to_read, out_buffer
       end
 
-      protected def read_more_from_buffer_nonblock(*options)
-        io_data = @io.read_nonblock @source_buffer_length, *options
-        append_io_data_to_buffer io_data
+      # -- common --
+
+      protected def append_io_data(io_data)
+        io_portion    = @io_remainder + io_data
+        bytes_read    = raw_wrapper :read, io_portion
+        @io_remainder = io_portion.byteslice bytes_read, io_portion.bytesize - bytes_read
+
+        # Even empty io data may require flush.
+        @need_to_flush = true
       end
 
-      # -- common --
+      protected def flush_io_data
+        raw_wrapper :flush
 
-      def eof?
-        @io.eof? && @buffer.bytesize == 0
+        @need_to_flush = false
+      end
+
+      protected def empty?
+        !@need_to_flush && @buffer.bytesize.zero?
       end
 
       protected def read_bytes_from_buffer(bytes_to_read, out_buffer)
@@ -136,18 +153,20 @@ module LZWS
         result
       end
 
-      protected def append_io_data_to_buffer(io_data)
-        io_portion    = @io_remainder + io_data
-        bytes_read    = raw_wrapper :read, io_portion
-        @io_remainder = io_portion.byteslice bytes_read, io_portion.bytesize - bytes_read
+      protected def read_buffer(out_buffer)
+        result = @buffer
+        reset_buffer
+        @pos += result.bytesize
 
-        # We should just ignore case when "io.eof?" appears but "io_remainder" is not empty.
-        # Ancient compress implementations can write bytes from not initialized buffer parts to output.
-        raw_wrapper :flush if @io.eof?
+        result.force_encoding @external_encoding unless @external_encoding.nil?
+        result = transcode_to_internal result
+
+        result = out_buffer.replace result unless out_buffer.nil?
+        result
       end
 
       protected def transcode_to_internal(data)
-        data = data.encode @internal_encoding, @transcode_options unless @internal_encoding.nil?
+        data = data.encode @internal_encoding, **@transcode_options unless @internal_encoding.nil?
         data
       end
 

data/lib/lzws/stream/reader_helpers.rb

@@ -1,6 +1,8 @@
 # Ruby bindings for lzws library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "English"
+
 require_relative "../validation"
 
 module LZWS

data/lib/lzws/stream/writer.rb

@@ -64,7 +64,7 @@ module LZWS
       end
 
       protected def write_remaining_buffer
-        return nil if @buffer.bytesize == 0
+        return nil if @buffer.bytesize.zero?
 
         @io.write @buffer
 
@@ -77,6 +77,11 @@ module LZWS
 
       # -- asynchronous --
 
+      # IO write nonblock can raise wait writable error.
+      # After resolving this error user may provide same content again.
+      # It is not possible to revert accepted content after error.
+      # So we have to accept content after processing IO write nonblock.
+      # It means that first write nonblock won't call IO write nonblock.
       def write_nonblock(object, *options)
         return 0 unless write_remaining_buffer_nonblock(*options)
 
@@ -120,14 +125,14 @@ module LZWS
       end
 
       protected def write_remaining_buffer_nonblock(*options)
-        return true if @buffer.bytesize == 0
+        return true if @buffer.bytesize.zero?
 
         bytes_written = @io.write_nonblock @buffer, *options
-        return false if bytes_written == 0
+        return false if bytes_written.zero?
 
         @buffer = @buffer.byteslice bytes_written, @buffer.bytesize - bytes_written
 
-        @buffer.bytesize == 0
+        @buffer.bytesize.zero?
       end
 
       protected def raw_nonblock_wrapper(method_name, *args)
@@ -137,7 +142,7 @@ module LZWS
       # -- common --
 
       protected def transcode(data)
-        data = data.encode @external_encoding, @transcode_options unless @external_encoding.nil?
+        data = data.encode @external_encoding, **@transcode_options unless @external_encoding.nil?
         data
       end
     end

data/lib/lzws/stream/writer_helpers.rb

@@ -1,6 +1,8 @@
 # Ruby bindings for lzws library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "English"
+
 require_relative "../error"
 require_relative "../validation"
 
@@ -11,18 +13,13 @@ module LZWS
         write object
       end
 
-      def print(*objects)
-        if objects.empty?
-          write $LAST_READ_LINE unless $LAST_READ_LINE.nil?
-          return nil
-        end
-
+      def print(*objects, field_separator: $OUTPUT_FIELD_SEPARATOR, record_separator: $OUTPUT_RECORD_SEPARATOR)
         objects.each do |object|
           write object
-          write $OUTPUT_FIELD_SEPARATOR unless $OUTPUT_FIELD_SEPARATOR.nil?
+          write field_separator unless field_separator.nil?
         end
 
-        write $OUTPUT_RECORD_SEPARATOR unless $OUTPUT_RECORD_SEPARATOR.nil?
+        write record_separator unless record_separator.nil?
 
         nil
       end
@@ -34,9 +31,10 @@ module LZWS
       end
 
       def putc(object, encoding: ::Encoding::BINARY)
-        if object.is_a? ::Numeric
+        case object
+        when ::Numeric
           write object.chr(encoding)
-        elsif object.is_a? ::String
+        when ::String
           write object[0]
         else
           raise ValidateError, "invalid object: \"#{object}\" for putc"

data/lib/lzws/validation.rb

@@ -5,12 +5,25 @@ require_relative "error"
 
 module LZWS
   module Validation
+    IO_METHODS = %i[
+      read
+      write
+      readpartial
+      read_nonblock
+      write_nonblock
+      eof?
+      flush
+      close
+      closed?
+    ]
+    .freeze
+
     def self.validate_bool(value)
       raise ValidateError, "invalid bool" unless value.is_a?(::TrueClass) || value.is_a?(::FalseClass)
     end
 
     def self.validate_positive_integer(value)
-      raise ValidateError, "invalid positive integer" unless value.is_a?(::Integer) && value > 0
+      raise ValidateError, "invalid positive integer" unless value.is_a?(::Integer) && value.positive?
     end
 
     def self.validate_not_negative_integer(value)
@@ -22,7 +35,7 @@ module LZWS
     end
 
     def self.validate_io(value)
-      raise ValidateError, "invalid io" unless value.is_a? ::IO
+      raise ValidateError, "invalid io" unless IO_METHODS.all? { |method| value.respond_to? method }
     end
 
     def self.validate_hash(value)

data/lib/lzws/version.rb

@@ -2,5 +2,5 @@
 # Copyright (c) 2019 AUTHORS, MIT License.
 
 module LZWS
-  VERSION = "1.1.1".freeze
+  VERSION = "1.1.6".freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lzws
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.6
 platform: ruby
 authors:
 - Andrew Aladjev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitar
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rails
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
 description: 
 email: aladjev.andrew@gmail.com
 executables: []
@@ -163,16 +191,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for lzws library.