Modernize gem.

ioquatix · ioquatix · commit af33edc5f66a · 2025-12-19T22:49:13.000+13:00
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
@@ -2,7 +2,7 @@
 
 ## Use Agent Context
 
-When working on this project, consult the `agent.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.
+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:
 
diff --git a/.github/workflows/documentation-coverage.yaml b/.github/workflows/documentation-coverage.yaml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ruby
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
 
     - uses: ruby/setup-ruby@v1
       with:
@@ -39,7 +39,7 @@ jobs:
       run: bundle exec bake utopia:project:static --force no
     
     - name: Upload documentation artifact
-      uses: actions/upload-pages-artifact@v3
+      uses: actions/upload-pages-artifact@v4
       with:
         path: docs
   
diff --git a/.github/workflows/rubocop.yaml b/.github/workflows/rubocop.yaml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ruby
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -23,7 +23,7 @@ jobs:
           - ruby
     
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{matrix.ruby}}
@@ -33,7 +33,7 @@ jobs:
       timeout-minutes: 5
       run: bundle exec bake test
     
-    - uses: actions/upload-artifact@v4
+    - uses: actions/upload-artifact@v5
       with:
         include-hidden-files: true
         if-no-files-found: error
@@ -45,13 +45,13 @@ jobs:
     runs-on: ubuntu-latest
     
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ruby
         bundler-cache: true
     
-    - uses: actions/download-artifact@v4
+    - uses: actions/download-artifact@v6
     
     - name: Validate coverage
       timeout-minutes: 5
diff --git a/.github/workflows/test-external.yaml b/.github/workflows/test-external.yaml
@@ -22,7 +22,7 @@ jobs:
           - "3.4"
     
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{matrix.ruby}}
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -36,7 +36,7 @@ jobs:
             experimental: true
     
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{matrix.ruby}}
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-/agent.md
+/agents.md
 /.context
 /.bundle
 /pkg
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,12 +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
@@ -33,6 +44,9 @@ Layout/BeginEndAlignment:
   Enabled: true
   EnforcedStyleAlignWith: start_of_line
 
+Layout/RescueEnsureAlignment:
+  Enabled: true
+
 Layout/ElseAlignment:
   Enabled: true
 
@@ -41,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/bake.rb b/bake.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 # Update the project documentation with the new version number.
 #
diff --git a/context/shared.md b/context/shared.md
@@ -65,7 +65,7 @@ Require and use shared fixtures in your test files:
 
 ```ruby
 # test/my_gem/user_manager.rb
-require 'my_gem/a_user'
+require "my_gem/a_user"
 
 describe MyGem::UserManager do
 	it_behaves_like MyGem::AUser, "manager"
@@ -108,7 +108,7 @@ Use specific shared fixtures:
 
 ```ruby
 # test/my_gem/authorization.rb
-require 'my_gem/users'
+require "my_gem/users"
 
 describe MyGem::Authorization do
 	with "standard user" do
diff --git a/context/usage.md b/context/usage.md
@@ -33,7 +33,7 @@ Create `config/sus.rb`:
 # frozen_string_literal: true
 
 # Use the covered gem for test coverage reporting:
-require 'covered/sus'
+require "covered/sus"
 include Covered::Sus
 
 def before_tests(assertions, output: self.output)
@@ -248,9 +248,9 @@ expect(hash).to have_keys(key1: be == 1, "key2" => be == 2)
 
 ```ruby
 expect(user).to have_attributes(
-  name: be == "John",
-  age: be >= 18,
-  email: be(:include?, "@")
+	name: be == "John",
+	age: be >= 18,
+	email: be(:include?, "@")
 )
 ```
 
diff --git a/gems.rb b/gems.rb
@@ -22,6 +22,7 @@
 	gem "decode"
 	
 	gem "rubocop"
+	gem "rubocop-md"
 	gem "rubocop-socketry"
 	
 	gem "bake-test"
diff --git a/lib/sus/assertions.rb b/lib/sus/assertions.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.
 
 require_relative "output"
 require_relative "clock"
diff --git a/lib/sus/config.rb b/lib/sus/config.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2024, by Samuel Williams.
+# Copyright, 2022-2025, by Samuel Williams.
 
 require_relative "clock"
 require_relative "registry"
diff --git a/lib/sus/mock.rb b/lib/sus/mock.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022-2024, by Samuel Williams.
+# Copyright, 2022-2025, by Samuel Williams.
 
 require_relative "expect"
 
diff --git a/lib/sus/output/messages.rb b/lib/sus/output/messages.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 module Sus
 	# Styled output output.
diff --git a/lib/sus/output/null.rb b/lib/sus/output/null.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.
 
 require_relative "messages"
 
diff --git a/lib/sus/respond_to.rb b/lib/sus/respond_to.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2025, by Samuel Williams.
 
 module Sus
 	class RespondTo
diff --git a/test/sus/context.rb b/test/sus/context.rb
@@ -5,7 +5,7 @@
 
 Context = Sus::Shared("context") do
 	it "can define a nested example" do
-		instance.it("has an example") {}
+		instance.it("has an example"){}
 		
 		expect(instance.children).not.to be(:empty?)
 	end
diff --git a/test/sus/describe.rb b/test/sus/describe.rb
@@ -6,7 +6,7 @@
 describe Sus::Describe do
 	with "nested contexts" do
 		let(:context) do
-			Sus::Describe.build(self.class, "a test class") {}
+			Sus::Describe.build(self.class, "a test class"){}
 		end
 		
 		it "has a description" do
@@ -23,7 +23,7 @@
 	with "unique:" do
 		it "can be unique" do
 			base = Sus.base
-			with = base.with("test", unique: "test") {}
+			with = base.with("test", unique: "test"){}
 			expect(with.identity).to have_attributes(unique: be == "test")
 		end
 	end
diff --git a/test/sus/it.rb b/test/sus/it.rb
@@ -52,7 +52,7 @@ def after(error = nil)
 	with "unique:" do
 		it "can be unique" do
 			base = Sus.base
-			it = base.it("test", unique: "test") {}
+			it = base.it("test", unique: "test"){}
 			expect(it.identity).to have_attributes(unique: be == "test")
 		end
 	end
diff --git a/test/sus/mock.rb b/test/sus/mock.rb
@@ -46,7 +46,7 @@ def implementation(*arguments)
 	end
 	
 	it "can expect a method to be called and call a block" do
-		expect(interface).to receive(:implementation){|*arguments|
+		expect(interface).to receive(:implementation) {|*arguments|
 			"Called with arguments: #{arguments.first}"
 		}
 		
diff --git a/test/sus/with.rb b/test/sus/with.rb
@@ -6,7 +6,7 @@
 describe Sus::With do
 	with "nested contexts" do
 		let(:context) do
-			Sus::With.build(self.class, "a test variable", {}) {}
+			Sus::With.build(self.class, "a test variable", {}){}
 		end
 		
 		it "has a description" do
@@ -23,7 +23,7 @@
 	with "unique:" do
 		it "can be unique" do
 			base = Sus.base
-			with = base.with("test", unique: "test") {}
+			with = base.with("test", unique: "test"){}
 			expect(with.identity).to have_attributes(unique: be == "test")
 		end
 	end

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/agent.md`
	`1`	`+/agents.md`
`2`	`2`	`/.context`
`3`	`3`	`/.bundle`
`4`	`4`	`/pkg`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`# frozen_string_literal: true`
`2`	`2`
`3`	`3`	`# Released under the MIT License.`
`4`		`-# Copyright, 2024, by Samuel Williams.`
	`4`	`+# Copyright, 2024-2025, by Samuel Williams.`
`5`	`5`
`6`	`6`	`# Update the project documentation with the new version number.`
`7`	`7`	`#`