adsp 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c094ea37f026fccb543a8fd2a07b5ca7ffa7a257898f4d68355c3b5725d5f4a
-  data.tar.gz: 1a23e412fa5acf7a1db82eaf54efa6d5f624371a7a073fb07efa76eff1dd39f0
+  metadata.gz: 30860551943717e9021665e6b9a7579a2a2b51998515dd66bddfbe4a61803dda
+  data.tar.gz: eab7e3ece3ff8153ac5a6e47abdd9cccba8622beb6a04d387c3d214bac35611e
 SHA512:
-  metadata.gz: e6dc7f6d468f9bf7efd0bdb3dec79a6edc8f546e450bf6fed510f6ff2200e088518d17a6a3ed3e7feaceada5020d529e62b59ccb574426630b85ad0b265c70d3
-  data.tar.gz: a163ea2c53fba855eb65f60432fed2b5e712541acbe23defd1db270b3de348eb732ea541186eeed51a1752821f566c734275f9cf7538cd1bf327bc475c285647
+  metadata.gz: ef45beb65c047e2c55cdcd68700aa0cfa456fa0b77653fda659c0c6d093d9e5b82e7ef7bcdff13d9d7c084da4e7490f29c5c2f8dcfcb83c1acc65013ec4d33ec
+  data.tar.gz: 685e128e4d17c3d875135bca4ab169004d2f15d03b3a50bef45998b213517a040dff8892b19143672f1eefcd6ddf0642792728d5db8904e748fcb05cc3780724

data/{test → lib/adsp/test}/common.rb

@@ -9,9 +9,12 @@ require_relative "coverage_helper"
 
 module ADSP
   module Test
+    # ADSP::Test::Common module.
     module Common
-      BASE_PATH = ::File.expand_path(::File.join(::File.dirname(__FILE__), "..")).freeze
+      BASE_PATH = ::File.expand_path(::File.join(::File.dirname(__FILE__), "..", "..", "..")).freeze
+
       TEMP_PATH = ::File.join(BASE_PATH, "tmp").freeze
+      FileUtils.mkdir_p TEMP_PATH
 
       SOURCE_PATH  = ::File.join(TEMP_PATH, "source").freeze
       ARCHIVE_PATH = ::File.join(TEMP_PATH, "archive").freeze

data/lib/adsp/test/file.rb

@@ -0,0 +1,120 @@
+# Abstract data stream processor.
+# Copyright (c) 2021 AUTHORS, MIT License.
+
+require "adsp/file"
+
+require_relative "common"
+require_relative "minitest"
+require_relative "mock/file"
+require_relative "option"
+require_relative "validation"
+
+module ADSP
+  # ADSP::Test module.
+  module Test
+    # ADSP::Test::File class.
+    class File < Minitest::Test
+      Option = Test::Option
+      Target = Mock::File
+
+      SOURCE_PATH  = Common::SOURCE_PATH
+      ARCHIVE_PATH = Common::ARCHIVE_PATH
+      TEXTS        = Common::TEXTS
+      LARGE_TEXTS  = Common::LARGE_TEXTS
+
+      BUFFER_LENGTH_NAMES   = %i[source_buffer_length destination_buffer_length].freeze
+      BUFFER_LENGTH_MAPPING = {
+        :source_buffer_length      => :destination_buffer_length,
+        :destination_buffer_length => :source_buffer_length
+      }
+      .freeze
+
+      def test_invalid_arguments
+        Validation::INVALID_STRINGS.each do |invalid_path|
+          assert_raises ValidateError do
+            Target.compress invalid_path, ARCHIVE_PATH
+          end
+
+          assert_raises ValidateError do
+            Target.compress SOURCE_PATH, invalid_path
+          end
+
+          assert_raises ValidateError do
+            Target.decompress invalid_path, SOURCE_PATH
+          end
+
+          assert_raises ValidateError do
+            Target.decompress ARCHIVE_PATH, invalid_path
+          end
+        end
+
+        get_invalid_compressor_options do |invalid_options|
+          assert_raises ValidateError do
+            Target.compress SOURCE_PATH, ARCHIVE_PATH, invalid_options
+          end
+        end
+
+        get_invalid_decompressor_options do |invalid_options|
+          assert_raises ValidateError do
+            Target.decompress ARCHIVE_PATH, SOURCE_PATH, invalid_options
+          end
+        end
+      end
+
+      def test_texts
+        parallel_compressor_options do |compressor_options, worker_index|
+          source_path  = Common.get_path SOURCE_PATH, worker_index
+          archive_path = Common.get_path ARCHIVE_PATH, worker_index
+
+          TEXTS.each do |text|
+            ::File.write source_path, text, :mode => "wb"
+            Target.compress source_path, archive_path, compressor_options
+
+            get_compatible_decompressor_options compressor_options do |decompressor_options|
+              Target.decompress archive_path, source_path, decompressor_options
+
+              decompressed_text = ::File.read source_path, :mode => "rb"
+              decompressed_text.force_encoding text.encoding
+
+              assert_equal text, decompressed_text
+            end
+          end
+        end
+      end
+
+      def test_large_texts
+        Common.parallel LARGE_TEXTS do |text, worker_index|
+          source_path  = Common.get_path SOURCE_PATH, worker_index
+          archive_path = Common.get_path ARCHIVE_PATH, worker_index
+
+          ::File.write source_path, text, :mode => "wb"
+          Target.compress source_path, archive_path
+          Target.decompress archive_path, source_path
+
+          decompressed_text = ::File.read source_path, :mode => "rb"
+          decompressed_text.force_encoding text.encoding
+
+          assert_equal text, decompressed_text
+        end
+      end
+
+      # -----
+
+      def get_invalid_compressor_options(&block)
+        self.class::Option.get_invalid_compressor_options BUFFER_LENGTH_NAMES, &block
+      end
+
+      def get_invalid_decompressor_options(&block)
+        self.class::Option.get_invalid_decompressor_options BUFFER_LENGTH_NAMES, &block
+      end
+
+      def parallel_compressor_options(&block)
+        Common.parallel_options self.class::Option.get_compressor_options_generator(BUFFER_LENGTH_NAMES), &block
+      end
+
+      def get_compatible_decompressor_options(compressor_options, &block)
+        self.class::Option.get_compatible_decompressor_options compressor_options, BUFFER_LENGTH_MAPPING, &block
+      end
+    end
+  end
+end

data/{test → lib/adsp/test}/minitest.rb

@@ -4,6 +4,7 @@
 require "minitest"
 require "minitest/autorun"
 
+# Minitest module.
 module Minitest
   Minitest.module_eval do
     class << self

data/{test → lib/adsp/test}/mock/common.rb

@@ -8,6 +8,7 @@ require_relative "../common"
 module ADSP
   module Test
     module Mock
+      # ADSP::Test::Mock::Common module.
       module Common
         DEFAULT_DESTINATION_BUFFER_LENGTH = 1 << 18 # 256 KB
 

data/{test → lib/adsp/test}/mock/file.rb

@@ -8,6 +8,7 @@ require_relative "./common"
 module ADSP
   module Test
     module Mock
+      # ADSP::Test::Mock::File class.
       class File < ADSP::File
         PORTION_LENGTH = 10**6
 

data/{test → lib/adsp/test}/mock/stream/raw/compressor.rb

@@ -10,6 +10,7 @@ module ADSP
     module Mock
       module Stream
         module Raw
+          # ADSP::Test::Mock::Stream::Raw::Compressor class.
           class Compressor < ADSP::Stream::Raw::Compressor
             NativeCompressor = Raw::NativeCompressor
           end

data/{test → lib/adsp/test}/mock/stream/raw/decompressor.rb

@@ -10,6 +10,7 @@ module ADSP
     module Mock
       module Stream
         module Raw
+          # ADSP::Test::Mock::Stream::Raw::Decompressor class.
           class Decompressor < ADSP::Stream::Raw::Decompressor
             NativeDecompressor = Raw::NativeDecompressor
           end

data/{test → lib/adsp/test}/mock/stream/raw/native_compressor.rb

@@ -11,6 +11,7 @@ module ADSP
     module Mock
       module Stream
         module Raw
+          # ADSP::Test::Mock::Stream::Raw::NativeCompressor class.
           class NativeCompressor
             def initialize(options)
               ADSP::Validation.validate_hash options

data/{test → lib/adsp/test}/mock/stream/raw/native_decompressor.rb

@@ -11,6 +11,7 @@ module ADSP
     module Mock
       module Stream
         module Raw
+          # ADSP::Test::Mock::Stream::Raw::NativeDecompressor class.
           class NativeDecompressor
             def initialize(options)
               ADSP::Validation.validate_hash options

data/{test → lib/adsp/test}/mock/stream/reader.rb

@@ -9,6 +9,7 @@ module ADSP
   module Test
     module Mock
       module Stream
+        # ADSP::Test::Mock::Stream::Reader class.
         class Reader < ADSP::Stream::Reader
           RawDecompressor = Mock::Stream::Raw::Decompressor
         end

data/{test → lib/adsp/test}/mock/stream/writer.rb

@@ -9,6 +9,7 @@ module ADSP
   module Test
     module Mock
       module Stream
+        # ADSP::Test::Mock::Stream::Writer class.
         class Writer < ADSP::Stream::Writer
           RawCompressor = Mock::Stream::Raw::Compressor
         end

data/{test → lib/adsp/test}/mock/string.rb

@@ -8,6 +8,7 @@ require_relative "./common"
 module ADSP
   module Test
     module Mock
+      # ADSP::Test::Mock::String class.
       class String < ADSP::String
         def self.native_compress_string(source, options)
           destination_buffer_length = options[:destination_buffer_length]

data/{test → lib/adsp/test}/option.rb

@@ -8,6 +8,7 @@ require_relative "validation"
 
 module ADSP
   module Test
+    # ADSP::Test::Option module.
     module Option
       private_class_method def self.get_common_invalid_options(buffer_length_names, &block)
         Validation::INVALID_HASHES.each(&block)

data/{test → lib/adsp/test}/stream/abstract.rb

@@ -11,6 +11,7 @@ require_relative "../validation"
 module ADSP
   module Test
     module Stream
+      # ADSP::Test::Stream::Abstract class.
       class Abstract < Minitest::Test
         SOURCE_PATH = Common::SOURCE_PATH
 

data/lib/adsp/test/stream/minitar.rb

@@ -0,0 +1,50 @@
+# Abstract data stream processor.
+# Copyright (c) 2021 AUTHORS, MIT License.
+
+require "minitar"
+
+require_relative "../common"
+require_relative "../minitest"
+require_relative "../mock/stream/reader"
+require_relative "../mock/stream/writer"
+
+module ADSP
+  module Test
+    # ADSP::Test::Stream module.
+    module Stream
+      # ADSP::Test::Stream::MinitarTest class.
+      class MinitarTest < Minitest::Test
+        Reader = Mock::Stream::Reader
+        Writer = Mock::Stream::Writer
+
+        ARCHIVE_PATH = Common::ARCHIVE_PATH
+        LARGE_TEXTS  = Common::LARGE_TEXTS
+
+        def test_tar
+          Common.parallel LARGE_TEXTS do |text, worker_index|
+            archive_path = Common.get_path ARCHIVE_PATH, worker_index
+
+            Writer.open archive_path do |writer|
+              Minitar::Writer.open writer do |tar|
+                tar.add_file_simple "file", :data => text
+              end
+            end
+
+            Reader.open archive_path do |reader|
+              Minitar::Reader.open reader do |tar|
+                tar.each_entry do |entry|
+                  assert_equal "file", entry.name
+
+                  decompressed_text = entry.read
+                  decompressed_text.force_encoding text.encoding
+
+                  assert_equal text, decompressed_text
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/{test → lib/adsp/test}/stream/raw/abstract.rb

@@ -8,6 +8,7 @@ module ADSP
   module Test
     module Stream
       module Raw
+        # ADSP::Test::Stream::Raw::Abstract class.
         class Abstract < Minitest::Test
           NOOP_PROC = Validation::NOOP_PROC
 

data/lib/adsp/test/stream/raw/compressor.rb

@@ -0,0 +1,165 @@
+# Abstract data stream processor.
+# Copyright (c) 2021 AUTHORS, MIT License.
+
+require_relative "abstract"
+require_relative "../../common"
+require_relative "../../mock/stream/raw/compressor"
+require_relative "../../mock/string"
+require_relative "../../option"
+require_relative "../../validation"
+
+module ADSP
+  module Test
+    module Stream
+      # ADSP::Test::Stream::Raw module.
+      module Raw
+        # ADSP::Test::Stream::Raw::Compressor class.
+        class Compressor < Abstract
+          Target = Mock::Stream::Raw::Compressor
+          String = Mock::String
+
+          TEXTS                 = Common::TEXTS
+          LARGE_TEXTS           = Common::LARGE_TEXTS
+          PORTION_LENGTHS       = Common::PORTION_LENGTHS
+          LARGE_PORTION_LENGTHS = Common::LARGE_PORTION_LENGTHS
+
+          BUFFER_LENGTH_NAMES   = %i[destination_buffer_length].freeze
+          BUFFER_LENGTH_MAPPING = { :destination_buffer_length => :destination_buffer_length }.freeze
+
+          def test_invalid_initialize
+            get_invalid_compressor_options do |invalid_options|
+              assert_raises ValidateError do
+                Target.new invalid_options
+              end
+            end
+          end
+
+          def test_invalid_write
+            compressor = Target.new
+
+            Validation::INVALID_STRINGS.each do |invalid_string|
+              assert_raises ValidateError do
+                compressor.write invalid_string, &NOOP_PROC
+              end
+            end
+
+            assert_raises ValidateError do
+              compressor.write ""
+            end
+
+            compressor.close(&NOOP_PROC)
+
+            assert_raises UsedAfterCloseError do
+              compressor.write "", &NOOP_PROC
+            end
+          end
+
+          def test_texts
+            parallel_compressor_options do |compressor_options|
+              TEXTS.each do |text|
+                PORTION_LENGTHS.each do |portion_length|
+                  compressed_buffer = ::StringIO.new
+                  compressed_buffer.set_encoding ::Encoding::BINARY
+
+                  writer     = proc { |portion| compressed_buffer << portion }
+                  compressor = Target.new compressor_options
+
+                  begin
+                    source      = "".b
+                    text_offset = 0
+                    index       = 0
+
+                    loop do
+                      portion = text.byteslice text_offset, portion_length
+                      break if portion.nil?
+
+                      text_offset += portion_length
+                      source << portion
+
+                      bytes_written = compressor.write source, &writer
+                      source        = source.byteslice bytes_written, source.bytesize - bytes_written
+
+                      compressor.flush(&writer) if index.even?
+                      index += 1
+                    end
+
+                  ensure
+                    refute_predicate compressor, :closed?
+                    compressor.close(&writer)
+                    assert_predicate compressor, :closed?
+                  end
+
+                  compressed_text = compressed_buffer.string
+
+                  get_compatible_decompressor_options compressor_options do |decompressor_options|
+                    decompressed_text = String.decompress compressed_text, decompressor_options
+                    decompressed_text.force_encoding text.encoding
+
+                    assert_equal text, decompressed_text
+                  end
+                end
+              end
+            end
+          end
+
+          def test_large_texts
+            options_generator = OCG.new(
+              :text           => LARGE_TEXTS,
+              :portion_length => LARGE_PORTION_LENGTHS
+            )
+
+            Common.parallel_options options_generator do |options|
+              text           = options[:text]
+              portion_length = options[:portion_length]
+
+              compressed_buffer = ::StringIO.new
+              compressed_buffer.set_encoding ::Encoding::BINARY
+
+              writer     = proc { |portion| compressed_buffer << portion }
+              compressor = Target.new
+
+              begin
+                source      = "".b
+                text_offset = 0
+
+                loop do
+                  portion = text.byteslice text_offset, portion_length
+                  break if portion.nil?
+
+                  text_offset += portion_length
+                  source << portion
+
+                  bytes_written = compressor.write source, &writer
+                  source        = source.byteslice bytes_written, source.bytesize - bytes_written
+                end
+              ensure
+                compressor.close(&writer)
+              end
+
+              compressed_text = compressed_buffer.string
+
+              decompressed_text = String.decompress compressed_text
+              decompressed_text.force_encoding text.encoding
+
+              assert_equal text, decompressed_text
+            end
+          end
+
+          # -----
+
+          def get_invalid_compressor_options(&block)
+            Option.get_invalid_compressor_options BUFFER_LENGTH_NAMES, &block
+          end
+
+          def parallel_compressor_options(&block)
+            Common.parallel_options Option.get_compressor_options_generator(BUFFER_LENGTH_NAMES), &block
+          end
+
+          def get_compatible_decompressor_options(compressor_options, &block)
+            Option.get_compatible_decompressor_options compressor_options, BUFFER_LENGTH_MAPPING, &block
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adsp/test/stream/raw/decompressor.rb

@@ -0,0 +1,165 @@
+# Abstract data stream processor.
+# Copyright (c) 2021 AUTHORS, MIT License.
+
+require_relative "abstract"
+require_relative "../../common"
+require_relative "../../mock/stream/raw/decompressor"
+require_relative "../../mock/string"
+require_relative "../../option"
+require_relative "../../validation"
+
+module ADSP
+  module Test
+    module Stream
+      # ADSP::Test::Stream::Raw module.
+      module Raw
+        # ADSP::Test::Stream::Raw::Decompressor class.
+        class Decompressor < Abstract
+          Target = Mock::Stream::Raw::Decompressor
+          String = Mock::String
+
+          TEXTS                 = Common::TEXTS
+          LARGE_TEXTS           = Common::LARGE_TEXTS
+          PORTION_LENGTHS       = Common::PORTION_LENGTHS
+          LARGE_PORTION_LENGTHS = Common::LARGE_PORTION_LENGTHS
+
+          BUFFER_LENGTH_NAMES   = %i[destination_buffer_length].freeze
+          BUFFER_LENGTH_MAPPING = { :destination_buffer_length => :destination_buffer_length }.freeze
+
+          def test_invalid_initialize
+            get_invalid_decompressor_options do |invalid_options|
+              assert_raises ValidateError do
+                Target.new invalid_options
+              end
+            end
+          end
+
+          def test_invalid_read
+            decompressor = Target.new
+
+            Validation::INVALID_STRINGS.each do |invalid_string|
+              assert_raises ValidateError do
+                decompressor.read invalid_string, &NOOP_PROC
+              end
+            end
+
+            assert_raises ValidateError do
+              decompressor.read ""
+            end
+
+            decompressor.close(&NOOP_PROC)
+
+            assert_raises UsedAfterCloseError do
+              decompressor.read "", &NOOP_PROC
+            end
+          end
+
+          def test_texts
+            parallel_compressor_options do |compressor_options|
+              TEXTS.each do |text|
+                compressed_text = String.compress text, compressor_options
+
+                PORTION_LENGTHS.each do |portion_length|
+                  get_compatible_decompressor_options compressor_options do |decompressor_options|
+                    decompressed_buffer = ::StringIO.new
+                    decompressed_buffer.set_encoding ::Encoding::BINARY
+
+                    writer       = proc { |portion| decompressed_buffer << portion }
+                    decompressor = Target.new decompressor_options
+
+                    begin
+                      source                 = "".b
+                      compressed_text_offset = 0
+                      index                  = 0
+
+                      loop do
+                        portion = compressed_text.byteslice compressed_text_offset, portion_length
+                        break if portion.nil?
+
+                        compressed_text_offset += portion_length
+                        source << portion
+
+                        bytes_read = decompressor.read source, &writer
+                        source     = source.byteslice bytes_read, source.bytesize - bytes_read
+
+                        decompressor.flush(&writer) if index.even?
+                        index += 1
+                      end
+
+                    ensure
+                      refute_predicate decompressor, :closed?
+                      decompressor.close(&writer)
+                      assert_predicate decompressor, :closed?
+                    end
+
+                    decompressed_text = decompressed_buffer.string
+                    decompressed_text.force_encoding text.encoding
+
+                    assert_equal text, decompressed_text
+                  end
+                end
+              end
+            end
+          end
+
+          def test_large_texts
+            options_generator = OCG.new(
+              :text           => LARGE_TEXTS,
+              :portion_length => LARGE_PORTION_LENGTHS
+            )
+
+            Common.parallel_options options_generator do |options|
+              text           = options[:text]
+              portion_length = options[:portion_length]
+
+              compressed_text = String.compress text
+
+              decompressed_buffer = ::StringIO.new
+              decompressed_buffer.set_encoding ::Encoding::BINARY
+
+              writer       = proc { |portion| decompressed_buffer << portion }
+              decompressor = Target.new
+
+              begin
+                source                 = "".b
+                compressed_text_offset = 0
+
+                loop do
+                  portion = compressed_text.byteslice compressed_text_offset, portion_length
+                  break if portion.nil?
+
+                  compressed_text_offset += portion_length
+                  source << portion
+
+                  bytes_read = decompressor.read source, &writer
+                  source     = source.byteslice bytes_read, source.bytesize - bytes_read
+                end
+              ensure
+                decompressor.close(&writer)
+              end
+
+              decompressed_text = decompressed_buffer.string
+              decompressed_text.force_encoding text.encoding
+
+              assert_equal text, decompressed_text
+            end
+          end
+
+          # -----
+
+          def get_invalid_decompressor_options(&block)
+            Option.get_invalid_decompressor_options BUFFER_LENGTH_NAMES, &block
+          end
+
+          def parallel_compressor_options(&block)
+            Common.parallel_options Option.get_compressor_options_generator(BUFFER_LENGTH_NAMES), &block
+          end
+
+          def get_compatible_decompressor_options(compressor_options, &block)
+            Option.get_compatible_decompressor_options compressor_options, BUFFER_LENGTH_MAPPING, &block
+          end
+        end
+      end
+    end
+  end
+end