discorb 0.14.0 → 0.16.0

data/lib/discorb/components/select_menu.rb

@@ -122,22 +122,8 @@ module Discorb
         }
       end
 
-      # @private
-      def hash_emoji(emoji)
-        case emoji
-        when UnicodeEmoji
-          {
-            id: nil,
-            name: emoji.to_s,
-            animated: false,
-          }
-        when CustomEmoji
-          {
-            id: emoji.id,
-            name: emoji.name,
-            animated: emoji.animated?,
-          }
-        end
+      def inspect
+        "#<#{self.class} #{@label}: #{@value}>"
       end
 
       class << self

data/lib/discorb/dictionary.rb

@@ -55,6 +55,8 @@ module Discorb
       @cache.delete(id.to_s)
     end
 
+    alias delete remove
+
     #
     # Get an item from the dictionary.
     #

data/lib/discorb/embed.rb

@@ -45,37 +45,43 @@ module Discorb
     # @param [Discorb::Embed::Thumbnail, String] thumbnail The thumbnail of embed.
     #
     def initialize(title = nil, description = nil, color: nil, url: nil, timestamp: nil, author: nil,
-                                                   fields: nil, footer: nil, image: nil, thumbnail: nil, data: nil)
-      if data.nil?
-        @title = title
-        @description = description
-        @url = url
-        @timestamp = timestamp
-        @color = color
-        @author = author
-        @fields = fields || []
-        @footer = footer
-        @image = image && (image.is_a?(String) ? Image.new(image) : image)
-        @thumbnail = thumbnail && (thumbnail.is_a?(String) ? Thumbnail.new(thumbnail) : thumbnail)
-        @type = "rich"
-      else
-        @title = data[:title]
-        @description = data[:description]
-        @url = data[:url]
-        @timestamp = data[:timestamp] && Time.iso8601(data[:timestamp])
-        @type = data[:type]
-        @color = data[:color] && Color.new(data[:color])
-        @footer = data[:footer] && Footer.new(data[:footer][:text], icon: data[:footer][:icon_url])
-        @author = if data[:author]
-            Author.new(data[:author][:name], icon: data[:author][:icon_url],
-                                             url: data[:author][:url])
-          end
-        @thumbnail = data[:thumbnail] && Thumbnail.new(data[:thumbnail])
-        @image = data[:image] && Image.new(data[:image])
-        @video = data[:video] && Video.new(data[:video])
-        @provider = data[:provider] && Provider.new(data[:provider])
-        @fields = data[:fields] ? data[:fields].map { |f| Field.new(f[:name], f[:value], inline: f[:inline]) } : []
-      end
+                                                   fields: nil, footer: nil, image: nil, thumbnail: nil)
+      @title = title
+      @description = description
+      @url = url
+      @timestamp = timestamp
+      @color = color
+      @author = author
+      @fields = fields || []
+      @footer = footer
+      @image = image && (image.is_a?(String) ? Image.new(image) : image)
+      @thumbnail = thumbnail && (thumbnail.is_a?(String) ? Thumbnail.new(thumbnail) : thumbnail)
+      @type = "rich"
+    end
+
+    #
+    # Initialize embed from hash.
+    # @private
+    #
+    # @param [Hash] data The hash data to initialize embed.
+    #
+    def initialize_hash(data)
+      @title = data[:title]
+      @description = data[:description]
+      @url = data[:url]
+      @timestamp = data[:timestamp] && Time.iso8601(data[:timestamp])
+      @type = data[:type]
+      @color = data[:color] && Color.new(data[:color])
+      @footer = data[:footer] && Footer.new(data[:footer][:text], icon: data[:footer][:icon_url])
+      @author = if data[:author]
+          Author.new(data[:author][:name], icon: data[:author][:icon_url],
+                                           url: data[:author][:url])
+        end
+      @thumbnail = data[:thumbnail] && Thumbnail.new(data[:thumbnail])
+      @image = data[:image] && Image.new(data[:image])
+      @video = data[:video] && Video.new(data[:video])
+      @provider = data[:provider] && Provider.new(data[:provider])
+      @fields = data[:fields] ? data[:fields].map { |f| Field.new(f[:name], f[:value], inline: f[:inline]) } : []
     end
 
     def image=(value)
@@ -111,10 +117,27 @@ module Discorb
       ret
     end
 
+    def self.from_hash(data)
+      inst = allocate
+      inst.initialize_hash(data)
+      inst
+    end
+
+    #
+    # Represents an entry in embed.
+    # @abstract
+    # @private
+    #
+    class Entry
+      def inspect
+        "#<#{self.class}>"
+      end
+    end
+
     #
     # Represents an author of embed.
     #
-    class Author
+    class Author < Entry
       # @return [String] The name of author.
       attr_accessor :name
       # @return [String, nil] The url of author.
@@ -153,7 +176,7 @@ module Discorb
     #
     # Represemts a footer of embed.
     #
-    class Footer
+    class Footer < Entry
       attr_accessor :text, :icon
 
       #
@@ -184,7 +207,7 @@ module Discorb
     #
     # Represents a field of embed.
     #
-    class Field
+    class Field < Entry
       # @return [String] The name of field.
       attr_accessor :name
       # @return [String] The value of field.
@@ -223,7 +246,7 @@ module Discorb
     #
     # Represents an image of embed.
     #
-    class Image
+    class Image < Entry
       # @return [String] The url of image.
       attr_accessor :url
       # @return [String] The proxy url of image.
@@ -267,7 +290,7 @@ module Discorb
     #
     # Represents a thumbnail of embed.
     #
-    class Thumbnail
+    class Thumbnail < Entry
       # @return [String] The url of thumbnail.
       attr_accessor :url
       # @return [String] The proxy url of thumbnail.
@@ -311,7 +334,7 @@ module Discorb
     #
     # Represents a video of embed.
     #
-    class Video
+    class Video < Entry
       # @return [String] The url of video.
       attr_reader :url
       # @return [String] The proxy url of video.
@@ -321,7 +344,12 @@ module Discorb
       # @return [Integer] The width of video.
       attr_reader :width
 
+      #
+      # Initialize a new Video object.
       # @private
+      #
+      # @param [Hash] data The data of video.
+      #
       def initialize(data)
         @url = data[:url]
         @proxy_url = data[:proxy_url]
@@ -333,13 +361,18 @@ module Discorb
     #
     # Represents a provider of embed.
     #
-    class Provider
+    class Provider < Entry
       # @return [String] The name of provider.
       attr_reader :name
       # @return [String] The url of provider.
       attr_reader :url
 
+      #
+      # Initialize a new Provider object.
       # @private
+      #
+      # @param [Hash] data The data of provider.
+      #
       def initialize(data)
         @name = data[:name]
         @url = data[:url]

data/lib/discorb/emoji.rb

@@ -44,7 +44,14 @@ module Discorb
     # @!attribute [r] roles?
     #   @return [Boolean] whether or not this emoji is restricted to certain roles.
 
+    #
+    # Initialize a new custom emoji.
     # @private
+    #
+    # @param [Discorb::Client] client The client that owns this emoji.
+    # @param [Discorb::Guild] guild The guild that owns this emoji.
+    # @param [Hash] data The data of the emoji.
+    #
     def initialize(client, guild, data)
       @client = client
       @guild = guild
@@ -121,7 +128,12 @@ module Discorb
 
     alias destroy! delete!
 
+    #
+    # Converts the object to a hash.
     # @private
+    #
+    # @return [Hash] The hash represents the object.
+    #
     def to_hash
       {
         name: @name,
@@ -135,7 +147,7 @@ module Discorb
     def _set_data(data)
       @id = Snowflake.new(data[:id])
       @name = data[:name]
-      @roles = data[:role] ? data[:role].map { |r| Role.new(@client, r) } : []
+      @roles = data[:role] ? data[:role].map { |r| Role.new(@client, guild, r) } : []
       @user = User.new(@client, data[:user]) if data[:user]
       @require_colons = data[:require_colons]
       @managed = data[:managed]
@@ -158,7 +170,12 @@ module Discorb
     attr_reader :deleted
     alias deleted? deleted
 
+    #
+    # Initialize a new partial custom emoji.
     # @private
+    #
+    # @param [Hash] data The data of the emoji.
+    #
     def initialize(data)
       @id = Snowflake.new(data[:id])
       @name = data[:name]
@@ -200,7 +217,12 @@ module Discorb
     # @return [Integer] The skin tone of the emoji.
     attr_reader :skin_tone
 
-    # @private
+    #
+    # Initialize a new unicode emoji.
+    #
+    # @param [String] name The name of the emoji.
+    # @param [Integer] tone The skin tone of the emoji.
+    #
     def initialize(name, tone: 0)
       if EmojiTable::DISCORD_TO_UNICODE.key?(name)
         @name = name
@@ -232,7 +254,12 @@ module Discorb
       "#<#{self.class} :#{@name}:>"
     end
 
+    #
+    # Converts the object to a hash.
     # @private
+    #
+    # @return [Hash] The hash represents the object.
+    #
     def to_hash
       {
         name: @value,

data/lib/discorb/emoji_table.rb

@@ -3885,7 +3885,7 @@ module Discorb
       "\xf0\x9f\x8f\xbc",
       "\xf0\x9f\x8f\xbd",
       "\xf0\x9f\x8f\xbe",
-      "\xf0\x9f\x8f\xbf"
+      "\xf0\x9f\x8f\xbf",
     ].freeze
   end
 end

data/lib/discorb/error.rb

@@ -42,7 +42,10 @@ module Discorb
     # @return [Net::HTTPResponse] the HTTP response.
     attr_reader :response
 
+    #
+    # Initialize a new instance of the HTTPError class.
     # @private
+    #
     def initialize(resp, data)
       @code = data[:code]
       @response = resp
@@ -54,7 +57,10 @@ module Discorb
   # Represents a 400 error.
   #
   class BadRequestError < HTTPError
+    #
+    # Initialize a new instance of the BadRequestError class.
     # @private
+    #
     def initialize(resp, data)
       @code = data[:code]
       @response = resp
@@ -62,7 +68,7 @@ module Discorb
         [
           data[:message] + " (#{@code})", enumerate_errors(data[:errors])
             .map { |ek, ev| "#{ek}=>#{ev}" }
-            .join("\n")
+            .join("\n"),
         ].join("\n")
       )
     end

data/lib/discorb/event.rb

@@ -4,20 +4,26 @@ module Discorb
   # Represents an event in guild.
   #
   class ScheduledEvent < DiscordModel
-    @privacy_level = {
+    # @private
+    # @return [{Integer => Symbol}] The mapping of privacy level.
+    PRIVACY_LEVEL = {
       2 => :guild_only,
-    }
-    @status = {
+    }.freeze
+    # @private
+    # @return [{Integer => Symbol}] The mapping of status.
+    STATUS = {
       1 => :scheduled,
       2 => :active,
       3 => :completed,
       4 => :canceled,
-    }
-    @entity_type = {
+    }.freeze
+    # @private
+    # @return [{Integer => Symbol}] The mapping of entity_type.
+    ENTITY_TYPE = {
       1 => :stage_instance,
       2 => :voice,
       3 => :external,
-    }
+    }.freeze
 
     # @!visibility private
     def initialize(client, data)
@@ -36,6 +42,10 @@ module Discorb
       def initialize(data)
         @location = data[:location]
       end
+
+      def inspect
+        "#<#{self.class.name} #{@name}>"
+      end
     end
 
     # @return [Discorb::Snowflake] The ID of the event.
@@ -132,10 +142,10 @@ module Discorb
               description: description,
               scheduled_start_time: start_time.iso8601,
               scheduled_end_time: end_time&.iso8601,
-              privacy_level: Discorb::ScheduledEvent.privacy_level.key(privacy_level) || Discorb::Unset,
+              privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level) || Discorb::Unset,
               channel_id: channel&.id,
-              entity_type: Discorb::ScheduledEvent.entity_type.key(:stage_instance),
-              status: Discorb::ScheduledEvent.status.key(status) || Discorb::Unset,
+              entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:stage_instance),
+              status: Discorb::ScheduledEvent::STATUS.key(status) || Discorb::Unset,
             }.reject { |_, v| v == Discorb::Unset }
           when :voice
             raise ArgumentError, "channel must be provided for voice events" unless channel
@@ -144,10 +154,10 @@ module Discorb
               description: description,
               scheduled_start_time: start_time.iso8601,
               scheduled_end_time: end_time&.iso8601,
-              privacy_level: Discorb::ScheduledEvent.privacy_level.key(privacy_level) || Discorb::Unset,
+              privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level) || Discorb::Unset,
               channel_id: channel&.id,
-              entity_type: Discorb::ScheduledEvent.entity_type.key(:voice),
-              status: Discorb::ScheduledEvent.status.key(status) || Discorb::Unset,
+              entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:voice),
+              status: Discorb::ScheduledEvent::STATUS.key(status) || Discorb::Unset,
             }.reject { |_, v| v == Discorb::Unset }
           when :external
             raise ArgumentError, "location must be provided for external events" unless location
@@ -158,12 +168,12 @@ module Discorb
               channel_id: nil,
               scheduled_start_time: start_time.iso8601,
               scheduled_end_time: end_time.iso8601,
-              privacy_level: Discorb::ScheduledEvent.privacy_level.key(privacy_level) || Discorb::Unset,
-              entity_type: Discorb::ScheduledEvent.entity_type.key(:external),
+              privacy_level: Discorb::ScheduledEvent::PRIVACY_LEVEL.key(privacy_level) || Discorb::Unset,
+              entity_type: Discorb::ScheduledEvent::ENTITY_TYPE.key(:external),
               entity_metadata: {
                 location: location,
               },
-              status: Discorb::ScheduledEvent.status.key(status) || Discorb::Unset,
+              status: Discorb::ScheduledEvent::STATUS.key(status) || Discorb::Unset,
             }.reject { |_, v| v == Discorb::Unset }
           else
             raise ArgumentError, "Invalid scheduled event type: #{type}"
@@ -264,8 +274,8 @@ module Discorb
       @scheduled_start_time = Time.iso8601(data[:scheduled_start_time])
       @scheduled_end_time = data[:scheduled_end_time] && Time.iso8601(data[:scheduled_end_time])
       @privacy_level = :guild_only # data[:privacy_level]
-      @status = self.class.status[data[:status]]
-      @entity_type = self.class.entity_type[data[:entity_type]]
+      @status = STATUS[data[:status]]
+      @entity_type = ENTITY_TYPE[data[:entity_type]]
       @entity_id = data[:entity_id] && Snowflake.new(data[:entity_id])
       @entity_metadata = data[:entity_metadata] && Metadata.new(data[:entity_metadata])
       @creator = @client.users[@creator_id] || (data[:creator] && User.new(@client, data[:creator]))

data/lib/discorb/exe/new.rb

@@ -164,8 +164,8 @@ def git_init
   system "git add ."
   system "git commit -m \"Initial commit\""
   sputs "Initialized repository, use " \
-          "\e[32mgit commit --amend -m '...'\e[92m" \
-          " to change commit message of initial commit.\n"
+        "\e[32mgit commit --amend -m '...'\e[92m" \
+        " to change commit message of initial commit.\n"
 end
 
 # @private
@@ -228,9 +228,9 @@ if (dir = ARGV[0])
       iputs "Found \e[30m#{dir}\e[90m and empty, using this directory."
     elsif $values[:force]
       iputs "Found \e[30m#{dir}\e[90m and not empty, but force is on, using this directory."
-      else
-        eputs "Directory \e[31m#{dir}\e[91m already exists and not empty. Use \e[31m-f\e[91m to force."
-        exit
+    else
+      eputs "Directory \e[31m#{dir}\e[91m already exists and not empty. Use \e[31m-f\e[91m to force."
+      exit
     end
   else
     Dir.mkdir($path)

data/lib/discorb/exe/run.rb

@@ -4,10 +4,9 @@ require "optparse"
 require "json"
 require "discorb/utils/colored_puts"
 require "io/console"
+require "discorb"
 
 ARGV.delete_at 0
-# @private
-LOG_LEVELS = %w[none debug info warn error fatal].freeze
 
 opt = OptionParser.new <<~BANNER
                          This command will run a client.
@@ -18,23 +17,10 @@ opt = OptionParser.new <<~BANNER
                        BANNER
 options = {
   title: nil,
-  log_level: nil,
-  log_file: nil,
-  log_color: nil,
   setup: nil,
   token: false,
   bundler: :default,
 }
-opt.on("-l", "--log-level LEVEL", "Log level.") do |v|
-  unless LOG_LEVELS.include? v.downcase
-    eputs "Invalid log level: \e[31m#{v}\e[91m"
-    eputs "Valid log levels: \e[31m#{LOG_LEVELS.join("\e[91m, \e[31m")}\e[91m"
-    exit 1
-  end
-  options[:log_level] = v.downcase
-end
-opt.on("-f", "--log-file FILE", "File to write log to.") { |v| options[:log_file] = v }
-opt.on("-c", "--[no-]log-color", "Whether to colorize log output.") { |v| options[:log_color] = v }
 opt.on("-s", "--setup", "Whether to setup application commands.") { |v| options[:setup] = v }
 opt.on("-e", "--env [ENV]", "The name of the environment variable to use for token, or just `-e` or `--env` for intractive prompt.") { |v| options[:token] = v }
 opt.on("-t", "--title TITLE", "The title of process.") { |v| options[:title] = v }