(update): tip command fix + new command (#73)

maisans-maid · web-flow · commit 43d9dd08d113 · 2021-01-10T04:24:37.000+08:00
* (update): Version 4.0.4 update (#71) * (feat): create Continuous Integration (#72) * (update): Remove old node versions * (feat): add test file * Update README.md * (update): add dev branch to workflow * (fix): tip throwing error when tipping unregistered users * (feat): new command -> creditslb * (fix): string truncation * (update): rename coins to credits on bal command. * (refactor): add streak on bal command
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -0,0 +1,30 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master, dev ]
+  pull_request:
+    branches: [ master, dev ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test
diff --git a/README.md b/README.md
@@ -1,26 +1,72 @@
-## &ensp;[Mai](https://invite.mai-san.ml/) - A Discord Bot Based Around Anime
-
-[![Online](https://img.shields.io/discord/703922441768009731?color=%237289DA&label=Support&logo=discord&logoColor=white)](https://support.mai-san.ml/)
-[![App Version](https://img.shields.io/github/package-json/v/maisans-maid/mai/master?color=pink&label=Current%20Version)](https://github.com/maisans-maid/Mai)
-[![Node](https://img.shields.io/static/v1?label=node&message=>=14.0.0&color=success&logo=Node.js&logoColor=white)](https://nodejs.org/dist/latest-v14.x/)
-[![heroku](https://img.shields.io/static/v1?label=heroku&message=ready%20to%20deploy&color=purple&logo=heroku)](https://herokuapp.com)
-[![DJS](https://img.shields.io/github/package-json/dependency-version/maisans-maid/Mai/discord.js?logo=github)](https://discord.js.org/)
-[![License](https://img.shields.io/github/license/maisans-maid/Mai?color=pink&label=License)](https://github.com/maisans-maid/Mai/blob/master/LICENSE)
-[![Dependencies Status](https://david-dm.org/maisans-maid/Mai/status.svg)](https://david-dm.org/maisans-maid/Mai)
-###### &ensp;&ensp;A multifunctional **Discord Bot**, written in **Discord.js V12**~
+<h1 align="center"> <img src='https://cdn.discordapp.com/emojis/757869043117064223.png?v=1' height='50'> Mai</h1>
+
+<p align="center"> A Discord Bot Based Around Anime, and Mai </p>
+
+<p align="center">
+  <a href="http://forthebadge.com/">
+    <img src="http://forthebadge.com/images/badges/built-with-love.svg"/>
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://standardjs.com/">
+    <img src="https://cdn.rawgit.com/feross/standard/master/badge.svg" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/maisans-maid/Mai">
+    <img src="https://img.shields.io/github/package-json/v/maisans-maid/mai/master?color=pink&label=Current%20Version" alt="App Version" />
+  </a>
+  <a href="https://nodejs.org/dist/latest-v14.x/">
+    <img src="https://img.shields.io/static/v1?label=node&message=>=14.0.0&color=success&logo=Node.js&logoColor=white" alt="Node Requirements">
+  </a>
+  <a href="https://github.com/maisans-maid/Mai">
+    <img src="https://img.shields.io/github/workflow/status/maisans-maid/mai/Node.js%20CI" alt="build">
+  </a>
+  <a href="https://github.com/maisans-maid/Mai/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/maisans-maid/Mai?color=pink&label=License" alt="LICENSE">
+  </a>
+  <a href="https://david-dm.org/maisans-maid/Mai">
+    <img src="https://david-dm.org/maisans-maid/Mai/status.svg" alt="LICENSE">
+  </a>
+  <a href="https://support.mai-san.ml/">
+    <img src="https://img.shields.io/discord/703922441768009731?color=%237289DA&label=Support&logo=discord&logoColor=white" alt="Online">
+  </a>
+</p>
+<p align="center">
+  
+</p>
+
 ---
+
 <br />
 
 Check the docs on https://mai-san.ml/
 
+### Host
+Create Env file:
+
+*Refer to .env_example file for other usable environment variables*
+```
+DISCORD_TOKEN=
+```
+
+Run the following command on your CLI
+```
+npm install
+
+npm start
+```
+
 ### Why should you invite Mai?
 Mai is a simple yet powerful Discord Bot that aims to give discord users an enhanced "Discord Experience". Mai provides a variety of fun and informative commands that you can use with your friends.
 
 Mai can:
 - Spice up chat environment with the use of roleplay/action commands such as pat, hug, slap, and more! </font> <br />
 -  Search through the internet for information resources through various functions such as anime information lookup (series, characters, and even seiyuus!), games (via steam), or even time on some cities. </font> <br />
 -  Ease the work of moderators by managing the server through various single commands. </font> <br />
--  Provide Airing Information automagically, implement user experience system, as well as server-based economy system. </font> <br />
+-  Provide Airing Information automagically, implement user experience system, as well as economy system. </font> <br />
 -  Acquire totally random fun facts from various sources Mai has access to. </font> <br />
 
 
@@ -31,34 +77,15 @@ You may invite Mai through https://invite.mai-san.ml.
 If you have questions regarding the bot and it's use, please do join our support server at https://support.mai-san.ml/.
 
 ### Contribute
-Contribution includes, but is not limited to making a Pull Request. For reference, I have been struggling on proper implementation of the economy command. I am expecting that most contributors will probably be coming from there.
+Contribution includes, but is not limited to making a Pull Request.
 
 Pull Requests regarding totally new commands without foretelling the developer via creating issue will automatically be rejected.
 
 If you love this work and wish to contribute in another manner, please do join our support server (which isn't much) and ping/mention **Sakurajimai#6742** there.
 
-### Credits
-"Give Credit when it's Due" - is a phrase that i love so much. Therefore, i will be mentioning here the projects/people that helped Mai grow as a powerful Discord Bot.
-
-- [Discord.js](https://github.com/discordjs/discord.js/) by [discordjs](https://github.com/discordjs/) - a powerful javascript library for interacting with the [Discord API](https://discord.com/developers/docs/intro).
-- [AniList](https://github.com/TehNut/AniSchedule) by [TehNut](https://github.com/TehNut) - an anime announcer made purely on javascript that became the basis for one of Mai's main feature in the present.
-- [Komugari](https://github.com/Mitorisia/Komugari) by [Mitorisia](https://github.com/Mitorisia) - a discord bot written in [Discord.js@Commando](https://github.com/discordjs/Commando) that has been the basis for most of Mai's current commands.
-- The kind people on Discord.js Official, Coding Den, Programmer's Hangout, and Discord API servers that helped me debug errors on my code whenever I fail to solve it myself.
-
-Hey you! Yes You! If you've been using Mai as a reference, please give her due credit.
 
 ### License
 Mai is Licensed under MIT.
->MIT License
->
->Copyright (c) 2020 Sakurajimai#6742
->
->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.
 
 
 ### Disclaimer
diff --git a/commands/social/bal.js b/commands/social/bal.js
@@ -25,13 +25,13 @@ module.exports = {
       new MessageEmbed().setDescription(
         `\u200B\n💰 **${
           text.commatize(doc.data.economy.wallet)
-        }** coins in posession.\n\n${
+        }** credits in posession.\n\n${
           doc.data.economy.bank !== null
-          ? `💰 **${text.commatize(doc.data.economy.bank)}** coins in bank!`
+          ? `💰 **${text.commatize(doc.data.economy.bank)}** credits in bank!`
           : `Seems like you don't have a bank yet. Create one now by typing \`${
             client.config.prefix
           }bank\``
-        }`
+        }\n\nDaily Streak: **${doc.data.economy.streak.current}** (All time best: **${doc.data.economy.streak.alltime}**)`
       ).setAuthor(`${message.member.displayName}'s wallet`)
       .setColor('GREY')
       .setThumbnail(message.author.displayAvatarURL({dynamic: 'true'}))
diff --git a/commands/social/creditslb.js b/commands/social/creditslb.js
@@ -0,0 +1,112 @@
+const { MessageEmbed } = require('discord.js');
+const profile = require(`${process.cwd()}/models/Profile`);
+const text = require(`${process.cwd()}/util/string`);
+
+module.exports = {
+  name: 'creditslb',
+  aliases: [ 'richlb', 'richleaderboard', 'creditsleaderboard' ],
+  guildOnly: true,
+  rankcommand: true,
+  group: 'social',
+  description: 'Shows the top credit earners for this server',
+  requiresDatabase: true,
+  clientPermissions: [ 'EMBED_LINKS' ],
+  get examples(){ return [this.name, ...this.aliases ];},
+  run: (client, message) => {
+
+    const { exceptions, isActive } = client.guildProfiles.get(message.guild.id).xp;
+    const embed = new MessageEmbed()
+    .setFooter(`XP Leaderboard | \©️${new Date().getFullYear()} Mai`)
+    .setThumbnail('https://i.imgur.com/qkBQB8V.png')
+    .setColor('RED');
+
+    if (!isActive){
+      return message.channel.send(
+        embed.setDescription([
+          `**${message.member.displayName}**, XP is currently disabled in this server.\n`,
+          `If you are the server Administrator, you may enable it by typing \`${client.config.prefix}xptoggle\`.`,
+          `[Learn More](https://mai-san.ml/docs/features/XP_System) about Mai's XP System.`
+        ].join('\n'))
+        .setAuthor('XP Systems Disabled','https://cdn.discordapp.com/emojis/767062250279927818.png?v=1')
+      );
+    };
+
+    if (exceptions.includes(message.channel.id)){
+      return message.channel.send(
+        embed.setDescription([
+          `**${message.member.displayName}**, XP is currently disabled in this channel.\n`,
+          `To see which channels are xp-disabled, use the command \`${client.config.prefix}nonxpchannels\``,
+          `If you are the server Administrator, you may reenable it here by typing \`${client.config.prefix}xpenable #${message.channel.name}\``,
+          `[Learn More](https://mai-san.ml/docs/features/XP_System) about Mai's XP System.`
+        ].join('\n'))
+        .setAuthor('Channel Blacklisted','https://cdn.discordapp.com/emojis/767062250279927818.png?v=1')
+      );
+    };
+
+    return profile.find({ 'data.xp.id': message.guild.id }, async (err, docs) => {
+      if (err) {
+        return message.channel.send(
+          embed.setAuthor('Database Error','https://cdn.discordapp.com/emojis/767062250279927818.png?v=1')
+          .setDescription('Mai\'s Database Provider responded with an error: ' + err.name)
+        );
+      };
+
+      docs = docs.map(x => { return { id: x._id, wallet: x.data.economy.wallet, bank: x.data.economy.bank};})
+      .sort((A,B) => ((B.wallet || 0) + (B.bank || 0)) - ((A.wallet || 0) + (A.bank || 0))) // Arrange by credits, descending.
+      .filter(x => Boolean(x.wallet || 0 + x.bank || 0)); // Remove document where total credits is 0.
+
+      console.log(docs)
+
+      if (!docs.length){
+        return message.channel.send(
+          embed.setDescription([
+            `**${message.member.displayName}**, No credit documents found.\n\n`,
+            'Users in this server have not started earning credits yet!\n',
+            '[Learn More](https://mai-san.ml/) about Mai\'s Economy System.'
+          ].join('\n'))
+          .setAuthor('No Credits','https://cdn.discordapp.com/emojis/767062250279927818.png?v=1')
+        );
+      };
+
+      const members = await message.guild.members
+      .fetch({ user: docs.slice(0,10).map(x => x.id) })
+      .catch(() => null)
+
+      return message.channel.send(
+        new MessageEmbed()
+        .setColor('GREY')
+        .setFooter(`Credits Leaderboard | \©️${new Date().getFullYear()} Mai`)
+        .setAuthor(`🏆 ${message.guild.name} Credits Leaderboard`, message.guild.iconURL({format: 'png', dynamic: true }) || null)
+        .addField(`**${members.get(docs[0].id)?.displayName || '<Unknown User>'}** ranked the highest with **${text.commatize(docs[0].wallet + docs[0].bank)} **Credits!`,
+        [
+          '```properties',
+          '╭═══════╤════════╤═════════╤════════════════════════════╮',
+          '┃  Rank ┃ Wallet ┃    Bank ┃ User                       ┃',
+          '╞═══════╪════════╪═════════╪════════════════════════════╡',
+          docs.slice(0,10).map((u,i) => {
+            const rank = String(i+1);
+            return [
+              '┃' + ' '.repeat(6-rank.length) + rank,
+              ' '.repeat(6-text.compactNum(u.wallet).length) + text.compactNum(u.wallet),
+              ' '.repeat(7-text.compactNum(u.bank).length) + text.compactNum(u.bank),
+              members.get(u.id)?.user.tag || '<Unknown User>'
+            ].join(' ┃ ')
+          }).join('\n'),
+          '╞═══════╪════════╪═════════╪════════════════════════════╡',
+          docs.filter(x => x.id === message.author.id).map((u,i,a) => {
+            const user = a.find(x => x.id === message.author.id);
+            const rank = docs.findIndex(x => x.id === message.author.id) + 1;
+            return [
+              '┃' + ' '.repeat(6-text.ordinalize(rank).length) + text.ordinalize(rank),
+              ' '.repeat(6-text.compactNum(u.wallet).length) + text.compactNum(u.wallet),
+              ' '.repeat(7-text.compactNum(u.bank).length) + text.compactNum(u.bank),
+              text.truncate('You (' + message.author.tag + ')', 26) + ' '.repeat(27-text.truncate('You (' + message.author.tag + ')', 26).length) + '┃'
+            ].join(' ┃ ')
+          }).join(''),
+          '╰═══════╧════════╧═════════╧════════════════════════════╯',
+          '```'
+        ].join('\n'))
+      );
+    });
+  }
+};
diff --git a/commands/social/leaderboard.js b/commands/social/leaderboard.js
@@ -98,7 +98,7 @@ module.exports = {
               '┃' + ' '.repeat(6-text.ordinalize(rank).length) + text.ordinalize(rank),
               ' '.repeat(5-String(u.data.level).length) + u.data.level,
               ' '.repeat(6-text.compactNum(u.data.xp).length) + text.compactNum(u.data.xp),
-              text.truncate('You (' + message.author.tag + ')', 27) + ' '.repeat(27-text.truncate('You (' + message.author.tag + ')', 27).length) + '┃'
+              text.truncate('You (' + message.author.tag + ')', 26) + ' '.repeat(27-text.truncate('You (' + message.author.tag + ')', 26).length) + '┃'
             ].join(' ┃ ')
           }).join(''),
           '╰═══════╧═══════╧════════╧════════════════════════════╯',
diff --git a/commands/social/tip.js b/commands/social/tip.js
@@ -66,7 +66,7 @@ module.exports = {
       .then(() => message.channel.send([
         `\\✔️ **${message.author.tag}**, tipped **${amount}** to **${member.user.tag}**.`,
         overflow ? `\n\\⚠️ **Overflow Warning**: **${member.user.tag}**'s wallet just overflowed! You need to transfer some of your credits to your bank!` : '',
-        unregistered ? `\n\\⚠️ **Unregistered**: **${member.user,tag}** is unregistered, the bonus credits will not be added.` : ''
+        unregistered ? `\n\\⚠️ **Unregistered**: **${member.user.tag}** is unregistered, the bonus credits will not be added.` : ''
       ].join('')))
       .catch(() => message.channel.send(`\`❌ [DATABASE_ERR]:\` Unable to save the document to the database, please try again later!`))
     });
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,10 +1,10 @@
 {
   "name": "mai",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Discordbot written in discord.js",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "node test.js",
     "start": "node index.js"
   },
   "engines": {
diff --git a/test.js b/test.js
@@ -0,0 +1,50 @@
+// NOTE: ./struct not included on test
+
+const options = {
+  paths: [
+    'action', 'anime', 'bot',
+    'core', 'fun', 'moderation',
+    'owner', 'setup', 'social','utility'
+  ]
+};
+
+const { readdir } = require('fs');
+
+// Test events
+for (const path of options.paths){
+  readdir(`./commands/${path}`, (err, files) => {
+    files.filter(file => file.split('.').pop === 'js').forEach(file => {
+      require(`./commands/${path}/${file}`);
+    });
+  });
+};
+
+// Test events
+readdir(`./events`, (err, files) => {
+  files.filter(file => file.split('.').pop() === 'js').forEach(file => {
+    require(`./events/${file}`);
+  });
+});
+
+// Test JSON assets
+readdir('./assets/json', (err, files) => {
+  files.filter(file => file.split('.').pop() === 'json').forEach(file => {
+    require(`./assets/json/${file}`);
+  });
+});
+
+// Test utils
+readdir('./util', (err, files) => {
+  files.filter(file => file.split('.').pop() === 'js').forEach(file => {
+    require(`./util/${file}`);
+  });
+});
+
+// Test ./utils/games
+readdir('./util/games', (err, files) => {
+  files.filter(file => file.split('.').pop() === 'js').forEach(file => {
+    require(`./util/games/${file}`);
+  });
+});
+
+// End of Test
