discorb 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26ef2cd9945ad11a9816b4ece328391c265b8f59f8b9a67e66326e21414f083c
-  data.tar.gz: 06662ff1518386e95e615afffc6b8338cb9e337bb0dc36c66f6d1d79fd7a01e8
+  metadata.gz: 54c64c3d8d4c8293ba42d1c6ab6042b9c03b12f52b2cbdd92afb3ab483e82b8b
+  data.tar.gz: ad9c479984defc53a872cf196bd7476f7838fe9f004be6d817e78b4b5ebf3fbd
 SHA512:
-  metadata.gz: 83ddc5818285d4ed50e08998446a5fa9763cffe9c0a1992a70085af38a323e304851ca4dd77f43a8108e4ece850f097eaca9dc119b83c9bdb9a66e5c32b40f5a
-  data.tar.gz: 8a409f031d896344586bb2001019b9431299683a99df36f090f3a0da748d08bd6b4f2191c0a32823106d5b3b0cd6d22624106367d8e4adc400acf430ddb60370
+  metadata.gz: fc9a269f561e1a53ce46dbf0a026ae34999633e966bc7f286383cb0583160a85e6aaf5a1d2ee8596e72a7454052a119e7db24394abdf689f744c0cef85b5e2a4
+  data.tar.gz: f0d14f5f858848e3a3d4877a505e998da9a76b12d57b31000d28b827d3acb47c1a1025214315abe900fcce6cf043632af563f4e43c4f6e942020c6f1bf059145

data/Changelog.md

@@ -105,4 +105,10 @@
 - Change: Use zlib stream instead
 - Add: Add tutorials
 - Add: Add ratelimit handler
-- Change: Make `--git` option in `discorb init` false
+- Change: Make `--git` option in `discorb init` false
+  
+## 0.5.1
+
+- Add: Can use block for defining group commands
+- Fix: Fix bug in subcommands
+- Fix: Fix bug in receiving commands

data/Gemfile.lock

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

data/Rakefile

@@ -163,13 +163,9 @@ namespace :document do
       FileUtils.cp_r("./doc/.", "./tmp-doc")
       FileUtils.rm_rf("doc")
     end
-    version = "."
-    Rake::Task["document:yard"].execute
-    Rake::Task["document:replace:html"].execute
-    Rake::Task["document:replace:css"].execute
-    Rake::Task["document:replace:eol"].execute
     sh "git switch main -f"
     FileUtils.cp_r("./tmp-doc/.", "./doc")
+    FileUtils.cp_r("./doc/#{tags.last.delete_prefix("v")}/.", "./doc")
     sputs "Successfully built all versions"
   rescue => e
     sh "git switch main -f"

data/docs/application_command.md

@@ -53,11 +53,11 @@ In `options`, hash should be like this:
 
 ```ruby
 {
-    "Name" => {
-        type: :string,
-        required: true,
-        description: "The description of the command."
-    }
+  "Name" => {
+    type: :string,
+    required: true,
+    description: "The description of the command."
+  }
 }
 ```
 
@@ -73,19 +73,19 @@ In `options`, hash should be like this:
 
 ```ruby
 {
-    "vocaloid" => {
-        required: true,
-        description: "The vocaloid which you like.",
-        type: :string,
-        choices: {
-            "Hatsune Miku" => "miku",
-            "Kagamine Rin" => "rin",
-            "Kagamine Len" => "len",
-            "Megurine Luka" => "luka",
-            "MEIKO" => "meiko",
-            "KAITO" => "kaito",
-        }
+  "vocaloid" => {
+    required: true,
+    description: "The vocaloid which you like.",
+    type: :string,
+    choices: {
+      "Hatsune Miku" => "miku",
+      "Kagamine Rin" => "rin",
+      "Kagamine Len" => "len",
+      "Megurine Luka" => "luka",
+      "MEIKO" => "meiko",
+      "KAITO" => "kaito",
     }
+  }
 }
 
 # Note: This aritcle is written in 8/31.
@@ -113,22 +113,47 @@ To register a group of slash commands, use {Discorb::Command::Handler#slash_grou
 group = client.slash_group("settings", "Set settings of bot.")
 
 group.slash("message_expand", "Whether bot should expand message.", {
-    "enabled" => {
-        type: :boolean,
-        description: "Whether bot should expand message."
-    }
+  "enabled" => {
+    type: :boolean,
+    description: "Whether bot should expand message."
+  }
 }) do |interaction|
   # ...
 end
 
 group.slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
-    "enabled" => {
-        type: :boolean,
-        description: "Whether bot should notify DISBOARD bump."
-    }
+  "enabled" => {
+    type: :boolean,
+    description: "Whether bot should notify DISBOARD bump."
+  }
 }) do |interaction|
   # ...
 end
+
+```
+
+Since v0.5.1, You can use block for register commands.
+
+```ruby
+
+client.slash_group("settings", "Set settings of bot.") do
+  slash("message_expand", "Whether bot should expand message.", {
+    "enabled" => {
+      type: :boolean,
+      description: "Whether bot should expand message."
+    }
+  }) do |interaction|
+    # ...
+  end
+  slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
+    "enabled" => {
+      type: :boolean,
+      description: "Whether bot should notify DISBOARD bump."
+    }
+  }) do |interaction|
+    # ...
+  end
+end
 ```
 
 You can make subcommand group by using {Discorb::Command::Command::GroupCommand#group}.
@@ -210,6 +235,8 @@ end
 
 ```
 
+Same as above, you can use block for register commands since v0.5.1.
+
 ### Register User Context Menu Command
 
 ```ruby

data/lib/discorb/client.rb

@@ -422,7 +422,7 @@ module Discorb
           end
         end
         start_client(token)
-      when "setup_command"
+      when "setup"
         setup_commands(token)
       end
     end

data/lib/discorb/command.rb

@@ -44,13 +44,16 @@ module Discorb
       # @param [String] description Command description.
       # @param [Array<#to_s>] guild_ids Guild IDs to restrict the command to.
       #
+      # @yield Block to execute as the command. It can be used to define sub-commands.
+      # @yieldself [Discorb::Command::Command::GroupCommand] Group command.
+      #
       # @return [Discorb::Command::Command::GroupCommand] Command object.
       #
       # @see file:docs/slash_command.md
       #
-      def slash_group(command_name, description, guild_ids: [])
-        command = Discorb::Command::Command::GroupCommand.new(command_name, description, guild_ids, nil)
-        @commands << command
+      def slash_group(command_name, description, guild_ids: [], &block)
+        command = Discorb::Command::Command::GroupCommand.new(command_name, description, guild_ids, nil, self)
+        command.instance_eval(&block) if block_given?
         command
       end
 
@@ -174,6 +177,7 @@ module Discorb
           @guild_ids = guild_ids.map(&:to_s)
           @block = block
           @type = Discorb::Command::Command.types[type]
+          @type_raw = 1
           @options = options
           @id = nil
           @parent = parent
@@ -241,10 +245,11 @@ module Discorb
         attr_reader :description
 
         # @!visibility private
-        def initialize(name, description, guild_ids, type)
+        def initialize(name, description, guild_ids, type, client)
           super(name, guild_ids, block, type)
           @description = description
-          @commands = []
+          @commands = client.commands
+          @client = client
           @id_map = Discorb::Dictionary.new
         end
 
@@ -302,13 +307,16 @@ module Discorb
         # @param [String] command_name Group name.
         # @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.
+        #
         # @return [Discorb::Command::Command::SubcommandGroup] Command object.
         #
         # @see file:docs/slash_command.md
         #
-        def group(command_name, description)
-          command = Discorb::Command::Command::SubcommandGroup.new(command_name, description, @name)
-          @commands << command
+        def group(command_name, description, &block)
+          command = Discorb::Command::Command::SubcommandGroup.new(command_name, description, @name, @client)
+          command.instance_eval(&block) if block_given?
           command
         end
 
@@ -328,7 +336,7 @@ module Discorb
               {
                 name: command.name,
                 description: command.description,
-                default_permission: command.enabled,
+                default_permission: true,
                 type: 1,
                 options: command.to_hash[:options],
               }
@@ -336,7 +344,7 @@ module Discorb
               {
                 name: command.name,
                 description: command.description,
-                default_permission: command.enabled,
+                default_permission: true,
                 type: 2,
                 options: command.commands.map { |c| c.to_hash.merge(type: 1) },
               }
@@ -360,10 +368,10 @@ module Discorb
         attr_reader :commands
 
         # @!visibility private
-        def initialize(name, description, enabled, parent)
-          super(name, description, [], enabled, 1)
+        def initialize(name, description, parent, client)
+          super(name, description, [], 1, client)
 
-          @commands = []
+          @commands = client.commands
           @parent = parent
         end
 
@@ -376,8 +384,8 @@ module Discorb
         # @param (see Discorb::Command::Handler#slash)
         # @return [Discorb::Command::Command::SlashCommand] The added subcommand.
         #
-        def slash(command_name, description, options = {}, enabled: true, &block)
-          command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, [], enabled, block, 1, @parent + " " + @name)
+        def slash(command_name, description, options = {}, &block)
+          command = Discorb::Command::Command::SlashCommand.new(command_name, description, options, [], block, 1, @parent + " " + @name)
           @commands << command
           command
         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/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/gateway.rb

@@ -545,7 +545,7 @@ module Discorb
               connect_gateway(true)
             end
           when 11
-            @log.info "Received opcode 11"
+            @log.debug "Received opcode 11"
             @ping = Time.now.to_f - @heartbeat_before
           when 0
             handle_event(payload[:t], data)

data/lib/discorb/http.rb

@@ -5,7 +5,7 @@ require "net/https"
 module Discorb
   #
   # A class to handle http requests.
-  # This class is internal use only.
+  # @private
   #
   class HTTP
     @nil_body = nil

data/lib/discorb/interaction.rb

@@ -297,7 +297,7 @@ module Discorb
             end
           end
 
-          unless (command = @client.commands.find { |c| c.to_s == name })
+          unless (command = @client.commands.find { |c| c.to_s == name && c.type_raw == 1 })
             @client.log.warn "Unknown command name #{name}, ignoreing"
             next
           end

data/lib/discorb/rate_limit.rb

@@ -3,14 +3,22 @@
 module Discorb
   #
   # Class to handle rate limiting.
+  # @private
   #
   class RatelimitHandler
+    # @!visibility private
     def initialize(client)
       @client = client
       @ratelimit_hash = {}
       @path_ratelimit_hash = {}
     end
 
+    #
+    # Wait for the rate limit to reset.
+    #
+    # @param [String] method The HTTP method.
+    # @param [String] path The path.
+    #
     def wait(method, path)
       return if path.start_with?("https://")
 
@@ -28,6 +36,13 @@ module Discorb
       sleep(b[:reset_at] - Time.now.to_i)
     end
 
+    #
+    # Save the rate limit.
+    #
+    # @param [String] method The HTTP method.
+    # @param [String] path The path.
+    # @param [Net::HTTPResponse] resp The response.
+    #
     def save(method, path, resp)
       return unless resp["X-RateLimit-Remaining"]
 

data/template-replace/files/css/common.css

@@ -421,7 +421,7 @@ code[class=""] {
 
 .docstring .abstract {
   --dstr-back: var(--background-modifier-hover);
-  --dstr-fore: var(--interactive-hover);
+  --dstr-fore: var(--interactive-muted);
 }
 
 .docstring .note {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - sevenc-nanashi