ruby-lzws 1.1.3 → 1.2.0

data/lib/lzws/file.rb

@@ -20,6 +20,8 @@ module LZWS
       open_files(source, destination) do |source_io, destination_io|
         LZWS._native_compress_io source_io, destination_io, options
       end
+
+      nil
     end
 
     def self.decompress(source, destination, options = {})
@@ -31,6 +33,8 @@ module LZWS
       open_files(source, destination) do |source_io, destination_io|
         LZWS._native_decompress_io source_io, destination_io, options
       end
+
+      nil
     end
 
     private_class_method def self.open_files(source, destination, &_block)

data/lib/lzws/option.rb

@@ -8,45 +8,37 @@ require_relative "validation"
 
 module LZWS
   module Option
-    # Default options will be compatible with UNIX compress.
-
-    DEFAULT_BUFFER_LENGTH       = 0
-    LOWEST_MAX_CODE_BIT_LENGTH  = 9
-    BIGGEST_MAX_CODE_BIT_LENGTH = 16
-
-    DECOMPRESSOR_DEFAULTS = {
-      :without_magic_header => false,
-      :msb                  => false,
-      :unaligned_bit_groups => false,
-      :quiet                => false
-    }
-    .freeze
-
-    COMPRESSOR_DEFAULTS = DECOMPRESSOR_DEFAULTS.merge(
-      :max_code_bit_length => BIGGEST_MAX_CODE_BIT_LENGTH,
-      :block_mode          => true
-    )
-    .freeze
+    DEFAULT_BUFFER_LENGTH = 0
 
     def self.get_compressor_options(options, buffer_length_names)
       Validation.validate_hash options
 
       buffer_length_defaults = buffer_length_names.each_with_object({}) { |name, defaults| defaults[name] = DEFAULT_BUFFER_LENGTH }
-      options                = COMPRESSOR_DEFAULTS.merge(buffer_length_defaults).merge options
+      options                = buffer_length_defaults.merge options
 
       buffer_length_names.each { |name| Validation.validate_not_negative_integer options[name] }
 
       max_code_bit_length = options[:max_code_bit_length]
-      Validation.validate_positive_integer max_code_bit_length
+      unless max_code_bit_length.nil?
+        Validation.validate_positive_integer max_code_bit_length
+        raise ValidateError, "invalid max code bit length" if
+          max_code_bit_length < LOWEST_MAX_CODE_BIT_LENGTH || max_code_bit_length > BIGGEST_MAX_CODE_BIT_LENGTH
+      end
 
-      raise ValidateError, "invalid max code bit length" if
-        max_code_bit_length < LOWEST_MAX_CODE_BIT_LENGTH || max_code_bit_length > BIGGEST_MAX_CODE_BIT_LENGTH
+      without_magic_header = options[:without_magic_header]
+      Validation.validate_bool without_magic_header unless without_magic_header.nil?
 
-      Validation.validate_bool options[:without_magic_header]
-      Validation.validate_bool options[:block_mode]
-      Validation.validate_bool options[:msb]
-      Validation.validate_bool options[:unaligned_bit_groups]
-      Validation.validate_bool options[:quiet]
+      block_mode = options[:block_mode]
+      Validation.validate_bool block_mode unless block_mode.nil?
+
+      msb = options[:msb]
+      Validation.validate_bool msb unless msb.nil?
+
+      unaligned_bit_groups = options[:unaligned_bit_groups]
+      Validation.validate_bool unaligned_bit_groups unless unaligned_bit_groups.nil?
+
+      quiet = options[:quiet]
+      Validation.validate_bool quiet unless quiet.nil?
 
       options
     end
@@ -55,14 +47,21 @@ module LZWS
       Validation.validate_hash options
 
       buffer_length_defaults = buffer_length_names.each_with_object({}) { |name, defaults| defaults[name] = DEFAULT_BUFFER_LENGTH }
-      options                = DECOMPRESSOR_DEFAULTS.merge(buffer_length_defaults).merge options
+      options                = buffer_length_defaults.merge options
 
       buffer_length_names.each { |name| Validation.validate_not_negative_integer options[name] }
 
-      Validation.validate_bool options[:without_magic_header]
-      Validation.validate_bool options[:msb]
-      Validation.validate_bool options[:unaligned_bit_groups]
-      Validation.validate_bool options[:quiet]
+      without_magic_header = options[:without_magic_header]
+      Validation.validate_bool without_magic_header unless without_magic_header.nil?
+
+      msb = options[:msb]
+      Validation.validate_bool msb unless msb.nil?
+
+      unaligned_bit_groups = options[:unaligned_bit_groups]
+      Validation.validate_bool unaligned_bit_groups unless unaligned_bit_groups.nil?
+
+      quiet = options[:quiet]
+      Validation.validate_bool quiet unless quiet.nil?
 
       options
     end

data/lib/lzws/stream/abstract.rb

@@ -17,23 +17,19 @@ module LZWS
 
       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 LZWS
 
       protected def reset_io_advise
         # Both compressor and decompressor need sequential io access.
-        @io.advise :sequential
-      rescue ::Errno::ESPIPE # rubocop:disable Lint/SuppressedException
+        @io.advise :sequential if @io.respond_to? :advise
+      rescue ::Errno::ESPIPE
         # ok
       end
 
@@ -126,7 +122,8 @@ module LZWS
       def rewind
         @raw_stream = create_raw_stream
 
-        @io.rewind
+        @io.rewind if @io.respond_to? :rewind
+
         reset_buffer
         reset_io_advise
 

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

@@ -27,9 +27,9 @@ module LZWS
           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)
@@ -50,6 +50,8 @@ module LZWS
 
           @native_stream.close
           @is_closed = true
+
+          nil
         end
 
         def closed?

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

@@ -35,7 +35,7 @@ module LZWS
 
             if need_more_destination
               source = source.byteslice bytes_written, source.bytesize - bytes_written
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -61,7 +61,7 @@ module LZWS
             need_more_destination = @native_stream.finish
 
             if need_more_destination
-              flush_destination_buffer(&writer)
+              more_destination(&writer)
               next
             end
 
@@ -69,8 +69,6 @@ module LZWS
           end
 
           super
-
-          nil
         end
       end
     end

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

@@ -34,7 +34,7 @@ module LZWS
 
             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 LZWS
           Validation.validate_proc writer
 
           super
-
-          nil
         end
       end
     end

data/lib/lzws/stream/reader.rb

@@ -20,79 +20,60 @@ module LZWS
 
         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 LZWS
         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,18 +153,20 @@ module LZWS
         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
 

data/lib/lzws/stream/writer.rb

@@ -64,7 +64,7 @@ module LZWS
       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 LZWS
 
       # -- 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 LZWS
       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)
@@ -137,7 +142,7 @@ module LZWS
       # -- common --
 
       protected def transcode(data)
-        data = data.encode @external_encoding, @transcode_options unless @external_encoding.nil?
+        data = data.encode @external_encoding, **@transcode_options unless @external_encoding.nil?
         data
       end
     end