discorb 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 810e9b14c77e49e9fca7afc4fe6b98389b26cb17dc1617213f38d7655b990a49
-  data.tar.gz: bbaa999265ac212f90ab60d57ec772fe7ade0e47f264a136130c679b85a46952
+  metadata.gz: 6537aa3c45f64e6b0e8040a5a0d989934fb58d766ee6de305bf04132630a7b94
+  data.tar.gz: 68512bc0d2abd0738cc6e81ba2b794feb87480d6d84197a51a6deba739d31d5a
 SHA512:
-  metadata.gz: 120828736edcf7eef9d78410914651edeb41ae85eadef012050b105b03c80f07f835d812105d3cfe954c7237e344b3bbc540af8840a7dde1a69f590b008a759e
-  data.tar.gz: f29b0399c65f180b05bf6c0c3d5f253689ff08c734f60ee7681b57c060d99e36dd85fc275f9652354933478b8139aa76c8ad854f6963fd1c074a8a260ffb6bde
+  metadata.gz: 239e4658a2ade0ea8382655970a1eecbb3c62c7c3619e3de8fdf932c1c0a4053e35b722bef5dcdbd67477754388cc3c157c9be6360ef7625fe9f84504b5ecf90
+  data.tar.gz: d830a06c7a505ee31aeb3242e7aa59dadf6abab24a26c357b9e29e5f94d5fef7a889b114d4b7793ffda3f50b19a6be0c3f87921934393b03e71c5f50bfa96de4

data/.github/workflows/build_version.yml

@@ -33,7 +33,7 @@ jobs:
           git clone git@github.com:discorb-lib/discorb-lib.github.io /tmp/pages
       - name: Install dependencies
         run: |
-          bundle config --local with 'docs development'
+          bundle config --local with 'docs development lint'
           bundle install
           gem update uri
       - name: Generate document

data/.github/workflows/lint-push.yml

@@ -1,6 +1,8 @@
 name: Lint with RuboCop
 on:
-  - push
+  push:
+    branches:
+      - main
 jobs:
   rubocop:
     runs-on: ubuntu-latest
@@ -15,4 +17,4 @@ jobs:
           gem install rubocop
       - name: Run rubocop
         run: |
-          rubocop lib
+          rubocop lib

data/.rubocop.yml

@@ -10,10 +10,14 @@ Metrics:
   Enabled: false
 
 Style/TrailingCommaInHashLiteral:  # Disabled for rufo
-  Enabled: false
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:  # Disabled for rufo
+  EnforcedStyleForMultiline: consistent_comma
 
 Style/StringLiterals:  # Disabled for rufo
-  Enabled: false
+  Enabled: true
+  EnforcedStyle: double_quotes
 
 Style/TrailingCommaInArguments:  # Disabled for rufo
   Enabled: false

data/Changelog.md

@@ -4,6 +4,33 @@
 
 # Changelog
 
+## v0.16
+
+### v0.16.0
+
+- Change!: Use built-in Logger instead of custom Logger.
+- Delete!: `--log-level`, `--[no-]log-color` is deleted.
+- Add: Support sharding
+- Add: Use Mutex for preventing connection duplications.
+
+## v0.15
+
+### v0.15.1
+
+- Add: Add `Member#can_manage?`
+- Add: Add `Discorb::VERSION_ARRAY`
+- Fix: `Snowflake#timestamp` includes milliseconds now
+- Fix: `TextChannel#create_invite` will no longer return `ArgumentError`
+- Fix: Connection will not closed with 4001 when `Client#update_presence`
+  is called
+
+### v0.15.0
+
+- Add: Migrate to API v10
+- Add: Add `TextChannel#threads`
+- Add: Support editing attachments
+- Delete!: Delete File class - Use Attachment class instead
+
 ## v0.14
 
 ### v0.14.0

data/Rakefile

@@ -320,6 +320,12 @@ end
 
 task document: %i[document:yard document:replace]
 
+desc "Lint code with rubocop"
 task :lint do
   sh "rubocop lib"
 end
+
+desc "Autofix code with rubocop"
+task "lint:fix" do
+  sh "rubocop lib -A"
+end

data/docs/events.md

@@ -30,13 +30,13 @@ class << client
 end
 ```
 
-If you want to seperate event handlers from the client, consider using {Discorb::Extension}. {file:docs/extension.md Learn more about extensions}.
+If you want to separate event handlers from the client, consider using {Discorb::Extension}. {file:docs/extension.md Learn more about extensions}.
 
-Since v0.6.1, you can set `:override` to `true` to register overridable event handlers.
+Since v0.6.1, you can set `:override` to `true` to register event handlers that can be overridden.
 
 ```ruby
 client.on :message, override: true do |event|
-  puts "This event handler is overrideable!"
+  puts "This event handler can be overridden."
 end
 
 client.on :message do |event|
@@ -44,8 +44,8 @@ client.on :message do |event|
 end
 ```
 
-This example will print `Override!`, but not `This event handler is overrideable!`.
-This is useful for registering event handlers as default behaviour, such as error handlers.
+This example will print `Override!`, but not `This event handler can be overridden.`.
+This is useful for registering event handlers as default behavior, such as error handlers.
 
 ```ruby
 # In the library...
@@ -95,6 +95,22 @@ Defaults to printing the error to stderr, override to handle it yourself.
 Fires when `discorb setup` is run.
 This is useful for setting up some dependencies, such as the database.
 
+#### `shard_standby(shard)`
+
+Fires when a shard is standby.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`shard`     | {Discorb::Shard} | The shard that is standby. |
+
+#### `shard_resumed(shard)`
+
+Fires when a shard is resumed connection.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`shard`     | {Discorb::Shard} | The shard that is standby. |
+
 ### Guild events
 
 #### `guild_join(guild)`
@@ -487,6 +503,46 @@ Fires when an invitation is deleted.
 
 ### Interaction events
 
+#### `interaction_create(interaction)`
+
+Fires when an interaction is created. This will fire for all interactions.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::Interaction}| The created interaction. |
+
+#### `application_command(interaction)`
+
+Fires when an application command is used.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::CommandInteraction}| The created interaction. |
+
+#### `slash_command(interaction)`
+
+Fires when a slash command is used.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::CommandInteraction::SlashCommand}| The created interaction. |
+
+#### `message_command(interaction)`
+
+Fires when a message command is used.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::CommandInteraction::MessageMenuCommand}| The created interaction. |
+
+#### `user_command(interaction)`
+
+Fires when a user command is used.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::CommandInteraction::UserMenuCommand}| The created interaction. |
+
 #### `button_click(interaction)`
 
 Fires when a button is clicked.
@@ -503,6 +559,16 @@ Fires when a select menu is selected.
 | ---------- | ----- | ----------- |
 |`interaction`| {Discorb::MessageComponentInteraction::SelectMenu}| The interaction object. |
 
+#### `form_submit(interaction)`
+
+Fires when a form is submitted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+| `interaction` | {Discorb::ModalInteraction} | The interaction object. |
+
+#### `slash_command
+
 ### Voice events
 
 Because it's big, it's documented in {file:docs/voice_events.md}.

data/docs/faq.md

@@ -62,19 +62,19 @@ client.on :ready do
 end
 ```
 
-### How can I send files?
+### How can I send attachments?
 
-Use {Discorb::File} class.
+Use {Discorb::Attachment} class.
 
 ```ruby
-# Send a file
-message.channel.post file: Discorb::File.new(File.open("./README.md"))
+# Send an attachment
+message.channel.post attachment: Discorb::Attachment.new(File.open("./README.md"))
 
-# Send some files with text
-message.channel.post "File!", files: [Discorb::File.new(File.open("./README.md")), Discorb::File.new(File.open("./License.txt"))]
+# Send some attachment with text
+message.channel.post "File!", attachments: [Discorb::Attachment.new("./README.md"), Discorb::Attachment.new(File.open("./License.txt"))]
 
-# Send a string as a file
-message.channel.post file: Discorb::File.from_string("Hello world!", "hello.txt")
+# Send a string as an attachment
+message.channel.post attachments: Discorb::Attachment.from_string("Hello world!", "hello.txt")
 ```
 
 ### How can I add reactions?

data/examples/simple/rolepanel.rb

@@ -2,7 +2,7 @@
 require "discorb"
 intents = Discorb::Intents.new
 intents.members = true
-client = Discorb::Client.new(intents: intents, log: $stdout, colorize_log: true)
+client = Discorb::Client.new(intents: intents)
 
 def convert_role(guild, string)
   guild.roles.find do |role|

data/examples/simple/shard.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require "discorb"
+
+client = Discorb::Client.new(log: Logger.new($stdout))
+
+client.once :standby do
+  puts "Logged in as #{client.user}"
+end
+
+client.on :message do |message|
+  next if message.author.bot?
+  next unless message.content == "!inspect"
+
+  message.channel.post("I'm #{client.user}, running on shard #{client.shard_id}!")
+end
+
+client.run(ENV["DISCORD_BOT_TOKEN"], shards: [0, 1], shard_count: 2)

data/lib/discorb/allowed_mentions.rb

@@ -32,7 +32,14 @@ module Discorb
       "#<#{self.class} @everyone=#{@everyone} @roles=#{@roles} @users=#{@users} @replied_user=#{@replied_user}>"
     end
 
+    #
+    # Converts the object to a hash.
     # @private
+    #
+    # @param [Discorb::AllowedMentions, nil] other The object to merge.
+    #
+    # @return [Hash] The hash.
+    #
     def to_hash(other = nil)
       payload = {
         parse: %w[everyone roles users],

data/lib/discorb/app_command/command.rb

@@ -23,24 +23,39 @@ module Discorb
       # @return [Discorb::Dictionary{Discorb::Snowflake, :global => Discorb::Snowflake}] The ID mapping.
       attr_reader :id_map
 
-      @types = {
+      # @private
+      # @return [{Integer => Symbol}] The mapping of raw types to types.
+      TYPES = {
         1 => :chat_input,
         2 => :user,
         3 => :message,
       }.freeze
 
+      #
+      # Initialize a new command.
       # @private
+      #
+      # @param [String] name The name of the command.
+      # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+      # @param [Proc] block The block of the command.
+      # @param [:chat_input, :user, :message] type The type of the command.
+      #
       def initialize(name, guild_ids, block, type)
         @name = name
         @guild_ids = guild_ids&.map(&:to_s)
         @block = block
         @raw_type = type
-        @type = Discorb::ApplicationCommand::Command.types[type]
+        @type = Discorb::ApplicationCommand::Command::TYPES[type]
         @type_raw = type
         @id_map = Discorb::Dictionary.new
       end
 
+      #
+      # Changes the self pointer to the given object.
       # @private
+      #
+      # @param [Object] instance The object to change the self pointer to.
+      #
       def replace_block(instance)
         current_block = @block.dup
         @block = proc do |*args|
@@ -48,7 +63,12 @@ module Discorb
         end
       end
 
+      #
+      # Converts the object to a hash.
       # @private
+      #
+      # @return [Hash] The hash represents the object.
+      #
       def to_hash
         {
           name: @name,
@@ -66,7 +86,18 @@ module Discorb
         # @return [Hash{String => Hash}] The options of the command.
         attr_reader :options
 
+        #
+        # Initialize a new slash command.
         # @private
+        #
+        # @param [String] name The name of the command.
+        # @param [String] description The description of the command.
+        # @param [Hash{String => Hash}] options The options of the command.
+        # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+        # @param [Proc] block The block of the command.
+        # @param [:chat_input, :user, :message] type The type of the command.
+        # @param [Discorb::ApplicationCommand::Command, nil] parent The parent command.
+        #
         def initialize(name, description, options, guild_ids, block, type, parent)
           super(name, guild_ids, block, type)
           @description = description
@@ -85,7 +116,12 @@ module Discorb
           (@parent + " " + @name).strip
         end
 
+        #
+        # Converts the object to a hash.
         # @private
+        #
+        # @return [Hash] The hash represents the object.
+        #
         def to_hash
           options_payload = options.map do |name, value|
             ret = {
@@ -145,7 +181,16 @@ module Discorb
         # @return [String] The description of the command.
         attr_reader :description
 
+        #
+        # Initialize a new group command.
         # @private
+        #
+        # @param [String] name The name of the command.
+        # @param [String] description The description of the command.
+        # @param [Array<#to_s>] guild_ids The guild ids that the command is enabled in.
+        # @param [:chat_input, :user, :message] type The type of the command.
+        # @param [Discorb::Client] client The client of the command.
+        #
         def initialize(name, description, guild_ids, type, client)
           super(name, guild_ids, block, type)
           @description = description
@@ -196,13 +241,23 @@ module Discorb
           @name
         end
 
+        #
+        # Changes the self pointer to the given object.
         # @private
+        #
+        # @param [Object] instance The object to change to.
+        #
         def block_replace(instance)
           super
           @commands.each { |c| c.replace_block(instance) }
         end
 
+        #
+        # Converts the object to a hash.
         # @private
+        #
+        # @return [Hash] The hash represents the object.
+        #
         def to_hash
           options_payload = @commands.map do |command|
             if command.is_a?(SlashCommand)
@@ -240,7 +295,14 @@ module Discorb
         # @return [Array<Discorb::ApplicationCommand::Command::SlashCommand>] The subcommands of the command.
         attr_reader :commands
 
+        #
+        # Initialize a new subcommand group.
         # @private
+        #
+        # @param [String] name The name of the command.
+        # @param [String] description The description of the command.
+        # @param [Discorb::ApplicationCommand::Command::GroupCommand] parent The parent command.
+        # @param [Discorb::Client] client The client.
         def initialize(name, description, parent, client)
           super(name, description, [], 1, client)
 

data/lib/discorb/app_command/handler.rb

@@ -160,7 +160,7 @@ module Discorb
               end
             end
           end
-          @log.info "Successfully setup commands"
+          @logger.info "Successfully setup commands"
         end
       end
     end

data/lib/discorb/application.rb

@@ -29,7 +29,13 @@ module Discorb
     alias bot_require_code_grant? bot_require_code_grant
     # @return [Discorb::Application::Flag] The application's flags.
     attr_reader :flags
+    #
+    # Initializes a new instance of the Application class.
     # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    #
     def initialize(client, data)
       @client = client
       @data = data
@@ -97,7 +103,13 @@ module Discorb
       # @return [Discorb::Application::Team::Member] The team's member.
       attr_reader :members
 
+      #
+      # Initializes a new instance of the Team class.
       # @private
+      #
+      # @param [Discorb::Client] client The client that instantiated the object.
+      # @param [Hash] data The data of the object.
+      #
       def initialize(client, data)
         @client = client
         @id = Snowflake.new(data[:id])
@@ -142,7 +154,9 @@ module Discorb
         # @!attribute [r] owner?
         #   @return [Boolean] Whether the member is the team's owner.
 
-        @membership_state = {
+        # @private
+        # @return [{Integer => Symbol}] The permission map.
+        MEMBERSHIP_STATE = {
           1 => :invited,
           2 => :accepted,
         }.freeze
@@ -153,7 +167,7 @@ module Discorb
           @team = team
           @user = client.users[data[:user][:id]] || User.new(client, data[:user])
           @team_id = Snowflake.new(data[:team_id])
-          @membership_state = self.class.membership_state[data[:membership_state]]
+          @membership_state = MEMBERSHIP_STATE[data[:membership_state]]
           @permissions = data[:permissions].map(&:to_sym)
         end
 
@@ -176,11 +190,6 @@ module Discorb
         def ==(other)
           super || @user == other
         end
-
-        class << self
-          # @private
-          attr_reader :membership_state
-        end
       end
     end
   end

data/lib/discorb/asset.rb

@@ -11,7 +11,13 @@ module Discorb
     # @!attribute [r] animated?
     #   @return [Boolean] Whether the asset is animated.
 
+    #
+    # Initialize a new instance of the Asset class.
     # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    #
     def initialize(target, hash, path: nil)
       @hash = hash
       @target = target
@@ -63,7 +69,10 @@ module Discorb
     # @!attribute [r] animated?
     #   @return [false] For compatibility with {Asset}, always `false`.
 
+    #
+    # Initialize a new instance of the DefaultAvatar class.
     # @private
+    #
     def initialize(discriminator)
       @discriminator = discriminator.to_s.rjust(4, "0")
     end

data/lib/discorb/{file.rb → attachment.rb}

@@ -7,15 +7,17 @@ module Discorb
   #
   # Represents a attachment file.
   #
-  class Attachment < DiscordModel
+  class Attachment
     # @return [#read] The file content.
     attr_reader :io
-    # @return [Discorb::Snowflake] The attachment id.
-    attr_reader :id
     # @return [String] The attachment filename.
     attr_reader :filename
     # @return [String] The attachment content type.
     attr_reader :content_type
+    # @return [String] The attachment description.
+    attr_reader :description
+    # @return [Discorb::Snowflake] The attachment id.
+    attr_reader :id
     # @return [Integer] The attachment size in bytes.
     attr_reader :size
     # @return [String] The attachment url.
@@ -28,12 +30,44 @@ module Discorb
     # @return [Integer] The image width.
     # @return [nil] If the attachment is not an image.
     attr_reader :width
+    # @return [:client, :discord] The attachment was created by.
+    attr_reader :created_by
+    # @private
+    # @return [Boolean] Whether the attachment will be closed after it is sent.
+    attr_reader :will_close
 
     # @!attribute [r] image?
     #   @return [Boolean] whether the file is an image.
 
+    #
+    # Creates a new attachment.
+    #
+    # @param [#read, String] source The Source of the attachment.
+    # @param [String] filename The filename of the attachment. If not set, path or object_id of the IO is used.
+    # @param [String] description The description of the attachment.
+    # @param [String] content_type The content type of the attachment. If not set, it is guessed from the filename.
+    #   If failed to guess, it is set to `application/octet-stream`.
+    # @param [Boolean] will_close Whether the IO will be closed after the attachment is sent.
+    #
+    def initialize(source, filename = nil, description: nil, content_type: nil, will_close: true)
+      @io = if source.respond_to?(:read)
+          source
+        else
+          File.open(source, "rb")
+        end
+      @filename = filename || (@io.respond_to?(:path) ? @io.path : @io.object_id)
+      @description = description
+      @content_type = content_type || MIME::Types.type_for(@filename.to_s)[0].to_s
+      @content_type = "application/octet-stream" if @content_type == ""
+      @will_close = will_close
+      @created_by = :client
+    end
+
+    #
+    # Initializes the object from a hash.
     # @private
-    def initialize(data)
+    #
+    def initialize_hash(data)
       @id = Snowflake.new(data[:id])
       @filename = data[:filename]
       @content_type = data[:content_type]
@@ -42,37 +76,29 @@ module Discorb
       @proxy_url = data[:proxy_url]
       @height = data[:height]
       @width = data[:width]
+      @created_by = :discord
     end
 
     def image?
       @content_type.start_with? "image/"
     end
-  end
 
-  #
-  # Represents a file to send as an attachment.
-  #
-  class File
-    # @return [#read] The IO of the file.
-    attr_accessor :io
-    # @return [String] The filename of the file. If not set, path or object_id of the IO is used.
-    attr_accessor :filename
-    # @return [String] The content type of the file. If not set, it is guessed from the filename.
-    attr_accessor :content_type
+    def inspect
+      if @created_by == :discord
+        "<#{self.class} #{@id}: #{@filename}>"
+      else
+        "<#{self.class} #{io.fileno}: #{@filename}>"
+      end
+    end
 
     #
-    # Creates a new file from IO.
-    #
-    # @param [#read] io The IO of the file.
-    # @param [String] filename The filename of the file. If not set, path or object_id of the IO is used.
-    # @param [String] content_type The content type of the file. If not set, it is guessed from the filename.
-    #   If failed to guess, it is set to `application/octet-stream`.
+    # Creates a new file from a hash.
+    # @private
     #
-    def initialize(io, filename = nil, content_type: nil)
-      @io = io
-      @filename = filename || (io.respond_to?(:path) ? io.path : io.object_id)
-      @content_type = content_type || MIME::Types.type_for(@filename.to_s)[0].to_s
-      @content_type = "application/octet-stream" if @content_type == ""
+    def self.from_hash(data)
+      inst = allocate
+      inst.initialize_hash(data)
+      inst
     end
 
     #
@@ -82,16 +108,12 @@ module Discorb
     # @param [String] filename The filename of the file. object_id of the string is used if not set.
     # @param [String] content_type The content type of the file. If not set, it is guessed from the filename.
     #
-    # @return [File] The new file.
+    # @return [Discorb::Attachment] The new file.
     #
-    def self.from_string(string, filename: nil, content_type: nil)
+    def self.from_string(string, filename = nil, content_type: nil, description: nil)
       io = StringIO.new(string)
       filename ||= string.object_id.to_s + ".txt"
-      new(io, filename, content_type: content_type)
-    end
-
-    def inspect
-      "#<#{self.class} filename=#{@filename} content_type=#{@content_type}>"
+      new(io, filename, content_type: content_type, description: description, will_close: true)
     end
   end
 end