[FEAT] creates and uses Command.helper util

carlos3g · carlos3g · commit c5987ad58f79 · 2021-08-10T23:16:05.000-03:00
diff --git a/index.js b/index.js
@@ -5,6 +5,7 @@ const {
   Coin,
   Commands,
   Cron,
+  Everyone,
   Links,
   Lyric,
   Report,
@@ -18,6 +19,7 @@ const alice = new Alice([
   new Coin(),
   new Commands(),
   new Cron(),
+  new Everyone(),
   new Links(),
   new Lyric(),
   new Report(),
diff --git a/src/commands/about.js b/src/commands/about.js
@@ -1,14 +1,11 @@
 const { Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Mostra informações sobre o bot.
-
-  *uso:* \`\`\`!about [--args]\`\`\`
-
-  *args válidos:* 
-  \`\`\`--help\`\`\` -> _mostra esta mensagem._
-  `,
+  help: Command.helper({
+    description: 'Mostra informações sobre o bot.',
+    usage: '!about [--args]',
+    args: { help: 'mostra esta mensagem.' },
+  }),
 
   about: Command.message`
   Alice foi criada utilizando a biblioteca \`\`\`whatsapp-web.js\`\`\` como base sob licença Apache 2.0. Saiba mais em _https://github.com/pedroslopez/whatsapp-web.js_
diff --git a/src/commands/coin.js b/src/commands/coin.js
@@ -3,15 +3,15 @@ const cheerio = require('cheerio');
 const { Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Retorna dados de uma moeda disponível no CoinMarketCap (https://coinmarketcap.com).
-
-  *uso:* \`\`\`!coin [--args] coin_name\`\`\`
-
-  *args válidos:* 
-  \`\`\`--all\`\`\` -> _retorna todos os dados disponíveis._
-  \`\`\`--help\`\`\` -> _mostra essa mensagem._
-  `,
+  help: Command.helper({
+    description:
+      'Retorna dados de uma moeda disponível no CoinMarketCap (https://coinmarketcap.com).',
+    usage: '!coin [--args] coin_name',
+    args: {
+      all: 'retorna todos os dados disponíveis.',
+      help: 'mostra esta mensagem.',
+    },
+  }),
 };
 
 async function loadCheerio(url) {
diff --git a/src/commands/commands.js b/src/commands/commands.js
@@ -1,21 +1,21 @@
 const { Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Lista todos os comandos disponíveis.
-
-  *uso:* \`\`\`!commands [--args]\`\`\`
-
-  *args válidos:* 
-  \`\`\`--help\`\`\` -> _mostra esta mensagem._
-  `,
+  help: Command.helper({
+    description: 'Lista todos os comandos disponíveis.',
+    usage: '!commands [--args]',
+    args: {
+      help: 'mostra esta mensagem.',
+    },
+  }),
 
   availableCommands: Command.message`
   Os seguintes comandos estão disponiveis:
   - !about
   - !coin
   - !commands
   - !cron
+  - !everyone
   - !links
   - !lyric
   - !report
diff --git a/src/commands/cron.js b/src/commands/cron.js
@@ -2,26 +2,26 @@ const events = require('events');
 const { chattools, Time, Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Repete uma mensagem em um determinado período de tempo. Cada mensagem é representada por uma thread.
-
-  *uso:* \`\`\`!cron --args [--kwargs=<type>] ...\`\`\`
-
-  *args válidos:* 
-  \`\`\`--create\`\`\` -> _cria uma nova thread._
-  \`\`\`--destroy\`\`\` -> _para e apaga uma thread._
-  \`\`\`--stop\`\`\` -> _para uma thread._
-  \`\`\`--start\`\`\` -> _inicia uma thread._
-  \`\`\`--log\`\`\` -> _mostra as threads existentes._
-  \`\`\`--killall\`\`\` -> _para e apaga todas as threads._
-  \`\`\`--help\`\`\` -> _mostra esta mensagem._
-
-  *kwargs válidos:*
-  \`\`\`--s=<int>\`\`\` -> _define um periodo em segundos._
-  \`\`\`--m=<int>\`\`\` -> _define um periodo em minutos._
-  \`\`\`--h=<int>\`\`\` -> _define um periodo em horas._
-  \`\`\`--d=<int>\`\`\` -> _define um periodo em dias._
-  `,
+  help: Command.helper({
+    description:
+      'Repete uma mensagem em um determinado período de tempo. Cada mensagem é representada por uma thread.',
+    usage: '!cron --args [--kwargs=<type>] ...',
+    args: {
+      create: 'cria uma nova thread.',
+      destroy: 'para e apaga uma thread.',
+      stop: 'para uma thread.',
+      start: 'inicia uma thread.',
+      log: 'mostra as threads existentes.',
+      killall: 'para e apaga todas as threads.',
+      help: 'mostra esta mensagem.',
+    },
+    kwargs: {
+      's=<int>': 'define um periodo em segundos.',
+      'm=<int>': 'define um periodo em minutos.',
+      'h=<int>': 'define um periodo em horas.',
+      'd=<int>': 'define um periodo em dias.',
+    },
+  }),
 };
 const emitter = new events.EventEmitter();
 
diff --git a/src/commands/everyone.js b/src/commands/everyone.js
@@ -0,0 +1,50 @@
+const { chattools, Command } = require('../utils');
+
+const STRINGS = {
+  help: Command.helper({
+    description: 'Marca todos os membros do grupo com a mensagem citada.',
+    usage: '!everyone [--args]',
+    args: {
+      help: 'mostra esta mensagem.',
+    },
+  }),
+
+  defaultMessage: Command.message`@everyone`,
+};
+
+class Everyone {
+  constructor() {
+    this.name = 'everyone';
+    this.strings = STRINGS;
+  }
+
+  async execute(data, message) {
+    const { args } = data;
+    const isAdm = await chattools.isAdm(message);
+
+    if (!isAdm) {
+      message.reply('staff only.');
+      return;
+    }
+
+    if (args.includes('help')) {
+      message.reply(this.strings.help);
+      return;
+    }
+
+    const chat = await message.getChat();
+    const { participants } = chat;
+
+    if (message.hasQuotedMsg) {
+      const quotedMessage = await message.getQuotedMessage();
+      quotedMessage.reply(this.strings.defaultMessage, undefined, {
+        mentions: participants,
+      });
+      return;
+    }
+
+    throw new Error('No message was replied.');
+  }
+}
+
+module.exports = Everyone;
diff --git a/src/commands/index.js b/src/commands/index.js
@@ -5,6 +5,7 @@ module.exports = {
   Coin: require('./coin'),
   Commands: require('./commands'),
   Cron: require('./cron'),
+  Everyone: require('./everyone'),
   Links: require('./links'),
   Lyric: require('./lyric'),
   Report: require('./report'),
diff --git a/src/commands/links.js b/src/commands/links.js
@@ -1,14 +1,13 @@
 const { Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Lista links para os grupos coding.
-
-  *uso:* \`\`\`!links [--args]\`\`\`
-
-  *args válidos:* 
-  \`\`\`--help\`\`\` -> _mostra esta mensagem._
-  `,
+  help: Command.helper({
+    description: 'Lista links para os grupos coding.',
+    usage: '!links [--args]',
+    args: {
+      help: 'mostra esta mensagem.',
+    },
+  }),
 
   groupsLinks: Command.message`
   Coding in python:
diff --git a/src/commands/lyric.js b/src/commands/lyric.js
@@ -3,14 +3,13 @@ const JSSoup = require('jssoup').default;
 const { search, Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Retorna a letra de uma música.
-
-  *uso:* \`\`\`!lyric [--args] music_name\`\`\`
-
-  *args válidos:* 
-  \`\`\`--help\`\`\` -> _mostra esta mensagem._
-  `,
+  help: Command.helper({
+    description: 'Retorna a letra de uma música.',
+    usage: '!lyric [--args] music_name',
+    args: {
+      help: 'mostra esta mensagem.',
+    },
+  }),
 };
 
 async function makeSoup(url) {
diff --git a/src/commands/report.js b/src/commands/report.js
@@ -1,17 +1,18 @@
 const { chattools, Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Reporte problemas no bot ou um usuário.
+  help: Command.helper({
+    description: 'Reporte problemas no bot ou um usuário.',
+    usage: '!report --args ...',
+    args: {
+      bug: 'reporta um bug.',
+      user: 'reporta um usuário.',
+      help: 'mostra esta mensagem.',
+    },
+  }),
 
-  *uso:* \`\`\`!report --args ...\`\`\`
-
-  *args válidos:* 
-  \`\`\`--bug\`\`\` -> _reporta um bug._
-  \`\`\`--user\`\`\` -> reporta um usuário._
-  \`\`\`--help\`\`\` -> _mostra esta mensagem._
-  `,
   bug: 'sua solicitação será analisada. caso confirmada, abriremos uma issue',
+
   user: 'o usuário foi reportado a administração',
 };
 
diff --git a/src/commands/search.js b/src/commands/search.js
@@ -1,16 +1,15 @@
 const { search, Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Retorna o primeiro resultado de uma pesquisa no google.
-
-  *uso:* \`\`\`!cron [--args] ...\`\`\`
-
-  *args válidos:*
-  \`\`\`--help\`\`\` -> _mostra esta mensagem._
-  \`\`\`--target\`\`\` -> _define um site especifico para pesquisa._
-  \`\`\`--limit\`\`\` -> _define um limite de resultados. O padrão é 1._
-  `,
+  help: Command.helper({
+    description: 'Retorna o primeiro resultado de uma pesquisa no google.',
+    usage: '!cron [--args] ...',
+    args: {
+      help: 'mostra esta mensagem.',
+      target: 'define um site especifico para pesquisa.',
+      limit: 'define um limite de resultados. O padrão é 1.',
+    },
+  }),
 };
 
 class Search {
diff --git a/src/commands/suggest.js b/src/commands/suggest.js
@@ -1,17 +1,16 @@
 const { chattools, Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Sugira algo com este comando.
-
-  *uso:* \`\`\`!suggest --args ...\`\`\`
-
-  *args válidos:* 
-  \`\`\`--feature\`\`\` -> _sugira algo novo._
-  \`\`\`--remove\`\`\` -> _sugira remoções._
-  \`\`\`--change\`\`\` -> _sugira mudanças._
-  \`\`\`--help\`\`\` -> _mostra esta mensagem._
-  `,
+  help: Command.helper({
+    description: 'Sugira algo com este comando.',
+    usage: '!suggest --args ...',
+    args: {
+      feature: 'sugira algo novo.',
+      remove: 'sugira remoções.',
+      change: 'sugira mudanças.',
+      help: 'mostra esta mensagem.',
+    },
+  }),
 };
 
 class Suggest {
diff --git a/src/commands/wiki.js b/src/commands/wiki.js
@@ -2,15 +2,14 @@ const wikijs = require('wikijs').default;
 const { Command } = require('../utils');
 
 const STRINGS = {
-  help: Command.message`
-  Faz uma pesquisa na wikipedia.
-
-  *uso:* \`\`\`!wiki [--args] ...\`\`\`
-
-  *args válidos:*
-  \`\`\`--search\`\`\` -> _retorna uma lista com os títulos dos artigos encontrados._
-  \`\`\`--help\`\`\` -> _mostra esta mensagem._
-  `,
+  help: Command.helper({
+    description: 'Faz uma pesquisa na wikipedia.',
+    usage: '!wiki [--args] ...',
+    args: {
+      search: 'retorna uma lista com os títulos dos artigos encontrados.',
+      help: 'mostra esta mensagem.',
+    },
+  }),
 };
 
 class Wiki {
diff --git a/src/utils/Command.js b/src/utils/Command.js
@@ -19,6 +19,37 @@ class Command {
       .join('\n')
       .trim();
   }
+
+  /**
+   * For a given object of information about a command, returns a help message.
+   * @param {object} commandInfo - Information about the command.
+   * @param {string} commandInfo.description - The command's description.
+   * @param {string} commandInfo.usage - The command's usage.
+   * @param {object} [commandInfo.args] - The command's args. Where the key is arg's name and the value arg's description.
+   * @param {object} [commandInfo.kwargs] - The command's kwargs. Where the key is kwarg's name and the value kwarg's description.
+   * @returns {string} - The help message.
+   */
+  static helper(commandInfo) {
+    // I'll write it better in the future, ok?
+    const { description, usage, args = {}, kwargs = {} } = commandInfo;
+    const argsString = Object.entries(args)
+      .map(([k, v]) => `\`\`\`--${k}\`\`\` -> _${v}_`)
+      .join('\n');
+    const kwargsString = Object.entries(kwargs)
+      .map(([k, v]) => `\`\`\`--${k}\`\`\` -> _${v}_`)
+      .join('\n');
+    const helpMessage = Command.message`
+    ${description}
+
+    *uso:* \`\`\`${usage}\`\`\`
+
+    ${argsString ? `*args válidos:*\n${argsString}` : ''}
+
+    ${kwargsString ? `*kwargs válidos:*\n${kwargsString}` : ''}
+    `;
+
+    return helpMessage;
+  }
 }
 
 module.exports = Command;
