commandrb 0.4.0 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8e157c31805af8a1a19398b332dd1e711acc6086
-  data.tar.gz: d9811c8a83caac8570795fb1e4525d2585dd72cf
+SHA256:
+  metadata.gz: 89f754aad75f12c277404a9411affd57fa77f44b191b6be620db935c95ee40d7
+  data.tar.gz: fba97e0c044f0357c40d38e40786ef95d86f96711f64722df02c794130541e63
 SHA512:
-  metadata.gz: d4f15b5e1e82bb14df045c85e207737c29a4b43fa44fbfcbd15d4d8b877dafdb7ef52dac2a0b45efdb422e55f8cd6d323de35617917743e41ccceee0ea1eac01
-  data.tar.gz: 9acb080178dd98a8c15eacdd1673fefc9006be37db103e574cf481a5dea5bffe0e0ff3f63b25ccfde97ff70129f497ed0aa5edce3e96c991aba6ae16d1bd2e50
+  metadata.gz: b448742362cc9fb63fa98b9be809fbe25df58b937f0c72047a575e11d7e99a898c44fa240abd18cb9c67ad3ceebc576ae55758d13e6a4c8fd746aa8970b08d4c
+  data.tar.gz: 349cc028596ef2e133d651a4e33aee55e84bf9b87ee1de0361dc637f22191f2a4caf062d3d623d6d8be90f13def3bd734c93fe41b582f2626acfc6abd132b463

data/lib/commandrb.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'helper'
 
 class CommandrbBot
-  
-  ENV['COMMANDRB_MODE'] == 'debug' ? @debug_mode = true : @debug_mode = false
-
+  @debug_mode = ENV['COMMANDRB_MODE'] == 'debug'
+  @debug_mode = true
   # Be able to adjust the config on the fly.
   attr_accessor :config
 
@@ -16,7 +17,6 @@ class CommandrbBot
   # Lets you change global prefixes while the bot is running (Not recommended!)
   attr_accessor :prefixes
 
-
   def add_command(name, attributes = {})
     @commands[name.to_sym] = attributes
   end
@@ -24,14 +24,21 @@ class CommandrbBot
   def remove_command(name)
     begin
       @commands.delete(name)
-    rescue
+    rescue StandardError
       return false
     end
     true
   end
 
-  def initialize(init_hash)
+  # By defining this seperately. 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)
+  end
+
+  alias is_owner? owner?
 
+  def initialize(init_hash)
     # Setup the variables for first use.
     @commands = {}
     @prefixes = []
@@ -41,22 +48,20 @@ class CommandrbBot
 
     # @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[:selfbot] = false if @config[:selfbot].nil?
     @config[:delete_activators] = false if @config[:delete_activators].nil?
 
-    if @config[:token].nil? or init_hash[:token] == ''
-      raise 'No token supplied in init hash!'
-      return false
-    end
+    raise 'No token supplied in init hash!' if @config[:token].nil? || (init_hash[:token] == '')
 
-    init_parse_self = init_hash[:parse_self] rescue nil
+    init_parse_self = begin
+                        init_hash[:parse_self]
+                      rescue StandardError
+                        nil
+                      end
     init_type = @config[:type]
 
     if init_type == :bot
-      if init_hash[:client_id].nil?
-        raise 'No client ID or invalid client ID supplied in init hash!'
-        return false
-      end
+      raise 'No client ID or invalid client ID supplied in init hash!' if init_hash[:client_id].nil?
     end
 
     @config[:owners] = init_hash[:owners]
@@ -65,10 +70,10 @@ class CommandrbBot
     @prefixes = init_hash[:prefixes]
 
     @bot = Discordrb::Bot.new(
-        token: @config[:token],
-        client_id: @config[:client_id],
-        parse_self: init_parse_self,
-        type: @config[:type]
+      token: @config[:token],
+      client_id: @config[:client_id],
+      parse_self: init_parse_self,
+      type: @config[:type]
     )
 
     unless init_hash[:ready].nil?
@@ -78,93 +83,80 @@ class CommandrbBot
       end
     end
 
-
     # Command processing
     @bot.message do |event|
-      @finished = false
-      @command = nil
-      @event = nil
-      @chosen = nil
-      @args = nil
-      @rawargs = nil
-      @continue = false
-      @prefixes.each { |prefix|
-        break if @finished
-        if event.message.content.start_with?(prefix)
-
-          @commands.each { | key, command |
-            break if @finished
-            puts ":: Considering #{key.to_s}"  if @debug_mode
-            triggers =  command[:triggers].nil? ? [key.to_s] : command[:triggers]
-
-            triggers.each { |trigger|
-              @activator = prefix + trigger.to_s
-              puts @activator if @debug_mode
-              @activator = @activator.downcase
-              if event.message.content.downcase.start_with?(@activator)
-                puts "Prefix matched! #{@activator}" if @debug_mode
-
-                # Continue only if you've already chosen a choice.
-                unless @chosen.nil?
-                  # 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
-                    @chosen = @activator
-                  # Otherwhise, just give up.
-                  else
-                    puts "Match failed..." if @debug_mode
-                    next
-                  end
-                # If you haven't chosen yet, get choosing!
-                else
-                    puts "First match obtained!" if @debug_mode
-                    @continue = true
-                    @chosen = @activator
-                end
-              end
-            }
-            
-            puts "Result: #{@chosen}" if @debug_mode
-
-            next if !@continue
-            puts "Final esult: #{@chosen}" if @debug_mode
-
-            break if @config[:selfbot] && event.user.id != @bot.profile.id
-
-            # 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[:server_only] = false if command[:server_only].nil?
-            command[:typing] = @config[:typing_default] if command[:typing_default].nil?
-            command[:delete_activator] = @config[:delete_activators] if command[:delete_activator].nil?
-
-            # 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
-            puts "[DEBUG] Owners only? #{command[:owners_only]}" if @debug_mode
-            if command[:owners_only]
-              if !@config[:owners].include?(event.user.id)
-                event.channel.send_message('', false,
-                  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
-                  )
-                )
-                puts 'Were returning!'
-                @finished = true
+      finished = false
+      chosen = nil
+      args = nil
+      rawargs = nil
+      continue = false
+      failed = false
+      @prefixes.each do |prefix|
+        break if finished
+
+        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
+          end
+
+          puts "Result: #{chosen}" if @debug_mode == true
 
-            # 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]
+          next unless continue
 
-            # If the command is only for use in servers, display error and abort.
+          puts "Final result: #{chosen}" if @debug_mode == true
+
+          break if @config[:selfbot] && event.user.id != @bot.profile.id
+
+          # 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]
@@ -179,88 +171,128 @@ class CommandrbBot
                 event.respond('❌ This command will only work in servers!')
               end
               # Abort!
-              @finished = true
+              finished = true
               next
             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 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 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
-
-            # 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 !
-            if args.length > 2
-              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(/ /)
+            # 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
+
+          # 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
+
+          # 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
 
-
-            # Check the number of args for the command.
-            unless command[:max_args].nil?
-              if command[:max_args] > 0 && args.length > command[:max_args]
-                # May be replaced with an embed.
-                event.channel.send_message('', false,
-                    Helper.error_embed(
-                     error: "Too many arguments! \nMax arguments: `#{command[:max_args]}`",
-                     footer: "Command: `#{event.message.content}`",
-                     colour: 0xFA0E30,
-                     code_error: false
-                    )
-                  )
-                break
+          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
-            
-            # If the command is configured to catch all errors, thy shall be done.
-            if !command[:catch_errors] || @config['catch_errors']
-              # Run the command code!
-              command[:code].call(event, args, rawargs)
-            else
-              # Run the command code, but catch all errors and output accordingly.
-              begin
-                command[:code].call(event, args, rawargs)
-              rescue Exception => e
-                event.respond("❌ An error has occured!! ```ruby\n#{e}```Please contact the bot owner with the above message for assistance.")
-              end
+          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
 
-            unless command[:required_permissions].nil?
-              command[:required_permissions].each { |x|
-                if event.user.on(event.server).permission?(x,event.channel)
-                  event.respond('❌ You don\'t have permission for that!')
-                  @finished = true
-                  next
+          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
-
-            # All done here.
-            puts "Finished!! Executed command: #{@chosen}" if @debug_mode
-            @command = command
-            @event = event
-            @args = args
-            @rawargs = rawargs
-            @finished = true
-            break
-          }
+            else
+              command[:code].call(event, args, rawargs)
+            end
+          end
+
+          # 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
     end
   end
 end

data/lib/helper.rb

@@ -0,0 +1,34 @@
+# 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
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commandrb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.8
 platform: ruby
 authors:
-- Erisa Komuro (Seriel)
+- Erisa A
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2020-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discordrb
@@ -31,13 +31,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.0
 description: A customisable and easy to use Commands System for Discordrb.
-email: seriel@fl0.co
+email: seriel@erisa.moe
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/commandrb.rb
-homepage: https://github.com/Seriell/commandrb
+- lib/helper.rb
+homepage: https://github.com/Yuuki-Discord/commandrb
 licenses:
 - MIT
 metadata: {}
@@ -49,15 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Commandrb