discorb 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d381f2f57b9406b242c04ef9dba26469f5a24b07b9666b1bbc3c28ee8fa9ba4b
-  data.tar.gz: c3734ddee2014e8de6a92f121d2e3267c72e1ca0c501f6744012c206ad453663
+  metadata.gz: e27fc8b1d9e527f2ce007c686025f4edc9ca7ee8dda06df91ff48a02034a1dbf
+  data.tar.gz: 7708d124bd2921941164e178c35714b3cf7d68f19b202a823bc9913688c35495
 SHA512:
-  metadata.gz: 35078668f904112c86baf31c99dc325c323e7045b13e45e3d42754e2cbf702298e2b32f589c8fe880912aa4ed850bf1ce0b41deffa91375a55e3a63621566a0d
-  data.tar.gz: aad1dbe26e32f6d86c2990bd614d40a44e00c4f95861b7494656333ca6b6cd5d7e14a02135bb9396eacfe66bbe0000cf3ec671f76fa52a726f1499a69f4a77b6
+  metadata.gz: 8b4d553c7fe030956205058581ed1685a73fcdc1034c250e1c09ca29ef52637d8b85b10bb19edc93d334f0782e7b9a4d4fe4e88976d1f1174286e5f72ca866bb
+  data.tar.gz: bc6ec15cb5c3592df82e5af2682f690a5ee6649e8a1cf957786bf0886f3b0c3ad76ab6241b606d52380d47b3ccd17f4c7cda71b62b98198ce3470180ec07c753

data/.gitignore

@@ -53,4 +53,5 @@ build-iPhoneSimulator/
 .rvmrc
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
+# .rubocop-https?--*
+tmp-template-replace

data/.yardopts

@@ -2,6 +2,7 @@
 --no-private
 --markup markdown
 --tag flags:"Flags"
+--verbose
 -
 docs/*.md
 Changelog.md

data/Changelog.md

@@ -64,4 +64,13 @@
 
 ## 0.2.3
 
-- Fix: Fix critical error
+- Fix: Fix critical error
+
+## 0.2.4
+
+- Fix: Fix error in `Embed#image=`, `Embed#thumbnail=`
+
+## 0.2.5
+
+- Add: Add way to add event listener
+- Change: Move document to https://discorb-lib.github.io/

data/Gemfile

@@ -1,17 +1,17 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in discorb.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-group :debug, optional: true do
-  gem "rufo", "~> 0.13.0"
-end
-
-group :docs, optional: true do
-  gem "redcarpet"
-  gem "yard", "~> 0.9.26"
-end
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in discorb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :debug, optional: true do
+  gem "rufo", "~> 0.13.0"
+end
+
+group :docs, optional: true do
+  gem "redcarpet"
+  gem "yard", "~> 0.9.26"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.2.4)
+    discorb (0.2.5)
       async
       async-http
       async-websocket

data/README.md

@@ -1,5 +1,5 @@
 # discorb
-[![rubydoc](https://img.shields.io/badge/Document-rubydoc.info-blue.svg)](https://rubydoc.info/gems/discorb)
+[![Document](https://img.shields.io/badge/Document-discord--lib.github.io-blue.svg)](https://discorb-lib.github.io/)
 [![Gem](https://img.shields.io/gem/dt/discorb?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/discorb)
 [![Gem](https://img.shields.io/gem/v/discorb?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/discorb)
 [![Discord](https://img.shields.io/discord/863581274916913193?logo=discord&logoColor=fff&color=5865f2&label=Discord)](https://discord.gg/hCP6zq8Vpj)  

data/Rakefile

@@ -1,46 +1,159 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-task default: %i[]
-
-task :emoji_table do
-  require_relative "lib/discorb"
-
-  res = {}
-  Discorb::EmojiTable::DISCORD_TO_UNICODE.each do |discord, unicode|
-    res[unicode] ||= []
-    res[unicode] << discord
-  end
-
-  res_text = +""
-  res.each do |unicode, discord|
-    res_text << %(#{unicode.unpack("C*").pack("C*").inspect} => %w[#{discord.join(" ")}],\n)
-  end
-
-  table_script = File.read("lib/discorb/emoji_table.rb")
-
-  table_script.gsub!(/(?<=UNICODE_TO_DISCORD = {\n)[\s\S]+(?=}\.freeze)/, res_text)
-
-  File.open("lib/discorb/emoji_table.rb", "w") do |f|
-    f.print(table_script)
-  end
-  `rubocop -A lib/discorb/emoji_table.rb`
-  puts "Successfully made emoji_table.rb"
-end
-
-task :format do
-  Dir.glob("**/*.rb").each do |file|
-    next if file.start_with?("vendor")
-
-    puts "Formatting #{file}"
-    `rufo ./#{file}`
-    content = ""
-    File.open(file, "rb") do |f|
-      content = f.read
-    end
-    content.gsub!("\r\n", "\n")
-    File.open(file, "wb") do |f|
-      f.print(content)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]
+
+def get_version
+  require_relative "lib/discorb/common"
+  latest_commit = `git log --oneline`.force_encoding("utf-8").split("\n")[0]
+  version = Discorb::VERSION
+  unless latest_commit.downcase.include?("update version")
+    version += "-dev"
+  end
+  version
+end
+
+def gputs(text)
+  puts "\e[90m#{text}\e[m"
+end
+
+def sputs(text)
+  puts "\e[92m#{text}\e[m"
+end
+
+task :emoji_table do
+  require_relative "lib/discorb"
+
+  gputs "Building emoji_table.rb"
+  res = {}
+  Discorb::EmojiTable::DISCORD_TO_UNICODE.each do |discord, unicode|
+    res[unicode] ||= []
+    res[unicode] << discord
+  end
+
+  res_text = +""
+  res.each do |unicode, discord|
+    res_text << %(#{unicode.unpack("C*").pack("C*").inspect} => %w[#{discord.join(" ")}],\n)
+  end
+
+  table_script = File.read("lib/discorb/emoji_table.rb")
+
+  table_script.gsub!(/(?<=UNICODE_TO_DISCORD = {\n)[\s\S]+(?=}\.freeze)/, res_text)
+
+  File.open("lib/discorb/emoji_table.rb", "w") do |f|
+    f.print(table_script)
+  end
+  `rufo lib/discorb/emoji_table.rb`
+  sputs "Successfully made emoji_table.rb"
+end
+
+task :format do
+  Dir.glob("**/*.rb").each do |file|
+    next if file.start_with?("vendor")
+
+    gputs "Formatting #{file}"
+    `rufo ./#{file}`
+    content = ""
+    File.open(file, "rb") do |f|
+      content = f.read
+    end
+    content.gsub!("\r\n", "\n")
+    File.open(file, "wb") do |f|
+      f.print(content)
+    end
+  end
+end
+namespace :document do
+  version = get_version
+  task :yard do
+    sh "yardoc -o doc/#{version}"
+  end
+  namespace :replace do
+    require "fileutils"
+    task :css do
+      gputs "Replacing css"
+      Dir.glob("template-replace/files/**/*.*")
+        .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"
+    end
+    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"
+      gputs "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
+
+        content = File.read(f)
+        content.gsub!(/<!--od-->[\s\S]*<!--eod-->/, "")
+        File.write(f, content)
+      end
+      gputs "Adding version tab"
+      %w[file_list class_list method_list].each do |f|
+        replace_sidebar("doc/#{version}/#{f}.html")
+      end
+
+      gputs "Building version tab"
+      build_version_sidebar("doc/#{version}")
+      gputs "Replacing _index.html"
+      replace_index("doc/#{version}", version)
+      gputs "Replacing YARD credits"
+      yard_replace("doc/#{version}", version)
+      gputs "Successfully replaced htmls"
+    end
+    task :eol do
+      gputs "Replacing CRLF with LF"
+      Dir.glob("doc/**/*.*") do |file|
+        next unless File.file?(file)
+
+        content = ""
+        File.open(file, "rb") do |f|
+          content = f.read
+        end
+        content.gsub!("\r\n", "\n")
+        File.open(file, "wb") do |f|
+          f.print(content)
+        end
+      end
+      sputs "Successfully replaced CRLF with LF"
+    end
+  end
+  task :replace => %i[replace:css replace:html replace:eol]
+  task :build_all do
+    require "fileutils"
+    gputs "Building all versions"
+    FileUtils.cp_r("./template-replace/.", "./tmp-template-replace")
+    tags = `git tag`.force_encoding("utf-8").split("\n")
+    tags.each do |tag|
+      sh "git checkout #{tag} -f"
+      gputs "Building #{tag}"
+      FileUtils.cp_r("./tmp-template-replace/.", "./template-replace")
+      version = tag.delete_prefix("v")
+      Rake::Task["document:yard"].execute
+      Rake::Task["document:replace:html"].execute
+      Rake::Task["document:replace:css"].execute
+      Rake::Task["document:replace:eol"].execute
+    end
+    version = "."
+    Rake::Task["document:yard"].execute
+    Rake::Task["document:replace:html"].execute
+    Rake::Task["document:replace:css"].execute
+    Rake::Task["document:replace:eol"].execute
+    sh "git switch main -f"
+    sputs "Successfully built all versions"
+  end
+  task :push do
+    gputs "Pushing documents"
+    Dir.chdir("doc") do
+      sh "git add ."
+      sh "git commit -m \"Update: Update document\""
+      sh "git push -f"
+    end
+    sputs "Successfully pushed documents"
+  end
+end
+
+task :document => %i[document:yard document:replace]

data/crowdin.yml

@@ -0,0 +1,3 @@
+files:
+  - source: /po/yard.pot
+    translation: /po/%two_letters_code%.po

data/discorb.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/discorb-lib/discorb"
   spec.metadata["changelog_uri"] = "https://github.com/discorb-lib/discorb/blob/main/Changelog.md"
+  spec.metadata["documentation_uri"] = "https://discorb-lib.github.io"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/docs/application_command.md

@@ -10,7 +10,7 @@ From: [Discord API docs](https://discord.com/developers/docs/interactions/applic
 
 ## How do I register an application command?
 
-Use {Discorb::Command::Handler#slash}, {Discorb::Command::Handler#group} for slash commands, {Discorb::Command::Handler#user_command} for user menu commands, and {Discorb::Command::Handler#message_command} for message menu commands.
+Use {Discorb::Command::Handler.slash}, {Discorb::Command::Handler.slash_group} for slash commands, {Discorb::Command::Handler.user_command} for user menu commands, and {Discorb::Command::Handler.message_command} for message menu commands.
 
 ### Note
 
@@ -69,7 +69,7 @@ In `options`, hash should be like this:
 {
     "vocaloid" => {
         required: true,
-        description: "The vocaloid which you like."
+        description: "The vocaloid which you like.",
         type: :string,
         choices: {
             "Hatsune Miku" => "miku",
@@ -125,7 +125,7 @@ group.slash("bump_alert", "Whether bot should notify DISBOARD bump.", {
 end
 ```
 
-You can make subcommand group by using {Discorb::Command::GroupCommand#group}.
+You can make subcommand group by using {Discorb::Command::Command::GroupCommand#group}.
 
 ```ruby
 group = client.slash_group("permission", "Set/Get command permissions.")
@@ -211,7 +211,7 @@ client.user_command("hello") do |interaction, user|
   interaction.post("Hello, #{user.name}!")
 end
 ```
-{Discorb::Command::Handler#user_command} takes 3 arguments:
+{Discorb::Command::Handler.user_command} takes 3 arguments:
 
 | Parameter | Description |
 | --- | --- |
@@ -235,7 +235,7 @@ client.message_command("Bookmark") do |interaction, message|
 end
 ```
 
-{Discorb::Command::Handler#message_command} takes 3 arguments:
+{Discorb::Command::Handler.message_command} takes 3 arguments:
 
 | Parameter | Description |
 | --- | --- |
@@ -248,4 +248,4 @@ end
 | Parameter | Description |
 | --- | --- |
 | `interaction` | The interaction object. |
-| `message` | The message object. |
+| `message` | The message object. |

data/docs/discord_irb.md

@@ -18,7 +18,7 @@ To start.
 discord-irb will load a token from...
 1. the `DISCORD_BOT_TOKEN` environment variable
 2. the `DISCORD_TOKEN` environment variable
-3. `token` file in the current directory(customizable with `-f` option)
+3. `token` file in the current directory(customizable with `-t` option)
 4. your input
 
 ### Arguments

data/docs/events.md

@@ -5,8 +5,8 @@
 ## How to use events
 
 discorb uses event driven programming.
-You can register event handlers with {Client#on}.
-Alternatively, you can use {Client#once} to register a one-time event handler.
+You can register event handlers with {Discorb::Client#on}.
+Alternatively, you can use {Discorb::Client#once} to register a one-time event handler.
 
 ```ruby
 client.on :message do |event|
@@ -16,6 +16,20 @@ end
 
 This example will print the content of every message received.
 
+Since v0.2.5, you can also register event handlers by adding a method to the client, with the prefix `on_` and the event name as the method name.
+
+```ruby
+client = Discorb::Client.new
+
+class << client
+  def on_ready
+    puts "Ready!"
+  end
+end
+```
+
+If you want to seperate event handlers from the client, consider using {Discorb::Extension}. {file:docs/extension.md Learn more about extensions}.
+
 ## Event reference
 
 ### Client events
@@ -139,7 +153,7 @@ Fires when a webhook is updated.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`event`     | {Discorb::WebhooksUpdateEvent} | The webhook update event. |
+|`event`     | {Discorb::Gateway::WebhooksUpdateEvent} | The webhook update event. |
 
 #### `thread_new(thread)`
 
@@ -182,8 +196,8 @@ Fires when a thread's members are updated.
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
 |`thread`    | {Discorb::ThreadChannel} | The thread that the members were updated for. |
-|`added`     | Array<{ThreadChannel::Member}> | An array of {Discorb::ThreadChannel::Member} objects that were added to the thread. |
-|`removed`   | Array<{ThreadChannel::Member}> | An array of {Discorb::ThreadChannel::Member} objects that were removed from the thread. |
+|`added`     | Array<{Discorb::ThreadChannel::Member}> | An array of {Discorb::ThreadChannel::Member} objects that were added to the thread. |
+|`removed`   | Array<{Discorb::ThreadChannel::Member}> | An array of {Discorb::ThreadChannel::Member} objects that were removed from the thread. |
 
 #### `thread_member_update(before, after)`
 
@@ -258,7 +272,7 @@ This will fire when cached messages are deleted.
 #### `message_delete_id(message_id, channel, guild)`
 
 Fires when a message is deleted.
-Not like {#message_delete} this will fire even message is not cached.
+Not like {file:#message_delete} this will fire even message is not cached.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
@@ -280,7 +294,7 @@ Fires when a message is pinned or unpinned.
 
 | Parameter  | Type  | Description |
 | ---------- | ----- | ----------- |
-|`event`     | {Discorb::Gateway::MessagePinUpdateEvent}| The event object. |
+|`event`     | {Discorb::Gateway::MessagePinEvent}| The event object. |
 
 #### `typing_start(event)`