Modernize code.

ioquatix · ioquatix · commit 51c6cc7d9951 · 2025-12-08T02:04:16.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}}
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}}
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+/agents.md
+/.context
 /.bundle
 /pkg
 /gems.locked
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,10 +55,15 @@ Layout/DefEndAlignment:
 
 Layout/CaseIndentation:
   Enabled: true
+  EnforcedStyle: end
 
 Layout/CommentIndentation:
   Enabled: true
 
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
 Layout/EmptyLinesAroundClassBody:
   Enabled: true
 
diff --git a/examples/memory/leak.rb b/examples/memory/leak.rb
@@ -9,11 +9,11 @@
 
 Async do |task|
 	c = Async::Redis::Client.new
-
+	
 	10_000.times do |i|
 		c.ping "foo#{i}"
 	end
-
+	
 	available = c.instance_variable_get("@pool").instance_variable_get("@available")
 	puts "available size #{available.size}, unique #{available.uniq.size}"
 end
diff --git a/gems.rb b/gems.rb
@@ -19,7 +19,10 @@
 	gem "sus", "~> 0.15"
 	gem "covered"
 	gem "decode"
+	
 	gem "rubocop"
+	gem "rubocop-md"
+	gem "rubocop-socketry"
 	
 	gem "traces"
 	gem "sus-fixtures-async"
diff --git a/lib/async/pool/controller.rb b/lib/async/pool/controller.rb
@@ -232,13 +232,13 @@ def prune(retain = 0)
 			
 			# Retire a specific resource.
 			def retire(resource)
-				Console.debug(self) {"Retire #{resource}"}
+				Console.debug(self){"Retire #{resource}"}
 				
 				@resources.delete(resource)
 				
 				resource.close
 				
-				@mutex.synchronize {@condition.broadcast}
+				@mutex.synchronize{@condition.broadcast}
 				
 				return true
 			end
@@ -287,7 +287,7 @@ def availability_summary
 			# end
 			
 			def reuse(resource)
-				Console.debug(self) {"Reuse #{resource}"}
+				Console.debug(self){"Reuse #{resource}"}
 				
 				usage = @resources[resource]
 				
@@ -302,15 +302,15 @@ def reuse(resource)
 				
 				@resources[resource] = usage - 1
 				
-				@mutex.synchronize {@condition.broadcast}
+				@mutex.synchronize{@condition.broadcast}
 				
 				return true
 			end
 			
 			def wait_for_resource
 				# If we fail to create a resource (below), we will end up waiting for one to become resources.
 				until resource = available_resource
-					@mutex.synchronize {@condition.wait(@mutex)}
+					@mutex.synchronize{@condition.wait(@mutex)}
 				end
 				# Be careful not to context switch or fail here.
 				return resource
@@ -360,7 +360,7 @@ def acquire_existing_resource
 							return resource
 						end
 					end
-					@mutex.synchronize {@condition.wait(@mutex)}
+					@mutex.synchronize{@condition.wait(@mutex)}
 				end
 				# Only when the pool has been completely drained, return nil:
 				return nil
@@ -389,7 +389,7 @@ def acquire_or_create_resource
 				end
 				
 				if @limit.nil? or @resources.size < @limit
-					Console.debug(self) {"No available resources, allocating new one..."}
+					Console.debug(self){"No available resources, allocating new one..."}
 					
 					return create_resource
 				end
diff --git a/lib/traces/provider/async/pool/controller.rb b/lib/traces/provider/async/pool/controller.rb
@@ -13,7 +13,7 @@ def create_resource(...)
 		
 		attributes.merge!(@tags) if @tags
 		
-		Traces.trace("async.pool.create", attributes: attributes) {super}
+		Traces.trace("async.pool.create", attributes: attributes){super}
 	end
 	
 	def drain(...)
@@ -23,7 +23,7 @@ def drain(...)
 		
 		attributes.merge!(@tags) if @tags
 		
-		Traces.trace("async.pool.drain", attributes: attributes) {super}
+		Traces.trace("async.pool.drain", attributes: attributes){super}
 	end
 	
 	def acquire(...)
@@ -34,7 +34,7 @@ def acquire(...)
 		
 		attributes.merge!(@tags) if @tags
 		
-		Traces.trace("async.pool.acquire", attributes: attributes) {super}
+		Traces.trace("async.pool.acquire", attributes: attributes){super}
 	end
 	
 	def release(...)
@@ -44,7 +44,7 @@ def release(...)
 		
 		attributes.merge!(@tags) if @tags
 		
-		Traces.trace("async.pool.release", attributes: attributes) {super}
+		Traces.trace("async.pool.release", attributes: attributes){super}
 	end
 	
 	def retire(...)
@@ -54,6 +54,6 @@ def retire(...)
 		
 		attributes.merge!(@tags) if @tags
 		
-		Traces.trace("async.pool.retire", attributes: attributes) {super}
+		Traces.trace("async.pool.retire", attributes: attributes){super}
 	end
 end
diff --git a/test/async/pool/controller.rb b/test/async/pool/controller.rb
@@ -181,7 +181,7 @@
 			resource = pool.acquire
 			
 			mock(resource) do |mock|
-				mock.replace(:reusable?) {true}
+				mock.replace(:reusable?){true}
 			end
 			
 			pool.release(resource)
@@ -273,7 +273,7 @@
 					pool.acquire{}
 				end
 			end
-				
+			
 			pool.release(resource)
 			
 			pool.close
@@ -414,16 +414,16 @@ def failures(repeats: 500, time_scale: 0.001, &block)
 			resource = pool.acquire
 			waited = false
 			finished = false
-
+			
 			Async do
 				Async::Task.current.sleep(0.01)
 				pool.release(resource)
 			end
-
+			
 			pool.wait_until_free do
 				waited = true
 			end
-
+			
 			finished = true
 			expect(waited).to be == true
 			expect(finished).to be == true
diff --git a/test/async/pool/multiplex.rb b/test/async/pool/multiplex.rb
@@ -20,7 +20,7 @@
 		it "will put object in available list after one use" do
 			object = pool.acquire
 			mock(object) do |mock|
-				mock.replace(:reusable?) {true}
+				mock.replace(:reusable?){true}
 			end
 			
 			pool.release(object)
@@ -32,7 +32,7 @@
 		it "can acquire and release the same object up to the concurrency limit" do
 			object1 = pool.acquire
 			mock(object1) do |mock|
-				mock.replace(:reusable?) {true}
+				mock.replace(:reusable?){true}
 			end
 			
 			object2 = pool.acquire
@@ -53,7 +53,7 @@
 			object = pool.acquire
 			
 			mock(object) do |mock|
-				mock.replace(:reusable?) {false}
+				mock.replace(:reusable?){false}
 			end
 			
 			pool.release(object)
@@ -66,7 +66,7 @@
 		it "puts the item back into the available list if it is reusable" do
 			pool.acquire do |object|
 				mock(object) do |mock|
-					mock.replace(:reusable?) {true}
+					mock.replace(:reusable?){true}
 				end
 				
 				pool.prune

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+/agents.md`
	`2`	`+/.context`
`1`	`3`	`/.bundle`
`2`	`4`	`/pkg`
`3`	`5`	`/gems.locked`