redis 4.5.1 → 4.8.1

data/lib/redis/commands/connection.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Connection
+      # Authenticate to the server.
+      #
+      # @param [Array<String>] args includes both username and password
+      #   or only password
+      # @return [String] `OK`
+      # @see https://redis.io/commands/auth AUTH command
+      def auth(*args)
+        send_command([:auth, *args])
+      end
+
+      # Ping the server.
+      #
+      # @param [optional, String] message
+      # @return [String] `PONG`
+      def ping(message = nil)
+        send_command([:ping, message].compact)
+      end
+
+      # Echo the given string.
+      #
+      # @param [String] value
+      # @return [String]
+      def echo(value)
+        send_command([:echo, value])
+      end
+
+      # Change the selected database for the current connection.
+      #
+      # @param [Integer] db zero-based index of the DB to use (0 to 15)
+      # @return [String] `OK`
+      def select(db)
+        synchronize do |client|
+          client.db = db
+          client.call([:select, db])
+        end
+      end
+
+      # Close the connection.
+      #
+      # @return [String] `OK`
+      def quit
+        synchronize do |client|
+          begin
+            client.call([:quit])
+          rescue ConnectionError
+          ensure
+            client.disconnect
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redis/commands/geo.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Geo
+      # Adds the specified geospatial items (latitude, longitude, name) to the specified key
+      #
+      # @param [String] key
+      # @param [Array] member arguemnts for member or members: longitude, latitude, name
+      # @return [Integer] number of elements added to the sorted set
+      def geoadd(key, *member)
+        send_command([:geoadd, key, *member])
+      end
+
+      # Returns geohash string representing position for specified members of the specified key.
+      #
+      # @param [String] key
+      # @param [String, Array<String>] member one member or array of members
+      # @return [Array<String, nil>] returns array containg geohash string if member is present, nil otherwise
+      def geohash(key, member)
+        send_command([:geohash, key, member])
+      end
+
+      # Query a sorted set representing a geospatial index to fetch members matching a
+      # given maximum distance from a point
+      #
+      # @param [Array] args key, longitude, latitude, radius, unit(m|km|ft|mi)
+      # @param ['asc', 'desc'] sort sort returned items from the nearest to the farthest
+      #   or the farthest to the nearest relative to the center
+      # @param [Integer] count limit the results to the first N matching items
+      # @param ['WITHDIST', 'WITHCOORD', 'WITHHASH'] options to return additional information
+      # @return [Array<String>] may be changed with `options`
+      def georadius(*args, **geoptions)
+        geoarguments = _geoarguments(*args, **geoptions)
+
+        send_command([:georadius, *geoarguments])
+      end
+
+      # Query a sorted set representing a geospatial index to fetch members matching a
+      # given maximum distance from an already existing member
+      #
+      # @param [Array] args key, member, radius, unit(m|km|ft|mi)
+      # @param ['asc', 'desc'] sort sort returned items from the nearest to the farthest or the farthest
+      #   to the nearest relative to the center
+      # @param [Integer] count limit the results to the first N matching items
+      # @param ['WITHDIST', 'WITHCOORD', 'WITHHASH'] options to return additional information
+      # @return [Array<String>] may be changed with `options`
+      def georadiusbymember(*args, **geoptions)
+        geoarguments = _geoarguments(*args, **geoptions)
+
+        send_command([:georadiusbymember, *geoarguments])
+      end
+
+      # Returns longitude and latitude of members of a geospatial index
+      #
+      # @param [String] key
+      # @param [String, Array<String>] member one member or array of members
+      # @return [Array<Array<String>, nil>] returns array of elements, where each
+      #   element is either array of longitude and latitude or nil
+      def geopos(key, member)
+        send_command([:geopos, key, member])
+      end
+
+      # Returns the distance between two members of a geospatial index
+      #
+      # @param [String ]key
+      # @param [Array<String>] members
+      # @param ['m', 'km', 'mi', 'ft'] unit
+      # @return [String, nil] returns distance in spefied unit if both members present, nil otherwise.
+      def geodist(key, member1, member2, unit = 'm')
+        send_command([:geodist, key, member1, member2, unit])
+      end
+
+      private
+
+      def _geoarguments(*args, options: nil, sort: nil, count: nil)
+        args.push sort if sort
+        args.push 'count', count if count
+        args.push options if options
+        args
+      end
+    end
+  end
+end

data/lib/redis/commands/hashes.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Hashes
+      # Get the number of fields in a hash.
+      #
+      # @param [String] key
+      # @return [Integer] number of fields in the hash
+      def hlen(key)
+        send_command([:hlen, key])
+      end
+
+      # Set one or more hash values.
+      #
+      # @example
+      #   redis.hset("hash", "f1", "v1", "f2", "v2") # => 2
+      #   redis.hset("hash", { "f1" => "v1", "f2" => "v2" }) # => 2
+      #
+      # @param [String] key
+      # @param [Array<String> | Hash<String, String>] attrs array or hash of fields and values
+      # @return [Integer] The number of fields that were added to the hash
+      def hset(key, *attrs)
+        attrs = attrs.first.flatten if attrs.size == 1 && attrs.first.is_a?(Hash)
+
+        send_command([:hset, key, *attrs])
+      end
+
+      # Set the value of a hash field, only if the field does not exist.
+      #
+      # @param [String] key
+      # @param [String] field
+      # @param [String] value
+      # @return [Boolean] whether or not the field was **added** to the hash
+      def hsetnx(key, field, value)
+        send_command([:hsetnx, key, field, value], &Boolify)
+      end
+
+      # Set one or more hash values.
+      #
+      # @example
+      #   redis.hmset("hash", "f1", "v1", "f2", "v2")
+      #     # => "OK"
+      #
+      # @param [String] key
+      # @param [Array<String>] attrs array of fields and values
+      # @return [String] `"OK"`
+      #
+      # @see #mapped_hmset
+      def hmset(key, *attrs)
+        send_command([:hmset, key] + attrs)
+      end
+
+      # Set one or more hash values.
+      #
+      # @example
+      #   redis.mapped_hmset("hash", { "f1" => "v1", "f2" => "v2" })
+      #     # => "OK"
+      #
+      # @param [String] key
+      # @param [Hash] hash a non-empty hash with fields mapping to values
+      # @return [String] `"OK"`
+      #
+      # @see #hmset
+      def mapped_hmset(key, hash)
+        hmset(key, hash.to_a.flatten)
+      end
+
+      # Get the value of a hash field.
+      #
+      # @param [String] key
+      # @param [String] field
+      # @return [String]
+      def hget(key, field)
+        send_command([:hget, key, field])
+      end
+
+      # Get the values of all the given hash fields.
+      #
+      # @example
+      #   redis.hmget("hash", "f1", "f2")
+      #     # => ["v1", "v2"]
+      #
+      # @param [String] key
+      # @param [Array<String>] fields array of fields
+      # @return [Array<String>] an array of values for the specified fields
+      #
+      # @see #mapped_hmget
+      def hmget(key, *fields, &blk)
+        send_command([:hmget, key] + fields, &blk)
+      end
+
+      # Get the values of all the given hash fields.
+      #
+      # @example
+      #   redis.mapped_hmget("hash", "f1", "f2")
+      #     # => { "f1" => "v1", "f2" => "v2" }
+      #
+      # @param [String] key
+      # @param [Array<String>] fields array of fields
+      # @return [Hash] a hash mapping the specified fields to their values
+      #
+      # @see #hmget
+      def mapped_hmget(key, *fields)
+        hmget(key, *fields) do |reply|
+          if reply.is_a?(Array)
+            Hash[fields.zip(reply)]
+          else
+            reply
+          end
+        end
+      end
+
+      # Get one or more random fields from a hash.
+      #
+      # @example Get one random field
+      #   redis.hrandfield("hash")
+      #     # => "f1"
+      # @example Get multiple random fields
+      #   redis.hrandfield("hash", 2)
+      #     # => ["f1, "f2"]
+      # @example Get multiple random fields with values
+      #   redis.hrandfield("hash", 2, with_values: true)
+      #     # => [["f1", "s1"], ["f2", "s2"]]
+      #
+      # @param [String] key
+      # @param [Integer] count
+      # @param [Hash] options
+      #   - `:with_values => true`: include values in output
+      #
+      # @return [nil, String, Array<String>, Array<[String, Float]>]
+      #   - when `key` does not exist, `nil`
+      #   - when `count` is not specified, a field name
+      #   - when `count` is specified and `:with_values` is not specified, an array of field names
+      #   - when `:with_values` is specified, an array with `[field, value]` pairs
+      def hrandfield(key, count = nil, withvalues: false, with_values: withvalues)
+        if with_values && count.nil?
+          raise ArgumentError, "count argument must be specified"
+        end
+
+        args = [:hrandfield, key]
+        args << count if count
+        args << "WITHVALUES" if with_values
+
+        parser = Pairify if with_values
+        send_command(args, &parser)
+      end
+
+      # Delete one or more hash fields.
+      #
+      # @param [String] key
+      # @param [String, Array<String>] field
+      # @return [Integer] the number of fields that were removed from the hash
+      def hdel(key, *fields)
+        send_command([:hdel, key, *fields])
+      end
+
+      # Determine if a hash field exists.
+      #
+      # @param [String] key
+      # @param [String] field
+      # @return [Boolean] whether or not the field exists in the hash
+      def hexists(key, field)
+        send_command([:hexists, key, field], &Boolify)
+      end
+
+      # Increment the integer value of a hash field by the given integer number.
+      #
+      # @param [String] key
+      # @param [String] field
+      # @param [Integer] increment
+      # @return [Integer] value of the field after incrementing it
+      def hincrby(key, field, increment)
+        send_command([:hincrby, key, field, increment])
+      end
+
+      # Increment the numeric value of a hash field by the given float number.
+      #
+      # @param [String] key
+      # @param [String] field
+      # @param [Float] increment
+      # @return [Float] value of the field after incrementing it
+      def hincrbyfloat(key, field, increment)
+        send_command([:hincrbyfloat, key, field, increment], &Floatify)
+      end
+
+      # Get all the fields in a hash.
+      #
+      # @param [String] key
+      # @return [Array<String>]
+      def hkeys(key)
+        send_command([:hkeys, key])
+      end
+
+      # Get all the values in a hash.
+      #
+      # @param [String] key
+      # @return [Array<String>]
+      def hvals(key)
+        send_command([:hvals, key])
+      end
+
+      # Get all the fields and values in a hash.
+      #
+      # @param [String] key
+      # @return [Hash<String, String>]
+      def hgetall(key)
+        send_command([:hgetall, key], &Hashify)
+      end
+
+      # Scan a hash
+      #
+      # @example Retrieve the first batch of key/value pairs in a hash
+      #   redis.hscan("hash", 0)
+      #
+      # @param [String, Integer] cursor the cursor of the iteration
+      # @param [Hash] options
+      #   - `:match => String`: only return keys matching the pattern
+      #   - `:count => Integer`: return count keys at most per iteration
+      #
+      # @return [String, Array<[String, String]>] the next cursor and all found keys
+      def hscan(key, cursor, **options)
+        _scan(:hscan, cursor, [key], **options) do |reply|
+          [reply[0], reply[1].each_slice(2).to_a]
+        end
+      end
+
+      # Scan a hash
+      #
+      # @example Retrieve all of the key/value pairs in a hash
+      #   redis.hscan_each("hash").to_a
+      #   # => [["key70", "70"], ["key80", "80"]]
+      #
+      # @param [Hash] options
+      #   - `:match => String`: only return keys matching the pattern
+      #   - `:count => Integer`: return count keys at most per iteration
+      #
+      # @return [Enumerator] an enumerator for all found keys
+      def hscan_each(key, **options, &block)
+        return to_enum(:hscan_each, key, **options) unless block_given?
+
+        cursor = 0
+        loop do
+          cursor, values = hscan(key, cursor, **options)
+          values.each(&block)
+          break if cursor == "0"
+        end
+      end
+    end
+  end
+end

data/lib/redis/commands/hyper_log_log.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module HyperLogLog
+      # Add one or more members to a HyperLogLog structure.
+      #
+      # @param [String] key
+      # @param [String, Array<String>] member one member, or array of members
+      # @return [Boolean] true if at least 1 HyperLogLog internal register was altered. false otherwise.
+      def pfadd(key, member)
+        send_command([:pfadd, key, member], &Boolify)
+      end
+
+      # Get the approximate cardinality of members added to HyperLogLog structure.
+      #
+      # If called with multiple keys, returns the approximate cardinality of the
+      # union of the HyperLogLogs contained in the keys.
+      #
+      # @param [String, Array<String>] keys
+      # @return [Integer]
+      def pfcount(*keys)
+        send_command([:pfcount] + keys)
+      end
+
+      # Merge multiple HyperLogLog values into an unique value that will approximate the cardinality of the union of
+      # the observed Sets of the source HyperLogLog structures.
+      #
+      # @param [String] dest_key destination key
+      # @param [String, Array<String>] source_key source key, or array of keys
+      # @return [Boolean]
+      def pfmerge(dest_key, *source_key)
+        send_command([:pfmerge, dest_key, *source_key], &BoolifySet)
+      end
+    end
+  end
+end