discorb 0.13.4 → 0.15.1

data/lib/discorb/audit_logs.rb

@@ -14,7 +14,10 @@ module Discorb
     # @return [Array<Discorb::AuditLog::Entry>] The entries in this audit log.
     attr_reader :entries
 
+    #
+    # Initializes a new instance of the AuditLog class.
     # @private
+    #
     def initialize(client, data, guild)
       @client = client
       @guild = guild
@@ -24,6 +27,10 @@ module Discorb
       @entries = data[:audit_log_entries].map { |entry| AuditLog::Entry.new(@client, entry, guild.id) }
     end
 
+    def inspect
+      "<#{self.class} #{@entries.length} entries>"
+    end
+
     #
     # Gets an entry from entries.
     #
@@ -108,8 +115,11 @@ module Discorb
       # @!attribute [r] user
       #   @return [Discorb::User] The user who performed the action.
 
+      #
+      # @return [{Integer => Symbol}] The map of events to their respective changes.
       # @private
-      @events = {
+      #
+      EVENTS = {
         1 => :guild_update,
         10 => :channel_create,
         11 => :channel_update,
@@ -159,24 +169,30 @@ module Discorb
         112 => :thread_delete,
       }.freeze
 
+      #
+      # The converter for the change.
       # @private
-      @converts = {
+      #
+      CONVERTERS = {
         channel: ->(client, id, _guild_id) { client.channels[id] },
         thread: ->(client, id, _guild_id) { client.channels[id] },
         role: ->(client, id, guild_id) { client.guilds[guild_id]&.roles&.[](id) },
         member: ->(client, id, guild_id) { client.guilds[guild_id]&.members&.[](id) },
         guild: ->(client, id, _guild_id) { client.guilds[id] },
         message: ->(client, id, _guild_id) { client.messages[id] },
-      }
+      }.freeze
 
+      #
+      # Initializes a new AuditLog entry.
       # @private
+      #
       def initialize(client, data, guild_id)
         @client = client
         @guild_id = Snowflake.new(guild_id)
         @id = Snowflake.new(data[:id])
         @user_id = Snowflake.new(data[:user_id])
         @target_id = Snowflake.new(data[:target_id])
-        @type = self.class.events[data[:action_type]]
+        @type = EVENTS[data[:action_type]]
         @target = self.class.converts[@type.to_s.split("_")[0].to_sym]&.call(client, @target_id, @gui)
         @target ||= Snowflake.new(data[:target_id])
         @changes = data[:changes] && Changes.new(data[:changes])
@@ -223,15 +239,21 @@ module Discorb
         attr_reader :data
 
         #
+        # Initializes a new changes object.
         # @private
         #
+        # @param [Hash] data The data to initialize with.
+        #
         def initialize(data)
-          @data = data.map { |d| [d[:key].to_sym, d] }.to_h
+          @data = data.to_h { |d| [d[:key].to_sym, d] }
           @data.each do |k, v|
             define_singleton_method(k) { Change.new(v) }
           end
         end
 
+        #
+        # Formats the changes into a string.
+        #
         def inspect
           "#<#{self.class} #{@data.length} changes>"
         end
@@ -270,7 +292,10 @@ module Discorb
         # @return [Object] The new value of the change.
         attr_reader :new_value
 
+        #
+        # Initializes a new change object.
         # @private
+        #
         def initialize(data)
           @key = data[:key].to_sym
           method = case @key.to_s
@@ -287,8 +312,8 @@ module Discorb
             else
               ->(v) { v }
             end
-          @old_value = method.(data[:old_value])
-          @new_value = method.(data[:new_value])
+          @old_value = method.call(data[:old_value])
+          @new_value = method.call(data[:new_value])
         end
 
         #
@@ -298,10 +323,20 @@ module Discorb
           @new_value.__send__(method, ...)
         end
 
+        #
+        # Format the change into a string.
+        #
+        # @return [String] The string representation of the change.
+        #
         def inspect
           "#<#{self.class} #{@key.inspect} #{@old_value.inspect} -> #{@new_value.inspect}>"
         end
 
+        #
+        # Whether the change responds to the given method.
+        #
+        # @return [Boolean] Whether the change responds to the given method.
+        #
         def respond_to_missing?(method, include_private = false)
           @new_value.respond_to?(method, include_private)
         end
@@ -321,7 +356,10 @@ module Discorb
       # @return [Discorb::Integration::Account] The account of the integration.
       attr_reader :account
 
+      #
+      # Initializes a new integration object.
       # @private
+      #
       def initialize(data)
         @id = Snowflake.new(data[:id])
         @type = data[:type].to_sym

data/lib/discorb/channel.rb

@@ -19,7 +19,10 @@ module Discorb
     @channel_type = nil
     @subclasses = []
 
+    #
+    # Initializes a new instance of the Channel class.
     # @private
+    #
     def initialize(client, data, no_cache: false)
       @client = client
       @data = {}
@@ -44,12 +47,22 @@ module Discorb
       "#<#{self.class} \"##{@name}\" id=#{@id}>"
     end
 
+    #
+    # Returns the descendants of the Channel class.
     # @private
+    #
     def self.descendants
       ObjectSpace.each_object(Class).select { |klass| klass < self }
     end
 
+    #
+    # Creates a new instance of the Channel class or instance of its descendants.
     # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    # @param [Boolean] no_cache Whether to disable cache the object.
+    #
     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 +72,10 @@ module Discorb
     end
 
     class << self
+      #
       # @private
+      # @return [Integer] The type of the channel.
+      #
       attr_reader :channel_type
     end
 
@@ -67,7 +83,12 @@ module Discorb
       self.class.channel_type
     end
 
+    #
+    # Returns the channel id to request.
     # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    #
     def channel_id
       Async do
         @id
@@ -114,7 +135,7 @@ module Discorb
     #
     # @param [Discorb::GuildChannel] other The channel to compare.
     #
-    # @return [-1, 1] -1 if the channel is at lower than the other, 1 if the channel is at highter than the other.
+    # @return [-1, 0, 1] -1 if the channel is at lower than the other, 1 if the channel is at highter than the other.
     #
     def <=>(other)
       return 0 unless other.respond_to?(:position)
@@ -211,9 +232,9 @@ module Discorb
       @guild_id = data[:guild_id]
       @position = data[:position]
       @permission_overwrites = if data[:permission_overwrites]
-          data[:permission_overwrites].map do |ow|
+          data[:permission_overwrites].to_h do |ow|
             [(ow[:type] == 1 ? guild.roles : guild.members)[ow[:id]], PermissionOverwrite.new(ow[:allow], ow[:deny])]
-          end.to_h
+          end
         else
           {}
         end
@@ -239,17 +260,15 @@ module Discorb
     # @return [Time] The time when the last pinned message was pinned.
     attr_reader :last_pin_timestamp
     alias last_pinned_at last_pin_timestamp
-    # @return [Array<Discorb::ThreadChannel>] The threads in the channel.
-    attr_reader :threads
 
     include Messageable
 
     @channel_type = 0
 
-    # @private
-    def initialize(client, data, no_cache: false)
-      super
-      @threads = Dictionary.new
+    # @!attribute [r] threads
+    #   @return [Array<Discorb::ThreadChannel>] The threads in the channel.
+    def threads
+      guild.threads.select { |thread| thread.parent == self }
     end
 
     #
@@ -421,7 +440,7 @@ module Discorb
     def fetch_invites
       Async do
         _resp, data = @client.http.request(Route.new("/channels/#{@id}/invites", "//channels/:channel_id/invites", :get)).wait
-        data.map { |invite| Invite.new(@client, invite) }
+        data.map { |invite| Invite.new(@client, invite, false) }
       end
     end
 
@@ -446,7 +465,7 @@ module Discorb
           temporary: temporary,
           unique: unique,
         }, audit_log_reason: reason).wait
-        Invite.new(@client, data)
+        Invite.new(@client, data, false)
       end
     end
 
@@ -666,7 +685,10 @@ module Discorb
     attr_reader :bitrate
     # @return [Integer] The user limit of the voice channel.
     attr_reader :user_limit
+    #
     # @private
+    # @return [Discorb::Dictionary{Discorb::Snowflake => StageInstance}] The stage instances associated with the stage channel.
+    #
     attr_reader :stage_instances
 
     include Connectable
@@ -675,7 +697,10 @@ module Discorb
     #   @return [Discorb::StageInstance] The stage instance of the channel.
 
     @channel_type = 13
+    #
+    # Initialize a new stage channel.
     # @private
+    #
     def initialize(...)
       @stage_instances = Dictionary.new
       super(...)
@@ -759,7 +784,7 @@ module Discorb
     end
 
     def audiences
-      voice_states.filter { |state| state.suppress? }.map(&:member)
+      voice_states.filter(&:suppress?).map(&:member)
     end
 
     private
@@ -825,12 +850,17 @@ module Discorb
     include Messageable
     @channel_type = nil
 
+    #
+    # Initialize a new thread channel.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the thread channel.
+    # @param [Boolean] no_cache Whether to disable the cache.
+    #
     def initialize(client, data, no_cache: false)
       @members = Dictionary.new
       super
-      @client.channels[@parent_id].threads[@id] = self
-
       @client.channels[@id] = self unless no_cache
     end
 
@@ -990,14 +1020,23 @@ module Discorb
       end
     end
 
+    #
+    # Represents a thread in news channel(aka announcement channel).
+    #
     class News < ThreadChannel
       @channel_type = 10
     end
 
+    #
+    # Represents a public thread in text channel.
+    #
     class Public < ThreadChannel
       @channel_type = 11
     end
 
+    #
+    # Represents a private thread in text channel.
+    #
     class Private < ThreadChannel
       @channel_type = 12
     end
@@ -1007,7 +1046,7 @@ module Discorb
     end
 
     #
-    # Repre
+    # Represents a member in a thread.
     #
     class Member < DiscordModel
       attr_reader :joined_at
@@ -1059,6 +1098,9 @@ module Discorb
     end
   end
 
+  #
+  # Represents a category in a guild.
+  #
   class CategoryChannel < GuildChannel
     @channel_type = 4
 
@@ -1099,10 +1141,18 @@ module Discorb
     end
   end
 
+  #
+  # Represents a DM channel.
+  #
   class DMChannel < Channel
     include Messageable
 
+    #
+    # Returns the channel id to request.
     # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    #
     def channel_id
       Async do
         @id

data/lib/discorb/client.rb

@@ -54,7 +54,10 @@ module Discorb
     attr_reader :session_id
     # @return [Hash{String => Discorb::Extension}] The loaded extensions.
     attr_reader :extensions
+    #
     # @private
+    # @return [Hash{Discorb::Snowflake => Discorb::ApplicationCommand::Command}] The commands on the top level.
+    #
     attr_reader :bottom_commands
 
     #
@@ -186,10 +189,8 @@ module Discorb
         @log.debug "Dispatching event #{event_name}"
         events.each do |block|
           Async do
-            Async(annotation: "Discorb event: #{event_name}") do |task|
-              if block.is_a?(Discorb::EventHandler)
-                @events[event_name].delete(block) if block.metadata[:once]
-              end
+            Async(annotation: "Discorb event: #{event_name}") do |_task|
+              @events[event_name].delete(block) if block.is_a?(Discorb::EventHandler) && block.metadata[:once]
               block.call(*args)
               @log.debug "Dispatched proc with ID #{block.id.inspect}"
             rescue StandardError, ScriptError => e
@@ -261,7 +262,7 @@ module Discorb
     #
     # @return [Async::Task<Discorb::Invite>] The invite.
     #
-    def fetch_invite(code, with_count: false, with_expiration: false)
+    def fetch_invite(code, with_count: true, with_expiration: true)
       Async do
         _resp, data = @http.request(Route.new("/invites/#{code}?with_count=#{with_count}&with_expiration=#{with_expiration}", "//invites/:code", :get)).wait
         Invite.new(self, data, false)
@@ -295,8 +296,8 @@ module Discorb
     #
     def fetch_nitro_sticker_packs
       Async do
-        _resp, data = @http.request(Route.new("/stickers-packs", "//stickers-packs", :get)).wait
-        data.map { |pack| Sticker::Pack.new(self, pack) }
+        _resp, data = @http.request(Route.new("/sticker-packs", "//sticker-packs", :get)).wait
+        data[:sticker_packs].map { |pack| Sticker::Pack.new(self, pack) }
       end
     end
 
@@ -305,18 +306,15 @@ module Discorb
     #
     # @param [Discorb::Activity] activity The activity to update.
     # @param [:online, :idle, :dnd, :invisible] status The status to update.
-    # @param [String] afk Whether to set the client as AFK.
     #
-    def update_presence(activity = nil, status: nil, afk: false)
+    def update_presence(activity = nil, status: nil)
       payload = {
         activities: [],
         status: status,
-        afk: nil,
         since: nil,
+        afk: nil,
       }
-      if !activity.nil?
-        payload[:activities] = [activity.to_hash]
-      end
+      payload[:activities] = [activity.to_hash] unless activity.nil?
       payload[:status] = status unless status.nil?
       if @connection
         Async do
@@ -374,10 +372,11 @@ module Discorb
     # @param [Object] ... The arguments to pass to the `ext#initialize`.
     #
     def load_extension(ext, ...)
-      if ext.is_a?(Class)
+      case ext
+      when Class
         raise ArgumentError, "#{ext} is not a extension" unless ext < Discorb::Extension
         ins = ext.new(self, ...)
-      elsif ext.is_a?(Discorb::Extension)
+      when Discorb::Extension
         ins = ext
       else
         raise ArgumentError, "#{ext} is not a extension"
@@ -398,12 +397,20 @@ module Discorb
       ins.class.commands.each do |cmd|
         cmd.define_singleton_method(:extension) { ins.class.name }
         cmd.replace_block(ins)
+        cmd.block.define_singleton_method(:self_replaced) { true }
         @commands << cmd
       end
 
       cls = ins.class
       cls.loaded(self, ...) if cls.respond_to? :loaded
-      @bottom_commands += ins.class.bottom_commands
+      ins.class.bottom_commands.each do |cmd|
+        unless cmd.respond_to? :self_replaced
+          cmd.define_singleton_method(:extension) { ins.class.name }
+          cmd.replace_block(ins)
+          cmd.block.define_singleton_method(:self_replaced) { true }
+        end
+        @bottom_commands << cmd
+      end
       @extensions[ins.class.name] = ins
       ins
     end
@@ -463,7 +470,7 @@ module Discorb
               ::File.open(options[:log_file], "a")
             end
           @log.level = options[:log_level].to_sym
-          @log.colorize_log = options[:log_color] == nil ? @log.out.isatty : options[:log_color]
+          @log.colorize_log = options[:log_color].nil? ? @log.out.isatty : options[:log_color]
         end
       end
     end
@@ -473,29 +480,29 @@ module Discorb
       if guilds = ENV["DISCORB_SETUP_GUILDS"]
         guild_ids = guilds.split(",")
       end
-      if guild_ids == ["global"]
-        guild_ids = false
-      end
+      guild_ids = false if guild_ids == ["global"]
       setup_commands(token, guild_ids: guild_ids).wait
-      @events[:setup]&.each do |event|
-        event.call
+      if ENV["DISCORB_SETUP_SCRIPT"] == "true"
+        @events[:setup]&.each do |event|
+          event.call
+        end
+        self.on_setup if respond_to? :on_setup
       end
-      self.on_setup if respond_to? :on_setup
     end
 
     def start_client(token)
-      Async do |task|
-        Signal.trap(:SIGINT) {
+      Async do |_task|
+        Signal.trap(:SIGINT) do
           @log.info "SIGINT received, closing..."
           Signal.trap(:SIGINT, "DEFAULT")
           close!
-        }
+        end
         @token = token.to_s
         @close_condition = Async::Condition.new
         @main_task = Async do
           @status = :running
           connect_gateway(false).wait
-        rescue
+        rescue StandardError
           @status = :stopped
           @close_condition.signal
           raise

data/lib/discorb/common.rb

@@ -2,11 +2,13 @@
 
 module Discorb
   # @return [String] The API base URL.
-  API_BASE_URL = "https://discord.com/api/v9"
+  API_BASE_URL = "https://discord.com/api/v10"
   # @return [String] The version of discorb.
-  VERSION = "0.13.4"
+  VERSION = "0.15.1"
+  # @return [Array<Integer>] The version array of discorb.
+  VERSION_ARRAY = VERSION.split(".").map(&:to_i).freeze
   # @return [String] The user agent for the bot.
-  USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
+  USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}".freeze
 
   #
   # @abstract
@@ -25,11 +27,11 @@ module Discorb
       end
     end
 
-    # @private
     def inspect
-      super
+      "#<#{self.class}: #{@id}>"
     end
 
+    # @private
     def hash
       @id.hash
     end
@@ -40,7 +42,12 @@ module Discorb
   #
   # @see https://discord.com/developers/docs/reference#snowflakes Official Discord API docs
   class Snowflake < String
+    #
+    # Initialize new snowflake.
     # @private
+    #
+    # @param [#to_s] value The value of the snowflake.
+    #
     def initialize(value)
       @value = value.to_i
       super(@value.to_s)
@@ -95,7 +102,7 @@ module Discorb
     end
 
     def timestamp
-      Time.at(((@value >> 22) + 1_420_070_400_000) / 1000)
+      Time.at(((@value >> 22) + 1_420_070_400_000) / 1000.0)
     end
 
     def worker_id
@@ -111,7 +118,7 @@ module Discorb
     end
 
     def inspect
-      "#<#{self.class} #{to_s}>"
+      "#<#{self.class} #{self}>"
     end
 
     alias id to_s
@@ -130,6 +137,10 @@ module Discorb
       @method = method
     end
 
+    def inspect
+      "#<#{self.class} #{self.identifier}>"
+    end
+
     def hash
       @url.hash
     end
@@ -146,26 +157,7 @@ module Discorb
     end
   end
 
-  # @return [Object] Object that represents nil.
+  # @return [Object] Object that represents unspecified value.
   #   This is used as a default value for optional parameters.
   Unset = Object.new
-  class << Unset
-    def method_missing(*)
-      self
-    end
-
-    def or(other)
-      other
-    end
-  end
-
-  module DefineOr
-    refine Object do
-      def or(other)
-        self
-      end
-    end
-  end
-
-  using DefineOr
 end