ruby-lzws 1.0.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e42a999e18187b07931b4c7127274339f8d6eb61490d2c3bcd504180c674d43
-  data.tar.gz: 8516d4a94686aeeb2587fcb6bd862dc85ff651ac6e71ae0449e3797a85653f78
+  metadata.gz: 6fc8861bd91fe484c375cdeae3ad55e478727e8a1314117fb3897cef408bd401
+  data.tar.gz: 9b7a0d9cd62930a12250641599638d80abb34737bae20842109d91f1dfee84a8
 SHA512:
-  metadata.gz: 4c8f80f27ac4b2e12bc3628468b94bbebe5b00b688a6dc586013797b5eabb8a1a85da39fdd2ba5d48ed81d71d77df463800f6ef8c285d41bf057c1d306ed2727
-  data.tar.gz: f4ced4337b346873836d004c57ca6411f62ba604d32a69001658db3705c4098f1a938e23c2242092bd76e645792824daeba93680ea3d3da5c4529872279095cc
+  metadata.gz: 880eb17f48cca872b77a56936aedebe4aa416eb971e51743550e0bd02c473568fb638d412deab64c522fa84895732c9f91da338a7d4f79bd3ac4c382f35326eb
+  data.tar.gz: e29e72c646f05e55ec4411a06e4be7122581962d9fe46164bc6bbaeefd1e874595ad74783503f76bf049096730043032976c8595e2d7903d9acb3ab9bb39b8cc

data/README.md

@@ -1,13 +1,14 @@
 # Ruby bindings for lzws library
 
-[![Travis build status](https://travis-ci.org/andrew-aladev/ruby-lzws.svg?branch=master)](https://travis-ci.org/andrew-aladev/ruby-lzws)
-[![AppVeyor build 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)
+| Travis | AppVeyor | Cirrus | Circle | Codecov |
+| :---:  | :---:    | :---:  | :---:  | :---:   |
+| [![Travis test status](https://travis-ci.com/andrew-aladev/ruby-lzws.svg?branch=master)](https://travis-ci.com/andrew-aladev/ruby-lzws) | [![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) | [![Cirrus test status](https://api.cirrus-ci.com/github/andrew-aladev/ruby-lzws.svg?branch=master)](https://cirrus-ci.com/github/andrew-aladev/ruby-lzws) | [![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) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-lzws/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-lzws) |
 
 See [lzws library](https://github.com/andrew-aladev/lzws).
 
 ## Installation
 
-Please install lzws library first.
+Please install lzws library first, use latest 1.3.0+ version.
 
 ```sh
 gem install ruby-lzws
@@ -38,7 +39,7 @@ puts LZWS::Stream::Reader.open("file.txt.Z") { |reader| reader.read }
 ```
 
 You can create and read `tar.Z` archives with `minitar` for example.
-LZWS is fully compatible with UNIX compress (with default options).
+LZWS is compatible with UNIX compress (with default options).
 
 ```ruby
 require "lzws"
@@ -60,30 +61,86 @@ LZWS::Stream::Reader.open "file.tar.Z" do |reader|
 end
 ```
 
-Each API supports additional options, please read lzws docs for more info.
+## Options
 
-Compressor:
+Each API supports several options:
+
+```
+:source_buffer_length
+:destination_buffer_length
+```
+
+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, 2 - infinity, default value: 0.
+0 means automatic buffer length selection.
+1 byte is not enough, 2 bytes is minimal buffer length.
 
 ```
 :max_code_bit_length
+```
+
+Values: `LZWS::Option::LOWEST_MAX_CODE_BIT_LENGTH` - `LZWS::Option::BIGGEST_MAX_CODE_BIT_LENGTH`, default value: `LZWS::Option::BIGGEST_MAX_CODE_BIT_LENGTH`.
+
+```
 :block_mode
-:buffer_length
+```
+
+Values: true/false, default value: true.
+
+```
 :without_magic_header
+```
+
+Values: true/false, default value: false.
+
+```
 :msb
+```
+
+Values: true/false, default value: false.
+
+```
 :unaligned_bit_groups
+```
+
+Values: true/false, default value: false.
+
+```
 :quiet
 ```
 
-Decompressor:
+Values: true/false, default value: false.
+Disables lzws library logging.
+
+Please read lzws docs for more info about options.
+
+Possible compressor options:
+```
+:source_buffer_length
+:destination_buffer_length
+:max_code_bit_length
+:block_mode
+:without_magic_header
+:msb
+:unaligned_bit_groups
+:quiet
+```
 
+Possible decompressor options:
 ```
-:buffer_length
+:source_buffer_length
+:destination_buffer_length
 :without_magic_header
 :msb
 :unaligned_bit_groups
 :quiet
 ```
 
+Example:
+
 ```ruby
 require "lzws"
 
@@ -91,7 +148,7 @@ data = LZWS::String.compress "TOBEORNOTTOBEORTOBEORNOT", :msb => true
 puts LZWS::String.decompress(data, :msb => true)
 ```
 
-You can use `Content-Encoding: compress`.
+Default options are compatible with UNIX compress (`Content-Encoding: compress`):
 
 ```ruby
 require "lzws"
@@ -103,50 +160,91 @@ get "/" do
 end
 ```
 
-## Docs
+Please read more about compatibility in lzws docs.
 
-`LZWS::String`:
+## String
+
+String maintains destination buffer only, so it accepts `destination_buffer_length` option only.
 
 ```
 ::compress(source, options = {})
 ::decompress(source, options = {})
 ```
 
-`LZWS::File`:
+`source` is a source string.
+
+## File
+
+File maintains both source and destination buffers, it accepts both `source_buffer_length` and `destination_buffer_length` options.
 
 ```
 ::compress(source, destination, options = {})
 ::decompress(source, destination, options = {})
 ```
 
-`LZWS::Stream::Writer` and `LZWS::Stream::Reader`:
+`source` and `destination` are file pathes.
+
+## Stream::Writer
+
+Its behaviour is similar to builtin [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html).
+
+Writer maintains destination buffer only, so it accepts `destination_buffer_length` option only.
+
+```
+::open(file_path, options = {}, :external_encoding => nil, :transcode_options => {}, &block)
+```
+
+Open file path and create stream writer associated with opened file.
+Data will be transcoded to `:external_encoding` using `:transcode_options` before compressing.
+
+```
+::new(destination_io, options = {}, :external_encoding => nil, :transcode_options => {})
+```
+
+Create stream writer associated with destination io.
+Data will be transcoded to `:external_encoding` using `:transcode_options` before compressing.
+
+```
+#set_encoding(external_encoding, nil, transcode_options)
+```
+
+Set another encodings, `nil` is just for compatibility with `IO`.
 
 ```
-::open(file_path, options = {}, :external_encoding => nil, :internal_encoding => nil, &block)
 #io
+#to_io
 #stat
 #external_encoding
-#internal_encoding
+#transcode_options
 #pos
 #tell
-#advise
-#set_encoding(external_encoding, internal_encoding, transcode_options)
+```
+
+See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
+
+```
+#write(*objects)
+#flush
 #rewind
 #close
 #closed?
-#to_io
 ```
 
-`Stream::Writer`:
+See [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
 
 ```
-::new(destination_io, options = {}, :external_encoding => nil)
-#write(*objects)
-#flush
 #write_nonblock(object, *options)
 #flush_nonblock(*options)
 #rewind_nonblock(*options)
 #close_nonblock(*options)
+```
+
+Special asynchronous methods missing in `Zlib::GzipWriter`.
+`rewind` wants to `close`, `close` wants to `write` something and `flush`, `flush` want to `write` something.
+So it is possible to have asynchronous variants for these synchronous methods.
+Behaviour is the same as `IO#write_nonblock` method.
+
+```
 #<<(object)
 #print(*objects)
 #printf(*args)
@@ -154,24 +252,77 @@ end
 #puts(*objects)
 ```
 
-`Stream::Reader`:
+Typical helpers, see [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
+
+## Stream::Reader
+
+Its behaviour is similar to builtin [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html).
+
+Reader maintains both source and destination buffers, it accepts both `source_buffer_length` and `destination_buffer_length` options.
+
+```
+::open(file_path, options = {}, :external_encoding => nil, :internal_encoding => nil, :transcode_options => {}, &block)
+```
+
+Open file path and create stream reader associated with opened file.
+Data will be force encoded to `:external_encoding` and transcoded to `:internal_encoding` using `:transcode_options` after decompressing.
+
+```
+::new(source_io, options = {}, :external_encoding => nil, :internal_encoding => nil, :transcode_options => {})
+```
+
+Create stream reader associated with source io.
+Data will be force encoded to `:external_encoding` and transcoded to `:internal_encoding` using `:transcode_options` after decompressing.
+
+```
+#set_encoding(external_encoding, internal_encoding, transcode_options)
+```
+
+Set another encodings.
+
+```
+#io
+#to_io
+#stat
+#external_encoding
+#internal_encoding
+#transcode_options
+#pos
+#tell
+```
+
+See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 
 ```
-::new(source_io, options = {}, :external_encoding => nil, :internal_encoding => nil)
-#lineno
-#lineno=
 #read(bytes_to_read = nil, out_buffer = nil)
+#eof?
+#rewind
+#close
+#closed?
+```
+
+See [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+
+```
 #readpartial(bytes_to_read = nil, out_buffer = nil)
 #read_nonblock(bytes_to_read, out_buffer = nil, *options)
-#eof?
+```
+
+See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
+
+```
 #getbyte
 #each_byte(&block)
 #readbyte
 #ungetbyte(byte)
+
 #getc
 #readchar
 #each_char(&block)
 #ungetc(char)
+
+#lineno
+#lineno=
 #gets(separator = $OUTPUT_RECORD_SEPARATOR, limit = nil)
 #readline
 #readlines
@@ -180,8 +331,15 @@ end
 #ungetline(line)
 ```
 
-`LZWS::Stream::Writer` and `LZWS::Stream::Reader` behaviour is the same as builtin [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.6.3/libdoc/zlib/rdoc/Zlib/GzipReader.html), [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.6.3/libdoc/zlib/rdoc/Zlib/GzipWriter.html) and [`IO`](https://ruby-doc.org/core-2.6.3/IO.html).
-Please read these method descriptions in ruby doc.
+Typical helpers, see [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+
+## CI
+
+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
 

data/ext/extconf.rb

@@ -3,74 +3,76 @@
 
 require "mkmf"
 
-def require_header(name)
+def require_header(name, types = [])
   abort "Can't find #{name} header" unless find_header name
+
+  types.each do |type|
+    abort "Can't find #{type} type in #{name} header" unless find_type type, nil, name
+  end
 end
 
 require_header "lzws/buffer.h"
+require_header "lzws/common.h", %w[lzws_result_t]
 require_header "lzws/compressor/common.h"
-require_header "lzws/compressor/header.h"
 require_header "lzws/compressor/main.h"
-require_header "lzws/compressor/state.h"
+require_header "lzws/compressor/state.h", %w[lzws_compressor_state_t]
 require_header "lzws/decompressor/common.h"
-require_header "lzws/decompressor/header.h"
 require_header "lzws/decompressor/main.h"
-require_header "lzws/decompressor/state.h"
+require_header "lzws/decompressor/state.h", %w[lzws_decompressor_state_t]
 require_header "lzws/file.h"
-require_header "lzws/string.h"
 
 def require_library(name, functions)
   functions.each do |function|
-    abort "Can't find #{name} library and #{function} function" unless find_library name, function
+    abort "Can't find #{function} function in #{name} library" unless find_library name, function
   end
 end
 
-functions = %w[
-  lzws_create_buffer_for_compressor
-  lzws_create_buffer_for_decompressor
-  lzws_resize_buffer
-
-  lzws_compress_string
-  lzws_decompress_string
+require_library(
+  "lzws",
+  %w[
+    lzws_create_source_buffer_for_compressor
+    lzws_create_destination_buffer_for_compressor
+    lzws_create_source_buffer_for_decompressor
+    lzws_create_destination_buffer_for_decompressor
 
-  lzws_compress_file
-  lzws_decompress_file
+    lzws_compressor_get_initial_state
+    lzws_compressor_free_state
+    lzws_compress
+    lzws_compressor_finish
 
-  lzws_compressor_write_magic_header
-  lzws_compressor_get_initial_state
-  lzws_compress
-  lzws_flush_compressor
-  lzws_compressor_free_state
-
-  lzws_decompressor_read_magic_header
-  lzws_decompressor_get_initial_state
-  lzws_decompress
-  lzws_decompressor_free_state
-]
-.freeze
+    lzws_decompressor_get_initial_state
+    lzws_decompressor_free_state
+    lzws_decompress
 
-require_library "lzws", functions
+    lzws_compress_file
+    lzws_decompress_file
+  ]
+)
 
 extension_name = "lzws_ext".freeze
 dir_config extension_name
 
-sources = %w[
+# rubocop:disable Style/GlobalVars
+$srcs = %w[
   stream/compressor
   stream/decompressor
+  buffer
   error
   io
   main
   option
   string
 ]
+.map { |name| "src/#{extension_name}/#{name}.c" }
 .freeze
 
-# rubocop:disable Style/GlobalVars
-$srcs = sources
-  .map { |name| "src/#{extension_name}/#{name}.c" }
-  .freeze
+if ENV["CI"] || ENV["COVERAGE"]
+  $CFLAGS << " --coverage"
+  $LDFLAGS << " --coverage"
+end
 
 $CFLAGS << " -Wno-declaration-after-statement"
+
 $VPATH << "$(srcdir)/#{extension_name}:$(srcdir)/#{extension_name}/stream"
 # rubocop:enable Style/GlobalVars