ruby-zstds 1.3.0 → 1.3.1

data/lib/zstds/stream/abstract.rb

@@ -1,156 +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
-        @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 if @io.respond_to? :close
-
-        nil
-      end
-
-      def closed?
-        return false unless @raw_stream.closed?
-
-        if @io.respond_to? :closed
-          @io.closed?
-        else
-          true
-        end
-      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

data/lib/zstds/stream/reader_helpers.rb

@@ -1,194 +0,0 @@
-# Ruby bindings for zstd library.
-# Copyright (c) 2019 AUTHORS, MIT License.
-
-require "English"
-
-require_relative "../validation"
-
-module ZSTDS
-  module Stream
-    module ReaderHelpers
-      def getbyte
-        read 1
-      end
-
-      def each_byte(&block)
-        each_string method(:getbyte), &block
-      end
-
-      def readbyte
-        readstring method(:getbyte)
-      end
-
-      def ungetbyte(byte)
-        Validation.validate_string byte
-
-        @buffer.prepend byte
-
-        nil
-      end
-
-      # -- char --
-
-      def getc
-        if @external_encoding.nil?
-          byte = getbyte
-          return nil if byte.nil?
-
-          return transcode_to_internal byte
-        end
-
-        char = ::String.new :encoding => ::Encoding::BINARY
-
-        # Read one byte until valid string will appear.
-        loop do
-          byte = getbyte
-          return nil if byte.nil?
-
-          char << byte
-
-          char.force_encoding @external_encoding
-          return transcode_to_internal char if char.valid_encoding?
-
-          char.force_encoding ::Encoding::BINARY
-        end
-      end
-
-      def readchar
-        readstring method(:getc)
-      end
-
-      def each_char(&block)
-        each_string method(:getc), &block
-      end
-
-      def ungetc(char)
-        ungetstring char
-      end
-
-      # -- lines --
-
-      def gets(separator = $OUTPUT_RECORD_SEPARATOR, limit = nil)
-        # Limit can be a first argument.
-        if separator.is_a? ::Numeric
-          limit     = separator
-          separator = $OUTPUT_RECORD_SEPARATOR
-        end
-
-        line_ending =
-          if separator.nil?
-            nil
-          else
-            Validation.validate_string separator
-            ::String.new separator, :encoding => target_encoding
-          end
-
-        Validation.validate_positive_integer limit unless limit.nil?
-
-        line = ::String.new :encoding => target_encoding
-
-        loop do
-          char = getc
-
-          if char.nil?
-            return nil if line.empty?
-
-            break
-          end
-
-          line << char
-
-          break if
-            (!line_ending.nil? && line.end_with?(line_ending)) ||
-            (!limit.nil? && line.length >= limit)
-        end
-
-        @lineno += 1
-
-        line
-      end
-
-      def readline
-        readstring method(:gets)
-      end
-
-      def readlines
-        lines = []
-        each_line { |line| lines << line }
-
-        lines
-      end
-
-      def each_line(&block)
-        each_string method(:gets), &block
-      end
-
-      alias each each_line
-
-      def ungetline(line)
-        ungetstring line
-
-        @lineno -= 1
-
-        nil
-      end
-
-      # -- common --
-
-      protected def readstring(each_proc)
-        string = each_proc.call
-        raise ::EOFError if string.nil?
-
-        string
-      end
-
-      protected def each_string(each_proc, &block)
-        return enum_for __method__, each_proc unless block.is_a? ::Proc
-
-        loop do
-          string = each_proc.call
-          break if string.nil?
-
-          yield string
-        end
-
-        nil
-      end
-
-      protected def ungetstring(string)
-        Validation.validate_string string
-
-        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
-        @buffer.prepend string
-
-        nil
-      end
-
-      # -- etc --
-
-      module ClassMethods
-        def open(file_path, *args, &block)
-          Validation.validate_string file_path
-          Validation.validate_proc block
-
-          ::File.open file_path, "rb" do |io|
-            reader = new io, *args
-
-            begin
-              yield reader
-            ensure
-              reader.close
-            end
-          end
-        end
-      end
-
-      def self.included(klass)
-        klass.extend ClassMethods
-      end
-    end
-  end
-end

data/lib/zstds/stream/stat.rb

@@ -1,78 +0,0 @@
-# Ruby bindings for zstd library.
-# Copyright (c) 2019 AUTHORS, MIT License.
-
-require "forwardable"
-
-module ZSTDS
-  module Stream
-    class Stat
-      # Libraries like minitar tries to access stat to know whether stream is seekable.
-      # We need to mark stream as not directory, file, etc, because it is not seekable.
-
-      # User can use disabled delegates using :io reader.
-
-      extend ::Forwardable
-
-      METHODS_RETURNING_FALSE = %i[
-        blockdev?
-        chardev?
-        directory?
-        executable?
-        executable_real?
-        file?
-        grpowned?
-        owned?
-        pipe?
-        setgid?
-        setuid?
-        socket?
-        sticky?
-        symlink?
-        zero?
-      ]
-      .freeze
-
-      DELEGATES = %i[
-        <=>
-        atime
-        birthtime
-        blksize
-        blocks
-        ctime
-        dev
-        dev_major
-        dev_minor
-        ftype
-        gid
-        ino
-        inspect
-        mode
-        mtime
-        nlink
-        rdev
-        rdev_major
-        rdev_minor
-        readable?
-        readable_real?
-        size
-        size?
-        uid
-        world_readable?
-        world_writable?
-        writable?
-        writable_real?
-      ]
-      .freeze
-
-      def initialize(stat)
-        @stat = stat
-      end
-
-      METHODS_RETURNING_FALSE.each do |method_name|
-        define_method(method_name) { false }
-      end
-
-      def_delegators :@stat, *DELEGATES
-    end
-  end
-end

data/lib/zstds/stream/writer_helpers.rb

@@ -1,91 +0,0 @@
-# Ruby bindings for zstd library.
-# Copyright (c) 2019 AUTHORS, MIT License.
-
-require "English"
-
-require_relative "../error"
-require_relative "../validation"
-
-module ZSTDS
-  module Stream
-    module WriterHelpers
-      def <<(object)
-        write object
-      end
-
-      def print(*objects, field_separator: $OUTPUT_FIELD_SEPARATOR, record_separator: $OUTPUT_RECORD_SEPARATOR)
-        objects.each do |object|
-          write object
-          write field_separator unless field_separator.nil?
-        end
-
-        write record_separator unless record_separator.nil?
-
-        nil
-      end
-
-      def printf(*args)
-        write sprintf(*args)
-
-        nil
-      end
-
-      def putc(object, encoding: ::Encoding::BINARY)
-        case object
-        when ::Numeric
-          write object.chr(encoding)
-        when ::String
-          write object[0]
-        else
-          raise ValidateError, "invalid object: \"#{object}\" for putc"
-        end
-
-        object
-      end
-
-      def puts(*objects)
-        objects.each do |object|
-          if object.is_a? ::Array
-            puts(*object)
-            next
-          end
-
-          source  = object.to_s
-          newline = "\n".encode source.encoding
-
-          # Do not add newline if source ends with newline.
-          if source.end_with? newline
-            write source
-          else
-            write source + newline
-          end
-        end
-
-        nil
-      end
-
-      # -- etc --
-
-      module ClassMethods
-        def open(file_path, *args, &block)
-          Validation.validate_string file_path
-          Validation.validate_proc block
-
-          ::File.open file_path, "wb" do |io|
-            writer = new io, *args
-
-            begin
-              yield writer
-            ensure
-              writer.close
-            end
-          end
-        end
-      end
-
-      def self.included(klass)
-        klass.extend ClassMethods
-      end
-    end
-  end
-end