commandrb 0.4.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89f754aad75f12c277404a9411affd57fa77f44b191b6be620db935c95ee40d7
-  data.tar.gz: fba97e0c044f0357c40d38e40786ef95d86f96711f64722df02c794130541e63
+  metadata.gz: a71ccd55615cb29fa0a400e3fd29b543d3ce8d52d264646be9e50d2b824790bd
+  data.tar.gz: cc5f60c22142653ac2b9b3a2504c083329ea382738c07c9bc6f9c6f4966e519c
 SHA512:
-  metadata.gz: b448742362cc9fb63fa98b9be809fbe25df58b937f0c72047a575e11d7e99a898c44fa240abd18cb9c67ad3ceebc576ae55758d13e6a4c8fd746aa8970b08d4c
-  data.tar.gz: 349cc028596ef2e133d651a4e33aee55e84bf9b87ee1de0361dc637f22191f2a4caf062d3d623d6d8be90f13def3bd734c93fe41b582f2626acfc6abd132b463
+  metadata.gz: 23cc6f6e1cf7f67c05d555794cd700c9a8ab8d0a5e329543e1c58e8219c61ef3e64a02b9de45b020cd22b7bed21639124ecf60f196e154c2f49398c3dc1ee364
+  data.tar.gz: 1fdd79b3754dc7e156ac365723efdb2589b56f4a04adda1309b04ce62e69cfa23641ae1dd48631cc461bf3495367e80e5a765df48443dd9d52b9f4f6c3f93ff0

data/lib/commandrb.rb

@@ -3,8 +3,6 @@
 require_relative 'helper'
 
 class CommandrbBot
-  @debug_mode = ENV['COMMANDRB_MODE'] == 'debug'
-  @debug_mode = true
   # Be able to adjust the config on the fly.
   attr_accessor :config
 
@@ -30,7 +28,7 @@ class CommandrbBot
     true
   end
 
-  # By defining this seperately. we allow you to overwrite it and use your own owner list.
+  # By defining this separately, we allow you to overwrite it and use your own owner list.
   # Your checks will instead be run by commandrb and allow you to use :owner_only as normal.
   def owner?(id)
     @config[:owners].include?(id)
@@ -39,6 +37,8 @@ class CommandrbBot
   alias is_owner? owner?
 
   def initialize(init_hash)
+    @debug_mode = ENV['COMMANDRB_MODE'] == 'debug'
+
     # Setup the variables for first use.
     @commands = {}
     @prefixes = []
@@ -46,22 +46,20 @@ class CommandrbBot
 
     # Load sane defaults for options that aren't specified.
 
-    # @config[:prefix_type] = 'rescue' if @config[:prefix_type].nil?
     @config[:typing_default] = false if @config[:typing_default].nil?
-    @config[:selfbot] = false if @config[:selfbot].nil?
     @config[:delete_activators] = false if @config[:delete_activators].nil?
 
     raise 'No token supplied in init hash!' if @config[:token].nil? || (init_hash[:token] == '')
 
     init_parse_self = begin
-                        init_hash[:parse_self]
-                      rescue StandardError
-                        nil
-                      end
+      init_hash[:parse_self]
+    rescue StandardError
+      nil
+    end
     init_type = @config[:type]
 
-    if init_type == :bot
-      raise 'No client ID or invalid client ID supplied in init hash!' if init_hash[:client_id].nil?
+    if init_type == :bot && init_hash[:client_id].nil?
+      raise 'No client ID or invalid client ID supplied in init hash!'
     end
 
     @config[:owners] = init_hash[:owners]
@@ -85,214 +83,145 @@ class CommandrbBot
 
     # Command processing
     @bot.message do |event|
-      finished = false
-      chosen = nil
-      args = nil
-      rawargs = nil
-      continue = false
-      failed = false
-      @prefixes.each do |prefix|
-        break if finished
+      chosen_activator = nil
+      message_content = nil
+      chosen_command = nil
+      used_prefix = ''
 
+      # If we have a usable prefix, get the raw arguments for this command.
+      @prefixes.each do |prefix|
         next unless event.message.content.start_with?(prefix)
 
-        @commands.each do |key, command|
-          break if finished
-
-          puts ":: Considering #{key}" if @debug_mode == true
-          triggers = command[:triggers].nil? ? [key.to_s] : command[:triggers]
-
-          triggers.each do |trigger|
-            activator = prefix + trigger.to_s
-            puts activator if @debug_mode == true
-            activator = activator.downcase
-            next unless event.message.content.downcase.start_with?(activator)
-
-            puts "Prefix matched! #{activator}" if @debug_mode == true
-
-            # Continue only if you've already chosen a choice.
-            if chosen.nil?
-              puts 'First match obtained!' if @debug_mode == true
-              continue = true
-              chosen = activator
-            else
-              # If the new activator begins with the chosen one, then override it.
-              # Example: sh is chosen, shell is the new one.
-              # In this example, shell would override sh, preventing ugly bugs.
-              if activator.start_with?(chosen)
-                puts "#{activator} just overrode #{chosen}" if @debug_mode == true
-                chosen = activator
-                # Otherwhise, just give up.
-              else
-                puts 'Match failed...' if @debug_mode == true
-                next
-              end
-              # If you haven't chosen yet, get choosing!
-            end
+        # Store the message's content, sans its prefix.
+        # Strip leading spaces in the event a prefix ends with a space.
+        message_content = event.message.content
+        used_prefix = message_content.slice! prefix
+        break
+      end
+
+      # Otherwise, do not continue processing.
+      next if message_content.nil?
+
+      @commands.each do |key, command|
+        puts ":: Considering #{key}" if @debug_mode == true
+        triggers = command[:triggers].nil? ? [key.to_s] : command[:triggers]
+
+        triggers.each do |trigger|
+          activator = trigger.to_s.downcase
+          puts activator if @debug_mode == true
+          next unless event.message.content.downcase.start_with?(activator)
+
+          puts "Prefix matched! #{activator}" if @debug_mode == true
+
+          # Continue only if you've already chosen a choice.
+          if chosen_activator.nil?
+            puts 'First match obtained!' if @debug_mode == true
+            chosen_activator = activator
+            chosen_command = command
+
+            # If the new activator begins with the chosen one, then override it.
+            # Example: sh is chosen, shell is the new one.
+            # In this example, shell would override sh, preventing ugly bugs.
+          elsif activator.start_with?(chosen_activator)
+            puts "#{activator} just overrode #{chosen_activator}" if @debug_mode == true
+            chosen_activator = activator
+            chosen_command = command
+          # Otherwise, just give up.
+          elsif @debug_mode == true
+            puts 'Match failed...'
           end
+          # If you haven't chosen yet, get choosing!
+        end
 
-          puts "Result: #{chosen}" if @debug_mode == true
+        puts "Result: #{chosen_activator}" if @debug_mode == true
+      end
 
-          next unless continue
+      # If we have no chosen activator, it is likely the command does not exist
+      # or the prefix itself was run.
+      next if chosen_activator.nil?
 
-          puts "Final result: #{chosen}" if @debug_mode == true
+      command_run = used_prefix + chosen_activator
+      puts "Final result: #{command_run}" if @debug_mode == true
 
-          break if @config[:selfbot] && event.user.id != @bot.profile.id
+      # Command flag defaults
+      chosen_command[:owners_only] = false if chosen_command[:owners_only].nil?
+      chosen_command[:server_only] = false if chosen_command[:server_only].nil?
+      chosen_command[:typing] = @config[:typing_default] if chosen_command[:typing_default].nil?
+      if chosen_command[:delete_activator].nil?
+        chosen_command[:delete_activator] =
+          @config[:delete_activators]
+      end
+      chosen_command[:owner_override] = false if chosen_command[:owner_override].nil?
+
+      # If the settings are to delete activating messages, then do that.
+      # I'm *hoping* this doesn't cause issues with argument extraction.
+      event.message.delete if chosen_command[:delete_activator]
+
+      # If the command is only for use in servers, display error and abort.
+      if chosen_command[:server_only] && event.channel.private?
+        event.channel.send_embed error_embed(
+          error: 'This command can only be used in servers!',
+          footer: "Command: `#{command_run}`"
+        )
+        break
+      end
 
-          # Command flag defaults
-          command[:catch_errors] = @config[:catch_errors] if command[:catch_errors].nil?
-          command[:owners_only] = false if command[:owners_only].nil?
-          command[:max_args] = 2000 if command[:max_args].nil?
-          command[:min_args] = 0 if command[:min_args].nil?
-          command[:server_only] = false if command[:server_only].nil?
-          command[:typing] = @config[:typing_default] if command[:typing_default].nil?
-          if command[:delete_activator].nil?
-            command[:delete_activator] = @config[:delete_activators]
-          end
-          command[:owner_override] = false if command[:owner_override].nil?
-
-          # If the settings are to delete activating messages, then do that.
-          # I'm *hoping* this doesn't cause issues with argument extraction.
-          event.message.delete if command[:delete_activator]
-
-          # If the command is only for use in servers, display error and abort.
-          unless failed
-            if command[:server_only] && event.channel.private?
-              # For selfbots, a fancy embed will be used. WIP.
-              if @config[:selfbot]
-                event.channel.send_embed do |embed|
-                  embed.colour = 0x221461
-                  embed.title = '❌ An error has occured!'
-                  embed.description = 'This command can only be used in servers!'
-                  embed.footer = Discordrb::Webhooks::EmbedFooter.new(text: "Command: '#{event.message.content}'")
-                end
-              else
-                # If its not a selfbot, an ordinary message will be shown, may be changed to embed later.
-                event.respond('❌ This command will only work in servers!')
-              end
-              # Abort!
-              finished = true
-              next
-            end
-          end
+      # If the user is a bot and the command is set to not pass bots
+      # OR the user is a bot and the global config is to not parse bots...
+      # ...then abort :3
+      if event.user.bot_account? && \
+         (chosen_command[:parse_bots] == false || @config[:parse_bots] == false)
+        # Abort!
+        break
+      end
 
-          # If the user is a bot and the command is set to not pass bots OR the user is a bot and the global config is to not parse bots...
-          # ...then abort :3
-          if (event.user.bot_account? && command[:parse_bots] == false) || (event.user.bot_account? && @config[:parse_bots] == false)
-            # Abort!
-            finished = true
-            next
-          end
+      # If the config is setup to show typing messages, then do so.
+      event.channel.start_typing if chosen_command[:typing]
 
-          # If the config is setup to show typing messages, then do so.
-          event.channel.start_typing if command[:typing]
-
-          args = event.message.content.split(' ')
-          # Parse args if args exist !
-          begin
-            spaces = 1
-            # Prefixes with spaces are special and need to be parsed differently : )
-            if prefix.include? ' '
-              spaces += prefix.count(' ')
-              args = event.message.content.slice!(args[0].size + args[1].size + spaces, event.message.content.size)
-            else
-              args = event.message.content.slice!(args[0].size + spaces, event.message.content.size)
-            end
-            # Split the argmuents into an array for easy usage but keep the raw args !!
-            rawargs = args
-            args = args.split(/ /)
-          rescue NoMethodError # Not the most elegant solution but it'll do. TODO: Make a more elegant solution.
-            args = []
-          end
+      # Our arguments are the message's contents, minus the activator.
+      args = message_content
+      args.slice! chosen_activator
+      args = args.split
 
-          # Check the number of args for the command.
-          unless command[:max_args].nil? || failed
-            if command[:max_args] > 0 && args.length > command[:max_args]
-              send_error = Helper.error_embed(
-                error: "Too many arguments! \nMax arguments: `#{command[:max_args]}`",
-                footer: "Command: `#{event.message.content}`",
-                colour: 0xFA0E30,
-                code_error: false
-              )
-              failed = true
-            end
-          end
+      no_permission = false
 
-          # Check the number of args for the command.
-          unless command[:min_args].nil? || failed
-            if command[:min_args] > 0 && args.length < command[:min_args]
-              send_error = Helper.error_embed(
-                error: "Too few arguments! \nMin arguments: `#{command[:min_args]}`",
-                footer: "Command: `#{event.message.content}`",
-                colour: 0xFA0E30,
-                code_error: false
-              )
-              failed = true
-            end
-          end
+      chosen_command[:required_permissions]&.each do |x|
+        if event.user.on(event.server).permission?(x, event.channel) \
+          || (chosen_command[:owner_override] && @config[:owners].include?(event.user.id))
+          next
+        end
 
-          unless command[:required_permissions].nil? || failed
-            command[:required_permissions].each do |x|
-              if event.user.on(event.server).permission?(x, event.channel) || (command[:owner_override] && @config[:owners].include?(event.user.id))
-                next
-              end
-
-              send_error = Helper.error_embed(
-                error: "You don't have permission for that!\nPermission required: `#{x}`",
-                footer: "Command: `#{event.message.content}`",
-                colour: 0xFA0E30,
-                code_error: false
-              )
-              failed = true
-            end
-          end
+        event.channel.send_embed '', error_embed(
+          error: "You don't have permission for that!\nPermission required: `#{x}`",
+          footer: "Command: `#{command_run}`"
+        )
+        no_permission = true
+        break
+      end
 
-          # If the command is set to owners only and the user is not the owner, show error and abort.
-          puts "[DEBUG] Command being processed: '#{command}'" if @debug_mode == true
-          puts "[DEBUG] Owners only? #{command[:owners_only]}" if @debug_mode == true
-          if command[:owners_only]
-            unless owner?(event.user.id)
-
-              send_error = Helper.error_embed(
-                error: "You don't have permission for that!\nOnly owners are allowed to access this command.",
-                footer: "Command: `#{event.message.content}`",
-                colour: 0xFA0E30,
-                code_error: false
-              )
-              failed = true
-              # next
-            end
-          end
+      next if no_permission
+
+      # If the command is set to owners only and the user is not the owner,
+      # show an error and abort.
+      puts "[DEBUG] Command being processed: '#{chosen_command}'" if @debug_mode == true
+      puts "[DEBUG] Owners only? #{chosen_command[:owners_only]}" if @debug_mode == true
+      if chosen_command[:owners_only] && !owner?(event.user.id)
+        event.channel.send_embed '', error_embed(
+          error: "You don't have permission for that!\n"\
+                 'Only owners are allowed to access this command.',
+          footer: "Command: `#{command_run}`"
+        )
+        next
+      end
 
-          unless finished
-            # If the command is configured to catch all errors, thy shall be done.
-            # Run the command code!
-            if failed
-              if command[:failcode].nil?
-                if send_error.nil?
-                  event.respond(':x: An unknown error has occured!')
-                else
-                  event.channel.send_message('', false, send_error)
-                end
-              else
-                command[:failcode]&.call(event, args, rawargs)
-              end
-            else
-              command[:code].call(event, args, rawargs)
-            end
-          end
+      # Run the command code!
+      # TODO: determine a good method to log other errors as made via the command.
+      # Without, we will simply log to console.
+      chosen_command[:code].call(event, args, message_content)
 
-          # All done here.
-          puts "Finished!! Executed command: #{chosen}" if @debug_mode == true
-          failed = false
-          command = command
-          event = event
-          args = args
-          rawargs = rawargs
-          finished = true
-          break
-        end
-      end
+      # All done here.
+      puts "Finished!! Executed command: #{chosen_activator}" if @debug_mode == true
+      next
     end
   end
 end

data/lib/helper.rb

@@ -1,34 +1,48 @@
 # frozen_string_literal: true
 
 class CommandrbBot
-  module Helper
-    def self.error_embed(error: nil, footer: nil, colour: nil, color: nil, code_error: true)
-      if error.nil? || footer.nil?
-        raise 'Invalid arguments for Helper.error_embed!'
-      else
-        colour = 0x22ef1f if color.nil? && colour.nil?
-        Discordrb::Webhooks::Embed.new(
-          title: '❌ An error has occured!',
-          description: code_error ? "```ruby\n#{error}```" : error,
-          colour: colour || color,
-          footer: Discordrb::Webhooks::EmbedFooter.new(text: footer)
-        )
-      end
-    end
-
-    def self.avatar_embed(color: nil, colour: nil, url: nil, username: nil, time: Time.now.getutc.asctime)
-      if url.nil?
-        raise 'Invalid arguments for Helper.avatar_embed!'
-      else
-        colour = 0x22ef1f if color.nil? && colour.nil?
-        username = username.nil? ? 'Unknown User' : username
-        Discordrb::Webhooks::Embed.new(
-          colour: colour || color,
-          image: Discordrb::Webhooks::EmbedImage.new(url: url),
-          author: Discordrb::Webhooks::EmbedAuthor.new(name: "Avatar for #{username}", url: url),
-          footer: Discordrb::Webhooks::EmbedFooter.new(text: "Avatar correct as of #{time}")
-        )
-      end
-    end
+  # Utilizes several methods to attempt to determine a user.
+  def user_parse(context)
+    # Can't do anything if there's nothing to begin with.
+    return nil if context.nil?
+
+    # Catches cases such as "0": obviously invalid, attempted nonetheless.
+    context = context.to_s
+
+    # If it's an ID.
+    id_check = bot.user(context)
+    return id_check unless id_check.nil?
+
+    # If it's a mention!
+    matches = /<@!?(\d+)>/.match(context)
+    return bot.user(matches[1]) unless matches.nil?
+
+    # Might be a username...
+    return bot.find_user(context)[0] unless bot.find_user(context).nil?
+
+    nil
+  end
+
+  # Generates a usable error embed with defaults.
+  def error_embed(error: nil, footer: nil, colour: nil, color: nil)
+    raise 'Invalid arguments for Helper.error_embed!' if error.nil? || footer.nil?
+
+    colour = 0xFA0E30 if color.nil? && colour.nil?
+    Discordrb::Webhooks::Embed.new(
+      title: '❌ An error has occurred!',
+      description: error,
+      colour: colour || color,
+      footer: Discordrb::Webhooks::EmbedFooter.new(text: footer)
+    )
+  end
+
+  # Generates a usable error embed with defaults, and a formatted error.
+  def code_embed(error: nil, footer: nil, colour: nil, color: nil)
+    raise 'Invalid arguments for Helper.code_embed!' if error.nil? || footer.nil?
+
+    # Format to have a code block with formatting.
+    error = "```ruby\n#{error}```"
+
+    error_embed(error: error, footer: footer, colour: colour, color: color)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commandrb
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.0
 platform: ruby
 authors:
 - Erisa A
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-03 00:00:00.000000000 Z
+date: 2022-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -31,7 +31,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.0
 description: A customisable and easy to use Commands System for Discordrb.
-email: seriel@erisa.moe
+email: erisa@erisa.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -41,8 +41,9 @@ files:
 homepage: https://github.com/Yuuki-Discord/commandrb
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,15 +51,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Commandrb
 test_files: []