ruby-lzws 1.3.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72fd9e1b55088bd5ba7a6d57edc857322ede1d9764b6b2eb3aeafe85193605ad
-  data.tar.gz: 2f08eb4371bef83f138233ab62a5a54b5fa01f5a2904d6d1f64ee00fb9aebd1c
+  metadata.gz: 0e48df46a2a929a961d72881cf20a4c087769576f3208cc2dee02a31b3d1f00a
+  data.tar.gz: f5fe984d47acaa03d91ca5f7d19a5e87c49b029aea37323fbd2e2c72a5f57491
 SHA512:
-  metadata.gz: beff1dd2f2016bb9660f26bd62f3eaf1fdab8af9e70c24a65bfda4090190c4c02ef66ff943346b9483f5b588ceff6b5964f33d32dfc15e017b3e7964877ce7f9
-  data.tar.gz: a5c0074902b21193725bb0f215cef8ebaad55b3a029e20d0d0b54c0382e527a86c3460feca7a36ed7754b96254497eacb4a08900a425c7bfda70fa44153e60b6
+  metadata.gz: 3ea80697e381e1a350bb49c0c267791b41783e09ccfca10348ae1c02afa090de7930d06f1a2ca8fd6ff81929f86f34ff6bf46d9b51ac83fe4dc09c558227385c
+  data.tar.gz: 7c6843ea9729056bea5bd149b31d25409e9f5d225b43e12f6305353bf5a4b820eb94104e192d02dda454cccc0adf684e17dc953719184a7b5a846570f9575225

data/README.md

@@ -8,7 +8,9 @@ See [lzws library](https://github.com/andrew-aladev/lzws).
 
 ## Installation
 
-Please install lzws library first, use latest 1.4.0+ version.
+Operating systems: GNU/Linux, FreeBSD, OSX, Windows (MinGW).
+
+Dependencies: [lzws](https://github.com/andrew-aladev/lzws) 1.4.0+ version.
 
 ```sh
 gem install ruby-lzws
@@ -354,10 +356,6 @@ 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
 
 Please visit [scripts/test-images](scripts/test-images).

data/ext/extconf.rb

@@ -5,23 +5,94 @@ require "mkmf"
 
 have_func "rb_thread_call_without_gvl", "ruby/thread.h"
 
-def require_header(name, types = [])
+def require_header(name, constants: [], macroses: [], types: [], variables: [])
   abort "Can't find #{name} header" unless find_header name
 
+  constants.each do |constant|
+    abort "Can't find #{constant} constant in #{name} header" unless have_const constant, name
+  end
+
+  macroses.each do |macro|
+    abort "Can't find #{macro} macro in #{name} header" unless have_macro macro, name
+  end
+
   types.each do |type|
     abort "Can't find #{type} type in #{name} header" unless find_type type, nil, name
   end
+
+  variables.each do |variable|
+    abort "Can't find #{variable} variable in #{name} header" unless have_var variable, name
+  end
 end
 
-require_header "lzws/buffer.h"
-require_header "lzws/common.h", %w[lzws_result_t]
-require_header "lzws/compressor/common.h", %w[lzws_compressor_options_t]
+require_header(
+  "lzws/buffer.h",
+  :macroses => %w[
+    LZWS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR
+    LZWS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR
+    LZWS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR
+    LZWS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR
+  ]
+)
+require_header(
+  "lzws/common.h",
+  :constants => %w[
+    LZWS_BIGGEST_MAX_CODE_BIT_LENGTH
+    LZWS_LOWEST_MAX_CODE_BIT_LENGTH
+  ],
+  :types     => %w[
+    lzws_byte_fast_t
+    lzws_result_t
+  ]
+)
+require_header(
+  "lzws/compressor/common.h",
+  :constants => %w[
+    LZWS_COMPRESSOR_ALLOCATE_FAILED
+    LZWS_COMPRESSOR_INVALID_MAX_CODE_BIT_LENGTH
+    LZWS_COMPRESSOR_NEEDS_MORE_DESTINATION
+  ],
+  :types     => %w[lzws_compressor_options_t],
+  :variables => %w[LZWS_COMPRESSOR_DEFAULT_OPTIONS]
+)
 require_header "lzws/compressor/main.h"
-require_header "lzws/compressor/state.h", %w[lzws_compressor_state_t]
-require_header "lzws/decompressor/common.h", %w[lzws_decompressor_options_t]
+require_header(
+  "lzws/compressor/state.h",
+  :types => %w[lzws_compressor_state_t]
+)
+require_header(
+  "lzws/config.h",
+  :macroses => %w[LZWS_VERSION]
+)
+require_header(
+  "lzws/decompressor/common.h",
+  :constants => %w[
+    LZWS_DECOMPRESSOR_ALLOCATE_FAILED
+    LZWS_DECOMPRESSOR_CORRUPTED_SOURCE
+    LZWS_DECOMPRESSOR_INVALID_MAGIC_HEADER
+    LZWS_DECOMPRESSOR_INVALID_MAX_CODE_BIT_LENGTH
+    LZWS_DECOMPRESSOR_NEEDS_MORE_DESTINATION
+  ],
+  :types     => %w[lzws_decompressor_options_t],
+  :variables => %w[LZWS_DECOMPRESSOR_DEFAULT_OPTIONS]
+)
 require_header "lzws/decompressor/main.h"
-require_header "lzws/decompressor/state.h", %w[lzws_decompressor_state_t]
-require_header "lzws/file.h"
+require_header(
+  "lzws/decompressor/state.h",
+  :types => %w[lzws_decompressor_state_t]
+)
+require_header(
+  "lzws/file.h",
+  :constants => %w[
+    LZWS_FILE_ALLOCATE_FAILED
+    LZWS_FILE_DECOMPRESSOR_CORRUPTED_SOURCE
+    LZWS_FILE_NOT_ENOUGH_DESTINATION_BUFFER
+    LZWS_FILE_NOT_ENOUGH_SOURCE_BUFFER
+    LZWS_FILE_READ_FAILED
+    LZWS_FILE_VALIDATE_FAILED
+    LZWS_FILE_WRITE_FAILED
+  ]
+)
 
 def require_library(name, functions)
   functions.each do |function|
@@ -32,22 +103,19 @@ end
 require_library(
   "lzws",
   %w[
+    lzws_compress
+    lzws_compress_file
+    lzws_compressor_finish
+    lzws_compressor_free_state
+    lzws_compressor_get_initial_state
     lzws_create_source_buffer_for_compressor
-    lzws_create_destination_buffer_for_compressor
     lzws_create_source_buffer_for_decompressor
+    lzws_create_destination_buffer_for_compressor
     lzws_create_destination_buffer_for_decompressor
-
-    lzws_compressor_get_initial_state
-    lzws_compressor_free_state
-    lzws_compress
-    lzws_compressor_finish
-
-    lzws_decompressor_get_initial_state
-    lzws_decompressor_free_state
     lzws_decompress
-
-    lzws_compress_file
     lzws_decompress_file
+    lzws_decompressor_free_state
+    lzws_decompressor_get_initial_state
   ]
 )
 

data/ext/lzws_ext/buffer.c

@@ -5,8 +5,6 @@
 
 #include <lzws/buffer.h>
 
-#include "ruby.h"
-
 VALUE lzws_ext_create_string_buffer(VALUE length)
 {
   return rb_str_new(NULL, NUM2SIZET(length));

data/ext/lzws_ext/error.c

@@ -3,8 +3,6 @@
 
 #include "lzws_ext/error.h"
 
-#include "ruby.h"
-
 static inline NORETURN(void raise_error(const char* name, const char* description))
 {
   VALUE module = rb_define_module(LZWS_EXT_MODULE_NAME);

data/ext/lzws_ext/gvl.h

@@ -4,7 +4,7 @@
 #if !defined(LZWS_EXT_GVL_H)
 #define LZWS_EXT_GVL_H
 
-#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+#if defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL)
 
 #include "ruby/thread.h"
 
@@ -19,6 +19,6 @@
 
 #define LZWS_EXT_GVL_WRAP(_gvl, function, data) function((void*) data);
 
-#endif
+#endif // HAVE_RB_THREAD_CALL_WITHOUT_GVL
 
 #endif // LZWS_EXT_GVL_H

data/ext/lzws_ext/io.c

@@ -9,7 +9,6 @@
 #include "lzws_ext/gvl.h"
 #include "lzws_ext/macro.h"
 #include "lzws_ext/option.h"
-#include "ruby.h"
 #include "ruby/io.h"
 
 // -- utils --

data/ext/lzws_ext/macro.h

@@ -8,6 +8,6 @@
 #define LZWS_EXT_UNUSED(x) x __attribute__((__unused__))
 #else
 #define LZWS_EXT_UNUSED(x) x
-#endif
+#endif // __GNUC__
 
 #endif // LZWS_EXT_MACRO_H

data/ext/lzws_ext/main.c

@@ -1,13 +1,14 @@
 // Ruby bindings for lzws library.
 // Copyright (c) 2019 AUTHORS, MIT License.
 
+#include <lzws/config.h>
+
 #include "lzws_ext/buffer.h"
 #include "lzws_ext/io.h"
 #include "lzws_ext/option.h"
 #include "lzws_ext/stream/compressor.h"
 #include "lzws_ext/stream/decompressor.h"
 #include "lzws_ext/string.h"
-#include "ruby.h"
 
 void Init_lzws_ext()
 {
@@ -19,4 +20,7 @@ void Init_lzws_ext()
   lzws_ext_compressor_exports(root_module);
   lzws_ext_decompressor_exports(root_module);
   lzws_ext_string_exports(root_module);
+
+  VALUE version = rb_str_new2(LZWS_VERSION);
+  rb_define_const(root_module, "LIBRARY_VERSION", rb_obj_freeze(version));
 }

data/ext/lzws_ext/option.c

@@ -4,7 +4,6 @@
 #include "lzws_ext/option.h"
 
 #include "lzws_ext/error.h"
-#include "ruby.h"
 
 // -- values --
 

data/ext/lzws_ext/stream/compressor.c

@@ -5,12 +5,10 @@
 
 #include <lzws/buffer.h>
 #include <lzws/compressor/main.h>
-#include <lzws/compressor/state.h>
 
 #include "lzws_ext/error.h"
 #include "lzws_ext/gvl.h"
 #include "lzws_ext/option.h"
-#include "ruby.h"
 
 // -- initialization --
 

data/ext/lzws_ext/stream/decompressor.c

@@ -5,12 +5,10 @@
 
 #include <lzws/buffer.h>
 #include <lzws/decompressor/main.h>
-#include <lzws/decompressor/state.h>
 
 #include "lzws_ext/error.h"
 #include "lzws_ext/gvl.h"
 #include "lzws_ext/option.h"
-#include "ruby.h"
 
 // -- initialization --
 

data/ext/lzws_ext/string.c

@@ -15,7 +15,6 @@
 #include "lzws_ext/gvl.h"
 #include "lzws_ext/macro.h"
 #include "lzws_ext/option.h"
-#include "ruby.h"
 
 // -- buffer --
 

data/lib/lzws/stream/abstract.rb

@@ -24,9 +24,7 @@ module LZWS
 
       def initialize(io, options = {})
         @raw_stream = create_raw_stream
-
-        Validation.validate_io io
-        @io = io
+        @io         = io
 
         @stat = Stat.new @io.stat if @io.respond_to? :stat
 
@@ -135,13 +133,19 @@ module LZWS
       end
 
       def close
-        @io.close
+        @io.close if @io.respond_to? :close
 
         nil
       end
 
       def closed?
-        @raw_stream.closed? && @io.closed?
+        return false unless @raw_stream.closed?
+
+        if @io.respond_to? :closed
+          @io.closed?
+        else
+          true
+        end
       end
 
       def to_io

data/lib/lzws/stream/reader.rb

@@ -54,6 +54,9 @@ module LZWS
         Validation.validate_not_negative_integer bytes_to_read unless bytes_to_read.nil?
         Validation.validate_string out_buffer unless out_buffer.nil?
 
+        raise ValidateError, "io should be responsible to read and eof" unless
+          @io.respond_to?(:read) && @io.respond_to?(:eof?)
+
         unless bytes_to_read.nil?
           return ::String.new :encoding => ::Encoding::BINARY if bytes_to_read.zero?
           return nil if eof?
@@ -86,16 +89,22 @@ module LZWS
       end
 
       def eof?
+        raise ValidateError, "io should be responsible to eof" unless @io.respond_to? :eof?
+
         empty? && @io.eof?
       end
 
       # -- asynchronous --
 
       def readpartial(bytes_to_read, out_buffer = nil)
+        raise ValidateError, "io should be responsible to readpartial" unless @io.respond_to? :readpartial
+
         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 ValidateError, "io should be responsible to read nonblock" unless @io.respond_to? :read_nonblock
+
         read_more_nonblock(bytes_to_read, out_buffer) { @io.read_nonblock(@source_buffer_length, *options) }
       end
 

data/lib/lzws/stream/writer.rb

@@ -23,6 +23,8 @@ module LZWS
       # -- synchronous --
 
       def write(*objects)
+        validate_write
+
         write_remaining_buffer
 
         bytes_written = 0
@@ -38,20 +40,26 @@ module LZWS
       end
 
       def flush
+        validate_write
+
         finish :flush
 
-        @io.flush
+        @io.flush if @io.respond_to? :flush
 
         self
       end
 
       def rewind
+        validate_write
+
         finish :close
 
         super
       end
 
       def close
+        validate_write
+
         finish :close
 
         super
@@ -75,6 +83,10 @@ module LZWS
         @raw_stream.send(method_name, *args) { |portion| @io.write portion }
       end
 
+      def validate_write
+        raise ValidateError, "io should be responsible to write" unless @io.respond_to? :write
+      end
+
       # -- asynchronous --
 
       # IO write nonblock can raise wait writable error.
@@ -83,6 +95,8 @@ module LZWS
       # 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)
+        validate_write_nonblock
+
         return 0 unless write_remaining_buffer_nonblock(*options)
 
         source         = transcode object.to_s
@@ -93,14 +107,18 @@ module LZWS
       end
 
       def flush_nonblock(*options)
+        validate_write_nonblock
+
         return false unless finish_nonblock :flush, *options
 
-        @io.flush
+        @io.flush if @io.respond_to? :flush
 
         true
       end
 
       def rewind_nonblock(*options)
+        validate_write_nonblock
+
         return false unless finish_nonblock :close, *options
 
         method(:rewind).super_method.call
@@ -109,6 +127,8 @@ module LZWS
       end
 
       def close_nonblock(*options)
+        validate_write_nonblock
+
         return false unless finish_nonblock :close, *options
 
         method(:close).super_method.call
@@ -139,6 +159,10 @@ module LZWS
         @raw_stream.send(method_name, *args) { |portion| @buffer << portion }
       end
 
+      def validate_write_nonblock
+        raise ValidateError, "io should be responsible to write nonblock" unless @io.respond_to? :write_nonblock
+      end
+
       # -- common --
 
       protected def transcode(data)

data/lib/lzws/validation.rb

@@ -5,41 +5,20 @@ 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.positive?
+    def self.validate_hash(value)
+      raise ValidateError, "invalid hash" unless value.is_a? ::Hash
     end
 
     def self.validate_not_negative_integer(value)
       raise ValidateError, "invalid not negative integer" unless value.is_a?(::Integer) && value >= 0
     end
 
-    def self.validate_string(value)
-      raise ValidateError, "invalid string" unless value.is_a? ::String
-    end
-
-    def self.validate_io(value)
-      raise ValidateError, "invalid io" unless IO_METHODS.all? { |method| value.respond_to? method }
-    end
-
-    def self.validate_hash(value)
-      raise ValidateError, "invalid hash" unless value.is_a? ::Hash
+    def self.validate_positive_integer(value)
+      raise ValidateError, "invalid positive integer" unless value.is_a?(::Integer) && value.positive?
     end
 
     def self.validate_proc(value)
@@ -47,5 +26,9 @@ module LZWS
         raise ValidateError, "invalid proc"
       end
     end
+
+    def self.validate_string(value)
+      raise ValidateError, "invalid string" unless value.is_a? ::String
+    end
   end
 end

data/lib/lzws/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lzws
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Andrew Aladjev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -58,28 +58,28 @@ 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.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -128,56 +128,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.26'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.26'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -241,7 +241,8 @@ files:
 homepage: https://github.com/andrew-aladev/ruby-lzws
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -257,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby bindings for lzws library (compatible with UNIX compress).