discorb 0.14.0 → 0.16.0

data/lib/discorb/audit_logs.rb

@@ -14,7 +14,10 @@ module Discorb
     # @return [Array<Discorb::AuditLog::Entry>] The entries in this audit log.
     attr_reader :entries
 
+    #
+    # Initializes a new instance of the AuditLog class.
     # @private
+    #
     def initialize(client, data, guild)
       @client = client
       @guild = guild
@@ -24,6 +27,10 @@ module Discorb
       @entries = data[:audit_log_entries].map { |entry| AuditLog::Entry.new(@client, entry, guild.id) }
     end
 
+    def inspect
+      "<#{self.class} #{@entries.length} entries>"
+    end
+
     #
     # Gets an entry from entries.
     #
@@ -108,8 +115,11 @@ module Discorb
       # @!attribute [r] user
       #   @return [Discorb::User] The user who performed the action.
 
+      #
+      # @return [{Integer => Symbol}] The map of events to their respective changes.
       # @private
-      @events = {
+      #
+      EVENTS = {
         1 => :guild_update,
         10 => :channel_create,
         11 => :channel_update,
@@ -159,24 +169,30 @@ module Discorb
         112 => :thread_delete,
       }.freeze
 
+      #
+      # The converter for the change.
       # @private
-      @converts = {
+      #
+      CONVERTERS = {
         channel: ->(client, id, _guild_id) { client.channels[id] },
         thread: ->(client, id, _guild_id) { client.channels[id] },
         role: ->(client, id, guild_id) { client.guilds[guild_id]&.roles&.[](id) },
         member: ->(client, id, guild_id) { client.guilds[guild_id]&.members&.[](id) },
         guild: ->(client, id, _guild_id) { client.guilds[id] },
         message: ->(client, id, _guild_id) { client.messages[id] },
-      }
+      }.freeze
 
+      #
+      # Initializes a new AuditLog entry.
       # @private
+      #
       def initialize(client, data, guild_id)
         @client = client
         @guild_id = Snowflake.new(guild_id)
         @id = Snowflake.new(data[:id])
         @user_id = Snowflake.new(data[:user_id])
         @target_id = Snowflake.new(data[:target_id])
-        @type = self.class.events[data[:action_type]]
+        @type = EVENTS[data[:action_type]]
         @target = self.class.converts[@type.to_s.split("_")[0].to_sym]&.call(client, @target_id, @gui)
         @target ||= Snowflake.new(data[:target_id])
         @changes = data[:changes] && Changes.new(data[:changes])
@@ -223,8 +239,11 @@ module Discorb
         attr_reader :data
 
         #
+        # Initializes a new changes object.
         # @private
         #
+        # @param [Hash] data The data to initialize with.
+        #
         def initialize(data)
           @data = data.to_h { |d| [d[:key].to_sym, d] }
           @data.each do |k, v|
@@ -232,6 +251,9 @@ module Discorb
           end
         end
 
+        #
+        # Formats the changes into a string.
+        #
         def inspect
           "#<#{self.class} #{@data.length} changes>"
         end
@@ -270,7 +292,10 @@ module Discorb
         # @return [Object] The new value of the change.
         attr_reader :new_value
 
+        #
+        # Initializes a new change object.
         # @private
+        #
         def initialize(data)
           @key = data[:key].to_sym
           method = case @key.to_s
@@ -298,10 +323,20 @@ module Discorb
           @new_value.__send__(method, ...)
         end
 
+        #
+        # Format the change into a string.
+        #
+        # @return [String] The string representation of the change.
+        #
         def inspect
           "#<#{self.class} #{@key.inspect} #{@old_value.inspect} -> #{@new_value.inspect}>"
         end
 
+        #
+        # Whether the change responds to the given method.
+        #
+        # @return [Boolean] Whether the change responds to the given method.
+        #
         def respond_to_missing?(method, include_private = false)
           @new_value.respond_to?(method, include_private)
         end
@@ -321,7 +356,10 @@ module Discorb
       # @return [Discorb::Integration::Account] The account of the integration.
       attr_reader :account
 
+      #
+      # Initializes a new integration object.
       # @private
+      #
       def initialize(data)
         @id = Snowflake.new(data[:id])
         @type = data[:type].to_sym

data/lib/discorb/channel.rb

@@ -19,7 +19,10 @@ module Discorb
     @channel_type = nil
     @subclasses = []
 
+    #
+    # Initializes a new instance of the Channel class.
     # @private
+    #
     def initialize(client, data, no_cache: false)
       @client = client
       @data = {}
@@ -44,22 +47,35 @@ module Discorb
       "#<#{self.class} \"##{@name}\" id=#{@id}>"
     end
 
+    #
+    # Returns the descendants of the Channel class.
     # @private
+    #
     def self.descendants
       ObjectSpace.each_object(Class).select { |klass| klass < self }
     end
 
+    #
+    # Creates a new instance of the Channel class or instance of its descendants.
     # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    # @param [Boolean] no_cache Whether to disable cache the object.
+    #
     def self.make_channel(client, data, no_cache: false)
       descendants.each do |klass|
         return klass.new(client, data, no_cache: no_cache) if !klass.channel_type.nil? && klass.channel_type == data[:type]
       end
-      client.log.warn("Unknown channel type #{data[:type]}, initialized GuildChannel")
+      client.logger.warn("Unknown channel type #{data[:type]}, initialized GuildChannel")
       GuildChannel.new(client, data)
     end
 
     class << self
+      #
       # @private
+      # @return [Integer] The type of the channel.
+      #
       attr_reader :channel_type
     end
 
@@ -67,7 +83,12 @@ module Discorb
       self.class.channel_type
     end
 
+    #
+    # Returns the channel id to request.
     # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    #
     def channel_id
       Async do
         @id
@@ -114,7 +135,7 @@ module Discorb
     #
     # @param [Discorb::GuildChannel] other The channel to compare.
     #
-    # @return [-1, 1] -1 if the channel is at lower than the other, 1 if the channel is at highter than the other.
+    # @return [-1, 0, 1] -1 if the channel is at lower than the other, 1 if the channel is at highter than the other.
     #
     def <=>(other)
       return 0 unless other.respond_to?(:position)
@@ -239,17 +260,15 @@ module Discorb
     # @return [Time] The time when the last pinned message was pinned.
     attr_reader :last_pin_timestamp
     alias last_pinned_at last_pin_timestamp
-    # @return [Array<Discorb::ThreadChannel>] The threads in the channel.
-    attr_reader :threads
 
     include Messageable
 
     @channel_type = 0
 
-    # @private
-    def initialize(client, data, no_cache: false)
-      super
-      @threads = Dictionary.new
+    # @!attribute [r] threads
+    #   @return [Array<Discorb::ThreadChannel>] The threads in the channel.
+    def threads
+      guild.threads.select { |thread| thread.parent == self }
     end
 
     #
@@ -421,7 +440,7 @@ module Discorb
     def fetch_invites
       Async do
         _resp, data = @client.http.request(Route.new("/channels/#{@id}/invites", "//channels/:channel_id/invites", :get)).wait
-        data.map { |invite| Invite.new(@client, invite) }
+        data.map { |invite| Invite.new(@client, invite, false) }
       end
     end
 
@@ -446,7 +465,7 @@ module Discorb
           temporary: temporary,
           unique: unique,
         }, audit_log_reason: reason).wait
-        Invite.new(@client, data)
+        Invite.new(@client, data, false)
       end
     end
 
@@ -666,7 +685,10 @@ module Discorb
     attr_reader :bitrate
     # @return [Integer] The user limit of the voice channel.
     attr_reader :user_limit
+    #
     # @private
+    # @return [Discorb::Dictionary{Discorb::Snowflake => StageInstance}] The stage instances associated with the stage channel.
+    #
     attr_reader :stage_instances
 
     include Connectable
@@ -675,7 +697,10 @@ module Discorb
     #   @return [Discorb::StageInstance] The stage instance of the channel.
 
     @channel_type = 13
+    #
+    # Initialize a new stage channel.
     # @private
+    #
     def initialize(...)
       @stage_instances = Dictionary.new
       super(...)
@@ -825,12 +850,17 @@ module Discorb
     include Messageable
     @channel_type = nil
 
+    #
+    # Initialize a new thread channel.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the thread channel.
+    # @param [Boolean] no_cache Whether to disable the cache.
+    #
     def initialize(client, data, no_cache: false)
       @members = Dictionary.new
       super
-      @client.channels[@parent_id].threads[@id] = self
-
       @client.channels[@id] = self unless no_cache
     end
 
@@ -1117,7 +1147,12 @@ module Discorb
   class DMChannel < Channel
     include Messageable
 
+    #
+    # Returns the channel id to request.
     # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    #
     def channel_id
       Async do
         @id

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
+    # @return [Hash{Discorb::Snowflake => Discorb::ApplicationCommand::Command}] The commands on the top level.
     attr_reader :bottom_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,8 +77,7 @@ 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`.
@@ -72,7 +85,7 @@ module Discorb
     #
     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 +93,7 @@ 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")
       @user = nil
       @users = Discorb::Dictionary.new
       @channels = Discorb::Dictionary.new
@@ -100,6 +113,8 @@ module Discorb
       @fetch_member = fetch_member
       @title = title
       @extensions = {}
+      @mutex = {}
+      @shards = {}
       set_default_events
     end
 
@@ -180,16 +195,16 @@ 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)
             end
@@ -309,10 +324,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
@@ -423,15 +439,15 @@ module Discorb
     #
     # @note If the token is nil, you should use `discorb run` with the `-e` or `--env` option.
     #
-    def run(token = nil)
+    def run(token = nil, shards: nil, shard_count: nil)
       token ||= ENV["DISCORB_CLI_TOKEN"]
       raise ArgumentError, "Token is not specified, and -e/--env is not specified" if token.nil?
       case ENV["DISCORB_CLI_FLAG"]
       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,10 +457,33 @@ 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
@@ -453,22 +492,6 @@ module Discorb
       require "json"
       options = JSON.parse(ENV["DISCORB_CLI_OPTIONS"], 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)
@@ -486,32 +509,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)
+      close_condition = Async::Condition.new
+      self.main_task = Async do
+        set_status(:running, shard)
+        connect_gateway(false).wait
+      rescue StandardError
+        set_status(:running, shard)
+        close_condition.signal
+        raise
+      end
+      close_condition.wait
+      main_task.stop
+    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, fallback: $stderr
       end
 
       once :standby do

data/lib/discorb/common.rb

@@ -2,9 +2,11 @@
 
 module Discorb
   # @return [String] The API base URL.
-  API_BASE_URL = "https://discord.com/api/v9"
+  API_BASE_URL = "https://discord.com/api/v10"
   # @return [String] The version of discorb.
-  VERSION = "0.14.0"
+  VERSION = "0.16.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

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,
@@ -59,7 +61,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 +70,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 +83,6 @@ module Discorb
     end
 
     class << self
-      # @private
-      attr_reader :styles
-
       #
       # Creates a new button from a hash.
       #