discorb 0.9.4 → 0.10.1

data/docs/extension.md

@@ -2,16 +2,16 @@
 
 # Extension
 
-Extension allows you to split your code into multiple files.
+Extension allows you to seperate your code from the main application.
+
+# @since 
 
 ## Make a new extension
 
-Make a new module, and extend {Discorb::Extension}.
+Make a new class that extends Extension.
 
 ```ruby
-module MyExtension
-  extend Discorb::Extension
-  
+class MyExtension < Discorb::Extension
   # ...
 end
 ```
@@ -21,27 +21,25 @@ end
 Use {Discorb::Extension.event} to register event, or {Discorb::Extension.once_event} to register event only once.
 
 ```ruby
-module MyExtension
-  extend Discorb::Extension
-
+class MyExtension < Discorb::Extension
   event :message do |message|
     # ...
   end
 
-  once_event :ready do |message|
+  once_event :standby do |message|
     # ...
   end
 end
 ```
 
+Note block will be binded to the extension instance.
+
 ## Register Command
 
-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}.
+Use `Discorb::Extension.command` to register command, see {Discorb::ApplicationCommand::Handler} for more information.
 
 ```ruby
-module MyExtension
-  extend Discorb::Extension
-
+class MyExtension < Discorb::Extension
   slash("command", "Command") do |interaction|
     # ...
   end
@@ -63,18 +61,16 @@ end
 
 ## Load extension
 
-Use {Discorb::Client#extend} to load extension.
+Use {Discorb::Client#load_extension} to load extension.
 
 ```ruby
-module MyExtension
-  extend Discorb::Extension
-
+class MyExtension < Discorb::Extension
   event :message do |message|
     # ...
   end
 end
 
-client.extend MyExtension
+client.load_extension(MyExtension)
 ```
 
 ## Access Client from extension
@@ -82,10 +78,8 @@ client.extend MyExtension
 You can access {Discorb::Client} from extension with `@client`.
 
 ```ruby
-module MyExtension
-  extend Discorb::Extension
-
-  event :ready do |message|
+class MyExtension < Discorb::Extension
+  event :standby do |message|
     puts "Logged in as #{@client.user}"
   end
 end

data/docs/license.md

@@ -4,4 +4,8 @@
 
 discorb is licensed under the [MIT license](https://opensource.org/licenses/MIT).
 
-{include:file:License.txt}
+----
+
+{include:file:LICENSE.txt}
+
+----

data/examples/extension/main.rb

@@ -7,6 +7,6 @@ client.once :standby do
   puts "Logged in as #{client.user}"
 end
 
-client.extend(MessageExpander)
+client.load_extension(MessageExpander)
 
 client.run(ENV["DISCORD_BOT_TOKEN"])

data/examples/extension/message_expander.rb

@@ -1,9 +1,7 @@
 require "discorb"
 
-module MessageExpander
-  extend Discorb::Extension
-
-  @message_regex = Regexp.new(
+class MessageExpander < Discorb::Extension
+  @@message_regex = Regexp.new(
     '(?!<)https://(?:ptb\.|canary\.)?discord(?:app)?\.com/channels/' \
     "(?<guild>[0-9]{18})/(?<channel>[0-9]{18})/(?<message>[0-9]{18})(?!>)"
   )
@@ -11,7 +9,7 @@ module MessageExpander
   event :message do |message|
     next if message.author.bot?
 
-    message.content.to_enum(:scan, @message_regex).map { Regexp.last_match }.each do |match|
+    message.content.to_enum(:scan, @@message_regex).map { Regexp.last_match }.each do |match|
       ch = @client.channels[match[:channel]]
       next if ch.nil?
 
@@ -27,7 +25,7 @@ module MessageExpander
           author: Discorb::Embed::Author.new(
             url_message.author.name,
             url: url_message.jump_url,
-            icon: url_message.author.display_avatar.url,
+            icon: url_message.author.avatar.url,
           ),
           footer: Discorb::Embed::Footer.new(
             "#{url_message.guild.name} / #{ch.name}",

data/lib/discorb/app_command.rb

@@ -20,9 +20,11 @@ module Discorb
       #   | Key | Type | Description |
       #   | --- | --- | --- |
       #   | `:description` | `String` | Description of the option. |
-      #   | `:optional` | `Boolean` | Whether the option is optional or not. |
+      #   | `: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. |
+      #   | `:default` | `Object` | Default value of the option. |
       #
       # @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.
@@ -231,7 +233,7 @@ module Discorb
               end,
               name: name,
               description: value[:description],
-              required: !value[:optional],
+              required: value[:required].nil? ? !value[:optional] : value[:required],
             }
             if value[:choices]
               ret[:choices] = value[:choices].map { |t| { name: t[0], value: t[1] } }

data/lib/discorb/client.rb

@@ -52,6 +52,8 @@ module Discorb
     attr_reader :status
     # @return [Integer] The session ID of connection.
     attr_reader :session_id
+    # @return [Hash{String => Discorb::Extension}] The loaded extensions.
+    attr_reader :extensions
     # @private
     attr_reader :bottom_commands
 
@@ -97,6 +99,7 @@ module Discorb
       @status = :initialized
       @fetch_member = fetch_member
       @title = title
+      @extensions = {}
       set_default_events
     end
 
@@ -369,31 +372,38 @@ module Discorb
     #
     # Load the extension.
     #
-    # @param [Module] mod The extension to load.
+    # @param [Class, Discorb::Extension] ext The extension to load.
+    # @param [Object] ... The arguments to pass to the `ext#initialize`.
     #
-    def extend(mod)
-      if mod.respond_to?(:events)
-        @events.each_value do |event|
-          event.delete_if { |c| c.metadata[:extension] == mod.name }
-        end
-        mod.events.each do |name, events|
-          @events[name] ||= []
-          @events[name].delete_if { |c| c.metadata[:override] }
-          events.each do |event|
-            @events[name] << event
-          end
-        end
-        @commands.delete_if do |cmd|
-          cmd.respond_to? :extension and cmd.extension == mod.name
-        end
-        mod.commands.each do |cmd|
-          cmd.define_singleton_method(:extension) { mod.name }
-          @commands << cmd
+    def load_extension(ext, ...)
+      if ext.is_a?(Class)
+        raise ArgumentError, "#{ext} is not a extension" unless ext < Discorb::Extension
+        ins = ext.new(self, ...)
+      elsif ext.is_a?(Discorb::Extension)
+        ins = ext
+      else
+        raise ArgumentError, "#{ext} is not a extension"
+      end
+
+      @events.each_value do |event|
+        event.delete_if { |c| c.metadata[:extension] == ins.class.name }
+      end
+      ins.events.each do |name, events|
+        @events[name] ||= []
+        events.each do |event|
+          @events[name] << event
         end
-        @bottom_commands += mod.bottom_commands
-        mod.client = self
       end
-      super(mod)
+      @commands.delete_if do |cmd|
+        cmd.respond_to? :extension and cmd.extension == ins.name
+      end
+      ins.class.commands.each do |cmd|
+        cmd.define_singleton_method(:extension) { ins.name }
+        @commands << cmd
+      end
+      @bottom_commands += ins.class.bottom_commands
+      @extensions[ins.class.name] = ins
+      ins
     end
 
     include Discorb::Gateway::Handler

data/lib/discorb/common.rb

@@ -4,9 +4,9 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.9.4"
+  VERSION = "0.10.1"
   # @return [String] The user agent for the bot.
-  USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"
+  USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
 
   #
   # @abstract
@@ -39,10 +39,11 @@ module Discorb
   # Represents Snowflake of Discord.
   #
   # @see https://discord.com/developers/docs/reference#snowflakes Official Discord API docs
-  class Snowflake < DiscordModel
+  class Snowflake < String
     # @private
     def initialize(value)
       @value = value.to_i
+      super(@value.to_s)
     end
 
     # @!attribute [r] timestamp
@@ -64,26 +65,6 @@ module Discorb
     #
     #   @return [Integer] Increment of snowflake.
 
-    #
-    # Stringify snowflake.
-    #
-    # @return [String] Stringified snowflake.
-    #
-    def to_s
-      @value.to_s
-    end
-
-    alias to_str to_s
-
-    #
-    # Integerize snowflake.
-    #
-    # @return [Integer] Integerized snowflake.
-    #
-    def to_i
-      @value.to_i
-    end
-
     #
     # Compares snowflake with other object.
     #

data/lib/discorb/components.rb

@@ -36,6 +36,34 @@ module Discorb
           )
         end
       end
+
+      #
+      # Convert components to a hash.
+      #
+      # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components Components.
+      #
+      # @return [Array<Hash>] Hash data.
+      #
+      def to_payload(components)
+        tmp_components = []
+        tmp_row = []
+        components.each do |c|
+          case c
+          when Array
+            tmp_components << tmp_row
+            tmp_row = []
+            tmp_components << c
+          when SelectMenu
+            tmp_components << tmp_row
+            tmp_row = []
+            tmp_components << [c]
+          else
+            tmp_row << c
+          end
+        end
+        tmp_components << tmp_row
+        return tmp_components.filter { |c| c.length.positive? }.map { |c| { type: 1, components: c.map(&:to_hash) } }
+      end
     end
   end
 
@@ -152,7 +180,7 @@ module Discorb
     # @return [Integer] The maximum number of values.
     attr_accessor :max_values
     # @return [Boolean] Whether the select menu is disabled.
-    attr_reader :disabled
+    attr_accessor :disabled
     alias disabled? disabled
 
     #

data/lib/discorb/exe/run.rb

@@ -22,6 +22,7 @@ options = {
   log_color: nil,
   setup: nil,
   token: false,
+  bundler: :default,
 }
 opt.on("-l", "--log-level LEVEL", "Log level.") do |v|
   unless LOG_LEVELS.include? v.downcase
@@ -36,6 +37,7 @@ opt.on("-c", "--[no-]log-color", "Whether to colorize log output.") { |v| option
 opt.on("-s", "--setup", "Whether to setup application commands.") { |v| options[:setup] = v }
 opt.on("-e", "--env [ENV]", "The name of the environment variable to use for token, or just `-e` or `--env` for intractive prompt.") { |v| options[:token] = v }
 opt.on("-t", "--title TITLE", "The title of process.") { |v| options[:title] = v }
+opt.on("-b", "--[no-]bundler", "Whether to use bundler. Default to true if Gemfile exists, otherwise false.") { |v| options[:bundler] = v }
 opt.parse!(ARGV)
 
 script = ARGV[0]
@@ -54,10 +56,25 @@ elsif options[:token].nil? || options[:token] == "-"
   puts ""
 end
 
+if options[:bundler] == :default
+  dir = Dir.pwd.split("/")
+  options[:bundler] = false
+  dir.length.times.reverse_each do |i|
+    if File.exist? "#{dir[0..i].join("/")}/Gemfile"
+      options[:bundler] = true
+      break
+    end
+  end
+end
+
 ENV["DISCORB_CLI_TITLE"] = options[:title]
 
-begin
-  load script
-rescue LoadError
+if File.exist? script
+  if options[:bundler]
+    system "bundle exec ruby #{script}"
+  else
+    system "ruby #{script}"
+  end
+else
   eputs "Could not load script: \e[31m#{script}\e[91m"
 end

data/lib/discorb/extend.rb

@@ -16,3 +16,24 @@ class Time
     end
   end
 end
+
+# @private
+class Async::Node
+  def description
+    @object_name ||= "#{self.class}:0x#{object_id.to_s(16)}#{@transient ? " transient" : nil}"
+
+    if @annotation
+      "#{@object_name} #{@annotation}"
+    elsif line = self.backtrace(0, 1)&.first
+      "#{@object_name} #{line}"
+    else
+      @object_name
+    end
+  end
+
+  def to_s
+    "\#<#{self.description}>"
+  end
+
+  alias inspect to_s
+end

data/lib/discorb/extension.rb

@@ -2,65 +2,78 @@
 
 module Discorb
   #
-  # Module to make extension.
-  # extend this module to make your own extension.
+  # Abstract class to make extension.
+  # Inherit from this class to make your own extension.
   # @see file:docs/extension.md
   # @abstract
   #
-  module Extension
-    include Discorb::ApplicationCommand::Handler
-    undef setup_commands
+  class Extension
+    extend Discorb::ApplicationCommand::Handler
 
     @events = {}
-    @client = nil
 
-    #
-    # Define a new event.
-    #
-    # @param [Symbol] event_name The name of the event.
-    # @param [Symbol] id The id of the event. Used to delete the event.
-    # @param [Hash] metadata Other metadata.
-    # @param [Proc] block The block to execute when the event is triggered.
-    #
-    # @return [Discorb::Event] The event.
-    #
-    def event(event_name, id: nil, **metadata, &block)
-      raise ArgumentError, "Event name must be a symbol" unless event_name.is_a?(Symbol)
-      raise ArgumentError, "block must be a Proc" unless block.is_a?(Proc)
-
-      @events[event_name] ||= []
-      metadata[:extension] = self.name
-      @events[event_name] << Discorb::Event.new(block, id, metadata)
+    def initialize(client)
+      @client = client
     end
 
-    #
-    # Define a new once event.
-    #
-    # @param [Symbol] event_name The name of the event.
-    # @param [Symbol] id The id of the event. Used to delete the event.
-    # @param [Hash] metadata Other metadata.
-    # @param [Proc] block The block to execute when the event is triggered.
-    #
-    # @return [Discorb::Event] The event.
-    #
-    def once_event(event_name, id: nil, **metadata, &block)
-      event(event_name, id: id, once: true, **metadata, &block)
+    def events
+      return @events if @events
+      ret = {}
+      self.class.events.each do |event, handlers|
+        ret[event] = handlers.map do |handler|
+          Discorb::Event.new(Proc.new { |*args, **kwargs| instance_exec(*args, **kwargs, &handler[2]) }, handler[0], handler[1])
+        end
+      end
+      @events = ret
     end
 
-    # @return [Hash{Symbol => Array<Discorb::Event>}] The events of the extension.
-    attr_reader :events
-    # @return [Array<Discorb::ApplicationCommand::Command>] The commands of the extension.
-    attr_reader :commands
-    # @private
-    attr_reader :bottom_commands
+    class << self
+      undef setup_commands
+
+      #
+      # Define a new event.
+      #
+      # @param [Symbol] event_name The name of the event.
+      # @param [Symbol] id The id of the event. Used to delete the event.
+      # @param [Hash] metadata Other metadata.
+      #
+      # @return [Discorb::Event] The event.
+      #
+      def event(event_name, id: nil, **metadata, &block)
+        raise ArgumentError, "Event name must be a symbol" unless event_name.is_a?(Symbol)
+        raise ArgumentError, "block must be given" unless block_given?
+
+        @events[event_name] ||= []
+        metadata[:extension] = self.name
+        @events[event_name] << [id, metadata, block]
+      end
+
+      #
+      # Define a new once event.
+      #
+      # @param [Symbol] event_name The name of the event.
+      # @param [Symbol] id The id of the event. Used to delete the event.
+      # @param [Hash] metadata Other metadata.
+      # @param [Proc] block The block to execute when the event is triggered.
+      #
+      # @return [Discorb::Event] The event.
+      #
+      def once_event(event_name, id: nil, **metadata, &block)
+        event(event_name, id: id, once: true, **metadata, &block)
+      end
 
-    # @private
-    attr_accessor :client
+      # @return [Hash{Symbol => Array<Discorb::Event>}] The events of the extension.
+      attr_reader :events
+      # @return [Array<Discorb::ApplicationCommand::Command>] The commands of the extension.
+      attr_reader :commands
+      # @private
+      attr_reader :bottom_commands
 
-    def self.extended(obj)
-      obj.instance_variable_set(:@events, {})
-      obj.instance_variable_set(:@commands, [])
-      obj.instance_variable_set(:@bottom_commands, [])
+      def inherited(klass)
+        klass.instance_variable_set(:@commands, [])
+        klass.instance_variable_set(:@bottom_commands, [])
+        klass.instance_variable_set(:@events, {})
+      end
     end
   end
 end

data/lib/discorb/file.rb

@@ -60,6 +60,14 @@ module Discorb
     # @return [String] The content type of the file. If not set, it is guessed from the filename.
     attr_accessor :content_type
 
+    #
+    # Creates a new file from IO.
+    #
+    # @param [#read] io The IO of the file.
+    # @param [String] filename The filename of the file. If not set, path or object_id of the IO is used.
+    # @param [String] content_type The content type of the file. If not set, it is guessed from the filename.
+    #   If failed to guess, it is set to `application/octet-stream`.
+    #
     def initialize(io, filename = nil, content_type: nil)
       @io = io
       @filename = filename || (io.respond_to?(:path) ? io.path : io.object_id)
@@ -67,8 +75,18 @@ module Discorb
       @content_type = "application/octet-stream" if @content_type == ""
     end
 
+    #
+    # Creates a new file from a string.
+    #
+    # @param [String] string The string to create the file from.
+    # @param [String] filename The filename of the file. object_id of the string is used if not set.
+    # @param [String] content_type The content type of the file. If not set, it is guessed from the filename.
+    #
+    # @return [File] The new file.
+    #
     def self.from_string(string, filename: nil, content_type: nil)
       io = StringIO.new(string)
+      filename ||= string.object_id.to_s + ".txt"
       new(io, filename, content_type: content_type)
     end
   end

data/lib/discorb/interaction.rb

@@ -198,7 +198,6 @@ module Discorb
         # @macro http
         # @macro edit
         #
-        # @param [Discorb::Webhook::Message] message The message to edit.
         # @param [String] content The new content of the message.
         # @param [Discorb::Embed] embed The new embed of the message.
         # @param [Array<Discorb::Embed>] embeds The new embeds of the message.
@@ -256,7 +255,7 @@ module Discorb
       def defer_update(ephemeral: false)
         Async do
           @client.http.post("/interactions/#{@id}/#{@token}/callback", {
-            type: 7,
+            type: 6,
             data: {
               flags: (ephemeral ? 1 << 6 : 0),
             },
@@ -311,7 +310,7 @@ module Discorb
             payload[:components] = tmp_components.filter { |c| c.length.positive? }.map { |c| { type: 1, components: c.map(&:to_hash) } }
           end
           payload[:flags] = (ephemeral ? 1 << 6 : 0)
-          @client.http.post("/interactions/#{@id}/#{@token}/callback", { type: 6, data: payload }).wait
+          @client.http.post("/interactions/#{@id}/#{@token}/callback", { type: 7, data: payload }).wait
         end
       end
     end
@@ -363,28 +362,31 @@ module Discorb
               options = data[:options]
             end
           end
-          options ||= []
-          options.map! do |option|
-            case option[:type]
-            when 3, 4, 5, 10
-              option[:value]
-            when 6
-              guild.members[option[:value]] || guild.fetch_member(option[:value]).wait
-            when 7
-              guild.channels[option[:value]] || guild.fetch_channels.wait.find { |channel| channel.id == option[:value] }
-            when 8
-              guild.roles[option[:value]] || guild.fetch_roles.wait.find { |role| role.id == option[:value] }
-            when 9
-              guild.members[option[:value]] || guild.roles[option[:value]] || guild.fetch_member(option[:value]).wait || guild.fetch_roles.wait.find { |role| role.id == option[:value] }
-            end
-          end
 
           unless (command = @client.bottom_commands.find { |c| c.to_s == name && c.type_raw == 1 })
             @client.log.warn "Unknown command name #{name}, ignoreing"
             next
           end
 
-          command.block.call(self, *options)
+          option_map = command.options.map { |k, v| [k.to_s, v[:default]] }.to_h
+          options ||= []
+          options.each do |option|
+            val = case option[:type]
+              when 3, 4, 5, 10
+                option[:value]
+              when 6
+                guild.members[option[:value]] || guild.fetch_member(option[:value]).wait
+              when 7
+                guild.channels[option[:value]] || guild.fetch_channels.wait.find { |channel| channel.id == option[:value] }
+              when 8
+                guild.roles[option[:value]] || guild.fetch_roles.wait.find { |role| role.id == option[:value] }
+              when 9
+                guild.members[option[:value]] || guild.roles[option[:value]] || guild.fetch_member(option[:value]).wait || guild.fetch_roles.wait.find { |role| role.id == option[:value] }
+              end
+            option_map[option[:name]] = val
+          end
+
+          command.block.call(self, *command.options.map { |k, v| option_map[k.to_s] })
         end
       end
     end
@@ -458,6 +460,8 @@ module Discorb
     include Interaction::UpdateResponse
     # @return [String] The content of the response.
     attr_reader :custom_id
+    # @return [Discorb::Message] The target message.
+    attr_reader :message
 
     @interaction_type = 3
     @interaction_name = :message_component

data/lib/discorb/message.rb

@@ -296,11 +296,11 @@ module Discorb
     # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
     # @param [Boolean] supress Whether to supress embeds.
     #
-    def edit(message_id, content = nil, embed: nil, embeds: nil, allowed_mentions: nil,
-                                        components: nil, supress: nil)
+    def edit(content = nil, embed: nil, embeds: nil, allowed_mentions: nil,
+                            components: nil, supress: nil)
       Async do
-        channel.edit_message(@id, message_id, content, embed: embed, embeds: embeds, allowed_mentions: allowed_mentions,
-                                                       components: components, supress: supress).wait
+        channel.edit_message(@id, content, embed: embed, embeds: embeds, allowed_mentions: allowed_mentions,
+                                           components: components, supress: supress).wait
       end
     end