Modernize gem.

Author: ioquatix

.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

@@ -40,7 +40,7 @@ jobs:
       run: bundle exec bake utopia:project:static --force no
 
     - name: Upload documentation artifact
-      uses: actions/upload-pages-artifact@v2
+      uses: actions/upload-pages-artifact@v3
       with:
         path: docs
 
@@ -55,4 +55,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v3
+        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 renamed to .github/workflows/test-coverage.yaml

@@ -1,4 +1,4 @@
-name: Coverage
+name: Test Coverage
 
 on: [push, pull_request]
 
@@ -43,7 +43,7 @@ jobs:
     - name: Run tests
       timeout-minutes: 5
       run: bundle exec bake test
-
+    
     - uses: actions/upload-artifact@v3
       with:
         name: coverage-${{matrix.os}}-${{matrix.ruby}}

.rubocop.yml

@@ -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

async-redis.gemspec

@@ -16,6 +16,7 @@ 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",
 	}
 

benchmark/performance.rb

@@ -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

gems.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
 source 'https://rubygems.org'
 
@@ -17,13 +17,16 @@
 end
 
 group :test do
+	gem "sus"
+	gem "covered"
+	gem "decode"
+	gem "rubocop"
+	
 	gem "bake-test"
 	gem "bake-test-external"
 
-	gem "hiredis"
-	
-	gem "covered"
-	
-	gem "sus"
 	gem "sus-fixtures-async"
+	
+	gem "redis"
+	gem "hiredis"
 end

lib/async/redis/context/pipeline.rb

@@ -2,7 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2019, by David Ortiz.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2022, by Tim Willard.
 
 require_relative 'generic'
@@ -81,7 +81,7 @@ def collect
 
 				def close
 					flush
-			  ensure
+				ensure
 					super
 				end
 			end

lib/async/redis/sentinels.rb

@@ -11,84 +11,91 @@ module Redis
 		class SentinelsClient < Client
 			def initialize(master_name, sentinels, role = :master, protocol = Protocol::RESP2, **options)
 				@master_name = master_name
+				
 				@sentinel_endpoints = sentinels.map do |sentinel|
 					::IO::Endpoint.tcp(sentinel[:host], sentinel[:port])
 				end
+				
 				@role = role
-
 				@protocol = protocol
 				@pool = connect(**options)
 			end
-
+			
 			private
-
+			
 			# Override the parent method. The only difference is that this one needs
 			# to resolve the master/slave address.
 			def connect(**options)
 				Async::Pool::Controller.wrap(**options) do
 					endpoint = resolve_address
 					peer = endpoint.connect
 					stream = ::IO::Stream(peer)
-
+					
 					@protocol.client(stream)
 				end
 			end
-
+			
 			def resolve_address
-				address = case @role
-									when :master then resolve_master
-									when :slave then resolve_slave
-									else raise ArgumentError, "Unknown instance role #{@role}"
-									end
-
+				case @role
+				when :master
+					resolve_master
+				when :slave
+					resolve_slave
+				else
+					raise ArgumentError, "Unknown instance role #{@role}"
+				end => address
+				
 				address or raise RuntimeError, "Unable to fetch #{@role} via Sentinel."
 			end
-
+			
 			def resolve_master
 				@sentinel_endpoints.each do |sentinel_endpoint|
 					client = Client.new(sentinel_endpoint)
-
+					
 					begin
 						address = client.call('sentinel', 'get-master-addr-by-name', @master_name)
 					rescue Errno::ECONNREFUSED
 						next
 					end
-
+					
 					return ::IO::Endpoint.tcp(address[0], address[1]) if address
 				end
-
+				
 				nil
 			end
-
+			
 			def resolve_slave
 				@sentinel_endpoints.each do |sentinel_endpoint|
 					client = Client.new(sentinel_endpoint)
-
+					
 					begin
 						reply = client.call('sentinel', 'slaves', @master_name)
 					rescue Errno::ECONNREFUSED
 						next
 					end
-
+					
 					slaves = available_slaves(reply)
 					next if slaves.empty?
-
+					
 					slave = select_slave(slaves)
 					return ::IO::Endpoint.tcp(slave['ip'], slave['port'])
 				end
-
+				
 				nil
 			end
-
-			def available_slaves(slaves_cmd_reply)
+			
+			def available_slaves(reply)
 				# The reply is an array with the format: [field1, value1, field2,
 				# value2, etc.].
 				# When a slave is marked as down by the sentinel, the "flags" field
 				# (comma-separated array) contains the "s_down" value.
-				slaves_cmd_reply.map { |s| s.each_slice(2).to_h }
-						            .reject { |s| s.fetch('flags').split(',').include?('s_down') }
+				slaves = reply.map{|fields| fields.each_slice(2).to_h}
+				
+				slaves.reject do |slave|
+					slave['flags'].split(',').include?('s_down')
+				end
 			end
-
+			
 			def select_slave(available_slaves)
 				available_slaves.sample
 			end