discorb 0.13.4 → 0.14.0

data/lib/discorb/components.rb

@@ -22,23 +22,12 @@ module Discorb
       def from_hash(data)
         case data[:type]
         when 2
-          Button.new(
-            data[:label],
-            data[:style],
-            emoji: data[:emoji],
-            custom_id: data[:custom_id],
-            url: data[:url],
-            disabled: data[:disabled],
-          )
+          Button
         when 3
-          SelectMenu.new(
-            data[:custom_id],
-            data[:options].map { |o| SelectMenu::Option.from_hash(o) },
-            placeholder: data[:placeholder],
-            min_values: data[:min_values],
-            max_values: data[:max_values],
-          )
-        end
+          SelectMenu
+        when 4
+          TextInput
+        end.from_hash(data)
       end
 
       #
@@ -57,7 +46,7 @@ module Discorb
             tmp_components << tmp_row
             tmp_row = []
             tmp_components << c
-          when SelectMenu
+          when SelectMenu, TextInput
             tmp_components << tmp_row
             tmp_row = []
             tmp_components << [c]
@@ -66,266 +55,12 @@ module Discorb
           end
         end
         tmp_components << tmp_row
-        return tmp_components.filter { |c| c.length.positive? }.map { |c| { type: 1, components: c.map(&:to_hash) } }
-      end
-    end
-  end
-
-  #
-  # Represents a button component.
-  #
-  class Button < Component
-    # @return [String] The label of the button.
-    attr_accessor :label
-    # @return [:primary, :secondary, :success, :danger, :link] The style of the button.
-    attr_accessor :style
-    # @return [Discorb::Emoji] The emoji of the button.
-    attr_accessor :emoji
-    # @return [String] The custom ID of the button.
-    #   Won't be used if the style is `:link`.
-    attr_accessor :custom_id
-    # @return [String] The URL of the button.
-    #   Only used when the style is `:link`.
-    attr_accessor :url
-    # @return [Boolean] Whether the button is disabled.
-    attr_accessor :disabled
-    alias disabled? disabled
-
-    @styles = {
-      primary: 1,
-      secondary: 2,
-      success: 3,
-      danger: 4,
-      link: 5,
-    }.freeze
-
-    #
-    # Initialize a new button.
-    #
-    # @param [String] label The label of the button.
-    # @param [:primary, :secondary, :success, :danger, :link] style The style of the button.
-    # @param [Discorb::Emoji] emoji The emoji of the button.
-    # @param [String] custom_id The custom ID of the button.
-    # @param [String] url The URL of the button.
-    # @param [Boolean] disabled Whether the button is disabled.
-    #
-    def initialize(label, style = :primary, emoji: nil, custom_id: nil, url: nil, disabled: false)
-      @label = label
-      @style = style
-      @emoji = emoji
-      @custom_id = custom_id
-      @url = url
-      @disabled = disabled
-    end
-
-    #
-    # Converts the button to a hash.
-    #
-    # @see https://discord.com/developers/docs/interactions/message-components#button-object-button-structure Official Discord API docs
-    # @return [Hash] A hash representation of the button.
-    #
-    def to_hash
-      if @style == :link
-        {
-          type: 2,
-          label: @label,
-          style: self.class.styles[@style],
-          url: @url,
-          emoji: hash_emoji(@emoji),
-          disabled: @disabled,
-        }
-      else
-        {
-          type: 2,
-          label: @label,
-          style: self.class.styles[@style],
-          custom_id: @custom_id,
-          emoji: hash_emoji(@emoji),
-          disabled: @disabled,
-        }
-      end
-    end
-
-    def inspect
-      "#<#{self.class}: #{@custom_id || @url}>"
-    end
-
-    class << self
-      # @private
-      attr_reader :styles
-    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
-    end
-  end
-
-  #
-  # Represents a select menu component.
-  #
-  class SelectMenu < Component
-    # @return [String] The custom ID of the select menu.
-    attr_accessor :custom_id
-    # @return [Array<SelectMenu::Option>] The options of the select menu.
-    attr_accessor :options
-    # @return [Integer] The minimum number of values.
-    attr_accessor :min_values
-    # @return [Integer] The maximum number of values.
-    attr_accessor :max_values
-    # @return [Boolean] Whether the select menu is disabled.
-    attr_accessor :disabled
-    alias disabled? disabled
-
-    #
-    # Initialize a new select menu.
-    #
-    # @param [String, Symbol] custom_id Custom ID of the select menu.
-    # @param [Array<Discorb::SelectMenu::Option>] options The options of the select menu.
-    # @param [String] placeholder The placeholder of the select menu.
-    # @param [Integer] min_values The minimum number of values.
-    # @param [Integer] max_values The maximum number of values.
-    #
-    def initialize(custom_id, options, placeholder: nil, min_values: 1, max_values: 1)
-      @custom_id = custom_id
-      @options = options
-      @placeholder = placeholder
-      @min_values = min_values
-      @max_values = max_values
-    end
-
-    #
-    # Converts the select menu to a hash.
-    #
-    # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-menu-structure Official Discord API docs
-    # @return [Hash] A hash representation of the select menu.
-    #
-    def to_hash
-      {
-        type: 3,
-        custom_id: @custom_id,
-        options: @options.map(&:to_hash),
-        placeholder: @placeholder,
-        min_values: @min_values,
-        max_values: @max_values,
-        disabled: @disabled,
-      }
-    end
-
-    def inspect
-      "#<#{self.class}: #{@custom_id}>"
-    end
-
-    #
-    # Represents an option of a select menu.
-    #
-    class Option
-      # @return [String] The label of the option.
-      attr_accessor :label
-      # @return [String] The value of the option.
-      attr_accessor :value
-      # @return [String] The description of the option.
-      attr_accessor :description
-      # @return [Discorb::Emoji] The emoji of the option.
-      attr_accessor :emoji
-      # @return [Boolean] Whether the option is default.
-      attr_accessor :default
-
-      #
-      # Initialize a new option.
-      #
-      # @param [String] label The label of the option.
-      # @param [String] value The value of the option.
-      # @param [String] description The description of the option.
-      # @param [Discorb::Emoji] emoji The emoji of the option.
-      # @param [Boolean] default Whether the option is default.
-      def initialize(label, value, description: nil, emoji: nil, default: false)
-        @label = label
-        @value = value
-        @description = description
-        @emoji = emoji
-        @default = default
-      end
-
-      #
-      # Converts the option to a hash.
-      #
-      # @see https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-option-structure Official Discord API docs
-      # @return [Hash] Hash representation of the option.
-      #
-      def to_hash
-        {
-          label: @label,
-          value: @value,
-          description: @description,
-          emoji: hash_emoji(@emoji),
-          default: @default,
-        }
-      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
-      end
-
-      class << self
-        #
-        # Creates a new option from a hash.
-        #
-        # @param [Hash] data A hash representing the option.
-        #
-        # @return [Discorb::SelectMenu::Option] A new option.
-        #
-        def from_hash(data)
-          new(data[:label], data[:value], description: data[:description], emoji: data[:emoji], default: data[:default])
-        end
-      end
-    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?,
-        }
+        tmp_components.filter { |c| c.length.positive? }.map { |c| { type: 1, components: c.map(&:to_hash) } }
       end
     end
   end
 end
+
+%w[button text_input select_menu].each do |name|
+  require_relative "components/#{name}"
+end

data/lib/discorb/dictionary.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module Discorb
+  #
+  # Extended hash class. This is used for storing pair of ID and object.
+  #
   class Dictionary
     # @return [Integer] The maximum number of items in the dictionary.
     attr_accessor :limit

data/lib/discorb/embed.rb

@@ -79,11 +79,11 @@ module Discorb
     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

data/lib/discorb/emoji.rb

@@ -121,6 +121,15 @@ module Discorb
 
     alias destroy! delete!
 
+    # @private
+    def to_hash
+      {
+        name: @name,
+        id: @id,
+        animated: @animated,
+      }
+    end
+
     private
 
     def _set_data(data)
@@ -202,9 +211,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 +232,15 @@ module Discorb
       "#<#{self.class} :#{@name}:>"
     end
 
+    # @private
+    def to_hash
+      {
+        name: @value,
+        id: nil,
+        animated: false,
+      }
+    end
+
     class << self
       alias [] new
     end

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

@@ -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
 
@@ -64,7 +62,7 @@ module Discorb
         [
           data[:message] + " (#{@code})", enumerate_errors(data[:errors])
             .map { |ek, ev| "#{ek}=>#{ev}" }
-            .join("\n"),
+            .join("\n")
         ].join("\n")
       )
     end
@@ -92,14 +90,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,4 +1,8 @@
+# frozen_string_literal: true
 module Discorb
+  #
+  # Represents an event in guild.
+  #
   class ScheduledEvent < DiscordModel
     @privacy_level = {
       2 => :guild_only,
@@ -120,7 +124,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
             {
@@ -226,11 +230,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 +240,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

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