ruby-zstds 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec16246ba1102583f6f309e555e4ac4dbbf49135f5adee4e0332b86be7388de4
-  data.tar.gz: 7d8d40b406c9da3ed50c5929f565c51fc8cf46558bee937fdeaa0d942d0fe84f
+  metadata.gz: 1a3bf1ddf3028d59dbfadc868b7dd0049f95213ccede92b223cab2f1af2a847b
+  data.tar.gz: d8dce89cd592e7815aea864900afd336e67a0bc65def9f6b21b30a67b184a7fc
 SHA512:
-  metadata.gz: fd92bd835bf7eb14db13ecc1761a89467e3f38bbcb9d373573fa7c3a8839f4050a478091ada05fec97bb8e2824e9913d23ef9593f3388e317c5b9df456e7e7cd
-  data.tar.gz: 00d8bd37067fd788a7033abd8cf4c6d590b4f672f8986e7da7b80e47ed9ffa4a91886db7442a2a118a6ba45c8f9b2b232665455a5fc85c6cf4c8fcbe119c4e9c
+  metadata.gz: b956bba7a80f4456b736748e2355d9e862f230af855d5b539cb0d7034c183238d8e8b68a65c629fb5baae2ec94757d0e8f822572d0bcc694a2740bb173ab6e7d
+  data.tar.gz: 6222867bf832bf0d8b08e8cc94d25be1eec376e87b6f24e1bc2d8c75f36d06bb12a7a601f8737eccafa02bdd1c1c0a3eee65c7d7f2c77fcb9e0b4068d9afaef1

data/README.md

@@ -1,14 +1,14 @@
 # Ruby bindings for zstd library
 
-| AppVeyor | Circle | Github actions | Codecov | Gem  |
-| :------: | :----: | :------------: | :-----: | :--: |
-| [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-zstds?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-zstds/branch/master) | [![Circle test status](https://circleci.com/gh/andrew-aladev/ruby-zstds/tree/master.svg?style=shield)](https://circleci.com/gh/andrew-aladev/ruby-zstds/tree/master) | [![Github Actions test status](https://github.com/andrew-aladev/ruby-zstds/workflows/test/badge.svg?branch=master)](https://github.com/andrew-aladev/ruby-zstds/actions) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-zstds/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-zstds) | [![Gem](https://img.shields.io/gem/v/ruby-zstds.svg)](https://rubygems.org/gems/ruby-zstds) |
+| AppVeyor | Jenkins | Github actions | Codecov | Gem  |
+| :------: | :-----: | :------------: | :-----: | :--: |
+| [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-zstds?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-zstds/branch/master) | [![Jenkins test status](http://37.187.122.190:58182/buildStatus/icon?job=ruby-zstds)](http://37.187.122.190:58182/job/ruby-zstds) | [![Github Actions test status](https://github.com/andrew-aladev/ruby-zstds/workflows/test/badge.svg?branch=master)](https://github.com/andrew-aladev/ruby-zstds/actions) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-zstds/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-zstds) | [![Gem](https://img.shields.io/gem/v/ruby-zstds.svg)](https://rubygems.org/gems/ruby-zstds) |
 
 See [zstd library](https://github.com/facebook/zstd).
 
 ## Installation
 
-Operating systems: GNU/Linux, FreeBSD, OSX, Windows (MinGW).
+Operating systems: GNU/Linux, FreeBSD, OSX.
 
 Dependencies: [zstd](https://github.com/facebook/zstd) 1.4.0+ version.
 
@@ -18,7 +18,6 @@ Dependencies: [zstd](https://github.com/facebook/zstd) 1.4.0+ version.
 | CentOS     | `libzstd-devel`           |
 | ArchLinux  | `zstd`                    |
 | OSX        | `zstd`                    |
-| Windows    | `mingw-w64-x86_64-zstd`   |
 
 ```sh
 gem install ruby-zstds
@@ -151,6 +150,10 @@ Parallel.each large_datas do |large_data|
 end
 ```
 
+# Docs
+
+Please review [rdoc generated docs](https://andrew-aladev.github.io/ruby-zstds).
+
 ## Options
 
 | Option                          | Values         | Default    | Description |
@@ -344,14 +347,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)
 ```
 

data/ext/zstds_ext/dictionary.c

@@ -203,34 +203,34 @@ static inline void* finalize_wrapper(void* data)
     return NULL;
   }
 
-  int                compressionLevel;
   zstds_ext_option_t compression_level = args->dictionary_options.compression_level;
+  int                compression_level_value;
   if (compression_level.has_value) {
-    compressionLevel = compression_level.value;
+    compression_level_value = compression_level.value;
   } else {
-    compressionLevel = 0;
+    compression_level_value = 0;
   }
 
-  unsigned int       notificationLevel;
   zstds_ext_option_t notification_level = args->dictionary_options.notification_level;
+  unsigned int       notification_level_value;
   if (notification_level.has_value) {
-    notificationLevel = notification_level.value;
+    notification_level_value = notification_level.value;
   } else {
-    notificationLevel = 0;
+    notification_level_value = 0;
   }
 
-  unsigned int       dictID;
   zstds_ext_option_t dictionary_id = args->dictionary_options.dictionary_id;
+  unsigned int       dictionary_id_value;
   if (dictionary_id.has_value) {
-    dictID = dictionary_id.value;
+    dictionary_id_value = dictionary_id.value;
   } else {
-    dictID = 0;
+    dictionary_id_value = 0;
   }
 
   ZDICT_params_t dictionary_params = {
-    .compressionLevel  = compressionLevel,
-    .notificationLevel = notificationLevel,
-    .dictID            = dictID,
+    .compressionLevel  = compression_level_value,
+    .notificationLevel = notification_level_value,
+    .dictID            = dictionary_id_value,
   };
 
   args->result = ZDICT_finalizeDictionary(

data/lib/zstds/dictionary.rb

@@ -7,13 +7,16 @@ require_relative "error"
 require_relative "validation"
 
 module ZSTDS
+  # ZSTDS::Dictionary class.
   class Dictionary
+    # Current train defaults.
     TRAIN_DEFAULTS = {
       :gvl      => false,
       :capacity => 0
     }
     .freeze
 
+    # Current finalize defaults.
     FINALIZE_DEFAULTS = {
       :gvl                => false,
       :max_size           => 0,
@@ -21,6 +24,7 @@ module ZSTDS
     }
     .freeze
 
+    # Current finalize dictionary defaults.
     FINALIZE_DICTIONARY_DEFAULTS = {
       :compression_level  => 0,
       :notification_level => 0,
@@ -28,8 +32,11 @@ module ZSTDS
     }
     .freeze
 
+    # Reads current +buffer+ binary data.
     attr_reader :buffer
 
+    # Initializes compressor.
+    # Uses +buffer+ binary data.
     def initialize(buffer)
       Validation.validate_string buffer
       raise ValidateError, "dictionary buffer should not be empty" if buffer.empty?
@@ -37,6 +44,12 @@ module ZSTDS
       @buffer = buffer
     end
 
+    # Trains dictionary.
+    # Uses +samples+ list of binary datas.
+    # Uses +options+ options hash.
+    # Option +gvl+ is global interpreter lock enabled.
+    # Option +capacity+ capacity of dictionary buffer.
+    # Returns dictionary based on new buffer.
     def self.train(samples, options = {})
       validate_samples samples
 
@@ -51,6 +64,14 @@ module ZSTDS
       new buffer
     end
 
+    # Finalizes dictionary.
+    # Uses +content+ binary data.
+    # Uses +samples+ list of binary datas.
+    # Uses +options+ options hash.
+    # Option +gvl+ is global interpreter lock enabled.
+    # Option +max_size+ max size of dictionary buffer.
+    # Option +dictionary_options+ standard dictionary options hash.
+    # Returns dictionary based on new buffer.
     def self.finalize(content, samples, options = {})
       Validation.validate_string content
       raise ValidateError, "content should not be empty" if content.empty?
@@ -79,6 +100,7 @@ module ZSTDS
       new buffer
     end
 
+    # Raises error when +samples+ are not list of not empty strings.
     def self.validate_samples(samples)
       Validation.validate_array samples
 
@@ -88,10 +110,12 @@ module ZSTDS
       end
     end
 
+    # Returns current dictionary id.
     def id
       self.class.get_buffer_id @buffer
     end
 
+    # Returns current dictionary header size.
     def header_size
       self.class.get_header_size @buffer
     end

data/lib/zstds/error.rb

@@ -1,16 +1,15 @@
 # Ruby bindings for zstd library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp"
+
 module ZSTDS
   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 CorruptedDictionaryError         < BaseError; end
 
@@ -18,6 +17,11 @@ module ZSTDS
   class ReadIOError   < BaseError; end
   class WriteIOError  < BaseError; end
 
-  class NotImplementedError < BaseError; end
-  class UnexpectedError     < BaseError; end
+  ValidateError = ADSP::ValidateError
+
+  NotEnoughDestinationError = ADSP::NotEnoughDestinationError
+  UsedAfterCloseError       = ADSP::UsedAfterCloseError
+
+  NotImplementedError = ADSP::NotImplementedError
+  UnexpectedError     = ADSP::UnexpectedError
 end

data/lib/zstds/file.rb

@@ -1,50 +1,40 @@
 # Ruby bindings for zstd library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/file"
 require "zstds_ext"
 
-require_relative "error"
 require_relative "option"
 require_relative "validation"
 
 module ZSTDS
-  module File
-    BUFFER_LENGTH_NAMES = %i[source_buffer_length destination_buffer_length].freeze
-
+  # ZSTDS::File class.
+  class File < ADSP::File
+    # Current option class.
+    Option = ZSTDS::Option
+
+    # Compresses data from +source+ file path to +destination+ file path.
+    # Option: +:source_buffer_length+ source buffer length.
+    # Option: +:destination_buffer_length+ destination buffer length.
+    # Option: +:pledged_size+ source bytesize.
     def self.compress(source, destination, options = {})
       Validation.validate_string source
-      Validation.validate_string destination
 
       options = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
 
       options[:pledged_size] = ::File.size source
 
-      open_files source, destination do |source_io, destination_io|
-        ZSTDS._native_compress_io source_io, destination_io, options
-      end
-
-      nil
+      super source, destination, options
     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|
-        ZSTDS._native_decompress_io source_io, destination_io, options
-      end
-
-      nil
+    # Bypass native compress.
+    def self.native_compress_io(*args)
+      ZSTDS._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)
+      ZSTDS._native_decompress_io(*args)
     end
   end
 end

data/lib/zstds/option.rb

@@ -8,41 +8,95 @@ require_relative "error"
 require_relative "validation"
 
 module ZSTDS
+  # ZSTDS::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,
+      # Compression level.
       :compression_level             => nil,
+      # Maximum back-reference distance (power of 2).
       :window_log                    => nil,
+      # Size of the initial probe table (power of 2).
       :hash_log                      => nil,
+      # Size of the multi-probe search table (power of 2).
       :chain_log                     => nil,
+      # Number of search attempts (power of 2).
       :search_log                    => nil,
+      # Minimum size of searched matches.
       :min_match                     => nil,
+      # Distance between match sampling (for :fast strategy),
+      #   length of match considered "good enough" for (for other strategies).
       :target_length                 => nil,
+      # Choses strategy.
       :strategy                      => nil,
+      # Enables long distance matching.
       :enable_long_distance_matching => nil,
+      # Size of the table for long distance matching (power of 2).
       :ldm_hash_log                  => nil,
+      # Minimum match size for long distance matcher.
       :ldm_min_match                 => nil,
+      # Log size of each bucket in the LDM hash table for collision resolution.
       :ldm_bucket_size_log           => nil,
+      # Frequency of inserting/looking up entries into the LDM hash table.
       :ldm_hash_rate_log             => nil,
+      # Enables writing of content size into frame header (if known).
       :content_size_flag             => nil,
+      # Enables writing of 32-bits checksum of content at end of frame.
       :checksum_flag                 => nil,
+      # Enables writing of dictionary id into frame header.
       :dict_id_flag                  => nil,
+      # Number of threads spawned in parallel.
       :nb_workers                    => nil,
+      # Size of job (nb_workers >= 1).
       :job_size                      => nil,
+      # Overlap size, as a fraction of window size.
       :overlap_log                   => nil,
+      # Chose dictionary.
       :dictionary                    => nil
     }
     .freeze
 
+    # Current decompressor defaults.
     DECOMPRESSOR_DEFAULTS = {
+      # Enables global VM lock where possible.
       :gvl            => false,
+      # Size limit (power of 2).
       :window_log_max => nil,
+      # Chose dictionary.
       :dictionary     => 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: +:compression_level+ compression level.
+    # Option: +:window_log+ maximum back-reference distance (power of 2).
+    # Option: +:hash_log+ size of the initial probe table (power of 2).
+    # Option: +:chain_log+ size of the multi-probe search table (power of 2).
+    # Option: +:search_log+ number of search attempts (power of 2).
+    # Option: +:min_match+ minimum size of searched matches.
+    # Option: +:target_length+ distance between match sampling (for :fast strategy),
+    #   length of match considered "good enough" for (for other strategies).
+    # Option: +:strategy+ choses strategy.
+    # Option: +:ldm_hash_log+ size of the table for long distance matching (power of 2).
+    # Option: +:ldm_min_match+ minimum match size for long distance matcher.
+    # Option: +:ldm_bucket_size_log+ log size of each bucket in the LDM hash table for collision resolution.
+    # Option: +:ldm_hash_rate_log+ frequency of inserting/looking up entries into the LDM hash table.
+    # Option: +:content_size_flag+ enables writing of content size into frame header (if known).
+    # Option: +:checksum_flag+ enables writing of 32-bits checksum of content at end of frame.
+    # Option: +:dict_id_flag+ enables writing of dictionary id into frame header.
+    # Option: +:nb_workers+ number of threads spawned in parallel.
+    # Option: +:job_size+ size of job (nb_workers >= 1).
+    # Option: +:overlap_log+ overlap size, as a fraction of window size.
+    # Option: +:dictionary+ chose dictionary.
+    # Returns processed compressor options.
     def self.get_compressor_options(options, buffer_length_names)
       Validation.validate_hash options
 
@@ -179,6 +233,12 @@ module ZSTDS
       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: +:window_log_max+ size limit (power of 2).
+    # Returns processed decompressor options.
     def self.get_decompressor_options(options, buffer_length_names)
       Validation.validate_hash options
 

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

@@ -1,97 +1,33 @@
 # Ruby bindings for zstd library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/stream/raw/compressor"
 require "zstds_ext"
 
-require_relative "abstract"
-require_relative "../../error"
 require_relative "../../option"
 require_relative "../../validation"
 
 module ZSTDS
   module Stream
     module Raw
-      class Compressor < Abstract
-        BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
+      # ZSTDS::Stream::Raw::Compressor class.
+      class Compressor < ADSP::Stream::Raw::Compressor
+        # Current native compressor class.
+        NativeCompressor = Stream::NativeCompressor
 
+        # Current option class.
+        Option = ZSTDS::Option
+
+        # Initializes compressor.
+        # Option: +:destination_buffer_length+ destination buffer length.
+        # Option: +:pledged_size+ source bytesize.
         def initialize(options = {})
           options = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
 
           pledged_size = options[:pledged_size]
           Validation.validate_not_negative_integer pledged_size unless pledged_size.nil?
 
-          native_stream = NativeCompressor.new options
-
-          super native_stream
-        end
-
-        def write(source, &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 flush(&writer)
-          do_not_use_after_close
-
-          Validation.validate_proc writer
-
-          loop do
-            need_more_destination = @native_stream.flush
-
-            if need_more_destination
-              more_destination(&writer)
-              next
-            end
-
-            break
-          end
-
-          super
-        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
-
-          super
+          super options
         end
       end
     end

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

@@ -1,65 +1,21 @@
 # Ruby bindings for zstd library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/stream/raw/decompressor"
 require "zstds_ext"
 
-require_relative "abstract"
 require_relative "../../option"
-require_relative "../../validation"
 
 module ZSTDS
   module Stream
     module Raw
-      class Decompressor < Abstract
-        BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
+      # ZSTDS::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
-
-          super native_stream
-        end
-
-        def read(source, &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 flush(&writer)
-          do_not_use_after_close
-
-          Validation.validate_proc writer
-
-          super
-        end
-
-        def close(&writer)
-          return nil if closed?
-
-          Validation.validate_proc writer
-
-          super
-        end
+        # Current option class.
+        Option = ZSTDS::Option
       end
     end
   end