redis 4.5.0 → 4.7.0

data/lib/redis/commands/pubsub.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Pubsub
+      # Post a message to a channel.
+      def publish(channel, message)
+        send_command([:publish, channel, message])
+      end
+
+      def subscribed?
+        synchronize do |client|
+          client.is_a? SubscribedClient
+        end
+      end
+
+      # Listen for messages published to the given channels.
+      def subscribe(*channels, &block)
+        synchronize do |_client|
+          _subscription(:subscribe, 0, channels, block)
+        end
+      end
+
+      # Listen for messages published to the given channels. Throw a timeout error
+      # if there is no messages for a timeout period.
+      def subscribe_with_timeout(timeout, *channels, &block)
+        synchronize do |_client|
+          _subscription(:subscribe_with_timeout, timeout, channels, block)
+        end
+      end
+
+      # Stop listening for messages posted to the given channels.
+      def unsubscribe(*channels)
+        synchronize do |client|
+          raise "Can't unsubscribe if not subscribed." unless subscribed?
+
+          client.unsubscribe(*channels)
+        end
+      end
+
+      # Listen for messages published to channels matching the given patterns.
+      def psubscribe(*channels, &block)
+        synchronize do |_client|
+          _subscription(:psubscribe, 0, channels, block)
+        end
+      end
+
+      # Listen for messages published to channels matching the given patterns.
+      # Throw a timeout error if there is no messages for a timeout period.
+      def psubscribe_with_timeout(timeout, *channels, &block)
+        synchronize do |_client|
+          _subscription(:psubscribe_with_timeout, timeout, channels, block)
+        end
+      end
+
+      # Stop listening for messages posted to channels matching the given patterns.
+      def punsubscribe(*channels)
+        synchronize do |client|
+          raise "Can't unsubscribe if not subscribed." unless subscribed?
+
+          client.punsubscribe(*channels)
+        end
+      end
+
+      # Inspect the state of the Pub/Sub subsystem.
+      # Possible subcommands: channels, numsub, numpat.
+      def pubsub(subcommand, *args)
+        send_command([:pubsub, subcommand] + args)
+      end
+    end
+  end
+end

data/lib/redis/commands/scripting.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Scripting
+      # Control remote script registry.
+      #
+      # @example Load a script
+      #   sha = redis.script(:load, "return 1")
+      #     # => <sha of this script>
+      # @example Check if a script exists
+      #   redis.script(:exists, sha)
+      #     # => true
+      # @example Check if multiple scripts exist
+      #   redis.script(:exists, [sha, other_sha])
+      #     # => [true, false]
+      # @example Flush the script registry
+      #   redis.script(:flush)
+      #     # => "OK"
+      # @example Kill a running script
+      #   redis.script(:kill)
+      #     # => "OK"
+      #
+      # @param [String] subcommand e.g. `exists`, `flush`, `load`, `kill`
+      # @param [Array<String>] args depends on subcommand
+      # @return [String, Boolean, Array<Boolean>, ...] depends on subcommand
+      #
+      # @see #eval
+      # @see #evalsha
+      def script(subcommand, *args)
+        subcommand = subcommand.to_s.downcase
+
+        if subcommand == "exists"
+          arg = args.first
+
+          send_command([:script, :exists, arg]) do |reply|
+            reply = reply.map { |r| Boolify.call(r) }
+
+            if arg.is_a?(Array)
+              reply
+            else
+              reply.first
+            end
+          end
+        else
+          send_command([:script, subcommand] + args)
+        end
+      end
+
+      # Evaluate Lua script.
+      #
+      # @example EVAL without KEYS nor ARGV
+      #   redis.eval("return 1")
+      #     # => 1
+      # @example EVAL with KEYS and ARGV as array arguments
+      #   redis.eval("return { KEYS, ARGV }", ["k1", "k2"], ["a1", "a2"])
+      #     # => [["k1", "k2"], ["a1", "a2"]]
+      # @example EVAL with KEYS and ARGV in a hash argument
+      #   redis.eval("return { KEYS, ARGV }", :keys => ["k1", "k2"], :argv => ["a1", "a2"])
+      #     # => [["k1", "k2"], ["a1", "a2"]]
+      #
+      # @param [Array<String>] keys optional array with keys to pass to the script
+      # @param [Array<String>] argv optional array with arguments to pass to the script
+      # @param [Hash] options
+      #   - `:keys => Array<String>`: optional array with keys to pass to the script
+      #   - `:argv => Array<String>`: optional array with arguments to pass to the script
+      # @return depends on the script
+      #
+      # @see #script
+      # @see #evalsha
+      def eval(*args)
+        _eval(:eval, args)
+      end
+
+      # Evaluate Lua script by its SHA.
+      #
+      # @example EVALSHA without KEYS nor ARGV
+      #   redis.evalsha(sha)
+      #     # => <depends on script>
+      # @example EVALSHA with KEYS and ARGV as array arguments
+      #   redis.evalsha(sha, ["k1", "k2"], ["a1", "a2"])
+      #     # => <depends on script>
+      # @example EVALSHA with KEYS and ARGV in a hash argument
+      #   redis.evalsha(sha, :keys => ["k1", "k2"], :argv => ["a1", "a2"])
+      #     # => <depends on script>
+      #
+      # @param [Array<String>] keys optional array with keys to pass to the script
+      # @param [Array<String>] argv optional array with arguments to pass to the script
+      # @param [Hash] options
+      #   - `:keys => Array<String>`: optional array with keys to pass to the script
+      #   - `:argv => Array<String>`: optional array with arguments to pass to the script
+      # @return depends on the script
+      #
+      # @see #script
+      # @see #eval
+      def evalsha(*args)
+        _eval(:evalsha, args)
+      end
+
+      private
+
+      def _eval(cmd, args)
+        script = args.shift
+        options = args.pop if args.last.is_a?(Hash)
+        options ||= {}
+
+        keys = args.shift || options[:keys] || []
+        argv = args.shift || options[:argv] || []
+
+        send_command([cmd, script, keys.length] + keys + argv)
+      end
+    end
+  end
+end

data/lib/redis/commands/server.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Server
+      # Asynchronously rewrite the append-only file.
+      #
+      # @return [String] `OK`
+      def bgrewriteaof
+        send_command([:bgrewriteaof])
+      end
+
+      # Asynchronously save the dataset to disk.
+      #
+      # @return [String] `OK`
+      def bgsave
+        send_command([:bgsave])
+      end
+
+      # Get or set server configuration parameters.
+      #
+      # @param [Symbol] action e.g. `:get`, `:set`, `:resetstat`
+      # @return [String, Hash] string reply, or hash when retrieving more than one
+      #   property with `CONFIG GET`
+      def config(action, *args)
+        send_command([:config, action] + args) do |reply|
+          if reply.is_a?(Array) && action == :get
+            Hashify.call(reply)
+          else
+            reply
+          end
+        end
+      end
+
+      # Manage client connections.
+      #
+      # @param [String, Symbol] subcommand e.g. `kill`, `list`, `getname`, `setname`
+      # @return [String, Hash] depends on subcommand
+      def client(subcommand = nil, *args)
+        send_command([:client, subcommand] + args) do |reply|
+          if subcommand.to_s == "list"
+            reply.lines.map do |line|
+              entries = line.chomp.split(/[ =]/)
+              Hash[entries.each_slice(2).to_a]
+            end
+          else
+            reply
+          end
+        end
+      end
+
+      # Return the number of keys in the selected database.
+      #
+      # @return [Integer]
+      def dbsize
+        send_command([:dbsize])
+      end
+
+      # Remove all keys from all databases.
+      #
+      # @param [Hash] options
+      #   - `:async => Boolean`: async flush (default: false)
+      # @return [String] `OK`
+      def flushall(options = nil)
+        if options && options[:async]
+          send_command(%i[flushall async])
+        else
+          send_command([:flushall])
+        end
+      end
+
+      # Remove all keys from the current database.
+      #
+      # @param [Hash] options
+      #   - `:async => Boolean`: async flush (default: false)
+      # @return [String] `OK`
+      def flushdb(options = nil)
+        if options && options[:async]
+          send_command(%i[flushdb async])
+        else
+          send_command([:flushdb])
+        end
+      end
+
+      # Get information and statistics about the server.
+      #
+      # @param [String, Symbol] cmd e.g. "commandstats"
+      # @return [Hash<String, String>]
+      def info(cmd = nil)
+        send_command([:info, cmd].compact) do |reply|
+          if reply.is_a?(String)
+            reply = HashifyInfo.call(reply)
+
+            if cmd && cmd.to_s == "commandstats"
+              # Extract nested hashes for INFO COMMANDSTATS
+              reply = Hash[reply.map do |k, v|
+                v = v.split(",").map { |e| e.split("=") }
+                [k[/^cmdstat_(.*)$/, 1], Hash[v]]
+              end]
+            end
+          end
+
+          reply
+        end
+      end
+
+      # Get the UNIX time stamp of the last successful save to disk.
+      #
+      # @return [Integer]
+      def lastsave
+        send_command([:lastsave])
+      end
+
+      # Listen for all requests received by the server in real time.
+      #
+      # There is no way to interrupt this command.
+      #
+      # @yield a block to be called for every line of output
+      # @yieldparam [String] line timestamp and command that was executed
+      def monitor(&block)
+        synchronize do |client|
+          client.call_loop([:monitor], &block)
+        end
+      end
+
+      # Synchronously save the dataset to disk.
+      #
+      # @return [String]
+      def save
+        send_command([:save])
+      end
+
+      # Synchronously save the dataset to disk and then shut down the server.
+      def shutdown
+        synchronize do |client|
+          client.with_reconnect(false) do
+            begin
+              client.call([:shutdown])
+            rescue ConnectionError
+              # This means Redis has probably exited.
+              nil
+            end
+          end
+        end
+      end
+
+      # Make the server a slave of another instance, or promote it as master.
+      def slaveof(host, port)
+        send_command([:slaveof, host, port])
+      end
+
+      # Interact with the slowlog (get, len, reset)
+      #
+      # @param [String] subcommand e.g. `get`, `len`, `reset`
+      # @param [Integer] length maximum number of entries to return
+      # @return [Array<String>, Integer, String] depends on subcommand
+      def slowlog(subcommand, length = nil)
+        synchronize do |client|
+          args = [:slowlog, subcommand]
+          args << length if length
+          client.call args
+        end
+      end
+
+      # Internal command used for replication.
+      def sync
+        send_command([:sync])
+      end
+
+      # Return the server time.
+      #
+      # @example
+      #   r.time # => [ 1333093196, 606806 ]
+      #
+      # @return [Array<Integer>] tuple of seconds since UNIX epoch and
+      #   microseconds in the current second
+      def time
+        send_command([:time]) do |reply|
+          reply&.map(&:to_i)
+        end
+      end
+
+      def debug(*args)
+        send_command([:debug] + args)
+      end
+    end
+  end
+end

data/lib/redis/commands/sets.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Sets
+      # Get the number of members in a set.
+      #
+      # @param [String] key
+      # @return [Integer]
+      def scard(key)
+        send_command([:scard, key])
+      end
+
+      # Add one or more members to a set.
+      #
+      # @param [String] key
+      # @param [String, Array<String>] member one member, or array of members
+      # @return [Boolean, Integer] `Boolean` when a single member is specified,
+      #   holding whether or not adding the member succeeded, or `Integer` when an
+      #   array of members is specified, holding the number of members that were
+      #   successfully added
+      def sadd(key, member)
+        send_command([:sadd, key, member]) do |reply|
+          if member.is_a? Array
+            # Variadic: return integer
+            reply
+          else
+            # Single argument: return boolean
+            Boolify.call(reply)
+          end
+        end
+      end
+
+      # Remove one or more members from a set.
+      #
+      # @param [String] key
+      # @param [String, Array<String>] member one member, or array of members
+      # @return [Boolean, Integer] `Boolean` when a single member is specified,
+      #   holding whether or not removing the member succeeded, or `Integer` when an
+      #   array of members is specified, holding the number of members that were
+      #   successfully removed
+      def srem(key, member)
+        send_command([:srem, key, member]) do |reply|
+          if member.is_a? Array
+            # Variadic: return integer
+            reply
+          else
+            # Single argument: return boolean
+            Boolify.call(reply)
+          end
+        end
+      end
+
+      # Remove and return one or more random member from a set.
+      #
+      # @param [String] key
+      # @return [String]
+      # @param [Integer] count
+      def spop(key, count = nil)
+        if count.nil?
+          send_command([:spop, key])
+        else
+          send_command([:spop, key, count])
+        end
+      end
+
+      # Get one or more random members from a set.
+      #
+      # @param [String] key
+      # @param [Integer] count
+      # @return [String]
+      def srandmember(key, count = nil)
+        if count.nil?
+          send_command([:srandmember, key])
+        else
+          send_command([:srandmember, key, count])
+        end
+      end
+
+      # Move a member from one set to another.
+      #
+      # @param [String] source source key
+      # @param [String] destination destination key
+      # @param [String] member member to move from `source` to `destination`
+      # @return [Boolean]
+      def smove(source, destination, member)
+        send_command([:smove, source, destination, member], &Boolify)
+      end
+
+      # Determine if a given value is a member of a set.
+      #
+      # @param [String] key
+      # @param [String] member
+      # @return [Boolean]
+      def sismember(key, member)
+        send_command([:sismember, key, member], &Boolify)
+      end
+
+      # Determine if multiple values are members of a set.
+      #
+      # @param [String] key
+      # @param [String, Array<String>] members
+      # @return [Array<Boolean>]
+      def smismember(key, *members)
+        send_command([:smismember, key, *members]) do |reply|
+          reply.map(&Boolify)
+        end
+      end
+
+      # Get all the members in a set.
+      #
+      # @param [String] key
+      # @return [Array<String>]
+      def smembers(key)
+        send_command([:smembers, key])
+      end
+
+      # Subtract multiple sets.
+      #
+      # @param [String, Array<String>] keys keys pointing to sets to subtract
+      # @return [Array<String>] members in the difference
+      def sdiff(*keys)
+        send_command([:sdiff, *keys])
+      end
+
+      # Subtract multiple sets and store the resulting set in a key.
+      #
+      # @param [String] destination destination key
+      # @param [String, Array<String>] keys keys pointing to sets to subtract
+      # @return [Integer] number of elements in the resulting set
+      def sdiffstore(destination, *keys)
+        send_command([:sdiffstore, destination, *keys])
+      end
+
+      # Intersect multiple sets.
+      #
+      # @param [String, Array<String>] keys keys pointing to sets to intersect
+      # @return [Array<String>] members in the intersection
+      def sinter(*keys)
+        send_command([:sinter, *keys])
+      end
+
+      # Intersect multiple sets and store the resulting set in a key.
+      #
+      # @param [String] destination destination key
+      # @param [String, Array<String>] keys keys pointing to sets to intersect
+      # @return [Integer] number of elements in the resulting set
+      def sinterstore(destination, *keys)
+        send_command([:sinterstore, destination, *keys])
+      end
+
+      # Add multiple sets.
+      #
+      # @param [String, Array<String>] keys keys pointing to sets to unify
+      # @return [Array<String>] members in the union
+      def sunion(*keys)
+        send_command([:sunion, *keys])
+      end
+
+      # Add multiple sets and store the resulting set in a key.
+      #
+      # @param [String] destination destination key
+      # @param [String, Array<String>] keys keys pointing to sets to unify
+      # @return [Integer] number of elements in the resulting set
+      def sunionstore(destination, *keys)
+        send_command([:sunionstore, destination, *keys])
+      end
+
+      # Scan a set
+      #
+      # @example Retrieve the first batch of keys in a set
+      #   redis.sscan("set", 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>] the next cursor and all found members
+      def sscan(key, cursor, **options)
+        _scan(:sscan, cursor, [key], **options)
+      end
+
+      # Scan a set
+      #
+      # @example Retrieve all of the keys in a set
+      #   redis.sscan_each("set").to_a
+      #   # => ["key1", "key2", "key3"]
+      #
+      # @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 keys in the set
+      def sscan_each(key, **options, &block)
+        return to_enum(:sscan_each, key, **options) unless block_given?
+
+        cursor = 0
+        loop do
+          cursor, keys = sscan(key, cursor, **options)
+          keys.each(&block)
+          break if cursor == "0"
+        end
+      end
+    end
+  end
+end