ruby-brs 1.0.1 → 1.1.4

data/ext/extconf.rb

@@ -3,46 +3,52 @@
 
 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 "brotli/encode.h"
-require_header "brotli/decode.h"
+require_header "brotli/types.h", %w[BROTLI_BOOL]
+require_header "brotli/encode.h", ["BrotliEncoderState *", "BrotliEncoderMode"]
+require_header "brotli/decode.h", ["BrotliDecoderState *", "BrotliDecoderResult", "BrotliDecoderErrorCode"]
 
 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
 
-encoder_functions = %w[
-  BrotliEncoderCreateInstance
-  BrotliEncoderSetParameter
-  BrotliEncoderCompressStream
-  BrotliEncoderHasMoreOutput
-  BrotliEncoderIsFinished
-  BrotliEncoderDestroyInstance
-]
-.freeze
+require_library(
+  "brotlienc",
+  %w[
+    BrotliEncoderCreateInstance
+    BrotliEncoderSetParameter
+    BrotliEncoderCompressStream
+    BrotliEncoderHasMoreOutput
+    BrotliEncoderIsFinished
+    BrotliEncoderDestroyInstance
+  ]
+)
 
-require_library "brotlienc", encoder_functions
-
-decoder_functions = %w[
-  BrotliDecoderCreateInstance
-  BrotliDecoderSetParameter
-  BrotliDecoderDecompressStream
-  BrotliDecoderGetErrorCode
-  BrotliDecoderDestroyInstance
-]
-.freeze
-
-require_library "brotlidec", decoder_functions
+require_library(
+  "brotlidec",
+  %w[
+    BrotliDecoderCreateInstance
+    BrotliDecoderSetParameter
+    BrotliDecoderDecompressStream
+    BrotliDecoderGetErrorCode
+    BrotliDecoderDestroyInstance
+  ]
+)
 
 extension_name = "brs_ext".freeze
 dir_config extension_name
 
-sources = %w[
+# rubocop:disable Style/GlobalVars
+$srcs = %w[
   stream/compressor
   stream/decompressor
   buffer
@@ -52,14 +58,23 @@ sources = %w[
   option
   string
 ]
+.map { |name| "src/#{extension_name}/#{name}.c" }
 .freeze
 
-# rubocop:disable Style/GlobalVars
-$srcs = sources
-  .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"
+end
 
 $CFLAGS << " -Wno-declaration-after-statement"
+
 $VPATH << "$(srcdir)/#{extension_name}:$(srcdir)/#{extension_name}/stream"
 # rubocop:enable Style/GlobalVars
 

data/lib/brs.rb

@@ -5,3 +5,4 @@ require_relative "brs/stream/reader"
 require_relative "brs/stream/writer"
 require_relative "brs/file"
 require_relative "brs/string"
+require_relative "brs/version"

data/lib/brs/file.rb

@@ -17,9 +17,13 @@ module BRS
 
       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
     end
 
     def self.decompress(source, destination, options = {})
@@ -31,6 +35,8 @@ module BRS
       open_files(source, destination) do |source_io, destination_io|
         BRS._native_decompress_io source_io, destination_io, options
       end
+
+      nil
     end
 
     private_class_method def self.open_files(source, destination, &_block)

data/lib/brs/option.rb

@@ -1,6 +1,8 @@
 # Ruby bindings for brotli library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "brs_ext"
+
 require_relative "error"
 require_relative "validation"
 
@@ -14,7 +16,6 @@ module BRS
       :lgwin                            => nil,
       :lgblock                          => nil,
       :disable_literal_context_modeling => nil,
-      :size_hint                        => nil,
       :large_window                     => nil
     }
     .freeze
@@ -40,20 +41,26 @@ module BRS
       end
 
       quality = options[:quality]
-      Validation.validate_not_negative_integer quality unless quality.nil?
+      unless quality.nil?
+        Validation.validate_not_negative_integer quality
+        raise ValidateError, "invalid quality" if quality < MIN_QUALITY || quality > MAX_QUALITY
+      end
 
       lgwin = options[:lgwin]
-      Validation.validate_not_negative_integer lgwin unless lgwin.nil?
+      unless lgwin.nil?
+        Validation.validate_not_negative_integer lgwin
+        raise ValidateError, "invalid lgwin" if lgwin < MIN_LGWIN || lgwin > MAX_LGWIN
+      end
 
       lgblock = options[:lgblock]
-      Validation.validate_not_negative_integer lgblock unless lgblock.nil?
+      unless lgblock.nil?
+        Validation.validate_not_negative_integer lgblock
+        raise ValidateError, "invalid lgblock" if lgblock < MIN_LGBLOCK || lgblock > MAX_LGBLOCK
+      end
 
       disable_literal_context_modeling = options[:disable_literal_context_modeling]
       Validation.validate_bool disable_literal_context_modeling unless disable_literal_context_modeling.nil?
 
-      size_hint = options[:size_hint]
-      Validation.validate_not_negative_integer size_hint unless size_hint.nil?
-
       large_window = options[:large_window]
       Validation.validate_bool large_window unless large_window.nil?
 

data/lib/brs/stream/abstract.rb

@@ -17,23 +17,19 @@ module BRS
 
       include Delegates
 
-      attr_reader :io
-      attr_reader :stat
-      attr_reader :external_encoding
-      attr_reader :internal_encoding
-      attr_reader :transcode_options
-      attr_reader :pos
+      attr_reader :io, :stat, :external_encoding, :internal_encoding, :transcode_options, :pos
+
       alias tell pos
 
-      def initialize(io, external_encoding: nil, internal_encoding: nil, transcode_options: {})
+      def initialize(io, options = {})
         @raw_stream = create_raw_stream
 
         Validation.validate_io io
         @io = io
 
-        @stat = Stat.new @io.stat
+        @stat = Stat.new @io.stat if @io.respond_to? :stat
 
-        set_encoding external_encoding, internal_encoding, transcode_options
+        set_encoding options[:external_encoding], options[:internal_encoding], options[:transcode_options]
         reset_buffer
         reset_io_advise
 
@@ -50,8 +46,8 @@ module BRS
 
       protected def reset_io_advise
         # Both compressor and decompressor need sequential io access.
-        @io.advise :sequential
-      rescue ::Errno::ESPIPE # rubocop:disable Lint/HandleExceptions
+        @io.advise :sequential if @io.respond_to? :advise
+      rescue ::Errno::ESPIPE
         # ok
       end
 
@@ -126,7 +122,8 @@ module BRS
       def rewind
         @raw_stream = create_raw_stream
 
-        @io.rewind
+        @io.rewind if @io.respond_to? :rewind
+
         reset_buffer
         reset_io_advise
 

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

@@ -19,11 +19,13 @@ module BRS
 
         def flush(&writer)
           write_result(&writer)
+
+          nil
         end
 
-        protected def flush_destination_buffer(&writer)
+        protected def more_destination(&writer)
           result_bytesize = write_result(&writer)
-          raise NotEnoughDestinationError, "not enough destination" if result_bytesize == 0
+          raise NotEnoughDestinationError, "not enough destination" if result_bytesize.zero?
         end
 
         protected def write_result(&_writer)
@@ -44,6 +46,8 @@ module BRS
 
           @native_stream.close
           @is_closed = true
+
+          nil
         end
 
         def closed?

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

@@ -15,7 +15,11 @@ module BRS
         BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
 
         def initialize(options = {})
-          options       = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
+          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
@@ -35,13 +39,15 @@ module BRS
 
             if need_more_destination
               source = source.byteslice bytes_written, source.bytesize - bytes_written
-              flush_destination_buffer(&writer)
+              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
@@ -59,7 +65,7 @@ module BRS
             need_more_destination = @native_stream.flush
 
             if need_more_destination
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -67,8 +73,6 @@ module BRS
           end
 
           super
-
-          nil
         end
 
         def close(&writer)
@@ -80,7 +84,7 @@ module BRS
             need_more_destination = @native_stream.finish
 
             if need_more_destination
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -88,8 +92,6 @@ module BRS
           end
 
           super
-
-          nil
         end
       end
     end

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

@@ -34,7 +34,7 @@ module BRS
 
             if need_more_destination
               source = source.byteslice bytes_read, source.bytesize - bytes_read
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -51,8 +51,6 @@ module BRS
           Validation.validate_proc writer
 
           super
-
-          nil
         end
 
         def close(&writer)
@@ -61,8 +59,6 @@ module BRS
           Validation.validate_proc writer
 
           super
-
-          nil
         end
       end
     end

data/lib/brs/stream/reader.rb

@@ -20,79 +20,60 @@ module BRS
 
         initialize_source_buffer_length
         reset_io_remainder
+        reset_need_to_flush
 
         @lineno = 0
       end
 
+      protected def create_raw_stream
+        Raw::Decompressor.new @options
+      end
+
       protected def initialize_source_buffer_length
         source_buffer_length = @options[:source_buffer_length]
         Validation.validate_not_negative_integer source_buffer_length unless source_buffer_length.nil?
 
         source_buffer_length = Buffer::DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR \
-          if source_buffer_length == 0 || source_buffer_length.nil?
+          if source_buffer_length.nil? || source_buffer_length.zero?
 
         @source_buffer_length = source_buffer_length
       end
 
-      protected def create_raw_stream
-        Raw::Decompressor.new @options
-      end
-
       protected def reset_io_remainder
         @io_remainder = ::String.new :encoding => ::Encoding::BINARY
       end
 
+      protected def reset_need_to_flush
+        @need_to_flush = false
+      end
+
       # -- synchronous --
 
       def read(bytes_to_read = nil, out_buffer = nil)
         Validation.validate_not_negative_integer bytes_to_read unless bytes_to_read.nil?
         Validation.validate_string out_buffer unless out_buffer.nil?
 
-        return ::String.new :encoding => ::Encoding::BINARY if bytes_to_read == 0
-
         unless bytes_to_read.nil?
+          return ::String.new :encoding => ::Encoding::BINARY if bytes_to_read.zero?
           return nil if eof?
 
-          read_more_from_buffer until @buffer.bytesize >= bytes_to_read || @io.eof?
+          append_io_data @io.read(@source_buffer_length) while @buffer.bytesize < bytes_to_read && !@io.eof?
+          flush_io_data if @buffer.bytesize < bytes_to_read
 
           return read_bytes_from_buffer bytes_to_read, out_buffer
         end
 
-        read_more_from_buffer until @io.eof?
-
-        result = @buffer
-        reset_buffer
-        @pos += result.bytesize
+        append_io_data @io.read(@source_buffer_length) until @io.eof?
+        flush_io_data
 
-        result.force_encoding @external_encoding unless @external_encoding.nil?
-        result = transcode_to_internal result
-        result = out_buffer.replace result unless out_buffer.nil?
-
-        result
-      end
-
-      protected def read_more_from_buffer
-        io_data = @io.read @source_buffer_length
-        append_io_data_to_buffer io_data
-      end
-
-      def readpartial(bytes_to_read = nil, out_buffer = nil)
-        raise ::EOFError if eof?
-
-        readpartial_from_buffer until @buffer.bytesize >= bytes_to_read || @io.eof?
-
-        read_bytes_from_buffer bytes_to_read, out_buffer
-      end
-
-      protected def readpartial_from_buffer
-        io_data = @io.readpartial @source_buffer_length
-        append_io_data_to_buffer io_data
+        read_buffer out_buffer
       end
 
       def rewind
         raw_wrapper :close
 
         reset_io_remainder
+        reset_need_to_flush
 
         super
       end
@@ -103,25 +84,61 @@ module BRS
         super
       end
 
+      def eof?
+        empty? && @io.eof?
+      end
+
       # -- asynchronous --
 
+      def readpartial(bytes_to_read, out_buffer = nil)
+        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 ::EOFError if eof?
+        read_more_nonblock(bytes_to_read, out_buffer) { @io.read_nonblock(@source_buffer_length, *options) }
+      end
+
+      protected def read_more_nonblock(bytes_to_read, out_buffer, &_block)
+        Validation.validate_not_negative_integer bytes_to_read
+        Validation.validate_string out_buffer unless out_buffer.nil?
+
+        return ::String.new :encoding => ::Encoding::BINARY if bytes_to_read.zero?
+
+        io_provided_eof_error = false
 
-        read_more_from_buffer_nonblock(*options) until @buffer.bytesize >= bytes_to_read || @io.eof?
+        if @buffer.bytesize < bytes_to_read
+          begin
+            append_io_data yield
+          rescue ::EOFError
+            io_provided_eof_error = true
+          end
+        end
+
+        flush_io_data if @buffer.bytesize < bytes_to_read
+        raise ::EOFError if empty? && io_provided_eof_error
 
         read_bytes_from_buffer bytes_to_read, out_buffer
       end
 
-      protected def read_more_from_buffer_nonblock(*options)
-        io_data = @io.read_nonblock @source_buffer_length, *options
-        append_io_data_to_buffer io_data
+      # -- common --
+
+      protected def append_io_data(io_data)
+        io_portion    = @io_remainder + io_data
+        bytes_read    = raw_wrapper :read, io_portion
+        @io_remainder = io_portion.byteslice bytes_read, io_portion.bytesize - bytes_read
+
+        # Even empty io data may require flush.
+        @need_to_flush = true
       end
 
-      # -- common --
+      protected def flush_io_data
+        raw_wrapper :flush
 
-      def eof?
-        @io.eof? && @buffer.bytesize == 0
+        @need_to_flush = false
+      end
+
+      protected def empty?
+        !@need_to_flush && @buffer.bytesize.zero?
       end
 
       protected def read_bytes_from_buffer(bytes_to_read, out_buffer)
@@ -136,18 +153,20 @@ module BRS
         result
       end
 
-      protected def append_io_data_to_buffer(io_data)
-        io_portion    = @io_remainder + io_data
-        bytes_read    = raw_wrapper :read, io_portion
-        @io_remainder = io_portion.byteslice bytes_read, io_portion.bytesize - bytes_read
+      protected def read_buffer(out_buffer)
+        result = @buffer
+        reset_buffer
+        @pos += result.bytesize
 
-        # We should just ignore case when "io.eof?" appears but "io_remainder" is not empty.
-        # Ancient compress implementations can write bytes from not initialized buffer parts to output.
-        raw_wrapper :flush if @io.eof?
+        result.force_encoding @external_encoding unless @external_encoding.nil?
+        result = transcode_to_internal result
+
+        result = out_buffer.replace result unless out_buffer.nil?
+        result
       end
 
       protected def transcode_to_internal(data)
-        data = data.encode @internal_encoding, @transcode_options unless @internal_encoding.nil?
+        data = data.encode @internal_encoding, **@transcode_options unless @internal_encoding.nil?
         data
       end