discorb 0.16.0 → 0.18.0

data/po/yard.pot

@@ -2907,23 +2907,23 @@ msgid "### How can I send files?"
 msgstr ""
 
 #: ../docs/faq.md:65
-msgid "Use {Discorb::File} class."
+msgid "Use {Discorb::Attachment} class."
 msgstr ""
 
 #: ../docs/faq.md:67
 msgid "```ruby\n"
 "# Send a file\n"
-"message.channel.post file: Discorb::File.new(File.open(\"./README.md\"))"
+"message.channel.post file: Discorb::Attachment.new(File.open(\"./README.md\"))"
 msgstr ""
 
 #: ../docs/faq.md:71
 msgid "# Send some files with text\n"
-"message.channel.post \"File!\", files: [Discorb::File.new(File.open(\"./README.md\")), Discorb::File.new(File.open(\"./License.txt\"))]"
+"message.channel.post \"File!\", files: [Discorb::Attachment.new(File.open(\"./README.md\")), Discorb::Attachment.new(File.open(\"./License.txt\"))]"
 msgstr ""
 
 #: ../docs/faq.md:74
 msgid "# Send a string as a file\n"
-"message.channel.post file: Discorb::File.from_string(\"Hello world!\", \"hello.txt\")\n"
+"message.channel.post file: Discorb::Attachment.from_string(\"Hello world!\", \"hello.txt\")\n"
 "```"
 msgstr ""
 
@@ -4519,7 +4519,7 @@ msgid "Command block."
 msgstr ""
 
 # @return [Discorb::ApplicationCommand::Command::GroupCommand]
-# @return [Discorb::ApplicationCommand::Command::SlashCommand]
+# @return [Discorb::ApplicationCommand::Command::ChatInputCommand]
 # @return [Discorb::ApplicationCommand::Command::SubcommandGroup]
 # @return [Discorb::ApplicationCommand::Command]
 #: ../lib/discorb/app_command.rb:40
@@ -4722,7 +4722,7 @@ msgstr ""
 msgid "a new instance of Command"
 msgstr ""
 
-# Discorb::ApplicationCommand::Command::SlashCommand
+# Discorb::ApplicationCommand::Command::ChatInputCommand
 #: ../lib/discorb/app_command.rb:194
 msgid "Represents the slash command."
 msgstr ""
@@ -4738,12 +4738,12 @@ msgstr ""
 msgid "The options of the command."
 msgstr ""
 
-# @return [SlashCommand]
+# @return [ChatInputCommand]
 #: ../lib/discorb/app_command.rb:203
-msgid "a new instance of SlashCommand"
+msgid "a new instance of ChatInputCommand"
 msgstr ""
 
-# Discorb::ApplicationCommand::Command::SlashCommand#to_s
+# Discorb::ApplicationCommand::Command::ChatInputCommand#to_s
 #: ../lib/discorb/app_command.rb:213
 msgid "Returns the commands name."
 msgstr ""
@@ -4753,8 +4753,8 @@ msgstr ""
 msgid "Represents the command with subcommands."
 msgstr ""
 
-# @return [Array<Discorb::ApplicationCommand::Command::SlashCommand, Discorb::ApplicationCommand::Command::SubcommandGroup>]
-# @return [Array<Discorb::ApplicationCommand::Command::SlashCommand>]
+# @return [Array<Discorb::ApplicationCommand::Command::ChatInputCommand, Discorb::ApplicationCommand::Command::SubcommandGroup>]
+# @return [Array<Discorb::ApplicationCommand::Command::ChatInputCommand>]
 #: ../lib/discorb/app_command.rb:275
 #: ../lib/discorb/app_command.rb:372
 msgid "The subcommands of the command."
@@ -4772,7 +4772,7 @@ msgstr ""
 msgid "Add new subcommand."
 msgstr ""
 
-# @return [Discorb::ApplicationCommand::Command::SlashCommand]
+# @return [Discorb::ApplicationCommand::Command::ChatInputCommand]
 #: ../lib/discorb/app_command.rb:294
 #: ../lib/discorb/app_command.rb:391
 msgid "The added subcommand."
@@ -9511,7 +9511,7 @@ msgstr ""
 msgid "a new instance of Attachment"
 msgstr ""
 
-# Discorb::File
+# Discorb::Attachment
 #: ../lib/discorb/file.rb:53
 msgid "Represents a file to send as an attachment."
 msgstr ""
@@ -9537,7 +9537,7 @@ msgstr ""
 msgid "The content type of the file. If not set, it is guessed from the filename."
 msgstr ""
 
-# Discorb::File#initialize
+# Discorb::Attachment#initialize
 #: ../lib/discorb/file.rb:64
 msgid "Creates a new file from IO."
 msgstr ""
@@ -9570,7 +9570,7 @@ msgstr ""
 msgid "tag|param|content_type"
 msgstr ""
 
-# Discorb::File.from_string
+# Discorb::Attachment.from_string
 #: ../lib/discorb/file.rb:79
 msgid "Creates a new file from a string."
 msgstr ""
@@ -11738,7 +11738,7 @@ msgstr ""
 msgid "A helper method to send multipart/form-data requests for creating messages."
 msgstr ""
 
-# @param [Array<Discorb::File>]
+# @param [Array<Discorb::Attachment>]
 #: ../lib/discorb/http.rb:154
 #: ../lib/discorb/interaction/response.rb:91
 #: ../lib/discorb/interaction/response.rb:115
@@ -11750,7 +11750,7 @@ msgstr ""
 msgid "tag|param|files"
 msgstr ""
 
-# @param [Array<Discorb::File>] files
+# @param [Array<Discorb::Attachment>] files
 #: ../lib/discorb/http.rb:154
 #: ../lib/discorb/interaction/response.rb:91
 #: ../lib/discorb/interaction/response.rb:115
@@ -12122,7 +12122,7 @@ msgstr ""
 msgid "Represents a command interaction."
 msgstr ""
 
-# Discorb::CommandInteraction::SlashCommand
+# Discorb::CommandInteraction::ChatInputCommand
 #: ../lib/discorb/interaction/command.rb:11
 msgid "Represents a slash command interaction."
 msgstr ""
@@ -12357,7 +12357,7 @@ msgstr ""
 msgid "tag|param|attachments"
 msgstr ""
 
-# @param [Discorb::File]
+# @param [Discorb::Attachment]
 #: ../lib/discorb/interaction/response.rb:91
 #: ../lib/discorb/interaction/response.rb:115
 #: ../lib/discorb/modules.rb:25
@@ -12375,7 +12375,7 @@ msgstr ""
 msgid "The new embeds of the message."
 msgstr ""
 
-# @param [Discorb::File] file
+# @param [Discorb::Attachment] file
 #: ../lib/discorb/interaction/response.rb:91
 #: ../lib/discorb/interaction/response.rb:115
 #: ../lib/discorb/modules.rb:25

data/rbs_collection.lock.yaml

@@ -0,0 +1,88 @@
+---
+sources:
+- name: ruby/gem_rbs_collection
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  revision: main
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: net-http
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: listen
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: prime
+  version: '0'
+  source:
+    type: stdlib
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 347858a6750d478f6cf1285b4ebd6ae945af2609
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib

data/rbs_collection.yaml

@@ -0,0 +1,21 @@
+# Download sources
+sources:
+  - name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+    ignore: true
+  - name: discorb
+    ignore: true
+  - name: net-http
+  - name: logger
+  - name: activesupport
+    ignore: true

data/sig/async.rbs

@@ -0,0 +1,11 @@
+module Async
+  class Task[T]
+    def wait: -> T
+  end
+
+  module WebSocket
+    class Connection
+      def initialize: (untyped, ?untyped, response: untyped, **untyped) -> void
+    end
+  end
+end

data/sig/discorb/activity.rbs

@@ -0,0 +1,23 @@
+module Discorb
+  #
+  # Represents an activity for Gateway Command.
+  class Activity
+    TYPES: untyped
+
+    #
+    # Initializes a new Activity.
+    #
+    # @param [String] name The name of the activity.
+    # @param [:playing, :streaming, :listening, :watching, :competing] type The type of activity.
+    # @param [String] url The URL of the activity.
+    def initialize: (String name, ?Symbol `type`, ?String? url) -> void
+
+    #
+    # Converts the activity to a hash.
+    #
+    # @return [Hash] A hash representation of the activity.
+    def to_hash: -> Discorb::json
+
+    def inspect: -> String
+  end
+end

data/sig/discorb/allowed_mentions.rbs

@@ -0,0 +1,44 @@
+module Discorb
+  #
+  # Represents a allowed mentions in a message.
+  class AllowedMentions
+    #
+    # Initializes a new instance of the AllowedMentions class.
+    #
+    # @param [Boolean] everyone Whether to allow @everyone or @here.
+    # @param [Boolean, Array<Discorb::Role>] roles The roles to allow, or false to disable.
+    # @param [Boolean, Array<Discorb::User>] users The users to allow, or false to disable.
+    # @param [Boolean] replied_user Whether to ping the user that sent the message to reply.
+    def initialize: (
+      ?everyone: bool?,
+      ?roles: (bool | ::Array[Discorb::Role])?,
+      ?users: (bool | ::Array[Discorb::User])?,
+      ?replied_user: bool?
+    ) -> void
+
+    def inspect: -> String
+
+    #
+    # Converts the object to a hash.
+    # @private
+    #
+    # @param [Discorb::AllowedMentions, nil] other The object to merge.
+    #
+    # @return [Hash] The hash.
+    def to_hash: (?Discorb::AllowedMentions? other) -> ::Hash[untyped, untyped]
+
+    def nil_merge: (*untyped args) -> untyped
+
+    # @return [Boolean] Whether to allow @everyone or @here.
+    attr_accessor everyone: bool?
+
+    # @return [Boolean, Array<Discorb::Role>] The roles to allow, or false to disable.
+    attr_accessor roles: (bool | ::Array[Discorb::Role])?
+
+    # @return [Boolean, Array<Discorb::User>] The users to allow, or false to disable.
+    attr_accessor users: (bool | ::Array[Discorb::User])?
+
+    # @return [Boolean] Whether to ping the user that sent the message to reply.
+    attr_accessor replied_user: bool?
+  end
+end

data/sig/discorb/app_command/base.rbs

@@ -0,0 +1,282 @@
+module Discorb
+  #
+  # Handles application commands.
+  module ApplicationCommand
+    VALID_LOCALES: untyped
+    type option =
+      {
+        name_localizations: Hash[(Symbol | String), String]?,
+        description: localizable?,
+        required: bool?,
+        optional: bool?,
+        default: untyped?,
+        type: (singleton(String)
+        | :string
+        | :str
+        | singleton(Integer)
+        | :integer
+        | :int
+        | singleton(TrueClass)
+        | singleton(FalseClass)
+        | :boolean
+        | :bool
+        | singleton(Discorb::User)
+        | singleton(Discorb::Member)
+        | :user
+        | :member
+        | singleton(Discorb::Channel)
+        | :channel
+        | singleton(Discorb::Role)
+        | :role
+        | :mentionable
+        | singleton(Float)
+        | :float
+        | :attachment)?,
+        choices: Hash[String, (String | Integer | Float)]?,
+        choices_localizations: Hash[String, Hash[(Symbol | String), String]]?,
+        channel_types: Array[Class]?,
+        autocomplete: ^(Discorb::CommandInteraction) -> Hash[String, String]?,
+        range: Range[(Integer | Float)]?
+      }
+    type options = ::Hash[String, option]
+    type localizable = String | Hash[Symbol | String, String]
+    type guild_ids = Array[_ToS] | false | nil
+
+    def self?.modify_localization_hash: (
+      Hash[Symbol | String, String] hash
+    ) -> Hash[String, String]
+
+    #
+    # Represents a application command.
+    # @abstract
+    class Command < Discorb::DiscordModel
+      TYPES: Hash[Integer, Symbol]
+
+      #
+      # Initialize a new command.
+      # @private
+      #
+      # @param [String, Hash{Symbol => String}] name The name of the command.
+      # @param [Array<#to_s>, false, nil] guild_ids The guild ids that the command is enabled in.
+      # @param [Proc] block The block of the command.
+      # @param [Integer] type The type of the command.
+      # @param [Boolean] dm_permission Whether the command is enabled in DMs.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      def initialize: (
+        Discorb::ApplicationCommand::localizable name,
+        Discorb::ApplicationCommand::guild_ids guild_ids,
+        ^(Discorb::Interaction, *untyped) -> untyped block,
+        Integer `type`,
+        ?bool? dm_permission,
+        ?Discorb::Permission? default_permission
+      ) -> void
+
+      #
+      # Changes the self pointer of block to the given object.
+      # @private
+      #
+      # @param [Object] instance The object to change the self pointer to.
+      def replace_block: (Object `instance`) -> untyped
+
+      #
+      # Converts the object to a hash.
+      # @private
+      #
+      # @return [Hash] The hash represents the object.
+      def to_hash: -> Discorb::json
+
+      # @return [Hash{String => String}] The name of the command.
+      attr_reader name: ::Hash[String, String]
+
+      # @return [Array<#to_s>] The guild ids that the command is enabled in.
+      attr_reader guild_ids: Discorb::ApplicationCommand::guild_ids
+
+      # @return [Proc] The block of the command.
+      attr_reader block: ^(Discorb::Interaction, *untyped) -> untyped
+
+      # @return [:chat_input, :user, :message] The type of the command.
+      attr_reader type: Symbol
+
+      # @return [Integer] The raw type of the command.
+      attr_reader type_raw: Integer
+
+      # @return [Discorb::Permission] The default permissions for this command.
+      attr_reader default_permission: Discorb::Permission?
+
+      # @return [Boolean] Whether the command is enabled in DMs.
+      attr_reader dm_permission: bool?
+
+      #
+      # Represents the slash command.
+      class ChatInputCommand < Discorb::ApplicationCommand::Command
+        #
+        # Initialize a new slash command.
+        # @private
+        #
+        # @param [String, Hash{Symbol => String}] name The name of the command.
+        #   The hash should have `default`, and language keys.
+        # @param [String, Hash{Symbol => String}] description The description of the command.
+        #   The hash should have `default`, and language keys.
+        # @param [Hash{String => Hash}] options The options of the command.
+        # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+        # @param [Proc] block The block of the command.
+        # @param [Integer] type The type of the command.
+        # @param [Discorb::ApplicationCommand::Command, nil] parent The parent command.
+        # @param [Boolean] dm_permission Whether the command is enabled in DMs.
+        # @param [Discorb::Permission] default_permission The default permission of the command.
+        def initialize: (
+          Discorb::ApplicationCommand::localizable name,
+          Discorb::ApplicationCommand::localizable description,
+          Discorb::ApplicationCommand::options options,
+          Discorb::ApplicationCommand::guild_ids guild_ids,
+          ^(
+            Discorb::CommandInteraction::ChatInputCommand,
+            *untyped
+          ) -> untyped block,
+          Integer `type`,
+          Discorb::ApplicationCommand::Command? parent,
+          bool? dm_permission,
+          Discorb::Permission? default_permission
+        ) -> void
+
+        #
+        # Returns the commands name.
+        #
+        # @return [String] The name of the command.
+        def to_s: -> String
+
+        #
+        # Converts the object to a hash.
+        # @private
+        #
+        # @return [Hash] The hash represents the object.
+        def to_hash: -> Discorb::json
+
+        # @return [Hash{String => String}] The description of the command.
+        attr_reader description: ::Hash[String, String]
+
+        # @return [Hash{String => Hash}] The options of the command.
+        attr_reader options: ::Hash[String, ::Hash[untyped, untyped]]
+      end
+
+      #
+      # Represents the command with subcommands.
+      class GroupCommand < Discorb::ApplicationCommand::Command
+        #
+        # Initialize a new group command.
+        # @private
+        #
+        # @param [String, Hash{Symbol => String}] name The name of the command.
+        # @param [String, Hash{Symbol => String}] description The description of the command.
+        # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+        # @param [Discorb::Client] client The client of the command.
+        # @param [Boolean] dm_permission Whether the command is enabled in DMs.
+        # @param [Discorb::Permission] default_permission The default permission of the command.
+        def initialize: (
+          Discorb::ApplicationCommand::localizable name,
+          Discorb::ApplicationCommand::localizable description,
+          Discorb::ApplicationCommand::guild_ids guild_ids,
+          Discorb::Client client,
+          bool? dm_permission,
+          Discorb::Permission? default_permission
+        ) -> void
+
+        #
+        # Add new subcommand.
+        #
+        # @param (see Discorb::ApplicationCommand::Handler#slash)
+        # @return [Discorb::ApplicationCommand::Command::ChatInputCommand] The added subcommand.
+        def slash: (
+          String | ::Hash[Symbol, String] command_name,
+          String | ::Hash[Symbol, String] description,
+          ?Discorb::ApplicationCommand::options options,
+          ?dm_permission: bool,
+          ?default_permission: Discorb::Permission?
+        ) {
+          (Discorb::CommandInteraction::ChatInputCommand, *untyped) -> void
+        } -> Discorb::ApplicationCommand::Command::ChatInputCommand
+
+        #
+        # 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: (
+          String command_name,
+          String description
+        ) ?{
+          (Discorb::ApplicationCommand::Command::SubcommandGroup group) -> void
+        } -> Discorb::ApplicationCommand::Command::SubcommandGroup
+
+        #
+        # Returns the command name.
+        #
+        # @return [String] The command name.
+        def to_s: -> String
+
+        #
+        # Changes the self pointer to the given object.
+        # @private
+        #
+        # @param [Object] instance The object to change to.
+        def block_replace: (Object `instance`) -> untyped
+
+        #
+        # Converts the object to a hash.
+        # @private
+        #
+        # @return [Hash] The hash represents the object.
+        def to_hash: -> Discorb::json
+
+        # @return [Array<Discorb::ApplicationCommand::Command>] The subcommands of the command.
+        attr_reader commands: ::Array[Discorb::ApplicationCommand::Command]
+
+        # @return [String] The description of the command.
+        attr_reader description: ::Hash[String, String]
+      end
+
+      #
+      # Represents the subcommand group.
+      class SubcommandGroup < Discorb::ApplicationCommand::Command::GroupCommand
+        #
+        # Initialize a new subcommand group.
+        # @private
+        #
+        # @param [String] name The name of the command.
+        # @param [String] description The description of the command.
+        # @param [Discorb::ApplicationCommand::Command::GroupCommand] parent The parent command.
+        # @param [Discorb::Client] client The client.
+        def initialize: (
+          String name,
+          String description,
+          Discorb::ApplicationCommand::Command::GroupCommand parent,
+          Discorb::Client client
+        ) -> void
+
+        def to_s: -> untyped
+
+        #
+        # Add new subcommand.
+        # @param (see Discorb::ApplicationCommand::Handler#slash)
+        # @return [Discorb::ApplicationCommand::Command::ChatInputCommand] The added subcommand.
+        def slash: (
+          Discorb::ApplicationCommand::localizable command_name,
+          Discorb::ApplicationCommand::localizable description,
+          ?Discorb::ApplicationCommand::options options
+        ) {
+          (Discorb::CommandInteraction::ChatInputCommand, *untyped) -> void
+        } -> Discorb::ApplicationCommand::Command::ChatInputCommand
+
+        # @return [Array<Discorb::ApplicationCommand::Command::ChatInputCommand>] The subcommands of the command.
+        attr_reader commands: ::Array[Discorb::ApplicationCommand::Command]
+      end
+    end
+  end
+end