discorb 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27fc8b1d9e527f2ce007c686025f4edc9ca7ee8dda06df91ff48a02034a1dbf
-  data.tar.gz: 7708d124bd2921941164e178c35714b3cf7d68f19b202a823bc9913688c35495
+  metadata.gz: 4f5c9c3f2c3e472300d1fe8462b9e667008bce0a30d11b2ce6cf866f697aedb0
+  data.tar.gz: d2c2fa2edd51a84a1001675d0572bfae3464f5d25b85865a95a7c7f5daebf109
 SHA512:
-  metadata.gz: 8b4d553c7fe030956205058581ed1685a73fcdc1034c250e1c09ca29ef52637d8b85b10bb19edc93d334f0782e7b9a4d4fe4e88976d1f1174286e5f72ca866bb
-  data.tar.gz: bc6ec15cb5c3592df82e5af2682f690a5ee6649e8a1cf957786bf0886f3b0c3ad76ab6241b606d52380d47b3ccd17f4c7cda71b62b98198ce3470180ec07c753
+  metadata.gz: ed4bb639464a3adc7a5982088149421d6d15f7e3c4be37bb59855a5d106ee5a1e1756b10ba401fd3d3ced9008c15e99bb3967f93eb7ff197903fb6cf95e19699
+  data.tar.gz: fc6809db6b8e7a7e65e70fb49ce3b25a2aa4f42145477730e234511a95f278879759d76f5ee9547fa213f34ce3c413f5ba167c7f042d7f73a954718ba22e51d4

data/.yardopts

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    discorb (0.2.5)
+    discorb (0.3.0)
       async
       async-http
       async-websocket
@@ -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)

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.
+discorb irb is a command line tool for interacting with the Discord API.
 
 
 ## 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)

data/docs/cli.md

@@ -0,0 +1,20 @@
+# @title CLI tools
+
+# CLI tools
+
+discorb has a CLI tool for developing.
+
+## Usage
+
+```bash
+bundle exec discorb <command> ...
+```
+
+## Commands
+
+Currently, discorb has the following commands:
+
+| Command | Description |
+|---------|-------------|
+| {file:docs/cli/init.md `init`} | Create a new project. |
+| {file:docs/cli/irb.md `irb`} | Start an interactive Ruby shell with connected client. |

data/exe/discorb

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby
+
+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") }
+  scripts = {}
+  Dir.glob(discorb_path + "/discorb/exe/*.rb") do |script|
+    name = File.basename(script, ".rb")
+    description = File.read(script).match(/# description: (.+)/)&.[](1) || "No description"
+    scripts[name] = description
+  end
+  max_length = scripts.keys.map { |key| key.length }.max
+  scripts.sort.each do |name, description|
+    puts "\e[90m#{name.rjust(max_length)}\e[m - #{description}"
+  end
+
+  exit 1
+end
+
+begin
+  require "discorb/exe/#{script}"
+rescue LoadError
+  puts "\e[91mThis tool is not available: \e[90m#{script}\e[m"
+  exit 1
+end

data/lib/discorb/audit_logs.rb

@@ -279,6 +279,9 @@ module Discorb
           @new_value = data[:new_value].then(&method)
         end
 
+        #
+        # Send a message to the new value.
+        #
         def method_missing(method, ...)
           @new_value.__send__(method, ...)
         end

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://github.com/discorb-lib/discorb #{VERSION}) Ruby/#{RUBY_VERSION}"
 

data/lib/discorb/dictionary.rb

@@ -93,6 +93,9 @@ module Discorb
       !self[id].nil?
     end
 
+    #
+    # Send a message to the array of values.
+    #
     def method_missing(name, ...)
       if values.respond_to?(name)
         values.send(name, ...)

data/lib/discorb/exe/init.rb

@@ -0,0 +1,185 @@
+# description: Make files for the discorb project.
+
+require "optparse"
+require_relative "../utils/colored_puts"
+
+$path = Dir.pwd
+
+FILES = {
+  "main.rb" => <<~'RUBY',
+    require "discorb"
+    require "dotenv"
+
+    Dotenv.load
+
+    client = Discorb::Client.new
+
+    client.once :ready do
+      puts "Logged in as #{client.user}"
+    end
+
+    client.run ENV["%<token>s"]
+  RUBY
+  ".env" => <<~BASH,
+    %<token>s=Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng
+  BASH
+  ".gitignore" => <<~GITIGNORE,
+    *.gem
+    *.rbc
+    /.config
+    /coverage/
+    /InstalledFiles
+    /pkg/
+    /spec/reports/
+    /spec/examples.txt
+    /test/tmp/
+    /test/version_tmp/
+    /tmp/
+    
+    # Used by dotenv library to load environment variables.
+    .env
+    
+    # Ignore Byebug command history file.
+    .byebug_history
+    
+    ## Specific to RubyMotion:
+    .dat*
+    .repl_history
+    build/
+    *.bridgesupport
+    build-iPhoneOS/
+    build-iPhoneSimulator/
+    
+    ## Specific to RubyMotion (use of CocoaPods):
+    #
+    # We recommend against adding the Pods directory to your .gitignore. However
+    # you should judge for yourself, the pros and cons are mentioned at:
+    # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+    #
+    # vendor/Pods/
+    
+    ## Documentation cache and generated files:
+    /.yardoc/
+    /_yardoc/
+    /doc/
+    /rdoc/
+    
+    ## Environment normalization:
+    /.bundle/
+    /vendor/bundle
+    /lib/bundler/man/
+    
+    # for a library or gem, you might want to ignore these files since the code is
+    # intended to run in multiple environments; otherwise, check them in:
+    # Gemfile.lock
+    # .ruby-version
+    # .ruby-gemset
+    
+    # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+    .rvmrc
+    
+    # Used by RuboCop. Remote config files pulled in from inherit_from directive.
+    # .rubocop-https?--*
+
+    # This gitignore is from github/gitignore.
+    # https://github.com/github/gitignore/blob/master/Ruby.gitignore
+  GITIGNORE
+}
+
+def make_files
+  iputs "Making files..."
+  FILES.each do |file, content|
+    File.write($path + "/#{file}", format(content, token: $values[:token]), mode: "wb")
+  end
+  sputs "Made files.\n"
+end
+
+def bundle_init
+  iputs "Initializing bundle..."
+  File.write($path + "/Gemfile", <<~'RUBY', mode: "wb")
+    # frozen_string_literal: true
+
+    source "https://rubygems.org"
+
+    git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+    gem "discorb", "~> 0.2.5"
+    gem "dotenv", "~> 2.7"
+  RUBY
+  iputs "Installing gems..."
+  system "bundle install"
+  sputs "Installed gems.\n"
+end
+
+def git_init
+  iputs "Initializing git repository..."
+  system "git init"
+  system "git add ."
+  system "git commit -m \"Initial commit\""
+  sputs "Initialized repository, use " +
+          "\e[32mgit commit --amend -m '...'\e[92m" +
+          " to change commit message of initial commit.\n"
+end
+
+opt = OptionParser.new <<~BANNER
+                         A tool to make a new project.
+
+                         Usage: discorb init [options] [dir]
+
+                                   dir                        The directory to make the files in.
+                       BANNER
+
+$values = {
+  bundle: true,
+  git: true,
+  force: false,
+  token: "TOKEN",
+}
+
+opt.on("--[no-]bundle", "Whether to use bundle. Default to true.") do |v|
+  $values[:bundle] = v
+end
+
+opt.on("--[no-]git", "Whether to initialize git. Default to true.") do |v|
+  $values[:git] = v
+end
+
+opt.on("-t NAME", "--token NAME", "The name of token environment variable. Default to TOKEN.") do |v|
+  $values[:token] = v
+end
+
+opt.on("-f", "--force", "Whether to force use directory. Default to false.") do |v|
+  $values[:force] = v
+end
+
+ARGV.delete_at(0)
+
+opt.parse!(ARGV)
+
+if (dir = ARGV[0])
+  $path += "/#{dir}"
+  if Dir.exist?($path)
+    if Dir.empty?($path)
+      gputs "Found \e[30m#{dir}\e[90m and empty, using this directory."
+    else
+      if $values[:force]
+        gputs "Found \e[30m#{dir}\e[90m and not empty, but force is on, using this directory."
+      else
+        eputs "Directory \e[31m#{dir}\e[91m already exists and not empty. Use \e[31m-f\e[91m to force."
+        exit
+      end
+    end
+  else
+    Dir.mkdir($path)
+    gputs "Couldn't find \e[30m#{dir}\e[90m, created directory."
+  end
+  Dir.chdir($path)
+end
+
+bundle_init if $values[:bundle]
+
+make_files
+
+git_init if $values[:git]
+
+sputs "\nSuccessfully made a new project at \e[32m#{$path}\e[92m."

data/{exe/discord-irb → lib/discorb/exe/irb.rb}

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# description: Connect to discord and start IRB.
+
 require "io/console"
 require "discorb"
 require "optparse"

data/lib/discorb/flag.rb

@@ -25,6 +25,9 @@ module Discorb
       end
     end
 
+    #
+    # Returns the value of the flag.
+    #
     def method_missing(name, args = nil)
       if @values.key?(name.to_s.delete_suffix("?").to_sym)
         @values[name.to_s.delete_suffix("?").to_sym]

data/lib/discorb/intents.rb

@@ -75,6 +75,9 @@ module Discorb
       }
     end
 
+    #
+    # (see Flag#method_missing)
+    #
     def method_missing(name, args = nil)
       if @raw_value.key?(name)
         @raw_value[name]

data/lib/discorb/permission.rb

@@ -229,6 +229,9 @@ module Discorb
       end
     end
 
+    #
+    # (see Flag#method_missing)
+    #
     def method_missing(method, bool = nil)
       if self.class.bits.key?(method)
         self[method]

data/lib/discorb/utils/colored_puts.rb

@@ -0,0 +1,11 @@
+def sputs(text)
+  puts "\e[92m#{text}\e[m"
+end
+
+def eputs(text)
+  puts "\e[91m#{text}\e[m"
+end
+
+def iputs(text)
+  puts "\e[90m#{text}\e[m"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discorb
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - sevenc-nanashi
@@ -70,7 +70,7 @@ description:
 email:
 - sevenc-nanashi@sevenbot.jp
 executables:
-- discord-irb
+- discorb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -88,7 +88,9 @@ files:
 - discorb.gemspec
 - docs/Examples.md
 - docs/application_command.md
-- docs/discord_irb.md
+- docs/cli.md
+- docs/cli/init.md
+- docs/cli/irb.md
 - docs/events.md
 - docs/extension.md
 - docs/voice_events.md
@@ -103,7 +105,7 @@ files:
 - examples/simple/ping_pong.rb
 - examples/simple/rolepanel.rb
 - examples/simple/wait_for_message.rb
-- exe/discord-irb
+- exe/discorb
 - lib/discorb.rb
 - lib/discorb/application.rb
 - lib/discorb/asset.rb
@@ -120,6 +122,8 @@ files:
 - lib/discorb/emoji_table.rb
 - lib/discorb/error.rb
 - lib/discorb/event.rb
+- lib/discorb/exe/init.rb
+- lib/discorb/exe/irb.rb
 - lib/discorb/extend.rb
 - lib/discorb/extension.rb
 - lib/discorb/file.rb
@@ -145,6 +149,7 @@ files:
 - lib/discorb/sticker.rb
 - lib/discorb/user.rb
 - lib/discorb/utils.rb
+- lib/discorb/utils/colored_puts.rb
 - lib/discorb/voice_state.rb
 - lib/discorb/webhook.rb
 - po/yard.pot