discorb 0.13.4 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45868a2fa9284bc0910bdad465983c490f44b721ccc49632df681e79e78fd727
-  data.tar.gz: 969d627479e5381da98e1775186e23f9a193244180135b8dc9396878a425ee43
+  metadata.gz: 810e9b14c77e49e9fca7afc4fe6b98389b26cb17dc1617213f38d7655b990a49
+  data.tar.gz: bbaa999265ac212f90ab60d57ec772fe7ade0e47f264a136130c679b85a46952
 SHA512:
-  metadata.gz: 2732b467bfc1ba6af2d6938b384026e5219bfce03ff646669870e311601ec7b0258a72ba1c4b6fd6c9a60d1c3186c3890842916bb2f387542cf1d2ee7fbafab3
-  data.tar.gz: a825f0d8497f8f62c024fa381441d9a19da54b0aa2fe71a7b87fc6ef17bc74f7e65a1681b6dc9c7abb1a2f746e6d821abaf4ae28ae6d9661226e7276dce2f551
+  metadata.gz: 120828736edcf7eef9d78410914651edeb41ae85eadef012050b105b03c80f07f835d812105d3cfe954c7237e344b3bbc540af8840a7dde1a69f590b008a759e
+  data.tar.gz: f29b0399c65f180b05bf6c0c3d5f253689ff08c734f60ee7681b57c060d99e36dd85fc275f9652354933478b8139aa76c8ad854f6963fd1c074a8a260ffb6bde

data/.gitattributes

@@ -0,0 +1,2 @@
+template-replace/**/* linguist-documentation
+sig/* linguist-generated

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '20 10 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

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

@@ -0,0 +1,18 @@
+name: Lint with RuboCop
+on:
+  - push
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+      - name: Install gems
+        run: |
+          gem install rubocop
+      - name: Run rubocop
+        run: |
+          rubocop lib

data/.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: Lint with RuboCop
+on:
+  - pull_request
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+      - name: rubocop
+        uses: reviewdog/action-rubocop@v2
+        with:
+          rubocop_version: 1.25

data/.rubocop.yml

@@ -0,0 +1,70 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  Exclude:
+    - examples/**/*.rb
+
+Layout:
+  Enabled: false
+Metrics:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:  # Disabled for rufo
+  Enabled: false
+
+Style/StringLiterals:  # Disabled for rufo
+  Enabled: false
+
+Style/TrailingCommaInArguments:  # Disabled for rufo
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:  # Disabled for rufo
+  Enabled: false
+
+Style/StringConcatenation:  # + looks better
+  Enabled: false
+
+Lint/MissingSuper:  # For abstract classes
+  Enabled: false
+
+Lint/AssignmentInCondition:  # Looks bad
+  Enabled: false
+
+Style/PerlBackrefs:  # It will be longer
+  Enabled: false
+
+Style/RedundantSelf:  # Looks local variable
+  Enabled: false
+
+Naming/VariableNumber:  # Discord API docs naming
+  Enabled: false
+
+Style/ParallelAssignment:  # It will be longer
+  Enabled: false
+
+Style/RedundantInterpolation:  # For make it extendable
+  Enabled: false
+
+Style/Next:  # For make it extendable
+  Enabled: false
+
+Lint/ShadowedException:  # False positive
+  Enabled: false
+
+Lint/AmbiguousOperatorPrecedence:  # Not needed
+  Enabled: false
+
+Style/GlobalVars: # For /exe
+  Enabled: false
+
+Lint/Debugger: # For /exe
+  Enabled: false
+
+Style/GuardClause: # For make it extendable
+  Enabled: false
+
+Layout/EndOfLine: # For git
+  EnforcedStyle: lf
+
+Lint/ScriptPermission: # For GitHub Actions
+  Enabled: false

data/Changelog.md

@@ -4,6 +4,18 @@
 
 # Changelog
 
+## v0.14
+
+### v0.14.0
+
+- Add: Support Modal interaction
+- Add: Support attachment option type in slash command
+- Fix: Connections will no longer stacked
+- Fix: Fix Client#fetch_nitro_sticker_packs returning 404
+- Fix: Fix `self` reference in subcommand of extension
+- Refactor: Refactored many things
+- Refactor: Add Rubocop
+
 ## v0.13
 
 ### v0.13.4

data/Gemfile

@@ -13,9 +13,13 @@ group :development, optional: true do
 end
 
 group :docs, optional: true do
-  gem "redcarpet"
-  gem "yard", "~> 0.9.26"
-  gem "gettext", "~> 3.4.1"
   gem "crowdin-api", "~> 1.0"
+  gem "gettext", "~> 3.4.1"
+  gem "redcarpet"
   gem "rubyzip", "~> 2.3"
+  gem "yard", "~> 0.9.26"
+end
+
+group :lint, optional: true do
+  gem "rubocop", "~> 1.25"
 end

data/Rakefile

@@ -5,15 +5,14 @@ require_relative "lib/discorb/utils/colored_puts"
 task default: %i[]
 
 # @private
-def get_version
+def current_version
   require_relative "lib/discorb/common"
   tag = `git tag --points-at HEAD`.force_encoding("utf-8").strip
   if tag.empty?
-    version = "main"
+    "main"
   else
-    version = Discorb::VERSION
+    Discorb::VERSION
   end
-  version
 end
 
 desc "Build emoji_table.rb"
@@ -63,8 +62,7 @@ end
 
 desc "Generate document and replace"
 namespace :document do
-  version = get_version
-
+  version = current_version
   desc "Just generate document"
   task :yard do
     sh "bundle exec yardoc -o doc/#{version} --locale #{ENV["rake_locale"] or "en"}"
@@ -86,12 +84,12 @@ namespace :document do
 
     desc "Replace HTML"
     task :html do
-      require_relative "template-replace/scripts/sidebar.rb"
-      require_relative "template-replace/scripts/version.rb"
-      require_relative "template-replace/scripts/index.rb"
-      require_relative "template-replace/scripts/yard_replace.rb"
-      require_relative "template-replace/scripts/favicon.rb"
-      require_relative "template-replace/scripts/arrow.rb"
+      require_relative "template-replace/scripts/sidebar"
+      require_relative "template-replace/scripts/version"
+      require_relative "template-replace/scripts/index"
+      require_relative "template-replace/scripts/yard_replace"
+      require_relative "template-replace/scripts/favicon"
+      require_relative "template-replace/scripts/arrow"
       iputs "Resetting changes"
       Dir.glob("doc/#{version}/**/*.html") do |f|
         next if (m = f.match(/[0-9]+\.[0-9]+\.[0-9]+(-[a-z]+)?/)) && m[0] != version
@@ -143,20 +141,18 @@ namespace :document do
       replace_locale("doc/main")
     end
   end
-  task :replace => %i[replace:css replace:html replace:eol]
+  task replace: %i[replace:css replace:html replace:eol]
 
   desc "Build all versions"
   task :build_all do
     require "fileutils"
 
-    class Bundler::Definition
-      def validate_platforms!
-        # noop
-      end
-    end
-
     iputs "Building all versions"
-    FileUtils.rm_rf("doc") rescue nil
+    begin
+      FileUtils.rm_rf("doc")
+    rescue StandardError
+      nil
+    end
     FileUtils.cp_r("./template-replace/.", "./tmp-template-replace")
     Rake::Task["document:yard"].execute
     Rake::Task["document:replace:html"].execute
@@ -181,7 +177,7 @@ namespace :document do
     FileUtils.cp_r("./tmp-doc/.", "./doc")
     FileUtils.cp_r("./doc/#{tags.last.delete_prefix("v")}/.", "./doc")
     sputs "Successfully built all versions"
-  rescue => e
+  rescue StandardError => e
     sh "git switch main -f"
     raise e
   end
@@ -322,4 +318,8 @@ task :rbs do
   File.write("sig/discorb.rbs", base)
 end
 
-task :document => %i[document:yard document:replace]
+task document: %i[document:yard document:replace]
+
+task :lint do
+  sh "rubocop lib"
+end

data/discorb.gemspec

@@ -46,4 +46,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mime-types", "~> 3.3"
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/examples/commands/bookmarker.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 require "json"
 
@@ -20,7 +21,7 @@ def build_embed_from_message(message)
   embed
 end
 
-client.message_command("Bookmark", guild_ids: [857373681096327180]) do |interaction, message|
+client.message_command("Bookmark", guild_ids: [857_373_681_096_327_180]) do |interaction, message|
   unless channel = bookmark_channel(interaction.guild)
     interaction.post("Bookmark channel not found. Please create one called `bookmarks`.", ephemeral: true)
     next

data/examples/commands/hello.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new

data/examples/commands/inspect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new
@@ -6,7 +7,7 @@ client.once :standby do
   puts "Logged in as #{client.user}"
 end
 
-client.user_command("Info", guild_ids: [857373681096327180]) do |interaction|
+client.user_command("Info", guild_ids: [857_373_681_096_327_180]) do |interaction|
   interaction.post(embed: Discorb::Embed.new(
                      "Information of #{interaction.target.to_s_user}",
                      fields: [
@@ -14,7 +15,7 @@ client.user_command("Info", guild_ids: [857373681096327180]) do |interaction|
                        Discorb::Embed::Field.new("ID", interaction.target.id),
                        Discorb::Embed::Field.new("Bot", interaction.target.bot? ? "Yes" : "No"),
                        Discorb::Embed::Field.new("Joined at", interaction.target.joined_at.to_df("F")),
-                       Discorb::Embed::Field.new("Created at", interaction.target.created_at.to_df("F")),
+                       Discorb::Embed::Field.new("Created at", interaction.target.created_at.to_df("F"))
                      ],
                      thumbnail: interaction.target.avatar&.url,
 

data/examples/components/authorization_button.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new
@@ -27,7 +28,7 @@ client.on :message do |message|
     components: [
       Discorb::Button.new(
         "Get role", custom_id: "auth:#{role.id}",
-      ),
+      )
     ],
   )
 end

data/examples/components/select_menu.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new
@@ -21,7 +22,7 @@ SECTIONS = [
     > So I decided to make it.
     Matsumoto describes the design of Ruby as being like a simple Lisp language at its core, with an object system like that of Smalltalk, blocks inspired by higher-order functions, and practical utility like that of Perl.
   WIKI
-  ["First publication", <<~WIKI],
+  ["First publication", <<~WIKI]
     The first public release of Ruby 0.95 was announced on Japanese domestic newsgroups on December 21, 1995.
     Subsequently, three more versions of Ruby were released in two days.
     The release coincided with the launch of the Japanese-language ruby-list mailing list, which was the first mailing list for the new language.

data/examples/extension/main.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 require_relative "message_expander"
 

data/examples/extension/message_expander.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 class MessageExpander

data/examples/simple/eval.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new
@@ -24,8 +25,8 @@ client.on :message do |message|
     res = res.wait if res.is_a? Async::Task
     message.channel.post("```rb\n#{res.inspect[...1990]}\n```")
   end
-rescue Exception => error
-  message.reply embed: Discorb::Embed.new("Error!", "```rb\n#{error.full_message(highlight: false)[...1990]}\n```",
+rescue Exception => e
+  message.reply embed: Discorb::Embed.new("Error!", "```rb\n#{e.full_message(highlight: false)[...1990]}\n```",
                                           color: Discorb::Color[:red])
 end
 

data/examples/simple/ping_pong.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new

data/examples/simple/rolepanel.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 intents = Discorb::Intents.new
 intents.members = true

data/examples/simple/wait_for_message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new
@@ -10,16 +11,16 @@ client.on :message do |message|
   next if message.author.bot?
   next unless message.content == "!quiz"
 
-  operator = [:+, :-, :*].sample
+  operator = %i[+ - *].sample
   num1 = rand(1..10)
   num2 = rand(1..10)
 
   val = num1.send(operator, num2)
   message.channel.post("Quiz: `#{num1} #{operator} #{num2}`")
   begin
-    msg = client.event_lock(:message, 30) { |m|
+    msg = client.event_lock(:message, 30) do |m|
       m.content == val.to_s && m.channel == message.channel
-    }.wait
+    end.wait
   rescue Discorb::TimeoutError
     message.channel.post("No one answered...")
   else

data/exe/discorb

@@ -1,24 +1,25 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
 
 script = ARGV[0]
 
 if script.nil?
   puts "\e[94mThis is a tool for discorb. Currently these tools are available:\e[m"
 
-  discorb_path = $:.find { |path| File.directory?(path + "/discorb") }
+  discorb_path = $LOAD_PATH.find { |path| File.directory?(path + "/discorb") }
   scripts = {}
-  Dir.glob(discorb_path + "/discorb/exe/*.rb") do |script|
-    name = File.basename(script, ".rb")
-    description = File.read(script).match(/# description: (.+)/)&.[](1) || "No description"
+  Dir.glob(discorb_path + "/discorb/exe/*.rb") do |exe_script|
+    name = File.basename(exe_script, ".rb")
+    description = File.read(exe_script).match(/# description: (.+)/)&.[](1) || "No description"
     scripts[name] = description
   end
-  max_length = scripts.keys.map { |key| key.length }.max
+  max_length = scripts.keys.map(&:length).max
   scripts.sort.each do |name, description|
     puts "\e[90m#{name.rjust(max_length)}\e[m - #{description}"
   end
 
-  puts "\e[94m\nTo run a tool, type:\e[m\n" +
-         "\e[34m  discorb [script]\e[m"
+  puts "\e[94m\nTo run a tool, type:\e[m\n" \
+       "\e[34m  discorb [script]\e[m"
 
   exit 1
 end

data/lib/discorb/allowed_mentions.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+module Discorb
+  #
+  # Represents a allowed mentions in a message.
+  #
+  class AllowedMentions
+    # @return [Boolean] Whether to allow @everyone or @here.
+    attr_accessor :everyone
+    # @return [Boolean, Array<Discorb::Role>] The roles to allow, or false to disable.
+    attr_accessor :roles
+    # @return [Boolean, Array<Discorb::User>] The users to allow, or false to disable.
+    attr_accessor :users
+    # @return [Boolean] Whether to ping the user that sent the message to reply.
+    attr_accessor :replied_user
+
+    #
+    # Initializes a new instance of the AllowedMentions class.
+    #
+    # @param [Boolean] everyone Whether to allow @everyone or @here.
+    # @param [Boolean, Array<Discorb::Role>] roles The roles to allow, or false to disable.
+    # @param [Boolean, Array<Discorb::User>] users The users to allow, or false to disable.
+    # @param [Boolean] replied_user Whether to ping the user that sent the message to reply.
+    #
+    def initialize(everyone: nil, roles: nil, users: nil, replied_user: nil)
+      @everyone = everyone
+      @roles = roles
+      @users = users
+      @replied_user = replied_user
+    end
+
+    def inspect
+      "#<#{self.class} @everyone=#{@everyone} @roles=#{@roles} @users=#{@users} @replied_user=#{@replied_user}>"
+    end
+
+    # @private
+    def to_hash(other = nil)
+      payload = {
+        parse: %w[everyone roles users],
+      }
+      replied_user = nil_merge(@replied_user, other&.replied_user)
+      everyone = nil_merge(@everyone, other&.everyone)
+      roles = nil_merge(@roles, other&.roles)
+      users = nil_merge(@users, other&.users)
+      payload[:replied_user] = replied_user
+      payload[:parse].delete("everyone") if everyone == false
+      if (roles == false) || roles.is_a?(Array)
+        payload[:roles] = roles.map { |u| u.id.to_s } if roles.is_a? Array
+        payload[:parse].delete("roles")
+      end
+      if (users == false) || users.is_a?(Array)
+        payload[:users] = users.map { |u| u.id.to_s } if users.is_a? Array
+        payload[:parse].delete("users")
+      end
+      payload
+    end
+
+    def nil_merge(*args)
+      args.each do |a|
+        return a unless a.nil?
+      end
+      nil
+    end
+  end
+end