Merge remote-tracking branch 'upstream/main'

Author: mstrk

.github/workflows/lint-and-test.yml

@@ -9,10 +9,21 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Cache npm dependencies
+        uses: actions/cache@v4
         with:
-          node-version: "18"
-          cache: "npm"
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+            ${{ runner.os }}-
 
       - name: Install dependencies
         run: npm ci

.gitignore

@@ -1,3 +1,6 @@
+# VS Code
+.vscode
+
 # Logs
 logs
 *.log

.prettierrc

@@ -1,4 +1,5 @@
 {
   "singleQuote": false,
-  "printWidth": 120
+  "printWidth": 120,
+  "trailingComma": "es5"
 }

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contribuição
+
+Antes de mais, obrigado por considerares participar neste projeto.
+
+Neste documento encontram-se instruções detalhadas para que possas contribuir em conformidade com a estrutura e organização do projecto. Estas instruções não são para ser consideradas regras rígidas mas sim uma orientação generalizada do que esperamos quando alguém contribui, utiliza o bom senso quando estiveres a contribuir para o projecto.
+
+#### Tabela de conteúdo
+
+1. [Código de conduta](#código-de-conduta)
+2. [Arquitetura](#arquitetura)
+3. [Linguagem e versões](#linguagem-e-versões)
+4. [Como contribuir](#como-contribuir)
+5. [Guia de estilos](#guia-de-estilos)
+   - [Código](#código)
+   - [Issues](#issues)
+   - [Mensagens de commit](#mensagens-de-commit)
+
+## Código de conduta
+
+Ao participares neste projeto, esperamos que tenhas em consideração as seguintes regras:
+
+- Respeito pelo próximo
+- Uso de linguagem inclusiva e acolhedora
+- Aceitação de crítica construtiva
+- Foco no que é melhor para a comunidade
+
+## Arquitetura
+
+- Este projeto segue, na sua grande maioria, o estilo de _Domain-Driven Design_ (DDD). Para mais informação consulta o nosso documento sobre [Arquitetura](ARCHITECTURE)
+
+## Linguagem e versões
+
+- A linguagem utilizada é Typescript, e tem Node e NPM como dependências principais. As versões necessárias podem ser consultadas no [ReadMe](README).
+
+Para instalar as dependências executa o comando `npm install`.
+
+## Como contribuir
+
+- Encontra um issue que te sentes capaz de ajudar. Se for a primeira contribuição, issues marcados com `bom primeiro issue` são normalmente considerados bons para principiantes.
+- Faz `fork` deste repositório para a tua conta pessoal.
+- Depois podes utilizar o `git` para fazer um `clone` para a tua máquina pessoal.
+- Cria um novo branch `git checkout -b novo-nome-branch`.
+- Faz as modificações que achas necessárias.
+- Faz commit do teu código para a origem do teu `branch`.
+- Cria um `pull request` no github para que possa ser revisto pela equipa.
+- Se receberes comentários ajusta o teu código e faz novos commits.
+- Quando for aprovado, o teu código vai ser `merged` com o `branch` main.
+
+## Guia de estilos
+
+#### Código
+
+- O código deve ser escrito seguindo o estilo já presente no repositório.
+
+#### Issues
+
+- **Utiliza um titulo claro e descritivo** no issue para identificar a sugestão.
+- **Fornece uma descrição exaustiva da melhoria sugerida** usando o máximo detalhe possível.
+- Se aplicável, descreve os passos para replicar o issue.
+
+#### Mensagens de commit
+
+- Inclui referência ao Issue em questão se aplicável.

LICENSE

@@ -0,0 +1,48 @@
+# Discord Bot devPT
+
+![](https://avatars.githubusercontent.com/u/79173787?s=200&v=4)
+
+[![language](https://img.shields.io/badge/language-TypeScript-3178C6)](https://www.typescriptlang.org/) [![node_major_version](https://img.shields.io/badge/node_major_version-18-5fa04e)](https://nodejs.org/en) [![license](https://img.shields.io/github/license/devpt-org/discord-bot)](LICENSE)
+
+## Descrição
+
+Projeto criado em conjunto por elementos do devPT, com o intuito de criar um bot para adicionar funcionalidades extra ao servidor.
+
+O devPT é uma comunidade de língua portuguesa sem fins lucrativos para developers, disponibilizando um espaço em comum para engenheiros, estudantes e curiosos da área do desenvolvimento de software para se encontrarem e desenvolverem iniciativas Open-Source.
+
+## Indice
+
+- [Utilização](#utilização)
+- [Guia de Contribuição](#guia-de-contribuição)
+- [Licença](#licença)
+- [Contactos](#contactos)
+- [Agradecimentos](#agradecimentos)
+
+## Utilização
+
+O bot está disponível no nosso discord [devPT](https://devpt.co/discord) e apresenta as seguintes funcionalidades / comandos:
+
+- `!ja` - gera uma mensagem relacionada com "não perguntes para perguntar".
+- `!oc` - gera uma mensagem com o aviso de que o servidor é apenas para questões relacionadas com programação.
+- `!cwl` - gera uma mensagem que exibe o 'leaderboard' do CodeWars.
+- Mensagem na entrada de novos utilizadores
+
+## Guia de Contribuição
+
+Para detalhes sobre o nosso código de conduta e o processo para submeter um `pull request` neste projeto, por favor consulte o nosso [Guia de Contribuição](CONTRIBUTING.md).
+
+## Licença
+
+Este projeto está disponível gratuitamente para uso não comercial. Para mais informação, por favor consulte a nossa [Licença](LICENSE)
+
+## Contactos
+
+[devPT](https://devpt.co/discord)
+
+## Agradecimentos
+
+<a href="https://github.com/devpt-org/discord-bot/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=devpt-org/discord-bot" />
+</a>
+
+[Voltar ao início](#top)

README.md

@@ -1,14 +1,17 @@
-import KataLeaderboardUser from "../../../domain/service/kataService/kataLeaderboardUser";
-import KataService from "../../../domain/service/kataService/kataService";
-import ChatService from "../../../domain/service/chatService";
-import { SendCodewarsLeaderboardToChannelInput } from "./sendCodewarsLeaderboardToChannelInput";
+import { SendCodewarsLeaderboardToChannelInput } from "application/usecases/sendCodewarsLeaderboardToChannel/sendCodewarsLeaderboardToChannelInput";
+import { Command } from "../../types";
+import KataService from "../../domain/service/kataService/kataService";
+import ChatService from "../../domain/service/chatService";
+import KataLeaderboardUser from "../../domain/service/kataService/kataLeaderboardUser";
+
+export default class CodewarsLeaderboardCommand implements Command {
+  readonly name = "!cwl";
 
-export default class SendCodewarsLeaderboardToChannelUseCase {
   private chatService: ChatService;
 
   private kataService: KataService;
 
-  constructor({ chatService, kataService }: { chatService: ChatService; kataService: KataService }) {
+  constructor(chatService: ChatService, kataService: KataService) {
     this.chatService = chatService;
     this.kataService = kataService;
   }

application/usecases/sendCodewarsLeaderboardToChannel/sendCodewarsLeaderboardToChannelUseCase.ts renamed to application/command/codewarsLeaderboardCommand.ts

@@ -0,0 +1,19 @@
+import { Command, Context } from "../../types";
+import ChatService from "../../domain/service/chatService";
+
+export default class DontAskToAskCommand implements Command {
+  readonly name = "!ja";
+
+  private readonly message: string =
+    "Olá! Experimenta fazer a pergunta diretamente e contar o que já tentaste! Sabe mais aqui :point_right: https://dontasktoask.com/pt-pt/";
+
+  private chatService: ChatService;
+
+  constructor(chatService: ChatService) {
+    this.chatService = chatService;
+  }
+
+  async execute(context: Context): Promise<void> {
+    await this.chatService.sendMessageToChannel(this.message, context.channelId);
+  }
+}

application/command/dontAskToAskCommand.ts

@@ -0,0 +1,19 @@
+import { Command, Context } from "../../types";
+import ChatService from "../../domain/service/chatService";
+
+export default class OnlyCodeQuestionsCommand implements Command {
+  readonly name = "!oc";
+
+  private chatService: ChatService;
+
+  private readonly message: string =
+    ":warning: Este servidor é APENAS para questões relacionadas com programação! :warning:";
+
+  constructor(chatService: ChatService) {
+    this.chatService = chatService;
+  }
+
+  async execute(context: Context): Promise<void> {
+    await this.chatService.sendMessageToChannel(this.message, context.channelId);
+  }
+}

application/command/onlyCodeQuestionsCommand.ts

@@ -1,5 +1,5 @@
 [
-  ", o que te trás por cá?",
+  ", o que te traz por cá?",
   ", como estás?",
   ", já viste o sol hoje?",
   ", já viste a luz do dia?",
@@ -19,10 +19,10 @@
   ". A única solução que vejo para isso é formatar...",
   ". E quê? Já falas melhor em Python que em português?",
   ". Então e qual a linguagem que queres aprender?",
-  ", se já viste https://youtu.be/MAlSjtxy5ak talvez aqui tenhas mais sorte!",
+  ", se já viste <https://youtu.be/MAlSjtxy5ak> talvez aqui tenhas mais sorte!",
   ", ufa, foi por pouco que não te apanhávamos!",
   ", já contaste ao patinho?",
-  ", https://youtu.be/a3Z7zEc7AXQ",
+  ", <https://www.youtube.com/watch?v=xvFZjo5PgG0>",
   ". Se o Google não ajudar, força nisso!",
   ". Se quiseres aprender a programar, podes contar com o nosso apoio!",
   ". Acho que estás a merecer um !ja",

assets/phrases/welcoming.json

@@ -1,79 +1,27 @@
-import { Context } from "../../types";
+import { Command, Context } from "../../types";
 import UseCaseNotFound from "../exception/useCaseNotFound";
-import SendMessageToChannelUseCase from "../../application/usecases/sendMessageToChannel/sendMessageToChannelUseCase";
-import MessageRepository from "../repository/messageRepository";
-import ChatService from "./chatService";
 import LoggerService from "./loggerService";
-import ChannelResolver from "./channelResolver";
-import KataService from "./kataService/kataService";
-import SendCodewarsLeaderboardToChannelUseCase from "../../application/usecases/sendCodewarsLeaderboardToChannel/sendCodewarsLeaderboardToChannelUseCase";
-
-type CallbackFunctionVariadic = (...args: unknown[]) => void;
 
 export default class CommandUseCaseResolver {
-  private messageRepository: MessageRepository;
-
-  private chatService: ChatService;
+  private commands: Command[];
 
   private loggerService: LoggerService;
 
-  private channelResolver: ChannelResolver;
-
-  private kataService: KataService;
-
-  constructor({
-    messageRepository,
-    chatService,
-    loggerService,
-    channelResolver,
-    kataService,
-  }: {
-    messageRepository: MessageRepository;
-    chatService: ChatService;
-    loggerService: LoggerService;
-    channelResolver: ChannelResolver;
-    kataService: KataService;
-  }) {
-    this.messageRepository = messageRepository;
-    this.chatService = chatService;
+  constructor({ commands, loggerService }: { commands: Command[]; loggerService: LoggerService }) {
     this.loggerService = loggerService;
-    this.channelResolver = channelResolver;
-    this.kataService = kataService;
+
+    this.commands = commands;
   }
 
-  resolveByCommand(command: string, context: Context): void {
+  async resolveByCommand(command: string, context: Context): Promise<void> {
     this.loggerService.log(`Command received: "${command}"`);
 
-    const deps = {
-      messageRepository: this.messageRepository,
-      chatService: this.chatService,
-      loggerService: this.loggerService,
-      channelResolver: this.channelResolver,
-      kataService: this.kataService,
-    };
-
-    const commandUseCases: Record<string, CallbackFunctionVariadic> = {
-      "!ja": async () =>
-        new SendMessageToChannelUseCase(deps).execute({
-          channelId: context.channelId,
-          message:
-            "Olá! Experimenta fazer a pergunta diretamente e contar o que já tentaste! Sabe mais aqui :point_right: https://dontasktoask.com/pt-pt/",
-        }),
-      "!oc": async () =>
-        new SendMessageToChannelUseCase(deps).execute({
-          channelId: context.channelId,
-          message: ":warning: Este servidor é APENAS para questões relacionadas com programação! :warning:",
-        }),
-      "!cwl": async () =>
-        new SendCodewarsLeaderboardToChannelUseCase(deps).execute({
-          channelId: context.channelId,
-        }),
-    };
+    const commandInstance = this.commands.find((cmd) => cmd.name === command);
 
-    if (!commandUseCases[command]) {
+    if (!commandInstance) {
       throw new UseCaseNotFound().byCommand(command);
     }
 
-    commandUseCases[command]();
+    await commandInstance.execute(context);
   }
 }

domain/service/commandUseCaseResolver.ts

@@ -14,6 +14,10 @@ import KataService from "./domain/service/kataService/kataService";
 import CodewarsKataService from "./infrastructure/service/codewarsKataService";
 import ContentAggregatorService from "./domain/service/contentAggregatorService/contentAggregatorService";
 import LemmyContentAggregatorService from "./infrastructure/service/lemmyContentAggregatorService";
+import CodewarsLeaderboardCommand from "./application/command/codewarsLeaderboardCommand";
+import DontAskToAskCommand from "./application/command/dontAskToAskCommand";
+import OnlyCodeQuestionsCommand from "./application/command/onlyCodeQuestionsCommand";
+import { Command } from "./types";
 
 dotenv.config();
 
@@ -29,12 +33,14 @@ const loggerService: LoggerService = new ConsoleLoggerService();
 const channelResolver: ChannelResolver = new ChannelResolver();
 const kataService: KataService = new CodewarsKataService();
 const lemmyContentAggregatorService: ContentAggregatorService = new LemmyContentAggregatorService();
+const commands: Command[] = [
+  new CodewarsLeaderboardCommand(chatService, kataService),
+  new DontAskToAskCommand(chatService),
+  new OnlyCodeQuestionsCommand(chatService),
+];
 const useCaseResolver = new CommandUseCaseResolver({
-  messageRepository,
-  chatService,
+  commands,
   loggerService,
-  channelResolver,
-  kataService,
 });
 
 const checkForNewPosts = async () => {
@@ -58,7 +64,7 @@ const checkForNewPosts = async () => {
   };
 
   last5MinutesPosts.forEach((post) => {
-    const title = avoidEmbedInLink(post!.getTitle());
+    const title = avoidEmbedInLink(post.getTitle());
 
     const message = `Novo post no Lemmy: **${title}** (*${post?.getAuthorName()}*)