io-stream 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 108295b1d28ce05e7c9e9e3f7b3d26427f564a85527a9f23a24ad5b47a261dea
-  data.tar.gz: 2aa1c2f6d600d38667e5030122aecd1faa97f81be44695edf6776dda541d5a89
+  metadata.gz: c9a2897049a042fc1a0ba9a45d3f5700375938c6983d2ad2752f68c98b187b0c
+  data.tar.gz: 7991aaf45961ca5ec63254a1f83dffa5af87a1b4950aa0d0484ea4d23b55f7f0
 SHA512:
-  metadata.gz: c6c9fc15b84c0ef6d58e2400aeebaac0a36fd67f656dcf10e2f4a1dde2176434dc8f9464809f2b5c05af2563c8bcb1a74ef1e243b7263348d36d24f00df2af7c
-  data.tar.gz: 92c3a90776a6f6308ab7d0fa25d35b7df65021f70cb8aadf01e7363961c818392c2ce3fe861b20b38965acebcca851e7419708ad18b2536ae892496b9ea39ade
+  metadata.gz: ee85bb6dd18c0281d3dbe0d3af1a8cb5379834e40666e0a77c813a372f05dea8dda255a29c0196517ca978860f0032ee15bfec89cfb8770c1a24416acfc1d189
+  data.tar.gz: 399269a7444a2763b7ef82f2dacc2954aa06e82e3859a88411f7291f6afc98949d93a5b2936fdc8a0d493df3c38ee216b40e9055017f8c9f6c5dd95fcfc6116c

data/lib/io/stream/readable.rb

@@ -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
@@ -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,9 +80,20 @@ 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
+				
+				if buffer
+					buffer.replace(@read_buffer)
+					@read_buffer.clear
+				else
+					buffer = @read_buffer
+					@read_buffer = StringBuffer.new
+				end
+				
+				# Read without size always returns a non-nil value, even if it is an empty string.
+				return buffer
 			end
 			
 			return consume_read_buffer(size, buffer)
@@ -103,7 +114,7 @@ module IO::Stream
 				end
 			end
 		
-			if !@done and @read_buffer.empty?
+			if !@finished and @read_buffer.empty?
 				fill_read_buffer
 			end
 			
@@ -123,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`.
@@ -131,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.
@@ -211,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
 					
@@ -220,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
@@ -276,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
 			
@@ -347,7 +358,7 @@ module IO::Stream
 			end
 			
 			# else for both cases above:
-			@done = true
+			@finished = true
 			return false
 		end
 		
@@ -356,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/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2023-2024, by Samuel Williams.
 
 module IO::Stream
-	VERSION = "0.9.0"
+	VERSION = "0.10.0"
 end

data/readme.md

@@ -12,6 +12,14 @@ 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.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.
+
 ### v0.9.0
 
   - Add support for `buffer` parameter in `read`, `read_exactly`, and `read_partial` methods to allow reading into a provided buffer.
@@ -51,17 +59,6 @@ Please see the [project releases](https://socketry.github.io/io-streamreleases/i
   - 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.
-
-### v0.4.0
-
-  - Add convenient `IO.Stream()` constructor method for creating buffered streams.
-
 ## See Also
 
   - [async-io](https://github.com/socketry/async-io) — Where this implementation originally came from.

data/releases.md

@@ -1,5 +1,13 @@
 # Releases
 
+## 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.
+
 ## v0.9.0
 
   - Add support for `buffer` parameter in `read`, `read_exactly`, and `read_partial` methods to allow reading into a provided buffer.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-stream
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Samuel Williams