io-stream 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93cc26a0208cdfd7e20115522eeb3a51234834a5b6ce6670248c6bb85dd84e3c
-  data.tar.gz: bec8f1a9e90cb7fe37845d4acb96c0c8f1919d253662da476a169a29a27b33bf
+  metadata.gz: fe1cb88a44b5750ca8841631a3031da7ff06004e21d5dccf319012f0a0f1151f
+  data.tar.gz: 30d66da77b2887c16024511e907a8b30fdf1b24c53ee548f3a9171b54ff45ee1
 SHA512:
-  metadata.gz: 865a0a1031f7c83bbd428675e970fd2421a42ae4e19cd22ccf2080678d4009c78add651212f1f69cada5ba07075e1411d39978f3f9cba721d291a56f266a71e8
-  data.tar.gz: 73ff08ba993904115d3158fe5e233cc6e0e9667c34614b4c1e4efae5873417a3cd8f08cb30ac58edace8cb118ee640afdef1f37aaa73677d2c4ca64f7bad82de
+  metadata.gz: e2ad4475b779c7c421fb7143fac491243790e210c12dac89d37e885753353c78d1305bd08144e12204a13d4c068c7cf16a9133462fe0a5f19a5eecd49e839fc7
+  data.tar.gz: edef464bbf54fdfd662850aca4b7fcc522caca32566a2201b2ee8c68460c5eff9ae67d5e645e255b2e60ba951b88d10703648393e65c4f1b58f12ccffc8cd6cb

data/lib/io/stream/buffered.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'generic'
+require_relative "generic"
 
 module IO::Stream
 	class Buffered < Generic
@@ -22,7 +22,7 @@ module IO::Stream
 		def self.wrap(io, **options)
 			if io.respond_to?(:buffered=)
 				io.buffered = false
-			else
+			elsif io.respond_to?(:sync=)
 				io.sync = true
 			end
 			
@@ -50,6 +50,10 @@ module IO::Stream
 		
 		attr :io
 		
+		def to_io
+			@io.to_io
+		end
+		
 		def closed?
 			@io.closed?
 		end
@@ -70,8 +74,15 @@ module IO::Stream
 		
 		protected
 		
-		def sysclose
-			@io.close
+		if RUBY_VERSION >= "3.3.0"
+			def sysclose
+				# https://bugs.ruby-lang.org/issues/20723
+				Thread.new{@io.close}.join
+			end
+		else
+			def sysclose
+				@io.close
+			end
 		end
 		
 		def syswrite(buffer)
@@ -111,6 +122,8 @@ module IO::Stream
 					return result
 				end
 			end
+		rescue Errno::EBADF
+			raise ::IOError, "stream closed"
 		end
 	end
 end

data/lib/io/stream/generic.rb

@@ -3,20 +3,20 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'string_buffer'
+require_relative "string_buffer"
 
-require_relative 'shim/buffered'
-require_relative 'shim/readable'
-require_relative 'shim/timeout'
+require_relative "shim/buffered"
+require_relative "shim/readable"
+require_relative "shim/timeout"
 
-require_relative 'openssl'
+require_relative "openssl"
 
 module IO::Stream
 	# The default block size for IO buffers. Defaults to 64KB (typical pipe buffer size).
-	BLOCK_SIZE = ENV.fetch('IO_STREAM_BLOCK_SIZE', 1024*64).to_i
+	BLOCK_SIZE = ENV.fetch("IO_STREAM_BLOCK_SIZE", 1024*64).to_i
 
 	# The maximum read size when appending to IO buffers. Defaults to 8MB.
-	MAXIMUM_READ_SIZE = ENV.fetch('IO_STREAM_MAXIMUM_READ_SIZE', BLOCK_SIZE * 128).to_i
+	MAXIMUM_READ_SIZE = ENV.fetch("IO_STREAM_MAXIMUM_READ_SIZE", BLOCK_SIZE * 128).to_i
 	
 	class Generic
 		def initialize(block_size: BLOCK_SIZE, maximum_read_size: MAXIMUM_READ_SIZE)
@@ -29,7 +29,6 @@ module IO::Stream
 			
 			@read_buffer = StringBuffer.new
 			@write_buffer = StringBuffer.new
-			@drain_buffer = StringBuffer.new
 			
 			# Used as destination buffer for underlying reads.
 			@input_buffer = StringBuffer.new
@@ -129,20 +128,21 @@ module IO::Stream
 			read_until(separator, **options)
 		end
 		
+		private def drain(buffer)
+			begin
+				syswrite(buffer)
+			ensure
+				# If the write operation fails, we still need to clear this buffer, and the data is essentially lost.
+				buffer.clear
+			end
+		end
+		
 		# Flushes buffered data to the stream.
 		def flush
 			return if @write_buffer.empty?
 			
 			@writing.synchronize do
-				# Flip the write buffer and drain buffer:
-				@write_buffer, @drain_buffer = @drain_buffer, @write_buffer
-				
-				begin
-					syswrite(@drain_buffer)
-				ensure
-					# If the write operation fails, we still need to clear this buffer, and the data is essentially lost.
-					@drain_buffer.clear
-				end
+				self.drain(@write_buffer)
 			end
 		end
 		
@@ -150,11 +150,15 @@ module IO::Stream
 		# buffer is flushed to the underlying `io`.
 		# @param string the string to write to the buffer.
 		# @return the number of bytes appended to the buffer.
-		def write(string)
-			@write_buffer << string
-			
-			if @write_buffer.bytesize >= @block_size
-				flush
+		def write(string, flush: false)
+			@writing.synchronize do
+				@write_buffer << string
+				
+				flush |= @write_buffer.bytesize >= @block_size
+				
+				if flush
+					self.drain(@write_buffer)
+				end
 			end
 			
 			return string.bytesize
@@ -168,11 +172,15 @@ module IO::Stream
 		end
 		
 		def puts(*arguments, separator: $/)
-			arguments.each do |argument|
-				@write_buffer << argument << separator
-			end
+			return if arguments.empty?
 			
-			flush
+			@writing.synchronize do
+				arguments.each do |argument|
+					@write_buffer << argument << separator
+				end
+				
+				self.drain(@write_buffer)
+			end
 		end
 		
 		def closed?
@@ -195,7 +203,7 @@ module IO::Stream
 			rescue
 				# We really can't do anything here unless we want #close to raise exceptions.
 			ensure
-				sysclose
+				self.sysclose
 			end
 		end
 		
@@ -266,13 +274,13 @@ module IO::Stream
 			
 			if @read_buffer.empty?
 				if sysread(size, @read_buffer)
-					# Console.logger.debug(self, name: "read") {@read_buffer.inspect}
+					# Console.info(self, name: "read") {@read_buffer.inspect}
 					return true
 				end
 			else
 				if chunk = sysread(size, @input_buffer)
 					@read_buffer << chunk
-					# Console.logger.debug(self, name: "read") {@read_buffer.inspect}
+					# Console.info(self, name: "read") {@read_buffer.inspect}
 					
 					return true
 				end

data/lib/io/stream/openssl.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'openssl'
+require "openssl"
 
 module OpenSSL
 	module SSL

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

@@ -15,7 +15,7 @@ unless IO.method_defined?(:buffered?, false)
 	end
 end
 
-require 'socket'
+require "socket"
 
 unless BasicSocket.method_defined?(:buffered?, false)
 	class BasicSocket
@@ -50,7 +50,7 @@ unless BasicSocket.method_defined?(:buffered?, false)
 	end
 end
 
-require 'stringio'
+require "stringio"
 
 unless StringIO.method_defined?(:buffered?, false)
 	class StringIO

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

@@ -12,7 +12,7 @@ class IO
 	end
 end
 
-require 'socket'
+require "socket"
 
 class BasicSocket
 	unless method_defined?(:readable?, false)
@@ -32,7 +32,7 @@ class BasicSocket
 	end
 end
 
-require 'stringio'
+require "stringio"
 
 class StringIO
 	unless method_defined?(:readable?, false)
@@ -42,7 +42,7 @@ class StringIO
 	end
 end
 
-require 'openssl'
+require "openssl"
 
 class OpenSSL::SSL::SSLSocket
 	unless method_defined?(:readable?, false)

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
 class IO
 	unless const_defined?(:TimeoutError)
 		# Compatibility shim.

data/lib/io/stream/version.rb

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

data/lib/io/stream.rb

@@ -3,8 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'stream/version'
-require_relative 'stream/buffered'
+require_relative "stream/version"
+require_relative "stream/buffered"
 
 class IO
 	module Stream

data/readme.md

@@ -20,11 +20,11 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.
 
 ## See Also
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-stream
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Provides a generic stream wrapper for IO instances.