discorb 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aec8518b5159a98382c8f9ddcc4ca5818e0be6e364ef5e8d2a623e8395b5f078
-  data.tar.gz: 4b93ab7afc612c550e19a8d7ba1fac48f0613b760f38bcd1ba2b4387e20b2435
+  metadata.gz: 4d2ef47227e1e5895bdcaf6a67641d22319909c0f6a461d72ab35be1e0c9a42b
+  data.tar.gz: 688a952b571421e8c43ca53b10f9404f6ba2abf8b9071222c35d3a10e34c5b7e
 SHA512:
-  metadata.gz: b73524dd2de6c337d42ad82f83c95d960e936ad554ebf6fb9cad6c96b06d4779b862339d319d2d0d42ba498ce6cfa536f5adc48eb801bb42e1ba4dd133c72976
-  data.tar.gz: 1ff54afd40c0731e2726236d18633bd1a9039ae4c98129765f64a0d96f4491cf282f3f4a9872a195d20403160dcdab4ed0832d923533462f088694015bcf5dc9
+  metadata.gz: 9fd5eb78a1acda90e3c673a8745a2a9954ff8b8817c38210c5c609e6a85b16e4074b59bf8ae7bcc7725f7f45f22dfd785fb5edd321e9f61994bb071e4aa25a43
+  data.tar.gz: 4bee75498af33d4716e033f51103382d8931c079495d27234cf07cf5e5b288891b40fb7e00902d3c1d7150249d0c820701d9962130890005bea5378e46af5ac8

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,57 @@
+---
+name: Bug Report
+about: A bug report for discorb.
+labels:
+- bug
+---
+
+<!--
+Before submitting a bug report, please check that it is not already being, or has been, reported.
+Don't forget to find closed issues and check if the bug is already fixed.
+-->
+
+## What is the bug?
+
+<!--
+Please describe the bug in detail.
+Ex:
+  I want to sleep, but I can't.
+-->
+
+## What steps did you take to reproduce the bug?
+
+<!--
+Please describe the steps you took to reproduce the bug.
+Ex:
+  1. Go to bed
+  2. Count sheeps
+  3. Observe
+-->
+
+## What did you expect to see?
+
+<!--
+Please describe what you expected to see.
+Ex:
+  I can sleep.
+-->
+
+## What did you see instead?
+
+<!--
+Please describe what you saw instead.
+Ex:
+  I can't sleep.
+-->
+
+## Environment information
+
+<!--
+Use `discorb show` to get the current machine.
+-->
+
+## Other information
+
+<!--
+Please describe any other information you want to include as such as the screenshots you took, or the logs you generated.
+-->

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Documentation
+    url: https://discorb-lib.github.io/
+    about: Read the documentation first.
+  - name: Official Guild
+    url: https://discord.gg/hCP6zq8Vpj
+    about: Join the official Guild.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,38 @@
+---
+name: Feature Request
+labels:
+- Feature Request
+- Enhancement
+about: Feature request for discorb's future.
+---
+<!--
+Before submitting a feature request, please check there is no existing feature request for the feature you are requesting.
+-->
+
+
+## What is the feature you are requesting?
+
+<!--
+Please describe the feature you are requesting.
+Ex: Create discorb-chan
+-->
+
+## Why do you need the feature?
+
+<!--
+Please describe the reason for the feature you are requesting.
+Ex: She's cute.
+-->
+
+## Alternative considerations?
+
+<!--
+Please describe alternative considerations for the feature you are requesting.
+Ex: Add discorb-kun
+-->
+
+## Additional context
+
+<!--
+Please describe any additional context you have for the feature you are requesting.
+-->

data/Changelog.md

@@ -144,4 +144,9 @@
 - Add: Add rbs (experimental)
 - Add: Add `-t`, `--token` option to `discorb run`
 - Add: Add `-g`, `--guild` option to `discorb setup`
-- Change: Use `Async::Task<R>` instead of `R` in return value
+- Change: Use `Async::Task<R>` instead of `R` in return value
+
+## 0.6.1
+
+- Change: Rename `Event#discriminator` to `Event#metadata`
+- Add: Add `:override` to `Client#on`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.6.0)
+    discorb (0.6.1)
       async (~> 1.30.1)
       async-http (~> 0.56.5)
       async-websocket (~> 0.19.0)

data/docs/application_command.md

@@ -11,9 +11,9 @@ From: [Discord API docs](https://discord.com/developers/docs/interactions/applic
 ## How do I register an application command?
 
 Write to a your script:
-- {Discorb::Command::Handler.slash}, {Discorb::Command::Handler.slash_group} for slash commands,
-- {Discorb::Command::Handler.user_command} for user menu commands,
-- {Discorb::Command::Handler.message_command} for message menu commands.
+- {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.
 
 And then run `discorb setup` to register your application commands.
 {file:docs/cli/setup.md Learn more about `discorb setup`}. 
@@ -39,7 +39,7 @@ end
 client.run(ENV["DISCORD_BOT_TOKEN"])
 ```
 
-{Discorb::Command::Handler#slash} takes 5 arguments:
+{Discorb::ApplicationCommand::Handler#slash} takes 5 arguments:
 
 | Argument | Description |
 |---------|-------------|
@@ -107,7 +107,7 @@ In `type`, You must use one of the following:
 
 ### Group Slash Commands
 
-To register a group of slash commands, use {Discorb::Command::Handler#slash_group}.
+To register a group of slash commands, use {Discorb::ApplicationCommand::Handler#slash_group}.
 
 ```ruby
 group = client.slash_group("settings", "Set settings of bot.")
@@ -156,7 +156,7 @@ client.slash_group("settings", "Set settings of bot.") do
 end
 ```
 
-You can make subcommand group by using {Discorb::Command::Command::GroupCommand#group}.
+You can make subcommand group by using {Discorb::ApplicationCommand::Command::GroupCommand#group}.
 
 ```ruby
 group = client.slash_group("permission", "Set/Get command permissions.")
@@ -244,7 +244,7 @@ client.user_command("hello") do |interaction, user|
   interaction.post("Hello, #{user.name}!")
 end
 ```
-{Discorb::Command::Handler.user_command} takes 3 arguments:
+{Discorb::ApplicationCommand::Handler.user_command} takes 3 arguments:
 
 | Parameter | Description |
 | --- | --- |
@@ -268,7 +268,7 @@ client.message_command("Bookmark") do |interaction, message|
 end
 ```
 
-{Discorb::Command::Handler.message_command} takes 3 arguments:
+{Discorb::ApplicationCommand::Handler.message_command} takes 3 arguments:
 
 | Parameter | Description |
 | --- | --- |

data/docs/events.md

@@ -30,6 +30,35 @@ end
 
 If you want to seperate event handlers from the client, consider using {Discorb::Extension}. {file:docs/extension.md Learn more about extensions}.
 
+Since v0.6.1, you can set `:override` to `true` to register overridable event handlers.
+
+```ruby
+client.on :message, override: true do |event|
+  puts "This event handler is overrideable!"
+end
+
+client.on :message do |event|
+  puts "Override!"
+end
+```
+
+This example will print `Override!`, but not `This event handler is overrideable!`.
+This is useful for registering event handlers for default behaviour on errors.
+
+```ruby
+# In the library...
+
+client.on :command_error, override: true do |event, error|
+  $stderr.puts "Command error:\n#{error.full_message}"
+end
+
+# In your code...
+
+client.on :command_error do |event, error|
+  event.message.reply "An error occurred while executing that command!\n#{error.full_message}"
+end
+```
+
 ## Event reference
 
 ### Client events

data/docs/extension.md

@@ -36,7 +36,7 @@ end
 
 ## Register Command
 
-Since v0.5.2, {Discorb::Extension} includes {Discorb::Command::Handler} module, so you can register command with {Discorb::Command::Handler#slash} and {Discorb::Command::Handler#slash_group}.
+Since v0.5.2, {Discorb::Extension} includes {Discorb::ApplicationCommand::Handler} module, so you can register command with {Discorb::ApplicationCommand::Handler#slash} and {Discorb::ApplicationCommand::Handler#slash_group}.
 
 ```ruby
 module MyExtension

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
       #
@@ -27,13 +27,13 @@ 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.
       #
-      # @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: nil, &block)
-        command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, guild_ids, block, 1, "")
+        command = Discorb::ApplicationCommand::Command::SlashCommand.new(command_name, description, options, guild_ids, block, 1, "")
         @commands << command
         @bottom_commands << command
         command
@@ -47,15 +47,15 @@ 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.
       #
       # @yield Block to execute as the command. It can be used to define sub-commands.
-      # @yieldself [Discorb::Command::Command::GroupCommand] Group command.
+      # @yieldself [Discorb::ApplicationCommand::Command::GroupCommand] 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: nil, &block)
-        command = Discorb::Command::Command::GroupCommand.new(command_name, description, guild_ids, nil, self)
+        command = Discorb::ApplicationCommand::Command::GroupCommand.new(command_name, description, guild_ids, nil, self)
         command.instance_eval(&block) if block_given?
         @commands << command
         command
@@ -68,13 +68,13 @@ 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::CommandInteraction::UserMenuCommand] interaction Interaction 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: nil, &block)
-        command = Discorb::Command::Command.new(command_name, guild_ids, block, 3)
+        command = Discorb::ApplicationCommand::Command.new(command_name, guild_ids, block, 3)
         @commands << command
         command
       end
@@ -86,13 +86,13 @@ 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::CommandInteraction::UserMenuCommand] interaction 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: nil, &block)
-        command = Discorb::Command::Command.new(command_name, guild_ids, block, 2)
+        command = Discorb::ApplicationCommand::Command.new(command_name, guild_ids, block, 2)
         @commands << command
         command
       end
@@ -163,7 +163,7 @@ module Discorb
         @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
@@ -251,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
@@ -268,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
@@ -285,14 +285,14 @@ module Discorb
         # @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.
+        # @yieldself [Discorb::ApplicationCommand::Command::SubcommandGroup] 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 = Discorb::ApplicationCommand::Command::SubcommandGroup.new(command_name, description, @name, @client)
           command.instance_eval(&block) if block_given?
           @commands << command
           command
@@ -342,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
@@ -359,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/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.
@@ -99,14 +99,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 +119,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
 
     #
@@ -177,7 +175,7 @@ module Discorb
           lambda { |event_args|
             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)
               @log.debug "Dispatched proc with ID #{block.id.inspect}"
@@ -369,10 +367,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,7 +390,7 @@ module Discorb
     end
 
     include Discorb::Gateway::Handler
-    include Discorb::Command::Handler
+    include Discorb::ApplicationCommand::Handler
 
     #
     # Starts the client.