advanced_ruby_command_handler 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29ce9948b2b75e95125369d796c72f092a42892bffc7a66a768dc52d6bebaf18
-  data.tar.gz: 74cc5f8f368f366335e011a07de894dcabe6a59a613d552651de81485a881683
+  metadata.gz: e70e9c870edb9511be72ddda44180add9a4d0e3651a9e1158836f55c0cd24dbd
+  data.tar.gz: ffdcb7bf02966eb556801c36c559712744b9be93553e5c82ec1d36fc3edf40f3
 SHA512:
-  metadata.gz: 7c08da956a0b831f157c37b79cbe251f0176a6b57f8f65b0f153031547411d5b809bf872e8f6e5da60257676bcce72ecf190ddd8eb8ad26a158f9091545cc8f4
-  data.tar.gz: 4f6c83b2a00a332d20e1e7c6e5048fa1fdb4dc71620171064c0febe7adb619e22e8ae7d8810e44693f382c71b23a651adb4c3f7dff5eb684bdcca277623a8b11
+  metadata.gz: d4252035f4338480983222c7ffe97f598e9b887936b0abf693d60cc4673f130c3fa3a00d8c148c40090f0723fa082d422e4ed97d7631442ab5e7fbf3114cb44b
+  data.tar.gz: a0a4ef7f06ef3af9e8144af41b44c2ee9f71d842add17cfb653409d0a962fdbf7f017e11c5a657b1b596e1d686bd17cc1f65073b415ea3a61f86180aa5a0cd92

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -6,4 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-/.idea/
+/.idea/
+*.gem
+*.yml

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    advanced_ruby_command_handler (0.1.1)
+    advanced_ruby_command_handler (0.1.5)
+      discordrb
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,3 +1,8 @@
+
+[![forthebadge](https://forthebadge.com/images/badges/made-with-ruby.svg)](https://forthebadge.com)
+
+[![Les Laboratoires Ruby](https://invidget.switchblade.xyz/4P7XcmbDnt)](https://discord.gg/4P7XcmbDnt)
+
 # AdvancedRubyCommandHandler
 ## Installation
 

data/advanced_ruby_command_handler.gemspec

@@ -29,8 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "discordrb"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/advanced_ruby_command_handler/app/client.rb

@@ -5,6 +5,7 @@ require "fileutils"
 require "yaml"
 require_relative "command_handler"
 require_relative "event_handler"
+require_relative "utils"
 
 module AdvancedRubyCommandHandler
   class Client < Discordrb::Bot
@@ -34,13 +35,15 @@ module AdvancedRubyCommandHandler
         raise "'#{prop}' missing or empty"
       end
 
-      super(:token => @config[:token])
+      super(:token => @config[:token], :ignore_bots => true)
 
       @commands = AdvancedRubyCommandHandler::CommandHandler.load_commands(self)
       AdvancedRubyCommandHandler::EventHandler.load_events(self)
                                               .each do |event|
         Events.method(event).call(self)
       end
+
+      at_exit { @console_logger.info("Application exited") }
     end
 
     def run
@@ -49,8 +52,9 @@ module AdvancedRubyCommandHandler
       Thread.new do
         @console_logger.info("Type '.exit' to turn off the bot")
         # @console_logger.info("Type '.reload' to reload the bot")
-
-        exit if $stdin.gets.chomp == ".exit"
+        loop do
+          Process.exit!(true) if $stdin.gets.chomp == ".exit"
+        end
       end
 
       super.run

data/lib/advanced_ruby_command_handler/app/command.rb

@@ -5,8 +5,51 @@ module CommandHandler
     attr_reader :props, :run
 
     def initialize(props, &run)
-      @props = props
+      @props = load_proprieties(props)
       @run = run
     end
+
+    def load_proprieties(props)
+      return props unless props.instance_of?(Hash)
+
+      props[:aliases] ||= nil
+      props[:description] ||= nil
+      props[:args] ||= nil
+      props[:strict_args] ||= false
+      props[:use_example] ||= nil
+      props[:category] ||= nil
+      props[:user_permissions] ||= []
+      props[:client_permissions] ||= []
+      if props[:client_permissions].instance_of?(Array) && props[:client_permissions].empty?
+        props[:client_permissions].push(
+          :add_reactions,
+          :send_messages,
+          :embed_links,
+          :attach_files,
+          :use_external_emoji
+        )
+      elsif props[:client_permissions] == :default
+        props[:client_permissions] = %i[
+          add_reactions
+          send_messages
+          embed_links
+          attach_files
+          use_external_emoji
+        ]
+      end
+
+      Hash[
+        :name => props[:name],
+        :aliases => props[:aliases],
+        :description => props[:description],
+        :args => props[:args],
+        :strict_args => props[:strict_args],
+        :use_example => props[:use_example],
+        :category => props[:category],
+        :user_permissions => props[:user_permissions],
+        :client_permissions => props[:client_permissions]
+      ]
+    end
+    private :load_proprieties
   end
 end

data/lib/advanced_ruby_command_handler/app/command_handler.rb

@@ -10,7 +10,9 @@ module AdvancedRubyCommandHandler
         next if %w[. ..].include?(dir)
 
         Dir.entries("#{client.commands_dir}/#{dir}").each do |file|
-          next if %w(. ..).include?(file)
+          next if %w[. ..].include?(file)
+
+          p "#{client.commands_dir}/#{dir}/#{file}"
 
           load "#{client.commands_dir}/#{dir}/#{file}"
 

data/lib/advanced_ruby_command_handler/{defaults → app/defaults}/events/message.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../../app/utils"
+require_relative "../../utils"
 
 module Events
   def self.message(client)
@@ -11,7 +11,14 @@ module Events
 
       next unless command
 
-      command.run.call(message, client)
+      begin
+        command.run.call(message, client)
+      rescue StandardError => e
+        client.console_logger.error(e)
+        client.file_logger.write(e, :errors)
+      ensure
+        client.console_logger.info("Command '#{command.props[:name]}' used by #{message.author.username}")
+      end
     end
   end
 end

data/lib/advanced_ruby_command_handler/app/event_handler.rb

@@ -13,12 +13,10 @@ module AdvancedRubyCommandHandler
         events << File.basename(file, ".rb")
       end
 
-      Dir.entries("lib/advanced_ruby_command_handler/defaults/events").each do |file|
-        next if %w(. ..).include?(file)
-
+      Dir["#{File.dirname(__FILE__)}/defaults/events/*.rb"].sort.each do |file|
         next if events.include?(File.basename(file, ".rb"))
 
-        load "lib/advanced_ruby_command_handler/defaults/events/#{file}"
+        require file
 
         events << File.basename(file, ".rb")
       end

data/lib/advanced_ruby_command_handler/app/logger.rb

@@ -57,7 +57,6 @@ module AdvancedRubyCommandHandler
         puts "[#{console_color(:magenta, time)}] - [#{console_color(color, mode.to_s.upcase)}] : #{message.to_s}"
       end
     end
-
     private :console_color
   end
 end

data/lib/advanced_ruby_command_handler/app/utils.rb

@@ -7,5 +7,13 @@ module CommandHandler
 
       false
     end
+
+    # Do NOT use that
+    # FIXME
+    def reload_files(dirs)
+      dirs.each do |dir|
+        Dir.glob("#{dir}/**/*.rb").each { |file| load file }
+      end
+    end
   end
 end

data/lib/advanced_ruby_command_handler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdvancedRubyCommandHandler
-  VERSION = "0.1.1"
+  VERSION = "0.1.6"
 end

data/lib/advanced_ruby_command_handler.rb

@@ -1,12 +1,19 @@
-# frozen_string_literal: true
-
-require_relative "advanced_ruby_command_handler/app/app"
-require_relative "advanced_ruby_command_handler/app/command"
-require_relative "advanced_ruby_command_handler/app/utils"
-
-
-module CommandHandler
-  def self.new(commands_dir: "commands", events_dir: "events", config_file: "config.yml")
-    AdvancedRubyCommandHandler::Client.new(:commands_dir => commands_dir, :events_dir => events_dir, :config_file => config_file)
-  end
-end
+# frozen_string_literal: true
+
+require_relative "advanced_ruby_command_handler/app/app"
+require_relative "advanced_ruby_command_handler/app/command"
+require_relative "advanced_ruby_command_handler/app/utils"
+
+##
+# Represent the CommandHandler as a simply class
+module CommandHandler
+  ##
+  # @!method new
+  # @param [String] commands_dir The command's directory path
+  # @param [String] events_dir The event's directory path
+  # @param [String] config_file The config's file path
+  # @return [AdvancedRubyCommandHandler::Client] the created client
+  def self.new(commands_dir: "commands", events_dir: "events", config_file: "config.yml")
+    AdvancedRubyCommandHandler::Client.new(:commands_dir => commands_dir, :events_dir => events_dir, :config_file => config_file)
+  end
+end

data/tests/commands/test/test.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
 require_relative "../../../lib/advanced_ruby_command_handler/app/command"
+require_relative "../../../lib/advanced_ruby_command_handler/app/utils"
 
 module Commands
   def self.test
     CommandHandler::Command.new({
-                                  :name => "test"
-                                }) do |message, client|
-      message.respond "Command test!"
+                                  :name => "test",
+                                  :aliases => ["t"],
+                                  :description => "Une commande pour faire des tests!",
+                                  :args => false,
+                                  :use_example => :default,
+                                  :category => :default
+                                }) do |message, _client|
+      message.respond "Test"
     end
   end
 end

data/tests/config.yml

@@ -1,4 +1,4 @@
 ---
-:token: 'NzEwMTIxODk2OTM0NjM3NjY5.Xrv2jQ.4v9551dYI5nqRSIGfYy19APUmbA'
+:token: 'NzEwMTIxODk2OTM0NjM3NjY5.Xrv2jQ._ypS5jOkYr4onqigdoxGzF2dRj0'
 :prefix: '!'
 :owners: [123456789]

data/tests/events/ready.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Events
+  def self.ready(client)
+    client.ready do
+      client.console_logger.info("Client ready!")
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: advanced_ruby_command_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - senchuu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-26 00:00:00.000000000 Z
-dependencies: []
+date: 2021-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: discordrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: an advanced discord bot command handler
 email:
 - senchuuuu@gmail.com
@@ -17,9 +31,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -33,14 +49,15 @@ files:
 - lib/advanced_ruby_command_handler/app/client.rb
 - lib/advanced_ruby_command_handler/app/command.rb
 - lib/advanced_ruby_command_handler/app/command_handler.rb
+- lib/advanced_ruby_command_handler/app/defaults/events/message.rb
+- lib/advanced_ruby_command_handler/app/defaults/events/ready.rb
 - lib/advanced_ruby_command_handler/app/event_handler.rb
 - lib/advanced_ruby_command_handler/app/logger.rb
 - lib/advanced_ruby_command_handler/app/utils.rb
-- lib/advanced_ruby_command_handler/defaults/events/message.rb
-- lib/advanced_ruby_command_handler/defaults/events/ready.rb
 - lib/advanced_ruby_command_handler/version.rb
 - tests/commands/test/test.rb
 - tests/config.yml
+- tests/events/ready.rb
 - tests/index.rb
 homepage: https://github.com/Senchuu/Advanced-Bot.rb
 licenses: