commandorobo 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc21ecf86acf9004a016400ba93306630de2e3633123fdfd5164804babe03f2a
-  data.tar.gz: 7fb4cd8a5002b3389db1749d143e70401e1a4e39eb8f8e432d7da69e421d20ee
+  metadata.gz: c27daac909e3282e3e0afaddba356195f63a5caee2278bb0e5fcb2d45078b5fa
+  data.tar.gz: 969c5f78d351e2eac02c4adf32918bccd2f04b8ce48d1e5e5162212ee47532f2
 SHA512:
-  metadata.gz: dba076b5a961c2fa96af5fe2b020246937455d54b76eb66616ee60de5b0b0792129dd69e2fef13081f17dd8e8435c95c2ff508c5134d898275b4f03751042358
-  data.tar.gz: 933e239dc5e06c18c965fec1ee21bb8527034c4eb926f72e4e59633d9ffda9031924cc42c252d36cb5a95e5f57b717a7c903b398b0d3fc43dc41f746c54fb8eb
+  metadata.gz: 18ef66d68cdf00c9c20c559ca7b0d3ab85b2da5bc52cadb414752e76982c73157f00b7d288dba6bd25888d0c5a78eaa36da0ac0e14cb1b069849e46bf10facb8
+  data.tar.gz: f619413c4e914164ebab4725345e4724ffe8ab46e7ba905232cbf6590196c4010f56f4a7e02afa548641363bbc6ba2e5a0690d7b7b0d7a19d9223879b54ace1f

data/lib/commandorobo.rb

@@ -6,23 +6,31 @@ require 'discordrb'
 require_relative './constants.rb'
 require_relative './util.rb'
 
+# A discordrb command framework
 module Commandorobo
     include Constants
     include Utils
 
+    # Class that gets returned by Command#perm_check whenever the user does not have permission.
+    # @attr_reader [Array] perm The permissions returned as an array of symbols.
     class NoPermission
         attr_reader :perm
         def initialize(perm)
             @perm = perm
         end
 
-        def prettify # OH GOD PLEASE HELP ME
+        # Generates a "pretty" array of strings for permissions.
+        # @return [Array] An array of strings representing the pretty name for permissions.
+        def prettify
             @perm.map do |t| # <hackiness>
-                t.to_s.split(/_/).map(&:capitalize).join(' ')
+                t.to_s.split(/_/).map(&:capitalize)
             end # </hackiness>
         end
     end
 
+    # Class to represent an invoker (prefix, suffix).
+    # @attr_reader [String] value The value of the invoker.
+    # @attr_reader [Symbol] type The type of the invoker.
     class Invoker
         attr_reader :value, :type
         def initialize(val, type, **kwargs)
@@ -36,6 +44,9 @@ module Commandorobo
             @type = type
         end
 
+        # Internal - checks to see if regexes match.
+        # @param [String] text The text to check.
+        # @raise [RuntimeError] The invoker wasn't a regex.
         def match(text)
             if @type != :regex
                 raise "Incorrect type for function."
@@ -43,7 +54,9 @@ module Commandorobo
             return @value.match(text)
         end
 
-        def extrapolate(text) # I WANT AN EXCUSE TO SAY EXTRAPOLATE OK
+        # Gets the actual command and arguments from a string.
+        # @param [String] text The text to extrapolate.
+        def extrapolate(text)
             case @type
             when :prefix
                 return text[@value.length..text.length]
@@ -56,6 +69,8 @@ module Commandorobo
             end
         end
 
+        # Checks to see if the invoker is correct for the text.
+        # @param [String] text The text to check.
         def check(text)
             case @type
             when :prefix
@@ -70,23 +85,36 @@ module Commandorobo
         end
     end
 
+    # Class that gets passed to any block defined in {Bot#cmd}. Represents arguments.
+    # @attr_reader [Array] raw The unprocessed array of strings that make up the arguments.
     class Arguments
         attr_reader :raw
         def initialize(raw)
             @raw = raw
         end
         
+        # Leverages a utility function to grab switch information.
+        # @return [Hash] The switches.
         def switches
             Commandorobo::Utils::consume_switch(@raw.join(' '))
         end
 
+        # Leverages a utility function to remove switches.
+        # @return [String] The 'switchless' version of the arguments.
         def noswitch
             Commandorobo::Utils::remove_switch(@raw.join(' '))
         end
     end
 
+    # Class that represents a command.
+    # @attr_reader [Symbol] name The name of the command.
+    # @attr_reader [Block] code The code to execute when the command fires.
+    # @attr_reader [Array] permissions The permissions required to execute the command.
+    # @attr_reader [String] description The description for the command.
+    # @attr [Array] invokers The invokers for the command.
     class Command
-        attr_reader :name, :code, :permissions, :description, :invokers
+        attr_reader :name, :code, :permissions, :description
+        attr_accessor :invokers
         def initialize(name, code, permissions, description, invokers, bot)
             @name = name
             @code = code
@@ -96,15 +124,22 @@ module Commandorobo
 	        @bot = bot
         end
 
+        # Invokes the command.
+        # @param [Discordrb::Event] event The Event object to pass to the command.
+        # @param [Array] args The arguments to pass to the command.
+        # @return [nil]
         def invoke(event, args)
             @code.call(event, args)
         end
         
+        # Checks permissions for a command.
+        # @param [Discordrb::Event] event The event to use to check.
+        # @return [true, Commandorobo::NoPermission]
         def perm_check(event)
 	        perms = {}
             @permissions.each do |p|
                 if p == :bot_owner
-                    perms[p] = @bot.config['owner'].include?(event.author.id)
+                    perms[p] = @bot.owners.include?(event.author.id)
                 else
                     perms[p] = event.author.permission?(p)
                 end
@@ -123,14 +158,21 @@ module Commandorobo
         end
     end
 
+    # The main bot class.
+    # An extension of discordrb's.
+    # @attr [Array] invokers The invokers for the bot. Can be modified, but I'd rather you use {Bot#invoke_by}.
+    # @attr_reader [Hash] config The configuration for the bot.
+    # @attr_reader [Array] commands The commands, in an array. This isn't a hash because I have a method for looking them up.
+    # @attr_reader [Array] listeners Bound event listeners.
     class Bot < Discordrb::Bot
 	    attr_accessor :invokers
-        attr_reader :config, :commands, :listeners # what the hell ruby
+        attr_reader :config, :commands, :listeners
         def initialize(config, token, **kwargs)
                 @config = config
                 @commands = []
                 @listeners = {}
                 @invokers = config['invokers'].map {|i| Commandorobo::Invoker.new(i[1], i[0].to_sym)}
+                @owners = @config['owner'] || kwargs[:owners]
                 super(token: token, **kwargs)
                 # begin command
                 self.message do |ev|
@@ -166,10 +208,17 @@ module Commandorobo
             end
         end
 
+        # Gets a command based on its name.
+        # @param [Symbol] name The command to look for.
+        # @return [Commandorobo::Command] The command.
         def get_command(name)
             @commands.select {|c| c.invokers.include? name}.compact[0]
         end
 
+        # Registers a new event hook.
+        # @param [Symbol] name The event hook.
+        # @param [Block] block The code to run when the event fires.
+        # @return [nil]
         def evt(name, &block)
             if name.is_a? String
                 name = name.to_sym
@@ -180,6 +229,9 @@ module Commandorobo
             @listeners[name] << block
         end
 
+        # Internal.
+        # @raise [RuntimeError] No event hooks registered for the event.
+        # @return [nil]
         def idispatch(name, *args)
             if name.is_a? String
                 name = name.to_sym
@@ -194,15 +246,28 @@ module Commandorobo
             end
         end
 
+        # Adds a command.
+        # @param [Symbol] sym The command name.
+        # @param [Array] perms The permissions required by the command. Can be any valid discordrb permission, or :bot_owner, that will restrict to owners.
+        # @param [String, nil] desc The description for the command.
+        # @param [Block] block The block to run when the command is invoked.
+        # @return [nil]
         def cmd(sym, perms:[], desc:nil, invokers:[], &block)
             invokers << sym
             @commands << Commandorobo::Command.new(sym, block, perms, desc, invokers, self)
         end
 
-        def invoke_by(thing, type, **kwargs)
-            @invokers << Commandorobo::Invoker.new(thing, type, kwargs)
+        # Adds an invoker.
+        # @param [String] value The value of the invoker.
+        # @param [Symbol] type The type of the invoker.
+        # @return [nil] 
+        def invoke_by(value, type, **kwargs)
+            @invokers << Commandorobo::Invoker.new(value, type, kwargs)
         end
 
+        # Grabs an invoker from text.
+        # @param [String] text The text to parse.
+        # @return [nil]
         def get_invoker(text)
             @invokers.map {|a| a if a.check text}.reject(&:!).first # reject all false
         end

data/lib/constants.rb

@@ -1,5 +1,7 @@
 module Commandorobo
+    # Constants for commandorobo.
     module Constants
+        # An array of every valid Discordrb permission as a symbol.
         ValidPerms = [
             :create_instant_invite, 
             :kick_members,          

data/lib/util.rb

@@ -2,12 +2,19 @@
 # Written by ry00001
 
 module Commandorobo
+    # Utilities for commandorobo.
     module Utils
+        # Removes dashes. Used internally.
+        # @param [String] i String to remove dashes from.
+        # @return [String] String with no dashes.
         def self.nodash(i)
             i.split('').reject {|j| j == '-'}.join('')
         end
 
-        def self.consume_switch(str) # this function does not eat nintendo switches. do not try to feed it those.
+        # Gets switches from text.
+        # @param [String] str String to parse.
+        # @return [Hash] Switches as a hash.
+        def self.consume_switch(str)
             nextarg = nil
             parsed = false
             switches = {}
@@ -37,10 +44,9 @@ module Commandorobo
             return switches
         end
 
-        def self.fish_xdm_login_hack_hack_hack_hack # I don't know why this is here but it is, enjoy
-            'perry was here'
-        end
-
+        # Does the opposite of {Commandorobo::Utils::consume_switch}, it removes switches.
+        # @param [String] str String to parse.
+        # @return [Array] A raw array of removed switches.
         def self.remove_switch(str)
             parsed = []
             skip = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commandorobo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - ry00001