ruby-zstds 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae8809ef7fdd1bd25745784dbd1621851bd05c3fba52597fcbe532beeef17801
-  data.tar.gz: ebe9a4333e96fd000da57e5885d5fc8dd825fd7e5b533c630da19d5abe51054c
+  metadata.gz: 2f277f0e51b0f8328d440a5f42f4834026c188f665eae60949645222cb73a23a
+  data.tar.gz: 0d7dffc0a3a026ecc4f3d97d060b43e3e701d5f1cabc53c9694a276eccad2199
 SHA512:
-  metadata.gz: e552d52aa1b3c6867d5d3bffd67934b83d24a21d69e1e1777aa649ac7faba69ae3adb377b9ffb9214112cc5f9b346d2a26f4ce4269c8c2d7217905c052a06178
-  data.tar.gz: 623001b72258e1def31308111068609b436834ad148b4bb32cf8ac006ca7d64a93afd16a42c426aef39e9f196d6063f96a45046e1e29166538dfb50c7681404b
+  metadata.gz: 652c9cc07c28459b47d16efa85aabb46bce2c5e35e440243aba73092ee3058e48cbcb0349179796cb041343f4c80cf2918101f6881b08b17c9922cf4dc64ce01
+  data.tar.gz: e1b3e5fd27512a02561ad61aff70983a42ef37e86293cb75365aa39174139f37a163ac51030ef9ebec721746f6bf39114e4a8db1c851a7207bed90c2ecf092ce

data/README.md

@@ -1,8 +1,8 @@
 # Ruby bindings for zstd library
 
-| Travis | AppVeyor | Cirrus | Circle | Codecov |
-| :---:  | :---:    | :---:  | :---:  | :---:   |
-| [![Travis test status](https://travis-ci.com/andrew-aladev/ruby-zstds.svg?branch=master)](https://travis-ci.com/andrew-aladev/ruby-zstds) | [![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) | [![Cirrus test status](https://api.cirrus-ci.com/github/andrew-aladev/ruby-zstds.svg?branch=master)](https://cirrus-ci.com/github/andrew-aladev/ruby-zstds) | [![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) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-zstds/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-zstds) |
+| Travis | AppVeyor | Circle | Codecov |
+| :---:  | :---:    | :---:  | :---:   |
+| [![Travis test status](https://travis-ci.com/andrew-aladev/ruby-zstds.svg?branch=master)](https://travis-ci.com/andrew-aladev/ruby-zstds) | [![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) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-zstds/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-zstds) |
 
 See [zstd library](https://github.com/facebook/zstd).
 
@@ -21,6 +21,8 @@ rake gem
 gem install pkg/ruby-zstds-*.gem
 ```
 
+You can also use [overlay](https://github.com/andrew-aladev/overlay) for gentoo.
+
 ## Usage
 
 There are simple APIs: `String` and `File`. Also you can use generic streaming API: `Stream::Writer` and `Stream::Reader`.
@@ -101,158 +103,64 @@ end
 
 ## Options
 
-Each API supports several options:
-
-```
-:source_buffer_length
-:destination_buffer_length
-```
+| Option                          | Values           | Default      | Description |
+|---------------------------------|------------------|--------------|-------------|
+| `source_buffer_length`          | `0 - inf`        | `0 (auto)`   | internal buffer length for source data |
+| `destination_buffer_length`     | `0 - inf`        | `0 (auto)`   | internal buffer length for description data |
+| `compression_level`             | `-131072 - 22`   | `0 (auto)`   | compression level |
+| `window_log`                    | `10 - 31`        | `0 (auto)`   | maximum back-reference distance (power of 2) |
+| `hash_log`                      | `6 - 30`         | `0 (auto)`   | size of the initial probe table (power of 2) |
+| `chain_log`                     | `6 - 30`         | `0 (auto)`   | size of the multi-probe search table (power of 2) |
+| `search_log`                    | `1 - 30`         | `0 (auto)`   | number of search attempts (power of 2) |
+| `min_match`                     | `3 - 7`          | `0 (auto)`   | minimum size of searched matches |
+| `target_length`                 | `0 - 131072`     | `0 (auto)`   | distance between match sampling (for `:fast` strategy), length of match considered "good enough" for (for other strategies) |
+| `strategy`                      | `STRATEGIES`     | `nil (auto)` | choses strategy |
+| `enable_long_distance_matching` | `true/false`     | `nil (auto)` | enables long distance matching |
+| `ldm_hash_log`                  | `6 - 30`         | `0 (auto)`   | size of the table for long distance matching (power of 2) |
+| `ldm_min_match`                 | `4 - 4096`       | `0 (auto)`   | minimum match size for long distance matcher |
+| `ldm_bucket_size_log`           | `1 - 8`          | `0 (auto)`   | log size of each bucket in the LDM hash table for collision resolution |
+| `ldm_hash_rate_log`             | `0 - 25`         | `0 (auto)`   | frequency of inserting/looking up entries into the LDM hash table |
+| `content_size_flag`             | `true/false`     | `true`       | enables writing of content size into frame header (if known) |
+| `checksum_flag`                 | `true/false`     | `false`      | enables writing of 32-bits checksum of content at end of frame |
+| `dict_id_flag`                  | `true/false`     | `true`       | enables writing of dictionary id into frame header |
+| `nb_workers`                    | `0 - 200`        | `0 (auto)`   | number of threads spawned in parallel |
+| `job_size`                      | `0 - 1073741824` | `0 (auto)`   | size of job (nb_workers >= 1) |
+| `overlap_log`                   | `0 - 9`          | `0 (auto)`   | overlap size, as a fraction of window size |
+| `window_log_max`                | `10 - 31`        | `0 (auto)`   | size limit (power of 2) |
+| `dictionary`                    | `Dictionary`     | `nil`        | chose dictionary |
+| `pledged_size`                  | `0 - inf`        | `0 (auto)`   | size of input (if known) |
 
 There are internal buffers for compressed and decompressed data.
-For example you want to use 1 KB as source buffer length for compressor - please use 256 B as destination buffer length.
-You want to use 256 B as source buffer length for decompressor - please use 1 KB as destination buffer length.
-
-Values: 0 - infinity, default value: 0.
-0 means automatic buffer length selection.
-
-```
-:compression_level
-```
-
-Values: `ZSTDS::Option::MIN_COMPRESSION_LEVEL` - `ZSTDS::Option::MAX_COMPRESSION_LEVEL`, default value: `0`.
-
-```
-:window_log
-```
-
-Values: `ZSTDS::Option::MIN_WINDOW_LOG` - `ZSTDS::Option::MAX_WINDOW_LOG`, default value: `0`.
-
-```
-:hash_log
-```
-
-Values: `ZSTDS::Option::MIN_HASH_LOG` - `ZSTDS::Option::MAX_HASH_LOG`, default value: `0`.
-
-```
-:chain_log
-```
-
-Values: `ZSTDS::Option::MIN_CHAIN_LOG` - `ZSTDS::Option::MAX_CHAIN_LOG`, default value: `0`.
-
-```
-:search_log
-```
-
-Values: `ZSTDS::Option::MIN_SEARCH_LOG` - `ZSTDS::Option::MAX_SEARCH_LOG`, default value: `0`.
-
-```
-:min_match
-```
-
-Values: `ZSTDS::Option::MIN_MIN_MATCH` - `ZSTDS::Option::MAX_MIN_MATCH`, default value: `0`.
-
-```
-:target_length
-```
-
-Values: `ZSTDS::Option::MIN_TARGET_LENGTH` - `ZSTDS::Option::MAX_TARGET_LENGTH`, default value: `0`.
-
-```
-:strategy
-```
-
-Values: `ZSTDS::Option::STRATEGIES`, default value: none.
-
-```
-:enable_long_distance_matching
-```
-
-Values: true/false, default value: none.
-
-```
-:ldm_hash_log
-```
-
-Values: `ZSTDS::Option::MIN_LDM_HASH_LOG` - `ZSTDS::Option::MAX_LDM_HASH_LOG`, default value: `0`.
-
-```
-:ldm_min_match
-```
+For example you want to use 1 KB as `source_buffer_length` for compressor - please use 256 B as `destination_buffer_length`.
+You want to use 256 B as `source_buffer_length` for decompressor - please use 1 KB as `destination_buffer_length`.
 
-Values: `ZSTDS::Option::MIN_LDM_MIN_MATCH` - `ZSTDS::Option::MAX_LDM_MIN_MATCH`, default value: `0`.
-
-```
-:ldm_bucket_size_log
-```
-
-Values: `ZSTDS::Option::MIN_LDM_BUCKET_SIZE_LOG` - `ZSTDS::Option::MAX_LDM_BUCKET_SIZE_LOG`, default value: `0`.
-
-```
-:ldm_hash_rate_log
-```
-
-Values: `ZSTDS::Option::MIN_LDM_HASH_RATE_LOG` - `ZSTDS::Option::MAX_LDM_HASH_RATE_LOG`, default value: `0`.
-
-```
-:content_size_flag
-```
-
-Values: true/false, default value: true.
-
-```
-:checksum_flag
-```
-
-Values: true/false, default value: false.
-
-```
-:dict_id_flag
-```
-
-Values: true/false, default value: true.
-
-```
-:nb_workers
-```
-
-Values: `ZSTDS::Option::MIN_NB_WORKERS` - `ZSTDS::Option::MAX_NB_WORKERS`, default value: `0`.
-
-```
-:job_size
-```
-
-Values: `ZSTDS::Option::MIN_JOB_SIZE` - `ZSTDS::Option::MAX_JOB_SIZE`, default value: `0`.
-
-```
-:overlap_log
-```
-
-Values: `ZSTDS::Option::MIN_OVERLAP_LOG` - `ZSTDS::Option::MAX_OVERLAP_LOG`, default value: `0`.
-
-```
-:window_log_max
-```
-
-Values: `ZSTDS::Option::MIN_WINDOW_LOG_MAX` - `ZSTDS::Option::MAX_WINDOW_LOG_MAX`, default value: `0`.
-
-```
-:dictionary
-```
-
-Special option for dictionary, default value: none.
-
-```
-:pledged_size
-```
-
-Values: 0 - infinity, default value: 0.
-It is reasonable to provide size of input (if known) for streaming api.
 `String` and `File` will set `:pledged_size` automaticaly.
 
-Please read zstd docs for more info about options.
+You can also read zstd docs for more info about options.
+
+| Option                | Related constants |
+|-----------------------|-------------------|
+| `compression_level`   | `ZSTDS::Option::MIN_COMPRESSION_LEVEL = -131072`, `ZSTDS::Option::MAX_COMPRESSION_LEVEL = 22` |
+| `window_log`          | `ZSTDS::Option::MIN_WINDOW_LOG = 10`, `ZSTDS::Option::MAX_WINDOW_LOG = 31` |
+| `hash_log`            | `ZSTDS::Option::MIN_HASH_LOG = 6`, `ZSTDS::Option::MAX_HASH_LOG = 30` |
+| `chain_log`           | `ZSTDS::Option::MIN_CHAIN_LOG = 6`, `ZSTDS::Option::MAX_CHAIN_LOG = 30` |
+| `search_log`          | `ZSTDS::Option::MIN_SEARCH_LOG = 1`, `ZSTDS::Option::MAX_SEARCH_LOG = 30` |
+| `min_match`           | `ZSTDS::Option::MIN_MIN_MATCH = 3`, `ZSTDS::Option::MAX_MIN_MATCH = 7` |
+| `target_length`       | `ZSTDS::Option::MIN_TARGET_LENGTH = 0`, `ZSTDS::Option::MAX_TARGET_LENGTH = 131072` |
+| `strategy`            | `ZSTDS::Option::STRATEGIES = %i[fast dfast greedy lazy lazy2 btlazy2 btopt btultra btultra2]` |
+| `ldm_hash_log`        | `ZSTDS::Option::MIN_LDM_HASH_LOG = 6`, `ZSTDS::Option::MAX_LDM_HASH_LOG = 30` |
+| `ldm_min_match`       | `ZSTDS::Option::MIN_LDM_MIN_MATCH = 4`, `ZSTDS::Option::MAX_LDM_MIN_MATCH = 4096` |
+| `ldm_bucket_size_log` | `ZSTDS::Option::MIN_LDM_BUCKET_SIZE_LOG = 1`, `ZSTDS::Option::MAX_LDM_BUCKET_SIZE_LOG = 8` |
+| `ldm_hash_rate_log`   | `ZSTDS::Option::MIN_LDM_HASH_RATE_LOG = 0`, `ZSTDS::Option::MAX_LDM_HASH_RATE_LOG = 25` |
+| `nb_workers`          | `ZSTDS::Option::MIN_NB_WORKERS = 0`, `ZSTDS::Option::MAX_NB_WORKERS = 200` |
+| `job_size`            | `ZSTDS::Option::MIN_JOB_SIZE = 0`, `ZSTDS::Option::MAX_JOB_SIZE = 1073741824` |
+| `overlap_log`         | `ZSTDS::Option::MIN_OVERLAP_LOG = 0`, `ZSTDS::Option::MAX_OVERLAP_LOG = 9` |
+| `window_log_max`      | `ZSTDS::Option::MIN_WINDOW_LOG_MAX = 10`, `ZSTDS::Option::MAX_WINDOW_LOG_MAX = 31` |
 
 Possible compressor options:
 ```
+:source_buffer_length
+:destination_buffer_length
 :compression_level
 :window_log
 :hash_log
@@ -278,6 +186,8 @@ Possible compressor options:
 
 Possible decompressor options:
 ```
+:source_buffer_length
+:destination_buffer_length
 :window_log_max
 :dictionary
 ```
@@ -514,8 +424,6 @@ 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
 
 MIT license, see LICENSE and AUTHORS.

data/ext/extconf.rb

@@ -75,6 +75,13 @@ $srcs = %w[
 .map { |name| "src/#{extension_name}/#{name}.c" }
 .freeze
 
+# Removing library duplicates.
+$libs = $libs.split(%r{\s})
+  .reject(&:empty?)
+  .sort
+  .uniq
+  .join " "
+
 if ENV["CI"] || ENV["COVERAGE"]
   $CFLAGS << " --coverage"
   $LDFLAGS << " --coverage"

data/lib/zstds/option.rb

@@ -166,9 +166,8 @@ module ZSTDS
       end
 
       dictionary = options[:dictionary]
-      unless dictionary.nil?
-        raise ValidateError, "invalid dictionary" unless dictionary.is_a? Dictionary
-      end
+      raise ValidateError, "invalid dictionary" unless
+        dictionary.nil? || dictionary.is_a?(Dictionary)
 
       options
     end

data/lib/zstds/version.rb

@@ -2,5 +2,5 @@
 # Copyright (c) 2019 AUTHORS, MIT License.
 
 module ZSTDS
-  VERSION = "1.0.4".freeze
+  VERSION = "1.0.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-zstds
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Andrew Aladjev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -194,9 +194,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="