discorb 0.2.3 → 0.3.1

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

@@ -1,24 +1,22 @@
-# @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 `-f` option)
+3. `token` file in the current directory(customizable with `-t` option)
 4. your input
 
 ### Arguments

data/docs/cli.md

@@ -0,0 +1,21 @@
+# @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. |
+| `show` | Show your environment. |

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)`
 

data/docs/extension.md

@@ -18,7 +18,7 @@ end
 
 ## Register Event
 
-Use {Extension#event} to register event, or {Extension#once_event} to register event only once.
+Use {Discorb::Extension.event} to register event, or {Discorb::Extension.once_event} to register event only once.
 
 ```ruby
 module MyExtension
@@ -36,11 +36,23 @@ end
 
 ## Load extension
 
-Use {Client#extend} to load extension.
+Use {Discorb::Client#extend} to load extension.
+
+```ruby
+module MyExtension
+  extend Discorb::Extension
+
+  event :message do |message|
+    # ...
+  end
+end
+
+client.extend MyExtension
+```
 
 ## Access Client from extension
 
-You can access {Client} from extension with `@client`.
+You can access {Discorb::Client} from extension with `@client`.
 
 ```ruby
 module MyExtension

data/examples/commands/inspect.rb

@@ -18,7 +18,7 @@ client.user_command("Info", guild_ids: [857373681096327180]) do |interaction|
                      ],
                      thumbnail: interaction.target.avatar&.url,
 
-                   ), hide: true)
+                   ), ephemeral: true)
 end
 
 client.run(ENV["DISCORD_BOT_TOKEN"])

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/client.rb

@@ -155,15 +155,27 @@ module Discorb
             end
           end
         end
-        if @events[event_name].nil?
+        events = @events[event_name].dup || []
+        if respond_to?("on_" + event_name.to_s)
+          event_method = method("on_" + event_name.to_s)
+          class << event_method
+            def id
+              "method"
+            end
+          end
+          events << event_method
+        end
+        if events.nil?
           @log.debug "Event #{event_name} doesn't have any proc, skipping"
           next
         end
         @log.debug "Dispatching event #{event_name}"
-        @events[event_name].each do |block|
+        events.each do |block|
           lambda { |event_args|
             Async(annotation: "Discorb event: #{event_name}") do |task|
-              @events[event_name].delete(block) if block.discriminator[:once]
+              if block.is_a?(Discorb::Event)
+                @events[event_name].delete(block) if block.discriminator[:once]
+              end
               block.call(*event_args)
               @log.debug "Dispatched proc with ID #{block.id.inspect}"
             rescue StandardError, ScriptError => e

data/lib/discorb/color.rb

@@ -169,5 +169,6 @@ module Discorb
     end
   end
 
+  # @return [Class] The alias of `Discorb::Color`.
   Colour = Color
 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.3"
+  VERSION = "0.3.1"
   # @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/embed.rb

@@ -79,11 +79,11 @@ module Discorb
     end
 
     def image=(value)
-      @image = value.is_a? String ? Image.new(value) : value
+      @image = (value.is_a?(String)) ? Image.new(value) : value
     end
 
     def thumbnail=(value)
-      @thumbnail = value.is_a? String ? Thumbnail.new(value) : value
+      @thumbnail = (value.is_a?(String)) ? Thumbnail.new(value) : value
     end
 
     #

data/lib/discorb/exe/init.rb

@@ -0,0 +1,195 @@
+# description: Make files for the discorb project.
+
+require "optparse"
+require_relative "../utils/colored_puts"
+
+$path = Dir.pwd
+
+# @!visibility private
+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
+  "Gemfile" => <<~RUBY,
+    # 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
+}
+
+# @!visibility private
+def create_file(name)
+  File.write($path + "/#{name}", format(FILES[name], token: $values[:token]), mode: "wb")
+end
+
+# @!visibility private
+def make_files
+  iputs "Making files..."
+  create_file("main.rb")
+  create_file(".env")
+  sputs "Made files.\n"
+end
+
+# @!visibility private
+def bundle_init
+  iputs "Initializing bundle..."
+  create_file("Gemfile")
+  iputs "Installing gems..."
+  system "bundle install"
+  sputs "Installed gems.\n"
+end
+
+# @!visibility private
+def git_init
+  create_file(".gitignore")
+  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."