io-stream 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259533ca29c9be8e0476777d9060a4aa6928fa856848396110b3f668628db636
-  data.tar.gz: ed074a9ff19c5f0f74223228d1bb9929ff7534f921c11e4adf34fe88c5f2824b
+  metadata.gz: 15a89f071ddff7b47577a25a20195cb1d246f9b7105af8ee605ae01e0d267923
+  data.tar.gz: c29039d3ab0d1e234733ddf38f1ddc4be40cbffa92b5f9b47ba1dc247e9ea357
 SHA512:
-  metadata.gz: f90e4bca685926a8cc28b21b65ddceea17fd8d3ba25ccefd6daf9095403ef7446c71b9afdfe57367faccf2ee46635bcf939e14f8ac36e9ebc6b9ee55bdafaada
-  data.tar.gz: f7aaa56fb744df8cd057412083ad63c707165e3e1c404397dfa447f2135f7d11fef6d0b855cf88c23d28346ba96c320bc9566e7395520889d89ea7b63ea4fd1c
+  metadata.gz: 90d91151a245677dd5e7b96c2942af1b85f16d2a59c64c981e0d3d256d4af0ce5cc81115bfeb3a1981f765695e4777a0e76caf9c8f3d8995bbba204ebce8d91e
+  data.tar.gz: e40408fa7e69bab982229290640cb0e9c7a4efb9bc39ac40003ef1fe698f1aac962cd10a7464b5b2643bf46dddf6697e26296209527d507a0d135f112bc4bbae

data/lib/io/buffered.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-unless IO.method_defined?(:buffered?)
+unless IO.method_defined?(:buffered?, false)
 	class IO
 		def buffered?
 			return !self.sync
@@ -17,16 +17,19 @@ end
 
 require 'socket'
 
-unless BasicSocket.method_defined?(:buffered?)
+unless BasicSocket.method_defined?(:buffered?, false)
 	class BasicSocket
-		# Is it likely that the socket is still connected?
-		# May return false positive, but won't return false negative.
+		def ip_protocol_tcp?
+			local_address = self.local_address
+			
+			return (local_address.afamily == ::Socket::AF_INET || local_address.afamily == ::Socket::AF_INET6) && local_address.socktype == ::Socket::SOCK_STREAM
+		end
+		
 		def buffered?
 			return false unless super
 			
-			case self.local_address.protocol
-			when IPPROTO_TCP
-				return !self.getsockopt(IPPROTO_TCP, TCP_NODELAY).bool
+			if ip_protocol_tcp?
+				return !self.getsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY).bool
 			else
 				return true
 			end
@@ -35,14 +38,13 @@ unless BasicSocket.method_defined?(:buffered?)
 		def buffered=(value)
 			super
 			
-			case self.local_address.socktype
-			when SOCK_STREAM
+			if ip_protocol_tcp?
 				# When buffered is set to true, TCP_NODELAY shold be disabled.
-				self.setsockopt(IPPROTO_TCP, TCP_NODELAY, value ? 0 : 1)
+				self.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, value ? 0 : 1)
 			end
-		rescue Errno::EINVAL
+		rescue ::Errno::EINVAL
 			# On Darwin, sometimes occurs when the connection is not yet fully formed. Empirically, TCP_NODELAY is enabled despite this result.
-		rescue Errno::EOPNOTSUPP
+		rescue ::Errno::EOPNOTSUPP
 			# Some platforms may simply not support the operation.
 		end
 	end
@@ -50,7 +52,7 @@ end
 
 require 'stringio'
 
-unless StringIO.method_defined?(:buffered?)
+unless StringIO.method_defined?(:buffered?, false)
 	class StringIO
 		def buffered?
 			return !self.sync

data/lib/io/readable.rb

@@ -4,7 +4,7 @@
 # Copyright, 2023-2024, by Samuel Williams.
 
 class IO
-	unless method_defined?(:readable?)
+	unless method_defined?(:readable?, false)
 		def readable?
 			# Do not call `eof?` here as it is not concurrency-safe and it can block.
 			!closed?
@@ -15,10 +15,10 @@ end
 require 'socket'
 
 class BasicSocket
-	unless method_defined?(:readable?)
+	unless method_defined?(:readable?, false)
 		def readable?
 			# If we can wait for the socket to become readable, we know that the socket may still be open.
-			result = self.recv_nonblock(1, MSG_PEEK, exception: false)
+			result = self.recv_nonblock(1, ::Socket::MSG_PEEK, exception: false)
 			
 			# No data was available - newer Ruby can return nil instead of empty string:
 			return false if result.nil?
@@ -35,7 +35,7 @@ end
 require 'stringio'
 
 class StringIO
-	unless method_defined?(:readable?)
+	unless method_defined?(:readable?, false)
 		def readable?
 			!eof?
 		end
@@ -45,7 +45,7 @@ end
 require 'openssl'
 
 class OpenSSL::SSL::SSLSocket
-	unless method_defined?(:readable?)
+	unless method_defined?(:readable?, false)
 		def readable?
 			to_io.readable?
 		end

data/lib/io/stream/buffered.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Samuel Williams.
+
+require_relative 'generic'
+
+module IO::Stream
+	class Buffered < Generic
+		def self.open(path, mode = "r+", **options)
+			stream = self.new(::File.open(path, mode), **options)
+			
+			return stream unless block_given?
+			
+			begin
+				yield stream
+			ensure
+				stream.close
+			end
+		end
+		
+		def self.wrap(io, **options)
+			if io.respond_to?(:buffered=)
+				io.buffered = false
+			end
+			
+			stream = self.new(io, **options)
+			
+			return stream unless block_given?
+			
+			begin
+				yield stream
+			ensure
+				stream.close
+			end
+		end
+		
+		def initialize(io, ...)
+			super(...)
+			
+			@io = io
+		end
+		
+		attr :io
+		
+		def closed?
+			@io.closed?
+		end
+		
+		def close_read
+			@io.close_read
+		end
+		
+		def close_write
+			super
+		ensure
+			@io.close_write
+		end
+		
+		def readable?
+			super && @io.readable?
+		end
+		
+		protected
+		
+		def sysclose
+			@io.close
+		end
+		
+		def syswrite(buffer)
+			@io.write(buffer)
+		end
+		
+		# Reads data from the underlying stream as efficiently as possible.
+		def sysread(size, buffer)
+			# Come on Ruby, why couldn't this just return `nil`? EOF is not exceptional. Every file has one.
+			while true
+				result = @io.read_nonblock(size, buffer, exception: false)
+				
+				case result
+				when :wait_readable
+					@io.wait_readable
+				when :wait_writable
+					@io.wait_writable
+				else
+					return result
+				end
+			end
+		end
+	end
+end

data/lib/io/stream/{buffered_stream.rb → generic.rb}

@@ -8,6 +8,8 @@ require_relative 'string_buffer'
 require_relative '../buffered'
 require_relative '../readable'
 
+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
@@ -15,32 +17,11 @@ module IO::Stream
 	# 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
 	
-	class BufferedStream
-		def self.open(path, mode = "r+", **options)
-			stream = self.new(File.open(path, mode), **options)
-			
-			return stream unless block_given?
-			
-			begin
-				yield stream
-			ensure
-				stream.close
-			end
-		end
-		
-		def self.wrap(io, **options)
-			if io.respond_to?(:buffered=)
-				io.buffered = false
-			end
-			
-			self.new(io, **options)
-		end
-		
-		def initialize(io, block_size: BLOCK_SIZE, maximum_read_size: MAXIMUM_READ_SIZE)
-			@io = io
+	class Generic
+		def initialize(block_size: BLOCK_SIZE, maximum_read_size: MAXIMUM_READ_SIZE)
 			@eof = false
 			
-			@writing = Thread::Mutex.new
+			@writing = ::Thread::Mutex.new
 			
 			@block_size = block_size
 			@maximum_read_size = maximum_read_size
@@ -53,9 +34,7 @@ module IO::Stream
 			@input_buffer = StringBuffer.new
 		end
 		
-		attr :io
-		
-		attr :block_size
+		attr_accessor :block_size
 		
 		# Reads `size` bytes from the stream. If size is not specified, read until end of file.
 		def read(size = nil)
@@ -101,7 +80,7 @@ module IO::Stream
 			raise exception, "encountered eof while reading data"
 		end
 		
-		# This is a compatibility shim for existing code:
+		# This is a compatibility shim for existing code that uses `readpartial`.
 		def readpartial(size = nil)
 			read_partial(size) or raise EOFError, "Encountered eof while reading data!"
 		end
@@ -158,7 +137,7 @@ module IO::Stream
 				@write_buffer, @drain_buffer = @drain_buffer, @write_buffer
 				
 				begin
-					@io.syswrite(@drain_buffer)
+					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
@@ -195,34 +174,27 @@ module IO::Stream
 			flush
 		end
 		
-		def connected?
-			@io.connected?
-		end
-		
 		def closed?
-			@io.closed?
+			false
 		end
 		
 		def close_read
-			@io.close_read
 		end
 		
 		def close_write
 			flush
-		ensure
-			@io.close_write
 		end
 		
 		# Best effort to flush any unwritten data, and then close the underling IO.
 		def close
-			return if @io.closed?
+			return if closed?
 			
 			begin
 				flush
 			rescue
 				# We really can't do anything here unless we want #close to raise exceptions.
 			ensure
-				@io.close
+				sysclose
 			end
 		end
 		
@@ -261,19 +233,26 @@ module IO::Stream
 			end
 			
 			# If the underlying stream is readable, we can read more data:
-			return @io.readable?
+			return !closed?
 		end
 		
-		private
+		protected
+		
+		def sysclose
+			raise NotImplementedError
+		end
+		
+		def syswrite(buffer)
+			raise NotImplementedError
+		end
 		
 		# Reads data from the underlying stream as efficiently as possible.
 		def sysread(size, buffer)
-			# Come on Ruby, why couldn't this just return `nil`? EOF is not exceptional. Every file has one.
-			@io.sysread(size, buffer)
-		rescue EOFError
-			return false
+			raise NotImplementedError
 		end
 		
+		private
+		
 		# Fills the buffer from the underlying stream.
 		def fill_read_buffer(size = @block_size)
 			# We impose a limit because the underlying `read` system call can fail if we request too much data in one go.

data/lib/io/stream/openssl.rb

@@ -0,0 +1,31 @@
+require 'openssl'
+
+module OpenSSL
+	module SSL
+		class SSLSocket
+			unless method_defined?(:close_read)
+				def close_read
+					# Ignored.
+				end
+			end
+			
+			unless method_defined?(:close_write)
+				def close_write
+					self.stop
+				end
+			end
+			
+			unless method_defined?(:wait_readable)
+				def wait_readable(...)
+					to_io.wait_readable(...)
+				end
+			end
+			
+			unless method_defined?(:wait_writable)
+				def wait_writable(...)
+					to_io.wait_writable(...)
+				end
+			end
+		end
+	end
+end

data/lib/io/stream/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-stream
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -48,7 +48,9 @@ files:
 - lib/io/buffered.rb
 - lib/io/readable.rb
 - lib/io/stream.rb
-- lib/io/stream/buffered_stream.rb
+- lib/io/stream/buffered.rb
+- lib/io/stream/generic.rb
+- lib/io/stream/openssl.rb
 - lib/io/stream/string_buffer.rb
 - lib/io/stream/version.rb
 - license.md