discorb 0.17.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a56213c17efa8d538ddacbbe14f5d4d32b787384e02d21cf925aa0855db59e3
-  data.tar.gz: a3fce194d0f243b931d3918553880656e0bac5b0228d2ccd7147cae1068e1c9b
+  metadata.gz: c4cee4be461c639c494c2981f65ba496a17e4336fcb440218c2a4852d375b277
+  data.tar.gz: 4e743b61201c82a387f580cc75e0fa448dd357c5b02af5339df9b950898c0c38
 SHA512:
-  metadata.gz: aaced769a9309ab29050fdd89aed3164d7dbfe67e31dba2dd6caf91c83e5b6a16b00a941edc591a529619b13fdc0ec498e0cdfdda07c21849feece7c46a63a06
-  data.tar.gz: 205d12c8f88eabd03de31bf9a184e84653727ebb0acc8d05daabe8f3b0e41273665855ecdf8a8456e40cdcefc64c537b756efbaf48c6dbe413ea6a1b10cd7375
+  metadata.gz: b440b0e1f9e19161b666df325e01120905c3cf7f38e45cb4c89db4c9c7273b9626a5bed8825706317a84605417ac8b0f688450378622ee188cd3307d1905e7c0
+  data.tar.gz: b6bfc1d6c2e64918d0b0a73529029c01b50b33ac399a83bf18e30ef5bc6e7eb1c458f1aec7ce607349c36c2ba1585ded988c33d0607ece6048f0da9571af334d

data/.github/workflows/spec.yml

@@ -13,7 +13,10 @@ jobs:
         ruby-version:
           - "3.0"
           - "3.1"
-    runs-on: ubuntu-latest
+        os:
+          - "ubuntu-latest"
+          - "windows-latest"
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

data/.gitignore

@@ -61,3 +61,5 @@ tmp-doc
 doc
 *.zip
 **/*.po
+
+.gem_rbs_collection

data/Changelog.md

@@ -6,6 +6,12 @@
 
 ## v0.17
 
+### v0.17.1
+
+- Add: Add valid rbs file.
+- Change: Message content intent warning will show only once.
+- Update: Update audit log events.
+
 ### v0.17.0
 
 - Change!: Delete `Interaction#target` and `Interaction#fired_by`.

data/Rakefile

@@ -250,70 +250,70 @@ task :rbs do
   sh "sord gen sig/discorb.rbs --keep-original-comments --no-sord-comments" +
      (regenerate ? " --regenerate" : " --no-regenerate")
   base = File.read("sig/discorb.rbs")
-  base.gsub!(/\n +def _set_data: \(.+\) -> untyped\n\n/, "")
-  base.gsub!(/(  )?( *)# @private.+?(?:\n\n(?=\1\2#)|(?=\n\2end))/sm, "")
+  base.gsub!(/\n +def _set_data: \(.+\) -> untyped\n\n/, "\n")
+  # base.gsub!(/(  )?( *)# @private.+?(?:\n\n(?=\1\2#)|(?=\n\2end))/sm, "")
   base.gsub!(/untyped ([a-z_]*id)/, "_ToS \\1")
   # #region rbs dictionary
   base.gsub!(/  class Dictionary.+?end\n/ms, <<-RBS)
   class Dictionary[K, V]
-    ##{" "}
+    #
     # Initialize a new Dictionary.
-    ##{" "}
+    #
     # @param [Hash] hash A hash of items to add to the dictionary.
     # @param [Integer] limit The maximum number of items in the dictionary.
     # @param [false, Proc] sort Whether to sort the items in the dictionary.
     def initialize: (?::Hash[untyped, untyped] hash, ?limit: Integer?, ?sort: (bool | Proc)) -> void
 
-    ##{" "}
+    #
     # Registers a new item in the dictionary.
-    ##{" "}
+    #
     # @param [#to_s] id The ID of the item.
     # @param [Object] body The item to register.
-    ##{" "}
+    #
     # @return [self] The dictionary.
     def register: (_ToS id, Object body) -> self
 
-    ##{" "}
+    #
     # Merges another dictionary into this one.
-    ##{" "}
+    #
     # @param [Discorb::Dictionary] other The dictionary to merge.
     def merge: (Discorb::Dictionary other) -> untyped
 
-    ##{" "}
+    #
     # Removes an item from the dictionary.
-    ##{" "}
+    #
     # @param [#to_s] id The ID of the item to remove.
     def remove: (_ToS id) -> untyped
 
-    ##{" "}
+    #
     # Get an item from the dictionary.
-    ##{" "}
+    #
     # @param [#to_s] id The ID of the item.
     # @return [Object] The item.
     # @return [nil] if the item was not found.
-    ##{" "}
+    #
     # @overload get(index)
     #   @param [Integer] index The index of the item.
-    ##{" "}
+    #
     #   @return [Object] The item.
     #   @return [nil] if the item is not found.
     def get: (K id) -> V?
 
-    ##{" "}
+    #
     # Returns the values of the dictionary.
-    ##{" "}
+    #
     # @return [Array] The values of the dictionary.
     def values: () -> ::Array[V]
 
-    ##{" "}
+    #
     # Checks if the dictionary has an ID.
-    ##{" "}
+    #
     # @param [#to_s] id The ID to check.
-    ##{" "}
+    #
     # @return [Boolean] `true` if the dictionary has the ID, `false` otherwise.
     def has?: (_ToS id) -> bool
 
-    ##{" "}
+    #
     # Send a message to the array of values.
     def method_missing: (untyped name) -> untyped
 
@@ -330,6 +330,7 @@ task :rbs do
     base.gsub!(error, type)
   end
   base.gsub!("end\n\n\nend", "end\n")
+  base.gsub!(/ +$/m, "")
   File.write("sig/discorb.rbs", base)
 end
 

data/docs/application_command.md

@@ -54,11 +54,14 @@ client.run(ENV["DISCORD_BOT_TOKEN"])
 
 Block will be called with a {Discorb::Interaction} object and specified options.
 
+#### Register options
+
+You can set hash to `options` argument.
 In `options`, hash should be like this:
 
 ```ruby
 {
-  "Name" => {
+  "name" => {
     type: :string,
     required: true,
     description: "The description of the command."
@@ -67,10 +70,11 @@ In `options`, hash should be like this:
 ```
 
 | Key                      | Type                                     | Description                                                                           |
-| ------------------------ | ---------------------------------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| ------------------------ | ---------------------------------------- | ------------------------------------------------------------------------------------- |
+| `:name_localizations`    | `Hash{Symbol => String}`                 | Localizations of option name.                                                         |
 | `:description`           | `String`                                 | Description of the option.                                                            |
-| `:required`              | Boolean(true                             | false)                                                                                | Whether the argument is required. `optional` will be used if not specified. |
-| `:optional`              | Boolean(true                             | false)                                                                                | Whether the argument is optional. `required` will be used if not specified. |
+| `:required`              | `Boolean(true\|false)`                   | Whether the argument is required. `optional` will be used if not specified.           |
+| `:optional`              | `Boolean(true\|false)`                   | Whether the argument is optional. `required` will be used if not specified.           |
 | `:type`                  | `Object`                                 | Type of the option.                                                                   |
 | `:choices`               | `Hash{String => String, Integer, Float}` | Choice of the option.                                                                 |
 | `:choices_localizations` | `Hash{String => Hash{Symbol => String}}` | Localization of the choice. Key must be the name of a choice. (See below for example) |
@@ -116,6 +120,19 @@ In `type`, You must use one of the following:
 | `:channel` | Channel argument. | None      |
 | `:role`    | Role argument.    | None      |
 
+The block will receive the options as arguments.
+
+```ruby
+client.slash("hello", "Bot greets", {
+  "name" => {
+    type: :string,
+    description: "Name"
+  }
+}) do |interaction, name|
+  interaction.post("Hello, #{name}!", ephemeral: true)
+end
+```
+
 #### Group Slash Commands
 
 To register a group of slash commands, use {Discorb::ApplicationCommand::Handler#slash_group}.

data/lib/discorb/app_command/command.rb

@@ -213,10 +213,7 @@ module Discorb
       # Represents the command with subcommands.
       #
       class GroupCommand < Command
-        # @return [Array<
-        #     Discorb::ApplicationCommand::Command::ChatInputCommand,
-        #     Discorb::ApplicationCommand::Command::SubcommandGroup
-        #   >] The subcommands of the command.
+        # @return [Array<Discorb::ApplicationCommand::Command>] The subcommands of the command.
         attr_reader :commands
         # @return [String] The description of the command.
         attr_reader :description

data/lib/discorb/app_command/handler.rb

@@ -21,6 +21,7 @@ module Discorb
       #
       #   | Key | Type | Description |
       #   | --- | --- | --- |
+      #   | `:name_localizations` | Hash{Symbol => String} | Localizations of option name. |
       #   | `:description` | `String` \| `Hash{Symbol => String}` |
       #     Description of the option. If hash is passed, it must be a pair of Language code and description,
       #     and `:default` key is required. You can use `_` instead of `-` in language code. |

data/lib/discorb/audit_logs.rb

@@ -105,6 +105,7 @@ module Discorb
       # * `:thread_create`
       # * `:thread_update`
       # * `:thread_delete`
+      # * `:application_command_permission_update``
       attr_reader :type
       # @return [Discorb::AuditLog::Entry::Changes] The changes in this entry.
       attr_reader :changes
@@ -170,6 +171,7 @@ module Discorb
         110 => :thread_create,
         111 => :thread_update,
         112 => :thread_delete,
+        121 => :application_command_permission_update,
       }.freeze
 
       #
@@ -202,7 +204,7 @@ module Discorb
         @reason = data[:reason]
         data[:options]&.each do |option, value|
           define_singleton_method(option) { value }
-          if option.end_with?("_id")
+          if option.end_with?("_id") && CONVERTERS.key?(option.to_s.split("_")[0].to_sym)
             define_singleton_method(option.to_s.sub("_id", "")) do
               CONVERTERS[option.to_s.split("_")[0].to_sym]&.call(client, value, @guild_id)
             end

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.17.0"
+  VERSION = "0.17.1"
   # @return [Array<Integer>] The version array of discorb.
   VERSION_ARRAY = VERSION.split(".").map(&:to_i).freeze
   # @return [String] The user agent for the bot.

data/lib/discorb/emoji_table.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-# rubocop:disable Layout/LineLength
-
 module Discorb
   #
   # A table of emoji names and their unicode values.
   #
   module EmojiTable
+    # rubocop:disable Layout/LineLength
+
     # A hash of Discord's emoji names to their unicode characters.
     DISCORD_TO_UNICODE = {
       "grinning" => "\xf0\x9f\x98\x80",
@@ -8851,7 +8851,7 @@ module Discorb
       "\xf0\x9f\x8f\xbe",
       "\xf0\x9f\x8f\xbf",
     ].freeze
+
+    # rubocop:enable Layout/LineLength
   end
 end
-
-# rubocop:enable Layout/LineLength

data/lib/discorb/gateway.rb

@@ -604,8 +604,11 @@ module Discorb
             _, gateway_response = @http.request(Route.new("/gateway", "//gateway", :get)).wait
             gateway_url = gateway_response[:url]
             gateway_version = if @intents.to_h[:message_content].nil?
-                warn "message_content intent not set, using gateway version 9. " \
-                     "You should specify `message_content` intent for preventing unexpected changes in the future."
+                unless @message_content_intent_warned
+                  warn "message_content intent not set, using gateway version 9. " \
+                       "You should specify `message_content` intent for preventing unexpected changes in the future."
+                  @message_content_intent_warned = true
+                end
                 9
               else
                 10

data/lib/discorb/http.rb

@@ -57,7 +57,7 @@ module Discorb
     #
     # @param [Discorb::Route] path The path to the resource.
     # @param [String, Hash] body The body of the request.
-    # @param [Array<Discorb::File>] files The files to upload.
+    # @param [Array<Discorb::Attachment>] files The files to upload.
     # @param [Hash] headers The headers to send with the request.
     # @param [String] audit_log_reason The audit log reason to send with the request.
     # @param [Hash] kwargs The keyword arguments.

data/lib/discorb/interaction/response.rb

@@ -124,8 +124,8 @@ module Discorb
         # @param [Discorb::Embed] embed The new embed of the message.
         # @param [Array<Discorb::Embed>] embeds The new embeds of the message.
         # @param [Array<Discorb::Attachment>] attachments The attachments to remain.
-        # @param [Discorb::File] file The file to send.
-        # @param [Array<Discorb::File>] files The files to send.
+        # @param [Discorb::Attachment] file The file to send.
+        # @param [Array<Discorb::Attachment>] files The files to send.
         #
         # @return [Async::Task<void>] The task.
         #

data/lib/discorb/reaction.rb

@@ -45,10 +45,10 @@ module Discorb
       @count = data[:count]
       @me = data[:me]
       @emoji = if data[:emoji][:id].nil?
-                 UnicodeEmoji.new(data[:emoji][:name])
-               else
-                 PartialEmoji.new(data[:emoji])
-      end
+          UnicodeEmoji.new(data[:emoji][:name])
+        else
+          PartialEmoji.new(data[:emoji])
+        end
     end
   end
 end

data/lib/discorb/webhook.rb

@@ -56,8 +56,8 @@ module Discorb
     # @param [Discorb::Embed] embed The embed to send.
     # @param [Array<Discorb::Embed>] embeds The embeds to send.
     # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
-    # @param [Discorb::File] file The file to send.
-    # @param [Array<Discorb::File>] files The files to send.
+    # @param [Discorb::Attachment] attachment The attachment to send.
+    # @param [Array<Discorb::Attachment>] attachment The attachments to send.
     # @param [String] username The username of the message.
     # @param [String] avatar_url The avatar URL of the message.
     # @param [Boolean] wait Whether to wait for the message to be sent.
@@ -65,24 +65,34 @@ module Discorb
     # @return [Discorb::Webhook::Message] The message that was sent.
     # @return [Async::Task<nil>] If `wait` is false.
     #
-    def post(content = nil, tts: false, embed: nil, embeds: nil, allowed_mentions: nil,
-             file: nil, files: nil, username: nil, avatar_url: Discorb::Unset, wait: true)
+    def post(
+      content = nil,
+      tts: false,
+      embed: nil,
+      embeds: nil,
+      allowed_mentions: nil,
+      attachment: nil,
+      attachments: nil,
+      username: nil,
+      avatar_url: Discorb::Unset,
+      wait: true
+    )
       Async do
         payload = {}
         payload[:content] = content if content
         payload[:tts] = tts
         tmp_embed = if embed
-                      [embed]
-                    elsif embeds
-                      embeds
-        end
+            [embed]
+          elsif embeds
+            embeds
+          end
         payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
         payload[:allowed_mentions] = allowed_mentions&.to_hash
         payload[:username] = username if username
         payload[:avatar_url] = avatar_url if avatar_url != Discorb::Unset
-        files = [file]
+        attachments = [attachment] if attachment
         _resp, data = @http.multipart_request(Route.new("#{url}?wait=#{wait}", "//webhooks/:webhook_id/:token", :post),
-                                              files, payload, headers: headers).wait
+                                              attachments, payload, headers: headers).wait
         data && Webhook::Message.new(self, data)
       end
     end
@@ -137,8 +147,8 @@ module Discorb
     # @param [Discorb::Embed] embed The new embed of the message.
     # @param [Array<Discorb::Embed>] embeds The new embeds of the message.
     # @param [Array<Discorb::Attachment>] attachments The attachments to remain.
-    # @param [Discorb::File] file The file to send.
-    # @param [Array<Discorb::File>] files The files to send.
+    # @param [Discorb::Attachment] file The file to send.
+    # @param [Array<Discorb::Attachment>] files The files to send.
     # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
     #
     # @return [Async::Task<void>] The task.
@@ -176,10 +186,12 @@ module Discorb
     #
     def delete_message!(message)
       Async do
-        @http.request(Route.new(
-                        "#{url}/messages/#{Utils.try(message, :id)}",
-                        "//webhooks/:webhook_id/:token/messages/:message_id", :delete
-                      )).wait
+        @http.request(
+          Route.new(
+            "#{url}/messages/#{Utils.try(message, :id)}",
+            "//webhooks/:webhook_id/:token/messages/:message_id", :delete
+          )
+        ).wait
         message
       end
     end

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 ""
 
@@ -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
@@ -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,96 @@
+---
+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: activesupport
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 8e1f19e0c8768b6bac2815fe65a3310298ba400e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 8e1f19e0c8768b6bac2815fe65a3310298ba400e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 8e1f19e0c8768b6bac2815fe65a3310298ba400e
+    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: 8e1f19e0c8768b6bac2815fe65a3310298ba400e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 8e1f19e0c8768b6bac2815fe65a3310298ba400e
+    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: 8e1f19e0c8768b6bac2815fe65a3310298ba400e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib

data/rbs_collection.yaml

@@ -0,0 +1,17 @@
+# 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

data/sig/async.rbs

@@ -0,0 +1,5 @@
+module Async
+  class Task[T]
+    def wait: () -> T
+  end
+end