io-event 1.11.2 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c23033ceb02485410fbc8d330011826e9069a2d60cd0ca3483b575efe3d8c0e
-  data.tar.gz: 6c6af10647b050c564682dfe3023a92c935c048ecd14472ab13732d6c33967b9
+  metadata.gz: 80ad33ec3e92cfe141ff91e691370fbb9349f627997f59e130ad1bb016b68ac2
+  data.tar.gz: b2d5c4d46dead9a1b08bcb0ae6afc7a4f75972168501d7bb2bea04b58bf4bdf2
 SHA512:
-  metadata.gz: 7ded92b87ce6a9e74d87b7f6c8fc5de54ed6f913252897fe6c7d1bd478f990e5af1ffcf3003d250a2c5537e0c55926697f9d59ab09f8ba72650c3f2aa47cc1c7
-  data.tar.gz: 9e63f1bf68bfde30503297abd9122cddc8caa24e7480f3ba316863e3f51f2b238e966d67969b24f6ed17e645a989db2df527119b627d1db4469008a28158ba6e
+  metadata.gz: e97d58a391676389971aefb44228a74949ca68a2552810b1b67f0ee2737344fdc0d303068050aa22c7a8def39733fde20d1ceeab6772dd125c9d74bca534a436
+  data.tar.gz: 55fa3477e391ac2775dfe9f999f7545bbe3240b2811143ad665a785beb7ff38df6f813c2fa20f93c1901d039d4ffcd60c23576393f79ffdd792d3a830f4e06e9

data/agent.md

@@ -0,0 +1,47 @@
+# Agent
+
+## Context
+
+This section provides links to documentation from installed packages. It is automatically generated and may be updated by running `bake agent:context:install`.
+
+**Important:** Before performing any code, documentation, or analysis tasks, always read and apply the full content of any relevant documentation referenced in the following sections. These context files contain authoritative standards and best practices for documentation, code style, and project-specific workflows. **Do not proceed with any actions until you have read and incorporated the guidance from relevant context files.**
+
+### agent-context
+
+Install and manage context files from Ruby gems.
+
+#### [Usage Guide](.context/agent-context/usage.md)
+
+`agent-context` is a tool that helps you discover and install contextual information from Ruby gems for AI agents. Gems can provide additional documentation, examples, and guidance in a `context/` ...
+
+### decode
+
+Code analysis for documentation generation.
+
+#### [Getting Started with Decode](.context/decode/getting-started.md)
+
+The Decode gem provides programmatic access to Ruby code structure and metadata. It can parse Ruby files and extract definitions, comments, and documentation pragmas, enabling code analysis, docume...
+
+#### [Documentation Coverage](.context/decode/coverage.md)
+
+This guide explains how to test and monitor documentation coverage in your Ruby projects using the Decode gem's built-in bake tasks.
+
+#### [Ruby Documentation](.context/decode/ruby-documentation.md)
+
+This guide covers documentation practices and pragmas supported by the Decode gem for documenting Ruby code. These pragmas provide structured documentation that can be parsed and used to generate A...
+
+### sus
+
+A fast and scalable test runner.
+
+#### [Using Sus Testing Framework](.context/sus/usage.md)
+
+Sus is a modern Ruby testing framework that provides a clean, BDD-style syntax for writing tests. It's designed to be fast, simple, and expressive.
+
+#### [Mocking](.context/sus/mocking.md)
+
+There are two types of mocking in sus: `receive` and `mock`. The `receive` matcher is a subset of full mocking and is used to set expectations on method calls, while `mock` can be used to replace m...
+
+#### [Shared Test Behaviors and Fixtures](.context/sus/shared.md)
+
+Sus provides shared test contexts which can be used to define common behaviours or tests that can be reused across one or more test files.

data/ext/io/event/selector/selector.c

@@ -29,10 +29,7 @@ VALUE IO_Event_Selector_process_status_wait(rb_pid_t pid, int flags)
 int IO_Event_Selector_nonblock_set(int file_descriptor)
 {
 #ifdef _WIN32
-	u_long nonblock = 1;
-	ioctlsocket(file_descriptor, FIONBIO, &nonblock);
-	// Windows does not provide any way to know this, so we always restore it back to unset:
-	return 0;
+	rb_w32_set_nonblock(file_descriptor);
 #else
 	// Get the current mode:
 	int flags = fcntl(file_descriptor, F_GETFL, 0);
@@ -50,8 +47,6 @@ void IO_Event_Selector_nonblock_restore(int file_descriptor, int flags)
 {
 #ifdef _WIN32
 	// Yolo...
-	u_long nonblock = flags;
-	ioctlsocket(file_descriptor, FIONBIO, &nonblock);
 #else
 	// The flags didn't have O_NONBLOCK set, so it would have been set, so we need to restore it:
 	if (!(flags & O_NONBLOCK)) {

data/ext/io/event/worker_pool.c

@@ -336,19 +336,32 @@ static VALUE worker_pool_call(VALUE self, VALUE _blocking_operation) {
 	pthread_mutex_unlock(&pool->mutex);
 	
 	// Block the current fiber until work is completed:
-	int state;
+	int state = 0;
 	while (true) {
-		rb_protect(worker_pool_work_begin, (VALUE)&work, &state);
-
+		int current_state = 0;
+		rb_protect(worker_pool_work_begin, (VALUE)&work, &current_state);
+		if (DEBUG) fprintf(stderr, "-- worker_pool_call:work completed=%d, current_state=%d, state=%d\n", work.completed, current_state, state);
+		
+		// Store the first exception state:
+		if (!state) {
+			state = current_state;
+		}
+		
+		// If the work is still in the queue, we must wait for a worker to complete it (even if cancelled):
 		if (work.completed) {
+			// The work was completed, we can exit the loop:
 			break;
 		} else {
 			if (DEBUG) fprintf(stderr, "worker_pool_call:rb_fiber_scheduler_blocking_operation_cancel\n");
+			// Ensure the blocking operation is cancelled:
 			rb_fiber_scheduler_blocking_operation_cancel(blocking_operation);
-			// The work was not completed, we need to wait for it to be completed.
+			
+			// The work was not completed, we need to wait for it to be completed, so we go around the loop again.
 		}
 	}
 	
+	if (DEBUG) fprintf(stderr, "<- worker_pool_call:work completed=%d, state=%d\n", work.completed, state);
+	
 	if (state) {
 		rb_jump_tag(state);
 	} else {

data/lib/io/event/priority_heap.rb

@@ -82,7 +82,7 @@ class IO
 			# Validate the heap invariant. Every element except the root must not be smaller than its parent element. Note that it MAY be equal.
 			def valid?
 				# Notice we skip index 0 on purpose, because it has no parent
-				(1..(@contents.size - 1)).all? { |e| @contents[e] >= @contents[(e - 1) / 2] }
+				(1..(@contents.size - 1)).all? {|index| @contents[index] >= @contents[(index - 1) / 2]}
 			end
 			
 			private

data/lib/io/event/selector/select.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2024, by Samuel Williams.
+# Copyright, 2021-2025, by Samuel Williams.
 # Copyright, 2023, by Math Ieu.
 
 require_relative "../interrupt"
@@ -199,7 +199,7 @@ module IO::Event
 							result = Fiber.blocking{buffer.read(io, 0, offset)}
 							
 							if result < 0
-								if again?(result)
+								if length > 0 and again?(result)
 									self.io_wait(fiber, io, IO::READABLE)
 								else
 									return result
@@ -229,7 +229,7 @@ module IO::Event
 							result = Fiber.blocking{buffer.write(io, 0, offset)}
 							
 							if result < 0
-								if again?(result)
+								if length > 0 and again?(result)
 									self.io_wait(fiber, io, IO::READABLE)
 								else
 									return result
@@ -305,96 +305,14 @@ module IO::Event
 					
 					return total
 				end
-			elsif Support.fiber_scheduler_v1?
-				# Ruby <= 3.1, limited IO::Buffer support.
-				def io_read(fiber, _io, buffer, length, offset = 0)
-					# We need to avoid any internal buffering, so we use a duplicated IO object:
-					io = IO.for_fd(_io.fileno, autoclose: false)
-					
-					total = 0
-					
-					maximum_size = buffer.size - offset
-					while maximum_size > 0
-						case result = blocking{io.read_nonblock(maximum_size, exception: false)}
-						when :wait_readable
-							if length > 0
-								self.io_wait(fiber, io, IO::READABLE)
-							else
-								return EWOULDBLOCK
-							end
-						when :wait_writable
-							if length > 0
-								self.io_wait(fiber, io, IO::WRITABLE)
-							else
-								return EWOULDBLOCK
-							end
-						when nil
-							break
-						else
-							buffer.set_string(result, offset)
-							
-							size = result.bytesize
-							total += size
-							offset += size
-							break if size >= length
-							length -= size
-						end
-						
-						maximum_size = buffer.size - offset
-					end
-					
-					return total
-				rescue IOError => error
-					return -Errno::EBADF::Errno
-				rescue SystemCallError => error
-					return -error.errno
-				end
-				
-				def io_write(fiber, _io, buffer, length, offset = 0)
-					# We need to avoid any internal buffering, so we use a duplicated IO object:
-					io = IO.for_fd(_io.fileno, autoclose: false)
-					
-					total = 0
-					
-					maximum_size = buffer.size - offset
-					while maximum_size > 0
-						chunk = buffer.get_string(offset, maximum_size)
-						case result = blocking{io.write_nonblock(chunk, exception: false)}
-						when :wait_readable
-							if length > 0
-								self.io_wait(fiber, io, IO::READABLE)
-							else
-								return EWOULDBLOCK
-							end
-						when :wait_writable
-							if length > 0
-								self.io_wait(fiber, io, IO::WRITABLE)
-							else
-								return EWOULDBLOCK
-							end
-						else
-							total += result
-							offset += result
-							break if result >= length
-							length -= result
-						end
-						
-						maximum_size = buffer.size - offset
-					end
-					
-					return total
-				rescue IOError => error
-					return -Errno::EBADF::Errno
-				rescue SystemCallError => error
-					return -error.errno
-				end
-				
-				def blocking(&block)
-					fiber = Fiber.new(blocking: true, &block)
-					return fiber.resume(fiber)
-				end
 			end
 			
+			# Wait for a process to change state.
+			#
+			# @parameter fiber [Fiber] The fiber to resume after waiting.
+			# @parameter pid [Integer] The process ID to wait for.
+			# @parameter flags [Integer] Flags to pass to Process::Status.wait.
+			# @returns [Process::Status] The status of the waited process.
 			def process_wait(fiber, pid, flags)
 				Thread.new do
 					Process::Status.wait(pid, flags)
@@ -414,6 +332,10 @@ module IO::Event
 				end
 			end
 			
+			# Wait for IO events or a timeout.
+			#
+			# @parameter duration [Numeric | Nil] The maximum time to wait, or nil for no timeout.
+			# @returns [Integer] The number of ready IO objects.
 			def select(duration = nil)
 				if pop_ready
 					# If we have popped items from the ready list, they may influence the duration calculation, so we don't delay the event loop:

data/lib/io/event/support.rb

@@ -14,35 +14,28 @@ class IO
 				IO.const_defined?(:Buffer)
 			end
 			
-			# The basic fiber scheduler was introduced along side the IO::Buffer class.
-			#
-			# @returns [Boolean] Whether the IO::Buffer class is available.
-			#
-			# To be removed on 31 Mar 2025.
-			def self.fiber_scheduler_v1?
-				IO.const_defined?(:Buffer)
-			end
-			
 			# More advanced read/write methods and blocking controls were introduced in Ruby 3.2.
 			#
 			# To be removed on 31 Mar 2026.
 			def self.fiber_scheduler_v2?
-				# Some interface changes were back-ported incorrectly:
-				# https://github.com/ruby/ruby/pull/10778
-				# Specifically "Improvements to IO::Buffer read/write/pread/pwrite."
-				# Missing correct size calculation.
-				return false if RUBY_VERSION >= "3.2.5"
-				
-				IO.const_defined?(:Buffer) and Fiber.respond_to?(:blocking) and IO::Buffer.instance_method(:read).arity == -1
+				if RUBY_VERSION >= "3.2"
+					return true if RUBY_VERSION >= "3.2.6"
+					
+					# Some interface changes were back-ported incorrectly and released in 3.2.5 <https://github.com/ruby/ruby/pull/10778> - Specifically "Improvements to IO::Buffer read/write/pread/pwrite." is missing correct size calculation.
+					return false if RUBY_VERSION >= "3.2.5"
+					
+					# Feature detection:
+					IO.const_defined?(:Buffer) and Fiber.respond_to?(:blocking) and IO::Buffer.instance_method(:read).arity == -1
+				end
 			end
 			
 			# Updated inferfaces for read/write and IO::Buffer were introduced in Ruby 3.3, including pread/pwrite.
 			#
 			# To become the default 31 Mar 2026.
 			def self.fiber_scheduler_v3?
+				return true if RUBY_VERSION >= "3.3"
+				
 				if fiber_scheduler_v2?
-					return true if RUBY_VERSION >= "3.3"
-					
 					# Feature detection if required:
 					begin
 						IO::Buffer.new.slice(0, 0).write(STDOUT)

data/lib/io/event/version.rb

@@ -7,6 +7,6 @@
 class IO
 	# @namespace
 	module Event
-		VERSION = "1.11.2"
+		VERSION = "1.12.0"
 	end
 end

data/license.md

@@ -9,7 +9,7 @@ Copyright, 2022, by Bruno Sutic.
 Copyright, 2023, by Math Ieu.  
 Copyright, 2024, by Pavel Rosický.  
 Copyright, 2024, by Anthony Ross.  
-Copyright, 2024, by Shizuo Fujita.  
+Copyright, 2024-2025, by Shizuo Fujita.  
 Copyright, 2024, by Jean Boussier.  
 Copyright, 2025, by Stanislav (Stas) Katkov.  
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-event
 version: !ruby/object:Gem::Version
-  version: 1.11.2
+  version: 1.12.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -10,11 +10,11 @@ authors:
 - Jean Boussier
 - Benoit Daloze
 - Bruno Sutic
+- Shizuo Fujita
 - Alex Matchneer
 - Anthony Ross
 - Delton Ding
 - Pavel Rosický
-- Shizuo Fujita
 - Stanislav (Stas) Katkov
 bindir: bin
 cert_chain:
@@ -54,6 +54,7 @@ extensions:
 - ext/extconf.rb
 extra_rdoc_files: []
 files:
+- agent.md
 - design.md
 - ext/extconf.rb
 - ext/io/event/array.h
@@ -106,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: 3.2.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="