io-event 1.6.5 → 1.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53b1f32affa83ac713eaaf8fba4b9a1c9d2f25421908759dde9b5adec11c498f
-  data.tar.gz: 6504222eab182d55f2b56ef91c4de9f301f509a69fff17f286c03f0ef0315786
+  metadata.gz: 853f198e7ea15ab8efd9f3c864a224af60e1c45342a226ce2768eb554b1a21bb
+  data.tar.gz: 8fd1da4d954a4c78072f78499b322d87fd354e22786b3858f909c91346e5f92e
 SHA512:
-  metadata.gz: ac5f863272fb2a532d1adbe16e2960f78dd6f4ce52891e391f301d40bb28ad74e2775348d55610f1f308f7a69b0b362e93f794b44fe94b4ec6e91331a2e851d5
-  data.tar.gz: 042a1a3ba4ec1a3e438d823b9d9348eeebc86be2464030744a9a01ff50654aeeb229fb79729083d3f1bdb2feb968dcee8ec320d33de7083196eb1afd887c5ef6
+  metadata.gz: 25ea52c93eabc794db7abb8a91eb8b7311dd81eaf0bc725d67a3a553e8591df108b71a49ca3947aa3ed4a69d5e7f0247e1ffd24e0a93c54fbd2f90fc09688c13
+  data.tar.gz: 69937d7849c3c3ea9fd1b657dc5184f1921a44d7f51d8184ded13112ab57a5511bebbf2e40c5acd9b06e393c8e43041a3f0feedb2c4eb70230f330a280ffe125

data/ext/extconf.rb

@@ -2,46 +2,50 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 # Copyright, 2023, by Math Ieu.
 
 return if RUBY_DESCRIPTION =~ /jruby/
 
-require 'mkmf'
+require "mkmf"
 
 gem_name = File.basename(__dir__)
-extension_name = 'IO_Event'
+extension_name = "IO_Event"
 
 # dir_config(extension_name)
 
 $CFLAGS << " -Wall -Wno-unknown-pragmas -std=c99"
 
-if ENV.key?('RUBY_DEBUG')
+if ENV.key?("RUBY_DEBUG")
 	$CFLAGS << " -DRUBY_DEBUG -O0"
+	
+	# Add address and undefined behaviour sanitizers:
+	$CFLAGS << " -fsanitize=undefined -fno-omit-frame-pointer"
+	$LDFLAGS << " -fsanitize=undefined"
 end
 
 $srcs = ["io/event/event.c", "io/event/selector/selector.c"]
 $VPATH << "$(srcdir)/io/event"
 $VPATH << "$(srcdir)/io/event/selector"
 
-have_func('rb_ext_ractor_safe')
-have_func('&rb_fiber_transfer')
+have_func("rb_ext_ractor_safe")
+have_func("&rb_fiber_transfer")
 
-if have_library('uring') and have_header('liburing.h')
+if have_library("uring") and have_header("liburing.h")
 	$srcs << "io/event/selector/uring.c"
 end
 
-if have_header('sys/epoll.h')
+if have_header("sys/epoll.h")
 	$srcs << "io/event/selector/epoll.c"
 end
 
-if have_header('sys/event.h')
+if have_header("sys/event.h")
 	$srcs << "io/event/selector/kqueue.c"
 end
 
-have_header('sys/wait.h')
+have_header("sys/wait.h")
 
-have_header('sys/eventfd.h')
+have_header("sys/eventfd.h")
 $srcs << "io/event/interrupt.c"
 
 have_func("rb_io_descriptor")
@@ -50,7 +54,7 @@ have_func("rb_fiber_current")
 have_func("&rb_fiber_raise")
 have_func("epoll_pwait2")
 
-have_header('ruby/io/buffer.h')
+have_header("ruby/io/buffer.h")
 
 create_header
 

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

@@ -180,9 +180,15 @@ static void queue_pop(struct IO_Event_Selector *backend, struct IO_Event_Selecto
 	} else {
 		backend->ready = waiting->head;
 	}
+	
+	waiting->head = NULL;
+	waiting->tail = NULL;
 }
 
 static void queue_push(struct IO_Event_Selector *backend, struct IO_Event_Selector_Queue *waiting) {
+	assert(waiting->head == NULL);
+	assert(waiting->tail == NULL);
+	
 	if (backend->waiting) {
 		backend->waiting->head = waiting;
 		waiting->tail = backend->waiting;
@@ -283,6 +289,7 @@ static inline
 void IO_Event_Selector_queue_pop(struct IO_Event_Selector *backend, struct IO_Event_Selector_Queue *ready)
 {
 	if (DEBUG) fprintf(stderr, "IO_Event_Selector_queue_pop -> %p\n", (void*)ready->fiber);
+	
 	if (ready->flags & IO_EVENT_SELECTOR_QUEUE_FIBER) {
 		IO_Event_Selector_fiber_transfer(ready->fiber, 0, NULL);
 	} else {

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

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative '../support'
+require_relative "../support"
 
 module IO::Event
 	module Debug
@@ -12,8 +12,8 @@ module IO::Event
 			def self.wrap(selector, env = ENV)
 				log = nil
 				
-				if log_path = env['IO_EVENT_DEBUG_SELECTOR_LOG']
-					log = File.open(log_path, 'w')
+				if log_path = env["IO_EVENT_DEBUG_SELECTOR_LOG"]
+					log = File.open(log_path, "w")
 				end
 				
 				return self.new(selector, log: log)

data/lib/io/event/interrupt.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2023, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 module IO::Event
 	# A thread safe synchronisation primative.
@@ -27,7 +27,7 @@ module IO::Event
 		
 		# Send a sigle byte interrupt.
 		def signal
-			@output.write('.')
+			@output.write(".")
 			@output.flush
 		rescue IOError
 			# Ignore.

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
-require 'io/nonblock'
+require "io/nonblock"
 
 module IO::Event
 	module Selector

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

@@ -4,8 +4,8 @@
 # Copyright, 2021-2024, by Samuel Williams.
 # Copyright, 2023, by Math Ieu.
 
-require_relative '../interrupt'
-require_relative '../support'
+require_relative "../interrupt"
+require_relative "../support"
 
 module IO::Event
 	module Selector
@@ -168,6 +168,8 @@ module IO::Event
 			if Support.fiber_scheduler_v3?
 				# Ruby 3.3+, full IO::Buffer support.
 				
+				# Read from the given IO to the buffer.
+				#
 				# @parameter length [Integer] The minimum number of bytes to read.
 				# @parameter offset [Integer] The offset into the buffer to read to.
 				def io_read(fiber, io, buffer, length, offset = 0)
@@ -196,6 +198,8 @@ module IO::Event
 					return total
 				end
 				
+				# Write to the given IO from the buffer.
+				#
 				# @parameter length [Integer] The minimum number of bytes to write.
 				# @parameter offset [Integer] The offset into the buffer to write from.
 				def io_write(fiber, io, buffer, length, offset = 0)

data/lib/io/event/selector.rb

@@ -3,14 +3,14 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'selector/select'
-require_relative 'debug/selector'
-require_relative 'support'
+require_relative "selector/select"
+require_relative "debug/selector"
+require_relative "support"
 
 module IO::Event
 	module Selector
 		def self.default(env = ENV)
-			if name = env['IO_EVENT_SELECTOR']&.to_sym
+			if name = env["IO_EVENT_SELECTOR"]&.to_sym
 				return const_get(name)
 			end
 			
@@ -28,7 +28,7 @@ module IO::Event
 		def self.new(loop, env = ENV)
 			selector = default(env).new(loop)
 			
-			if debug = env['IO_EVENT_DEBUG_SELECTOR']
+			if debug = env["IO_EVENT_DEBUG_SELECTOR"]
 				selector = Debug::Selector.wrap(selector, env)
 			end
 			

data/lib/io/event/support.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2023, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 class IO
 	module Event
@@ -10,14 +10,23 @@ class IO
 				IO.const_defined?(:Buffer)
 			end
 			
+			# To be removed on 31 Mar 2025.
 			def self.fiber_scheduler_v1?
-				IO.const_defined?(:Buffer) and !Fiber.respond_to?(:blocking)
+				IO.const_defined?(:Buffer)
 			end
 			
+			# 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
 			end
 			
+			# To become the default 31 Mar 2026.
 			def self.fiber_scheduler_v3?
 				if fiber_scheduler_v2?
 					return true if RUBY_VERSION >= "3.3"

data/lib/io/event/timers.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'priority_heap'
+require_relative "priority_heap"
 
 class IO
 	module Event

data/lib/io/event/version.rb

@@ -5,6 +5,6 @@
 
 class IO
 	module Event
-		VERSION = "1.6.5"
+		VERSION = "1.6.6"
 	end
 end

data/lib/io/event.rb

@@ -3,13 +3,13 @@
 # Released under the MIT License.
 # Copyright, 2021-2024, by Samuel Williams.
 
-require_relative 'event/version'
-require_relative 'event/selector'
-require_relative 'event/timers'
+require_relative "event/version"
+require_relative "event/selector"
+require_relative "event/timers"
 
 begin
-	require 'IO_Event'
+	require "IO_Event"
 rescue LoadError => error
 	warn "Could not load native event selector: #{error}"
-	require_relative 'event/selector/nonblock'
+	require_relative "event/selector/nonblock"
 end

data/license.md

@@ -8,6 +8,7 @@ Copyright, 2022, by Alex Matchneer.
 Copyright, 2022, by Bruno Sutic.  
 Copyright, 2023, by Math Ieu.  
 Copyright, 2024, by Pavel Rosický.  
+Copyright, 2024, by Anthony Ross.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -24,8 +24,8 @@ 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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-event
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.6.6
 platform: ruby
 authors:
 - Samuel Williams
@@ -10,6 +10,7 @@ authors:
 - Benoit Daloze
 - Bruno Sutic
 - Alex Matchneer
+- Anthony Ross
 - Delton Ding
 - Pavel Rosický
 autorequire:
@@ -44,7 +45,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -85,7 +86,9 @@ files:
 homepage: https://github.com/socketry/io-event
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/io-event/
+  source_code_uri: https://github.com/socketry/io-event.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -101,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: An event loop.