cogsdrb 0.1.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93ee70ecaddfe627a3559db5799bfedd5301c256231d8b48fb3e2ad93520de97
-  data.tar.gz: 695d51fd6712fd1c65885a51ca5a5ede23baeb16c9d5fc0cab7dd6d0590d1102
+  metadata.gz: aa139fe677fab4e74fa37690536c56e26a6f7a5916ebac60ef6e97c10d9cedf7
+  data.tar.gz: d608f26282fd37d6ff977566d46b25c5937ac48fe5148ca8c8954acf3428a60f
 SHA512:
-  metadata.gz: a6e598efcde6e809992c79a39de90d96216f69ce5f73b07934e0a0202937516731e4eddc2d1de645ad42f4454dde9fe84827df1f51a05d7baa0df9ecf1621822
-  data.tar.gz: 55427a2092555d1499ee4a31b2c181da54ca9b6d7fe8a7f6d90fe5d60636507e884ba42daae5188dd3e71efb182dcf2040a789a4fcc09bafb422b69d5fba83fe
+  metadata.gz: 870020397d6104e2e23815cb09cffba6d4ee99e34c1c0b87b35475838be2924196fbb5b691dc04d4e237bfdacef09d9901ee259d889c20b00aad7aced709e7ad
+  data.tar.gz: a1b54950fbd4077ce0f96d59a6cbeaa55fdb8e7746e10f2abbf5c1abdf4c802117a6bd4a142ff490f919346eb59ce4bede37e8c49d659d58c12027ae832c1f42

data/README.md

@@ -5,7 +5,7 @@ Cogs for [discordrb](https://github.com/discordrb/discordrb), in the style of [d
 Cogs allow you to load commands, events, and variables from outside of the main bot file, 
 which helps improve organization and readability of code.
 
-#### Note: This gem is in extremely early development. As of now, it is extremely bare bones. More features will be added soon, and everyone is welcome to contribute. Additionally, the code is short but manages to be wack.
+#### Note: This gem is in extremely early development. As of now, it is extremely bare bones. More features will be added soon, and everyone is welcome to contribute. Additionally, the code is kinda hacky in some parts, and that will be fixed.
 
 ## Installation
 
@@ -81,7 +81,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/No-Jons/drb-cogs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/No-Jons/drb-cogs/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/No-Jons/cogsdrb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/No-Jons/cogsdrb/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -90,4 +90,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Drb::Cogs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/drb-cogs/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the CogsDRB project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/No-Jons/cogsdrb/blob/master/CODE_OF_CONDUCT.md).

data/lib/bot.rb

@@ -0,0 +1,118 @@
+require 'discordrb'
+
+module Cogs
+  class BaseBotClass < Discordrb::Commands::CommandBot
+    def initialize(token, prefix)
+      super token: token, prefix: prefix
+      @cached_cogs = {}
+      @loaded_cogs = {}
+
+    end
+
+    attr_reader :cached_cogs
+    attr_reader :loaded_cogs
+
+    def add_commands
+      nil
+    end
+
+    def run_bot
+      self.before
+      self.add_commands
+      begin
+        self.run
+      ensure
+        self.after
+      end
+    end
+
+    def before
+      nil
+    end
+
+    def after
+      nil
+    end
+
+    def command(name, attributes = {}, &block)
+      @commands ||= {}
+
+      # TODO: Remove in 4.0
+      if name.is_a?(Array)
+        name, *aliases = name
+        attributes[:aliases] = aliases if attributes[:aliases].nil?
+        Discordrb::LOGGER.warn("While registering command #{name.inspect}")
+        Discordrb::LOGGER.warn('Arrays for command aliases is removed. Please use `aliases` argument instead.')
+      end
+
+      new_command = Cogs::Command.new(self, name, attributes, &block)
+      new_command.attributes[:aliases].each do |aliased_name|
+        @commands[aliased_name] = CommandAlias.new(aliased_name, new_command)
+      end
+      @commands[name] = new_command
+    end
+
+    def _remove_all_cog_commands(cogname)
+      @commands ||= {}
+      @commands.each do |cmd|
+        if cmd[1]::cog == cogname
+          self.remove_command cmd[1]::name
+          p cmd[1]::name
+        end
+      end
+    end
+
+    def load_extension(fp)
+      fp = fp + ".rb" unless fp.end_with?".rb"
+      raise Cogs::CogError.new "Nonexistant filepath #{fp}" unless File.file?fp + ".rb" unless fp.end_with?".rb"
+      begin
+        load fp
+        cog = setup(self)
+        cog::fp = fp
+        @loaded_cogs[cog::name] = cog
+      rescue LoadError, NoMethodError => error
+        self.log_exception(error)
+      end
+    end
+
+    def add_cog(cog)
+      begin
+        cog.commands
+        @cached_cogs[cog::name] = cog.class
+        return cog
+      rescue NoMethodError => error
+        self.log_exception(error)
+      end
+    end
+
+    def unload_cog(cog: nil, cogname: "")
+      if cog.is_a?Cogs::Cog
+        if @cached_cogs.keys.include? cog::name
+          @loaded_cogs = @loaded_cogs.tap { |key| delete(key) if key == cog::name }
+          self._remove_all_cog_commands(cog::name)
+          Discordrb::LOGGER.info "Unloaded cog #{cog::name}"
+          return
+        end
+      end
+      if @cached_cogs.keys.include?cogname
+        @loaded_cogs = @loaded_cogs.tap { |key| delete(key) if key == cogname }
+        self._remove_all_cog_commands(cogname)
+        Discordrb::LOGGER.info "Unloaded cog #{cogname}"
+        return
+      end
+      raise Cogs::CogError.new "Cog already unloaded"
+    end
+
+    def reload_cog(cog)
+      raise Cogs::CogError.new "Cog not found" unless @cached_cogs.keys.include?cog or @loaded_cogs.keys.include?cog
+      if @loaded_cogs.include?cog
+        self.unload_cog(cogname: cog)
+      end
+      self.load_extension(@loaded_cogs[cog]::fp)
+    end
+
+    def load_cog(cog)
+      self.reload_cog(cog: cog)
+    end
+  end
+end

data/lib/cogsdrb.rb

@@ -1,73 +1,26 @@
 require 'discordrb'
 require "cogsdrb/version"
+require "bot"
+require "commands"
 
 module Cogs
-    class BaseBotClass < Discordrb::Commands::CommandBot
-        def initialize(token, prefix)
-            super token: token, prefix: prefix
-            @cogs = []
-        end
-
-        def cogs
-            @cogs
-        end
-
-        def add_commands
-            nil
-        end
-
-        def run_bot
-            self.before
-            self.add_commands
-            begin
-                self.run
-            ensure
-                self.after
-            end
-        end
-
-        def before
-            nil
-        end
-
-        def after
-            nil
-        end
-
-        def load_cog(fp)
-            begin
-                require fp
-                setup(self)
-            rescue LoadError, NoMethodError => error
-                self.log_exception(error)
-            end
-        end
-
-        def add_cog(cog)
-            begin
-                cog.commands
-                @cogs.append(cog)
-            rescue NoMethodError => error
-                self.log_exception(error)
-            end
-        end
-    end
-
     class Cog
         def initialize(name: "Cog")
             @name = name
+            @fp = fp
         end
 
-        def name
-            @name
-        end
+        attr_reader :name
+        attr_accessor :fp
     end
 
     # TODO:
-    #   - Loading and unloading of cogs
+    #   ✔ Loading and unloading of cogs
     #   - Event listeners
     #   - Cog meta attributes
     #   - More dpy-like implementation
     #   - Clean it up and make it not hacky af
 
+    class CogError < StandardError; end
+
 end

data/lib/cogsdrb/version.rb

@@ -1,3 +1,3 @@
 module Cogs
-    VERSION = "0.1.6"
+    VERSION = "0.2.8"
 end

data/lib/commands.rb

@@ -0,0 +1,57 @@
+require 'discordrb'
+
+module Cogs
+  class Command < Discordrb::Commands::Command
+    def initialize(bot, name, attributes = {}, &block)
+      super(name=name, attributes=attributes, &block=block)
+      @bot = bot
+      @cog = attributes[:cog] || "None"
+    end
+
+    attr_reader :cog
+
+    def call(event, arguments, chained = false, check_permissions = true)
+      return unless @bot::cached_cogs.include?(@cog) || @cog == "None"
+      if arguments.length < @attributes[:min_args]
+        response = "Too few arguments for command `#{name}`!"
+        response += "\nUsage: `#{@attributes[:usage]}`" if @attributes[:usage]
+        event.respond(response)
+        return
+      end
+      if @attributes[:max_args] >= 0 && arguments.length > @attributes[:max_args]
+        response = "Too many arguments for command `#{name}`!"
+        response += "\nUsage: `#{@attributes[:usage]}`" if @attributes[:usage]
+        event.respond(response)
+        return
+      end
+      unless @attributes[:chain_usable]
+        if chained
+          event.respond "Command `#{name}` cannot be used in a command chain!"
+          return
+        end
+      end
+
+      if check_permissions
+        rate_limited = event.bot.rate_limited?(@attributes[:bucket], event.author)
+        if @attributes[:bucket] && rate_limited
+          event.respond @attributes[:rate_limit_message].gsub('%time%', rate_limited.round(2).to_s) if @attributes[:rate_limit_message]
+          return
+        end
+      end
+
+      result = @block.call(event, *arguments)
+      event.drain_into(result)
+    rescue LocalJumpError => e # occurs when breaking
+      result = e.exit_value
+      event.drain_into(result)
+    rescue StandardError => e # Something went wrong inside our @block!
+      rescue_value = @attributes[:rescue] || event.bot.attributes[:rescue]
+      if rescue_value
+        event.respond(rescue_value.gsub('%exception%', e.message)) if rescue_value.is_a?(String)
+        rescue_value.call(event, e) if rescue_value.respond_to?(:call)
+      end
+
+      raise e
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogsdrb
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.8
 platform: ruby
 authors:
 - No-Jons
@@ -27,8 +27,10 @@ files:
 - bin/console
 - bin/setup
 - cogsdrb.gemspec
+- lib/bot.rb
 - lib/cogsdrb.rb
 - lib/cogsdrb/version.rb
+- lib/commands.rb
 homepage: https://github.com/No-Jons/cogsdrb
 licenses:
 - MIT