discorb 0.16.0 → 0.18.0

data/lib/discorb/client.rb

@@ -54,7 +54,7 @@ module Discorb
     attr_reader :shards
     # @private
     # @return [Hash{Discorb::Snowflake => Discorb::ApplicationCommand::Command}] The commands on the top level.
-    attr_reader :bottom_commands
+    attr_reader :callable_commands
     # @private
     # @return [{String => Thread::Mutex}] A hash of mutexes.
     attr_reader :mutex
@@ -66,7 +66,7 @@ module Discorb
     #   @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 [Integer] The current shard ID. This is implemented with Thread variables.
     #   @return [nil] If client has no shard.
     # @!attribute [r] logger
     #   @return [Logger] The logger.
@@ -81,7 +81,8 @@ module Discorb
     # @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,
@@ -93,7 +94,11 @@ module Discorb
       @intents = (intents or Intents.default)
       @events = {}
       @api_version = nil
-      @logger = logger || Logger.new($stdout, progname: "discorb")
+      @logger = logger || Logger.new(
+        $stdout,
+        progname: "discorb",
+        level: Logger::ERROR,
+      )
       @user = nil
       @users = Discorb::Dictionary.new
       @channels = Discorb::Dictionary.new
@@ -108,7 +113,7 @@ module Discorb
       @tasks = []
       @conditions = {}
       @commands = []
-      @bottom_commands = []
+      @callable_commands = []
       @status = :initialized
       @fetch_member = fetch_member
       @title = title
@@ -206,7 +211,11 @@ module Discorb
               block.call(*args)
               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
@@ -276,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
@@ -387,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
@@ -415,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
@@ -440,9 +456,10 @@ module Discorb
     # @note If the token is nil, you should use `discorb run` with the `-e` or `--env` option.
     #
     def run(token = nil, shards: nil, shard_count: nil)
-      token ||= ENV["DISCORB_CLI_TOKEN"]
+      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, shards: shards, shard_count: shard_count)
       when "run"
@@ -458,7 +475,7 @@ module Discorb
     #
     def close!
       if @shards.any?
-        @shards.each(&:close!)
+        @shards.each_value(&:close!)
       else
         @connection.send_close
       end
@@ -490,18 +507,20 @@ module Discorb
 
     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]
     end
 
     def run_setup(token)
-      guild_ids = "global"
-      if guilds = ENV["DISCORB_SETUP_GUILDS"]
+      # @type var guild_ids: Array[String] | false
+      guild_ids = false
+      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
@@ -534,8 +553,9 @@ module Discorb
     end
 
     def session_id=(value)
-      if shard_id
-        @shards[shard_id].session_id = value
+      sid = shard_id
+      if sid
+        @shards[sid].session_id = value
       else
         @session_id = value
       end
@@ -552,28 +572,22 @@ module Discorb
       if shards.nil?
         main_loop(nil)
       else
-        @shards = shards.map.with_index do |shard, i|
-          Shard.new(self, shard, shard_count, i)
+        @shards = shards.to_h.with_index do |shard, i|
+          [shard, Shard.new(self, shard, shard_count, i)]
         end
-        @shards[..-1].each_with_index do |shard, i|
-          shard.next_shard = @shards[i + 1]
+        @shards.values[..-1].each_with_index do |shard, i|
+          shard.next_shard = @shards.values[i + 1]
         end
-        @shards.each { |s| s.thread.join }
+        @shards.each_value { |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
+      set_status(:running, shard)
+      connect_gateway(false).wait
+    rescue StandardError
+      set_status(:closed, shard)
+      raise
     end
 
     def main_task
@@ -595,13 +609,13 @@ module Discorb
     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}"
-        logger.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/color.rb

@@ -85,7 +85,11 @@ module Discorb
     # @return [Hash{:r, :g, :b => Integer}] A RGB hash.
     #
     def to_rgb_hash
-      [@value / (256 * 256), @value / 256 % 256, @value % 256]
+      {
+        r: @value / (256 * 256),
+        g: @value / 256 % 256,
+        b: @value % 256,
+      }
     end
 
     alias deconstruct_keys to_rgb_hash
@@ -131,65 +135,38 @@ module Discorb
     # Create a color from a Discord's color.
     # Currently these colors are supported:
     #
-    # | Color Name | Hexadecimal |
-    # |------------|------------|
-    # | `:teal` | `#1abc9c` |
-    # | `:dark_teal` | `#11806a` |
-    # | `:green` | `#2ecc71` |
-    # | `:dark_green` | `#1f8b4c` |
-    # | `:blue` | `#3498db` |
-    # | `:dark_blue` | `#206694` |
-    # | `:purple` | `#9b59b6` |
-    # | `:dark_purple` | `#71368a` |
-    # | `:magenta` | `#e91e63` |
-    # | `:dark_magenta` | `#ad1457` |
-    # | `:gold` | `#f1c40f` |
-    # | `:dark_gold` | `#c27c0e` |
-    # | `:orange` | `#e67e22` |
-    # | `:dark_orange` | `#a84300` |
-    # | `:red` | `#e74c3c` |
-    # | `:dark_red` | `#992d22` |
-    # | `:lighter_grey` | `#95a5a6` |
-    # | `:lighter_gray` | `#95a5a6` |
-    # | `:dark_grey` | `#607d8b` |
-    # | `:dark_gray` | `#607d8b` |
-    # | `:light_grey` | `#979c9f` |
-    # | `:light_gray` | `#979c9f` |
-    # | `:darker_grey` | `#546e7a` |
-    # | `:darker_gray` | `#546e7a` |
-    # | `:og_blurple` | `#7289da` |
-    # | `:blurple` | `#5865f2` |
-    # | `:greyple` | `#99aab5` |
-    # | `:dark_theme` | `#36393f` |
-    # | `:fuchsia` | `#eb459e` |
-    # | `:dark_teal` | `#11806a` |
-    # | `:green` | `#2ecc71` |
-    # | `:dark_green` | `#1f8b4c` |
-    # | `:blue` | `#3498db` |
-    # | `:dark_blue` | `#206694` |
-    # | `:purple` | `#9b59b6` |
-    # | `:dark_purple` | `#71368a` |
-    # | `:magenta` | `#e91e63` |
-    # | `:dark_magenta` | `#ad1457` |
-    # | `:gold` | `#f1c40f` |
-    # | `:dark_gold` | `#c27c0e` |
-    # | `:orange` | `#e67e22` |
-    # | `:dark_orange` | `#a84300` |
-    # | `:red` | `#e74c3c` |
-    # | `:dark_red` | `#992d22` |
-    # | `:lighter_grey` | `#95a5a6` |
-    # | `:lighter_gray` | `#95a5a6` |
-    # | `:dark_grey` | `#607d8b` |
-    # | `:dark_gray` | `#607d8b` |
-    # | `:light_grey` | `#979c9f` |
-    # | `:light_gray` | `#979c9f` |
-    # | `:darker_grey` | `#546e7a` |
-    # | `:darker_gray` | `#546e7a` |
-    # | `:og_blurple` | `#7289da` |
-    # | `:blurple` | `#5865f2` |
-    # | `:greyple` | `#99aab5` |
-    # | `:dark_theme` | `#36393f` |
-    # | `:fuchsia` | `#eb459e` |
+    # | Color name      | Color code |
+    # |-----------------|------------|
+    # | `:teal`         | `#1abc9c`  |
+    # | `:dark_teal`    | `#11806a`  |
+    # | `:green`        | `#2ecc71`  |
+    # | `:dark_green`   | `#1f8b4c`  |
+    # | `:blue`         | `#3498db`  |
+    # | `:dark_blue`    | `#206694`  |
+    # | `:purple`       | `#9b59b6`  |
+    # | `:dark_purple`  | `#71368a`  |
+    # | `:magenta`      | `#e91e63`  |
+    # | `:dark_magenta` | `#ad1457`  |
+    # | `:gold`         | `#f1c40f`  |
+    # | `:dark_gold`    | `#c27c0e`  |
+    # | `:orange`       | `#e67e22`  |
+    # | `:dark_orange`  | `#a84300`  |
+    # | `:red`          | `#e74c3c`  |
+    # | `:dark_red`     | `#992d22`  |
+    # | `:lighter_grey` | `#95a5a6`  |
+    # | `:lighter_gray` | `#95a5a6`  |
+    # | `:dark_grey`    | `#607d8b`  |
+    # | `:dark_gray`    | `#607d8b`  |
+    # | `:light_grey`   | `#979c9f`  |
+    # | `:light_gray`   | `#979c9f`  |
+    # | `:darker_grey`  | `#546e7a`  |
+    # | `:darker_gray`  | `#546e7a`  |
+    # | `:og_blurple`   | `#7289da`  |
+    # | `:blurple`      | `#5865f2`  |
+    # | `:greyple`      | `#99aab5`  |
+    # | `:dark_theme`   | `#36393f`  |
+    # | `:fuchsia`      | `#eb459e`  |
+    # | `:yellow`       | `#fee75c`  |
     #
     # @param [Symbol] color A Discord color name.
     #

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v10"
   # @return [String] The version of discorb.
-  VERSION = "0.16.0"
+  VERSION = "0.18.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.
@@ -152,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

@@ -53,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

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

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

@@ -34,7 +34,7 @@ module Discorb
       @cache[id.to_s] = body
       @cache = @cache.sort_by(&@sort).to_h if @sort
       @cache.delete(@cache.keys[0]) if !@limit.nil? && @cache.size > @limit
-      body
+      self
     end
 
     #

data/lib/discorb/embed.rb

@@ -35,7 +35,7 @@ module Discorb
     #
     # @param [String] title The title of embed.
     # @param [String] description The description of embed.
-    # @param [Discorb::Color] color The color of embed.
+    # @param [Discorb::Color, Integer] color The color of embed.
     # @param [String] url The url of embed.
     # @param [Time] timestamp The timestamp of embed.
     # @param [Discorb::Embed::Author] author The author field of embed.
@@ -44,19 +44,29 @@ module Discorb
     # @param [Discorb::Embed::Image, String] image The image of embed.
     # @param [Discorb::Embed::Thumbnail, String] thumbnail The thumbnail of embed.
     #
-    def initialize(title = nil, description = nil, color: nil, url: nil, timestamp: nil, author: nil,
-                                                   fields: nil, footer: nil, image: nil, thumbnail: nil)
+    def initialize(
+      title = nil,
+      description = nil,
+      color: nil,
+      url: nil,
+      timestamp: nil,
+      author: nil,
+      fields: nil,
+      footer: nil,
+      image: nil,
+      thumbnail: nil
+    )
       @title = title
       @description = description
       @url = url
       @timestamp = timestamp
-      @color = color
+      @color = color && (color.is_a?(Color) ? color : Color.new(color))
       @author = author
       @fields = fields || []
       @footer = footer
       @image = image && (image.is_a?(String) ? Image.new(image) : image)
       @thumbnail = thumbnail && (thumbnail.is_a?(String) ? Thumbnail.new(thumbnail) : thumbnail)
-      @type = "rich"
+      @type = :rich
     end
 
     #
@@ -103,6 +113,7 @@ module Discorb
     # @return [Hash] Converted embed.
     #
     def to_hash
+      # @type var ret: Hash[untyped, untyped]
       ret = { type: "rich" }
       ret[:title] = @title if @title
       ret[:description] = @description if @description
@@ -161,7 +172,8 @@ module Discorb
       #
       # Convert author to hash.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted author.
       #
       def to_hash
@@ -193,7 +205,8 @@ module Discorb
       #
       # Convert footer to hash.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted footer.
       #
       def to_hash
@@ -231,7 +244,8 @@ module Discorb
       #
       # Convert field to hash.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted field.
       #
       def to_hash
@@ -279,7 +293,8 @@ module Discorb
       #
       # Convert image to hash for sending.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted image.
       #
       def to_hash
@@ -323,7 +338,8 @@ module Discorb
       #
       # Convert thumbnail to hash for sending.
       #
-      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure Offical Discord API Docs
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure
+      #   Offical Discord API Docs
       # @return [Hash] Converted thumbnail.
       #
       def to_hash

data/lib/discorb/emoji.rb

@@ -29,7 +29,7 @@ module Discorb
     attr_reader :roles
     # @return [Discorb::User] The user that created this emoji.
     attr_reader :user
-    # @return [Boolean] Whether the emoji requires colons.
+    # @return [Discorb::Guild] The guild that owns this emoji.
     attr_reader :guild
     # @return [Boolean] whether the emoji is managed by integration (ex: Twitch).
     attr_reader :managed
@@ -103,7 +103,10 @@ module Discorb
         payload = {}
         payload[:name] = name if name != Discorb::Unset
         payload[:roles] = roles.map { |r| Discorb::Utils.try(r, :id) } if roles != Discorb::Unset
-        @client.http.request(Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id", :patch), payload, audit_log_reason: reason)
+        @client.http.request(
+          Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id",
+                    :patch), payload, audit_log_reason: reason,
+        )
         self
       end
     end
@@ -120,7 +123,10 @@ module Discorb
     #
     def delete!(reason: nil)
       Async do
-        @client.http.request(Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id", :delete), audit_log_reason: reason).wait
+        @client.http.request(
+          Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id",
+                    :delete), {}, audit_log_reason: reason,
+        ).wait
         @available = false
         self
       end
@@ -230,10 +236,31 @@ module Discorb
       elsif EmojiTable::UNICODE_TO_DISCORD.key?(name)
         @name = EmojiTable::UNICODE_TO_DISCORD[name][0]
         @value = name
+      elsif EmojiTable::SKIN_TONES.any? { |t| name.include?(t) }
+        name2 = name.dup
+        EmojiTable::SKIN_TONES.each.with_index do |t, i|
+          next unless name2.include?(t)
+
+          @skin_tone = i
+          name2.sub!(t, "")
+          break
+        end
+        raise ArgumentError, "Invalid skin tone: #{tone}" unless @skin_tone
+
+        @name = EmojiTable::UNICODE_TO_DISCORD[name2].first
+        @value = name
       else
         raise ArgumentError, "No such emoji: #{name}"
       end
-      @value += EmojiTable::SKIN_TONES[tone] if tone.positive?
+      if tone.positive?
+        unless @value = EmojiTable::DISCORD_TO_UNICODE["#{name}_tone#{tone}"]
+          raise ArgumentError,
+                "Invalid skin tone for emoji: #{name}"
+        end
+
+        @name = "#{name}_tone#{tone}"
+        @skin_tone = tone
+      end
     end
 
     # @return [String] The unicode string of the emoji.