discorb 0.13.0 → 0.13.1

data/lib/discorb/event.rb

@@ -90,8 +90,7 @@ module Discorb
 
     #
     # Create a scheduled event for the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [:stage_instance, :voice, :external] type The type of event to create.
     # @param [String] name The name of the event.
@@ -103,6 +102,8 @@ module Discorb
     # @param [:guild_only] privacy_level The privacy level of the event. This must be `:guild_only`.
     # @param [:active, :completed, :canceled] status The status of the event.
     #
+    # @return [Async::Task<Discorb::ScheduledEvent>] The event that was created.
+    #
     # @see Event#start
     # @see Event#cancel
     # @see Event#complete
@@ -194,8 +195,9 @@ module Discorb
 
     #
     # Deletes the event.
-    # @macro async
-    # @macro http
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
     #
     def delete!
       Async do
@@ -207,8 +209,7 @@ module Discorb
 
     #
     # Fetches the event users.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @note You can fetch all of members by not specifying a parameter.
     #
@@ -218,7 +219,7 @@ module Discorb
     # @param [Boolean] with_member Whether to include the member object of the event. Defaults to `false`.
     #   This should be used for manual fetching of members.
     #
-    # @return [Array<Discorb::Member>] The event users.
+    # @return [Async::Task<Array<Discorb::Member>>] The event users.
     #
     def fetch_users(limit = nil, before: nil, after: nil, with_member: true)
       Async do

data/lib/discorb/exe/show.rb

@@ -2,7 +2,9 @@
 
 require "etc"
 require "discorb"
+
 puts "\e[90mRuby:\e[m #{RUBY_VERSION}"
 puts "\e[90mdiscorb:\e[m #{Discorb::VERSION}"
 uname = Etc.uname
 puts "\e[90mSystem:\e[m #{uname[:sysname]} #{uname[:release]}"
+puts "\e[90mPlatform:\e[m #{RUBY_PLATFORM}"

data/lib/discorb/extension.rb

@@ -4,7 +4,7 @@ module Discorb
   #
   # Abstract class to make extension.
   # Include from this module to make your own extension.
-  # @see file:docs/extension.md
+  # @see file:docs/extension.md Extension
   # @abstract
   #
   module Extension

data/lib/discorb/flag.rb

@@ -92,7 +92,7 @@ module Discorb
     #
     # @return [Discorb::Flag] The negation of the flag.
     #
-    def ~@
+    def ~
       self.class.new(~@value)
     end
 

data/lib/discorb/gateway.rb

@@ -94,8 +94,7 @@ module Discorb
 
       # Fetch the message.
       # If message is cached, it will be returned.
-      # @macro async
-      # @macro http
+      # @async
       #
       # @param [Boolean] force Whether to force fetching the message.
       #
@@ -143,8 +142,7 @@ module Discorb
 
       # Fetch the message.
       # If message is cached, it will be returned.
-      # @macro async
-      # @macro http
+      # @async
       #
       # @param [Boolean] force Whether to force fetching the message.
       #
@@ -195,8 +193,7 @@ module Discorb
 
       # Fetch the message.
       # If message is cached, it will be returned.
-      # @macro async
-      # @macro http
+      # @async
       #
       # @param [Boolean] force Whether to force fetching the message.
       #
@@ -293,8 +290,7 @@ module Discorb
       end
 
       # Fetch the message.
-      # @macro async
-      # @macro http
+      # @async
       #
       # @return [Async::Task<Discorb::Message>] The message.
       def fetch_message
@@ -503,14 +499,14 @@ module Discorb
     module Handler
       private
 
-      def connect_gateway(reconnect)
+      def connect_gateway(reconnect, no_close: false)
         if reconnect
           @log.info "Reconnecting to gateway..."
         else
           @log.info "Connecting to gateway..."
         end
         Async do
-          @connection&.close
+          @connection&.close unless no_close
           @http = HTTP.new(self)
           _, gateway_response = @http.get("/gateway").wait
           gateway_url = gateway_response[:url]
@@ -537,9 +533,9 @@ module Discorb
                   end
                 end
               end
-            rescue Async::Wrapper::Cancelled, OpenSSL::SSL::SSLError, Async::Wrapper::WaitError, EOFError => e
-              @log.error "Gateway connection closed: #{e.class}: #{e.message}"
-              connect_gateway(true)
+            rescue Async::Wrapper::Cancelled, OpenSSL::SSL::SSLError, Async::Wrapper::WaitError, EOFError, Errno::EPIPE => e
+              @log.error "Gateway connection closed accidentally: #{e.class}: #{e.message}"
+              connect_gateway(true, no_close: true)
             else # should never happen
               connect_gateway(true)
             end

data/lib/discorb/guild.rb

@@ -28,7 +28,7 @@ module Discorb
     attr_reader :features
     # @return [:none, :elevated] The MFA level of the guild.
     attr_reader :mfa_level
-    # @return [Discorb::Guild::SystemChannelFlag] The flag for the system channel.
+    # @return [Discorb::SystemChannelFlag] The flag for the system channel.
     attr_reader :system_channel_flags
     # @return [Time] Time that representing when bot has joined the guild.
     attr_reader :joined_at
@@ -162,8 +162,9 @@ module Discorb
 
     #
     # Leave the guild.
-    # @macro async
-    # @macro http
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
     #
     def leave!
       Async do
@@ -174,8 +175,7 @@ module Discorb
 
     #
     # Fetch scheduled events for the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Boolean] with_user_count Whether to include the user count in the events.
     #   Defaults to `true`.
@@ -191,13 +191,12 @@ module Discorb
 
     #
     # Fetch the scheduled event by ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id The ID of the scheduled event.
     #
-    # @return [Discorb::ScheduledEvent] The event with the given ID.
-    # @return [nil] If no event with the given ID exists.
+    # @return [Async::Task<Discorb::ScheduledEvent>] The event with the given ID.
+    # @return [Async::Task<nil>] If no event with the given ID exists.
     #
     def fetch_scheduled_event(id)
       Async do
@@ -211,6 +210,7 @@ module Discorb
 
     #
     # Create a scheduled event for the guild.
+    # @async
     #
     # @param [:stage_instance, :voice, :external] type The type of event to create.
     # @param [String] name The name of the event.
@@ -221,7 +221,7 @@ module Discorb
     # @param [String, nil] location The location of the event. Defaults to `nil`.
     # @param [:guild_only] privacy_level The privacy level of the event. This must be `:guild_only`.
     #
-    # @return [Discorb::ScheduledEvent] The created event.
+    # @return [Async::Task<Discorb::ScheduledEvent>] The created event.
     #
     def create_scheduled_event(
       type,
@@ -281,8 +281,7 @@ module Discorb
 
     #
     # Fetch emoji list of the guild.
-    # @macro async
-    # @macro http
+    # @async
     # @note This querys the API every time. We recommend using {#emojis} instead.
     #
     # @return [Async::Task<Discorb::Dictionary{Discorb::Snowflake => Discorb::CustomEmoji}>] A dictionary of emoji in the guild.
@@ -305,8 +304,7 @@ module Discorb
 
     #
     # Fetch emoji id of the guild.
-    # @macro async
-    # @macro http
+    # @async
     # @note This querys the API every time. We recommend using {#emojis} instead.
     #
     # @param [#to_s] id The emoji id.
@@ -320,8 +318,7 @@ module Discorb
 
     #
     # Create a custom emoji.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] name The name of the emoji.
     # @param [Discorb::Image] image The image of the emoji.
@@ -343,8 +340,7 @@ module Discorb
 
     #
     # Fetch webhooks of the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Webhook>>] A list of webhooks in the guild.
     #
@@ -357,8 +353,7 @@ module Discorb
 
     #
     # Fetch audit log of the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Discorb::AuditLog>] The audit log of the guild.
     #
@@ -371,8 +366,7 @@ module Discorb
 
     #
     # Fetch channels of the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Channel>>] A list of channels in the guild.
     #
@@ -385,8 +379,7 @@ module Discorb
 
     #
     # Create a new text channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the channel.
     # @param [String] topic The topic of the channel.
@@ -432,8 +425,7 @@ module Discorb
 
     #
     # Create a new voice channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the channel.
     # @param [Integer] bitrate The bitrate of the channel.
@@ -474,8 +466,7 @@ module Discorb
     end
 
     # Create a new category channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the channel.
     # @param [Integer] position The position of the channel.
@@ -512,8 +503,7 @@ module Discorb
 
     #
     # Create a new stage channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the channel.
     # @param [Integer] bitrate The bitrate of the channel.
@@ -550,8 +540,7 @@ module Discorb
 
     #
     # Create a new news channel.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the channel.
     # @param [String] topic The topic of the channel.
@@ -596,8 +585,7 @@ module Discorb
 
     #
     # Fetch a list of active threads in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::ThreadChannel>>] The list of threads.
     #
@@ -610,8 +598,7 @@ module Discorb
 
     #
     # Fetch a member in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id The ID of the member to fetch.
     #
@@ -629,8 +616,7 @@ module Discorb
     end
 
     # Fetch members in the guild.
-    # @macro async
-    # @macro http
+    # @async
     # @macro members_intent
     #
     # @param [Integer] limit The maximum number of members to fetch, 0 for all.
@@ -663,8 +649,7 @@ module Discorb
 
     #
     # Search for members by name in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the member to search for.
     # @param [Integer] limit The maximum number of members to return.
@@ -680,8 +665,7 @@ module Discorb
 
     #
     # Almost the same as {#fetch_members_named}, but returns a single member.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Discorb::Member>] The member.
     # @return [Async::Task<nil>] If the member is not found.
@@ -694,10 +678,13 @@ module Discorb
 
     #
     # Change nickname of client member.
+    # @async
     #
     # @param [String] nickname The nickname to set.
     # @param [String] reason The reason for changing the nickname.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def edit_nickname(nickname, reason: nil)
       Async do
         @client.http.patch("/guilds/#{@id}/members/@me/nick", { nick: nickname }, audit_log_reason: reason).wait
@@ -710,12 +697,13 @@ module Discorb
 
     #
     # Kick a member from the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Member] member The member to kick.
     # @param [String] reason The reason for kicking the member.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def kick_member(member, reason: nil)
       Async do
         @client.http.delete("/guilds/#{@id}/members/#{member.id}", audit_log_reason: reason).wait
@@ -724,8 +712,7 @@ module Discorb
 
     #
     # Fetch a list of bans in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Guild::Ban>>] The list of bans.
     #
@@ -738,8 +725,7 @@ module Discorb
 
     #
     # Fetch a ban in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::User] user The user to fetch.
     #
@@ -758,8 +744,7 @@ module Discorb
 
     #
     # Checks the user was banned from the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::User] user The user to check.
     #
@@ -773,8 +758,7 @@ module Discorb
 
     #
     # Ban a member from the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::Member] member The member to ban.
     # @param [Integer] delete_message_days The number of days to delete messages.
@@ -793,12 +777,13 @@ module Discorb
 
     #
     # Unban a user from the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Discorb::User] user The user to unban.
     # @param [String] reason The reason for unbanning the user.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def unban_user(user, reason: nil)
       Async do
         @client.http.delete("/guilds/#{@id}/bans/#{user.id}", audit_log_reason: reason).wait
@@ -807,8 +792,7 @@ module Discorb
 
     #
     # Fetch a list of roles in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Role>>] The list of roles.
     #
@@ -821,8 +805,7 @@ module Discorb
 
     #
     # Create a role in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] name The name of the role.
     # @param [Discorb::Color] color The color of the role.
@@ -848,8 +831,7 @@ module Discorb
 
     #
     # Fetch how many members will be pruned.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] days The number of days to prune.
     # @param [Array<Discorb::Role>] roles The roles that include for pruning.
@@ -870,8 +852,7 @@ module Discorb
 
     #
     # Prune members from the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Integer] days The number of days to prune.
     # @param [Array<Discorb::Role>] roles The roles that include for pruning.
@@ -890,8 +871,7 @@ module Discorb
 
     #
     # Fetch voice regions that are available in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::VoiceRegion>>] The available voice regions.
     #
@@ -904,8 +884,7 @@ module Discorb
 
     #
     # Fetch invites in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Invite>>] The invites.
     #
@@ -918,8 +897,7 @@ module Discorb
 
     #
     # Fetch integrations in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Integration>>] The integrations.
     #
@@ -932,8 +910,7 @@ module Discorb
 
     #
     # Fetch the widget of the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Discorb::Guild::Widget>] The widget.
     #
@@ -946,8 +923,7 @@ module Discorb
 
     #
     # Fetch the vanity URL of the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Discorb::Guild::VanityInvite>] The vanity URL.
     #
@@ -960,10 +936,9 @@ module Discorb
 
     #
     # Fetch the welcome screen of the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
-    # @return [Async::Task<Discorb::Guild::WelcomeScreen>] The welcome screen.
+    # @return [Async::Task<Discorb::WelcomeScreen>] The welcome screen.
     #
     def fetch_welcome_screen
       Async do
@@ -974,8 +949,7 @@ module Discorb
 
     #
     # Fetch stickers in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Sticker::GuildSticker>>] The stickers.
     #
@@ -988,8 +962,7 @@ module Discorb
 
     #
     # Fetch the sticker by ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id The ID of the sticker.
     #
@@ -1008,8 +981,7 @@ module Discorb
 
     #
     # Fetch templates in the guild.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Discorb::GuildTemplate>] The templates.
     #
@@ -1111,14 +1083,15 @@ module Discorb
 
       #
       # Edit the widget.
-      # @macro async
-      # @macro http
+      # @async
       # @macro edit
       #
       # @param [Boolean] enabled Whether the widget is enabled.
       # @param [Discorb::GuildChannel] channel The channel.
       # @param [String] reason The reason for editing the widget.
       #
+      # @return [Async::Task<void>] The task.
+      #
       def edit(enabled: nil, channel: nil, reason: nil)
         Async do
           payload = {}
@@ -1366,8 +1339,7 @@ module Discorb
 
       #
       # Edits the welcome screen.
-      # @macro async
-      # @macro http
+      # @async
       # @macro edit
       #
       # @param [Boolean] enabled Whether the welcome screen is enabled.
@@ -1375,12 +1347,14 @@ module Discorb
       # @param [String] description The description of the welcome screen.
       # @param [String] reason The reason for editing the welcome screen.
       #
-      def edit(enabled: :unset, channels: :unset, description: :unset, reason: nil)
+      # @return [Async::Task<void>] The task.
+      #
+      def edit(enabled: Discorb::Unset, channels: Discorb::Unset, description: Discorb::Unset, reason: nil)
         Async do
           payload = {}
-          payload[:enabled] = enabled unless enabled == :unset
-          payload[:welcome_channels] = channels.map(&:to_hash) unless channels == :unset
-          payload[:description] = description unless description == :unset
+          payload[:enabled] = enabled unless enabled == Discorb::Unset
+          payload[:welcome_channels] = channels.map(&:to_hash) unless channels == Discorb::Unset
+          payload[:description] = description unless description == Discorb::Unset
           @client.http.patch("/guilds/#{@guild.id}/welcome-screen", payload, audit_log_reason: reason).wait
         end
       end

data/lib/discorb/guild_template.rb

@@ -45,18 +45,19 @@ module Discorb
 
     #
     # Edit the template.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The new name of the template.
     # @param [String] description The new description of the template.
     #
-    def edit(name = nil, description = :unset)
+    # @return [Async::Task<void>] The task.
+    #
+    def edit(name = nil, description = Discorb::Unset)
       Async do
         payload = {}
         payload[:name] = name if name
-        payload[:description] = description if description != :unset
+        payload[:description] = description if description != Discorb::Unset
         @client.http.patch("/guilds/#{@source_guild_id}/templates/#{@code}", payload).wait
       end
     end
@@ -65,8 +66,9 @@ module Discorb
 
     #
     # Update the template.
-    # @macro async
-    # @macro http
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
     #
     def update
       Async do
@@ -77,8 +79,9 @@ module Discorb
 
     #
     # Delete the template.
-    # @macro async
-    # @macro http
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
     #
     def delete!
       Async do
@@ -98,7 +101,7 @@ module Discorb
       attr_reader :afk_timeout
       # @return [Discorb::Dictionary{Discorb::Snowflake => Discorb::Role}] A dictionary of roles in the guild.
       attr_reader :roles
-      # @return [Discorb::Guild::SystemChannelFlag] The flag for the system channel.
+      # @return [Discorb::SystemChannelFlag] The flag for the system channel.
       attr_reader :system_channel_flags
       # @return [Discorb::Dictionary{Discorb::Snowflake => Discorb::GuildChannel}] A dictionary of channels in the guild.
       attr_reader :channels