discorb 0.16.0 → 0.18.0

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require_relative "lib/discorb/utils/colored_puts"
+require "parallel_tests"
 task default: %i[]
 
 # @private
@@ -15,6 +16,11 @@ def current_version
   end
 end
 
+desc "Run spec with parallel_rspec"
+task :spec do
+  sh "parallel_rspec spec/*.spec.rb spec/**/*.spec.rb"
+end
+
 desc "Build emoji_table.rb"
 task :emoji_table do
   require_relative "lib/discorb"
@@ -65,7 +71,7 @@ namespace :document do
   version = current_version
   desc "Just generate document"
   task :yard do
-    sh "bundle exec yardoc -o doc/#{version} --locale #{ENV["rake_locale"] or "en"}"
+    sh "bundle exec yardoc -o doc/#{version} --locale #{ENV.fetch("rake_locale", nil) or "en"}"
   end
 
   desc "Replace files"
@@ -76,7 +82,7 @@ namespace :document do
     task :css do
       iputs "Replacing css"
       Dir.glob("template-replace/files/**/*.*")
-        .map { |f| f.delete_prefix("template-replace/files") }.each do |file|
+         .map { |f| f.delete_prefix("template-replace/files") }.each do |file|
         FileUtils.cp("template-replace/files" + file, "doc/#{version}/#{file}")
       end
       sputs "Successfully replaced css"
@@ -135,9 +141,11 @@ namespace :document do
       sputs "Successfully replaced CRLF with LF"
     end
 
+    desc "change locale of current document"
     task :locale do
       next if ENV["rake_locale"].nil?
-      require_relative "template-replace/scripts/locale_#{ENV["rake_locale"]}.rb"
+
+      require_relative "template-replace/scripts/locale_#{ENV.fetch("rake_locale", nil)}.rb"
       replace_locale("doc/main")
     end
   end
@@ -196,11 +204,12 @@ namespace :document do
   end
 
   namespace :locale do
+    desc "Generate Japanese document"
     task :ja do
       require "crowdin-api"
       require "zip"
       crowdin = Crowdin::Client.new do |config|
-        config.api_token = ENV["CROWDIN_PERSONAL_TOKEN"]
+        config.api_token = ENV.fetch("CROWDIN_PERSONAL_TOKEN", nil)
         config.project_id = ENV["CROWDIN_PROJECT_ID"].to_i
       end
       build = crowdin.build_project_translation["data"]["id"]
@@ -216,116 +225,235 @@ namespace :document do
       Rake::Task["document:replace"].execute
     end
 
+    desc "Generate English document"
     task :en do
       Rake::Task["document"].execute("locale:en")
     end
   end
 end
 
-task :rbs do
-  require "open3"
-  type_errors = {
-    "SORD_ERROR_SymbolSymbolSymbolInteger" => "{ r: Integer, g: Integer, b: Integer}",
-    "SORD_ERROR_DiscorbRoleDiscorbMemberDiscorbPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
-    "SORD_ERROR_DiscorbRoleDiscorbMemberPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
-    "SORD_ERROR_f | SORD_ERROR_F | SORD_ERROR_d | SORD_ERROR_D | SORD_ERROR_t | SORD_ERROR_T | SORD_ERROR_R" => '"f" | "F" | "d" | "D" | "t" | "T" | "R"',
-    "SORD_ERROR_dark | SORD_ERROR_light" => '"dark" | "light"',
-    "SORD_ERROR_SymbolStringSymbolboolSymbolObject" => "String | Integer | Float",
-  }
-  regenerate = ARGV.include?("--regenerate") || ARGV.include?("-r")
-
-  sh "sord gen sig/discorb.rbs --keep-original-comments --no-sord-comments" + (regenerate ? " --regenerate" : " --no-regenerate")
-  base = File.read("sig/discorb.rbs")
-  base.gsub!(/\n +def _set_data: \(.+\) -> untyped\n\n/, "")
-  base.gsub!(/(  )?( *)# @private.+?(?:\n\n(?=\1\2#)|(?=\n\2end))/sm, "")
-  base.gsub!(/untyped ([a-z_]*id)/, "_ToS \\1")
-  # #region rbs dictionary
-  base.gsub!(/  class Dictionary.+?end\n/ms, <<-RBS)
-  class Dictionary[K, V]
-    # 
-    # Initialize a new Dictionary.
-    # 
-    # @param [Hash] hash A hash of items to add to the dictionary.
-    # @param [Integer] limit The maximum number of items in the dictionary.
-    # @param [false, Proc] sort Whether to sort the items in the dictionary.
-    def initialize: (?::Hash[untyped, untyped] hash, ?limit: Integer?, ?sort: (bool | Proc)) -> void
-
-    # 
-    # Registers a new item in the dictionary.
-    # 
-    # @param [#to_s] id The ID of the item.
-    # @param [Object] body The item to register.
-    # 
-    # @return [self] The dictionary.
-    def register: (_ToS id, Object body) -> self
-
-    # 
-    # Merges another dictionary into this one.
-    # 
-    # @param [Discorb::Dictionary] other The dictionary to merge.
-    def merge: (Discorb::Dictionary other) -> untyped
-
-    # 
-    # Removes an item from the dictionary.
-    # 
-    # @param [#to_s] id The ID of the item to remove.
-    def remove: (_ToS id) -> untyped
-
-    # 
-    # Get an item from the dictionary.
-    # 
-    # @param [#to_s] id The ID of the item.
-    # @return [Object] The item.
-    # @return [nil] if the item was not found.
-    # 
-    # @overload get(index)
-    #   @param [Integer] index The index of the item.
-    # 
-    #   @return [Object] The item.
-    #   @return [nil] if the item is not found.
-    def get: (K id) -> V?
-
-    # 
-    # Returns the values of the dictionary.
-    # 
-    # @return [Array] The values of the dictionary.
-    def values: () -> ::Array[V]
-
-    # 
-    # Checks if the dictionary has an ID.
-    # 
-    # @param [#to_s] id The ID to check.
-    # 
-    # @return [Boolean] `true` if the dictionary has the ID, `false` otherwise.
-    def has?: (_ToS id) -> bool
-
-    # 
-    # Send a message to the array of values.
-    def method_missing: (untyped name) -> untyped
-
-    def respond_to_missing?: (untyped name, untyped args, untyped kwargs) -> bool
-
-    def inspect: () -> untyped
-
-    # @return [Integer] The maximum number of items in the dictionary.
-    attr_accessor limit: Integer
+desc "Generate rbs file"
+namespace :rbs do
+  desc "Generate event signature"
+  task :event do
+    client_rbs = File.read("sig/discorb/client.rbs")
+    extension_rbs = File.read("sig/discorb/extension.rbs")
+    event_document = File.read("./docs/events.md")
+    voice_event_document = File.read("./docs/voice_events.md")
+    event_reference = event_document.split("## Event reference")[1]
+    event_reference += voice_event_document.split("# Voice Events")[1]
+    event_reference.gsub!(/^### (.*)$/, "")
+    events = []
+    event_reference.split("#### `")[1..].each do |event|
+      header, content = event.split("`\n", 2)
+      name = header.split("(")[0]
+      description = content.split("| Parameter", 2)[0].strip
+      parameters = if content.include?("| Parameter")
+          content.scan(/\| `(.*?)` +\| (.*?) +\| (.*?) +\|/)
+        else
+          []
+        end
+      events << {
+        name: name,
+        description: description,
+        parameters: parameters.map { |p| { name: p[0], type: p[1], description: p[2] } },
+      }
+    end
+    event_sig = +""
+    event_lock_sig = +""
+    extension_sig = +""
+    events.each do |event|
+      args = []
+      event[:parameters].each do |parameter|
+        args << {
+          name: parameter[:name],
+          type: if parameter[:type].start_with?("?")
+            parameter[:type][1..]
+          else
+            parameter[:type]
+          end.tr("{}`", "").tr("<>", "[]").gsub(", ", " | ").then do |t|
+            if event[:name] == "event_receive"
+              case t
+              when "Hash"
+                next "Discorb::json"
+              end
+            end
+            t
+          end,
+        }
+      end
+      sig = args.map { |a| "#{a[:type]} #{a[:name]}" }.join(", ")
+      tuple_sig = args.map { |a| a[:type] }.join(", ")
+      tuple_sig = "[" + tuple_sig + "]" if args.length > 1
+      tuple_sig = "void" if args.length.zero?
+      event_sig << <<~RBS
+        | (:#{event[:name]} event_name, ?id: Symbol?, **untyped metadata) { (#{sig}) -> void } -> Discorb::EventHandler
+      RBS
+      event_lock_sig << <<~RBS
+        | (:#{event[:name]} event, ?Integer? timeout) { (#{sig}) -> boolish } -> Async::Task[#{tuple_sig}]
+      RBS
+      extension_sig << <<~RBS
+        | (:#{event[:name]} event_name, ?id: Symbol?, **untyped metadata) { (#{sig}) -> void } -> void
+      RBS
+    end
+    event_sig.sub!("| ", "  ").rstrip!
+    event_lock_sig.sub!("| ", "  ").rstrip!
+    extension_sig.sub!("| ", "  ").rstrip!
+    res = client_rbs.gsub!(/\# marker: on\n(?:[\s\S]*?\n)?( +)\# endmarker: on\n/) do
+      indent = Regexp.last_match(1)
+      "# marker: on\n#{event_sig.gsub(/^/, "#{indent}      ")}\n#{indent}# endmarker: on\n"
+    end
+    raise "Failed to generate Client#on" unless res
+
+    res = client_rbs.gsub!(/\# marker: once\n(?:[\s\S]*?\n)?( +)\# endmarker: once\n/) do
+      indent = Regexp.last_match(1)
+      "# marker: once\n#{event_sig.gsub(/^/, "#{indent}        ")}\n#{indent}# endmarker: once\n"
+    end
+    raise "Failed to generate Client#once" unless res
+
+    res = client_rbs.gsub!(/\# marker: event_lock\n(?:[\s\S]*?\n)?( +)\# endmarker: event_lock\n/) do
+      indent = Regexp.last_match(1)
+      "# marker: event_lock\n#{event_lock_sig.gsub(/^/, "#{indent}       ")}\n#{indent}# endmarker: event_lock\n"
+    end
+    raise "Failed to generate Client#event_lock" unless res
+
+    res = extension_rbs.gsub!(/\# marker: event\n(?:[\s\S]*?\n)?( +)\# endmarker: event\n/) do
+      indent = Regexp.last_match(1)
+      "# marker: event\n#{extension_sig.gsub(/^/, "#{indent}       ")}\n#{indent}# endmarker: event\n"
+    end
+    raise "Failed to generate Extension.event" unless res
+
+    res = extension_rbs.gsub!(/\# marker: once_event\n(?:[\s\S]*?\n)?( +)\# endmarker: once_event\n/) do
+      indent = Regexp.last_match(1)
+      "# marker: once_event\n#{extension_sig.gsub(/^/, "#{indent}       ")}\n#{indent}# endmarker: once_event\n"
+    end
+    raise "Failed to generate Extension.once_event" unless res
+
+    File.write("sig/discorb/client.rbs", client_rbs, mode: "wb")
+    File.write("sig/discorb/extension.rbs", extension_rbs, mode: "wb")
+  end
+
+  desc "Generate rbs file using sord"
+  task :sord do
+    require "open3"
+    # rubocop: disable Layout/LineLength
+    type_errors = {
+      "SORD_ERROR_SymbolSymbolSymbolInteger" => "{ r: Integer, g: Integer, b: Integer}",
+      "SORD_ERROR_DiscorbRoleDiscorbMemberDiscorbPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
+      "SORD_ERROR_DiscorbRoleDiscorbMemberPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
+      "SORD_ERROR_f | SORD_ERROR_F | SORD_ERROR_d | SORD_ERROR_D | SORD_ERROR_t | SORD_ERROR_T | SORD_ERROR_R" => '"f" | "F" | "d" | "D" | "t" | "T" | "R"',
+      "SORD_ERROR_dark | SORD_ERROR_light" => '"dark" | "light"',
+      "SORD_ERROR_SymbolStringSymbolboolSymbolObject" => "String | Integer | Float",
+    }
+    # rubocop: enable Layout/LineLength
+    regenerate = ARGV.include?("--regenerate") || ARGV.include?("-r")
+
+    sh "sord gen sig/discorb.rbs --keep-original-comments --no-sord-comments" +
+       (regenerate ? " --regenerate" : " --no-regenerate")
+    base = File.read("sig/discorb.rbs")
+    base.gsub!(/\n +def _set_data: \(.+\) -> untyped\n\n/, "\n")
+    # base.gsub!(/(  )?( *)# @private.+?(?:\n\n(?=\1\2#)|(?=\n\2end))/sm, "")
+    base.gsub!(/untyped ([a-z_]*id)/, "_ToS \\1")
+    # #region rbs dictionary
+    base.gsub!(/  class Dictionary.+?end\n/ms, <<-RBS)
+    class Dictionary[K, V]
+      #
+      # Initialize a new Dictionary.
+      #
+      # @param [Hash] hash A hash of items to add to the dictionary.
+      # @param [Integer] limit The maximum number of items in the dictionary.
+      # @param [false, Proc] sort Whether to sort the items in the dictionary.
+      def initialize: (?::Hash[untyped, untyped] hash, ?limit: Integer?, ?sort: (bool | Proc)) -> void
+
+      #
+      # Registers a new item in the dictionary.
+      #
+      # @param [#to_s] id The ID of the item.
+      # @param [Object] body The item to register.
+      #
+      # @return [self] The dictionary.
+      def register: (_ToS id, Object body) -> self
+
+      #
+      # Merges another dictionary into this one.
+      #
+      # @param [Discorb::Dictionary] other The dictionary to merge.
+      def merge: (Discorb::Dictionary other) -> untyped
+
+      #
+      # Removes an item from the dictionary.
+      #
+      # @param [#to_s] id The ID of the item to remove.
+      def remove: (_ToS id) -> untyped
+
+      #
+      # Get an item from the dictionary.
+      #
+      # @param [#to_s] id The ID of the item.
+      # @return [Object] The item.
+      # @return [nil] if the item was not found.
+      #
+      # @overload get(index)
+      #   @param [Integer] index The index of the item.
+      #
+      #   @return [Object] The item.
+      #   @return [nil] if the item is not found.
+      def get: (K id) -> V?
+
+      #
+      # Returns the values of the dictionary.
+      #
+      # @return [Array] The values of the dictionary.
+      def values: () -> ::Array[V]
+
+      #
+      # Checks if the dictionary has an ID.
+      #
+      # @param [#to_s] id The ID to check.
+      #
+      # @return [Boolean] `true` if the dictionary has the ID, `false` otherwise.
+      def has?: (_ToS id) -> bool
+
+      #
+      # Send a message to the array of values.
+      def method_missing: (untyped name) -> untyped
+
+      def respond_to_missing?: (untyped name, untyped args, untyped kwargs) -> bool
+
+      def inspect: () -> String
+
+      # @return [Integer] The maximum number of items in the dictionary.
+      attr_accessor limit: Integer
+    end
+    RBS
+    # #endregion
+    type_errors.each do |error, type|
+      base.gsub!(error, type)
+    end
+    base.gsub!("end\n\n\nend", "end\n")
+    base.gsub!(/ +$/m, "")
+    File.write("sig/discorb.rbs", base)
+  end
+
+  desc "Lint rbs with stree"
+  task :lint do
+    sh "stree check --plugins=rbs sig/**/*.rbs"
   end
-  RBS
-  # #endregion
-  type_errors.each do |error, type|
-    base.gsub!(error, type)
+
+  desc "Autofix rbs with stree"
+  task "lint:fix" do
+    sh "stree write --plugins=rbs sig/**/*.rbs"
   end
-  File.write("sig/discorb.rbs", base)
 end
 
 task document: %i[document:yard document:replace]
 
 desc "Lint code with rubocop"
 task :lint do
-  sh "rubocop lib"
+  sh "rubocop lib spec Rakefile"
 end
 
 desc "Autofix code with rubocop"
 task "lint:fix" do
-  sh "rubocop lib -A"
+  sh "rubocop lib spec Rakefile -A"
 end

data/Steepfile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"
+
+  library "net-http", "timeout"
+
+  configure_code_diagnostics(D::Ruby.lenient)
+  configure_code_diagnostics do |config|
+    config[D::Ruby::UnsupportedSyntax] = nil
+    config[D::Ruby::UnexpectedSuper] = nil
+    config[D::Ruby::UnexpectedPositionalArgument] = nil
+    config[D::Ruby::InsufficientPositionalArguments] = nil
+  end
+end
+
+target :test do
+  signature "sig"
+  signature "examples/sig"
+
+  check "examples/**/*.rb"
+
+  library "net-http", "timeout"
+end

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'discorb'
+require "bundler/setup"
+require "discorb"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'discorb'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/docs/Examples.md

@@ -25,4 +25,4 @@
 #### Note
 
 This example is not shown correctly in the docs.
-[Read this example on GitHub](https://github.com/discorb-lib/discorb/blob/main/examples/components/select_menu.rb).
+[Read this example on GitHub](https://github.com/discorb-lib/discorb/blob/main/examples/components/select_menu.rb).