discorb 0.13.4 → 0.14.0

data/lib/discorb/app_command.rb

@@ -1,428 +1,4 @@
 # frozen_string_literal: true
-
-module Discorb
-  #
-  # Handles application commands.
-  #
-  module ApplicationCommand
-    #
-    # Module to handle application commands.
-    #
-    module Handler
-      #
-      # Add new top-level command.
-      #
-      # @param [String] command_name Command name.
-      # @param [String] description Command description.
-      # @param [Hash{String => Hash{:description => String, :optional => Boolean, :type => Object}}] options Command options.
-      #   The key is the option name, the value is a hash with the following keys:
-      #
-      #   | Key | Type | Description |
-      #   | --- | --- | --- |
-      #   | `:description` | `String` | Description of the option. |
-      #   | `:required` | Whether the argument is required. `optional` will be used if not specified. |
-      #   | `:optional` | Whether the argument is optional. `required` will be used if not specified. |
-      #   | `:type` | `Object` | Type of the option. |
-      #   | `:choice` | `Hash{String => String, Integer, Float}` | Type of the option. |
-      #   | `:default` | `Object` | Default value of the option. |
-      #   | `:channel_types` | `Array<Class<Discorb::Channel>>` | Type of the channel option. |
-      #   | `:autocomplete` | `Proc` | Autocomplete function. |
-      #   | `:range` | `Range` | Range of the option. Only valid for numeric options. (`:int`, `:float`) |
-      #
-      # @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::ApplicationCommand::Command::SlashCommand] Command object.
-      #
-      # @see file:docs/application_command.md#register-slash-command Application Comamnds: Register Slash Command
-      # @see file:docs/cli/setup.md CLI: setup
-      #
-      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
-      end
-
-      #
-      # Add new command with group.
-      #
-      # @param [String] command_name Command name.
-      # @param [String] description Command description.
-      # @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 yield with the command.
-      # @yieldparam [Discorb::ApplicationCommand::Command::GroupCommand] group Group command.
-      #
-      # @return [Discorb::ApplicationCommand::Command::GroupCommand] Command object.
-      #
-      # @see file:docs/application_command.md Application Commands
-      # @see file:docs/cli/setup.md CLI: setup
-      #
-      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
-
-      #
-      # Add message context menu command.
-      #
-      # @param [String] command_name Command name.
-      # @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 Interaction object.
-      # @yieldparam [Discorb::Message] message Message object.
-      #
-      # @return [Discorb::ApplicationCommand::Command] Command object.
-      #
-      def message_command(command_name, guild_ids: nil, &block)
-        command = Discorb::ApplicationCommand::Command.new(command_name, guild_ids, block, 3)
-        @commands << command
-        command
-      end
-
-      #
-      # Add user context menu command.
-      #
-      # @param [String] command_name Command name.
-      # @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 Interaction object.
-      # @yieldparam [Discorb::User] user User object.
-      #
-      # @return [Discorb::ApplicationCommand::Command] Command object.
-      #
-      def user_command(command_name, guild_ids: nil, &block)
-        command = Discorb::ApplicationCommand::Command.new(command_name, guild_ids, block, 2)
-        @commands << command
-        command
-      end
-
-      #
-      # Setup commands.
-      # @async
-      # @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, guild_ids: nil)
-        Async do
-          @token ||= token
-          @http = HTTP.new(self)
-          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.request(
-            Route.new(
-              "/applications/#{app_info.id}/commands",
-              "//applications/:application_id/commands",
-              :put
-            ),
-            global_commands.map(&:to_hash)
-          ).wait unless global_commands.empty?
-          if ENV["DISCORB_CLI_FLAG"] == "setup"
-            sputs "Registered commands for global:"
-            global_commands.each do |command|
-              iputs "- #{command.name}"
-            end
-          end
-          final_guild_ids.each do |guild_id|
-            commands = local_commands.select { |c| c.guild_ids.include?(guild_id) }
-            @http.request(
-              Route.new("/applications/#{app_info.id}/guilds/#{guild_id}/commands",
-                        "//applications/:application_id/guilds/:guild_id/commands",
-                        :put),
-              commands.map(&:to_hash)
-            ).wait
-            sputs "Registered commands for #{guild_id}:"
-            commands.each do |command|
-              iputs "- #{command.name}"
-            end
-          end unless final_guild_ids.empty?
-          @log.info "Successfully setup commands"
-        end
-      end
-    end
-
-    #
-    # Represents a application command.
-    # @abstract
-    #
-    class Command < DiscordModel
-      # @return [String] The name of the command.
-      attr_reader :name
-      # @return [Array<#to_s>] The guild ids that the command is enabled in.
-      attr_reader :guild_ids
-      # @return [Proc] The block of the command.
-      attr_reader :block
-      # @return [:chat_input, :user, :message] The type of the command.
-      attr_reader :type
-      # @return [Integer] The raw type of the command.
-      attr_reader :type_raw
-      # @return [Discorb::Dictionary{Discorb::Snowflake, :global => Discorb::Snowflake}] The ID mapping.
-      attr_reader :id_map
-
-      @types = {
-        1 => :chat_input,
-        2 => :user,
-        3 => :message,
-      }.freeze
-
-      # @private
-      def initialize(name, guild_ids, block, type)
-        @name = name
-        @guild_ids = guild_ids&.map(&:to_s)
-        @block = block
-        @raw_type = type
-        @type = Discorb::ApplicationCommand::Command.types[type]
-        @type_raw = type
-        @id_map = Discorb::Dictionary.new
-      end
-
-      # @private
-      def replace_block(instance)
-        current_block = @block.dup
-        @block = Proc.new do |*args|
-          instance.instance_exec(*args, &current_block)
-        end
-      end
-
-      # @private
-      def to_hash
-        {
-          name: @name,
-          default_permission: @default_permission,
-          type: @type_raw,
-        }
-      end
-
-      #
-      # Represents the slash command.
-      #
-      class SlashCommand < Command
-        # @return [String] The description of the command.
-        attr_reader :description
-        # @return [Hash{String => Hash}] The options of the command.
-        attr_reader :options
-
-        # @private
-        def initialize(name, description, options, guild_ids, block, type, parent)
-          super(name, guild_ids, block, type)
-          @description = description
-          @options = options
-          @id = nil
-          @parent = parent
-          @id_map = Discorb::Dictionary.new
-        end
-
-        #
-        # Returns the commands name.
-        #
-        # @return [String] The name of the command.
-        #
-        def to_s
-          (@parent + " " + @name).strip
-        end
-
-        # @private
-        def to_hash
-          options_payload = options.map do |name, value|
-            ret = {
-              type: case value[:type]
-              when String, :string, :str
-                3
-              when Integer, :integer, :int
-                4
-              when TrueClass, FalseClass, :boolean, :bool
-                5
-              when Discorb::User, Discorb::Member, :user, :member
-                6
-              when Discorb::Channel, :channel
-                7
-              when Discorb::Role, :role
-                8
-              when :mentionable
-                9
-              when Float, :float
-                10
-              else
-                raise ArgumentError, "Invalid option type: #{value[:type]}"
-              end,
-              name: name,
-              description: value[:description],
-              required: value[:required].nil? ? !value[:optional] : value[:required],
-            }
-
-            ret[:choices] = value[:choices].map { |t| { name: t[0], value: t[1] } } if value[:choices]
-
-            ret[:channel_types] = value[:channel_types].map(&:channel_type) if value[:channel_types]
-
-            ret[:autocomplete] = !!value[:autocomplete] if value[:autocomplete]
-            if value[:range]
-              ret[:min_value] = value[:range].begin
-              ret[:max_value] = value[:range].end
-            end
-            ret
-          end
-          {
-            name: @name,
-            default_permission: true,
-            description: @description,
-            options: options_payload,
-          }
-        end
-      end
-
-      #
-      # Represents the command with subcommands.
-      #
-      class GroupCommand < 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
-
-        # @private
-        def initialize(name, description, guild_ids, type, client)
-          super(name, guild_ids, block, type)
-          @description = description
-          @commands = []
-          @client = client
-          @id_map = Discorb::Dictionary.new
-        end
-
-        #
-        # Add new subcommand.
-        #
-        # @param (see Discorb::ApplicationCommand::Handler#slash)
-        # @return [Discorb::ApplicationCommand::Command::SlashCommand] The added subcommand.
-        #
-        def slash(command_name, description, options = {}, &block)
-          command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, [], block, 1, @name)
-          @client.bottom_commands << command
-          @commands << command
-          command
-        end
-
-        #
-        # Add new subcommand group.
-        #
-        # @param [String] command_name Group name.
-        # @param [String] description Group description.
-        #
-        # @yield Block to yield with the command.
-        # @yieldparam [Discorb::ApplicationCommand::Command::SubcommandGroup] group Group command.
-        #
-        # @return [Discorb::ApplicationCommand::Command::SubcommandGroup] Command object.
-        #
-        # @see file:docs/application_command.md Application Commands
-        #
-        def group(command_name, description, &block)
-          command = Discorb::ApplicationCommand::Command::SubcommandGroup.new(command_name, description, @name, @client)
-          command.yield_self(&block) if block_given?
-          @commands << command
-          command
-        end
-
-        #
-        # Returns the command name.
-        #
-        # @return [String] The command name.
-        #
-        def to_s
-          @name
-        end
-
-        # @private
-        def block_replace(instance)
-          super
-          @commands.each { |c| c.replace_block(instance) }
-        end
-
-        # @private
-        def to_hash
-          options_payload = @commands.map do |command|
-            if command.is_a?(SlashCommand)
-              {
-                name: command.name,
-                description: command.description,
-                default_permission: true,
-                type: 1,
-                options: command.to_hash[:options],
-              }
-            else
-              {
-                name: command.name,
-                description: command.description,
-                default_permission: true,
-                type: 2,
-                options: command.commands.map { |c| c.to_hash.merge(type: 1) },
-              }
-            end
-          end
-
-          {
-            name: @name,
-            default_permission: @enabled,
-            description: @description,
-            options: options_payload,
-          }
-        end
-      end
-
-      #
-      # Represents the subcommand group.
-      #
-      class SubcommandGroup < GroupCommand
-        # @return [Array<Discorb::ApplicationCommand::Command::SlashCommand>] The subcommands of the command.
-        attr_reader :commands
-
-        # @private
-        def initialize(name, description, parent, client)
-          super(name, description, [], 1, client)
-
-          @commands = []
-          @parent = parent
-        end
-
-        def to_s
-          @parent + " " + @name
-        end
-
-        #
-        # Add new subcommand.
-        # @param (see Discorb::ApplicationCommand::Handler#slash)
-        # @return [Discorb::ApplicationCommand::Command::SlashCommand] The added subcommand.
-        #
-        def slash(command_name, description, options = {}, &block)
-          command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, [], block, 1, @parent + " " + @name)
-          @commands << command
-          @client.bottom_commands << command
-          command
-        end
-      end
-
-      class << self
-        # @private
-        attr_reader :types
-      end
-    end
-  end
+%w[command handler].each do |file|
+  require_relative "app_command/#{file}.rb"
 end

data/lib/discorb/asset.rb

@@ -80,7 +80,9 @@ module Discorb
     #
     # @return [String] URL of the avatar.
     #
+    # rubocop: disable Lint/UnusedMethodArgument
     def url(image_format: nil, size: 1024)
+      # rubocop: enable Lint/UnusedMethodArgument
       "https://cdn.discordapp.com/embed/avatars/#{@discriminator.to_i % 5}.png"
     end
 

data/lib/discorb/audit_logs.rb

@@ -226,7 +226,7 @@ module Discorb
         # @private
         #
         def initialize(data)
-          @data = data.map { |d| [d[:key].to_sym, d] }.to_h
+          @data = data.to_h { |d| [d[:key].to_sym, d] }
           @data.each do |k, v|
             define_singleton_method(k) { Change.new(v) }
           end
@@ -287,8 +287,8 @@ module Discorb
             else
               ->(v) { v }
             end
-          @old_value = method.(data[:old_value])
-          @new_value = method.(data[:new_value])
+          @old_value = method.call(data[:old_value])
+          @new_value = method.call(data[:new_value])
         end
 
         #

data/lib/discorb/channel.rb

@@ -211,9 +211,9 @@ module Discorb
       @guild_id = data[:guild_id]
       @position = data[:position]
       @permission_overwrites = if data[:permission_overwrites]
-          data[:permission_overwrites].map do |ow|
+          data[:permission_overwrites].to_h do |ow|
             [(ow[:type] == 1 ? guild.roles : guild.members)[ow[:id]], PermissionOverwrite.new(ow[:allow], ow[:deny])]
-          end.to_h
+          end
         else
           {}
         end
@@ -759,7 +759,7 @@ module Discorb
     end
 
     def audiences
-      voice_states.filter { |state| state.suppress? }.map(&:member)
+      voice_states.filter(&:suppress?).map(&:member)
     end
 
     private
@@ -990,14 +990,23 @@ module Discorb
       end
     end
 
+    #
+    # Represents a thread in news channel(aka announcement channel).
+    #
     class News < ThreadChannel
       @channel_type = 10
     end
 
+    #
+    # Represents a public thread in text channel.
+    #
     class Public < ThreadChannel
       @channel_type = 11
     end
 
+    #
+    # Represents a private thread in text channel.
+    #
     class Private < ThreadChannel
       @channel_type = 12
     end
@@ -1007,7 +1016,7 @@ module Discorb
     end
 
     #
-    # Repre
+    # Represents a member in a thread.
     #
     class Member < DiscordModel
       attr_reader :joined_at
@@ -1059,6 +1068,9 @@ module Discorb
     end
   end
 
+  #
+  # Represents a category in a guild.
+  #
   class CategoryChannel < GuildChannel
     @channel_type = 4
 
@@ -1099,6 +1111,9 @@ module Discorb
     end
   end
 
+  #
+  # Represents a DM channel.
+  #
   class DMChannel < Channel
     include Messageable
 

data/lib/discorb/client.rb

@@ -186,10 +186,8 @@ module Discorb
         @log.debug "Dispatching event #{event_name}"
         events.each do |block|
           Async do
-            Async(annotation: "Discorb event: #{event_name}") do |task|
-              if block.is_a?(Discorb::EventHandler)
-                @events[event_name].delete(block) if block.metadata[:once]
-              end
+            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}"
             rescue StandardError, ScriptError => e
@@ -261,7 +259,7 @@ module Discorb
     #
     # @return [Async::Task<Discorb::Invite>] The invite.
     #
-    def fetch_invite(code, with_count: false, with_expiration: false)
+    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
         Invite.new(self, data, false)
@@ -295,8 +293,8 @@ module Discorb
     #
     def fetch_nitro_sticker_packs
       Async do
-        _resp, data = @http.request(Route.new("/stickers-packs", "//stickers-packs", :get)).wait
-        data.map { |pack| Sticker::Pack.new(self, pack) }
+        _resp, data = @http.request(Route.new("/sticker-packs", "//sticker-packs", :get)).wait
+        data[:sticker_packs].map { |pack| Sticker::Pack.new(self, pack) }
       end
     end
 
@@ -305,18 +303,14 @@ module Discorb
     #
     # @param [Discorb::Activity] activity The activity to update.
     # @param [:online, :idle, :dnd, :invisible] status The status to update.
-    # @param [String] afk Whether to set the client as AFK.
     #
-    def update_presence(activity = nil, status: nil, afk: false)
+    def update_presence(activity = nil, status: nil)
       payload = {
         activities: [],
         status: status,
-        afk: nil,
         since: nil,
       }
-      if !activity.nil?
-        payload[:activities] = [activity.to_hash]
-      end
+      payload[:activities] = [activity.to_hash] unless activity.nil?
       payload[:status] = status unless status.nil?
       if @connection
         Async do
@@ -374,10 +368,11 @@ module Discorb
     # @param [Object] ... The arguments to pass to the `ext#initialize`.
     #
     def load_extension(ext, ...)
-      if ext.is_a?(Class)
+      case ext
+      when Class
         raise ArgumentError, "#{ext} is not a extension" unless ext < Discorb::Extension
         ins = ext.new(self, ...)
-      elsif ext.is_a?(Discorb::Extension)
+      when Discorb::Extension
         ins = ext
       else
         raise ArgumentError, "#{ext} is not a extension"
@@ -398,12 +393,20 @@ module Discorb
       ins.class.commands.each do |cmd|
         cmd.define_singleton_method(:extension) { ins.class.name }
         cmd.replace_block(ins)
+        cmd.block.define_singleton_method(:self_replaced) { true }
         @commands << cmd
       end
 
       cls = ins.class
       cls.loaded(self, ...) if cls.respond_to? :loaded
-      @bottom_commands += ins.class.bottom_commands
+      ins.class.bottom_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
+      end
       @extensions[ins.class.name] = ins
       ins
     end
@@ -463,7 +466,7 @@ module Discorb
               ::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]
+          @log.colorize_log = options[:log_color].nil? ? @log.out.isatty : options[:log_color]
         end
       end
     end
@@ -473,29 +476,29 @@ module Discorb
       if guilds = ENV["DISCORB_SETUP_GUILDS"]
         guild_ids = guilds.split(",")
       end
-      if guild_ids == ["global"]
-        guild_ids = false
-      end
+      guild_ids = false if guild_ids == ["global"]
       setup_commands(token, guild_ids: guild_ids).wait
-      @events[:setup]&.each do |event|
-        event.call
+      if ENV["DISCORB_SETUP_SCRIPT"] == "true"
+        @events[:setup]&.each do |event|
+          event.call
+        end
+        self.on_setup if respond_to? :on_setup
       end
-      self.on_setup if respond_to? :on_setup
     end
 
     def start_client(token)
-      Async do |task|
-        Signal.trap(:SIGINT) {
+      Async do |_task|
+        Signal.trap(:SIGINT) do
           @log.info "SIGINT received, closing..."
           Signal.trap(:SIGINT, "DEFAULT")
           close!
-        }
+        end
         @token = token.to_s
         @close_condition = Async::Condition.new
         @main_task = Async do
           @status = :running
           connect_gateway(false).wait
-        rescue
+        rescue StandardError
           @status = :stopped
           @close_condition.signal
           raise