io-stream 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98127286e0bfcfd823b663adec90587de5148f282cdad684a684c5eb2a057595
-  data.tar.gz: 41e3f054780a65fdf41f83996281a1f2720712a55ba1582939a60beeb7101303
+  metadata.gz: 93cc26a0208cdfd7e20115522eeb3a51234834a5b6ce6670248c6bb85dd84e3c
+  data.tar.gz: bec8f1a9e90cb7fe37845d4acb96c0c8f1919d253662da476a169a29a27b33bf
 SHA512:
-  metadata.gz: 4144ccb9ff5d96ef0d8f7aa56bce33d92333809ce827d860f5b8e604cede4751674a070a4ac0df97dee348ab039f5aa1b25bf4f8f3c723809dd4fe7281bd44e4
-  data.tar.gz: 59de415924836ae327e5c3089f1b458ef46bc4152b4c97b54f55998a3075035608c68ff2cc30414ed2458c36537a1c0a0b3c6c8833a1eb448550da7ce00f29bf
+  metadata.gz: 865a0a1031f7c83bbd428675e970fd2421a42ae4e19cd22ccf2080678d4009c78add651212f1f69cada5ba07075e1411d39978f3f9cba721d291a56f266a71e8
+  data.tar.gz: 73ff08ba993904115d3158fe5e233cc6e0e9667c34614b4c1e4efae5873417a3cd8f08cb30ac58edace8cb118ee640afdef1f37aaa73677d2c4ca64f7bad82de

data/lib/io/stream/buffered.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2024, by Samuel Williams.
 
 require_relative 'generic'
 
@@ -41,6 +41,11 @@ module IO::Stream
 			super(...)
 			
 			@io = io
+			if io.respond_to?(:timeout)
+				@timeout = io.timeout
+			else
+				@timeout = nil
+			end
 		end
 		
 		attr :io
@@ -78,9 +83,9 @@ module IO::Stream
 				
 				case result
 				when :wait_readable
-					@io.wait_readable
+					@io.wait_readable(@io.timeout) or raise ::IO::TimeoutError, "read timeout"
 				when :wait_writable
-					@io.wait_writable
+					@io.wait_writable(@io.timeout) or raise ::IO::TimeoutError, "write timeout"
 				else
 					if result == buffer.bytesize
 						return
@@ -99,9 +104,9 @@ module IO::Stream
 				
 				case result
 				when :wait_readable
-					@io.wait_readable
+					@io.wait_readable(@io.timeout) or raise ::IO::TimeoutError, "read timeout"
 				when :wait_writable
-					@io.wait_writable
+					@io.wait_writable(@io.timeout) or raise ::IO::TimeoutError, "write timeout"
 				else
 					return result
 				end

data/lib/io/stream/generic.rb

@@ -5,8 +5,9 @@
 
 require_relative 'string_buffer'
 
-require_relative '../buffered'
-require_relative '../readable'
+require_relative 'shim/buffered'
+require_relative 'shim/readable'
+require_relative 'shim/timeout'
 
 require_relative 'openssl'
 

data/lib/io/stream/openssl.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
 require 'openssl'
 
 module OpenSSL
@@ -26,6 +31,18 @@ module OpenSSL
 					to_io.wait_writable(...)
 				end
 			end
+			
+			unless method_defined?(:timeout)
+				def timeout
+					to_io.timeout
+				end
+			end
+			
+			unless method_defined?(:timeout=)
+				def timeout=(value)
+					to_io.timeout = value
+				end
+			end
 		end
 	end
 end

data/lib/io/stream/shim/shim.md

@@ -0,0 +1,4 @@
+# Shims
+
+Several shims are included for compatibility.
+

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class IO
+	unless const_defined?(:TimeoutError)
+		# Compatibility shim.
+		class TimeoutError < IOError
+		end
+	end
+	
+	unless method_defined?(:timeout)
+		# Compatibility shim.
+		attr_accessor :timeout
+	end
+end

data/lib/io/stream/version.rb

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

data/lib/io/stream.rb

@@ -4,9 +4,17 @@
 # Copyright, 2023-2024, by Samuel Williams.
 
 require_relative 'stream/version'
-require_relative 'stream/buffered_stream'
+require_relative 'stream/buffered'
 
 class IO
 	module Stream
 	end
+	
+	def self.Stream(io)
+		if io.is_a?(Stream::Buffered)
+			io
+		else
+			Stream::Buffered.wrap(io)
+		end
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-stream
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -45,12 +45,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/io/buffered.rb
-- lib/io/readable.rb
 - lib/io/stream.rb
 - lib/io/stream/buffered.rb
 - lib/io/stream/generic.rb
 - lib/io/stream/openssl.rb
+- lib/io/stream/shim/buffered.rb
+- lib/io/stream/shim/readable.rb
+- lib/io/stream/shim/shim.md
+- lib/io/stream/shim/timeout.rb
 - lib/io/stream/string_buffer.rb
 - lib/io/stream/version.rb
 - license.md