discorb 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48ed0b82cf398970b54454d1d41f60e8fdf55fb6d5499f1e55a54769d61bc954
-  data.tar.gz: 5aae36deb140de42e2ff94249f61aa346856682ae27de444eb2aadc8a0b29591
+  metadata.gz: 26ef2cd9945ad11a9816b4ece328391c265b8f59f8b9a67e66326e21414f083c
+  data.tar.gz: 06662ff1518386e95e615afffc6b8338cb9e337bb0dc36c66f6d1d79fd7a01e8
 SHA512:
-  metadata.gz: 3cc6e43128c370e30e6d16b6a19ec88be33a848e56a112981a6f272146d3506222f2240d55edb359e2d1d60f64b002841e37de5b52aa5142d837bddf75afcf5f
-  data.tar.gz: 3cf2390626afa7eb22ac3d906e9915ba2e4cee75e40a3d6dc9bbf25b5d00db0bd693ae2c7d1798a8811ea2c57475ab90e9825ffb3ceb762e415167a80bb9f192
+  metadata.gz: 83ddc5818285d4ed50e08998446a5fa9763cffe9c0a1992a70085af38a323e304851ca4dd77f43a8108e4ece850f097eaca9dc119b83c9bdb9a66e5c32b40f5a
+  data.tar.gz: 8a409f031d896344586bb2001019b9431299683a99df36f090f3a0da748d08bd6b4f2191c0a32823106d5b3b0cd6d22624106367d8e4adc400acf430ddb60370

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

@@ -3,6 +3,7 @@
 --markup markdown
 --tag flags:"Flags"
 --verbose
+--asset docs/assets:assets
 -
 docs/**/*.md
 Changelog.md

data/Changelog.md

@@ -73,4 +73,36 @@
 ## 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`
+  
+## 0.4.2
+
+- Fix: Fix error in `discorb run`
+  
+## 0.5.0
+
+- Change: Use zlib stream instead
+- Add: Add tutorials
+- Add: Add ratelimit handler
+- Change: Make `--git` option in `discorb init` false

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    discorb (0.3.1)
-      async
-      async-http
-      async-websocket
+    discorb (0.5.0)
+      async (~> 1.30.1)
+      async-http (~> 0.56.5)
+      async-websocket (~> 0.19.0)
       mime-types (~> 3.3)
 
 GEM
@@ -54,6 +54,7 @@ GEM
 
 PLATFORMS
   x86-mingw32
+  x86_64-linux
 
 DEPENDENCIES
   discorb!

data/Rakefile

@@ -7,10 +7,11 @@ 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
@@ -19,7 +20,7 @@ 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,7 +48,7 @@ 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|
@@ -66,7 +67,7 @@ namespace :document do
 
   desc "Just generate document"
   task :yard do
-    sh "yardoc -o doc/#{version}"
+    sh "bundle exec yardoc -o doc/#{version}"
   end
 
   desc "Replace files"
@@ -75,7 +76,7 @@ namespace :document do
 
     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}")
@@ -89,7 +90,7 @@ namespace :document do
       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
 
@@ -97,25 +98,26 @@ 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)
+        next unless %w[html css js].include? file.split(".").last
 
         content = ""
         File.open(file, "rb") do |f|
@@ -134,18 +136,32 @@ namespace :document do
   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
@@ -153,13 +169,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

@@ -30,7 +30,7 @@ Default to true.
 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.
+Default to false.
 
 ### `-t`, `--token`
 

data/docs/cli/irb.md

@@ -2,7 +2,7 @@
 
 # discorb irb
 
-discorb irb is a command line tool for interacting with the Discord API.
+This command will start an interactive Ruby shell with connected client.
 
 
 ## Usage

data/docs/cli/run.md

@@ -0,0 +1,46 @@
+# @title CLI: discorb run
+
+# discorb run
+
+This command will run a client.
+
+
+## Usage
+
+```
+discorb run [options] [script]
+```
+
+### Arguments
+
+#### `script`
+
+The script to run. Defaults to `main.rb`.
+
+#### `-d`, `--deamon`
+
+Run the client in deamon mode.
+
+#### `-l`, `--log-level`
+
+Specify the log level.
+Should be one of the following:
+
+* `none`
+* `debug`
+* `info`
+* `warn`
+* `error`
+* `fatal`
+
+#### `-f`, `--log-file`
+
+Specify the file to write logs to.
+You can use `stdout` to write to the standard output, and `stderr` to write to the standard error.
+
+#### `-c`, `--[no-]log-color`
+
+Whether to colorize the log output.
+If not specified, the default will be:
+- `true` if the file to write logs to is `stdout` or `stderr`.
+- `false` otherwise.

data/docs/cli/setup.md

@@ -0,0 +1,17 @@
+# @title CLI: discorb setup
+
+# discorb setup
+
+This command will setup application commands.
+
+## Usage
+
+```
+discorb setup [script]
+```
+
+### Arguments
+
+#### `script`
+
+The script to setup. Defaults to `main.rb`.