cogsdrb 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93ee70ecaddfe627a3559db5799bfedd5301c256231d8b48fb3e2ad93520de97
+  data.tar.gz: 695d51fd6712fd1c65885a51ca5a5ede23baeb16c9d5fc0cab7dd6d0590d1102
+SHA512:
+  metadata.gz: a6e598efcde6e809992c79a39de90d96216f69ce5f73b07934e0a0202937516731e4eddc2d1de645ad42f4454dde9fe84827df1f51a05d7baa0df9ecf1621822
+  data.tar.gz: 55427a2092555d1499ee4a31b2c181da54ca9b6d7fe8a7f6d90fe5d60636507e884ba42daae5188dd3e71efb182dcf2040a789a4fcc09bafb422b69d5fba83fe

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 61525221+No-Jons@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in drb-cogsdrb.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "discordrb"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 No-Jons
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# 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, 
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cogsdrb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cogsdrb
+
+## Usage
+
+When requiring the gem, you gain access to a few new classes through the `Cogs` module.
+ - `Cogs::Cog`
+ - `Cogs::BaseBotClass`
+
+`Cogs::BaseBotClass` is a class that inherits from `Discordrb::Commands::CommandBot` and adds the functions necessary
+for cogs to be implemented.
+
+Here is a quickstart example:
+
+```ruby
+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
+
+%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}")
+end
+
+bot.run
+```
+
+And here is what `fun.rb` looks like:
+
+```ruby
+require 'discordrb'
+require 'cogsdrb'
+
+class Fun < Cogs::Cog # Class *must* inherit from `Cogs::Cog`
+  def initialize(bot: Discordrb::Commands::CommandBot)
+    @bot = bot
+  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
+      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
+end
+```
+
+Support for events and unloading/loading cogs will come in the near future.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "drb/cogsdrb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cogsdrb.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/cogsdrb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cogsdrb"
+  spec.version       = Cogs::VERSION
+  spec.authors       = ["No-Jons"]
+  spec.email         = ["61525221+No-Jons@users.noreply.github.com"]
+
+  spec.summary       = %q{Cogs for discordrb, in the style of discord.py}
+  spec.homepage      = "https://github.com/No-Jons/cogsdrb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/No-Jons/cogsdrb"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/cogsdrb.rb

@@ -0,0 +1,73 @@
+require 'discordrb'
+require "cogsdrb/version"
+
+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
+        end
+
+        def name
+            @name
+        end
+    end
+
+    # TODO:
+    #   - Loading and unloading of cogs
+    #   - Event listeners
+    #   - Cog meta attributes
+    #   - More dpy-like implementation
+    #   - Clean it up and make it not hacky af
+
+end

data/lib/cogsdrb/version.rb

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

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: cogsdrb
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- No-Jons
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-30 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- 61525221+No-Jons@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cogsdrb.gemspec
+- lib/cogsdrb.rb
+- lib/cogsdrb/version.rb
+homepage: https://github.com/No-Jons/cogsdrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/No-Jons/cogsdrb
+  source_code_uri: https://github.com/No-Jons/cogsdrb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Cogs for discordrb, in the style of discord.py
+test_files: []