Merge branch 'main' into sentinel-client-protocol

Author: ioquatix

.editorconfig

@@ -3,3 +3,7 @@ root = true
 [*]
 indent_style = tab
 indent_size = 2
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2

.github/workflows/documentation-coverage.yaml

@@ -0,0 +1,25 @@
+name: Documentation Coverage
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+  COVERAGE: PartialSummary
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.3"
+        bundler-cache: true
+    
+    - name: Validate coverage
+      timeout-minutes: 5
+      run: bundle exec bake decode:index:coverage lib

.github/workflows/documentation.yaml

@@ -5,9 +5,6 @@ on:
     branches:
       - main
 
-    # Allows you to run this workflow manually from the Actions tab:
-    workflow_dispatch:
-
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages:
 permissions:
   contents: read
@@ -28,11 +25,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.2"
+        ruby-version: "3.3"
         bundler-cache: true
 
     - name: Installing packages
@@ -43,7 +40,7 @@ jobs:
       run: bundle exec bake utopia:project:static --force no
 
     - name: Upload documentation artifact
-      uses: actions/upload-pages-artifact@v1
+      uses: actions/upload-pages-artifact@v3
       with:
         path: docs
 
@@ -58,4 +55,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4

.github/workflows/rubocop.yaml

@@ -0,0 +1,24 @@
+name: RuboCop
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ruby
+        bundler-cache: true
+    
+    - name: Run RuboCop
+      timeout-minutes: 10
+      run: bundle exec rubocop

.github/workflows/coverage.yaml .github/workflows/test-coverage.yaml

@@ -1,4 +1,4 @@
-name: Coverage
+name: Test Coverage
 
 on: [push, pull_request]
 
@@ -31,10 +31,10 @@ jobs:
           - ubuntu
 
         ruby:
-          - "3.2"
+          - "3.3"
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{matrix.ruby}}
@@ -43,8 +43,8 @@ jobs:
     - name: Run tests
       timeout-minutes: 5
       run: bundle exec bake test
-
-    - uses: actions/upload-artifact@v2
+    
+    - uses: actions/upload-artifact@v3
       with:
         name: coverage-${{matrix.os}}-${{matrix.ruby}}
         path: .covered.db
@@ -54,10 +54,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: "3.2"
+        ruby-version: "3.3"
         bundler-cache: true
 
     - uses: actions/download-artifact@v3

.github/workflows/test-external.yaml

@@ -31,10 +31,9 @@ jobs:
           - ubuntu
 
         ruby:
-          - "2.7"
-          - "3.0"
           - "3.1"
           - "3.2"
+          - "3.3"
 
         experimental: [false]
 
@@ -50,7 +49,7 @@ jobs:
             experimental: true
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{matrix.ruby}}

.github/workflows/test.yaml

@@ -4,4 +4,5 @@
 /.covered.db
 /external
 
-/dump.rdb
+/.github/workflows/test-external.yaml
+/dump.rdb

.gitignore

@@ -0,0 +1,49 @@
+AllCops:
+  DisabledByDefault: true
+
+Layout/IndentationStyle:
+  Enabled: true
+  EnforcedStyle: tabs
+
+Layout/InitialIndentation:
+  Enabled: true
+
+Layout/IndentationWidth:
+  Enabled: true
+  Width: 1
+
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: normal
+
+Layout/BlockAlignment:
+  Enabled: true
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/BeginEndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/DefEndAlignment:
+  Enabled: true
+
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true

.rubocop.yml

@@ -15,10 +15,18 @@ Gem::Specification.new do |spec|
 
 	spec.homepage = "https://github.com/socketry/async-redis"
 
+	spec.metadata = {
+		"documentation_uri" => "https://socketry.github.io/async-redis/",
+		"source_code_uri" => "https://github.com/socketry/async-redis.git",
+	}
+	
 	spec.files = Dir.glob(['{lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__)
 
-	spec.add_dependency "async", [">= 1.8", "< 3.0"]
-	spec.add_dependency "async-io", "~> 1.10"
+	spec.required_ruby_version = ">= 3.1"
+	
+	spec.add_dependency "async", "~> 2.10"
 	spec.add_dependency "async-pool", "~> 0.2"
-	spec.add_dependency "protocol-redis", "~> 0.8.0"
+	spec.add_dependency "io-endpoint", "~> 0.10"
+	spec.add_dependency "io-stream", "~> 0.4"
+	spec.add_dependency "protocol-redis", "~> 0.9"
 end

async-redis.gemspec

@@ -2,7 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2019, by Pierre Montelle.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2019, by David Ortiz.
 
 require 'async/redis'
@@ -25,7 +25,9 @@
 			key = keys.sample
 			value = times.to_s
 
-			i = 0; while i < times; i += 1
+			i = 0
+			while i < times
+				i += 1
 				async_client.set(key, value)
 			end
 		end
@@ -37,7 +39,9 @@
 			async_client.pipeline do |pipeline|
 				sync = pipeline.sync
 
-				i = 0; while i < times; i += 1
+				i = 0
+				while i < times
+					i += 1
 					pipeline.set(key, value)
 				end
 			end
@@ -47,7 +51,9 @@
 			key = keys.sample
 			value = times.to_s
 
-			i = 0; while i < times; i += 1
+			i = 0
+			while i < times
+				i += 1
 				redis_client.set(key, value)
 			end
 		end
@@ -56,7 +62,9 @@
 			key = keys.sample
 			value = times.to_s
 
-			i = 0; while i < times; i += 1
+			i = 0
+			while i < times
+				i += 1
 				redis_client_hiredis.set(key, value)
 			end
 		end

benchmark/performance.rb

@@ -2,7 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2021, by Troex Nevelin.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
 require_relative '../../lib/async/redis'
 
@@ -32,16 +32,16 @@ def call(url = 'redis://localhost:6379', ssl_params: nil, **options)
 
 		# @param uri [URI]
 		# @param ssl_params [Hash]
-		# @return [Async::IO::Endpoint]
+		# @return [::IO::Endpoint::Generic]
 		def prepare_endpoint(uri, ssl_params = nil)
-			tcp_endpoint = Async::IO::Endpoint.tcp(uri.hostname, uri.port)
+			tcp_endpoint = ::IO::Endpoint.tcp(uri.hostname, uri.port)
 			case uri.scheme
 			when 'redis'
 				tcp_endpoint
 			when 'rediss'
 				ssl_context = OpenSSL::SSL::SSLContext.new
 				ssl_context.set_params(ssl_params) if ssl_params
-				Async::IO::SSLEndpoint.new(tcp_endpoint, ssl_context: ssl_context)
+				::IO::SSLEndpoint.new(tcp_endpoint, ssl_context: ssl_context)
 			else
 				raise ArgumentError
 			end

examples/auth/wrapper.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2018, by Huba Nagy.
+# Copyright, 2018-2024, by Samuel Williams.
 
 require 'async/redis'
 require 'async/redis/client'
@@ -19,14 +20,12 @@
 
 	let(:root) {Async::Redis::Key["async-redis:test:#{SecureRandom.uuid}"]}
 
-	def before
-		super
+	before do
 		keys = client.keys("#{root}:*")
 		client.del(*keys) if keys.any?
 	end
 
-	def after
+	after do
 		@client&.close
-		super
 	end
 end