ruby-zstds 1.3.0 → 1.3.1

data/lib/zstds/stream/reader.rb

@@ -1,195 +1,16 @@
 # Ruby bindings for zstd library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
-require_relative "abstract"
+require "adsp/stream/reader"
+
 require_relative "raw/decompressor"
-require_relative "reader_helpers"
-require_relative "../validation"
 
 module ZSTDS
   module Stream
-    class Reader < Abstract
-      include ReaderHelpers
-
-      attr_accessor :lineno
-
-      def initialize(source_io, options = {}, *args)
-        @options = options
-
-        super source_io, *args
-
-        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?
-
-        if source_buffer_length.nil? || source_buffer_length.zero?
-          source_buffer_length = Buffer::DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR
-        end
-
-        @source_buffer_length = source_buffer_length
-      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?
-
-        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?
-
-          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
-
-        append_io_data @io.read(@source_buffer_length) until @io.eof?
-        flush_io_data
-
-        read_buffer out_buffer
-      end
-
-      def rewind
-        raw_wrapper :close
-
-        reset_io_remainder
-        reset_need_to_flush
-
-        super
-      end
-
-      def close
-        raw_wrapper :close
-
-        super
-      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
-
-      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
-
-        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
-
-      # -- 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
-
-      protected def flush_io_data
-        raw_wrapper :flush
-
-        @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)
-        bytes_read = [@buffer.bytesize, bytes_to_read].min
-
-        # Result uses buffer binary encoding.
-        result   = @buffer.byteslice 0, bytes_read
-        @buffer  = @buffer.byteslice bytes_read, @buffer.bytesize - bytes_read
-        @pos    += bytes_read
-
-        result = out_buffer.replace result unless out_buffer.nil?
-        result
-      end
-
-      protected def read_buffer(out_buffer)
-        result = @buffer
-        reset_buffer
-        @pos += result.bytesize
-
-        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
-      end
-
-      # We should be able to return data back to buffer.
-      # We won't use any transcode options because transcoded data should be backward compatible.
-      protected def transcode_to_external(data)
-        data = data.encode @external_encoding unless @external_encoding.nil?
-        data
-      end
-
-      protected def raw_wrapper(method_name, *args)
-        @raw_stream.send(method_name, *args) { |portion| @buffer << portion }
-      end
+    # ZSTDS::Stream::Reader class.
+    class Reader < ADSP::Stream::Reader
+      # Current raw stream class.
+      RawDecompressor = Raw::Decompressor
     end
   end
 end

data/lib/zstds/stream/writer.rb

@@ -1,174 +1,16 @@
 # Ruby bindings for zstd library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
-require_relative "abstract"
+require "adsp/stream/writer"
+
 require_relative "raw/compressor"
-require_relative "writer_helpers"
 
 module ZSTDS
   module Stream
-    class Writer < Abstract
-      include WriterHelpers
-
-      def initialize(destination_io, options = {}, *args)
-        @options = options
-
-        super destination_io, *args
-      end
-
-      protected def create_raw_stream
-        Raw::Compressor.new @options
-      end
-
-      # -- synchronous --
-
-      def write(*objects)
-        validate_write
-
-        write_remaining_buffer
-
-        bytes_written = 0
-
-        objects.each do |object|
-          source         = transcode object.to_s
-          bytes_written += raw_wrapper :write, source
-        end
-
-        @pos += bytes_written
-
-        bytes_written
-      end
-
-      def flush
-        validate_write
-
-        finish :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
-      end
-
-      protected def finish(method_name)
-        write_remaining_buffer
-
-        raw_wrapper method_name
-      end
-
-      protected def write_remaining_buffer
-        return nil if @buffer.bytesize.zero?
-
-        @io.write @buffer
-
-        reset_buffer
-      end
-
-      protected def raw_wrapper(method_name, *args)
-        @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.
-      # 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)
-        validate_write_nonblock
-
-        return 0 unless write_remaining_buffer_nonblock(*options)
-
-        source         = transcode object.to_s
-        bytes_written  = raw_nonblock_wrapper :write, source
-        @pos          += bytes_written
-
-        bytes_written
-      end
-
-      def flush_nonblock(*options)
-        validate_write_nonblock
-
-        return false unless finish_nonblock :flush, *options
-
-        @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
-
-        true
-      end
-
-      def close_nonblock(*options)
-        validate_write_nonblock
-
-        return false unless finish_nonblock :close, *options
-
-        method(:close).super_method.call
-
-        true
-      end
-
-      protected def finish_nonblock(method_name, *options)
-        return false unless write_remaining_buffer_nonblock(*options)
-
-        raw_nonblock_wrapper method_name
-
-        write_remaining_buffer_nonblock(*options)
-      end
-
-      protected def write_remaining_buffer_nonblock(*options)
-        return true if @buffer.bytesize.zero?
-
-        bytes_written = @io.write_nonblock @buffer, *options
-        return false if bytes_written.zero?
-
-        @buffer = @buffer.byteslice bytes_written, @buffer.bytesize - bytes_written
-
-        @buffer.bytesize.zero?
-      end
-
-      protected def raw_nonblock_wrapper(method_name, *args)
-        @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 = data.encode @external_encoding, **@transcode_options unless @external_encoding.nil?
-        data
-      end
+    # ZSTDS::Stream::Writer class.
+    class Writer < ADSP::Stream::Writer
+      # Current raw stream class.
+      RawCompressor = Raw::Compressor
     end
   end
 end

data/lib/zstds/string.rb

@@ -1,15 +1,22 @@
 # Ruby bindings for zstd library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
+require "adsp/string"
 require "zstds_ext"
 
 require_relative "option"
 require_relative "validation"
 
 module ZSTDS
-  module String
-    BUFFER_LENGTH_NAMES = %i[destination_buffer_length].freeze
-
+  # ZSTDS::String class.
+  class String < ADSP::String
+    # Current option class.
+    Option = ZSTDS::Option
+
+    # Compresses +source+ string using +options+.
+    # Option: +:destination_buffer_length+ destination buffer length.
+    # Option: +:pledged_size+ source bytesize.
+    # Returns compressed string.
     def self.compress(source, options = {})
       Validation.validate_string source
 
@@ -17,15 +24,17 @@ module ZSTDS
 
       options[:pledged_size] = source.bytesize
 
-      ZSTDS._native_compress_string source, options
+      super source, options
     end
 
-    def self.decompress(source, options = {})
-      Validation.validate_string source
-
-      options = Option.get_decompressor_options options, BUFFER_LENGTH_NAMES
+    # Bypasses native compress.
+    def self.native_compress_string(*args)
+      ZSTDS._native_compress_string(*args)
+    end
 
-      ZSTDS._native_decompress_string source, options
+    # Bypasses native decompress.
+    def self.native_decompress_string(*args)
+      ZSTDS._native_decompress_string(*args)
     end
   end
 end

data/lib/zstds/validation.rb

@@ -1,46 +1,19 @@
 # Ruby bindings for zstd library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
-require_relative "error"
+require "adsp/validation"
 
 module ZSTDS
-  module Validation
-    def self.validate_array(value)
-      raise ValidateError, "invalid array" unless value.is_a? ::Array
-    end
-
+  # ZSTDS::Validation class.
+  class Validation < ADSP::Validation
+    # Raises error when +value+ is not boolean.
     def self.validate_bool(value)
       raise ValidateError, "invalid bool" unless value.is_a?(::TrueClass) || value.is_a?(::FalseClass)
     end
 
-    def self.validate_hash(value)
-      raise ValidateError, "invalid hash" unless value.is_a? ::Hash
-    end
-
+    # Raises error when +value+ is not integer.
     def self.validate_integer(value)
       raise ValidateError, "invalid integer" unless value.is_a? ::Integer
     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_positive_integer(value)
-      raise ValidateError, "invalid positive integer" unless value.is_a?(::Integer) && value.positive?
-    end
-
-    def self.validate_proc(value)
-      unless value.is_a?(::Proc) || value.is_a?(::Method) || value.is_a?(::UnboundMethod)
-        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/zstds/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-zstds
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Andrew Aladjev
@@ -10,8 +10,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-07-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: adsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +74,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: ocg
   requirement: !ruby/object:Gem::Requirement
@@ -124,48 +138,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.26'
+        version: '1.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.26'
+        version: '1.31'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -230,16 +258,10 @@ files:
 - lib/zstds/error.rb
 - lib/zstds/file.rb
 - lib/zstds/option.rb
-- lib/zstds/stream/abstract.rb
-- lib/zstds/stream/delegates.rb
-- lib/zstds/stream/raw/abstract.rb
 - lib/zstds/stream/raw/compressor.rb
 - lib/zstds/stream/raw/decompressor.rb
 - lib/zstds/stream/reader.rb
-- lib/zstds/stream/reader_helpers.rb
-- lib/zstds/stream/stat.rb
 - lib/zstds/stream/writer.rb
-- lib/zstds/stream/writer_helpers.rb
 - lib/zstds/string.rb
 - lib/zstds/validation.rb
 - lib/zstds/version.rb
@@ -256,7 +278,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="