cogsdrb 0.2.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa139fe677fab4e74fa37690536c56e26a6f7a5916ebac60ef6e97c10d9cedf7
-  data.tar.gz: d608f26282fd37d6ff977566d46b25c5937ac48fe5148ca8c8954acf3428a60f
+  metadata.gz: ab7973e0ed90dd965f13cb40b77729eabf0171464f5eaffacbb342b482cdb949
+  data.tar.gz: 5cf09cd4e2d94320e39a9b214f66eb1e5caf1046a83366ed9d4d227a3446acac
 SHA512:
-  metadata.gz: 870020397d6104e2e23815cb09cffba6d4ee99e34c1c0b87b35475838be2924196fbb5b691dc04d4e237bfdacef09d9901ee259d889c20b00aad7aced709e7ad
-  data.tar.gz: a1b54950fbd4077ce0f96d59a6cbeaa55fdb8e7746e10f2abbf5c1abdf4c802117a6bd4a142ff490f919346eb59ce4bede37e8c49d659d58c12027ae832c1f42
+  metadata.gz: 7d99022760e60aa8858e80aa48ff140654607e6393e2b5ce177a00ec9b7074dee3a3869adc4c1dde75d4e25403de52b109a40d759bc391741cbb923418480a6d
+  data.tar.gz: '0234997375f4ef43041164f7a5346fbc5db672373ee779106aaf47c6e6654b68c89febc169db52c323a886e8c6eaca0dce19e2d0fcb167bce2427f8fbee2ee36'

data/README.md

@@ -1,5 +1,8 @@
 # CogsDRB
 
+[![Gem Version](https://badge.fury.io/rb/cogsdrb.svg)](https://badge.fury.io/rb/cogsdrb)
+[![Gem Downloads](https://badgen.net/rubygems/dt/cogsdrb)](https://badgen.net/rubygems/dt/cogsdrb)
+
 Cogs for [discordrb](https://github.com/discordrb/discordrb), in the style of [discord.py](https://github.com/Rapptz/discord.py)'s cog implementation
 
 Cogs allow you to load commands, events, and variables from outside of the main bot file, 
@@ -39,10 +42,13 @@ require 'discordrb'
 require 'cogsdrb'
 
 bot = Cogs::BaseBotClass.new(token="<token>", prefix="r!")
-path_to_cogs = "C:/FULL/PATH/TO/COGS/" # As of now, cogs can only be loaded using the full path to the file
+path_to_cogs = "Path/to/cogs/dir" # Not necessary, but cuts down on repeated values.
+# Cogs are loaded by using ruby's `load` keyword to allow updating while the bot runs.
+# as such they must be loaded by using a filepath to the ruby file. It's like requiring,
+# but you load it with the function `bot.load_extension`.
 
 %w(mod fun).each do |i| # in this example, the path leads to the folder containing `mod.rb` and `fun.rb`
-  bot.load_cog(fp="#{path_to_cogs}#{i}")
+  bot.load_extension(fp="#{path_to_cogs}#{i}")
 end
 
 bot.run
@@ -56,22 +62,47 @@ require 'cogsdrb'
 
 class Fun < Cogs::Cog # Class *must* inherit from `Cogs::Cog`
   def initialize(bot: Discordrb::Commands::CommandBot)
-    @bot = bot
+    super(bot) # Required for command registration.
   end
 
-  def commands # all commands for a cog *must* be contained in a function named `commands`
-    @bot.command :test do |event| # As many commands as you want can be added in this function
+  def commands # commands can either be declared in the `initialize` function or a function named `commands`
+    self.command :test do |event| # As many commands as you want can be added in either function
       event.respond "Works"
     end
   end
 end
 
 def setup(bot)
-  bot.add_cog(Fun.new bot: bot) # Additionally, all cog files *must* contain this function, or else an error will be thrown and the cog not loaded
+  bot.add_cog(Fun) # Additionally, all cog files *must* contain this function, or else an error will be thrown and the cog not loaded
+end
+```
+
+Additionally, Cogs will allow you to manage what cogs are currently "loaded" on your bot. Here are come example commands for managing cogs.
+```ruby
+self.command :unload do |event, cogname|
+  begin
+    @bot.unload_cog(cogname: cogname)
+    event.respond "Unloaded cog #{cogname}!"
+  rescue Cogs::CogError
+    event.respond "Whoops! Cog #{cogname} either doesn't exist or is already unloaded! Did you spell it right?"
+  end
+end
+
+self.command :load do |event, cogname|
+  begin
+    @bot.reload_cog(cogname)
+    event.respond "Loaded cog #{cogname}!"
+  rescue Cogs::CogError
+    event.respond "Whoops! Cog #{cogname} doesn't exist! Did you spell it correctly?"
+  end
 end
 ```
 
-Support for events and unloading/loading cogs will come in the near future.
+"Unloading" a cog removes all commands categorized in the cog from the bot. "Reloading" allows you to apply updates to
+the bot without terminating the process, as the cog file can be edited and reloaded without terminating
+the bot process.
+
+Support for events will come in the near future.
 
 ## Development
 

data/lib/bot.rb

@@ -9,13 +9,10 @@ module Cogs
 
     end
 
+    attr_accessor :cogs
     attr_reader :cached_cogs
     attr_reader :loaded_cogs
 
-    def add_commands
-      nil
-    end
-
     def run_bot
       self.before
       self.add_commands
@@ -26,18 +23,13 @@ module Cogs
       end
     end
 
-    def before
-      nil
-    end
-
-    def after
-      nil
-    end
+    def add_commands; end
+    def before; end
+    def after; 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?
@@ -69,7 +61,9 @@ module Cogs
         load fp
         cog = setup(self)
         cog::fp = fp
+        cog::name = cog.to_s[2..].split(':')[0]
         @loaded_cogs[cog::name] = cog
+        @cached_cogs[cog::name] = cog.class
       rescue LoadError, NoMethodError => error
         self.log_exception(error)
       end
@@ -77,8 +71,8 @@ module Cogs
 
     def add_cog(cog)
       begin
+        cog = cog.new bot: self
         cog.commands
-        @cached_cogs[cog::name] = cog.class
         return cog
       rescue NoMethodError => error
         self.log_exception(error)
@@ -94,7 +88,7 @@ module Cogs
           return
         end
       end
-      if @cached_cogs.keys.include?cogname
+      if @loaded_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}"
@@ -104,15 +98,16 @@ module Cogs
     end
 
     def reload_cog(cog)
-      raise Cogs::CogError.new "Cog not found" unless @cached_cogs.keys.include?cog or @loaded_cogs.keys.include?cog
+      raise Cogs::CogError.new "Cog not found" unless @cached_cogs.include?cog or @loaded_cogs.include?cog
       if @loaded_cogs.include?cog
         self.unload_cog(cogname: cog)
       end
       self.load_extension(@loaded_cogs[cog]::fp)
+      Discordrb::LOGGER.info "Loaded cog #{cog}"
     end
 
     def load_cog(cog)
-      self.reload_cog(cog: cog)
+      self.reload_cog(cog)
     end
   end
 end

data/lib/cogsdrb.rb

@@ -5,13 +5,19 @@ require "commands"
 
 module Cogs
     class Cog
-        def initialize(name: "Cog")
-            @name = name
-            @fp = fp
+        def initialize(bot)
+            @bot = bot
         end
 
-        attr_reader :name
+        attr_accessor :name
         attr_accessor :fp
+
+        def command(name, attributes = {}, &block)
+            attributes[:cog] = @name unless attributes[:cog]
+            @bot.command(name, attributes, &block)
+        end
+
+        def commands; end
     end
 
     # TODO:

data/lib/cogsdrb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cogsdrb
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.9
 platform: ruby
 authors:
 - No-Jons
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2020-10-31 00:00:00.000000000 Z
 dependencies: []
 description:
 email: