refactor: parser types

jbrunton · Aug 14, 2024 · 99d4a36 · 99d4a36
1 parent fc42bba
commit 99d4a36
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 35 deletions.
diff --git a/services/api/src/domain/entities/command.entity.ts b/services/api/src/domain/entities/command.entity.ts
@@ -3,12 +3,3 @@ export class Command {
   roomId: string;
   canonicalInput: string;
 }
-
-export type ParsedCommand =
-  | { tag: 'help'; params: null }
-  | { tag: 'renameRoom'; params: { newName: string } }
-  | { tag: 'renameUser'; params: { newName: string } }
-  | {
-      tag: 'lorem';
-      params: { count: number; typeToken: 'words' | 'paragraphs' };
-    };
diff --git a/services/api/src/domain/usecases/commands/parse/command.parser.ts b/services/api/src/domain/usecases/commands/parse/command.parser.ts
@@ -1,8 +1,17 @@
-import { Command, ParsedCommand } from '@entities/command.entity';
+import { Command } from '@entities/command.entity';
 import { BadRequestException } from '@nestjs/common';
 import { equals } from 'rambda';
 import { z, ZodIssue, ZodType } from 'zod';
 
+export type ParsedCommand =
+  | { tag: 'help'; params: null }
+  | { tag: 'renameRoom'; params: { newName: string } }
+  | { tag: 'renameUser'; params: { newName: string } }
+  | {
+      tag: 'lorem';
+      params: { count: number; typeToken: 'words' | 'paragraphs' };
+    };
+
 export type ParseResult =
   | {
       match: true;

diff --git a/services/api/src/domain/usecases/commands/parse/index.ts b/services/api/src/domain/usecases/commands/parse/index.ts
@@ -1,6 +1,7 @@
-import { Command, ParsedCommand } from '@entities/command.entity';
+import { Command } from '@entities/command.entity';
 import { BadRequestException, Injectable } from '@nestjs/common';
 import { parsers } from './parsers';
+import { ParsedCommand } from './command.parser';
 
 @Injectable()
 export class ParseCommandUseCase {

diff --git a/...rc/domain/usecases/commands/parse.spec.ts → ...ain/usecases/commands/parse/parse.spec.ts b/...rc/domain/usecases/commands/parse.spec.ts → ...ain/usecases/commands/parse/parse.spec.ts
@@ -1,6 +1,7 @@
-import { Command, ParsedCommand } from '@entities/command.entity';
+import { Command } from '@entities/command.entity';
 import { BadRequestException } from '@nestjs/common';
-import { ParseCommandUseCase } from './parse';
+import { ParseCommandUseCase } from '.';
+import { ParsedCommand } from './command.parser';
 
 describe('ParseCommandUseCase', () => {
   let parse: ParseCommandUseCase;
@@ -9,7 +10,7 @@ describe('ParseCommandUseCase', () => {
     parse = new ParseCommandUseCase();
   });
 
-  const expectCommand = (command: string) => {
+  const withMessage = (command: string) => {
     const tokens = command.slice(1).split(' ');
     const parsedCommand: Command = {
       roomId: 'my-room',
@@ -18,12 +19,12 @@ describe('ParseCommandUseCase', () => {
     };
     const parse = new ParseCommandUseCase();
     return {
-      toReturn: (expected: ParsedCommand) => {
+      expectCommand: (expected: ParsedCommand) => {
         const result = parse.exec(parsedCommand);
         expect(result).toEqual(expected);
       },
 
-      toErrorWith: (...expectedMessage: string[]) => {
+      expectError: (...expectedMessage: string[]) => {
         expect(() => parse.exec(parsedCommand)).toThrow(
           new BadRequestException(expectedMessage.join('\n')),
         );
@@ -33,14 +34,14 @@ describe('ParseCommandUseCase', () => {
 
   describe('/help', () => {
     it('parses the command', () => {
-      expectCommand('/help').toReturn({
+      withMessage('/help').expectCommand({
         tag: 'help',
         params: null,
       });
     });
 
     it('validates the number of arguments', () => {
-      expectCommand('/help me').toErrorWith(
+      withMessage('/help me').expectError(
         'Error in command `/help me`:',
         '* Received too many arguments. Expected: `/help`',
       );
@@ -49,7 +50,7 @@ describe('ParseCommandUseCase', () => {
 
   describe('/lorem', () => {
     it('parses valid commands', () => {
-      expectCommand('/lorem 3 words').toReturn({
+      withMessage('/lorem 3 words').expectCommand({
         tag: 'lorem',
         params: {
           count: 3,
@@ -59,22 +60,22 @@ describe('ParseCommandUseCase', () => {
     });
 
     it('validates the number of arguments', () => {
-      expectCommand('/lorem').toErrorWith(
+      withMessage('/lorem').expectError(
         'Error in command `/lorem`:',
         `* Received too few arguments. Expected: \`/lorem {count} {'words' | 'paragraphs'}\``,
       );
-      expectCommand('/lorem 3 words paragraphs').toErrorWith(
+      withMessage('/lorem 3 words paragraphs').expectError(
         'Error in command `/lorem 3 words paragraphs`:',
         `* Received too many arguments. Expected: \`/lorem {count} {'words' | 'paragraphs'}\``,
       );
     });
 
     it('validates the arguments', () => {
-      expectCommand('/lorem three words').toErrorWith(
+      withMessage('/lorem three words').expectError(
         'Error in command `/lorem three words`:',
         '* Argument 1 (`three`): Expected number, received nan',
       );
-      expectCommand('/lorem 3 chars').toErrorWith(
+      withMessage('/lorem 3 chars').expectError(
         'Error in command `/lorem 3 chars`:',
         `* Argument 2 (\`chars\`): Invalid enum value. Expected 'words' | 'paragraphs', received 'chars'`,
       );
@@ -83,7 +84,7 @@ describe('ParseCommandUseCase', () => {
 
   describe('/rename room', () => {
     it('parses valid commands', () => {
-      expectCommand('/rename room My Room').toReturn({
+      withMessage('/rename room My Room').expectCommand({
         tag: 'renameRoom',
         params: {
           newName: 'My Room',
@@ -92,7 +93,7 @@ describe('ParseCommandUseCase', () => {
     });
 
     it('validates the number of arguments', () => {
-      expectCommand('/rename room').toErrorWith(
+      withMessage('/rename room').expectError(
         'Error in command `/rename room`:',
         `* Received too few arguments. Expected: \`/rename room {name}\``,
       );
@@ -101,7 +102,7 @@ describe('ParseCommandUseCase', () => {
 
   describe('/rename user', () => {
     it('parses valid commands', () => {
-      expectCommand('/rename user My User').toReturn({
+      withMessage('/rename user My User').expectCommand({
         tag: 'renameUser',
         params: {
           newName: 'My User',
@@ -110,7 +111,7 @@ describe('ParseCommandUseCase', () => {
     });
 
     it('validates the number of arguments', () => {
-      expectCommand('/rename user').toErrorWith(
+      withMessage('/rename user').expectError(
         'Error in command `/rename user`:',
         `* Received too few arguments. Expected: \`/rename user {name}\``,
       );

diff --git a/services/api/src/domain/usecases/commands/parse/parsers/help.parser.ts b/services/api/src/domain/usecases/commands/parse/parsers/help.parser.ts
@@ -1,6 +1,5 @@
-import { ParsedCommand } from '@entities/command.entity';
 import { z } from 'zod';
-import { CommandParser } from '../command.parser';
+import { CommandParser, ParsedCommand } from '../command.parser';
 
 const schema = z.tuple([z.literal('help')]).transform<ParsedCommand>(() => ({
   tag: 'help',

diff --git a/services/api/src/domain/usecases/commands/parse/parsers/lorem.parser.ts b/services/api/src/domain/usecases/commands/parse/parsers/lorem.parser.ts
@@ -1,6 +1,5 @@
-import { ParsedCommand } from '@entities/command.entity';
 import { z } from 'zod';
-import { CommandParser } from '../command.parser';
+import { CommandParser, ParsedCommand } from '../command.parser';
 
 const schema = z
   .tuple([

diff --git a/services/api/src/domain/usecases/commands/parse/parsers/rename.room.parser.ts b/services/api/src/domain/usecases/commands/parse/parsers/rename.room.parser.ts
@@ -1,6 +1,5 @@
-import { ParsedCommand } from '@entities/command.entity';
 import { z } from 'zod';
-import { CommandParser } from '../command.parser';
+import { CommandParser, ParsedCommand } from '../command.parser';
 
 const schema = z
   .tuple([z.literal('rename'), z.literal('room'), z.string()])

diff --git a/services/api/src/domain/usecases/commands/parse/parsers/rename.user.parser.ts b/services/api/src/domain/usecases/commands/parse/parsers/rename.user.parser.ts
@@ -1,6 +1,5 @@
-import { ParsedCommand } from '@entities/command.entity';
 import { z } from 'zod';
-import { CommandParser } from '../command.parser';
+import { CommandParser, ParsedCommand } from '../command.parser';
 
 const schema = z
   .tuple([z.literal('rename'), z.literal('user'), z.string()])