discorb 0.12.2 → 0.13.1

data/lib/discorb/client.rb

@@ -105,17 +105,17 @@ module Discorb
 
     #
     # Registers an event handler.
-    # @see file:docs/Events.md
+    # @see file:docs/Events.md Events Documentation
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol] id Custom ID of the event.
     # @param [Hash] metadata The metadata of the event.
     # @param [Proc] block The block to execute when the event is triggered.
     #
-    # @return [Discorb::Event] The event.
+    # @return [Discorb::EventHandler] The event.
     #
     def on(event_name, id: nil, **metadata, &block)
-      ne = Event.new(block, id, metadata)
+      ne = EventHandler.new(block, id, metadata)
       @events[event_name] ||= []
       @events[event_name].delete_if { |e| e.metadata[:override] }
       @events[event_name] << ne
@@ -127,7 +127,7 @@ module Discorb
     #
     # @param (see #on)
     #
-    # @return [Discorb::Event] The event.
+    # @return [Discorb::EventHandler] The event.
     #
     def once(event_name, id: nil, **metadata, &block)
       metadata[:once] = true
@@ -146,10 +146,13 @@ module Discorb
 
     #
     # Dispatch an event.
+    # @async
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Object] args The arguments to pass to the event.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def dispatch(event_name, *args)
       Async do
         if (conditions = @conditions[event_name])
@@ -184,7 +187,7 @@ module Discorb
         events.each do |block|
           Async do
             Async(annotation: "Discorb event: #{event_name}") do |task|
-              if block.is_a?(Discorb::Event)
+              if block.is_a?(Discorb::EventHandler)
                 @events[event_name].delete(block) if block.metadata[:once]
               end
               block.call(*args)
@@ -199,8 +202,7 @@ module Discorb
 
     #
     # Fetch user from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id <description>
     #
@@ -217,8 +219,7 @@ module Discorb
 
     #
     # Fetch channel from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id The ID of the channel.
     #
@@ -235,8 +236,7 @@ module Discorb
 
     #
     # Fetch guild from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id <description>
     #
@@ -253,8 +253,7 @@ module Discorb
 
     #
     # Fetch invite from code.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] code The code of the invite.
     # @param [Boolean] with_count Whether to include the count of the invite.
@@ -272,8 +271,7 @@ module Discorb
     #
     # Fetch webhook from ID.
     # If application was cached, it will be used.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Boolean] force Whether to force the fetch.
     #
@@ -291,8 +289,7 @@ module Discorb
 
     #
     # Fetch nitro sticker pack from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Sticker::Pack>>] The packs.
     #
@@ -334,12 +331,13 @@ module Discorb
 
     #
     # Method to wait for a event.
+    # @async
     #
     # @param [Symbol] event The name of the event.
     # @param [Integer] timeout The timeout in seconds.
     # @param [Proc] check The check to use.
     #
-    # @return [Object] The result of the event.
+    # @return [Async::Task<Object>] The result of the event.
     #
     # @raise [Discorb::TimeoutError] If the event didn't occur in time.
     #
@@ -416,7 +414,7 @@ module Discorb
     #
     # Starts the client.
     # @note This method behavior will change by CLI.
-    # @see file:docs/cli.md
+    # @see file:docs/cli.md CLI documentation
     #
     # @param [String, nil] token The token to use.
     #

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.12.2"
+  VERSION = "0.13.1"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
 
@@ -110,6 +110,33 @@ module Discorb
       @value & 0xFFF
     end
 
+    def inspect
+      "#<#{self.class} #{to_s}>"
+    end
+
     alias id to_s
   end
+
+  # @return [Object] Object that represents nil.
+  #   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

data/lib/discorb/components.rb

@@ -6,6 +6,10 @@ module Discorb
   # Represents a Discord component.
   #
   class Component
+    def inspect
+      "#<#{self.class}>"
+    end
+
     class << self
       #
       # Create a new component from hash data.
@@ -142,6 +146,10 @@ module Discorb
       end
     end
 
+    def inspect
+      "#<#{self.class}: #{@custom_id || @url}>"
+    end
+
     class << self
       # @private
       attr_reader :styles
@@ -218,6 +226,10 @@ module Discorb
       }
     end
 
+    def inspect
+      "#<#{self.class}: #{@custom_id}>"
+    end
+
     #
     # Represents an option of a select menu.
     #

data/lib/discorb/dictionary.rb

@@ -48,7 +48,7 @@ module Discorb
     # @param [#to_s] id The ID of the item to remove.
     #
     def remove(id)
-      @cache.remove(id.to_s)
+      @cache.delete(id.to_s)
     end
 
     #

data/lib/discorb/embed.rb

@@ -86,6 +86,10 @@ module Discorb
       @thumbnail = (value.is_a?(String)) ? Thumbnail.new(value) : value
     end
 
+    def inspect
+      "#<#{self.class} \"#{@title}\">"
+    end
+
     #
     # Convert embed to hash.
     #

data/lib/discorb/emoji.rb

@@ -13,6 +13,10 @@ module Discorb
     def ==(other)
       eql?(other)
     end
+
+    def inspect
+      "#<#{self.class}>"
+    end
   end
 
   # Represents a custom emoji in discord.
@@ -78,8 +82,7 @@ module Discorb
 
     #
     # Edit the emoji.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The new name of the emoji.
@@ -88,11 +91,11 @@ module Discorb
     #
     # @return [Async::Task<self>] The edited emoji.
     #
-    def edit(name: :unset, roles: :unset, reason: nil)
+    def edit(name: Discorb::Unset, roles: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:roles] = roles.map { |r| Discorb::Utils.try(r, :id) } if roles != :unset
+        payload[:name] = name if name != Discorb::Unset
+        payload[:roles] = roles.map { |r| Discorb::Utils.try(r, :id) } if roles != Discorb::Unset
         @client.http.patch("/guilds/#{@guild.id}/emojis/#{@id}", payload, audit_log_reason: reason)
         self
       end
@@ -102,8 +105,7 @@ module Discorb
 
     #
     # Delete the emoji.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] reason The reason for deleting the emoji.
     #