ruby-lzws 1.4.0 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68bdc9a93f0fec663f2bf0824e1e5838e7d86f2f2e83ca3f3239564410aa54dd
-  data.tar.gz: ae80e7b822bbe11b2d1d3ebe3bcd1093f0f428a29b556c95e1e1af97d41b00bc
+  metadata.gz: 0125a2586e06a3882d077fc746873c1376eeafb7393de58ee28e84eace30763b
+  data.tar.gz: a68ceee328f8ea19195c7c75cc5cfb72893d536bb3e14859f4021faa7c934391
 SHA512:
-  metadata.gz: e49fe4b9d0a2f319bf71e4098c3fc6b82c238d119eaffd76a76e4a6f5b480e6f950580983cef5ab71980843b18126c825c6846ac0030868127bc05db089da82c
-  data.tar.gz: 8093294842cdb734cf7962dcde85c7cb530ffbb15d873681fc7c81bbe23d5d5d5af9e0ad6b66d934e86f9e99b68bafbf2d4b2ab68a02da7aa05db8aa2a389b7b
+  metadata.gz: 849991f7d18e0e8449e7f1e6b96ca66a4c5545db67b918c3c6f59d5071113e035122b6a3b2620c81e7ed32a5a7adaa682654df0456141e20e941c8757d727c27
+  data.tar.gz: acdcb9d6175e7285b0deb2324925cc9a8cdd1a59c51385c311b4c1a0c794fc3a010f588644a8986fe51e2e4188e6e32c83d5dfe0f8a48d22b32c4398fd9f668c

data/README.md

@@ -1,14 +1,16 @@
 # Ruby bindings for lzws library
 
-| AppVeyor | Circle | Github actions | Codecov | Gem  |
-| :------: | :----: | :------------: | :-----: | :--: |
-| [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-lzws?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-lzws/branch/master) | [![Circle test status](https://circleci.com/gh/andrew-aladev/ruby-lzws/tree/master.svg?style=shield)](https://circleci.com/gh/andrew-aladev/ruby-lzws/tree/master) | [![Github Actions test status](https://github.com/andrew-aladev/ruby-lzws/workflows/test/badge.svg?branch=master)](https://github.com/andrew-aladev/ruby-lzws/actions) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-lzws/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-lzws) | [![Gem](https://img.shields.io/gem/v/ruby-lzws.svg)](https://rubygems.org/gems/ruby-lzws) |
+| AppVeyor | Jenkins | Github actions | Codecov | Gem  |
+| :------: | :-----: | :------------: | :-----: | :--: |
+| [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-lzws?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-lzws/branch/master) | [![Jenkins test status](http://37.187.122.190:58182/buildStatus/icon?job=ruby-lzws)](http://37.187.122.190:58182/job/ruby-lzws) | [![Github Actions test status](https://github.com/andrew-aladev/ruby-lzws/workflows/test/badge.svg?branch=master)](https://github.com/andrew-aladev/ruby-lzws/actions) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-lzws/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-lzws) | [![Gem](https://img.shields.io/gem/v/ruby-lzws.svg)](https://rubygems.org/gems/ruby-lzws) |
 
 See [lzws library](https://github.com/andrew-aladev/lzws).
 
 ## Installation
 
-Please install lzws library first, use latest 1.4.0+ version.
+Operating systems: GNU/Linux, FreeBSD, OSX.
+
+Dependencies: [lzws](https://github.com/andrew-aladev/lzws) 1.4.0+ version.
 
 ```sh
 gem install ruby-lzws
@@ -108,6 +110,10 @@ Parallel.each large_datas do |large_data|
 end
 ```
 
+# Docs
+
+Please review [rdoc generated docs](https://andrew-aladev.github.io/ruby-lzws).
+
 ## Options
 
 | Option                      | Values     | Default  | Description |
@@ -253,14 +259,11 @@ Special asynchronous methods missing in `Zlib::GzipWriter`.
 So it is possible to have asynchronous variants for these synchronous methods.
 Behaviour is the same as `IO#write_nonblock` method.
 
-All nonblock operations for file will raise `EBADF` error on Windows.
-Setting file into nonblocking mode is [not available on Windows](https://github.com/ruby/ruby/blob/master/win32/win32.c#L4388).
-
 ```
 #<<(object)
 #print(*objects)
 #printf(*args)
-#putc(object, encoding: ::Encoding::BINARY)
+#putc(object, :encoding => 'ASCII-8BIT')
 #puts(*objects)
 ```
 
@@ -354,10 +357,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/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/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/lib/lzws/error.rb

@@ -1,21 +1,26 @@
 # Ruby bindings for lzws library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp"
+
 module LZWS
   class BaseError < ::StandardError; end
 
   class AllocateError < BaseError; end
-  class ValidateError < BaseError; end
 
-  class UsedAfterCloseError              < BaseError; end
   class NotEnoughSourceBufferError       < BaseError; end
   class NotEnoughDestinationBufferError  < BaseError; end
-  class NotEnoughDestinationError        < BaseError; end
   class DecompressorCorruptedSourceError < BaseError; end
 
   class AccessIOError < BaseError; end
   class ReadIOError   < BaseError; end
   class WriteIOError  < BaseError; end
 
-  class UnexpectedError < BaseError; end
+  ValidateError = ADSP::ValidateError
+
+  NotEnoughDestinationError = ADSP::NotEnoughDestinationError
+  UsedAfterCloseError       = ADSP::UsedAfterCloseError
+
+  NotImplementedError = ADSP::NotImplementedError
+  UnexpectedError     = ADSP::UnexpectedError
 end

data/lib/lzws/file.rb

@@ -1,48 +1,25 @@
 # Ruby bindings for lzws library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/file"
 require "lzws_ext"
 
-require_relative "error"
 require_relative "option"
-require_relative "validation"
 
 module LZWS
-  module File
-    BUFFER_LENGTH_NAMES = %i[source_buffer_length destination_buffer_length].freeze
-
-    def self.compress(source, destination, options = {})
-      Validation.validate_string source
-      Validation.validate_string destination
-
-      options = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
-
-      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 = {})
-      Validation.validate_string source
-      Validation.validate_string destination
-
-      options = Option.get_decompressor_options options, BUFFER_LENGTH_NAMES
-
-      open_files source, destination do |source_io, destination_io|
-        LZWS._native_decompress_io source_io, destination_io, options
-      end
-
-      nil
+  # LZWS::File class.
+  class File < ADSP::File
+    # Current option class.
+    Option = LZWS::Option
+
+    # Bypass native compress.
+    def self.native_compress_io(*args)
+      LZWS._native_compress_io(*args)
     end
 
-    private_class_method def self.open_files(source, destination, &_block)
-      ::File.open source, "rb" do |source_io|
-        ::File.open destination, "wb" do |destination_io|
-          yield source_io, destination_io
-        end
-      end
+    # Bypass native decompress.
+    def self.native_decompress_io(*args)
+      LZWS._native_decompress_io(*args)
     end
   end
 end

data/lib/lzws/option.rb

@@ -7,29 +7,56 @@ require_relative "error"
 require_relative "validation"
 
 module LZWS
+  # LZWS::Option module.
   module Option
+    # Current default buffer length.
     DEFAULT_BUFFER_LENGTH = 0
 
+    # Current compressor defaults.
     COMPRESSOR_DEFAULTS = {
+      # Enables global VM lock where possible.
       :gvl                  => false,
+      # Max code bit length.
       :max_code_bit_length  => nil,
+      # Disables magic header.
       :without_magic_header => nil,
+      # Enables block mode.
       :block_mode           => nil,
+      # Enables most significant bit mode.
       :msb                  => nil,
+      # Enables unaligned bit groups.
       :unaligned_bit_groups => nil,
+      # Disables lzws library logging.
       :quiet                => nil
     }
     .freeze
 
+    # Current decompressor defaults.
     DECOMPRESSOR_DEFAULTS = {
+      # Enables global VM lock where possible.
       :gvl                  => false,
+      # Disables magic header.
       :without_magic_header => nil,
+      # Enables most significant bit mode.
       :msb                  => nil,
+      # Enables unaligned bit groups.
       :unaligned_bit_groups => nil,
+      # Disables lzws library logging.
       :quiet                => nil
     }
     .freeze
 
+    # Processes compressor +options+ and +buffer_length_names+.
+    # Option: +:source_buffer_length+ source buffer length.
+    # Option: +:destination_buffer_length+ destination buffer length.
+    # Option: +:gvl+ enables global VM lock where possible.
+    # Option: +:max_code_bit_length+ max code bit length.
+    # Option: +:block_mode+ enables block mode.
+    # Option: +:without_magic_header+ disables magic header.
+    # Option: +:msb+ enables most significant bit mode.
+    # Option: +:unaligned_bit_groups+ enables unaligned bit groups.
+    # Option: +:quiet+ disables lzws library logging.
+    # Returns processed compressor options.
     def self.get_compressor_options(options, buffer_length_names)
       Validation.validate_hash options
 
@@ -68,6 +95,15 @@ module LZWS
       options
     end
 
+    # Processes decompressor +options+ and +buffer_length_names+.
+    # Option: +:source_buffer_length+ source buffer length.
+    # Option: +:destination_buffer_length+ destination buffer length.
+    # Option: +:gvl+ enables global VM lock where possible.
+    # Option: +:without_magic_header+ disables magic header.
+    # Option: +:msb+ enables most significant bit mode.
+    # Option: +:unaligned_bit_groups+ enables unaligned bit groups.
+    # Option: +:quiet+ disables lzws library logging.
+    # Returns processed decompressor options.
     def self.get_decompressor_options(options, buffer_length_names)
       Validation.validate_hash options
 

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

@@ -1,74 +1,32 @@
 # Ruby bindings for lzws library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/stream/raw/compressor"
 require "lzws_ext"
 
-require_relative "abstract"
-require_relative "../../error"
 require_relative "../../option"
 require_relative "../../validation"
 
 module LZWS
   module Stream
     module Raw
-      class Compressor < Abstract
-        BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
+      # LZWS::Stream::Raw::Compressor class.
+      class Compressor < ADSP::Stream::Raw::Compressor
+        # Current native compressor class.
+        NativeCompressor = Stream::NativeCompressor
 
-        def initialize(options = {})
-          options       = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
-          native_stream = NativeCompressor.new options
+        # Current option class.
+        Option = LZWS::Option
 
-          super native_stream
-        end
-
-        def write(source, &writer)
+        # Flushes raw stream and writes next result using +writer+ proc.
+        def flush(&writer)
           do_not_use_after_close
 
-          Validation.validate_string source
-          Validation.validate_proc writer
-
-          total_bytes_written = 0
-
-          loop do
-            bytes_written, need_more_destination  = @native_stream.write source
-            total_bytes_written                  += bytes_written
-
-            if need_more_destination
-              source = source.byteslice bytes_written, source.bytesize - bytes_written
-              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
-          end
-
-          total_bytes_written
-        end
-
-        def close(&writer)
-          return nil if closed?
-
           Validation.validate_proc writer
 
-          loop do
-            need_more_destination = @native_stream.finish
-
-            if need_more_destination
-              more_destination(&writer)
-              next
-            end
-
-            break
-          end
+          write_result(&writer)
 
-          super
+          nil
         end
       end
     end

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

@@ -1,56 +1,32 @@
 # Ruby bindings for lzws library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/stream/raw/decompressor"
 require "lzws_ext"
 
-require_relative "abstract"
 require_relative "../../option"
 require_relative "../../validation"
 
 module LZWS
   module Stream
     module Raw
-      class Decompressor < Abstract
-        BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
+      # LZWS::Stream::Raw::Decompressor class.
+      class Decompressor < ADSP::Stream::Raw::Decompressor
+        # Current native decompressor class.
+        NativeDecompressor = Stream::NativeDecompressor
 
-        def initialize(options = {})
-          options       = Option.get_decompressor_options options, BUFFER_LENGTH_NAMES
-          native_stream = NativeDecompressor.new options
+        # Current option class.
+        Option = LZWS::Option
 
-          super native_stream
-        end
-
-        def read(source, &writer)
+        # Flushes raw stream and writes next result using +writer+ proc.
+        def flush(&writer)
           do_not_use_after_close
 
-          Validation.validate_string source
           Validation.validate_proc writer
 
-          total_bytes_read = 0
-
-          loop do
-            bytes_read, need_more_destination  = @native_stream.read source
-            total_bytes_read                  += bytes_read
-
-            if need_more_destination
-              source = source.byteslice bytes_read, source.bytesize - bytes_read
-              more_destination(&writer)
-              next
-            end
-
-            break
-          end
-
-          # Please remember that "total_bytes_read" can not be equal to "source.bytesize".
-          total_bytes_read
-        end
-
-        def close(&writer)
-          return nil if closed?
-
-          Validation.validate_proc writer
+          write_result(&writer)
 
-          super
+          nil
         end
       end
     end

data/lib/lzws/stream/reader.rb

@@ -1,186 +1,16 @@
 # Ruby bindings for lzws library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
-require_relative "abstract"
+require "adsp/stream/reader"
+
 require_relative "raw/decompressor"
-require_relative "reader_helpers"
-require_relative "../validation"
 
 module LZWS
   module Stream
-    class Reader < Abstract
-      include ReaderHelpers
-
-      attr_accessor :lineno
-
-      def initialize(source_io, options = {}, *args)
-        @options = options
-
-        super source_io, *args
-
-        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?
-
-        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
-
-      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?
-
-        unless bytes_to_read.nil?
-          return ::String.new :encoding => ::Encoding::BINARY if bytes_to_read.zero?
-          return nil if 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
-
-        append_io_data @io.read(@source_buffer_length) until @io.eof?
-        flush_io_data
-
-        read_buffer out_buffer
-      end
-
-      def rewind
-        raw_wrapper :close
-
-        reset_io_remainder
-        reset_need_to_flush
-
-        super
-      end
-
-      def close
-        raw_wrapper :close
-
-        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)
-        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
-
-        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
-
-      # -- 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
-
-      protected def flush_io_data
-        raw_wrapper :flush
-
-        @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)
-        bytes_read = [@buffer.bytesize, bytes_to_read].min
-
-        # Result uses buffer binary encoding.
-        result   = @buffer.byteslice 0, bytes_read
-        @buffer  = @buffer.byteslice bytes_read, @buffer.bytesize - bytes_read
-        @pos    += bytes_read
-
-        result = out_buffer.replace result unless out_buffer.nil?
-        result
-      end
-
-      protected def read_buffer(out_buffer)
-        result = @buffer
-        reset_buffer
-        @pos += result.bytesize
-
-        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
-      end
-
-      # We should be able to return data back to buffer.
-      # We won't use any transcode options because transcoded data should be backward compatible.
-      protected def transcode_to_external(data)
-        data = data.encode @external_encoding unless @external_encoding.nil?
-        data
-      end
-
-      protected def raw_wrapper(method_name, *args)
-        @raw_stream.send(method_name, *args) { |portion| @buffer << portion }
-      end
+    # LZWS::Stream::Reader class.
+    class Reader < ADSP::Stream::Reader
+      # Current raw stream class.
+      RawDecompressor = Raw::Decompressor
     end
   end
 end