ruby-brs 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f79255ffdaf743bde0edc13c314d1cf7f12402a9993389d6a86dea3d449b4e21
-  data.tar.gz: 8ca40ddca9e58f2876c33bd17bc353bdb739cf79d344ff5bf3c217c52a9cd2ac
+  metadata.gz: 7e466dd321946a82c2f6cf3c392c1c0dac066940d93cda2dc149409ef57b7491
+  data.tar.gz: d775c3fe8399adb3a8f514cf79c3fa1aa1eca505fa2e231595511e2606eb2a86
 SHA512:
-  metadata.gz: 801a6df0e461a1df124647362c10a6af08d0e5621ef5682987d6d0615b548e3fa51d5c184afd804be33cf4da74ce0ef810f8209851f5b5efe31037ac6912f205
-  data.tar.gz: ef62bbc6958e7de16d59eb0a56f84cc9c7ae7f88738219d642562455d7d7815df29cd94fa32da7f23dbf7065310c46e0081e3d0ce0443af8aa5d0257d1a765ba
+  metadata.gz: 6dd95aa6451b85d38f41c157a92907fdd14c2e3e54183ce49a498cde78bdefe94058c7646c2cc68035bccbd0fd9807d623da7f87a307c72b96603fe050c3817a
+  data.tar.gz: bc5ef430e925afb01859726b4103f6835813222cad3918431cb65c1df3e9ea7f1fb12390de0fa509121b90210cddc68f3599a89e34ce1a9372cabc0b13da57f0

data/README.md

@@ -36,6 +36,27 @@ BRS::File.decompress "file.txt.br", "file.txt"
 
 BRS::Stream::Writer.open("file.txt.br") { |writer| writer << "sample string" }
 puts BRS::Stream::Reader.open("file.txt.br") { |reader| reader.read }
+
+writer = BRS::Stream::Writer.new output_socket
+begin
+  bytes_written = writer.write_nonblock "sample string"
+  # handle "bytes_written"
+rescue IO::WaitWritable
+  # handle wait
+ensure
+  writer.close
+end
+
+reader = BRS::Stream::Reader.new input_socket
+begin
+  puts reader.read_nonblock(512)
+rescue IO::WaitReadable
+  # handle wait
+rescue ::EOFError
+  # handle eof
+ensure
+  reader.close
+end
 ```
 
 You can create and read `tar.br` archives with `minitar` for example.

data/lib/brs/file.rb

@@ -22,6 +22,8 @@ module BRS
       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 = {})
@@ -33,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/stream/abstract.rb

@@ -17,12 +17,7 @@ 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
 

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

@@ -39,7 +39,7 @@ module BRS
 
             if need_more_destination
               source = source.byteslice bytes_written, source.bytesize - bytes_written
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -65,7 +65,7 @@ module BRS
             need_more_destination = @native_stream.flush
 
             if need_more_destination
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -73,8 +73,6 @@ module BRS
           end
 
           super
-
-          nil
         end
 
         def close(&writer)
@@ -86,7 +84,7 @@ module BRS
             need_more_destination = @native_stream.finish
 
             if need_more_destination
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -94,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_to_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_to_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_to_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_to_buffer until @buffer.bytesize >= bytes_to_read || @io.eof?
-
-        read_bytes_from_buffer bytes_to_read, out_buffer
-      end
-
-      protected def readpartial_to_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_to_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_to_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,14 +153,16 @@ 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/lib/brs/stream/writer.rb

@@ -64,7 +64,7 @@ module BRS
       end
 
       protected def write_remaining_buffer
-        return nil if @buffer.bytesize == 0
+        return nil if @buffer.bytesize.zero?
 
         @io.write @buffer
 
@@ -77,6 +77,11 @@ module BRS
 
       # -- asynchronous --
 
+      # IO write nonblock can raise wait writable error.
+      # After resolving this error user may provide same content again.
+      # It is not possible to revert accepted content after error.
+      # 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)
         return 0 unless write_remaining_buffer_nonblock(*options)
 
@@ -120,14 +125,14 @@ module BRS
       end
 
       protected def write_remaining_buffer_nonblock(*options)
-        return true if @buffer.bytesize == 0
+        return true if @buffer.bytesize.zero?
 
         bytes_written = @io.write_nonblock @buffer, *options
-        return false if bytes_written == 0
+        return false if bytes_written.zero?
 
         @buffer = @buffer.byteslice bytes_written, @buffer.bytesize - bytes_written
 
-        @buffer.bytesize == 0
+        @buffer.bytesize.zero?
       end
 
       protected def raw_nonblock_wrapper(method_name, *args)

data/lib/brs/stream/writer_helpers.rb

@@ -31,9 +31,10 @@ module BRS
       end
 
       def putc(object, encoding: ::Encoding::BINARY)
-        if object.is_a? ::Numeric
+        case object
+        when ::Numeric
           write object.chr(encoding)
-        elsif object.is_a? ::String
+        when ::String
           write object[0]
         else
           raise ValidateError, "invalid object: \"#{object}\" for putc"

data/lib/brs/validation.rb

@@ -23,7 +23,7 @@ module BRS
     end
 
     def self.validate_positive_integer(value)
-      raise ValidateError, "invalid positive integer" unless value.is_a?(::Integer) && value > 0
+      raise ValidateError, "invalid positive integer" unless value.is_a?(::Integer) && value.positive?
     end
 
     def self.validate_not_negative_integer(value)

data/lib/brs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brs
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Andrew Aladjev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -122,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement