ruby-zstds 1.2.0 → 1.3.1

data/lib/zstds/stream/writer.rb

@@ -1,150 +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)
-        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
-        finish :flush
-
-        @io.flush
-
-        self
-      end
-
-      def rewind
-        finish :close
-
-        super
-      end
-
-      def close
-        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
-
-      # -- 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)
-
-        source         = transcode object.to_s
-        bytes_written  = raw_nonblock_wrapper :write, source
-        @pos          += bytes_written
-
-        bytes_written
-      end
-
-      def flush_nonblock(*options)
-        return false unless finish_nonblock :flush, *options
-
-        @io.flush
-
-        true
-      end
-
-      def rewind_nonblock(*options)
-        return false unless finish_nonblock :close, *options
-
-        method(:rewind).super_method.call
-
-        true
-      end
-
-      def close_nonblock(*options)
-        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
-
-      # -- 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,63 +1,19 @@
 # Ruby bindings for zstd library.
 # Copyright (c) 2019 AUTHORS, MIT License.
 
-require_relative "error"
+require "adsp/validation"
 
 module ZSTDS
-  module Validation
-    IO_METHODS = %i[
-      read
-      write
-      readpartial
-      read_nonblock
-      write_nonblock
-      eof?
-      flush
-      close
-      closed?
-    ]
-    .freeze
-
+  # 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
 
+    # 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_positive_integer(value)
-      raise ValidateError, "invalid positive integer" unless value.is_a?(::Integer) && value.positive?
-    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_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
-
-    def self.validate_io(value)
-      raise ValidateError, "invalid io" unless IO_METHODS.all? { |method| value.respond_to? method }
-    end
-
-    def self.validate_array(value)
-      raise ValidateError, "invalid array" unless value.is_a? ::Array
-    end
-
-    def self.validate_hash(value)
-      raise ValidateError, "invalid hash" unless value.is_a? ::Hash
-    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
   end
 end

data/lib/zstds/version.rb

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

metadata

@@ -1,15 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: ruby-zstds
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Andrew Aladjev
+- Ivan Takarlikov
+- Jenner La Fave
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-30 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
@@ -58,14 +74,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: ocg
   requirement: !ruby/object:Gem::Requirement
@@ -122,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.22'
+        version: '1.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '1.31'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -228,23 +258,18 @@ 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
 homepage: https://github.com/andrew-aladev/ruby-zstds
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -253,14 +278,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby bindings for zstd library.

data/lib/zstds/stream/abstract.rb

@@ -1,152 +0,0 @@
-# Ruby bindings for zstd library.
-# Copyright (c) 2019 AUTHORS, MIT License.
-
-require_relative "delegates"
-require_relative "stat"
-require_relative "../error"
-require_relative "../validation"
-
-module ZSTDS
-  module Stream
-    class Abstract
-      # 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.
-      # We will consume all source bytes and maintain buffer with remaining destination data.
-
-      include Delegates
-
-      attr_reader :io, :stat, :external_encoding, :internal_encoding, :transcode_options, :pos
-
-      alias tell pos
-
-      def initialize(io, options = {})
-        @raw_stream = create_raw_stream
-
-        Validation.validate_io io
-        @io = io
-
-        @stat = Stat.new @io.stat if @io.respond_to? :stat
-
-        set_encoding options[:external_encoding], options[:internal_encoding], options[:transcode_options]
-        reset_buffer
-        reset_io_advise
-
-        @pos = 0
-      end
-
-      # -- buffer --
-
-      protected def reset_buffer
-        @buffer = ::String.new :encoding => ::Encoding::BINARY
-      end
-
-      # -- advise --
-
-      protected def reset_io_advise
-        # Both compressor and decompressor need sequential io access.
-        @io.advise :sequential if @io.respond_to? :advise
-      rescue ::Errno::ESPIPE
-        # ok
-      end
-
-      def advise
-        # Noop
-        nil
-      end
-
-      # -- encoding --
-
-      def set_encoding(*args)
-        external_encoding, internal_encoding, transcode_options = process_set_encoding_arguments(*args)
-
-        set_target_encoding :@external_encoding, external_encoding
-        set_target_encoding :@internal_encoding, internal_encoding
-        @transcode_options = transcode_options
-
-        self
-      end
-
-      protected def process_set_encoding_arguments(*args)
-        external_encoding = args[0]
-
-        unless external_encoding.nil? || external_encoding.is_a?(::Encoding)
-          Validation.validate_string external_encoding
-
-          # First argument can be "external_encoding:internal_encoding".
-          match = %r{(.+?):(.+)}.match external_encoding
-
-          unless match.nil?
-            external_encoding = match[0]
-            internal_encoding = match[1]
-
-            transcode_options = args[1]
-            Validation.validate_hash transcode_options unless transcode_options.nil?
-
-            return [external_encoding, internal_encoding, transcode_options]
-          end
-        end
-
-        internal_encoding = args[1]
-        unless internal_encoding.nil? || internal_encoding.is_a?(::Encoding)
-          Validation.validate_string internal_encoding
-        end
-
-        transcode_options = args[2]
-        Validation.validate_hash transcode_options unless transcode_options.nil?
-
-        [external_encoding, internal_encoding, transcode_options]
-      end
-
-      protected def set_target_encoding(name, value)
-        unless value.nil? || value.is_a?(::Encoding)
-          begin
-            value = ::Encoding.find value
-          rescue ::ArgumentError
-            raise ValidateError, "invalid #{name} encoding"
-          end
-        end
-
-        instance_variable_set name, value
-      end
-
-      protected def target_encoding
-        return @internal_encoding unless @internal_encoding.nil?
-        return @external_encoding unless @external_encoding.nil?
-
-        ::Encoding::BINARY
-      end
-
-      # -- etc --
-
-      def rewind
-        @raw_stream = create_raw_stream
-
-        @io.rewind if @io.respond_to? :rewind
-
-        reset_buffer
-        reset_io_advise
-
-        @pos = 0
-
-        0
-      end
-
-      def close
-        @io.close
-
-        nil
-      end
-
-      def closed?
-        @raw_stream.closed? && @io.closed?
-      end
-
-      def to_io
-        self
-      end
-    end
-  end
-end

data/lib/zstds/stream/delegates.rb

@@ -1,36 +0,0 @@
-# Ruby bindings for zstd library.
-# Copyright (c) 2019 AUTHORS, MIT License.
-
-require "forwardable"
-
-module ZSTDS
-  module Stream
-    module Delegates
-      DELEGATES = %i[
-        autoclose=
-        autoclose?
-        binmode
-        binmode?
-        close_on_exec=
-        close_on_exec?
-        fcntl
-        fdatasync
-        fileno
-        fsync
-        ioctl
-        isatty
-        pid
-        sync
-        sync=
-        to_i
-        tty?
-      ]
-      .freeze
-
-      def self.included(klass)
-        klass.extend ::Forwardable
-        klass.def_delegators :@io, *DELEGATES
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-# Ruby bindings for zstd library.
-# Copyright (c) 2019 AUTHORS, MIT License.
-
-require "zstds_ext"
-
-require_relative "../../error"
-require_relative "../../validation"
-
-module ZSTDS
-  module Stream
-    module Raw
-      class Abstract
-        def initialize(native_stream)
-          @native_stream = native_stream
-          @is_closed     = false
-        end
-
-        # -- write --
-
-        def flush(&writer)
-          write_result(&writer)
-
-          nil
-        end
-
-        protected def more_destination(&writer)
-          result_bytesize = write_result(&writer)
-          raise NotEnoughDestinationError, "not enough destination" if result_bytesize.zero?
-        end
-
-        protected def write_result(&_writer)
-          result = @native_stream.read_result
-          yield result
-
-          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
-
-          nil
-        end
-
-        def closed?
-          @is_closed
-        end
-      end
-    end
-  end
-end