Modernize code.

ioquatix · ioquatix · commit a3cb9682096f · 2025-11-19T23:15:34.000+13:00
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
@@ -0,0 +1,20 @@
+# GitHub Copilot Instructions
+
+## Use Agent Context
+
+When working on this project, consult the `agents.md` file for project-specific guidelines, architecture decisions, and development patterns. This file contains curated information that will help you make better decisions aligned with the project's goals and standards.
+
+If the file does not exist, you will need to install it, by running the following command:
+
+```bash
+$ bundle install
+$ bundle exec bake agent:context:install
+```
+
+This command will set up the necessary context files that help you understand the project structure, dependencies, and conventions.
+
+## Ignoring Files
+
+The `.gitignore` file is split into two sections, separated by a blank line. The first section is automatically generated, while the second section is user controlled.
+
+While working on pull requests, you should not add unrelated changes to the `.gitignore` file as part of the pull request.
diff --git a/.github/workflows/documentation-coverage.yaml b/.github/workflows/documentation-coverage.yaml
@@ -6,7 +6,6 @@ permissions:
   contents: read
 
 env:
-  CONSOLE_OUTPUT: XTerm
   COVERAGE: PartialSummary
 
 jobs:
@@ -17,7 +16,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.4"
+        ruby-version: ruby
         bundler-cache: true
     
     - name: Validate coverage
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -17,7 +17,6 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  CONSOLE_OUTPUT: XTerm
   BUNDLE_WITH: maintenance
 
 jobs:
@@ -29,7 +28,7 @@ jobs:
 
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.4"
+        ruby-version: ruby
         bundler-cache: true
     
     - name: Installing packages
diff --git a/.github/workflows/rubocop.yaml b/.github/workflows/rubocop.yaml
@@ -5,9 +5,6 @@ on: [push, pull_request]
 permissions:
   contents: read
 
-env:
-  CONSOLE_OUTPUT: XTerm
-
 jobs:
   check:
     runs-on: ubuntu-latest
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -6,7 +6,6 @@ permissions:
   contents: read
 
 env:
-  CONSOLE_OUTPUT: XTerm
   COVERAGE: PartialSummary
 
 jobs:
@@ -21,7 +20,7 @@ jobs:
           - macos
         
         ruby:
-          - "3.4"
+          - ruby
     
     steps:
     - uses: actions/checkout@v4
@@ -49,7 +48,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.4"
+        ruby-version: ruby
         bundler-cache: true
     
     - uses: actions/download-artifact@v4
diff --git a/.github/workflows/test-external.yaml b/.github/workflows/test-external.yaml
@@ -5,9 +5,6 @@ on: [push, pull_request]
 permissions:
   contents: read
 
-env:
-  CONSOLE_OUTPUT: XTerm
-
 jobs:
   test:
     name: ${{matrix.ruby}} on ${{matrix.os}}
@@ -20,7 +17,6 @@ jobs:
           - macos
         
         ruby:
-          - "3.1"
           - "3.2"
           - "3.3"
           - "3.4"
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -5,9 +5,6 @@ on: [push, pull_request]
 permissions:
   contents: read
 
-env:
-  CONSOLE_OUTPUT: XTerm
-
 jobs:
   test:
     name: ${{matrix.ruby}} on ${{matrix.os}}
@@ -21,7 +18,6 @@ jobs:
           - macos
         
         ruby:
-          - "3.1"
           - "3.2"
           - "3.3"
           - "3.4"
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,7 @@
-/.bundle/
-/pkg/
+/agents.md
+/.context
+/.bundle
+/pkg
 /gems.locked
 /.covered.db
 /external
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,6 +1,23 @@
+plugins:
+  - rubocop-md
+  - rubocop-socketry
+
 AllCops:
   DisabledByDefault: true
 
+# Socketry specific rules:
+
+Layout/ConsistentBlankLineIndentation:
+  Enabled: true
+
+Layout/BlockDelimiterSpacing:
+  Enabled: true
+
+Style/GlobalExceptionVariables:
+  Enabled: true
+
+# General Layout rules:
+
 Layout/IndentationStyle:
   Enabled: true
   EnforcedStyle: tabs
@@ -27,6 +44,9 @@ Layout/BeginEndAlignment:
   Enabled: true
   EnforcedStyleAlignWith: start_of_line
 
+Layout/RescueEnsureAlignment:
+  Enabled: true
+
 Layout/ElseAlignment:
   Enabled: true
 
@@ -35,16 +55,33 @@ Layout/DefEndAlignment:
 
 Layout/CaseIndentation:
   Enabled: true
+  EnforcedStyle: end
 
 Layout/CommentIndentation:
   Enabled: true
 
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
 Layout/EmptyLinesAroundClassBody:
   Enabled: true
 
 Layout/EmptyLinesAroundModuleBody:
   Enabled: true
 
+Layout/EmptyLineAfterMagicComment:
+   Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceAroundBlockParameters:
+  Enabled: true
+  EnforcedStyleInsidePipes: no_space
+
 Style/FrozenStringLiteralComment:
   Enabled: true
 
diff --git a/async-bus.gemspec b/async-bus.gemspec
@@ -16,12 +16,13 @@ Gem::Specification.new do |spec|
 	spec.homepage = "https://github.com/socketry/async-bus"
 	
 	spec.metadata = {
+		"documentation_uri" => "https://socketry.github.io/async-bus/",
 		"source_code_uri" => "https://github.com/socketry/async-bus.git",
 	}
 	
 	spec.files = Dir.glob(["{lib}/**/*", "*.md"], File::FNM_DOTMATCH, base: __dir__)
 	
-	spec.required_ruby_version = ">= 3.1"
+	spec.required_ruby_version = ">= 3.2"
 	
 	spec.add_dependency "async"
 	spec.add_dependency "io-endpoint"
diff --git a/bake.rb b/bake.rb
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+# Update the project documentation with the new version number.
+#
+# @parameter version [String] The new version number.
+def after_gem_release_version_increment(version)
+	context["releases:update"].call(version)
+	context["utopia:project:update"].call
+end
diff --git a/bake/async/bus.rb b/bake/async/bus.rb
@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
 
 def server
 	require "async"
diff --git a/fixtures/async/bus/a_server.rb b/fixtures/async/bus/a_server.rb
@@ -37,4 +37,4 @@ def after(error = nil)
 			let(:client) {Async::Bus::Client.new(endpoint)}
 		end
 	end
-end
+end
diff --git a/gems.rb b/gems.rb
@@ -19,7 +19,10 @@
 	gem "sus"
 	gem "covered"
 	gem "decode"
+	
 	gem "rubocop"
+	gem "rubocop-md"
+	gem "rubocop-socketry"
 	
 	gem "sus-fixtures-async"
 	
diff --git a/lib/async/bus/controller.rb b/lib/async/bus/controller.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2025, by Samuel Williams.
+# Copyright, 2025, by Samuel Williams.
 
 module Async
 	module Bus
diff --git a/lib/async/bus/protocol/connection.rb b/lib/async/bus/protocol/connection.rb
@@ -102,7 +102,7 @@ def object(name)
 				end
 				
 				private def finalize(name)
-					proc{@finalized << name}
+					proc {@finalized << name}
 				end
 				
 				def []=(name, object)
diff --git a/lib/async/bus/protocol/invoke.rb b/lib/async/bus/protocol/invoke.rb
@@ -46,8 +46,8 @@ def pack(packer)
 				def self.unpack(unpacker)
 					id = unpacker.read
 					name = unpacker.read
-					arguments = Array.new(unpacker.read) {unpacker.read}
-					options = Array.new(unpacker.read) {[unpacker.read, unpacker.read]}.to_h
+					arguments = Array.new(unpacker.read){unpacker.read}
+					options = Array.new(unpacker.read){[unpacker.read, unpacker.read]}.to_h
 					block_given = unpacker.read
 					
 					return self.new(id, name, arguments, options, block_given)
diff --git a/lib/async/bus/protocol/transaction.rb b/lib/async/bus/protocol/transaction.rb
@@ -12,7 +12,7 @@ class Transaction
 				def initialize(connection, id, timeout: nil)
 					@connection = connection
 					@id = id
-
+					
 					@timeout = timeout
 					
 					@received = Thread::Queue.new
@@ -49,7 +49,7 @@ def close
 				
 				# Invoke a remote procedure.
 				def invoke(name, arguments, options, &block)
-					Console.debug(self) {[name, arguments, options, block]}
+					Console.debug(self){[name, arguments, options, block]}
 					
 					self.write(Invoke.new(@id, name, arguments, options, block_given?))
 					
@@ -69,8 +69,8 @@ def invoke(name, arguments, options, &block)
 						end
 					end
 					
-				# ensure
-				# 	self.write(:close)
+					# ensure
+					# 	self.write(:close)
 				end
 				
 				# Accept a remote procedure invokation.
@@ -99,8 +99,8 @@ def accept(object, arguments, options, block_given)
 					self.write(Throw.new(@id, error.tag))
 				rescue => error
 					self.write(Error.new(@id, error))
-				# ensure
-				# 	self.write(:close)
+					# ensure
+					# 	self.write(:close)
 				end
 			end
 		end
diff --git a/lib/async/bus/protocol/wrapper.rb b/lib/async/bus/protocol/wrapper.rb
@@ -25,27 +25,27 @@ def initialize(bus, reference_types: [Controller])
 					# The order here matters.
 					
 					self.register_type(0x00, Invoke, recursive: true,
-						packer: ->(invoke, packer){invoke.pack(packer)},
-						unpacker: ->(unpacker){Invoke.unpack(unpacker)},
+						packer: ->(invoke, packer) {invoke.pack(packer)},
+						unpacker: ->(unpacker) {Invoke.unpack(unpacker)},
 					)
 					
 					[Return, Yield, Error, Next, Throw, Close].each_with_index do |klass, index|
 						self.register_type(0x01 + index, klass, recursive: true,
-							packer: ->(value, packer){value.pack(packer)},
-							unpacker: ->(unpacker){klass.unpack(unpacker)},
+							packer: ->(value, packer) {value.pack(packer)},
+							unpacker: ->(unpacker) {klass.unpack(unpacker)},
 						)
 					end
 					
 					# Reverse serialize proxies back into proxies:
 					# When a Proxy is received, create a proxy pointing back
 					self.register_type(0x10, Proxy,
-						packer: ->(proxy){proxy.__name__},
+						packer: ->(proxy) {proxy.__name__},
 						unpacker: @bus.method(:[]),
 					)
 					
 					self.register_type(0x11, Release, recursive: true,
-						packer: ->(release, packer){release.pack(packer)},
-						unpacker: ->(unpacker){Release.unpack(unpacker)},
+						packer: ->(release, packer) {release.pack(packer)},
+						unpacker: ->(unpacker) {Release.unpack(unpacker)},
 					)
 					
 					self.register_type(0x20, Symbol)
@@ -56,8 +56,8 @@ def initialize(bus, reference_types: [Controller])
 					)
 					
 					self.register_type(0x22, Class,
-						packer: ->(klass){klass.name},
-						unpacker: ->(name){Object.const_get(name)},
+						packer: ->(klass) {klass.name},
+						unpacker: ->(name) {Object.const_get(name)},
 					)
 					
 					# Serialize objects into proxies:
diff --git a/readme.md b/readme.md
diff --git a/releases.md b/releases.md
diff --git a/test/async/bus/controller.rb b/test/async/bus/controller.rb
diff --git a/test/async/bus/protocol/wrapper.rb b/test/async/bus/protocol/wrapper.rb
diff --git a/test/async/bus/server.rb b/test/async/bus/server.rb
