discorb 0.15.0 → 0.15.1

data/lib/discorb/invite.rb

@@ -66,13 +66,22 @@ module Discorb
     #   Whether the invite is temporary.
     #   @return [Boolean]
 
-    @target_types = {
+    # @private
+    # @return [{Integer => Symbol}] The mapping of target types.
+    TARGET_TYPES = {
       nil => :voice,
       1 => :stream,
       2 => :guild,
     }.freeze
 
+    #
+    # Initialize a new invite.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of invite.
+    # @param [Boolean] gateway Whether the data is from gateway.
+    #
     def initialize(client, data, gateway)
       @client = client
       @data = data[:data]
@@ -124,7 +133,7 @@ module Discorb
         @expires_at = data[:expires_at] && Time.iso8601(data[:expires_at])
       end
       @inviter_data = data[:inviter]
-      @target_type = self.class.target_types[data[:target_type]]
+      @target_type = TARGET_TYPES[data[:target_type]]
       @target_user = @client.users[data[:target_user][:id]] || User.new(@client, data[:target_user]) if data[:target_user]
       # @target_application = nil
 
@@ -137,10 +146,5 @@ module Discorb
       @temporary = data[:temporary]
       @created_at = Time.iso8601(data[:created_at])
     end
-
-    class << self
-      # @private
-      attr_reader :target_types
-    end
   end
 end

data/lib/discorb/log.rb

@@ -5,11 +5,11 @@ module Discorb
   class Logger
     attr_accessor :out, :colorize_log
 
-    @levels = %i[debug info warn error fatal].freeze
+    LEVELS = %i[debug info warn error fatal].freeze
 
     def initialize(out, colorize_log, level)
       @out = out
-      @level = self.class.levels.index(level)
+      @level = LEVELS.index(level)
       @colorize_log = colorize_log
     end
 
@@ -18,11 +18,11 @@ module Discorb
     end
 
     def level
-      self.class.levels[@level]
+      LEVELS[@level]
     end
 
     def level=(level)
-      @level = self.class.levels.index(level)
+      @level = LEVELS.index(level)
       raise ArgumentError, "Invalid log level: #{level}" unless @level
     end
 

data/lib/discorb/member.rb

@@ -62,7 +62,15 @@ module Discorb
     # @!attribute [r] owner?
     #   @return [Boolean] Whether the member is the owner of the guild.
 
+    #
+    # Initialize a new instance of the member.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Discorb::Snowflake] guild_id The ID of the guild.
+    # @param [Hash] user_data The data of the user.
+    # @param [Hash] member_data The data of the member.
+    #
     def initialize(client, guild_id, user_data, member_data)
       @guild_id = guild_id
       @client = client
@@ -248,6 +256,19 @@ module Discorb
       end
     end
 
+    #
+    # Checks if the member can manage the given role.
+    #
+    # @param [Discorb::Role] role The role.
+    #
+    # @return [Boolean] `true` if the member can manage the role.
+    #
+    def can_manage?(role)
+      return true if owner?
+      top_role = roles.max_by(&:position)
+      top_role.position > role.position
+    end
+
     private
 
     def _set_data(user_data, member_data)

data/lib/discorb/message.rb

@@ -152,7 +152,14 @@ module Discorb
       !@guild_id.nil?
     end
 
+    #
+    # Initialize a new message.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the welcome screen.
+    # @param [Boolean] no_cache Whether to disable caching.
+    #
     def initialize(client, data, no_cache: false)
       @client = client
       @data = {}
@@ -446,7 +453,8 @@ module Discorb
       "#<#{self.class} #{@content.inspect} id=#{@id}>"
     end
 
-    # @private
+    private
+
     def _set_data(data)
       @id = Snowflake.new(data[:id])
       @channel_id = data[:channel_id]

data/lib/discorb/message_meta.rb

@@ -88,18 +88,31 @@ module Discorb
       def self.from_hash(data)
         new(data[:guild_id], data[:channel_id], data[:message_id], fail_if_not_exists: data[:fail_if_not_exists])
       end
+
+      def inspect
+        "#<#{self.class.name} #{@channel_id}/#{@message_id}>"
+      end
     end
 
     #
     # Represents a sticker.
     #
     class Sticker
-      attr_reader :id, :name, :format
+      # @return [Discorb::Snowflake] The sticker ID.
+      attr_reader :id
+      # @return [String] The sticker name.
+      attr_reader :name
+      # @return [Symbol] The sticker format.
+      attr_reader :format
 
       def initialize(data)
         @id = Snowflake.new(data[:id])
         @name = data[:name]
-        @format = Discorb::Sticker.sticker_format[data[:format]]
+        @format = Discorb::Sticker::STICKER_FORMAT[data[:format]]
+      end
+
+      def inspect
+        "#<#{self.class.name} #{@id}: #{@name} format=#{@format}>"
       end
     end
 
@@ -107,7 +120,7 @@ module Discorb
     # Represents a interaction of message.
     #
     class Interaction < DiscordModel
-      # @return [Discorb::Snowflake] The user ID.
+      # @return [Discorb::Snowflake] The interaction ID.
       attr_reader :id
       # @return [String] The name of command.
       # @return [nil] If the message is not a command.
@@ -117,13 +130,23 @@ module Discorb
       # @return [Discorb::User] The user.
       attr_reader :user
 
+      #
+      # Initialize a new interaction.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The interaction data.
+      #
       def initialize(client, data)
         @id = Snowflake.new(data[:id])
         @name = data[:name]
         @type = Discorb::Interaction.descendants.find { |c| c.interaction_type == data[:type] }
         @user = client.users[data[:user][:id]] || User.new(client, data[:user])
       end
+
+      def inspect
+        "<#{self.class.name} #{@id}: #{@name} type=#{@type} #{@user}>"
+      end
     end
 
     #
@@ -135,22 +158,28 @@ module Discorb
       # @return [Symbol] The type of activity.
       attr_reader :type
 
-      @type = {
+      # @private
+      # @return [{Integer => Symbol}] The mapping of activity type.
+      TYPES = {
         1 => :join,
         2 => :spectate,
         3 => :listen,
         5 => :join_request,
-      }
+      }.freeze
 
+      #
+      # Initialize a new activity.
       # @private
+      #
+      # @param [Hash] data The activity data.
+      #
       def initialize(data)
         @name = data[:name]
-        @type = self.class.type(data[:type])
+        @type = TYPES[data[:type]]
       end
 
-      class << self
-        # @private
-        attr_reader :type
+      def inspect
+        "<#{self.class.name} #{@name} type=#{@type}>"
       end
     end
   end

data/lib/discorb/permission.rb

@@ -138,7 +138,13 @@ module Discorb
     }.freeze
     @bits = @raw_bits.transform_values { |v| 1 << v }.freeze
 
+    #
+    # Initializes a new PermissionOverwrite.
     # @private
+    #
+    # @param allow [Integer] The allowed permissions.
+    # @param deny [Integer] The denied permissions.
+    #
     def initialize(allow, deny)
       @allow = allow
       @deny = deny
@@ -175,11 +181,14 @@ module Discorb
     #
     def to_hash
       self.class.bits.keys.to_h do |field|
-        [field, if @allow & self.class.bits[field] != 0
-          true
-        elsif @deny & self.class.bits[method] != 0
-          false
-        end]
+        [
+          field,
+          if @allow & self.class.bits[field] != 0
+            true
+          elsif @deny & self.class.bits[field] != 0
+            false
+          end,
+        ]
       end
     end
 

data/lib/discorb/presence.rb

@@ -19,7 +19,13 @@ module Discorb
     # @!attribute [r] activity
     #   @return [Discorb::Presence::Activity] The activity of the presence.
 
+    #
+    # Initialize a presence.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the presence.
+    #
     def initialize(client, data)
       @client = client
       @data = data
@@ -80,19 +86,26 @@ module Discorb
       # @return [Discorb::Presence::Activity::Flag] The flags of the activity.
       attr_reader :flags
 
-      @activity_types = {
+      # @private
+      # @return [{Integer => Symbol}] The mapping of activity types.
+      ACTIVITY_TYPES = {
         0 => :game,
         1 => :streaming,
         2 => :listening,
         3 => :watching,
         4 => :custom,
         5 => :competing,
-      }
+      }.freeze
 
+      #
+      # Initialize the activity.
       # @private
+      #
+      # @param [Hash] data The activity data.
+      #
       def initialize(data)
         @name = data[:name]
-        @type = self.class.activity_types[data[:type]]
+        @type = ACTIVITY_TYPES[data[:type]]
         @url = data[:url]
         @created_at = Time.at(data[:created_at])
         @timestamps = data[:timestamps] && Timestamps.new(data[:timestamps])
@@ -140,7 +153,12 @@ module Discorb
         # @return [Time] The end time of the activity.
         attr_reader :end
 
+        #
+        # Initialize the timestamps.
         # @private
+        #
+        # @param [Hash] data The timestamps data.
+        #
         def initialize(data)
           @start = data[:start] && Time.at(data[:start])
           @end = data[:end] && Time.at(data[:end])
@@ -159,7 +177,12 @@ module Discorb
         # @!attribute [r] max_size
         #   @return [Integer] The max size of the party.
 
+        #
+        # Initialize the party.
         # @private
+        #
+        # @param [Hash] data The party data.
+        #
         def initialize(data)
           @id = data[:id]
           @size = data[:size]
@@ -229,7 +252,12 @@ module Discorb
         # @return [String] The match secret of the activity.
         attr_reader :match
 
+        #
+        # Initialize the secrets.
         # @private
+        #
+        # @param [Hash] data The secrets data.
+        #
         def initialize(data)
           @join = data[:join]
           @spectate = data[:spectate]
@@ -247,17 +275,17 @@ module Discorb
         attr_reader :url
         alias text label
 
+        #
+        # Initialize the button.
         # @private
+        #
+        # @param [Hash] data The button data.
+        #
         def initialize(data)
           @label = data[0]
           @url = data[1]
         end
       end
-
-      class << self
-        # @private
-        attr_reader :activity_types
-      end
     end
 
     #
@@ -278,7 +306,12 @@ module Discorb
       # @!attribute [r] web?
       #   @return [Boolean] Whether the user is not offline on web.
 
+      #
+      # Initialize the client status.
       # @private
+      #
+      # @param [Hash] data The client status data.
+      #
       def initialize(data)
         @desktop = data[:desktop]&.to_sym || :offline
         @mobile = data[:mobile]&.to_sym || :offline

data/lib/discorb/rate_limit.rb

@@ -6,7 +6,12 @@ module Discorb
   # @private
   #
   class RatelimitHandler
+    #
+    # Initialize a rate limit handler.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    #
     def initialize(client)
       @client = client
       @path_ratelimit_bucket = {}

data/lib/discorb/reaction.rb

@@ -16,7 +16,13 @@ module Discorb
     alias me? me
     alias reacted? me
 
+    #
+    # Initialize a new reaction.
     # @private
+    #
+    # @param [Discorb::Message] message The message that this reaction is on.
+    # @param [Hash] data The data of the reaction.
+    #
     def initialize(message, data)
       @message = message
       _set_data(data)

data/lib/discorb/role.rb

@@ -42,7 +42,14 @@ module Discorb
 
     include Comparable
 
+    #
+    # Initializes a new role.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Discorb::Guild] guild The guild the role belongs to.
+    # @param [Hash] data The data of the role.
+    #
     def initialize(client, guild, data)
       @client = client
       @guild = guild
@@ -176,7 +183,12 @@ module Discorb
       # @!attribute [r] integration?
       #   @return [Boolean] Whether the role is an integration role.
 
+      #
+      # Initializes a new tag.
       # @private
+      #
+      # @param [Hash] data The data of the tag.
+      #
       def initialize(data)
         @bot_id = Snowflake.new(data[:bot_id])
         @integration_id = Snowflake.new(data[:integration_id])

data/lib/discorb/sticker.rb

@@ -29,16 +29,27 @@ module Discorb
     attr_reader :available
     alias available? available
 
-    @sticker_type = {
+    # @private
+    # @return [{Integer => Symbol}] The mapping of sticker types.
+    STICKER_TYPE = {
       1 => :official,
       2 => :guild,
     }.freeze
-    @sticker_format = {
+
+    # @private
+    # @return [{Integer => Symbol}] The mapping of sticker format.
+    STICKER_FORMAT = {
       1 => :png,
       2 => :apng,
       3 => :lottie,
-    }
+    }.freeze
+    #
+    # Initialize a new sticker.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The sticker data.
+    #
     def initialize(client, data)
       @client = client
       _set_data(data)
@@ -51,15 +62,6 @@ module Discorb
       # @!attribute [r] guild
       #   @macro client_cache
       #   @return [Discorb::Guild] The guild the sticker is in.
-      @sticker_type = {
-        1 => :official,
-        2 => :guild,
-      }.freeze
-      @sticker_format = {
-        1 => :png,
-        2 => :apng,
-        3 => :lottie,
-      }
 
       def guild
         @client.guilds[@guild_id]
@@ -121,7 +123,13 @@ module Discorb
       # @return [Discorb::Asset] The banner of the pack.
       attr_reader :banner
 
+      #
+      # Initialize a new sticker pack.
       # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The sticker pack data.
+      #
       def initialize(client, data)
         @client = client
         @id = Snowflake.new(data[:id])
@@ -141,8 +149,8 @@ module Discorb
       @id = Snowflake.new(data[:id])
       @name = data[:name]
       @tags = data[:tags].split(",")
-      @type = self.class.sticker_type[data[:type]]
-      @format = self.class.sticker_format[data[:format]]
+      @type = STICKER_TYPE[data[:type]]
+      @format = STICKER_FORMAT[data[:format]]
       @description = data[:description]
       @available = data[:available]
       if @type == :official

data/lib/discorb/user.rb

@@ -29,7 +29,13 @@ module Discorb
     # @!attribute [r] mention
     #   @return [String] The user's mention.
 
+    #
+    # Initializes a new user.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The user data.
+    #
     def initialize(client, data)
       @client = client
       @data = {}
@@ -79,7 +85,12 @@ module Discorb
 
     alias app_owner? bot_owner?
 
+    #
+    # Returns the dm channel id of the user.
     # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    #
     def channel_id
       Async do
         next @dm_channel_id if @dm_channel_id

data/lib/discorb/voice_state.rb

@@ -46,7 +46,13 @@ module Discorb
     #   @macro client_cache
     #   @return [Discorb::User] The user this voice state is for.
 
+    #
+    # Initialize a new voice state.
     # @private
+    #
+    # @param [Discorb::Client] client The client this voice state belongs to.
+    # @param [Hash] data The data of the voice state.
+    #
     def initialize(client, data)
       @client = client
       _set_data(data)
@@ -135,7 +141,14 @@ module Discorb
       2 => :guild_only,
     }
 
+    #
+    # Initialize a new instance of the StageInstance class.
     # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the stage instance.
+    # @param [Boolean] no_cache Whether to disable caching.
+    #
     def initialize(client, data, no_cache: false)
       @client = client
       @data = data
@@ -182,7 +195,7 @@ module Discorb
       Async do
         payload = {}
         payload[:topic] = topic if topic != Discorb::Unset
-        payload[:privacy_level] = self.class.privacy_level.key(privacy_level) if privacy_level != Discorb::Unset
+        payload[:privacy_level] = PRIVACY_LEVEL.key(privacy_level) if privacy_level != Discorb::Unset
         @client.http.request(
           Route.new("/stage-instances/#{@channel_id}", "//stage-instances/:channel_id", :patch), payload, audit_log_reason: reason,
         ).wait
@@ -216,7 +229,7 @@ module Discorb
       @guild_id = Snowflake.new(data[:guild_id])
       @channel_id = Snowflake.new(data[:channel_id])
       @topic = data[:topic]
-      @privacy_level = self.class.privacy_level[data[:privacy_level]]
+      @privacy_level = PRIVACY_LEVEL[data[:privacy_level]]
       @discoverable_disabled = data[:discoverable_disabled]
     end
 
@@ -246,7 +259,12 @@ module Discorb
     attr_reader :custom
     alias custom? custom
 
+    #
+    # Initialize a new instance of the VoiceRegion class.
     # @private
+    #
+    # @param [Hash] data The data of the voice region.
+    #
     def initialize(data)
       @id = data[:id]
       @name = data[:name]