io-stream 0.9.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 506d80a7bb9aee846def3d18d0bf53f2085b751de5d511a8a6a31f8a5de0efd2
-  data.tar.gz: 9c828735d78bdeb4dba18b81ed350f5776ba3436cca7f18b17c465d6efd4ce7e
+  metadata.gz: 1c071e8e033bc6afd35a809466299187cfbee327acf26787968a7af2baeb89ce
+  data.tar.gz: 748cee4f872237453f35ef91aea936f29a632a27d35cf09235dcdd72b12e5826
 SHA512:
-  metadata.gz: 19d26e89eca00835b6331548e72fc74bf17add777028af9bb6d6a7749ee760eab41a5bae780876de278c6f82eeec02366ce83bb160c798cb441a28dbef56f263
-  data.tar.gz: 798d2863752eca4a03d9ae7b21000530442b7a4af218f2e89d1590baa2e821650fcb66689e6ae88ba91b5ec742136ef46c328a7a48afb2d7048990084a12af05
+  metadata.gz: 758b8a379a4b745e51a58810011a33fd5473527863da8c655d2f84a8fa135925b258edf25dd2431ab9b4f2b9e983a725cf6855ead510ac832705eb55c08a5d41
+  data.tar.gz: d7acbd5c30572b838503b1e25faea6b6ce046e76581d712bcd2fa6792a3f156992a69610a19d76be6e3746b4782cba479b9e318762dbb5864d5f4ff732fd273e

data/lib/io/stream/buffered.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require_relative "generic"
+require_relative "connection_reset_error"
 
 module IO::Stream
 	# A buffered stream implementation that wraps an underlying IO object to provide efficient buffered reading and writing.
@@ -59,34 +60,34 @@ module IO::Stream
 				@timeout = nil
 			end
 		end
-
+		
 		# @attribute [IO] The wrapped IO object.
 		attr :io
-
+		
 		# Get the underlying IO object.
 		# @returns [IO] The underlying IO object.
 		def to_io
 			@io.to_io
 		end
-
+		
 		# Check if the stream is closed.
 		# @returns [Boolean] True if the stream is closed.
 		def closed?
 			@io.closed?
 		end
-
+		
 		# Close the read end of the stream.
 		def close_read
 			@io.close_read
 		end
-
+		
 		# Close the write end of the stream.
 		def close_write
 			super
 		ensure
 			@io.close_write
 		end
-
+		
 		# Check if the stream is readable.
 		# @returns [Boolean] True if the stream is readable.
 		def readable?
@@ -146,6 +147,12 @@ module IO::Stream
 					return result
 				end
 			end
+		rescue OpenSSL::SSL::SSLError => error
+			if error.message =~ /unexpected eof while reading/
+				raise ConnectionResetError, "Connection reset by peer!"
+			end
+		rescue Errno::ECONNRESET
+			raise ConnectionResetError, "Connection reset by peer!"
 		rescue Errno::EBADF
 			raise ::IOError, "stream closed"
 		end

data/lib/io/stream/connection_reset_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module IO::Stream
+	# Represents a connection reset error in IO streams, usually occurring when the remote side closes the connection unexpectedly.
+	class ConnectionResetError < Errno::ECONNRESET
+	end
+end

data/lib/io/stream/generic.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 require_relative "string_buffer"
 require_relative "readable"

data/lib/io/stream/openssl.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require "openssl"
 

data/lib/io/stream/readable.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2025, by Samuel Williams.
 
 require_relative "string_buffer"
 
 module IO::Stream
 	# The default block size for IO buffers. Defaults to 256KB (optimized for modern SSDs and networks).
 	BLOCK_SIZE = ENV.fetch("IO_STREAM_BLOCK_SIZE", 1024*256).to_i
-
+	
 	# The minimum read size for efficient I/O operations. Defaults to the same as BLOCK_SIZE.
 	MINIMUM_READ_SIZE = ENV.fetch("IO_STREAM_MINIMUM_READ_SIZE", BLOCK_SIZE).to_i
-
+	
 	# The maximum read size for a single read operation. This limit exists because:
 	# 1. System calls like read() cannot handle requests larger than SSIZE_MAX
 	# 2. Very large reads can cause memory pressure and poor interactive performance  
@@ -30,7 +30,7 @@ module IO::Stream
 		# @parameter maximum_read_size [Integer] The maximum size for read operations.
 		# @parameter block_size [Integer] Legacy parameter, use minimum_read_size instead.
 		def initialize(minimum_read_size: MINIMUM_READ_SIZE, maximum_read_size: MAXIMUM_READ_SIZE, block_size: nil, **, &block)
-			@done = false
+			@finished = false
 			@read_buffer = StringBuffer.new
 			# Used as destination buffer for underlying reads.
 			@input_buffer = StringBuffer.new
@@ -41,21 +41,21 @@ module IO::Stream
 			
 			super(**, &block) if defined?(super)
 		end
-
+		
 		attr_accessor :minimum_read_size
-
+		
 		# Legacy accessor for backwards compatibility
 		# @returns [Integer] The minimum read size.
 		def block_size
 			@minimum_read_size
 		end
-
+		
 		# Legacy setter for backwards compatibility
 		# @parameter value [Integer] The minimum read size.
 		def block_size=(value)
 			@minimum_read_size = value
 		end
-
+		
 		# Read data from the stream.
 		# @parameter size [Integer | Nil] The number of bytes to read. If nil, read until end of stream.
 		# @parameter buffer [String | Nil] An optional buffer to fill with data instead of allocating a new string.
@@ -72,7 +72,7 @@ module IO::Stream
 			end
 			
 			if size
-				until @done or @read_buffer.bytesize >= size
+				until @finished or @read_buffer.bytesize >= size
 					# Compute the amount of data we need to read from the underlying stream:
 					read_size = size - @read_buffer.bytesize
 					
@@ -80,7 +80,7 @@ module IO::Stream
 					fill_read_buffer(read_size > @minimum_read_size ? read_size : @minimum_read_size)
 				end
 			else
-				until @done
+				until @finished
 					fill_read_buffer
 				end
 				
@@ -113,8 +113,8 @@ module IO::Stream
 					return String.new(encoding: Encoding::BINARY)
 				end
 			end
-		
-			if !@done and @read_buffer.empty?
+			
+			if !@finished and @read_buffer.empty?
 				fill_read_buffer
 			end
 			
@@ -134,7 +134,7 @@ module IO::Stream
 				return buffer
 			end
 			
-			raise exception, "Encountered done while reading data!"
+			raise exception, "Stream finished before reading enough data!"
 		end
 		
 		# This is a compatibility shim for existing code that uses `readpartial`.
@@ -142,7 +142,7 @@ module IO::Stream
 		# @parameter buffer [String | Nil] An optional buffer to fill with data instead of allocating a new string.
 		# @returns [String] The data read from the stream.
 		def readpartial(size = nil, buffer = nil)
-			read_partial(size, buffer) or raise EOFError, "Encountered done while reading data!"
+			read_partial(size, buffer) or raise EOFError, "Stream finished before reading enough data!"
 		end
 		
 		# Find the index of a pattern in the read buffer, reading more data if needed.
@@ -222,7 +222,7 @@ module IO::Stream
 		# @returns [String] The data in the buffer without consuming it.
 		def peek(size = nil)
 			if size
-				until @done or @read_buffer.bytesize >= size
+				until @finished or @read_buffer.bytesize >= size
 					# Compute the amount of data we need to read from the underlying stream:
 					read_size = size - @read_buffer.bytesize
 					
@@ -231,7 +231,7 @@ module IO::Stream
 				end
 				return @read_buffer[..([size, @read_buffer.size].min - 1)]
 			end
-			until (block_given? && yield(@read_buffer)) or @done
+			until (block_given? && yield(@read_buffer)) or @finished
 				fill_read_buffer
 			end
 			return @read_buffer
@@ -287,33 +287,33 @@ module IO::Stream
 		# See {readable?} for a non-blocking alternative.
 		#
 		# @returns [Boolean] If the stream is at file which means there is no more data to be read.
-		def done?
+		def finished?
 			if !@read_buffer.empty?
 				return false
-			elsif @done
+			elsif @finished
 				return true
 			else
 				return !self.fill_read_buffer
 			end
 		end
 		
-		alias eof? done?
+		alias eof? finished?
 		
-		# Mark the stream as done and raise `EOFError`.
-		def done!
+		# Mark the stream as finished and raise `EOFError`.
+		def finish!
 			@read_buffer.clear
-			@done = true
+			@finished = true
 			
 			raise EOFError
 		end
 		
-		alias eof! done!
+		alias eof! finish!
 		
 		# Whether there is a chance that a read operation will succeed or not.
 		# @returns [Boolean] If the stream is readable, i.e. a `read` operation has a chance of success.
 		def readable?
 			# If we are at the end of the file, we can't read any more data:
-			if @done
+			if @finished
 				return false
 			end
 			
@@ -358,7 +358,7 @@ module IO::Stream
 			end
 			
 			# else for both cases above:
-			@done = true
+			@finished = true
 			return false
 		end
 		
@@ -367,8 +367,8 @@ module IO::Stream
 		# @parameter buffer [String | Nil] An optional buffer to fill with data instead of allocating a new string.
 		# @returns [String | Nil] The consumed data, or nil if no data available.
 		def consume_read_buffer(size = nil, buffer = nil)
-			# If we are at done, and the read buffer is empty, we can't consume anything.
-			if @done && @read_buffer.empty?
+			# If we are at finished, and the read buffer is empty, we can't consume anything.
+			if @finished && @read_buffer.empty?
 				# Clear the buffer even when returning nil
 				if buffer
 					buffer.clear

data/lib/io/stream/shim/buffered.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 unless IO.method_defined?(:buffered?, false)
 	class IO

data/lib/io/stream/shim/readable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 class IO
 	unless method_defined?(:readable?, false)

data/lib/io/stream/string_buffer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 module IO::Stream
 	# A specialized string buffer for binary data with automatic encoding handling.

data/lib/io/stream/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 module IO::Stream
-	VERSION = "0.9.1"
+	VERSION = "0.11.0"
 end

data/lib/io/stream/writable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2025, by Samuel Williams.
 
 require_relative "readable"
 

data/lib/io/stream.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 require_relative "stream/version"
 require_relative "stream/buffered"

data/readme.md

@@ -12,6 +12,15 @@ Please see the [project documentation](https://socketry.github.io/io-stream) for
 
 Please see the [project releases](https://socketry.github.io/io-streamreleases/index) for all releases.
 
+### v0.11.0
+
+  - Introduce `class IO::Stream::ConnectionResetError < Errno::ECONNRESET` to standardize connection reset error handling across different IO types.
+      - `OpenSSL::SSL::SSLSocket` raises `OpenSSL::SSL::SSLError` on connection reset, while other IO types raise `Errno::ECONNRESET`. `SSLError` is now rescued and re-raised as `IO::Stream::ConnectionResetError` for consistency.
+
+### v0.10.0
+
+  - Rename `done?` to `finished?` for clarity and consistency.
+
 ### v0.9.1
 
   - Fix EOF behavior to match Ruby IO semantics: `read()` returns empty string `""` at EOF while `read(size)` returns `nil` at EOF.
@@ -50,18 +59,6 @@ Please see the [project releases](https://socketry.github.io/io-streamreleases/i
   - Ensure TLS connections have correct buffering behavior.
   - Improve test suite organization and readability.
 
-### v0.4.2
-
-  - Add external test suite for better integration testing.
-  - Update dependencies and improve code style with RuboCop.
-
-### v0.4.1
-
-  - Add compatibility fix for `SSLSocket` raising `EBADF` errors.
-  - Fix `IO#close` hang issue in certain scenarios.
-  - Add `#to_io` method to `IO::Stream::Buffered` for better compatibility.
-  - Modernize gem structure and dependencies.
-
 ## See Also
 
   - [async-io](https://github.com/socketry/async-io) — Where this implementation originally came from.

data/releases.md

@@ -1,5 +1,14 @@
 # Releases
 
+## v0.11.0
+
+  - Introduce `class IO::Stream::ConnectionResetError < Errno::ECONNRESET` to standardize connection reset error handling across different IO types.
+      - `OpenSSL::SSL::SSLSocket` raises `OpenSSL::SSL::SSLError` on connection reset, while other IO types raise `Errno::ECONNRESET`. `SSLError` is now rescued and re-raised as `IO::Stream::ConnectionResetError` for consistency.
+
+## v0.10.0
+
+  - Rename `done?` to `finished?` for clarity and consistency.
+
 ## v0.9.1
 
   - Fix EOF behavior to match Ruby IO semantics: `read()` returns empty string `""` at EOF while `read(size)` returns `nil` at EOF.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-stream
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -44,6 +44,7 @@ extra_rdoc_files: []
 files:
 - lib/io/stream.rb
 - lib/io/stream/buffered.rb
+- lib/io/stream/connection_reset_error.rb
 - lib/io/stream/generic.rb
 - lib/io/stream/openssl.rb
 - lib/io/stream/readable.rb
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Provides a generic stream wrapper for IO instances.
 test_files: []