discorb 0.9.3 → 0.10.0

data/lib/discorb/channel.rb

@@ -19,7 +19,7 @@ module Discorb
     @channel_type = nil
     @subclasses = []
 
-    # @!visibility private
+    # @private
     def initialize(client, data, no_cache: false)
       @client = client
       @data = {}
@@ -44,12 +44,12 @@ module Discorb
       "#<#{self.class} \"##{@name}\" id=#{@id}>"
     end
 
-    # @!visibility private
+    # @private
     def self.descendants
       ObjectSpace.each_object(Class).select { |klass| klass < self }
     end
 
-    # @!visibility private
+    # @private
     def self.make_channel(client, data, no_cache: false)
       descendants.each do |klass|
         return klass.new(client, data, no_cache: no_cache) if !klass.channel_type.nil? && klass.channel_type == data[:type]
@@ -59,7 +59,7 @@ module Discorb
     end
 
     class << self
-      # @!visibility private
+      # @private
       attr_reader :channel_type
     end
 
@@ -67,7 +67,7 @@ module Discorb
       self.class.channel_type
     end
 
-    # @!visibility private
+    # @private
     def channel_id
       Async do
         @id
@@ -248,7 +248,7 @@ module Discorb
 
     @channel_type = 0
 
-    # @!visibility private
+    # @private
     def initialize(client, data, no_cache: false)
       super
       @threads = Dictionary.new
@@ -697,7 +697,7 @@ module Discorb
     attr_reader :bitrate
     # @return [Integer] The user limit of the voice channel.
     attr_reader :user_limit
-    # @!visibility private
+    # @private
     attr_reader :stage_instances
 
     include Connectable
@@ -706,7 +706,7 @@ module Discorb
     #   @return [Discorb::StageInstance] The stage instance of the channel.
 
     @channel_type = 13
-    # @!visibility private
+    # @private
     def initialize(...)
       @stage_instances = Dictionary.new
       super(...)
@@ -831,7 +831,7 @@ module Discorb
     include Messageable
     @channel_type = nil
 
-    # @!visibility private
+    # @private
     def initialize(client, data, no_cache: false)
       @members = Dictionary.new
       super
@@ -1092,7 +1092,7 @@ module Discorb
   class DMChannel < Channel
     include Messageable
 
-    # @!visibility private
+    # @private
     def channel_id
       Async do
         @id

data/lib/discorb/client.rb

@@ -369,31 +369,30 @@ module Discorb
     #
     # Load the extension.
     #
-    # @param [Module] mod The extension to load.
-    #
-    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
+    # @param [Class] ext The extension to load.
+    # @param [Object] ... The arguments to pass to the `ext#initialize`.
+    #
+    def load_extension(ext, ...)
+      raise ArgumentError, "#{ext} is not a extension" unless ext.is_a?(Class) && ext < Discorb::Extension
+      ins = ext.new(self, ...)
+      @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
+      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.3"
+  VERSION = "0.10.0"
   # @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
@@ -25,7 +25,7 @@ module Discorb
       end
     end
 
-    # @!visibility private
+    # @private
     def inspect
       super
     end
@@ -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
-    # @!visibility private
+  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
 
@@ -115,7 +143,7 @@ module Discorb
     end
 
     class << self
-      # @!visibility private
+      # @private
       attr_reader :styles
     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
 
     #
@@ -236,7 +264,7 @@ module Discorb
         }
       end
 
-      # @!visibility private
+      # @private
       def hash_emoji(emoji)
         case emoji
         when UnicodeEmoji

data/lib/discorb/embed.rb

@@ -317,7 +317,7 @@ module Discorb
       # @return [Integer] The width of video.
       attr_reader :width
 
-      # @!visibility private
+      # @private
       def initialize(data)
         @url = data[:url]
         @proxy_url = data[:proxy_url]
@@ -335,7 +335,7 @@ module Discorb
       # @return [String] The url of provider.
       attr_reader :url
 
-      # @!visibility private
+      # @private
       def initialize(data)
         @name = data[:name]
         @url = data[:url]

data/lib/discorb/emoji.rb

@@ -40,7 +40,7 @@ module Discorb
     # @!attribute [r] roles?
     #   @return [Boolean] whether or not this emoji is restricted to certain roles.
 
-    # @!visibility private
+    # @private
     def initialize(client, guild, data)
       @client = client
       @guild = guild
@@ -147,7 +147,7 @@ module Discorb
     attr_reader :deleted
     alias deleted? deleted
 
-    # @!visibility private
+    # @private
     def initialize(data)
       @id = Snowflake.new(data[:id])
       @name = data[:name]
@@ -189,7 +189,7 @@ module Discorb
     # @return [Integer] The skin tone of the emoji.
     attr_reader :skin_tone
 
-    # @!visibility private
+    # @private
     def initialize(name, tone: 0)
       if EmojiTable::DISCORD_TO_UNICODE.key?(name)
         @name = name

data/lib/discorb/error.rb

@@ -43,7 +43,7 @@ module Discorb
     # @return [Net::HTTPResponse] the HTTP response.
     attr_reader :response
 
-    # @!visibility private
+    # @private
     def initialize(resp, data)
       @code = data[:code]
       @response = resp
@@ -55,7 +55,7 @@ module Discorb
   # Represents a 400 error.
   #
   class BadRequestError < HTTPError
-    # @!visibility private
+    # @private
     def initialize(resp, data)
       @code = data[:code]
       @response = resp

data/lib/discorb/exe/init.rb

@@ -6,7 +6,7 @@ require_relative "../utils/colored_puts"
 
 $path = Dir.pwd
 
-# @!visibility private
+# @private
 FILES = {
   "main.rb" => <<~'RUBY',
     require "discorb"
@@ -133,12 +133,12 @@ FILES = {
   MARKDOWN
 }
 
-# @!visibility private
+# @private
 def create_file(name)
   File.write($path + "/#{name}", format(FILES[name], token: $values[:token], name: $values[:name]), mode: "wb")
 end
 
-# @!visibility private
+# @private
 def make_files
   iputs "Making files..."
   create_file("main.rb")
@@ -146,7 +146,7 @@ def make_files
   sputs "Made files.\n"
 end
 
-# @!visibility private
+# @private
 def bundle_init
   iputs "Initializing bundle..."
   create_file("Gemfile")
@@ -155,7 +155,7 @@ def bundle_init
   sputs "Installed gems.\n"
 end
 
-# @!visibility private
+# @private
 def git_init
   create_file(".gitignore")
   iputs "Initializing git repository..."
@@ -167,7 +167,7 @@ def git_init
           " to change commit message of initial commit.\n"
 end
 
-# @!visibility private
+# @private
 def make_descs
   iputs "Making descriptions..."
   create_file(".env.sample")
@@ -246,8 +246,8 @@ bundle_init if $values[:bundle]
 
 make_files
 
-git_init if $values[:git]
-
 make_descs if $values[:descs]
 
+git_init if $values[:git]
+
 sputs "\nSuccessfully made a new project at \e[32m#{$path}\e[92m."

data/lib/discorb/exe/run.rb

@@ -5,7 +5,7 @@ require "discorb/utils/colored_puts"
 require "io/console"
 
 ARGV.delete_at 0
-# @!visibility private
+# @private
 LOG_LEVELS = %w[none debug info warn error fatal]
 
 opt = OptionParser.new <<~BANNER

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
 
-    # @!visibility 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

@@ -32,7 +32,7 @@ module Discorb
     # @!attribute [r] image?
     #   @return [Boolean] whether the file is an image.
 
-    # @!visibility private
+    # @private
     def initialize(data)
       @id = Snowflake.new(data[:id])
       @filename = data[:filename]
@@ -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/gateway.rb

@@ -16,7 +16,7 @@ module Discorb
     # Represents an event.
     #
     class GatewayEvent
-      # @!visibility private
+      # @private
       def initialize(data)
         @data = data
       end
@@ -61,7 +61,7 @@ module Discorb
       alias reactor fired_by
       alias from fired_by
 
-      # @!visibility private
+      # @private
       def initialize(client, data)
         @client = client
         @data = data
@@ -129,7 +129,7 @@ module Discorb
       # @return [Discorb::Message] The message the reaction was sent in.
       attr_reader :message
 
-      # @!visibility private
+      # @private
       def initialize(client, data)
         @client = client
         @data = data
@@ -180,7 +180,7 @@ module Discorb
       # @return [Discorb::UnicodeEmoji, Discorb::PartialEmoji] The emoji that was reacted with.
       attr_reader :emoji
 
-      # @!visibility private
+      # @private
       def initialize(client, data)
         @client = client
         @data = data
@@ -296,7 +296,7 @@ module Discorb
       #   @macro client_cache
       #   @return [Discorb::Guild] The guild the message was sent in.
 
-      # @!visibility private
+      # @private
       def initialize(client, id, data)
         @client = client
         @id = id
@@ -328,7 +328,7 @@ module Discorb
       #   @macro client_cache
       #   @return [Discorb::Guild] The guild the message was sent in.
 
-      # @!visibility private
+      # @private
       def initialize(client, data)
         @client = client
         @data = data
@@ -381,7 +381,7 @@ module Discorb
       #   @macro client_cache
       #   @return [Discorb::Member, Discorb::User] The member or user that started typing.
 
-      # @!visibility private
+      # @private
       def initialize(client, data)
         @client = client
         @data = data
@@ -458,7 +458,7 @@ module Discorb
       #   @macro client_cache
       #   @return [Discorb::Guild] The guild where the webhook was updated.
 
-      # @!visibility private
+      # @private
       def initialize(client, data)
         @client = client
         @data = data

data/lib/discorb/gateway_requests.rb

@@ -40,7 +40,7 @@ module Discorb
     end
 
     class << self
-      # @!visibility private
+      # @private
       attr_reader :types
     end
   end