discorb 0.13.4 → 0.15.1

data/lib/discorb/embed.rb

@@ -45,45 +45,51 @@ 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)
-      @image = (value.is_a?(String)) ? Image.new(value) : value
+      @image = value.is_a?(String) ? Image.new(value) : value
     end
 
     def thumbnail=(value)
-      @thumbnail = (value.is_a?(String)) ? Thumbnail.new(value) : value
+      @thumbnail = value.is_a?(String) ? Thumbnail.new(value) : value
     end
 
     def inspect
@@ -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,12 +128,26 @@ module Discorb
 
     alias destroy! delete!
 
+    #
+    # Converts the object to a hash.
+    # @private
+    #
+    # @return [Hash] The hash represents the object.
+    #
+    def to_hash
+      {
+        name: @name,
+        id: @id,
+        animated: @animated,
+      }
+    end
+
     private
 
     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]
@@ -149,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]
@@ -191,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
@@ -202,9 +233,7 @@ module Discorb
       else
         raise ArgumentError, "No such emoji: #{name}"
       end
-      if tone > 0
-        @value += EmojiTable::SKIN_TONES[tone]
-      end
+      @value += EmojiTable::SKIN_TONES[tone] if tone.positive?
     end
 
     # @return [String] The unicode string of the emoji.
@@ -225,6 +254,20 @@ 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,
+        id: nil,
+        animated: false,
+      }
+    end
+
     class << self
       alias [] new
     end

data/lib/discorb/error.rb

@@ -11,9 +11,7 @@ module Discorb
     def enumerate_errors(hash)
       res = {}
       _recr_items([], hash, res)
-      if res == { "" => nil }
-        res = {}
-      end
+      res = {} if res == { "" => nil }
       res
     end
 
@@ -44,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
@@ -56,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
@@ -92,14 +96,14 @@ module Discorb
   # Represents a error because of a cloudflare ban.
   #
   class CloudFlareBanError < HTTPError
-    def initialize(resp, client)
+    def initialize(_resp, client)
       @client = client
       @client.close!
       message = <<~MESSAGE
         The client is banned from CloudFlare.
         Hint: Try to decrease the number of requests per second, e.g. Use sleep in between requests.
       MESSAGE
-      $stderr.puts message
+      warn message
       DiscorbError.instance_method(:initialize).bind(self).call(message)
     end
   end

data/lib/discorb/event.rb

@@ -1,19 +1,29 @@
+# frozen_string_literal: true
 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)
@@ -32,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.
@@ -120,7 +134,7 @@ module Discorb
       status: Discorb::Unset
     )
       Async do
-        payload = case (type == Discorb::Unset) ? @entity_type : type
+        payload = case type == Discorb::Unset ? @entity_type : type
           when :stage_instance
             raise ArgumentError, "channel must be provided for stage_instance events" unless channel
             {
@@ -128,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
@@ -140,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
@@ -154,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}"
@@ -226,11 +240,9 @@ module Discorb
         if limit.nil?
           after = 0
           res = []
-          while true
+          loop do
             _resp, users = @client.http.request(Route.new("/guilds/#{@guild_id}/scheduled-events/#{@id}/users?limit=100&after=#{after}&with_member=true", "//guilds/:guild_id/scheduled-events/:scheduled_event_id/users", :get)).wait
-            if users.empty?
-              break
-            end
+            break if users.empty?
             res += users.map { |u| Member.new(@client, @guild_id, u[:user], u[:member]) }
             after = users.last[:user][:id]
           end
@@ -238,8 +250,8 @@ module Discorb
         else
           params = {
             limit: limit,
-            before: Discorb::Utils.try(after, :id),
-            after: Discorb::Utils.try(around, :id),
+            before: Discorb::Utils.try(before, :id),
+            after: Discorb::Utils.try(after, :id),
             with_member: with_member,
           }.filter { |_k, v| !v.nil? }.to_h
           _resp, messages = @client.http.request(Route.new("/channels/#{channel_id.wait}/messages?#{URI.encode_www_form(params)}", "//channels/:channel_id/messages", :get)).wait
@@ -262,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/about.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # description: Show information of discorb.
 
 puts "  disco\e[31mrb\e[m -  A new Discord API wrapper in Ruby.  \n\n"

data/lib/discorb/exe/irb.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # description: Connect to discord and start IRB.
 
@@ -31,13 +32,13 @@ client.on :standby do
   end
 
   def dirb_help
-    puts <<~EOS
+    puts <<~MESSAGE
            \e[96mDiscord-IRB\e[m
            This is a debug client for Discord.
            \e[90mmessage\e[m to get latest message.
 
            \e[36mhttps://discorb-lib.github.io/#{Discorb::VERSION}/file.irb.html\e[m for more information.
-         EOS
+         MESSAGE
   end
 
   puts <<~FIRST_MESSAGE
@@ -56,7 +57,7 @@ end
 
 token = ENV["DISCORD_BOT_TOKEN"] || ENV["DISCORD_TOKEN"]
 if token.nil?
-  if File.exists?(token_file)
+  if File.exist?(token_file)
     token = File.read(token_file)
   else
     print "\e[90mToken?\e[m : "

data/lib/discorb/exe/new.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # description: Make files for the discorb project.
 
 require "optparse"
@@ -131,7 +132,7 @@ FILES = {
       https://rubygems.org/gems/license-cli may be useful.
 
   MARKDOWN
-}
+}.freeze
 
 # @private
 def create_file(name)
@@ -162,8 +163,8 @@ def git_init
   system "git init"
   system "git add ."
   system "git commit -m \"Initial commit\""
-  sputs "Initialized repository, use " +
-          "\e[32mgit commit --amend -m '...'\e[92m" +
+  sputs "Initialized repository, use " \
+          "\e[32mgit commit --amend -m '...'\e[92m" \
           " to change commit message of initial commit.\n"
 end
 
@@ -225,13 +226,11 @@ if (dir = ARGV[0])
   if Dir.exist?($path)
     if Dir.empty?($path)
       iputs "Found \e[30m#{dir}\e[90m and empty, using this directory."
-    else
-      if $values[:force]
-        iputs "Found \e[30m#{dir}\e[90m and not empty, but force is on, 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
-      end
     end
   else
     Dir.mkdir($path)

data/lib/discorb/exe/run.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # description: Run a client.
 require "optparse"
 require "json"
@@ -6,7 +7,7 @@ require "io/console"
 
 ARGV.delete_at 0
 # @private
-LOG_LEVELS = %w[none debug info warn error fatal]
+LOG_LEVELS = %w[none debug info warn error fatal].freeze
 
 opt = OptionParser.new <<~BANNER
                          This command will run a client.

data/lib/discorb/exe/setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # description: Setup application commands.
 require "optparse"
 require "discorb/utils/colored_puts"
@@ -6,6 +7,7 @@ ARGV.delete_at 0
 
 options = {
   guilds: nil,
+  script: true,
 }
 
 opt = OptionParser.new <<~BANNER
@@ -16,20 +18,21 @@ opt = OptionParser.new <<~BANNER
                                    script                     The script to setup.
                        BANNER
 opt.on("-g", "--guild ID", Array, "The guild ID to setup, use comma for setup commands in multiple guilds, or `global` for setup global commands.") { |v| options[:guilds] = v }
+opt.on("-s", "--[no-]script", "Whether to run `:setup` event. This may be useful if setup script includes operation that shouldn't run twice. Default to true.") { |v| options[:script] = v }
 opt.parse!(ARGV)
 
 script = ARGV[0]
 script ||= "main.rb"
 ENV["DISCORB_CLI_FLAG"] = "setup"
 
-if options[:guilds] == ["global"]
-  ENV["DISCORB_SETUP_GUILDS"] = "global"
+ENV["DISCORB_SETUP_GUILDS"] = if options[:guilds] == ["global"]
+  "global"
 elsif options[:guilds]
-  ENV["DISCORB_SETUP_GUILDS"] = options[:guilds].join(",")
-else
-  ENV["DISCORB_SETUP_GUILDS"] = nil
+  options[:guilds].join(",")
 end
 
+ENV["DISCORB_SETUP_SCRIPT"] = options[:script].to_s if options[:script]
+
 begin
   load script
 rescue LoadError

data/lib/discorb/exe/show.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # description: Show information of your environment.
 
 require "etc"

data/lib/discorb/extend.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop: disable Style/Documentation
 
 class Time
   #
@@ -18,22 +19,26 @@ class Time
 end
 
 # @private
-class Async::Node
-  def description
-    @object_name ||= "#{self.class}:0x#{object_id.to_s(16)}#{@transient ? " transient" : nil}"
+module Async
+  class Node
+    def description
+      @object_name ||= "#{self.class}:0x#{object_id.to_s(16)}#{@transient ? " transient" : nil}"
 
-    if @annotation
-      "#{@object_name} #{@annotation}"
-    elsif line = self.backtrace(0, 1)&.first
-      "#{@object_name} #{line}"
-    else
-      @object_name
+      if @annotation
+        "#{@object_name} #{@annotation}"
+      elsif line = self.backtrace(0, 1)&.first
+        "#{@object_name} #{line}"
+      else
+        @object_name
+      end
     end
-  end
 
-  def to_s
-    "\#<#{self.description}>"
-  end
+    def to_s
+      "\#<#{self.description}>"
+    end
 
-  alias inspect to_s
+    alias inspect to_s
+  end
 end
+
+# rubocop: enable Style/Documentation

data/lib/discorb/extension.rb

@@ -17,7 +17,7 @@ module Discorb
       ret = {}
       self.class.events.each do |event, handlers|
         ret[event] = handlers.map do |handler|
-          Discorb::EventHandler.new(Proc.new { |*args, **kwargs| instance_exec(*args, **kwargs, &handler[2]) }, handler[0], handler[1])
+          Discorb::EventHandler.new(proc { |*args, **kwargs| instance_exec(*args, **kwargs, &handler[2]) }, handler[0], handler[1])
         end
       end
       @events = ret
@@ -27,6 +27,10 @@ module Discorb
       base.extend(ClassMethods)
     end
 
+    #
+    # @private
+    # Module for adding class methods to the extension class.
+    #
     module ClassMethods
       include Discorb::ApplicationCommand::Handler
       undef setup_commands