ruby-brs 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863866e6104d00a5ddb331c3dbf693789b9c45d6669613128daebdf19fd1814d
-  data.tar.gz: d6bdbf9826d47a28b7360b3899953a57ba6769053bac9e5c1d598b70494de6ef
+  metadata.gz: 614baececc4a64311bdd172a962cb5f9bc721b2ade99ed84216ab79908f5a0ca
+  data.tar.gz: 88899da83cd343c1217652b7558a6770e43bd7722f3db7e1e3023ad54888bb54
 SHA512:
-  metadata.gz: 9d2dbcdea7dd3904429b79a2af1cec88d6695e17437547f76c08649c117bb19d0943a4db7e9cc6335eebfdac04d1f818ca08af733a943b9b79e1b426909de751
-  data.tar.gz: ff911df08d9cd98516cbb4c734af7816de17d80346939ecdf39bc3c6a0dfe0c0bbb1d9d0e31e81f34d06b6b32a9e791805f7a7983cfaf2b3f6562532f9351322
+  metadata.gz: efb6e0ec7ee97e4d4c6977b6843ee81ae6ec334af2985674634ea31a24ff00373753cc828bbc250ec137700fa721f84e1071fd6486cbbc2db869e4e6850e7255
+  data.tar.gz: 0ad07a2ebbbbbd27ff47a4e2780e90f297f4d02b36107f2877d45863f538b3f9b32b6aab18451a6376f620c6eee50118b6023b405cdb1f7c8079f1b8a295fd82

data/AUTHORS

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

data/README.md

@@ -8,7 +8,17 @@ 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, Windows (MinGW).
+
+Dependencies: [brotli](https://github.com/google/brotli) 1.0.0+ version.
+
+| Popular OS | Dependencies              |
+|------------|---------------------------|
+| Ubuntu     | `libbrotli-dev`           |
+| CentOS     | `brotli-devel`            |
+| ArchLinux  | `brotli`                  |
+| OSX        | `brotli`                  |
+| Windows    | `mingw-w64-x86_64-brotli` |
 
 ```sh
 gem install ruby-brs
@@ -23,6 +33,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`.
@@ -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/stream/abstract.rb

@@ -24,9 +24,7 @@ module BRS
 
       def initialize(io, options = {})
         @raw_stream = create_raw_stream
-
-        Validation.validate_io io
-        @io = io
+        @io         = io
 
         @stat = Stat.new @io.stat if @io.respond_to? :stat
 
@@ -135,13 +133,19 @@ module BRS
       end
 
       def close
-        @io.close
+        @io.close if @io.respond_to? :close
 
         nil
       end
 
       def closed?
-        @raw_stream.closed? && @io.closed?
+        return false unless @raw_stream.closed?
+
+        if @io.respond_to? :closed
+          @io.closed?
+        else
+          true
+        end
       end
 
       def to_io

data/lib/brs/stream/reader.rb

@@ -54,6 +54,9 @@ module BRS
         Validation.validate_not_negative_integer bytes_to_read unless bytes_to_read.nil?
         Validation.validate_string out_buffer unless out_buffer.nil?
 
+        raise ValidateError, "io should be responsible to read and eof" unless
+          @io.respond_to?(:read) && @io.respond_to?(:eof?)
+
         unless bytes_to_read.nil?
           return ::String.new :encoding => ::Encoding::BINARY if bytes_to_read.zero?
           return nil if eof?
@@ -86,16 +89,22 @@ module BRS
       end
 
       def eof?
+        raise ValidateError, "io should be responsible to eof" unless @io.respond_to? :eof?
+
         empty? && @io.eof?
       end
 
       # -- asynchronous --
 
       def readpartial(bytes_to_read, out_buffer = nil)
+        raise ValidateError, "io should be responsible to readpartial" unless @io.respond_to? :readpartial
+
         read_more_nonblock(bytes_to_read, out_buffer) { @io.readpartial @source_buffer_length }
       end
 
       def read_nonblock(bytes_to_read, out_buffer = nil, *options)
+        raise ValidateError, "io should be responsible to read nonblock" unless @io.respond_to? :read_nonblock
+
         read_more_nonblock(bytes_to_read, out_buffer) { @io.read_nonblock(@source_buffer_length, *options) }
       end
 

data/lib/brs/stream/writer.rb

@@ -23,6 +23,8 @@ module BRS
       # -- synchronous --
 
       def write(*objects)
+        validate_write
+
         write_remaining_buffer
 
         bytes_written = 0
@@ -38,20 +40,26 @@ module BRS
       end
 
       def flush
+        validate_write
+
         finish :flush
 
-        @io.flush
+        @io.flush if @io.respond_to? :flush
 
         self
       end
 
       def rewind
+        validate_write
+
         finish :close
 
         super
       end
 
       def close
+        validate_write
+
         finish :close
 
         super
@@ -75,6 +83,10 @@ module BRS
         @raw_stream.send(method_name, *args) { |portion| @io.write portion }
       end
 
+      def validate_write
+        raise ValidateError, "io should be responsible to write" unless @io.respond_to? :write
+      end
+
       # -- asynchronous --
 
       # IO write nonblock can raise wait writable error.
@@ -83,6 +95,8 @@ module BRS
       # So we have to accept content after processing IO write nonblock.
       # It means that first write nonblock won't call IO write nonblock.
       def write_nonblock(object, *options)
+        validate_write_nonblock
+
         return 0 unless write_remaining_buffer_nonblock(*options)
 
         source         = transcode object.to_s
@@ -93,14 +107,18 @@ module BRS
       end
 
       def flush_nonblock(*options)
+        validate_write_nonblock
+
         return false unless finish_nonblock :flush, *options
 
-        @io.flush
+        @io.flush if @io.respond_to? :flush
 
         true
       end
 
       def rewind_nonblock(*options)
+        validate_write_nonblock
+
         return false unless finish_nonblock :close, *options
 
         method(:rewind).super_method.call
@@ -109,6 +127,8 @@ module BRS
       end
 
       def close_nonblock(*options)
+        validate_write_nonblock
+
         return false unless finish_nonblock :close, *options
 
         method(:close).super_method.call
@@ -139,6 +159,10 @@ module BRS
         @raw_stream.send(method_name, *args) { |portion| @buffer << portion }
       end
 
+      def validate_write_nonblock
+        raise ValidateError, "io should be responsible to write nonblock" unless @io.respond_to? :write_nonblock
+      end
+
       # -- common --
 
       protected def transcode(data)

data/lib/brs/validation.rb

@@ -5,45 +5,20 @@ require_relative "error"
 
 module BRS
   module Validation
-    IO_METHODS = %i[
-      read
-      write
-      readpartial
-      read_nonblock
-      write_nonblock
-      eof?
-      flush
-      close
-      closed?
-    ]
-    .freeze
-
     def self.validate_bool(value)
       raise ValidateError, "invalid bool" unless value.is_a?(::TrueClass) || value.is_a?(::FalseClass)
     end
 
-    def self.validate_positive_integer(value)
-      raise ValidateError, "invalid positive integer" unless value.is_a?(::Integer) && value.positive?
+    def self.validate_hash(value)
+      raise ValidateError, "invalid hash" unless value.is_a? ::Hash
     end
 
     def self.validate_not_negative_integer(value)
       raise ValidateError, "invalid not negative integer" unless value.is_a?(::Integer) && value >= 0
     end
 
-    def self.validate_string(value)
-      raise ValidateError, "invalid string" unless value.is_a? ::String
-    end
-
-    def self.validate_symbol(value)
-      raise ValidateError, "invalid symbol" unless value.is_a? ::Symbol
-    end
-
-    def self.validate_io(value)
-      raise ValidateError, "invalid io" unless IO_METHODS.all? { |method| value.respond_to? method }
-    end
-
-    def self.validate_hash(value)
-      raise ValidateError, "invalid hash" unless value.is_a? ::Hash
+    def self.validate_positive_integer(value)
+      raise ValidateError, "invalid positive integer" unless value.is_a?(::Integer) && value.positive?
     end
 
     def self.validate_proc(value)
@@ -51,5 +26,13 @@ module BRS
         raise ValidateError, "invalid proc"
       end
     end
+
+    def self.validate_string(value)
+      raise ValidateError, "invalid string" unless value.is_a? ::String
+    end
+
+    def self.validate_symbol(value)
+      raise ValidateError, "invalid symbol" unless value.is_a? ::Symbol
+    end
   end
 end

data/lib/brs/version.rb

@@ -2,5 +2,5 @@
 # Copyright (c) 2019 AUTHORS, MIT License.
 
 module BRS
-  VERSION = "1.3.1".freeze
+  VERSION = "1.3.2".freeze
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brs
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Andrew Aladjev
+- Jenner La Fave
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -128,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.26'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.26'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -258,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby bindings for brotli library.