discorb 0.5.5 → 0.7.0

data/lib/discorb/{command.rb → app_command.rb}

@@ -4,9 +4,9 @@ module Discorb
   #
   # Handles application commands.
   #
-  module Command
+  module ApplicationCommand
     #
-    # Module to handle commands.
+    # Module to handle application commands.
     #
     module Handler
       #
@@ -24,15 +24,16 @@ module Discorb
       #   | `:type` | `Object` | Type of the option. |
       #   | `:choice` | `Hash{String => String, Integer, Float}` | Type of the option. |
       #
-      # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
       # @param [Proc] block Command block.
       #
-      # @return [Discorb::Command::Command::SlashCommand]
+      # @return [Discorb::ApplicationCommand::Command::SlashCommand] Command object.
       #
       # @see file:docs/application_command.md#register-slash-command
+      # @see file:docs/cli/setup.md
       #
-      def slash(command_name, description, options = {}, guild_ids: [], &block)
-        command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, guild_ids, block, 1, "")
+      def slash(command_name, description, options = {}, guild_ids: nil, &block)
+        command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, guild_ids, block, 1, "")
         @commands << command
         @bottom_commands << command
         command
@@ -43,18 +44,19 @@ module Discorb
       #
       # @param [String] command_name Command name.
       # @param [String] description Command description.
-      # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
       #
-      # @yield Block to execute as the command. It can be used to define sub-commands.
-      # @yieldself [Discorb::Command::Command::GroupCommand] Group command.
+      # @yield Block to yield with the command.
+      # @yieldparam [Discorb::ApplicationCommand::Command::GroupCommand] group Group command.
       #
-      # @return [Discorb::Command::Command::GroupCommand] Command object.
+      # @return [Discorb::ApplicationCommand::Command::GroupCommand] Command object.
       #
       # @see file:docs/slash_command.md
+      # @see file:docs/cli/setup.md
       #
-      def slash_group(command_name, description, guild_ids: [], &block)
-        command = Discorb::Command::Command::GroupCommand.new(command_name, description, guild_ids, nil, self)
-        command.instance_eval(&block) if block_given?
+      def slash_group(command_name, description, guild_ids: nil, &block)
+        command = Discorb::ApplicationCommand::Command::GroupCommand.new(command_name, description, guild_ids, nil, self)
+        command.yield_self(&block) if block_given?
         @commands << command
         command
       end
@@ -63,16 +65,16 @@ module Discorb
       # Add message context menu command.
       #
       # @param [String] command_name Command name.
-      # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
       # @param [Proc] block Command block.
       # @yield [interaction, message] Block to execute.
-      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] Interaction object.
-      # @yieldparam [Discorb::Message] user Message object.
+      # @yieldparam [Discorb::ApplicationCommandInteraction::UserMenuCommand] interaction Interaction object.
+      # @yieldparam [Discorb::Message] message Message object.
       #
-      # @return [Discorb::Command::Command] Command object.
+      # @return [Discorb::ApplicationCommand::Command] Command object.
       #
-      def message_command(command_name, guild_ids: [], &block)
-        command = Discorb::Command::Command.new(command_name, guild_ids, block, 3)
+      def message_command(command_name, guild_ids: nil, &block)
+        command = Discorb::ApplicationCommand::Command.new(command_name, guild_ids, block, 3)
         @commands << command
         command
       end
@@ -81,16 +83,16 @@ module Discorb
       # Add user context menu command.
       #
       # @param [String] command_name Command name.
-      # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to set the command to. `false` to global command, `nil` to use default.
       # @param [Proc] block Command block.
       # @yield [interaction, user] Block to execute.
-      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] Interaction object.
+      # @yieldparam [Discorb::ApplicationCommandInteraction::UserMenuCommand] interaction Interaction object.
       # @yieldparam [Discorb::User] user User object.
       #
-      # @return [Discorb::Command::Command] Command object.
+      # @return [Discorb::ApplicationCommand::Command] Command object.
       #
-      def user_command(command_name, guild_ids: [], &block)
-        command = Discorb::Command::Command.new(command_name, guild_ids, block, 2)
+      def user_command(command_name, guild_ids: nil, &block)
+        command = Discorb::ApplicationCommand::Command.new(command_name, guild_ids, block, 2)
         @commands << command
         command
       end
@@ -100,20 +102,32 @@ module Discorb
       # @see Client#initialize
       #
       # @param [String] token Bot token.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to use as default. If `false` is given, it will be global command.
+      #
       # @note `token` parameter only required if you don't run client.
       #
-      def setup_commands(token = nil)
+      def setup_commands(token = nil, guild_ids: nil)
         Async do
           @token ||= token
           @http = HTTP.new(self)
-          global_commands = @commands.select { |c| c.guild_ids.empty? }
-          guild_ids = Set[*@commands.map(&:guild_ids).flatten]
+          global_commands = @commands.select { |c| c.guild_ids == false or c.guild_ids == [] }
+          local_commands = @commands.select { |c| c.guild_ids.is_a?(Array) and c.guild_ids.any? }
+          default_commands = @commands.select { |c| c.guild_ids.nil? }
+          if guild_ids.is_a?(Array)
+            default_commands.each do |command|
+              command.instance_variable_set(:@guild_ids, guild_ids)
+            end
+            local_commands += default_commands
+          else
+            global_commands += default_commands
+          end
+          final_guild_ids = local_commands.map(&:guild_ids).flatten.map(&:to_s).uniq
           app_info = fetch_application.wait
           http.put("/applications/#{app_info.id}/commands", global_commands.map(&:to_hash)).wait unless global_commands.empty?
-          guild_ids.each do |guild_id|
-            commands = @commands.select { |c| c.guild_ids.include?(guild_id) }
+          final_guild_ids.each do |guild_id|
+            commands = local_commands.select { |c| c.guild_ids.include?(guild_id) }
             http.put("/applications/#{app_info.id}/guilds/#{guild_id}/commands", commands.map(&:to_hash)).wait
-          end unless guild_ids.empty?
+          end unless final_guild_ids.empty?
           @log.info "Successfully setup commands"
         end
       end
@@ -146,10 +160,10 @@ module Discorb
       # @!visibility private
       def initialize(name, guild_ids, block, type)
         @name = name
-        @guild_ids = guild_ids.map(&:to_s)
+        @guild_ids = guild_ids&.map(&:to_s)
         @block = block
         @raw_type = type
-        @type = Discorb::Command::Command.types[type]
+        @type = Discorb::ApplicationCommand::Command.types[type]
         @type_raw = type
         @id_map = Discorb::Dictionary.new
       end
@@ -174,12 +188,8 @@ module Discorb
 
         # @!visibility private
         def initialize(name, description, options, guild_ids, block, type, parent)
+          super(name, guild_ids, block, type)
           @description = description
-          @name = name
-          @guild_ids = guild_ids.map(&:to_s)
-          @block = block
-          @type = Discorb::Command::Command.types[type]
-          @type_raw = 1
           @options = options
           @id = nil
           @parent = parent
@@ -241,7 +251,7 @@ module Discorb
       # Represents the command with subcommands.
       #
       class GroupCommand < Command
-        # @return [Array<Discorb::Command::Command::SlashCommand, Discorb::Command::Command::SubcommandGroup>] The subcommands of the command.
+        # @return [Array<Discorb::ApplicationCommand::Command::SlashCommand, Discorb::ApplicationCommand::Command::SubcommandGroup>] The subcommands of the command.
         attr_reader :commands
         # @return [String] The description of the command.
         attr_reader :description
@@ -258,11 +268,11 @@ module Discorb
         #
         # Add new subcommand.
         #
-        # @param (see Discorb::Command::Handler#slash)
-        # @return [Discorb::Command::Command::SlashCommand] The added subcommand.
+        # @param (see Discorb::ApplicationCommand::Handler#slash)
+        # @return [Discorb::ApplicationCommand::Command::SlashCommand] The added subcommand.
         #
         def slash(command_name, description, options = {}, &block)
-          command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, [], block, 1, @name)
+          command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, [], block, 1, @name)
           @client.bottom_commands << command
           @commands << command
           command
@@ -274,16 +284,16 @@ module Discorb
         # @param [String] command_name Group name.
         # @param [String] description Group description.
         #
-        # @yield Block to execute as the command. It can be used to define sub-commands.
-        # @yieldself [Discorb::Command::Command::SubcommandGroup] Group command.
+        # @yield Block to yield with the command.
+        # @yieldparam [Discorb::ApplicationCommand::Command::SubcommandGroup] group Group command.
         #
-        # @return [Discorb::Command::Command::SubcommandGroup] Command object.
+        # @return [Discorb::ApplicationCommand::Command::SubcommandGroup] Command object.
         #
         # @see file:docs/slash_command.md
         #
         def group(command_name, description, &block)
-          command = Discorb::Command::Command::SubcommandGroup.new(command_name, description, @name, @client)
-          command.instance_eval(&block) if block_given?
+          command = Discorb::ApplicationCommand::Command::SubcommandGroup.new(command_name, description, @name, @client)
+          command.yield_self(&block) if block_given?
           @commands << command
           command
         end
@@ -332,7 +342,7 @@ module Discorb
       # Represents the subcommand group.
       #
       class SubcommandGroup < GroupCommand
-        # @return [Array<Discorb::Command::Command::SlashCommand>] The subcommands of the command.
+        # @return [Array<Discorb::ApplicationCommand::Command::SlashCommand>] The subcommands of the command.
         attr_reader :commands
 
         # @!visibility private
@@ -349,11 +359,11 @@ module Discorb
 
         #
         # Add new subcommand.
-        # @param (see Discorb::Command::Handler#slash)
-        # @return [Discorb::Command::Command::SlashCommand] The added subcommand.
+        # @param (see Discorb::ApplicationCommand::Handler#slash)
+        # @return [Discorb::ApplicationCommand::Command::SlashCommand] The added subcommand.
         #
         def slash(command_name, description, options = {}, &block)
-          command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, [], block, 1, @parent + " " + @name)
+          command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, [], block, 1, @parent + " " + @name)
           @commands << command
           @client.bottom_commands << command
           command

data/lib/discorb/channel.rb

@@ -171,7 +171,7 @@ module Discorb
     #
     # @param [String] reason The reason of deleting the channel.
     #
-    # @return [self] The deleted channel.
+    # @return [Async::Task<self>] The deleted channel.
     #
     def delete!(reason: nil)
       Async do
@@ -194,7 +194,7 @@ module Discorb
     # @param [Discorb::CategoryChannel] parent The parent of channel.
     # @param [String] reason The reason of moving the channel.
     #
-    # @return [self] The moved channel.
+    # @return [Async::Task<self>] The moved channel.
     #
     def move(position, lock_permissions: false, parent: :unset, reason: nil)
       Async do
@@ -273,7 +273,7 @@ module Discorb
     # @param [Integer] archive_in Alias of `default_auto_archive_duration`.
     # @param [String] reason The reason of editing the channel.
     #
-    # @return [self] The edited channel.
+    # @return [Async::Task<self>] The edited channel.
     #
     def edit(name: :unset, position: :unset, category: :unset, parent: :unset,
              topic: :unset, nsfw: :unset, announce: :unset,
@@ -310,7 +310,7 @@ module Discorb
     # @param [String] name The name of the webhook.
     # @param [Discorb::Image] avatar The avatar of the webhook.
     #
-    # @return [Discorb::Webhook::IncomingWebhook] The created webhook.
+    # @return [Async::Task<Discorb::Webhook::IncomingWebhook>] The created webhook.
     #
     def create_webhook(name, avatar: nil)
       Async do
@@ -327,7 +327,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Webhook>] The webhooks in the channel.
+    # @return [Async::Task<Array<Discorb::Webhook>>] The webhooks in the channel.
     #
     def fetch_webhooks
       Async do
@@ -419,7 +419,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Invite>] The invites in the channel.
+    # @return [Async::Task<Array<Discorb::Invite>>] The invites in the channel.
     #
     def fetch_invites
       Async do
@@ -440,7 +440,7 @@ module Discorb
     #   @note if it's `false` it may return existing invite.
     # @param [String] reason The reason of creating the invite.
     #
-    # @return [Invite] The created invite.
+    # @return [Async::Task<Invite>] The created invite.
     #
     def create_invite(max_age: nil, max_uses: nil, temporary: false, unique: false, reason: nil)
       Async do
@@ -487,7 +487,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Message>] The pinned messages in the channel.
+    # @return [Async::Task<Array<Discorb::Message>>] The pinned messages in the channel.
     #
     def fetch_pins
       Async do
@@ -535,7 +535,7 @@ module Discorb
     # @param [Boolean] public Whether the thread is public.
     # @param [String] reason The reason of starting the thread.
     #
-    # @return [Discorb::ThreadChannel] The started thread.
+    # @return [Async::Task<Discorb::ThreadChannel>] The started thread.
     #
     def start_thread(name, message: nil, auto_archive_duration: 1440, public: true, reason: nil)
       Async do
@@ -560,7 +560,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::ThreadChannel>] The archived threads in the channel.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived threads in the channel.
     #
     def fetch_archived_public_threads
       Async do
@@ -574,7 +574,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::ThreadChannel>] The archived private threads in the channel.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived private threads in the channel.
     #
     def fetch_archived_private_threads
       Async do
@@ -591,7 +591,7 @@ module Discorb
     # @param [Integer] limit The limit of threads to fetch.
     # @param [Time] before <description>
     #
-    # @return [Array<Discorb::ThreadChannel>] The joined archived private threads in the channel.
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The joined archived private threads in the channel.
     #
     def fetch_joined_archived_private_threads(limit: nil, before: nil)
       Async do
@@ -660,7 +660,7 @@ module Discorb
     # @param [Symbol] rtc_region The region of the voice channel.
     # @param [String] reason The reason of editing the voice channel.
     #
-    # @return [self] The edited voice channel.
+    # @return [Async::Task<self>] The edited voice channel.
     #
     def edit(name: :unset, position: :unset, bitrate: :unset, user_limit: :unset, rtc_region: :unset, reason: nil)
       Async do
@@ -728,7 +728,7 @@ module Discorb
     # @param [Symbol] rtc_region The region of the stage channel.
     # @param [String] reason The reason of editing the stage channel.
     #
-    # @return [self] The edited stage channel.
+    # @return [Async::Task<self>] The edited stage channel.
     #
     def edit(name: :unset, position: :unset, bitrate: :unset, rtc_region: :unset, reason: nil)
       Async do
@@ -753,7 +753,7 @@ module Discorb
     # @param [Boolean] public Whether the stage instance is public or not.
     # @param [String] reason The reason of starting the stage instance.
     #
-    # @return [Discorb::StageInstance] The started stage instance.
+    # @return [Async::Task<Discorb::StageInstance>] The started stage instance.
     #
     def start(topic, public: false, reason: nil)
       Async do
@@ -767,8 +767,8 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [StageInstance] The current stage instance.
-    # @return [nil] If there is no current stage instance.
+    # @return [Async::Task<StageInstance>] The current stage instance.
+    # @return [Async::Task<nil>] If there is no current stage instance.
     #
     def fetch_stage_instance
       Async do
@@ -853,7 +853,7 @@ module Discorb
     # @param [Boolean] locked Whether the thread is locked or not.
     # @param [String] reason The reason of editing the thread.
     #
-    # @return [self] The edited thread.
+    # @return [Async::Task<self>] The edited thread.
     #
     # @see #archive
     # @see #lock

data/lib/discorb/client.rb

@@ -41,7 +41,7 @@ module Discorb
     attr_reader :messages
     # @return [Discorb::Logger] The logger.
     attr_reader :log
-    # @return [Array<Discorb::Command::Command>] The commands that the client is using.
+    # @return [Array<Discorb::ApplicationCommand::Command>] The commands that the client is using.
     attr_reader :commands
     # @return [Float] The ping of the client.
     #   @note This will be calculated from heartbeat and heartbeat_ack.
@@ -91,6 +91,7 @@ module Discorb
       @commands = []
       @bottom_commands = []
       @status = :initialized
+      set_default_events
     end
 
     #
@@ -99,14 +100,15 @@ module Discorb
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol] id Custom ID of the event.
-    # @param [Hash] discriminator The discriminator of the event.
+    # @param [Hash] metadata The metadata of the event.
     # @param [Proc] block The block to execute when the event is triggered.
     #
     # @return [Discorb::Event] The event.
     #
-    def on(event_name, id: nil, **discriminator, &block)
-      ne = Event.new(block, id, discriminator)
+    def on(event_name, id: nil, **metadata, &block)
+      ne = Event.new(block, id, metadata)
       @events[event_name] ||= []
+      @events[event_name].delete_if { |e| e.metadata[:override] }
       @events[event_name] << ne
       ne
     end
@@ -118,12 +120,9 @@ module Discorb
     #
     # @return [Discorb::Event] The event.
     #
-    def once(event_name, id: nil, **discriminator, &block)
-      discriminator[:once] = true
-      ne = Event.new(block, id, discriminator)
-      @events[event_name] ||= []
-      @events[event_name] << ne
-      ne
+    def once(event_name, id: nil, **metadata, &block)
+      metadata[:once] = true
+      on(event_name, id: id, **metadata, &block)
     end
 
     #
@@ -174,23 +173,17 @@ module Discorb
         end
         @log.debug "Dispatching event #{event_name}"
         events.each do |block|
-          lambda { |event_args|
+          Async do
             Async(annotation: "Discorb event: #{event_name}") do |task|
               if block.is_a?(Discorb::Event)
-                @events[event_name].delete(block) if block.discriminator[:once]
+                @events[event_name].delete(block) if block.metadata[:once]
               end
-              block.call(*event_args)
+              block.call(*args)
               @log.debug "Dispatched proc with ID #{block.id.inspect}"
             rescue StandardError, ScriptError => e
-              message = "An error occurred while dispatching proc with ID #{block.id.inspect}\n#{e.full_message}"
-              dispatch(:error, event_name, event_args, e)
-              if @log.out
-                @log.error message
-              else
-                warn message
-              end
+              dispatch(:error, event_name, args, e)
             end
-          }.call(args)
+          end
         end
       end
     end
@@ -202,7 +195,7 @@ module Discorb
     #
     # @param [#to_s] id <description>
     #
-    # @return [Discorb::User] The user.
+    # @return [Async::Task<Discorb::User>] The user.
     #
     # @raise [Discorb::NotFoundError] If the user doesn't exist.
     #
@@ -220,7 +213,7 @@ module Discorb
     #
     # @param [#to_s] id The ID of the channel.
     #
-    # @return [Discorb::Channel] The channel.
+    # @return [Async::Task<Discorb::Channel>] The channel.
     #
     # @raise [Discorb::NotFoundError] If the channel doesn't exist.
     #
@@ -238,7 +231,7 @@ module Discorb
     #
     # @param [#to_s] id <description>
     #
-    # @return [Discorb::Guild] The guild.
+    # @return [Async::Task<Discorb::Guild>] The guild.
     #
     # @raise [Discorb::NotFoundError] If the guild doesn't exist.
     #
@@ -258,7 +251,7 @@ module Discorb
     # @param [Boolean] with_count Whether to include the count of the invite.
     # @param [Boolean] with_expiration Whether to include the expiration of the invite.
     #
-    # @return [Discorb::Invite] The invite.
+    # @return [Async::Task<Discorb::Invite>] The invite.
     #
     def fetch_invite(code, with_count: false, with_expiration: false)
       Async do
@@ -275,7 +268,7 @@ module Discorb
     #
     # @param [Boolean] force Whether to force the fetch.
     #
-    # @return [Discorb::Application] The application.
+    # @return [Async::Task<Discorb::Application>] The application.
     #
     def fetch_application(force: false)
       Async do
@@ -292,7 +285,7 @@ module Discorb
     # @macro async
     # @macro http
     #
-    # @return [Array<Discorb::Sticker::Pack>] The packs.
+    # @return [Async::Task<Array<Discorb::Sticker::Pack>>] The packs.
     #
     def fetch_nitro_sticker_packs
       Async do
@@ -369,10 +362,11 @@ module Discorb
     def extend(mod)
       if mod.respond_to?(:events)
         @events.each_value do |event|
-          event.delete_if { |c| c.discriminator[:extension] == mod.name }
+          event.delete_if { |c| c.metadata[:extension] == mod.name }
         end
         mod.events.each do |name, events|
-          @events[name] = [] if @events[name].nil?
+          @events[name] ||= []
+          @events[name].delete_if { |c| c.metadata[:override] }
           events.each do |event|
             @events[name] << event
           end
@@ -391,16 +385,20 @@ module Discorb
     end
 
     include Discorb::Gateway::Handler
-    include Discorb::Command::Handler
+    include Discorb::ApplicationCommand::Handler
 
     #
     # Starts the client.
     # @note This method behavior will change by CLI.
     # @see file:docs/cli.md
     #
-    # @param [String] token The token to use.
+    # @param [String, nil] token The token to use.
     #
-    def run(token)
+    # @note If the token is nil, you should use `discorb run` with the `-t` or `--token` option.
+    #
+    def run(token = nil)
+      token ||= ENV["DISCORB_CLI_TOKEN"]
+      raise ArgumentError, "Token is not specified, and -t/--token is not specified" if token.nil?
       case ENV["DISCORB_CLI_FLAG"]
       when nil
         start_client(token)
@@ -436,7 +434,14 @@ module Discorb
         end
         start_client(token)
       when "setup"
-        setup_commands(token)
+        guild_ids = "global"
+        if guilds = ENV["DISCORB_SETUP_GUILDS"]
+          guild_ids = guilds.split(",")
+        end
+        if guild_ids == ["global"]
+          guild_ids = false
+        end
+        setup_commands(token, guild_ids: guild_ids).wait
       end
     end
 
@@ -460,7 +465,7 @@ module Discorb
         }
         @token = token.to_s
         @close_condition = Async::Condition.new
-        main_task = Async do
+        @main_task = Async do
           @status = :running
           connect_gateway(true).wait
         rescue
@@ -469,7 +474,14 @@ module Discorb
           raise
         end
         @close_condition.wait
-        main_task.stop
+        @main_task.stop
+      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
       end
     end
   end