ruby-lzws 1.0.0 → 1.1.4

data/lib/lzws/option.rb

@@ -1,6 +1,8 @@
 # Ruby bindings for lzws library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "lzws_ext"
+
 require_relative "error"
 require_relative "validation"
 
@@ -8,11 +10,11 @@ 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 = {
-      :buffer_length        => 0,
       :without_magic_header => false,
       :msb                  => false,
       :unaligned_bit_groups => false,
@@ -26,19 +28,19 @@ module LZWS
     )
     .freeze
 
-    def self.get_compressor_options(options)
+    def self.get_compressor_options(options, buffer_length_names)
       Validation.validate_hash options
 
-      options = COMPRESSOR_DEFAULTS.merge 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
 
-      Validation.validate_not_negative_integer options[:buffer_length]
+      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
 
       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
+        max_code_bit_length < LOWEST_MAX_CODE_BIT_LENGTH || max_code_bit_length > BIGGEST_MAX_CODE_BIT_LENGTH
 
       Validation.validate_bool options[:without_magic_header]
       Validation.validate_bool options[:block_mode]
@@ -49,12 +51,14 @@ module LZWS
       options
     end
 
-    def self.get_decompressor_options(options)
+    def self.get_decompressor_options(options, buffer_length_names)
       Validation.validate_hash options
 
-      options = DECOMPRESSOR_DEFAULTS.merge 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
+
+      buffer_length_names.each { |name| Validation.validate_not_negative_integer options[name] }
 
-      Validation.validate_not_negative_integer options[:buffer_length]
       Validation.validate_bool options[:without_magic_header]
       Validation.validate_bool options[:msb]
       Validation.validate_bool options[:unaligned_bit_groups]

data/lib/lzws/stream/abstract.rb

@@ -9,7 +9,7 @@ require_relative "../validation"
 module LZWS
   module Stream
     class Abstract
-      # LZWS native stream is not seekable by design.
+      # Native stream is not seekable by design.
       # Related methods like "seek" and "pos=" can't be implemented.
 
       # It is not possible to maintain correspondance between bytes consumed from source and bytes written to destination by design.
@@ -21,18 +21,20 @@ module LZWS
       attr_reader :stat
       attr_reader :external_encoding
       attr_reader :internal_encoding
+      attr_reader :transcode_options
       attr_reader :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
 
@@ -49,8 +51,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/HandleExceptions
+        @io.advise :sequential if @io.respond_to? :advise
+      rescue ::Errno::ESPIPE
         # ok
       end
 
@@ -115,7 +117,6 @@ module LZWS
 
       protected def target_encoding
         return @internal_encoding unless @internal_encoding.nil?
-
         return @external_encoding unless @external_encoding.nil?
 
         ::Encoding::BINARY
@@ -126,7 +127,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

@@ -4,6 +4,7 @@
 require "lzws_ext"
 
 require_relative "../../error"
+require_relative "../../validation"
 
 module LZWS
   module Stream
@@ -14,19 +15,16 @@ module LZWS
           @is_closed     = false
         end
 
-        def close(&writer)
-          return nil if @is_closed
+        # -- write --
 
-          flush(&writer)
+        def flush(&writer)
+          do_not_use_after_close
 
-          @native_stream.close
-          @is_closed = true
+          Validation.validate_proc writer
 
-          nil
-        end
+          write_result(&writer)
 
-        def closed?
-          @is_closed
+          nil
         end
 
         protected def flush_destination_buffer(&writer)
@@ -40,6 +38,23 @@ module LZWS
 
           result.bytesize
         end
+
+        # -- close --
+
+        protected def do_not_use_after_close
+          raise UsedAfterCloseError, "used after close" if closed?
+        end
+
+        def close(&writer)
+          write_result(&writer)
+
+          @native_stream.close
+          @is_closed = true
+        end
+
+        def closed?
+          @is_closed
+        end
       end
     end
   end

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

@@ -12,13 +12,13 @@ module LZWS
   module Stream
     module Raw
       class Compressor < Abstract
+        BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
+
         def initialize(options = {})
-          options       = Option.get_compressor_options options
+          options       = Option.get_compressor_options options, BUFFER_LENGTH_NAMES
           native_stream = NativeCompressor.new options
 
           super native_stream
-
-          @need_to_write_magic_header = !options[:without_magic_header]
         end
 
         def write(source, &writer)
@@ -27,11 +27,6 @@ module LZWS
           Validation.validate_string source
           Validation.validate_proc writer
 
-          if @need_to_write_magic_header
-            write_magic_header(&writer)
-            @need_to_write_magic_header = false
-          end
-
           total_bytes_written = 0
 
           loop do
@@ -45,8 +40,10 @@ module LZWS
             end
 
             unless bytes_written == source.bytesize
+              # :nocov:
               # Compressor write should eat all provided "source" without remainder.
               raise UnexpectedError, "unexpected error"
+              # :nocov:
             end
 
             break
@@ -55,28 +52,13 @@ module LZWS
           total_bytes_written
         end
 
-        protected def write_magic_header(&writer)
-          loop do
-            need_more_destination = @native_stream.write_magic_header
-
-            if need_more_destination
-              flush_destination_buffer(&writer)
-              next
-            end
-
-            break
-          end
-
-          nil
-        end
-
-        def flush(&writer)
-          do_not_use_after_close
+        def close(&writer)
+          return nil if closed?
 
           Validation.validate_proc writer
 
           loop do
-            need_more_destination = @native_stream.flush
+            need_more_destination = @native_stream.finish
 
             if need_more_destination
               flush_destination_buffer(&writer)
@@ -86,14 +68,10 @@ module LZWS
             break
           end
 
-          write_result(&writer)
+          super
 
           nil
         end
-
-        protected def do_not_use_after_close
-          raise UsedAfterCloseError, "compressor used after close" if @is_closed
-        end
       end
     end
   end

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

@@ -4,7 +4,6 @@
 require "lzws_ext"
 
 require_relative "abstract"
-require_relative "../../error"
 require_relative "../../option"
 require_relative "../../validation"
 
@@ -12,13 +11,13 @@ module LZWS
   module Stream
     module Raw
       class Decompressor < Abstract
+        BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
+
         def initialize(options = {})
-          options       = Option.get_decompressor_options options
+          options       = Option.get_decompressor_options options, BUFFER_LENGTH_NAMES
           native_stream = NativeDecompressor.new options
 
           super native_stream
-
-          @need_to_read_magic_header = !options[:without_magic_header]
         end
 
         def read(source, &writer)
@@ -29,19 +28,6 @@ module LZWS
 
           total_bytes_read = 0
 
-          if @need_to_read_magic_header
-            bytes_read = @native_stream.read_magic_header source
-            if bytes_read == 0
-              # Decompressor is not able to read full magic header.
-              return 0
-            end
-
-            total_bytes_read += bytes_read
-            source            = source.byteslice bytes_read, source.bytesize - bytes_read
-
-            @need_to_read_magic_header = false
-          end
-
           loop do
             bytes_read, need_more_destination  = @native_stream.read source
             total_bytes_read                  += bytes_read
@@ -59,19 +45,15 @@ module LZWS
           total_bytes_read
         end
 
-        def flush(&writer)
-          do_not_use_after_close
+        def close(&writer)
+          return nil if closed?
 
           Validation.validate_proc writer
 
-          write_result(&writer)
+          super
 
           nil
         end
-
-        protected def do_not_use_after_close
-          raise UsedAfterCloseError, "decompressor used after close" if @is_closed
-        end
       end
     end
   end

data/lib/lzws/stream/reader.rb

@@ -11,8 +11,6 @@ module LZWS
     class Reader < Abstract
       include ReaderHelpers
 
-      DEFAULT_IO_PORTION_BYTESIZE = 1 << 15 # 32 KB
-
       attr_accessor :lineno
 
       def initialize(source_io, options = {}, *args)
@@ -20,17 +18,22 @@ module LZWS
 
         super source_io, *args
 
-        io_portion_bytesize = @options[:io_portion_bytesize]
-        @options.delete :io_portion_bytesize
-
-        Validation.validate_positive_integer io_portion_bytesize unless io_portion_bytesize.nil?
-        @io_portion_bytesize = io_portion_bytesize || DEFAULT_IO_PORTION_BYTESIZE
-
+        initialize_source_buffer_length
         reset_io_remainder
 
         @lineno = 0
       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?
+
+        @source_buffer_length = source_buffer_length
+      end
+
       protected def create_raw_stream
         Raw::Decompressor.new @options
       end
@@ -50,12 +53,12 @@ module LZWS
         unless bytes_to_read.nil?
           return nil if eof?
 
-          read_more_from_buffer until @buffer.bytesize >= bytes_to_read || @io.eof?
+          read_more_to_buffer until @buffer.bytesize >= bytes_to_read || @io.eof?
 
           return read_bytes_from_buffer bytes_to_read, out_buffer
         end
 
-        read_more_from_buffer until @io.eof?
+        read_more_to_buffer until @io.eof?
 
         result = @buffer
         reset_buffer
@@ -68,21 +71,21 @@ module LZWS
         result
       end
 
-      protected def read_more_from_buffer
-        io_data = @io.read @io_portion_bytesize
+      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_from_buffer until @buffer.bytesize >= bytes_to_read || @io.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_from_buffer
-        io_data = @io.readpartial @io_portion_bytesize
+      protected def readpartial_to_buffer
+        io_data = @io.readpartial @source_buffer_length
         append_io_data_to_buffer io_data
       end
 
@@ -105,13 +108,13 @@ module LZWS
       def read_nonblock(bytes_to_read, out_buffer = nil, *options)
         raise ::EOFError if eof?
 
-        read_more_from_buffer_nonblock(*options) until @buffer.bytesize >= bytes_to_read || @io.eof?
+        read_more_to_buffer_nonblock(*options) until @buffer.bytesize >= bytes_to_read || @io.eof?
 
         read_bytes_from_buffer bytes_to_read, out_buffer
       end
 
-      protected def read_more_from_buffer_nonblock(*options)
-        io_data = @io.read_nonblock @io_portion_bytesize, *options
+      protected def read_more_to_buffer_nonblock(*options)
+        io_data = @io.read_nonblock @source_buffer_length, *options
         append_io_data_to_buffer io_data
       end
 
@@ -144,7 +147,7 @@ module LZWS
       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/reader_helpers.rb

@@ -1,6 +1,8 @@
 # Ruby bindings for lzws library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "English"
+
 require_relative "../validation"
 
 module LZWS
@@ -156,7 +158,7 @@ module LZWS
       protected def ungetstring(string)
         Validation.validate_string string
 
-        string = ::String.new string, :encoding => @internal_encoding
+        string = ::String.new string, :encoding => @internal_encoding unless @internal_encoding.nil?
         string = transcode_to_external string unless @external_encoding.nil?
 
         string.force_encoding ::Encoding::BINARY
@@ -172,8 +174,8 @@ module LZWS
           Validation.validate_string file_path
           Validation.validate_proc block
 
-          ::File.open file_path, "rb" do |file|
-            reader = new file, *args
+          ::File.open file_path, "rb" do |io|
+            reader = new io, *args
 
             begin
               yield reader