Modernize code.

ioquatix · ioquatix · commit 07b102b12225 · 2025-08-28T22:28:06.000+12: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 `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.
+
+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/
+/agent.md
+/.context
+/.bundle
+/pkg
 /gems.locked
 /.covered.db
 /external
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,6 +1,12 @@
+plugins:
+  - rubocop-socketry
+
 AllCops:
   DisabledByDefault: true
 
+Layout/ConsistentBlankLineIndentation:
+  Enabled: true
+
 Layout/IndentationStyle:
   Enabled: true
   EnforcedStyle: tabs
@@ -45,6 +51,18 @@ Layout/EmptyLinesAroundClassBody:
 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/bake.rb b/bake.rb
@@ -8,5 +8,5 @@
 # @parameter version [String] The new version number.
 def after_gem_release_version_increment(version)
 	context["releases:update"].call(version)
-	context["utopia:project:readme:update"].call
+	context["utopia:project:update"].call
 end
diff --git a/context/getting-started.md b/context/getting-started.md
@@ -0,0 +1,82 @@
+# Getting Started
+
+This guide explains how to use the `protocol-http2` gem to implement a basic HTTP/2 client.
+
+## Installation
+
+Add the gem to your project:
+
+``` bash
+$ bundle add protocol-http2
+```
+
+## Usage
+
+This gem provides a low-level implementation of the HTTP/2 protocol. It is designed to be used in conjunction with other libraries to provide a complete HTTP/2 client or server. However, it is straight forward to give examples of how to use the library directly.
+
+### Client
+
+Here is a basic HTTP/2 client:
+
+``` ruby
+require 'async'
+require 'async/io/stream'
+require 'async/http/endpoint'
+require 'protocol/http2/client'
+
+Async do
+	endpoint = Async::HTTP::Endpoint.parse("https://www.google.com/search?q=kittens")
+	
+	peer = endpoint.connect
+	
+	puts "Connected to #{peer.inspect}"
+	
+	# IO Buffering:
+	stream = Async::IO::Stream.new(peer)
+	
+	framer = Protocol::HTTP2::Framer.new(stream)
+	client = Protocol::HTTP2::Client.new(framer)
+	
+	puts "Sending connection preface..."
+	client.send_connection_preface
+	
+	puts "Creating stream..."
+	stream = client.create_stream
+	
+	headers = [
+		[":scheme", endpoint.scheme],
+		[":method", "GET"],
+		[":authority", "www.google.com"],
+		[":path", endpoint.path],
+		["accept", "*/*"],
+	]
+	
+	puts "Sending request on stream id=#{stream.id} state=#{stream.state}..."
+	stream.send_headers(headers, Protocol::HTTP2::END_STREAM)
+	
+	puts "Waiting for response..."
+	$count = 0
+	
+	def stream.process_headers(frame)
+		headers = super
+		puts "Got response headers: #{headers} (#{frame.end_stream?})"
+	end
+	
+	def stream.receive_data(frame)
+		data = super
+		
+		$count += data.scan(/kittens/).count
+		
+		puts "Got response data: #{data.bytesize}"
+	end
+	
+	until stream.closed?
+		frame = client.read_frame
+	end
+	
+	puts "Got #{$count} kittens!"
+	
+	puts "Closing client..."
+	client.close
+end
+```
diff --git a/context/index.yaml b/context/index.yaml
@@ -0,0 +1,12 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: A low level implementation of the HTTP/2 protocol.
+metadata:
+  documentation_uri: https://socketry.github.io/protocol-http2/
+  source_code_uri: https://github.com/socketry/protocol-http2.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to use the `protocol-http2` gem to implement
+    a basic HTTP/2 client.
diff --git a/examples/http2/requests.rb b/examples/http2/requests.rb
@@ -36,7 +36,7 @@
 			
 			puts "Sending request on stream id=#{stream.id} state=#{stream.state}..."
 			stream.send_headers(headers, Protocol::HTTP2::END_STREAM)
-		
+			
 			def stream.process_headers(frame)
 				headers = super
 				puts "Stream #{self.id}: Got response headers: #{headers} (#{frame.end_stream?})"
diff --git a/gems.rb b/gems.rb
@@ -12,14 +12,18 @@
 	gem "bake-gem"
 	gem "bake-releases"
 	
+	gem "agent-context"
+	
 	gem "utopia-project"
 end
 
 group "test" do
 	gem "sus"
 	gem "covered"
 	gem "decode"
+	
 	gem "rubocop"
+	gem "rubocop-socketry"
 	
 	gem "traces"
 	gem "metrics"
diff --git a/lib/protocol/http2/error.rb b/lib/protocol/http2/error.rb
@@ -57,7 +57,7 @@ class Error < HTTP::Error
 		# connection must be aborted.
 		class HandshakeError < Error
 		end
-
+		
 		# Raised by stream or connection handlers, results in GOAWAY frame
 		# which signals termination of the current connection. You *cannot*
 		# recover from this exception, or any exceptions subclassed from it.
diff --git a/lib/protocol/http2/version.rb b/lib/protocol/http2/version.rb
@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
+# @namespace
 module Protocol
+	# @namespace
 	module HTTP2
 		VERSION = "0.22.1"
 	end
diff --git a/protocol-http2.gemspec b/protocol-http2.gemspec
@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
 		"source_code_uri" => "https://github.com/socketry/protocol-http2.git",
 	}
 	
-	spec.files = Dir.glob(["{lib}/**/*", "*.md"], File::FNM_DOTMATCH, base: __dir__)
+	spec.files = Dir.glob(["{context,lib}/**/*", "*.md"], File::FNM_DOTMATCH, base: __dir__)
 	
-	spec.required_ruby_version = ">= 3.1"
+	spec.required_ruby_version = ">= 3.2"
 	
 	spec.add_dependency "protocol-hpack", "~> 1.4"
 	spec.add_dependency "protocol-http", "~> 0.47"
diff --git a/test/protocol/http2/connection.rb b/test/protocol/http2/connection.rb
diff --git a/test/protocol/http2/stream.rb b/test/protocol/http2/stream.rb
