ruby-lzws 1.2.0 → 1.4.1

data/ext/lzws_ext/string.c

@@ -12,9 +12,9 @@
 
 #include "lzws_ext/buffer.h"
 #include "lzws_ext/error.h"
+#include "lzws_ext/gvl.h"
 #include "lzws_ext/macro.h"
 #include "lzws_ext/option.h"
-#include "ruby.h"
 
 // -- buffer --
 
@@ -41,30 +41,67 @@ static inline lzws_ext_result_t increase_destination_buffer(
   return 0;
 }
 
-// -- utils --
+// -- compress --
 
-#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);
+typedef struct
+{
+  lzws_compressor_state_t* state_ptr;
+  lzws_ext_byte_t**        remaining_source_ptr;
+  size_t*                  remaining_source_length_ptr;
+  lzws_ext_byte_t*         remaining_destination_buffer;
+  size_t*                  remaining_destination_buffer_length_ptr;
+  lzws_result_t            result;
+} compress_args_t;
+
+typedef struct
+{
+  lzws_compressor_state_t* state_ptr;
+  lzws_ext_byte_t*         remaining_destination_buffer;
+  size_t*                  remaining_destination_buffer_length_ptr;
+  lzws_result_t            result;
+} compressor_finish_args_t;
 
-// -- compress --
+static inline void* compress_wrapper(void* data)
+{
+  compress_args_t* args = data;
+
+  args->result = lzws_compress(
+    args->state_ptr,
+    args->remaining_source_ptr,
+    args->remaining_source_length_ptr,
+    &args->remaining_destination_buffer,
+    args->remaining_destination_buffer_length_ptr);
+
+  return NULL;
+}
+
+static inline void* compressor_finish_wrapper(void* data)
+{
+  compressor_finish_args_t* args = data;
+
+  args->result = lzws_compressor_finish(
+    args->state_ptr, &args->remaining_destination_buffer, args->remaining_destination_buffer_length_ptr);
+
+  return NULL;
+}
 
-#define BUFFERED_COMPRESS(function, ...)                                                                         \
+#define BUFFERED_COMPRESS(gvl, wrapper, args)                                                                    \
   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) {                                       \
+    args.remaining_destination_buffer            = remaining_destination_buffer;                                 \
+    args.remaining_destination_buffer_length_ptr = &remaining_destination_buffer_length;                         \
+                                                                                                                 \
+    LZWS_EXT_GVL_WRAP(gvl, wrapper, &args);                                                                      \
+    if (args.result != 0 && args.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) {                                                      \
+    if (args.result == LZWS_COMPRESSOR_NEEDS_MORE_DESTINATION) {                                                 \
       ext_result = increase_destination_buffer(                                                                  \
         destination_value, destination_length, &remaining_destination_buffer_length, destination_buffer_length); \
                                                                                                                  \
@@ -83,17 +120,24 @@ static inline lzws_ext_result_t compress(
   const char*              source,
   size_t                   source_length,
   VALUE                    destination_value,
-  size_t                   destination_buffer_length)
+  size_t                   destination_buffer_length,
+  bool                     gvl)
 {
-  lzws_result_t     result;
   lzws_ext_result_t ext_result;
   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;
 
-  BUFFERED_COMPRESS(lzws_compress, state_ptr, &remaining_source, &remaining_source_length);
-  BUFFERED_COMPRESS(lzws_compressor_finish, state_ptr);
+  compress_args_t args = {
+    .state_ptr                   = state_ptr,
+    .remaining_source_ptr        = &remaining_source,
+    .remaining_source_length_ptr = &remaining_source_length};
+
+  BUFFERED_COMPRESS(gvl, compress_wrapper, args);
+
+  compressor_finish_args_t finish_args = {.state_ptr = state_ptr};
+  BUFFERED_COMPRESS(gvl, compressor_finish_wrapper, finish_args);
 
   int exception;
 
@@ -107,10 +151,11 @@ static inline lzws_ext_result_t compress(
 
 VALUE lzws_ext_compress_string(VALUE LZWS_EXT_UNUSED(self), VALUE source_value, VALUE options)
 {
-  GET_SOURCE_DATA(source_value);
+  Check_Type(source_value, T_STRING);
   Check_Type(options, T_HASH);
+  LZWS_EXT_GET_SIZE_OPTION(options, destination_buffer_length);
+  LZWS_EXT_GET_BOOL_OPTION(options, gvl);
   LZWS_EXT_GET_COMPRESSOR_OPTIONS(options);
-  LZWS_EXT_GET_BUFFER_LENGTH_OPTION(options, destination_buffer_length);
 
   lzws_compressor_state_t* state_ptr;
 
@@ -138,8 +183,11 @@ VALUE lzws_ext_compress_string(VALUE LZWS_EXT_UNUSED(self), VALUE source_value,
     lzws_ext_raise_error(LZWS_EXT_ERROR_ALLOCATE_FAILED);
   }
 
+  const char* source        = RSTRING_PTR(source_value);
+  size_t      source_length = RSTRING_LEN(source_value);
+
   lzws_ext_result_t ext_result =
-    compress(state_ptr, source, source_length, destination_value, destination_buffer_length);
+    compress(state_ptr, source, source_length, destination_value, destination_buffer_length, gvl);
 
   lzws_compressor_free_state(state_ptr);
 
@@ -152,34 +200,60 @@ VALUE lzws_ext_compress_string(VALUE LZWS_EXT_UNUSED(self), VALUE source_value,
 
 // -- decompress --
 
+typedef struct
+{
+  lzws_decompressor_state_t* state_ptr;
+  lzws_ext_byte_t**          remaining_source_ptr;
+  size_t*                    remaining_source_length_ptr;
+  lzws_ext_byte_t*           remaining_destination_buffer;
+  size_t*                    remaining_destination_buffer_length_ptr;
+  lzws_result_t              result;
+} decompress_args_t;
+
+static inline void* decompress_wrapper(void* data)
+{
+  decompress_args_t* args = data;
+
+  args->result = lzws_decompress(
+    args->state_ptr,
+    args->remaining_source_ptr,
+    args->remaining_source_length_ptr,
+    &args->remaining_destination_buffer,
+    args->remaining_destination_buffer_length_ptr);
+
+  return NULL;
+}
+
 static inline lzws_ext_result_t decompress(
   lzws_decompressor_state_t* state_ptr,
   const char*                source,
   size_t                     source_length,
   VALUE                      destination_value,
-  size_t                     destination_buffer_length)
+  size_t                     destination_buffer_length,
+  bool                       gvl)
 {
-  lzws_result_t     result;
   lzws_ext_result_t ext_result;
   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;
 
+  decompress_args_t args = {
+    .state_ptr                   = state_ptr,
+    .remaining_source_ptr        = &remaining_source,
+    .remaining_source_length_ptr = &remaining_source_length};
+
   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 = lzws_decompress(
-      state_ptr,
-      &remaining_source,
-      &remaining_source_length,
-      &remaining_destination_buffer,
-      &remaining_destination_buffer_length);
+    args.remaining_destination_buffer            = remaining_destination_buffer;
+    args.remaining_destination_buffer_length_ptr = &remaining_destination_buffer_length;
 
-    if (result != 0 && result != LZWS_DECOMPRESSOR_NEEDS_MORE_DESTINATION) {
-      switch (result) {
+    LZWS_EXT_GVL_WRAP(gvl, decompress_wrapper, &args);
+    if (args.result != 0 && args.result != LZWS_DECOMPRESSOR_NEEDS_MORE_DESTINATION) {
+      switch (args.result) {
         case LZWS_DECOMPRESSOR_INVALID_MAGIC_HEADER:
         case LZWS_DECOMPRESSOR_INVALID_MAX_CODE_BIT_LENGTH:
           return LZWS_EXT_ERROR_VALIDATE_FAILED;
@@ -192,7 +266,7 @@ static inline lzws_ext_result_t decompress(
 
     destination_length += prev_remaining_destination_buffer_length - remaining_destination_buffer_length;
 
-    if (result == LZWS_DECOMPRESSOR_NEEDS_MORE_DESTINATION) {
+    if (args.result == LZWS_DECOMPRESSOR_NEEDS_MORE_DESTINATION) {
       ext_result = increase_destination_buffer(
         destination_value, destination_length, &remaining_destination_buffer_length, destination_buffer_length);
 
@@ -218,10 +292,11 @@ static inline lzws_ext_result_t decompress(
 
 VALUE lzws_ext_decompress_string(VALUE LZWS_EXT_UNUSED(self), VALUE source_value, VALUE options)
 {
-  GET_SOURCE_DATA(source_value);
+  Check_Type(source_value, T_STRING);
   Check_Type(options, T_HASH);
+  LZWS_EXT_GET_SIZE_OPTION(options, destination_buffer_length);
+  LZWS_EXT_GET_BOOL_OPTION(options, gvl);
   LZWS_EXT_GET_DECOMPRESSOR_OPTIONS(options);
-  LZWS_EXT_GET_BUFFER_LENGTH_OPTION(options, destination_buffer_length);
 
   lzws_decompressor_state_t* state_ptr;
 
@@ -247,8 +322,11 @@ VALUE lzws_ext_decompress_string(VALUE LZWS_EXT_UNUSED(self), VALUE source_value
     lzws_ext_raise_error(LZWS_EXT_ERROR_ALLOCATE_FAILED);
   }
 
+  const char* source        = RSTRING_PTR(source_value);
+  size_t      source_length = RSTRING_LEN(source_value);
+
   lzws_ext_result_t ext_result =
-    decompress(state_ptr, source, source_length, destination_value, destination_buffer_length);
+    decompress(state_ptr, source, source_length, destination_value, destination_buffer_length, gvl);
 
   lzws_decompressor_free_state(state_ptr);
 
@@ -259,6 +337,8 @@ VALUE lzws_ext_decompress_string(VALUE LZWS_EXT_UNUSED(self), VALUE source_value
   return destination_value;
 }
 
+// -- exports --
+
 void lzws_ext_string_exports(VALUE root_module)
 {
   rb_define_module_function(root_module, "_native_compress_string", RUBY_METHOD_FUNC(lzws_ext_compress_string), 2);

data/lib/lzws/file.rb

@@ -17,7 +17,7 @@ module LZWS
 
       options = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
 
-      open_files(source, destination) do |source_io, destination_io|
+      open_files source, destination do |source_io, destination_io|
         LZWS._native_compress_io source_io, destination_io, options
       end
 
@@ -30,7 +30,7 @@ module LZWS
 
       options = Option.get_decompressor_options options, BUFFER_LENGTH_NAMES
 
-      open_files(source, destination) do |source_io, destination_io|
+      open_files source, destination do |source_io, destination_io|
         LZWS._native_decompress_io source_io, destination_io, options
       end
 

data/lib/lzws/option.rb

@@ -10,14 +10,39 @@ module LZWS
   module Option
     DEFAULT_BUFFER_LENGTH = 0
 
+    COMPRESSOR_DEFAULTS = {
+      :gvl                  => false,
+      :max_code_bit_length  => nil,
+      :without_magic_header => nil,
+      :block_mode           => nil,
+      :msb                  => nil,
+      :unaligned_bit_groups => nil,
+      :quiet                => nil
+    }
+    .freeze
+
+    DECOMPRESSOR_DEFAULTS = {
+      :gvl                  => false,
+      :without_magic_header => nil,
+      :msb                  => nil,
+      :unaligned_bit_groups => nil,
+      :quiet                => nil
+    }
+    .freeze
+
     def self.get_compressor_options(options, buffer_length_names)
       Validation.validate_hash options
 
-      buffer_length_defaults = buffer_length_names.each_with_object({}) { |name, defaults| defaults[name] = DEFAULT_BUFFER_LENGTH }
-      options                = buffer_length_defaults.merge options
+      buffer_length_defaults = buffer_length_names.each_with_object({}) do |name, defaults|
+        defaults[name] = DEFAULT_BUFFER_LENGTH
+      end
+
+      options = COMPRESSOR_DEFAULTS.merge(buffer_length_defaults).merge options
 
       buffer_length_names.each { |name| Validation.validate_not_negative_integer options[name] }
 
+      Validation.validate_bool options[:gvl]
+
       max_code_bit_length = options[:max_code_bit_length]
       unless max_code_bit_length.nil?
         Validation.validate_positive_integer max_code_bit_length
@@ -46,11 +71,16 @@ module LZWS
     def self.get_decompressor_options(options, buffer_length_names)
       Validation.validate_hash options
 
-      buffer_length_defaults = buffer_length_names.each_with_object({}) { |name, defaults| defaults[name] = DEFAULT_BUFFER_LENGTH }
-      options                = buffer_length_defaults.merge options
+      buffer_length_defaults = buffer_length_names.each_with_object({}) do |name, defaults|
+        defaults[name] = DEFAULT_BUFFER_LENGTH
+      end
+
+      options = DECOMPRESSOR_DEFAULTS.merge(buffer_length_defaults).merge options
 
       buffer_length_names.each { |name| Validation.validate_not_negative_integer options[name] }
 
+      Validation.validate_bool options[:gvl]
+
       without_magic_header = options[:without_magic_header]
       Validation.validate_bool without_magic_header unless without_magic_header.nil?
 

data/lib/lzws/stream/abstract.rb

@@ -12,7 +12,8 @@ module LZWS
       # Native stream is not seekable by design.
       # Related methods like "seek" and "pos=" can't be implemented.
 
-      # It is not possible to maintain correspondance between bytes consumed from source and bytes written to destination by design.
+      # It is not possible to maintain correspondance between bytes
+      # consumed from source and bytes written to destination by design.
       # We will consume all source bytes and maintain buffer with remaining destination data.
 
       include Delegates
@@ -89,8 +90,9 @@ module LZWS
         end
 
         internal_encoding = args[1]
-        Validation.validate_string internal_encoding \
-          unless internal_encoding.nil? || internal_encoding.is_a?(::Encoding)
+        unless internal_encoding.nil? || internal_encoding.is_a?(::Encoding)
+          Validation.validate_string internal_encoding
+        end
 
         transcode_options = args[2]
         Validation.validate_hash transcode_options unless transcode_options.nil?

data/lib/lzws/stream/reader.rb

@@ -33,8 +33,9 @@ module LZWS
         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.nil? || source_buffer_length.zero?
+        if source_buffer_length.nil? || source_buffer_length.zero?
+          source_buffer_length = Buffer::DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR
+        end
 
         @source_buffer_length = source_buffer_length
       end

data/lib/lzws/stream/reader_helpers.rb

@@ -143,7 +143,7 @@ module LZWS
       end
 
       protected def each_string(each_proc, &block)
-        return enum_for __method__ unless block.is_a? ::Proc
+        return enum_for __method__, each_proc unless block.is_a? ::Proc
 
         loop do
           string = each_proc.call

data/lib/lzws/validation.rb

@@ -43,7 +43,9 @@ module LZWS
     end
 
     def self.validate_proc(value)
-      raise ValidateError, "invalid proc" unless value.is_a?(::Proc) || value.is_a?(::Method) || value.is_a?(::UnboundMethod)
+      unless value.is_a?(::Proc) || value.is_a?(::Method) || value.is_a?(::UnboundMethod)
+        raise ValidateError, "invalid proc"
+      end
     end
   end
 end

data/lib/lzws/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lzws
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Andrew Aladjev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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
@@ -44,28 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
   name: ocg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  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
   requirement: !ruby/object:Gem::Requirement
@@ -100,28 +128,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.93'
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.93'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +192,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: aladjev.andrew@gmail.com
 executables: []
 extensions:
@@ -152,6 +208,7 @@ files:
 - ext/lzws_ext/common.h
 - ext/lzws_ext/error.c
 - ext/lzws_ext/error.h
+- ext/lzws_ext/gvl.h
 - ext/lzws_ext/io.c
 - ext/lzws_ext/io.h
 - ext/lzws_ext/macro.h
@@ -184,8 +241,9 @@ files:
 homepage: https://github.com/andrew-aladev/ruby-lzws
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,8 +258,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
-summary: Ruby bindings for lzws library.
+summary: Ruby bindings for lzws library (compatible with UNIX compress).
 test_files: []