adsp 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd22e8463be2343be9f61ce80d54261f32aefed31b3f6b6550f38e41a5c0401
-  data.tar.gz: 690e5d1c232c781f2bd48b099b01f8ee2d60a7b79aadec7255775110acfedf1f
+  metadata.gz: '0857763064f25aac54a464ab7d50627214315565824b5c507713bf6f43aa40d2'
+  data.tar.gz: 4c4e2c600b0b887b2855629e3ab712ba6c99ff4b2a0f1f88693a52a400324a1e
 SHA512:
-  metadata.gz: 03e5c419cebc46df3e64aa5f71905358c0f7dc5d16a417b2239d22c9e93eca734258da71a819037d6c754b4c4a077a9d177e13f9ec8310ee87187d875606f120
-  data.tar.gz: 5759268ce78057265a84f667966e0869973da161035498438ef88e9c41fc06bdc4984ac8fd73f3b58a0010b2971eabc932ff874d152487c5f8ab6d60d1c92e3d
+  metadata.gz: dad7a1bed65e2b4302e7925e3ef4f6905a8edc5f716095af8b7df69c1f024d9a5545d0c3a2390142630b49d7d0ec898e17c959ddc5695b519ab9a0a37beb3b49
+  data.tar.gz: b1b79e2f89480b872338780a658c76facedb355e7c1d3e8bca2a8d6b77b19e1da7f189b9d022842d3dd398c90752855e0cb517642e2451cd9f0fcf879d800537

data/README.md

@@ -80,6 +80,10 @@ Parallel.each large_datas do |large_data|
 end
 ```
 
+# Docs
+
+Please review [rdoc generated docs](https://andrew-aladev.github.io/adsp).
+
 ## Options
 
 | Option                          | Values         | Default    | Description |
@@ -198,14 +202,11 @@ Special asynchronous methods missing in `Zlib::GzipWriter`.
 So it is possible to have asynchronous variants for these synchronous methods.
 Behaviour is the same as `IO#write_nonblock` method.
 
-All nonblock operations for file will raise `EBADF` error on Windows.
-Setting file into nonblocking mode is [not available on Windows](https://github.com/ruby/ruby/blob/master/win32/win32.c#L4388).
-
 ```
 #<<(object)
 #print(*objects)
 #printf(*args)
-#putc(object, encoding: ::Encoding::BINARY)
+#putc(object, :encoding => 'ASCII-8BIT')
 #puts(*objects)
 ```
 

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

@@ -9,8 +9,9 @@ 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
 
       SOURCE_PATH  = ::File.join(TEMP_PATH, "source").freeze
@@ -98,7 +99,7 @@ module ADSP
           file.write_nonblock "text"
         end
       rescue Errno::EBADF
-        # Nonblock operations with files are not available on Windows.
+        # Nonblock operations with files may not be available.
         false
       else
         true

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

@@ -10,7 +10,9 @@ 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

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
 
@@ -84,7 +85,7 @@ module ADSP
             instance.close_on_exec = true
             assert_predicate instance, :close_on_exec?
 
-            # Fcntl is not available on windows.
+            # Fcntl may not be available.
             if Fcntl.const_defined? :F_GETFL
               stats = instance.fcntl Fcntl::F_GETFL, 0
               refute_nil stats

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

@@ -10,7 +10,9 @@ 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

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/{test → lib/adsp/test}/stream/raw/compressor.test.rb

@@ -12,7 +12,9 @@ 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

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

@@ -12,7 +12,9 @@ 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

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

@@ -15,7 +15,9 @@ require_relative "../mock/string"
 
 module ADSP
   module Test
+    # ADSP::Test::Stream module.
     module Stream
+      # ADSP::Test::Stream::Reader class.
       class Reader < Abstract
         Target = Mock::Stream::Reader
         String = Mock::String

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

@@ -13,7 +13,9 @@ require_relative "../mock/string"
 
 module ADSP
   module Test
+    # ADSP::Test::Stream module.
     module Stream
+      # ADSP::Test::Stream::ReaderHelpers class.
       class ReaderHelpers < Minitest::Test
         Target = Mock::Stream::Reader
         String = Mock::String

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

@@ -14,7 +14,9 @@ require_relative "../mock/string"
 
 module ADSP
   module Test
+    # ADSP::Test::Stream module.
     module Stream
+      # ADSP::Test::Stream::Writer class.
       class Writer < Abstract
         Target = Mock::Stream::Writer
         String = Mock::String

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

@@ -13,7 +13,9 @@ require_relative "../mock/string"
 
 module ADSP
   module Test
+    # ADSP::Test::Stream module.
     module Stream
+      # ADSP::Test::Stream::WriterHelpers class.
       class WriterHelpers < Minitest::Test
         Target = Mock::Stream::Writer
         String = Mock::String

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

@@ -10,7 +10,9 @@ require_relative "option"
 require_relative "validation"
 
 module ADSP
+  # ADSP::Test module.
   module Test
+    # ADSP::Test::String class.
     class String < Minitest::Test
       Option = Test::Option
       Target = Mock::String

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

@@ -5,6 +5,7 @@ require "stringio"
 
 module ADSP
   module Test
+    # ADSP::Test::Validation module.
     module Validation
       NOOP_PROC = proc {} # no-op
 
@@ -43,26 +44,32 @@ module ADSP
       ]
       .freeze
 
+      # ADSP::Test::Validation::StringIOWithoutEOF class.
       class StringIOWithoutEOF < ::StringIO
         undef :eof?
       end
 
+      # ADSP::Test::Validation::StringIOWithoutRead class.
       class StringIOWithoutRead < ::StringIO
         undef :read
       end
 
+      # ADSP::Test::Validation::StringIOWithoutReadNonblock class.
       class StringIOWithoutReadNonblock < ::StringIO
         undef :read_nonblock
       end
 
+      # ADSP::Test::Validation::StringIOWithoutReadpartial class.
       class StringIOWithoutReadpartial < ::StringIO
         undef :readpartial
       end
 
+      # ADSP::Test::Validation::StringIOWithoutWrite class.
       class StringIOWithoutWrite < ::StringIO
         undef :write
       end
 
+      # ADSP::Test::Validation::StringIOWithoutWriteNonblock class.
       class StringIOWithoutWriteNonblock < ::StringIO
         undef :write_nonblock
       end

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

@@ -6,7 +6,9 @@ require "adsp"
 require_relative "minitest"
 
 module ADSP
+  # ADSP::Test module.
   module Test
+    # ADSP::Test::Version class.
     class Version < Minitest::Test
       def test_version
         refute_nil ADSP::VERSION

data/lib/adsp/version.rb

@@ -3,5 +3,5 @@
 
 module ADSP
   # Abstract data stream processor version.
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adsp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Andrew Aladjev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -218,34 +218,34 @@ files:
 - lib/adsp/stream/writer.rb
 - lib/adsp/stream/writer_helpers.rb
 - lib/adsp/string.rb
+- lib/adsp/test/common.rb
+- lib/adsp/test/coverage_helper.rb
+- lib/adsp/test/file.test.rb
+- lib/adsp/test/minitest.rb
+- lib/adsp/test/mock/common.rb
+- lib/adsp/test/mock/file.rb
+- lib/adsp/test/mock/stream/raw/compressor.rb
+- lib/adsp/test/mock/stream/raw/decompressor.rb
+- lib/adsp/test/mock/stream/raw/native_compressor.rb
+- lib/adsp/test/mock/stream/raw/native_decompressor.rb
+- lib/adsp/test/mock/stream/reader.rb
+- lib/adsp/test/mock/stream/writer.rb
+- lib/adsp/test/mock/string.rb
+- lib/adsp/test/option.rb
+- lib/adsp/test/stream/abstract.rb
+- lib/adsp/test/stream/minitar.test.rb
+- lib/adsp/test/stream/raw/abstract.rb
+- lib/adsp/test/stream/raw/compressor.test.rb
+- lib/adsp/test/stream/raw/decompressor.test.rb
+- lib/adsp/test/stream/reader.test.rb
+- lib/adsp/test/stream/reader_helpers.test.rb
+- lib/adsp/test/stream/writer.test.rb
+- lib/adsp/test/stream/writer_helpers.test.rb
+- lib/adsp/test/string.test.rb
+- lib/adsp/test/validation.rb
+- lib/adsp/test/version.test.rb
 - lib/adsp/validation.rb
 - lib/adsp/version.rb
-- test/common.rb
-- test/coverage_helper.rb
-- test/file.test.rb
-- test/minitest.rb
-- test/mock/common.rb
-- test/mock/file.rb
-- test/mock/stream/raw/compressor.rb
-- test/mock/stream/raw/decompressor.rb
-- test/mock/stream/raw/native_compressor.rb
-- test/mock/stream/raw/native_decompressor.rb
-- test/mock/stream/reader.rb
-- test/mock/stream/writer.rb
-- test/mock/string.rb
-- test/option.rb
-- test/stream/abstract.rb
-- test/stream/minitar.test.rb
-- test/stream/raw/abstract.rb
-- test/stream/raw/compressor.test.rb
-- test/stream/raw/decompressor.test.rb
-- test/stream/reader.test.rb
-- test/stream/reader_helpers.test.rb
-- test/stream/writer.test.rb
-- test/stream/writer_helpers.test.rb
-- test/string.test.rb
-- test/validation.rb
-- test/version.test.rb
 homepage: https://github.com/andrew-aladev/adsp
 licenses:
 - MIT
@@ -255,7 +255,6 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
-- test
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="