discorb 0.2.5 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27fc8b1d9e527f2ce007c686025f4edc9ca7ee8dda06df91ff48a02034a1dbf
-  data.tar.gz: 7708d124bd2921941164e178c35714b3cf7d68f19b202a823bc9913688c35495
+  metadata.gz: e88541a1d18a1ebd262bae5d91bb38c02d91350e1b2cf698c3f491bf58bb5cfa
+  data.tar.gz: dc55e68bea5b74105eb941c8ec50bec6fa6f4bf3dd716a1e505ea6c3ab598725
 SHA512:
-  metadata.gz: 8b4d553c7fe030956205058581ed1685a73fcdc1034c250e1c09ca29ef52637d8b85b10bb19edc93d334f0782e7b9a4d4fe4e88976d1f1174286e5f72ca866bb
-  data.tar.gz: bc6ec15cb5c3592df82e5af2682f690a5ee6649e8a1cf957786bf0886f3b0c3ad76ab6241b606d52380d47b3ccd17f4c7cda71b62b98198ce3470180ec07c753
+  metadata.gz: 5c5d884643656bca43b2ee1e448c0860f0235f439875cbad59a89c79b5d98c71d7b3f539ab6150a051b262ebb09551cf8f943c090676f0751d5533596bc5aea8
+  data.tar.gz: d4ddfe0faa3c4cdcbc14293216c13017d4c64b7c0f4594e44d5ddb9ab7b9b60ddb4f5acc8a4d06eaec8d1f5e504b13fd43c4f3bc898d787976c617c7509a15dc

data/.github/workflows/build_main.yml

@@ -0,0 +1,51 @@
+name: Build YARD with main
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "*/8 * * * *"
+
+jobs:
+  main:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.2
+          bundler-cache: true
+      - name: Set up git settings
+        run: |
+          git config --global user.email "action@github.com"
+          git config --global user.name "GitHub Action"
+      - name: Clone pages
+        env:
+          SSH_SECRET: ${{ secrets.SSH }}
+          GIT_SSH_COMMAND: ssh -i ~/ssh_secret
+        run: |
+          echo "$SSH_SECRET" > ~/ssh_secret
+          chmod 600 ~/ssh_secret
+          git clone git@github.com:discorb-lib/discorb-lib.github.io /tmp/pages
+      - name: Install dependencies
+        run: |
+          bundle config --local with 'docs'
+          bundle install
+      - name: Generate document
+        run: bundle exec rake document
+      - name: Push document
+        env:
+          SSH_SECRET: ${{ secrets.SSH }}
+          GIT_SSH_COMMAND: ssh -i ~/ssh_secret
+        run: |
+          echo "$SSH_SECRET" > ~/ssh_secret
+          chmod 600 ~/ssh_secret
+          cp -r ./doc/. /tmp/pages
+          cd /tmp/pages
+          git add -A
+          git commit -m "Update: Update document for ${{ github.sha }} by cron"
+          git update-ref -d refs/remotes/origin/user
+          git push origin main -f
+        continue-on-error: true

data/.gitignore

@@ -35,7 +35,7 @@ build-iPhoneSimulator/
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
-/doc/
+# /doc/
 /rdoc/
 
 ## Environment normalization:
@@ -54,4 +54,8 @@ build-iPhoneSimulator/
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+
+# For documentation generation.
 tmp-template-replace
+tmp-doc
+doc

data/.yardopts

@@ -4,5 +4,5 @@
 --tag flags:"Flags"
 --verbose
 -
-docs/*.md
+docs/**/*.md
 Changelog.md

data/Changelog.md

@@ -73,4 +73,25 @@
 ## 0.2.5
 
 - Add: Add way to add event listener
-- Change: Move document to https://discorb-lib.github.io/
+- Change: Move document to https://discorb-lib.github.io/
+
+## 0.3.0
+
+- Add: Improve CLI tools
+- Add: Add `discorb init`
+- Change: Change `discord-irb` to `discorb irb`
+  
+## 0.3.1
+
+- Add: Add `discorb show`
+- Fix: Fix documenting
+
+## 0.4.0
+
+- Add: Add `discorb setup`
+- Add: Add `discorb run`
+- Add: Add realtime documentation
+
+## 0.4.1
+
+- Add: Add `-s` option to `discorb run`

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    discorb (0.2.5)
-      async
-      async-http
-      async-websocket
+    discorb (0.4.1)
+      async (~> 1.30.1)
+      async-http (~> 0.56.5)
+      async-websocket (~> 0.19.0)
       mime-types (~> 3.3)
 
 GEM
@@ -34,11 +34,11 @@ GEM
     fiber-local (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0704)
-    nio4r (2.5.7)
+    mime-types-data (3.2021.0901)
+    nio4r (2.5.8)
     protocol-hpack (1.4.2)
     protocol-http (0.22.5)
-    protocol-http1 (0.14.1)
+    protocol-http1 (0.14.2)
       protocol-http (~> 0.22)
     protocol-http2 (0.14.2)
       protocol-hpack (~> 1.4)
@@ -54,6 +54,7 @@ GEM
 
 PLATFORMS
   x86-mingw32
+  x86_64-linux
 
 DEPENDENCIES
   discorb!

data/Rakefile

@@ -1,30 +1,26 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require_relative "lib/discorb/utils/colored_puts"
 task default: %i[]
 
+# @!visibility private
 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"
+  tag = `git tag --points-at HEAD`.force_encoding("utf-8").strip
+  if tag.empty?
+    version = "main"
+  else
+    version = Discorb::VERSION
   end
   version
 end
 
-def gputs(text)
-  puts "\e[90m#{text}\e[m"
-end
-
-def sputs(text)
-  puts "\e[92m#{text}\e[m"
-end
-
+desc "Build emoji_table.rb"
 task :emoji_table do
   require_relative "lib/discorb"
 
-  gputs "Building emoji_table.rb"
+  iputs "Building emoji_table.rb"
   res = {}
   Discorb::EmojiTable::DISCORD_TO_UNICODE.each do |discord, unicode|
     res[unicode] ||= []
@@ -47,11 +43,12 @@ task :emoji_table do
   sputs "Successfully made emoji_table.rb"
 end
 
+desc "Format files"
 task :format do
   Dir.glob("**/*.rb").each do |file|
     next if file.start_with?("vendor")
 
-    gputs "Formatting #{file}"
+    iputs "Formatting #{file}"
     `rufo ./#{file}`
     content = ""
     File.open(file, "rb") do |f|
@@ -63,27 +60,37 @@ task :format do
     end
   end
 end
+
+desc "Generate document and replace"
 namespace :document do
   version = get_version
+
+  desc "Just generate document"
   task :yard do
-    sh "yardoc -o doc/#{version}"
+    sh "bundle exec yardoc -o doc/#{version}"
   end
+
+  desc "Replace files"
   namespace :replace do
     require "fileutils"
+
+    desc "Replace CSS"
     task :css do
-      gputs "Replacing css"
+      iputs "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
+
+    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"
-      gputs "Resetting changes"
+      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
 
@@ -91,21 +98,23 @@ namespace :document do
         content.gsub!(/<!--od-->[\s\S]*<!--eod-->/, "")
         File.write(f, content)
       end
-      gputs "Adding version tab"
+      iputs "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"
+      iputs "Building version tab"
+      build_version_sidebar("doc/#{version}", version)
+      iputs "Replacing _index.html"
       replace_index("doc/#{version}", version)
-      gputs "Replacing YARD credits"
+      iputs "Replacing YARD credits"
       yard_replace("doc/#{version}", version)
-      gputs "Successfully replaced htmls"
+      iputs "Successfully replaced htmls"
     end
+
+    desc "Replace EOL"
     task :eol do
-      gputs "Replacing CRLF with LF"
+      iputs "Replacing CRLF with LF"
       Dir.glob("doc/**/*.*") do |file|
         next unless File.file?(file)
 
@@ -122,20 +131,36 @@ namespace :document do
     end
   end
   task :replace => %i[replace:css replace:html replace:eol]
+
+  desc "Build all versions"
   task :build_all do
     require "fileutils"
-    gputs "Building all versions"
+
+    class Bundler::Definition
+      def validate_platforms!
+        # noop
+      end
+    end
+
+    iputs "Building all versions"
+    FileUtils.rm_rf("doc") rescue nil
     FileUtils.cp_r("./template-replace/.", "./tmp-template-replace")
+    Rake::Task["document:yard"].execute
+    Rake::Task["document:replace:html"].execute
+    Rake::Task["document:replace:css"].execute
+    Rake::Task["document:replace:eol"].execute
     tags = `git tag`.force_encoding("utf-8").split("\n")
     tags.each do |tag|
       sh "git checkout #{tag} -f"
-      gputs "Building #{tag}"
+      iputs "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
+      FileUtils.cp_r("./doc/.", "./tmp-doc")
+      FileUtils.rm_rf("doc")
     end
     version = "."
     Rake::Task["document:yard"].execute
@@ -143,11 +168,19 @@ namespace :document do
     Rake::Task["document:replace:css"].execute
     Rake::Task["document:replace:eol"].execute
     sh "git switch main -f"
+    FileUtils.cp_r("./tmp-doc/.", "./doc")
     sputs "Successfully built all versions"
+  rescue => e
+    sh "git switch main -f"
+    raise e
   end
+
+  desc "Push to discorb-lib/discorb-lib.github.io"
   task :push do
-    gputs "Pushing documents"
+    iputs "Pushing documents"
     Dir.chdir("doc") do
+      sh "git init"
+      sh "git remote add origin git@github.com:discorb-lib/discorb-lib.github.io"
       sh "git add ."
       sh "git commit -m \"Update: Update document\""
       sh "git push -f"

data/discorb.gemspec

@@ -17,7 +17,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["changelog_uri"] = "https://discorb-lib.github.io/file.Changelog.html"
   spec.metadata["documentation_uri"] = "https://discorb-lib.github.io"
 
   # Specify which files should be added to the gem when it is released.
@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "async"
-  spec.add_dependency "async-http"
-  spec.add_dependency "async-websocket"
+  spec.add_dependency "async", "~> 1.30.1"
+  spec.add_dependency "async-http", "~> 0.56.5"
+  spec.add_dependency "async-websocket", "~> 0.19.0"
 
   spec.add_dependency "mime-types", "~> 3.3"
   # For more information and examples about making a new gem, checkout our

data/docs/application_command.md

@@ -10,7 +10,13 @@ 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.slash_group} for slash commands, {Discorb::Command::Handler.user_command} for user menu commands, and {Discorb::Command::Handler.message_command} for message menu commands.
+Write to a your script:
+- {Discorb::Command::Handler.slash}, {Discorb::Command::Handler.slash_group} for slash commands,
+- {Discorb::Command::Handler.user_command} for user menu commands,
+- {Discorb::Command::Handler.message_command} for message menu commands.
+
+And then run `discorb setup` to register your application commands.
+{file:docs/cli/setup.md Learn more about `discorb setup`}. 
 
 ### Note
 

data/docs/cli/init.md

@@ -0,0 +1,55 @@
+# @title CLI: discorb init
+
+# discorb init
+
+This command will create a new project in the directory.
+
+## Usage
+
+```bash
+discorb init [options] [dir]
+```
+
+## Options
+
+### `dir`
+
+The directory to create the project in.
+Defaults to the current directory.
+If the directory exists and is not empty, an error is returned.
+You can use `--force` to overwrite an existing directory.
+
+### `--[no-]bundle`
+
+Whether to use bundle.
+If true, the command will create Gemfile and execute `bundle install`.
+Default to true.
+
+### `--[no-]git`
+
+Whether to initialize git.
+If true, the command will initialize git and commit the initial files with commit message `Initial commit`.
+Use `git commit --amend -m "..."` to change the commit message.
+Default to true.
+
+### `-t`, `--token`
+
+The name of token environment variable.
+Default to TOKEN.
+
+### `-f`, `--force`
+
+Whether to overwrite an existing directory.
+Default to false.
+
+## File structure
+
+The following files will be created:
+
+| File | Description |
+| ---- | ----------- |
+| `.env` | Environment variables. |
+| `.gitignore` | Git ignore file. Won't be created if `--git` is false. |
+| `Gemfile` | Gemfile. Won't be created if `--bundle` is false. |
+| `Gemfile.lock` | Gemfile lock file. Won't be created if `--bundle` is false. |
+| `main.rb` | Main script. |

data/docs/{discord_irb.md → cli/irb.md}

@@ -1,21 +1,19 @@
-# @title discord-irb
+# @title CLI: discorb irb
 
-# discord-irb
+# discorb irb
 
-discord-irb is a command line tool for interacting with the Discord API.
+This command will start an interactive Ruby shell with connected client.
 
 
 ## Usage
 
 ```
-$ bundle exec discord-irb
+discorb irb [options]
 ```
 
-To start.
-
 ### Load a token
 
-discord-irb will load a token from...
+discorb 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 `-t` option)