discorb 0.12.4 → 0.13.3

data/Gemfile

@@ -7,11 +7,15 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-group :debug, optional: true do
+group :development, optional: true do
   gem "rufo", "~> 0.13.0"
+  gem "sord", "~> 3.0.1"
 end
 
 group :docs, optional: true do
   gem "redcarpet"
   gem "yard", "~> 0.9.26"
+  gem "gettext", "~> 3.4.1"
+  gem "crowdin-api", "~> 1.0"
+  gem "rubyzip", "~> 2.3"
 end

data/README.md

@@ -1,6 +1,6 @@
 <div align="center"><img src="./assets/banner.svg" alt="discorb"></div>
 
-<div align="center"><a href="https://discorb-lib.github.io/"><img src="https://img.shields.io/badge/Document-discorb--lib.github.io-blue.svg?style=flat-square&labelColor=2f3136" alt="Document"></a>
+<div align="center"><a href="https://discorb-lib.github.io/"><img src="https://img.shields.io/badge/Document-discorb--lib.github.io-blue.svg?style=flat-square&labelColor=2f3136&logo=github&logoColor=fff" alt="Document"></a>
 <a href="https://rubygems.org/gems/discorb"><img src="https://img.shields.io/gem/dt/discorb?logo=rubygems&logoColor=fff&label=Downloads&style=flat-square&labelColor=2f3136" alt="Gem"></a>
 <a href="https://rubygems.org/gems/discorb"><img src="https://img.shields.io/gem/v/discorb?logo=rubygems&logoColor=fff&label=Version&style=flat-square&labelColor=2f3136" alt="Gem"></a>
 <a href="https://discord.gg/hCP6zq8Vpj"><img src="https://img.shields.io/discord/863581274916913193?logo=discord&logoColor=fff&color=5865f2&label=Discord&style=flat-square&labelColor=2f3136" alt="Discord"></a>
@@ -9,7 +9,7 @@
 
 ----
 
-discorb is a Discord API wrapper written in Ruby.
+discorb is a Discord API wrapper for Ruby, Using [socketry/async](https://github.com/socketry/async).
 
 ## Installation
 

data/Rakefile

@@ -67,7 +67,7 @@ namespace :document do
 
   desc "Just generate document"
   task :yard do
-    sh "bundle exec yardoc -o doc/#{version}"
+    sh "bundle exec yardoc -o doc/#{version} --locale #{ENV["rake_locale"] or "en"}"
   end
 
   desc "Replace files"
@@ -136,6 +136,12 @@ namespace :document do
       end
       sputs "Successfully replaced CRLF with LF"
     end
+
+    task :locale do
+      next if ENV["rake_locale"].nil?
+      require_relative "template-replace/scripts/locale_#{ENV["rake_locale"]}.rb"
+      replace_locale("doc/main")
+    end
   end
   task :replace => %i[replace:css replace:html replace:eol]
 
@@ -156,6 +162,7 @@ namespace :document do
     Rake::Task["document:replace:html"].execute
     Rake::Task["document:replace:css"].execute
     Rake::Task["document:replace:eol"].execute
+    Rake::Task["document:replace:locale"].execute
     tags = `git tag`.force_encoding("utf-8").split("\n").sort_by { |t| t[1..].split(".").map(&:to_i) }
     tags.each do |tag|
       sh "git checkout #{tag} -f"
@@ -166,6 +173,7 @@ namespace :document do
       Rake::Task["document:replace:html"].execute
       Rake::Task["document:replace:css"].execute
       Rake::Task["document:replace:eol"].execute
+      Rake::Task["document:replace:locale"].execute
       FileUtils.cp_r("./doc/.", "./tmp-doc")
       FileUtils.rm_rf("doc")
     end
@@ -190,6 +198,128 @@ namespace :document do
     end
     sputs "Successfully pushed documents"
   end
+
+  namespace :locale do
+    task :ja do
+      require "crowdin-api"
+      require "zip"
+      crowdin = Crowdin::Client.new do |config|
+        config.api_token = ENV["CROWDIN_PERSONAL_TOKEN"]
+        config.project_id = ENV["CROWDIN_PROJECT_ID"].to_i
+      end
+      build = crowdin.build_project_translation["data"]["id"]
+      crowdin.download_project_translations("./tmp.zip", build)
+
+      Zip::File.open("tmp.zip") do |zip|
+        zip.each do |entry|
+          zip.extract(entry, entry.name) { true }
+        end
+      end
+      ENV["rake_locale"] = "ja"
+      Rake::Task["document:yard"].execute
+      Rake::Task["document:replace"].execute
+    end
+
+    task :en do
+      Rake::Task["document"].execute("locale:en")
+    end
+  end
+end
+
+task :rbs do
+  require "open3"
+  type_errors = {
+    "SORD_ERROR_SymbolSymbolSymbolInteger" => "{ r: Integer, g: Integer, b: Integer}",
+    "SORD_ERROR_DiscorbRoleDiscorbMemberDiscorbPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
+    "SORD_ERROR_DiscorbRoleDiscorbMemberPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
+    "SORD_ERROR_f | SORD_ERROR_F | SORD_ERROR_d | SORD_ERROR_D | SORD_ERROR_t | SORD_ERROR_T | SORD_ERROR_R" => '"f" | "F" | "d" | "D" | "t" | "T" | "R"',
+    "SORD_ERROR_dark | SORD_ERROR_light" => '"dark" | "light"',
+    "SORD_ERROR_SymbolStringSymbolboolSymbolObject" => "String | Integer | Float",
+  }
+  regenerate = ARGV.include?("--regenerate") || ARGV.include?("-r")
+
+  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!(/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
+
+    def respond_to_missing?: (untyped name, untyped args, untyped kwargs) -> bool
+
+    def inspect: () -> untyped
+
+    # @return [Integer] The maximum number of items in the dictionary.
+    attr_accessor limit: Integer
+  end
+  RBS
+  # #endregion
+  type_errors.each do |error, type|
+    base.gsub!(error, type)
+  end
+  File.write("sig/discorb.rbs", base)
 end
 
 task :document => %i[document:yard document:replace]

data/crowdin.yml

@@ -1,3 +1,5 @@
 files:
   - source: /po/yard.pot
     translation: /po/%two_letters_code%.po
+project_id_env: CROWDIN_PROJECT_ID
+api_token_env: CROWDIN_PERSONAL_TOKEN

data/discorb.gemspec

@@ -8,7 +8,18 @@ Gem::Specification.new do |spec|
   spec.authors = ["sevenc-nanashi"]
   spec.email = ["sevenc-nanashi@sevenbot.jp"]
 
-  spec.summary = "A discord API wrapper written in Ruby"
+  spec.summary = "A Discord API wrapper for Ruby, Using socketry/async."
+  spec.description = <<~RDOC
+    == discorb
+    discorb is a Discord API wrapper for Ruby, Using {socketry/async}[https://github.com/socketry/async].
+
+    === Contributing
+    Bug reports, feature requests, and pull requests are welcome on {the GitHub repository}[https://github.com/discorb-lib/discorb].
+
+    === License
+    This gem is licensed under the MIT License.
+
+  RDOC
   spec.homepage = "https://github.com/discorb-lib/discorb"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")

data/docs/Examples.md

@@ -1,4 +1,6 @@
+<!--
 # @title Examples
+-->
 
 # Examples
 

data/docs/application_command.md

@@ -1,4 +1,6 @@
+<!--
 # @title Application Commands
+-->
 
 # Application Commands
 
@@ -10,7 +12,7 @@ From: [Discord API docs](https://discord.com/developers/docs/interactions/applic
 
 ## How do I register an application command?
 
-Write to a your script:
+Write to your script:
 - {Discorb::ApplicationCommand::Handler.slash}, {Discorb::ApplicationCommand::Handler.slash_group} for slash commands,
 - {Discorb::ApplicationCommand::Handler.user_command} for user menu commands,
 - {Discorb::ApplicationCommand::Handler.message_command} for message menu commands.
@@ -49,6 +51,8 @@ client.run(ENV["DISCORD_BOT_TOKEN"])
 | `guild_ids` | The ID of the guild to register the command in. |
 | `block` | A block that will be called when the command is invoked. |
 
+Block will be called with a {Discorb::Interaction} object and specified options.
+
 In `options`, hash should be like this:
 
 ```ruby
@@ -66,7 +70,7 @@ In `options`, hash should be like this:
 | `: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. |
+| `:choice` | `Hash{String => String, Integer, Float}` | Choice 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. |
@@ -121,16 +125,16 @@ group.slash("message_expand", "Whether bot should expand message.", {
     type: :boolean,
     description: "Whether bot should expand message."
   }
-}) do |interaction|
+}) do |interaction, enabled|
   # ...
 end
 
-group.slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
+group.slash("level", "Whether level system is enabled.", {
   "enabled" => {
     type: :boolean,
-    description: "Whether bot should notify DISBOARD bump."
+    description: "Whether level system is enabled."
   }
-}) do |interaction|
+}) do |interaction, enabled|
   # ...
 end
 
@@ -146,15 +150,15 @@ client.slash_group("settings", "Set settings of bot.") do |group|
       type: :boolean,
       description: "Whether bot should expand message."
     }
-  }) do |interaction|
+  }) do |interaction, enabled|
     # ...
   end
-  group.slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
+  group.slash("bump_alert", "Whether level system is enabled.", {
     "enabled" => {
       type: :boolean,
-      description: "Whether bot should notify DISBOARD bump."
+      description: "Whether level system is enabled."
     }
-  }) do |interaction|
+  }) do |interaction, enabled|
     # ...
   end
 end
@@ -243,9 +247,9 @@ Same as above, you can use block for register commands since v0.5.1.
 
 #### Use Auto Completing
 
-Since v0.11.0, you can use auto completion by setting Proc to `:autocomplete` in options.
+Since v0.11.0, you can use auto-completion by setting Proc to `:autocomplete` in options.
 The proc will be called with interaction object and the argument.
-The proc should return an hash of the autocomplete result.
+The proc should return a hash of the autocomplete result.
 
 ```ruby
 client.slash("hello2", "Greet for you", {

data/docs/cli/irb.md

@@ -1,4 +1,6 @@
+<!--
 # @title CLI: discorb irb
+-->
 
 # discorb irb
 

data/docs/cli/new.md

@@ -1,4 +1,6 @@
+<!--
 # @title CLI: discorb new
+-->
 
 # discorb new
 

data/docs/cli/run.md

@@ -1,4 +1,6 @@
+<!--
 # @title CLI: discorb run
+-->
 
 # discorb run
 
@@ -50,7 +52,7 @@ If not specified, the default will be:
 
 #### `-s`, `--setup`
 
-Whether to setup application commands.
+Whether to set up application commands.
 
 #### `-e`, `--env`
 

data/docs/cli/setup.md

@@ -1,8 +1,10 @@
+<!--
 # @title CLI: discorb setup
+-->
 
 # discorb setup
 
-This command will setup application commands, and call `setup` event.
+This command will set up application commands, and call `setup` event.
 
 ## Usage
 
@@ -14,7 +16,7 @@ discorb setup [options] [script]
 
 #### `script`
 
-The script to setup. Defaults to `main.rb`.
+The script to set up. Defaults to `main.rb`.
 
 ### Options
 

data/docs/cli.md

@@ -1,4 +1,6 @@
+<!--
 # @title CLI tools
+-->
 
 # CLI tools
 

data/docs/events.md

@@ -1,4 +1,6 @@
+<!--
 # @title Events
+-->
 
 # Events
 
@@ -64,7 +66,7 @@ end
 ### Client events
 
 #### `event_receive(event_name, data)`
-Fires when a event is received.  
+Fires when an event is received.  
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
@@ -411,7 +413,7 @@ Fires when a role is deleted.
 
 #### Note
 
-These events requires the `guild_members` intent.
+These events require the `guild_members` intent.
 
 #### `member_add(member)`
 
@@ -469,7 +471,7 @@ Fires when a role is deleted.
 
 #### `invite_create(invite)`
 
-Fires when a invite is created.
+Fires when an invitation is created.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
@@ -477,7 +479,7 @@ Fires when a invite is created.
 
 #### `invite_delete(invite)`
 
-Fires when a invite is deleted.
+Fires when an invitation is deleted.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
@@ -503,7 +505,50 @@ Fires when a select menu is selected.
 
 ### Voice events
 
-It's too big, so they're documented in {file:docs/voice_events.md}
+Because it's big, it's documented in {file:docs/voice_events.md}.
+
+### Guild scheduled event events
+
+#### `scheduled_event_create(event)`
+
+Fires when a scheduled event is created.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `event`    | {Discorb::ScheduledEvent}| The created scheduled event. |
+
+#### `scheduled_event_cancel(event)`, `scheduled_event_delete(event)`
+
+Fires when a scheduled event is canceled or deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `event`    | {Discorb::ScheduledEvent}| The deleted scheduled event. |
+
+#### `scheduled_event_edit(before, after)`
+
+Fires when a scheduled event is edited.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `before`   | {Discorb::ScheduledEvent}| The scheduled event before the edit. |
+| `after`    | {Discorb::ScheduledEvent}| The scheduled event after the edit. |
+
+#### `scheduled_event_start(event)`
+
+Fires when a scheduled event is started.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `event`    | {Discorb::ScheduledEvent}| The scheduled event that started. |
+
+#### `scheduled_event_end(event)`
+
+Fires when a scheduled event is ended.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `event`    | {Discorb::ScheduledEvent}| The scheduled event that ended. |
 
 ### Low-level events
 
@@ -530,3 +575,12 @@ Fires when `THREAD_CREATE` is received.
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
 |`thread`    | {Discorb::ThreadChannel}| The thread of the event. |
+
+#### `scheduled_event_update(before, after)`
+
+Fires when `SCHEDULED_EVENT_UPDATE` is received.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `before` | {Discorb::ScheduledEvent}| The scheduled event before the update. |
+|`after`     | {Discorb::ScheduledEvent}| The scheduled event after the update. |

data/docs/extension.md

@@ -1,11 +1,11 @@
+<!--
 # @title Extension
+-->
 
 # Extension
 
 Extension allows you to seperate events.
 
-# @since 
-
 ## Make a new extension
 
 Make a new class that includes Extension.

data/docs/faq.md

@@ -1,4 +1,6 @@
+<!--
 # @title FAQ
+-->
 
 # Fequently asked questions
 
@@ -6,7 +8,7 @@
 
 ### What is `Async::Task`?
 
-Async::Task is a object for asynchronous tasks.
+Async::Task is an object for asynchronous tasks.
 
 https://socketry.github.io/async/ for more information.
 
@@ -16,7 +18,7 @@ It means a `server` of Discord.
 
 ### What is difference between `User` and `Member`?
 
-`User` is a object for account, `Member` is a object for user in guild.
+`User` is an object for account, `Member` is an object for user in guild.
 
 ## How can I ...?
 

data/docs/license.md

@@ -1,4 +1,6 @@
+<!--
 # @title License
+-->
 
 # License
 

data/docs/tutorial.md

@@ -1,4 +1,6 @@
+<!--
 # @title Tutorial
+-->
 
 # Tutorial
 
@@ -162,7 +164,7 @@ You can see your bot's response by typing `hello` in your server...
 
 ![](./assets/07_hello_infinite.png)
 
-Oh no! Your bot is responding to bot's messages, and it doesn't stop!
+Oops! Your bot is responding to bot's messages, it's infinite!
 
 Terminate your bot by typing `Ctrl + C` in terminal.
 
@@ -192,5 +194,4 @@ You did it! Your bot won't respond to bot's messages anymore.
 This is the end of tutorial.
 
 To learn more, check out the [documentation](https://discorb-lib.github.io/).
-
-We hope you enjoy this lib! Thanks for reading!
+You can also check out [Examples](docs/examples).

data/docs/voice_events.md

@@ -1,4 +1,6 @@
+<!--
 # @title Voice Events
+-->
 
 # Voice Events
 

data/lib/discorb/app_command.rb

@@ -34,8 +34,8 @@ module Discorb
       #
       # @return [Discorb::ApplicationCommand::Command::SlashCommand] Command object.
       #
-      # @see file:docs/application_command.md#register-slash-command
-      # @see file:docs/cli/setup.md
+      # @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, "")
@@ -56,8 +56,8 @@ module Discorb
       #
       # @return [Discorb::ApplicationCommand::Command::GroupCommand] Command object.
       #
-      # @see file:docs/slash_command.md
-      # @see file:docs/cli/setup.md
+      # @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)
@@ -73,7 +73,7 @@ module Discorb
       # @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::ApplicationCommandInteraction::UserMenuCommand] interaction Interaction object.
+      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
       # @yieldparam [Discorb::Message] message Message object.
       #
       # @return [Discorb::ApplicationCommand::Command] Command object.
@@ -91,7 +91,7 @@ module Discorb
       # @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::ApplicationCommandInteraction::UserMenuCommand] interaction Interaction object.
+      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
       # @yieldparam [Discorb::User] user User object.
       #
       # @return [Discorb::ApplicationCommand::Command] Command object.
@@ -104,6 +104,7 @@ module Discorb
 
       #
       # Setup commands.
+      # @async
       # @see Client#initialize
       #
       # @param [String] token Bot token.
@@ -309,7 +310,7 @@ module Discorb
         #
         # @return [Discorb::ApplicationCommand::Command::SubcommandGroup] Command object.
         #
-        # @see file:docs/slash_command.md
+        # @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)