discorb 0.15.0 → 0.17.0

data/lib/discorb/client.rb

@@ -40,8 +40,6 @@ module Discorb
     attr_reader :emojis
     # @return [Discorb::Dictionary{Discorb::Snowflake => Discorb::Message}] A dictionary of messages.
     attr_reader :messages
-    # @return [Discorb::Logger] The logger.
-    attr_reader :log
     # @return [Array<Discorb::ApplicationCommand::Command>] The commands that the client is using.
     attr_reader :commands
     # @return [Float] The ping of the client.
@@ -50,12 +48,28 @@ module Discorb
     attr_reader :ping
     # @return [:initialized, :running, :closed] The status of the client.
     attr_reader :status
-    # @return [Integer] The session ID of connection.
-    attr_reader :session_id
     # @return [Hash{String => Discorb::Extension}] The loaded extensions.
     attr_reader :extensions
+    # @return [Hash{Integer => Discorb::Shard}] The shards of the client.
+    attr_reader :shards
     # @private
-    attr_reader :bottom_commands
+    # @return [Hash{Discorb::Snowflake => Discorb::ApplicationCommand::Command}] The commands on the top level.
+    attr_reader :callable_commands
+    # @private
+    # @return [{String => Thread::Mutex}] A hash of mutexes.
+    attr_reader :mutex
+
+    # @!attribute [r] session_id
+    #   @return [String] The session ID of the client or current shard.
+    #   @return [nil] If not connected to the gateway.
+    # @!attribute [r] shard
+    #   @return [Discorb::Shard] The current shard. This is implemented with Thread variables.
+    #   @return [nil] If client has no shard.
+    # @!attribute [r] shard_id
+    #   @return [Discorb::Shard] The current shard ID. This is implemented with Thread variables.
+    #   @return [nil] If client has no shard.
+    # @!attribute [r] logger
+    #   @return [Logger] The logger.
 
     #
     # Initializes a new client.
@@ -63,16 +77,16 @@ module Discorb
     # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions that the client is using.
     # @param [Discorb::Intents] intents The intents that the client is currently using.
     # @param [Integer] message_caches The number of messages to cache.
-    # @param [#write] log The IO object to use for logging.
-    # @param [Boolean] colorize_log Whether to colorize the log.
+    # @param [Logger] logger The IO object to use for logging.
     # @param [:debug, :info, :warn, :error, :critical] log_level The log level.
     # @param [Boolean] wait_until_ready Whether to delay event dispatch until ready.
     # @param [Boolean] fetch_member Whether to fetch member on ready. This may slow down the client. Default to `false`.
-    # @param [String] title The title of the process. `false` to default, `nil` to `discorb: User#0000`. Default to `nil`.
+    # @param [String] title
+    #  The title of the process. `false` to default of ruby, `nil` to `discorb: User#0000`. Default to `nil`.
     #
     def initialize(
       allowed_mentions: nil, intents: nil, message_caches: 1000,
-      log: nil, colorize_log: false, log_level: :info,
+      logger: nil,
       wait_until_ready: true, fetch_member: false,
       title: nil
     )
@@ -80,7 +94,11 @@ module Discorb
       @intents = (intents or Intents.default)
       @events = {}
       @api_version = nil
-      @log = Logger.new(log, colorize_log, log_level)
+      @logger = logger || Logger.new(
+        $stdout,
+        progname: "discorb",
+        level: Logger::ERROR,
+      )
       @user = nil
       @users = Discorb::Dictionary.new
       @channels = Discorb::Dictionary.new
@@ -95,11 +113,13 @@ module Discorb
       @tasks = []
       @conditions = {}
       @commands = []
-      @bottom_commands = []
+      @callable_commands = []
       @status = :initialized
       @fetch_member = fetch_member
       @title = title
       @extensions = {}
+      @mutex = {}
+      @shards = {}
       set_default_events
     end
 
@@ -180,18 +200,22 @@ module Discorb
           events << event_method
         end
         if events.nil?
-          @log.debug "Event #{event_name} doesn't have any proc, skipping"
+          logger.debug "Event #{event_name} doesn't have any proc, skipping"
           next
         end
-        @log.debug "Dispatching event #{event_name}"
+        logger.debug "Dispatching event #{event_name}"
         events.each do |block|
           Async do
             Async(annotation: "Discorb event: #{event_name}") do |_task|
               @events[event_name].delete(block) if block.is_a?(Discorb::EventHandler) && block.metadata[:once]
               block.call(*args)
-              @log.debug "Dispatched proc with ID #{block.id.inspect}"
+              logger.debug "Dispatched proc with ID #{block.id.inspect}"
             rescue StandardError, ScriptError => e
-              dispatch(:error, event_name, args, e)
+              if event_name == :error
+                raise e
+              else
+                dispatch(:error, event_name, args, e)
+              end
             end
           end
         end
@@ -261,7 +285,13 @@ module Discorb
     #
     def fetch_invite(code, with_count: true, with_expiration: true)
       Async do
-        _resp, data = @http.request(Route.new("/invites/#{code}?with_count=#{with_count}&with_expiration=#{with_expiration}", "//invites/:code", :get)).wait
+        _resp, data = @http.request(
+          Route.new(
+            "/invites/#{code}?with_count=#{with_count}&with_expiration=#{with_expiration}",
+            "//invites/:code",
+            :get
+          )
+        ).wait
         Invite.new(self, data, false)
       end
     end
@@ -309,10 +339,11 @@ module Discorb
         activities: [],
         status: status,
         since: nil,
+        afk: nil,
       }
       payload[:activities] = [activity.to_hash] unless activity.nil?
       payload[:status] = status unless status.nil?
-      if @connection
+      if connection
         Async do
           send_gateway(3, **payload)
         end
@@ -371,6 +402,7 @@ module Discorb
       case ext
       when Class
         raise ArgumentError, "#{ext} is not a extension" unless ext < Discorb::Extension
+
         ins = ext.new(self, ...)
       when Discorb::Extension
         ins = ext
@@ -399,13 +431,13 @@ module Discorb
 
       cls = ins.class
       cls.loaded(self, ...) if cls.respond_to? :loaded
-      ins.class.bottom_commands.each do |cmd|
+      ins.class.callable_commands.each do |cmd|
         unless cmd.respond_to? :self_replaced
           cmd.define_singleton_method(:extension) { ins.class.name }
           cmd.replace_block(ins)
           cmd.block.define_singleton_method(:self_replaced) { true }
         end
-        @bottom_commands << cmd
+        @callable_commands << cmd
       end
       @extensions[ins.class.name] = ins
       ins
@@ -423,15 +455,16 @@ module Discorb
     #
     # @note If the token is nil, you should use `discorb run` with the `-e` or `--env` option.
     #
-    def run(token = nil)
-      token ||= ENV["DISCORB_CLI_TOKEN"]
+    def run(token = nil, shards: nil, shard_count: nil)
+      token ||= ENV.fetch("DISCORB_CLI_TOKEN", nil)
       raise ArgumentError, "Token is not specified, and -e/--env is not specified" if token.nil?
-      case ENV["DISCORB_CLI_FLAG"]
+
+      case ENV.fetch("DISCORB_CLI_FLAG", nil)
       when nil
-        start_client(token)
+        start_client(token, shards: shards, shard_count: shard_count)
       when "run"
         before_run(token)
-        start_client(token)
+        start_client(token, shards: shards, shard_count: shard_count)
       when "setup"
         run_setup(token)
       end
@@ -441,44 +474,52 @@ module Discorb
     # Stops the client.
     #
     def close!
-      @connection.send_close
+      if @shards.any?
+        @shards.each(&:close!)
+      else
+        @connection.send_close
+      end
       @tasks.each(&:stop)
       @status = :closed
-      @close_condition.signal
+    end
+
+    def session_id
+      if shard
+        shard.session_id
+      else
+        @session_id
+      end
+    end
+
+    def logger
+      shard&.logger || @logger
+    end
+
+    def shard
+      Thread.current.thread_variable_get("shard")
+    end
+
+    def shard_id
+      Thread.current.thread_variable_get("shard_id")
     end
 
     private
 
     def before_run(token)
       require "json"
-      options = JSON.parse(ENV["DISCORB_CLI_OPTIONS"], symbolize_names: true)
+      options = JSON.parse(ENV.fetch("DISCORB_CLI_OPTIONS", nil), symbolize_names: true)
       setup_commands(token) if options[:setup]
-      if options[:log_level]
-        if options[:log_level] == "none"
-          @log.out = nil
-        else
-          @log.out = case options[:log_file]
-            when nil, "stderr"
-              $stderr
-            when "stdout"
-              $stdout
-            else
-              ::File.open(options[:log_file], "a")
-            end
-          @log.level = options[:log_level].to_sym
-          @log.colorize_log = options[:log_color].nil? ? @log.out.isatty : options[:log_color]
-        end
-      end
     end
 
     def run_setup(token)
       guild_ids = "global"
-      if guilds = ENV["DISCORB_SETUP_GUILDS"]
+      if guilds = ENV.fetch("DISCORB_SETUP_GUILDS", nil)
         guild_ids = guilds.split(",")
       end
       guild_ids = false if guild_ids == ["global"]
       setup_commands(token, guild_ids: guild_ids).wait
-      if ENV["DISCORB_SETUP_SCRIPT"] == "true"
+      clear_commands(token, ENV.fetch("DISCORB_SETUP_CLEAR_GUILDS", "").split(","))
+      if ENV.fetch("DISCORB_SETUP_SCRIPT", nil) == "true"
         @events[:setup]&.each do |event|
           event.call
         end
@@ -486,38 +527,93 @@ module Discorb
       end
     end
 
-    def start_client(token)
-      Async do |_task|
-        Signal.trap(:SIGINT) do
-          @log.info "SIGINT received, closing..."
-          Signal.trap(:SIGINT, "DEFAULT")
-          close!
+    def set_status(status, shard)
+      if shard.nil?
+        @status = status
+      else
+        @shards[shard].status = status
+      end
+    end
+
+    def connection
+      if shard_id
+        @shards[shard_id].connection
+      else
+        @connection
+      end
+    end
+
+    def connection=(value)
+      if shard_id
+        @shards[shard_id].connection = value
+      else
+        @connection = value
+      end
+    end
+
+    def session_id=(value)
+      if shard_id
+        @shards[shard_id].session_id = value
+      else
+        @session_id = value
+      end
+    end
+
+    def start_client(token, shards: nil, shard_count: nil)
+      @token = token.to_s
+      @shard_count = shard_count
+      Signal.trap(:SIGINT) do
+        logger.info "SIGINT received, closing..."
+        Signal.trap(:SIGINT, "DEFAULT")
+        close!
+      end
+      if shards.nil?
+        main_loop(nil)
+      else
+        @shards = shards.map.with_index do |shard, i|
+          Shard.new(self, shard, shard_count, i)
         end
-        @token = token.to_s
-        @close_condition = Async::Condition.new
-        @main_task = Async do
-          @status = :running
-          connect_gateway(false).wait
-        rescue StandardError
-          @status = :stopped
-          @close_condition.signal
-          raise
+        @shards[..-1].each_with_index do |shard, i|
+          shard.next_shard = @shards[i + 1]
         end
-        @close_condition.wait
-        @main_task.stop
+        @shards.each { |s| s.thread.join }
+      end
+    end
+
+    def main_loop(shard)
+      set_status(:running, shard)
+      connect_gateway(false).wait
+    rescue StandardError
+      set_status(:closed, shard)
+      raise
+    end
+
+    def main_task
+      if shard_id
+        shard.main_task
+      else
+        @main_task
+      end
+    end
+
+    def main_task=(value)
+      if shard_id
+        shard.main_task = value
+      else
+        @main_task = value
       end
     end
 
     def set_default_events
       on :error, override: true do |event_name, _args, e|
         message = "An error occurred while dispatching #{event_name}:\n#{e.full_message}"
-        @log.error message, fallback: $stderr
+        logger.error message
       end
 
       once :standby do
         next if @title == false
 
-        title = @title || ENV["DISCORB_CLI_TITLE"] || "discorb: #{@user}"
+        title = @title || ENV.fetch("DISCORB_CLI_TITLE", nil) || "discorb: #{@user}"
         Process.setproctitle title
       end
     end

data/lib/discorb/common.rb

@@ -4,7 +4,9 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v10"
   # @return [String] The version of discorb.
-  VERSION = "0.15.0"
+  VERSION = "0.17.0"
+  # @return [Array<Integer>] The version array of discorb.
+  VERSION_ARRAY = VERSION.split(".").map(&:to_i).freeze
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}".freeze
 
@@ -25,8 +27,11 @@ module Discorb
       end
     end
 
-    # @private
+    def inspect
+      "#<#{self.class}: #{@id}>"
+    end
 
+    # @private
     def hash
       @id.hash
     end
@@ -37,7 +42,12 @@ module Discorb
   #
   # @see https://discord.com/developers/docs/reference#snowflakes Official Discord API docs
   class Snowflake < String
+    #
+    # Initialize new snowflake.
     # @private
+    #
+    # @param [#to_s] value The value of the snowflake.
+    #
     def initialize(value)
       @value = value.to_i
       super(@value.to_s)
@@ -92,7 +102,7 @@ module Discorb
     end
 
     def timestamp
-      Time.at(((@value >> 22) + 1_420_070_400_000) / 1000)
+      Time.at(((@value >> 22) + 1_420_070_400_000) / 1000.0)
     end
 
     def worker_id
@@ -127,6 +137,10 @@ module Discorb
       @method = method
     end
 
+    def inspect
+      "#<#{self.class} #{self.identifier}>"
+    end
+
     def hash
       @url.hash
     end
@@ -138,6 +152,7 @@ module Discorb
     def major_param
       param_type = @key.split("/").find { |k| k.start_with?(":") }
       return "" unless param_type
+
       param = url.gsub(API_BASE_URL, "").split("/")[@key.split("/").index(param_type) - 1]
       %w[:channel_id :guild_id :webhook_id].include?(param_type) ? param : ""
     end

data/lib/discorb/components/button.rb

@@ -21,7 +21,9 @@ module Discorb
     attr_accessor :disabled
     alias disabled? disabled
 
-    @styles = {
+    # @private
+    # @return [{Symbol => Integer}] The mapping of button styles.
+    STYLES = {
       primary: 1,
       secondary: 2,
       success: 3,
@@ -51,7 +53,8 @@ module Discorb
     #
     # Converts the button to a hash.
     #
-    # @see https://discord.com/developers/docs/interactions/message-components#button-object-button-structure Official Discord API docs
+    # @see https://discord.com/developers/docs/interactions/message-components#button-object-button-structure
+    #  Official Discord API docs
     # @return [Hash] A hash representation of the button.
     #
     def to_hash
@@ -59,7 +62,7 @@ module Discorb
         {
           type: 2,
           label: @label,
-          style: self.class.styles[@style],
+          style: STYLES[@style],
           url: @url,
           emoji: @emoji&.to_hash,
           disabled: @disabled,
@@ -68,7 +71,7 @@ module Discorb
         {
           type: 2,
           label: @label,
-          style: self.class.styles[@style],
+          style: STYLES[@style],
           custom_id: @custom_id,
           emoji: @emoji&.to_hash,
           disabled: @disabled,
@@ -81,9 +84,6 @@ module Discorb
     end
 
     class << self
-      # @private
-      attr_reader :styles
-
       #
       # Creates a new button from a hash.
       #

data/lib/discorb/components/select_menu.rb

@@ -37,7 +37,8 @@ module Discorb
     #
     # Converts the select menu to a hash.
     #
-    # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-menu-structure Official Discord API docs
+    # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-menu-structure
+    #   Official Discord API docs
     # @return [Hash] A hash representation of the select menu.
     #
     def to_hash
@@ -109,7 +110,8 @@ module Discorb
       #
       # Converts the option to a hash.
       #
-      # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-option-structure Official Discord API docs
+      # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-option-structure
+      #   Official Discord API docs
       # @return [Hash] Hash representation of the option.
       #
       def to_hash
@@ -122,22 +124,8 @@ module Discorb
         }
       end
 
-      # @private
-      def hash_emoji(emoji)
-        case emoji
-        when UnicodeEmoji
-          {
-            id: nil,
-            name: emoji.to_s,
-            animated: false,
-          }
-        when CustomEmoji
-          {
-            id: emoji.id,
-            name: emoji.name,
-            animated: emoji.animated?,
-          }
-        end
+      def inspect
+        "#<#{self.class} #{@label}: #{@value}>"
       end
 
       class << self

data/lib/discorb/components/text_input.rb

@@ -40,7 +40,16 @@ module Discorb
     # @param [String, nil] value The prefilled value of the text input.
     # @param [String, nil] placeholder The placeholder of the text input.
     #
-    def initialize(label, custom_id, style, min_length: nil, max_length: nil, required: false, value: nil, placeholder: nil)
+    def initialize(
+      label,
+      custom_id,
+      style,
+      min_length: nil,
+      max_length: nil,
+      required: false,
+      value: nil,
+      placeholder: nil
+    )
       @label = label
       @custom_id = custom_id
       @style = style
@@ -54,7 +63,8 @@ module Discorb
     #
     # Converts the select menu to a hash.
     #
-    # @see https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-structure Official Discord API docs
+    # @see https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-structure
+    #   Official Discord API docs
     # @return [Hash] A hash representation of the text input.
     #
     def to_hash

data/lib/discorb/components.rb

@@ -63,4 +63,4 @@ end
 
 %w[button text_input select_menu].each do |name|
   require_relative "components/#{name}"
-end
+end

data/lib/discorb/dictionary.rb

@@ -55,6 +55,8 @@ module Discorb
       @cache.delete(id.to_s)
     end
 
+    alias delete remove
+
     #
     # Get an item from the dictionary.
     #