ruby-brs 1.3.0 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 519776eef000f690d628b64310be61daf3e8cc144a103fa848586f1165e92de9
-  data.tar.gz: 8a0f7b24666a6291b10700a6ddf4dfd8afe90e2286750ca02531126348f0a198
+  metadata.gz: b6acc107214aae47c21bea586f3281f3b16ad01e03a5f13990667603b625ebd3
+  data.tar.gz: 7cf0a0aacb4bb52457f009a1ceffc6a6c9b6fb80bdf289b86efaabeed261de3f
 SHA512:
-  metadata.gz: c1a644ae3619da601177e0985926acffb6a43910c9686dfdb97b33f191814699f0cb6c9e38a5ecedb5f33999ac9cf129d0864bfcb2d065981faf1da61f5ef9c5
-  data.tar.gz: f7cf208285d14a9c2ef5b868dee4c1bf2dbe1262479cc250b6ce48d4c462007da431e8c5322097c8bf71cdef009140625ed8439d0c2a878825a4b502599a2086
+  metadata.gz: 703c614f49408c3aeb4203aa6f1a5f6abd341d3e0f88275d6c88d52e66e0f1a2f49e00908675e9a4bebcefd0851b33b3f7a115b7e3577d2718acb90d6d2ae551
+  data.tar.gz: d4984cf3b656386c7ab0dfecaebed8be95e5b2b0a24c48a21413e4908fd50d9862883baf887dddb980378f9604346b3da2bc5a9b09c0b430882247ec72a22a87

data/AUTHORS

@@ -1 +1,2 @@
 Andrew Aladjev
+Jenner La Fave

data/README.md

@@ -1,14 +1,23 @@
 # Ruby bindings for brotli library
 
-| AppVeyor | Circle | Github actions | Codecov | Gem  |
-| :------: | :----: | :------------: | :-----: | :--: |
-| [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-brs?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-brs/branch/master) | [![Circle test status](https://circleci.com/gh/andrew-aladev/ruby-brs/tree/master.svg?style=shield)](https://circleci.com/gh/andrew-aladev/ruby-brs/tree/master) | [![Github Actions test status](https://github.com/andrew-aladev/ruby-brs/workflows/test/badge.svg?branch=master)](https://github.com/andrew-aladev/ruby-brs/actions) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-brs/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-brs) | [![Gem](https://img.shields.io/gem/v/ruby-brs.svg)](https://rubygems.org/gems/ruby-brs) |
+| AppVeyor | Jenkins | Github actions | Codecov | Gem  |
+| :------: | :-----: | :------------: | :-----: | :--: |
+| [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-brs?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-brs/branch/master) | [![Jenkins test status](http://37.187.122.190:58182/buildStatus/icon?job=ruby-brs)](http://37.187.122.190:58182/job/ruby-brs) | [![Github Actions test status](https://github.com/andrew-aladev/ruby-brs/workflows/test/badge.svg?branch=master)](https://github.com/andrew-aladev/ruby-brs/actions) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-brs/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-brs) | [![Gem](https://img.shields.io/gem/v/ruby-brs.svg)](https://rubygems.org/gems/ruby-brs) |
 
 See [brotli library](https://github.com/google/brotli).
 
 ## Installation
 
-Please install brotli library first, use latest 1.0.0+ version.
+Operating systems: GNU/Linux, FreeBSD, OSX.
+
+Dependencies: [brotli](https://github.com/google/brotli) 1.0.0+ version.
+
+| Popular OS | Dependencies              |
+|------------|---------------------------|
+| Ubuntu     | `libbrotli-dev`           |
+| CentOS     | `brotli-devel`            |
+| ArchLinux  | `brotli`                  |
+| OSX        | `brotli`                  |
 
 ```sh
 gem install ruby-brs
@@ -23,6 +32,22 @@ gem install pkg/ruby-brs-*.gem
 
 You can also use [overlay](https://github.com/andrew-aladev/overlay) for gentoo.
 
+### Installation in macOS on Apple Silicon
+
+On M1 Macs, Homebrew installs to /opt/homebrew, so you'll need to specify its
+include and lib paths when building the native extension for brotli.
+
+```sh
+brew install brotli
+gem install ruby-brs -- --with-opt-include=/opt/homebrew/include --with-opt-lib=/opt/homebrew/lib
+```
+
+You can also configure Bundler to use those options when installing:
+
+```sh
+bundle config set build.ruby-brs "--with-opt-include=/opt/homebrew/include --with-opt-lib=/opt/homebrew/lib"
+```
+
 ## Usage
 
 There are simple APIs: `String` and `File`. Also you can use generic streaming API: `Stream::Writer` and `Stream::Reader`.
@@ -107,6 +132,10 @@ Parallel.each large_datas do |large_data|
 end
 ```
 
+# Docs
+
+Please review [rdoc generated docs](https://andrew-aladev.github.io/ruby-brs).
+
 ## Options
 
 | Option                             | Values     | Default    | Description |
@@ -118,8 +147,8 @@ end
 | `quality`                          | 0 - 11     | 11         | compression level |
 | `lgwin`                            | 10 - 24    | 22         | compressor window size |
 | `lgblock`                          | 16 - 24    | nil (auto) | compressor input block size |
-| `npostfix`                         | 0 - 3      | nil (auto) | Recommended number of postfix bits |
-| `ndirect`                          | 0 - 120    | nil (auto) | Recommended number of direct distance codes (step 1 << npostfix, max 15 << npostfix) |
+| `npostfix`                         | 0 - 3      | nil (auto) | recommended number of postfix bits |
+| `ndirect`                          | 0 - 120    | nil (auto) | recommended number of direct distance codes (step 1 << npostfix, max 15 << npostfix) |
 | `disable_literal_context_modeling` | true/false | false      | disables literal context modeling format |
 | `disable_ring_buffer_reallocation` | true/false | false      | disables ring buffer reallocation |
 | `size_hint`                        | 0 - inf    | 0 (auto)   | size of input (if known) |
@@ -266,14 +295,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)
 ```
 
@@ -367,10 +393,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/brs_ext/gvl.h

@@ -4,7 +4,7 @@
 #if !defined(BRS_EXT_GVL_H)
 #define BRS_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 BRS_EXT_GVL_WRAP(_gvl, function, data) function((void*) data);
 
-#endif
+#endif // HAVE_RB_THREAD_CALL_WITHOUT_GVL
 
 #endif // BRS_EXT_GVL_H

data/ext/brs_ext/macro.h

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

data/lib/brs/error.rb

@@ -1,21 +1,26 @@
 # Ruby bindings for brotli library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp"
+
 module BRS
   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/brs/file.rb

@@ -1,50 +1,40 @@
 # Ruby bindings for brotli library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/file"
 require "brs_ext"
 
-require_relative "error"
 require_relative "option"
 require_relative "validation"
 
 module BRS
-  module File
-    BUFFER_LENGTH_NAMES = %i[source_buffer_length destination_buffer_length].freeze
-
+  # BRS::File class.
+  class File < ADSP::File
+    # Current option class.
+    Option = BRS::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: +:size_hint+ 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[:size_hint] = ::File.size source
 
-      open_files source, destination do |source_io, destination_io|
-        BRS._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|
-        BRS._native_decompress_io source_io, destination_io, options
-      end
-
-      nil
+    # Bypass native compress.
+    def self.native_compress_io(*args)
+      BRS._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)
+      BRS._native_decompress_io(*args)
     end
   end
 end

data/lib/brs/option.rb

@@ -7,29 +7,58 @@ require_relative "error"
 require_relative "validation"
 
 module BRS
+  # BRS::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,
+      # Compressor mode.
       :mode                             => nil,
+      # Compression level.
       :quality                          => nil,
+      # Compressor window size.
       :lgwin                            => nil,
+      # Compressor input block size.
       :lgblock                          => nil,
+      # Recommended number of postfix bits.
       :npostfix                         => nil,
+      # Recommended number of direct distance codes (step 1 << npostfix, max 15 << npostfix).
       :ndirect                          => nil,
+      # Disables literal context modeling format.
       :disable_literal_context_modeling => nil,
+      # Enables large window.
       :large_window                     => nil
     }
     .freeze
 
+    # Current decompressor defaults.
     DECOMPRESSOR_DEFAULTS = {
+      # Enables global VM lock where possible.
       :gvl                              => false,
+      # Disables ring buffer reallocation.
       :disable_ring_buffer_reallocation => nil,
+      # Enables large window.
       :large_window                     => 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: +:mode+ compressor mode.
+    # Option: +:quality+ compression level.
+    # Option: +:lgwin+ compressor window size.
+    # Option: +:lgblock+ compressor input block size.
+    # Option: +:npostfix+ recommended number of postfix bits.
+    # Option: +:ndirect+ recommended number of direct distance codes (step 1 << npostfix, max 15 << npostfix).
+    # Option: +:disable_literal_context_modeling+ Disables literal context modeling format.
+    # Option: +:large_window+ enables large window.
+    # Returns processed compressor options.
     def self.get_compressor_options(options, buffer_length_names)
       Validation.validate_hash options
 
@@ -94,6 +123,13 @@ module BRS
       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: +:disable_ring_buffer_reallocation+ disables ring buffer reallocation.
+    # Option: +:large_window+ enables large window.
+    # Returns processed decompressor options.
     def self.get_decompressor_options(options, buffer_length_names)
       Validation.validate_hash options
 

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

@@ -1,97 +1,33 @@
 # Ruby bindings for brotli library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/stream/raw/compressor"
 require "brs_ext"
 
-require_relative "abstract"
-require_relative "../../error"
 require_relative "../../option"
 require_relative "../../validation"
 
 module BRS
   module Stream
     module Raw
-      class Compressor < Abstract
-        BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
+      # BRS::Stream::Raw::Compressor class.
+      class Compressor < ADSP::Stream::Raw::Compressor
+        # Current native compressor class.
+        NativeCompressor = Stream::NativeCompressor
 
+        # Current option class.
+        Option = BRS::Option
+
+        # Initializes compressor.
+        # Option: +:destination_buffer_length+ destination buffer length.
+        # Option: +:size_hint+ source bytesize.
         def initialize(options = {})
           options = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
 
           size_hint = options[:size_hint]
           Validation.validate_not_negative_integer size_hint unless size_hint.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/brs/stream/raw/decompressor.rb

@@ -1,65 +1,21 @@
 # Ruby bindings for brotli library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/stream/raw/decompressor"
 require "brs_ext"
 
-require_relative "abstract"
 require_relative "../../option"
-require_relative "../../validation"
 
 module BRS
   module Stream
     module Raw
-      class Decompressor < Abstract
-        BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
+      # BRS::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 = BRS::Option
       end
     end
   end