Modernize gem.

Author: ioquatix

.github/workflows/documentation-coverage.yaml

@@ -17,7 +17,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.3"
+        ruby-version: "3.4"
         bundler-cache: true
 
     - name: Validate coverage

.github/workflows/documentation.yaml

@@ -29,7 +29,7 @@ jobs:
 
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.3"
+        ruby-version: "3.4"
         bundler-cache: true
 
     - name: Installing packages

.github/workflows/rubocop.yaml

@@ -1,4 +1,4 @@
-name: Test External
+name: RuboCop
 
 on: [push, pull_request]
 
@@ -9,26 +9,14 @@ env:
   CONSOLE_OUTPUT: XTerm
 
 jobs:
-  test:
-    name: ${{matrix.ruby}} on ${{matrix.os}}
-    runs-on: ${{matrix.os}}-latest
-    
-    strategy:
-      matrix:
-        os:
-          - ubuntu
-          - macos
-        
-        ruby:
-          - "3.1"
-          - "3.2"
-          - "3.3"
+  check:
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{matrix.ruby}}
+        ruby-version: ruby
         bundler-cache: true
 
     - name: Run RuboCop

.github/workflows/test-coverage.yaml

@@ -21,7 +21,7 @@ jobs:
           - macos
 
         ruby:
-          - "3.3"
+          - "3.4"
 
     steps:
     - uses: actions/checkout@v4
@@ -33,9 +33,11 @@ jobs:
     - name: Run tests
       timeout-minutes: 5
       run: bundle exec bake test
-
-    - uses: actions/upload-artifact@v3
+    
+    - uses: actions/upload-artifact@v4
       with:
+        include-hidden-files: true
+        if-no-files-found: error
         name: coverage-${{matrix.os}}-${{matrix.ruby}}
         path: .covered.db
 
@@ -47,10 +49,10 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.3"
+        ruby-version: "3.4"
         bundler-cache: true
 
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
 
     - name: Validate coverage
       timeout-minutes: 5

.github/workflows/test-external.yaml

@@ -23,6 +23,7 @@ jobs:
           - "3.1"
           - "3.2"
           - "3.3"
+          - "3.4"
 
     steps:
     - uses: actions/checkout@v4

.github/workflows/test.yaml

@@ -24,6 +24,7 @@ jobs:
           - "3.1"
           - "3.2"
           - "3.3"
+          - "3.4"
 
         experimental: [false]
 

.rubocop.yml

@@ -16,6 +16,9 @@ Layout/IndentationConsistency:
   Enabled: true
   EnforcedStyle: normal
 
+Layout/BlockAlignment:
+  Enabled: true
+
 Layout/EndAlignment:
   Enabled: true
   EnforcedStyleAlignWith: start_of_line
@@ -44,3 +47,7 @@ Layout/EmptyLinesAroundModuleBody:
 
 Style/FrozenStringLiteralComment:
   Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

async-http-cache.gemspec

@@ -10,16 +10,16 @@ Gem::Specification.new do |spec|
 	spec.authors = ["Samuel Williams", "Colin Kelley", "Olle Jonsson"]
 	spec.license = "MIT"
 
-	spec.cert_chain  = ['release.cert']
-	spec.signing_key = File.expand_path('~/.gem/release.pem')
+	spec.cert_chain  = ["release.cert"]
+	spec.signing_key = File.expand_path("~/.gem/release.pem")
 
 	spec.homepage = "https://github.com/socketry/async-http-cache"
 
 	spec.metadata = {
 		"source_code_uri" => "https://github.com/socketry/async-http-cache.git",
 	}
 
-	spec.files = Dir.glob(['{lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__)
+	spec.files = Dir.glob(["{lib}/**/*", "*.md"], File::FNM_DOTMATCH, base: __dir__)
 
 	spec.required_ruby_version = ">= 3.1"
 

fixtures/async/http/cache/a_general_cache.rb

@@ -4,7 +4,7 @@
 # Copyright, 2020-2024, by Samuel Williams.
 # Copyright, 2022, by Colin Kelley.
 
-require 'async/http/cache/general'
+require "async/http/cache/general"
 
 module Async::HTTP::Cache
 	AGeneralCache = Sus::Shared("a general cache") do
@@ -50,13 +50,13 @@ module Async::HTTP::Cache
 			expect(cache).to have_attributes(count: be == 0)
 		end
 
-		with 'varied response' do
+		with "varied response" do
 			let(:app) do
 				Protocol::HTTP::Middleware.for do |request|
-					response = if user_agent = request.headers['user-agent']
-						Protocol::HTTP::Response[200, [['cache-control', 'max-age=1, public'], ['vary', 'user-agent']], [user_agent]]
+					response = if user_agent = request.headers["user-agent"]
+						Protocol::HTTP::Response[200, [["cache-control", "max-age=1, public"], ["vary", "user-agent"]], [user_agent]]
 					else
-						Protocol::HTTP::Response[200, [['cache-control', 'max-age=1, public'], ['vary', 'user-agent']], ['Hello', ' ', 'World']]
+						Protocol::HTTP::Response[200, [["cache-control", "max-age=1, public"], ["vary", "user-agent"]], ["Hello", " ", "World"]]
 					end
 
 					if request.head?
@@ -68,15 +68,15 @@ module Async::HTTP::Cache
 			end
 
 			let(:user_agents) {[
-				'test-a',
-				'test-b',
+				"test-a",
+				"test-b",
 			]}
 
 			it "should cache GET requests" do
 				2.times do
 					user_agents.each do |user_agent|
-						response = client.get("/", {'user-agent' => user_agent})
-						expect(response.headers['vary']).to be(:include?, 'user-agent')
+						response = client.get("/", {"user-agent" => user_agent})
+						expect(response.headers["vary"]).to be(:include?, "user-agent")
 						expect(response.read).to be == user_agent
 					end
 				end
@@ -85,24 +85,24 @@ module Async::HTTP::Cache
 			end
 		end
 
-		with 'cache writes' do
-			with 'response code' do
+		with "cache writes" do
+			with "response code" do
 				let(:app) do
 					Protocol::HTTP::Middleware.for do |_request|
-						Protocol::HTTP::Response[response_code, [], ['body']]
+						Protocol::HTTP::Response[response_code, [], ["body"]]
 					end
 				end
 
 				[200, 203, 300, 301, 302, 404, 410].each do |response_code|
 					with "cacheable response code #{response_code}", unique: "status-#{response_code}" do
 						let(:response_code) {response_code}
 
-						it 'is cached' do
+						it "is cached" do
 							responses = 2.times.map {client.get("/", {}).tap(&:finish)}
 							headers = responses.map {|r| r.headers.to_h}
 
-							expect(headers.first).not.to be(:include?, 'x-cache')
-							expect(headers.last).to have_keys('x-cache' => be == ['hit'])
+							expect(headers.first).not.to be(:include?, "x-cache")
+							expect(headers.last).to have_keys("x-cache" => be == ["hit"])
 						end
 					end
 				end
@@ -111,7 +111,7 @@ module Async::HTTP::Cache
 					with "not cacheable response code #{response_code}", unique: "status-#{response_code}" do
 						let(:response_code) {response_code}
 
-						it 'is not cached' do
+						it "is not cached" do
 							responses = 2.times.map {client.get("/", {}).tap(&:finish)}
 							response_headers = responses.map {|r| r.headers.to_h}
 
@@ -121,19 +121,19 @@ module Async::HTTP::Cache
 				end
 			end
 
-			with 'by cache-control: flag' do
+			with "by cache-control: flag" do
 				let(:app) do
 					Protocol::HTTP::Middleware.for do |_request|
 						Protocol::HTTP::Response[200, headers] # no body?
 					end
 				end
 
-				['no-store', 'private'].each do |flag|
-					let(:headers) {[['cache-control', flag]]}
+				["no-store", "private"].each do |flag|
+					let(:headers) {[["cache-control", flag]]}
 					let(:headers_hash) {Hash[headers.map {|k, v| [k, [v]]}]}
 
 					with "not cacheable response #{flag}", unique: flag do
-						it 'is not cached' do
+						it "is not cached" do
 							responses = 2.times.map {client.get("/", {}).tap(&:finish)}
 							response_headers = responses.map {|r| r.headers.to_h}
 
@@ -142,10 +142,10 @@ module Async::HTTP::Cache
 					end
 				end
 
-				with 'cacheable response' do
+				with "cacheable response" do
 					let(:headers) {[]}
 
-					it 'is cached' do
+					it "is cached" do
 						responses = 2.times.map {client.get("/", {}).tap(&:finish)}
 						headers = responses.map {|r| r.headers.to_h}
 
@@ -155,17 +155,17 @@ module Async::HTTP::Cache
 			end
 		end
 
-		with 'if-none-match' do
-			it 'validate etag' do
+		with "if-none-match" do
+			it "validate etag" do
 				# First, warm up the cache:
 				response = client.get("/")
-				expect(response.headers).not.to be(:include?, 'etag')
+				expect(response.headers).not.to be(:include?, "etag")
 				expect(response.read).to be == "Hello World"
-				expect(response.headers).to be(:include?, 'etag')
+				expect(response.headers).to be(:include?, "etag")
 
-				etag = response.headers['etag']
+				etag = response.headers["etag"]
 
-				response = client.get("/", {'if-none-match' => etag})
+				response = client.get("/", {"if-none-match" => etag})
 				expect(response).to be(:not_modified?)
 			end
 		end

lib/async/http/cache/body.rb

@@ -3,19 +3,19 @@
 # Released under the MIT License.
 # Copyright, 2020-2024, by Samuel Williams.
 
-require 'protocol/http/body/rewindable'
-require 'protocol/http/body/completable'
-require 'protocol/http/body/digestable'
+require "protocol/http/body/rewindable"
+require "protocol/http/body/completable"
+require "protocol/http/body/digestable"
 
-require 'console'
-require 'console/event/failure'
+require "console"
+require "console/event/failure"
 
 module Async
 	module HTTP
 		module Cache
 			module Body
-				TRAILER = 'trailer'
-				ETAG = 'etag'
+				TRAILER = "trailer"
+				ETAG = "etag"
 
 				def self.wrap(response, &block)
 					if body = response.body

lib/async/http/cache/general.rb

@@ -4,24 +4,24 @@
 # Copyright, 2020-2024, by Samuel Williams.
 # Copyright, 2022, by Colin Kelley.
 
-require 'set'
-require 'protocol/http/middleware'
+require "set"
+require "protocol/http/middleware"
 
-require_relative 'body'
-require_relative 'response'
-require_relative 'store'
+require_relative "body"
+require_relative "response"
+require_relative "store"
 
 module Async
 	module HTTP
 		module Cache
 			# Implements a general shared cache according to https://www.rfc-editor.org/rfc/rfc9111
 			class General < ::Protocol::HTTP::Middleware
-				CACHE_CONTROL  = 'cache-control'
+				CACHE_CONTROL  = "cache-control"
 
-				CONTENT_TYPE = 'content-type'
-				AUTHORIZATION = 'authorization'
-				COOKIE = 'cookie'
-				SET_COOKIE = 'set-cookie'
+				CONTENT_TYPE = "content-type"
+				AUTHORIZATION = "authorization"
+				COOKIE = "cookie"
+				SET_COOKIE = "set-cookie"
 
 				# Status codes of responses that MAY be stored by a cache or used in reply
 				# to a subsequent request.
@@ -72,7 +72,7 @@ def cacheable_request?(request)
 					end
 
 					# We only support caching GET and HEAD requests:
-					unless request.method == 'GET' || request.method == 'HEAD'
+					unless request.method == "GET" || request.method == "HEAD"
 						return false
 					end
 
@@ -111,7 +111,7 @@ def cacheable_response?(response)
 						Console.logger.debug(self, status: response.status) {"Cannot cache response with status code!"}
 						return false
 					end
-
+					
 					unless cacheable_response_headers?(response.headers)
 						Console.logger.debug(self) {"Cannot cache response with uncacheable headers!"}
 						return false
@@ -137,7 +137,7 @@ def wrap(key, request, response)
 					if request.head? and body = response.body
 						unless body.empty?
 							Console.logger.warn(self) {"HEAD request resulted in non-empty body!"}
-
+							
 							return response
 						end
 					end
@@ -161,7 +161,7 @@ def wrap(key, request, response)
 						end
 					end
 				end
-
+				
 				def call(request)
 					cache_control = request.headers[CACHE_CONTROL]