protocol-redis 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44522d19a4786415ce88e26cecde27b950b5f3b225f632fd0f64a0a2a40e6a88
-  data.tar.gz: 5a79d64a263f6b3f154a490977634b5b3501a2dc43d9a9c726ef7006e11cb155
+  metadata.gz: d7392dc8cc474911de91a9b0479ebad6a1406c940bed6c23fd6b35f7eff90959
+  data.tar.gz: 8afef4349361c795a119f3560198e71606a2bdda25b6fd9466ab5aef2f52ab8b
 SHA512:
-  metadata.gz: 967a4135662b57b39799adb7632d0152e390453e6d3420c52cb873da89e602fde78e5f45ba81ae4e855491d8fe85b006c6bfdd0ad51bf9b16c3ff85e89e5f217
-  data.tar.gz: a3333ff49a37c7d64462de1c8d712e9e9d7ef49c2e1ae470fec329337ca29de46a57bc3d18e6641d264fbe401561cf4dcafbc3d3282e39136b66a9df969c36b5
+  metadata.gz: ac74be71761f3341f3a76f035636b8e4d2693d40206c74c25858ee02f6eba2aad5013f0928cc467c16858c349ff1903074df878b764bdb7244fb75933428a3f5
+  data.tar.gz: 944106d0ef3be643b6efbaa14ab94eb1c2a4c337b54809127a798496d624c440ffc648de0de9bd550b7a998435486e8de9fb5c32372e6e6e4af6f82bf61a6ac6

data/lib/protocol/redis/methods/cluster.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Nick Burwell.
+
+module Protocol
+  module Redis
+    module Methods
+      module Cluster
+        # Sends the `CLUSTER *` command to random node and returns its reply.
+        # @see https://redis.io/commands/cluster-addslots/
+        # @param subcommand [String, Symbol] the subcommand of cluster command
+        #   e.g. `:addslots`, `:delslots`, `:nodes`, `:replicas`, `:info`
+        #
+        # @return [Object] depends on the subcommand provided
+        def cluster(subcommand, *args)
+          call("CLUSTER", subcommand.to_s, *args)
+        end
+
+        # Sends `ASKING` command to random node and returns its reply.
+        # @see https://redis.io/commands/asking/
+        #
+        # @return [String] `'OK'`
+        def asking
+          call("ASKING")
+        end
+      end
+    end
+  end
+end

data/lib/protocol/redis/methods/hashes.rb

@@ -2,6 +2,8 @@
 
 # Released under the MIT License.
 # Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2023, by Troex Nevelin.
+# Copyright, 2023, by Nick Burwell.
 
 module Protocol
 	module Redis
@@ -10,6 +12,7 @@ module Protocol
 				# Get the number of fields in a hash. O(1).
 				# @see https://redis.io/commands/hlen
 				# @param key [Key]
+				# @return [Integer]
 				def hlen(key)
 					call('HLEN', key)
 				end
@@ -17,6 +20,7 @@ module Protocol
 				# Set the string value of a hash field. O(1) for each field/value pair added, so O(N) to add N field/value pairs when the command is called with multiple field/value pairs.
 				# @see https://redis.io/commands/hset
 				# @param key [Key]
+				# @return [Integer] if new field added returns "1" otherwise "0"
 				def hset(key, field, value)
 					call('HSET', key, field, value)
 				end
@@ -26,21 +30,39 @@ module Protocol
 				# @param key [Key]
 				# @param field [String]
 				# @param value [String]
+				# @return [Boolean] "true" if new field added, "false" otherwise
 				def hsetnx(key, field, value)
-					call('HSETNX', key, field, value)
+					call('HSETNX', key, field, value) > 0
 				end
 				
 				# Set multiple hash fields to multiple values. O(N) where N is the number of fields being set.
 				# @see https://redis.io/commands/hmset
 				# @param key [Key]
+				# @return [String] default: "OK"
 				def hmset(key, *attrs)
 					call('HMSET', key, *attrs)
 				end
+
+				# Set multiple hash fields to multiple values, by providing a hash
+				#
+				# @example
+				#   redis.mapped_hmset("hash", { "f1" => "v1", "f2" => "v2" })
+				#     # => "OK"
+				#
+				# @param key [Key]
+				# @param hash [Hash] a non-empty hash with fields mapping to values
+				# @return [String] default: "OK"
+				#
+				# @see #hmset
+				def mapped_hmset(key, hash)
+					hmset(key, *hash.flatten)
+				end
 				
 				# Get the value of a hash field. O(1).
 				# @see https://redis.io/commands/hget
 				# @param key [Key]
 				# @param field [String]
+				# @return [String, Null]
 				def hget(key, field)
 					call('HGET', key, field)
 				end
@@ -48,15 +70,33 @@ module Protocol
 				# Get the values of all the given hash fields. O(N) where N is the number of fields being requested.
 				# @see https://redis.io/commands/hmget
 				# @param key [Key]
-				# @param field [String]
-				def hmget(key, *fields, &blk)
-					call('HMGET', key, *fields, &blk)
+				# @param fields [Array<String>] array of fields
+				# @return [Array]
+				def hmget(key, *fields)
+					call('HMGET', key, *fields)
 				end
-				
+
+				# Get the values of all the given hash fields and return as array
+				#
+				# @example
+				#   redis.mapped_hmget("hash", "f1", "f2")
+				#     # => { "f1" => "v1", "f2" => "v2" }
+				#
+				# @param key [Key]
+				# @param fields [Array<String>] array of fields
+				# @return [Hash] a hash mapping the specified fields to their values
+				#
+				# @see #hmget
+				def mapped_hmget(key, *fields)
+					reply = hmget(key, *fields)
+					Hash[fields.zip(reply)]
+				end
+
 				# Delete one or more hash fields. O(N) where N is the number of fields to be removed.
 				# @see https://redis.io/commands/hdel
 				# @param key [Key]
 				# @param field [String]
+				# @return [Integer] number of deleted fields
 				def hdel(key, *fields)
 					call('HDEL', key, *fields)
 				end
@@ -65,8 +105,9 @@ module Protocol
 				# @see https://redis.io/commands/hexists
 				# @param key [Key]
 				# @param field [String]
+				# @return [Boolean]
 				def hexists(key, field)
-					call('HEXISTS', key, field)
+					call('HEXISTS', key, field) > 0
 				end
 				
 				# Increment the integer value of a hash field by the given number. O(1).
@@ -74,6 +115,7 @@ module Protocol
 				# @param key [Key]
 				# @param field [String]
 				# @param increment [Integer]
+				# @return [Integer] field value after increment
 				def hincrby(key, field, increment)
 					call('HINCRBY', key, field, increment)
 				end
@@ -83,13 +125,15 @@ module Protocol
 				# @param key [Key]
 				# @param field [String]
 				# @param increment [Double]
+				# @return [Float] field value after increment
 				def hincrbyfloat(key, field, increment)
-					call('HINCRBYFLOAT', key, field, increment)
+					Float(call('HINCRBYFLOAT', key, field, increment))
 				end
 				
 				# Get all the fields in a hash. O(N) where N is the size of the hash.
 				# @see https://redis.io/commands/hkeys
 				# @param key [Key]
+				# @return [Array]
 				def hkeys(key)
 					call('HKEYS', key)
 				end
@@ -97,6 +141,7 @@ module Protocol
 				# Get all the values in a hash. O(N) where N is the size of the hash.
 				# @see https://redis.io/commands/hvals
 				# @param key [Key]
+				# @return [Array]
 				def hvals(key)
 					call('HVALS', key)
 				end
@@ -104,8 +149,27 @@ module Protocol
 				# Get all the fields and values in a hash. O(N) where N is the size of the hash.
 				# @see https://redis.io/commands/hgetall
 				# @param key [Key]
+				# @return [Hash]
 				def hgetall(key)
-					call('HGETALL', key)
+					call('HGETALL', key).each_slice(2).to_h
+				end
+
+				# Iterates fields of Hash types and their associated values. O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
+				# @see https://redis.io/commands/hscan/
+				# @param cursor [Cursor]
+				# @return [Hash]
+				def hscan(cursor, match: nil, count: nil)
+					arguments = [cursor]
+
+					if match
+						arguments.append("MATCH", match)
+					end
+
+					if count
+						arguments.append("COUNT", count)
+					end
+
+					call("HSCAN", *arguments)
 				end
 			end
 		end

data/lib/protocol/redis/methods.rb

@@ -9,6 +9,7 @@
 require_relative 'methods/generic'
 require_relative 'methods/connection'
 require_relative 'methods/server'
+require_relative 'methods/cluster'
 require_relative 'methods/geospatial'
 
 require_relative 'methods/counting'
@@ -30,6 +31,7 @@ module Protocol
 				klass.include Methods::Generic
 				klass.include Methods::Connection
 				klass.include Methods::Server
+				klass.include Methods::Cluster
 				klass.include Methods::Geospatial
 				
 				klass.include Methods::Counting

data/lib/protocol/redis/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module Redis
-		VERSION = "0.7.0"
+		VERSION = "0.8.0"
 	end
 end

data/license.md

@@ -6,7 +6,7 @@ Copyright, 2020, by Salim Semaoune.
 Copyright, 2020, by Dimitry Chopey.  
 Copyright, 2020, by Nakul Warrier.  
 Copyright, 2020, by David Ortiz.  
-Copyright, 2021, by Troex Nevelin.  
+Copyright, 2021-2023, by Troex Nevelin.  
 Copyright, 2021, by Daniel Evans.  
 Copyright, 2023, by Nick Burwell.  
 

data/readme.md

@@ -33,6 +33,12 @@ puts server.read_object
 # => "Hello World!"
 ```
 
+## Development
+
+Run tests:
+
+    bundle exec bake test
+
 ## Contributing
 
 We welcome contributions to this project.

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: protocol-redis
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Samuel Williams
 - Dimitry Chopey
+- Nick Burwell
 - David Ortiz
 - Nakul Warrier
+- Troex Nevelin
 - Daniel Evans
-- Nick Burwell
 - Olle Jonsson
 - Salim Semaoune
-- Troex Nevelin
 autorequire:
 bindir: bin
 cert_chain:
@@ -45,134 +45,8 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-06-03 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: async-http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-modernize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: trenni
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2023-06-13 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 executables: []
@@ -183,6 +57,7 @@ files:
 - lib/protocol/redis/connection.rb
 - lib/protocol/redis/error.rb
 - lib/protocol/redis/methods.rb
+- lib/protocol/redis/methods/cluster.rb
 - lib/protocol/redis/methods/connection.rb
 - lib/protocol/redis/methods/counting.rb
 - lib/protocol/redis/methods/generic.rb
@@ -212,14 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: A transport agnostic RESP protocol client/server.