ruby-lzws 1.1.0 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08551ca534634f131621d9bea42ec6d06bf7b1be6f3f7f3cb33bd11f9744ec1a'
-  data.tar.gz: db0b8c35c381df919bb9b21b9064abd4d88bdc28a82cdead9365f97c4e698b96
+  metadata.gz: a57fe20aab5886c14c0891ae6d61992532bb93a39a3ac3bac615d274666b9cee
+  data.tar.gz: '09fe72cfbf5aa061849efcbb3b73148dcb4481ccf9284544cbb74c2ee20de88d'
 SHA512:
-  metadata.gz: 0063ee032bf5b6cac9d7e16e696e235c18acec9a6ae48a66c5516906ca290b1c30fb6a0867d371b7b2404706a7523130e00e3b7bb17c1484017a0862a0c7c03f
-  data.tar.gz: eb1905eb2a128c716ffec1693b5be4ce94fb52894ea60adcb446ae03cc3263d8b51b62092e7e164085e875dac752a328b110c68bfdcfc631356d294ec3c50bd6
+  metadata.gz: 0c54fcae56fd3316e5a5ef3a84d381bc9a0c878c4f37a3b012a01cda98de8a8580809cfe03b81614260ba2518833aa691db6180a49862d0f41954f391ca8b1f2
+  data.tar.gz: 640e27b7c541376b0c816158749dda2b7f40926c0b773d48255135be98261f3110ed75711b7ee648d1ea1f316aaf4a951068d89eebc672b45e75013f993d4320

data/README.md

@@ -1,13 +1,14 @@
 # Ruby bindings for lzws library
 
-[![Travis build status](https://travis-ci.org/andrew-aladev/ruby-lzws.svg?branch=master)](https://travis-ci.org/andrew-aladev/ruby-lzws)
-[![AppVeyor build 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)
+| 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) |
 
 See [lzws library](https://github.com/andrew-aladev/lzws).
 
 ## Installation
 
-Please install lzws library first.
+Please install lzws library first, use latest 1.3.0+ version.
 
 ```sh
 gem install ruby-lzws
@@ -35,6 +36,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.
@@ -81,7 +103,7 @@ Values: 0, 2 - infinity, default value: 0.
 :max_code_bit_length
 ```
 
-Values: 9 - 16, default value: 16.
+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
@@ -185,7 +207,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.
 
@@ -219,7 +241,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)
@@ -229,7 +251,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)
@@ -251,11 +273,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.
 
@@ -290,7 +312,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)
@@ -300,14 +322,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
@@ -330,7 +352,15 @@ 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
+
+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.
 
 ## License
 

data/ext/extconf.rb

@@ -3,51 +3,57 @@
 
 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 "lzws/buffer.h"
+require_header "lzws/common.h", %w[lzws_result_t]
 require_header "lzws/compressor/common.h"
 require_header "lzws/compressor/main.h"
-require_header "lzws/compressor/state.h"
+require_header "lzws/compressor/state.h", %w[lzws_compressor_state_t]
 require_header "lzws/decompressor/common.h"
 require_header "lzws/decompressor/main.h"
-require_header "lzws/decompressor/state.h"
+require_header "lzws/decompressor/state.h", %w[lzws_decompressor_state_t]
 require_header "lzws/file.h"
 
 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
 
-functions = %w[
-  lzws_create_source_buffer_for_compressor
-  lzws_create_destination_buffer_for_compressor
-  lzws_create_source_buffer_for_decompressor
-  lzws_create_destination_buffer_for_decompressor
-
-  lzws_compressor_get_initial_state
-  lzws_compressor_free_state
-  lzws_compress
-  lzws_compressor_finish
+require_library(
+  "lzws",
+  %w[
+    lzws_create_source_buffer_for_compressor
+    lzws_create_destination_buffer_for_compressor
+    lzws_create_source_buffer_for_decompressor
+    lzws_create_destination_buffer_for_decompressor
 
-  lzws_decompressor_get_initial_state
-  lzws_decompressor_free_state
-  lzws_decompress
+    lzws_compressor_get_initial_state
+    lzws_compressor_free_state
+    lzws_compress
+    lzws_compressor_finish
 
-  lzws_compress_file
-  lzws_decompress_file
-]
-.freeze
+    lzws_decompressor_get_initial_state
+    lzws_decompressor_free_state
+    lzws_decompress
 
-require_library "lzws", functions
+    lzws_compress_file
+    lzws_decompress_file
+  ]
+)
 
 extension_name = "lzws_ext".freeze
 dir_config extension_name
 
-sources = %w[
+# rubocop:disable Style/GlobalVars
+$srcs = %w[
   stream/compressor
   stream/decompressor
   buffer
@@ -57,14 +63,16 @@ 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
+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/buffer.c

@@ -7,12 +7,24 @@
 
 #include "ruby.h"
 
+VALUE lzws_ext_create_string_buffer(VALUE length)
+{
+  return rb_str_new(NULL, NUM2SIZET(length));
+}
+
+VALUE lzws_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 lzws_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(LZWS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR));
-  rb_define_const(option, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR", UINT2NUM(LZWS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR));
-  rb_define_const(option, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR", UINT2NUM(LZWS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR));
-  rb_define_const(option, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR", UINT2NUM(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

@@ -6,6 +6,18 @@
 
 #include "ruby.h"
 
+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);
+
+#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);
+
 void lzws_ext_buffer_exports(VALUE root_module);
 
 #endif // LZWS_EXT_BUFFER_H

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))
@@ -13,9 +12,9 @@ static inline NORETURN(void raise(const char* name, const char* description))
   rb_raise(error, "%s", description);
 }
 
-void lzws_ext_raise_error(lzws_ext_result_t result)
+void lzws_ext_raise_error(lzws_ext_result_t ext_result)
 {
-  switch (result) {
+  switch (ext_result) {
     case LZWS_EXT_ERROR_ALLOCATE_FAILED:
       raise("AllocateError", "allocate error");
     case LZWS_EXT_ERROR_VALIDATE_FAILED:

data/ext/lzws_ext/error.h

@@ -25,6 +25,6 @@ enum {
   LZWS_EXT_ERROR_UNEXPECTED
 };
 
-NORETURN(void lzws_ext_raise_error(lzws_ext_result_t result));
+NORETURN(void lzws_ext_raise_error(lzws_ext_result_t ext_result));
 
 #endif // LZWS_EXT_ERROR_H

data/ext/lzws_ext/io.c

@@ -3,9 +3,9 @@
 
 #include "ruby/io.h"
 
+#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"
@@ -63,8 +63,7 @@ VALUE lzws_ext_compress_io(VALUE LZWS_EXT_UNUSED(self), VALUE source, VALUE dest
     without_magic_header, max_code_bit_length, block_mode, msb, unaligned_bit_groups, quiet);
 
   if (result != 0) {
-    lzws_ext_result_t ext_result = get_file_error(result);
-    lzws_ext_raise_error(ext_result);
+    lzws_ext_raise_error(get_file_error(result));
   }
 
   // Ruby itself won't flush stdio file before closing fd, flush is required.
@@ -88,8 +87,7 @@ VALUE lzws_ext_decompress_io(VALUE LZWS_EXT_UNUSED(self), VALUE source, VALUE de
     without_magic_header, msb, unaligned_bit_groups, quiet);
 
   if (result != 0) {
-    lzws_ext_result_t ext_result = get_file_error(result);
-    lzws_ext_raise_error(ext_result);
+    lzws_ext_raise_error(get_file_error(result));
   }
 
   // Ruby itself won't flush stdio file before closing fd, flush is required.

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,8 +3,6 @@
 
 #include "lzws_ext/option.h"
 
-#include <stdbool.h>
-
 #include "lzws_ext/error.h"
 #include "ruby.h"
 
@@ -25,7 +23,7 @@ bool lzws_ext_get_bool_option_value(VALUE options, const char* name)
   return raw_type == T_TRUE;
 }
 
-unsigned long lzws_ext_get_fixnum_option_value(VALUE options, const char* name)
+unsigned int lzws_ext_get_uint_option_value(VALUE options, const char* name)
 {
   VALUE raw_value = get_raw_option_value(options, name);
 
@@ -33,3 +31,12 @@ unsigned long lzws_ext_get_fixnum_option_value(VALUE options, const char* name)
 
   return NUM2UINT(raw_value);
 }
+
+size_t lzws_ext_get_size_option_value(VALUE options, const char* name)
+{
+  VALUE raw_value = get_raw_option_value(options, name);
+
+  Check_Type(raw_value, T_FIXNUM);
+
+  return NUM2SIZET(raw_value);
+}

data/ext/lzws_ext/option.h

@@ -5,24 +5,30 @@
 #define LZWS_EXT_OPTIONS_H
 
 #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);
-unsigned long lzws_ext_get_fixnum_option_value(VALUE options, const char* name);
+bool         lzws_ext_get_bool_option_value(VALUE options, const char* name);
+unsigned int lzws_ext_get_uint_option_value(VALUE options, const char* name);
+size_t       lzws_ext_get_size_option_value(VALUE options, const char* name);
 
 #define LZWS_EXT_GET_BOOL_OPTION(options, name) \
   bool name = lzws_ext_get_bool_option_value(options, #name);
 
-#define LZWS_EXT_GET_FIXNUM_OPTION(options, type, name) \
-  type name = lzws_ext_get_fixnum_option_value(options, #name);
+#define LZWS_EXT_GET_UINT_OPTION(options, type, name) \
+  type name = lzws_ext_get_uint_option_value(options, #name);
 
-#define LZWS_EXT_GET_COMPRESSOR_OPTIONS(options)                          \
-  LZWS_EXT_GET_BOOL_OPTION(options, without_magic_header);                \
-  LZWS_EXT_GET_FIXNUM_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_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, 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)         \
@@ -32,6 +38,6 @@ unsigned long lzws_ext_get_fixnum_option_value(VALUE options, const char* name);
   LZWS_EXT_GET_BOOL_OPTION(options, quiet);
 
 #define LZWS_EXT_GET_BUFFER_LENGTH_OPTION(options, name) \
-  LZWS_EXT_GET_FIXNUM_OPTION(options, size_t, name);
+  LZWS_EXT_GET_SIZE_OPTION(options, name);
 
 #endif // LZWS_EXT_OPTIONS_H