feat: add comparison operators helpers (#5334)

Co-authored-by: Dima Grossman <dima@grossman.io>
novuhq · Apr 15, 2024 · 58f8ecf · 58f8ecf
1 parent 0593fcb
commit 58f8ecf
Show file tree

Hide file tree

Showing 3 changed files with 210 additions and 0 deletions.
diff --git a/libs/shared/src/consts/handlebar-helpers/handlebarHelpers.ts b/libs/shared/src/consts/handlebar-helpers/handlebarHelpers.ts
@@ -10,6 +10,12 @@ export enum HandlebarHelpersEnum {
   SORT_BY = 'sortBy',
   NUMBERFORMAT = 'numberFormat',
   I18N = 'i18n',
+  GT = 'gt',
+  GTE = 'gte',
+  LT = 'lt',
+  LTE = 'lte',
+  EQ = 'eq',
+  NE = 'ne',
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -25,4 +31,10 @@ export const HandlebarHelpers = {
   [HandlebarHelpersEnum.SORT_BY]: { description: 'sort an array of objects by a property' },
   [HandlebarHelpersEnum.NUMBERFORMAT]: { description: 'format number' },
   [HandlebarHelpersEnum.I18N]: { description: 'translate' },
+  [HandlebarHelpersEnum.GT]: { description: 'greater than' },
+  [HandlebarHelpersEnum.GTE]: { description: 'greater than or equal to' },
+  [HandlebarHelpersEnum.LT]: { description: 'lesser than' },
+  [HandlebarHelpersEnum.LTE]: { description: 'lesser than or equal to' },
+  [HandlebarHelpersEnum.EQ]: { description: 'strict equal' },
+  [HandlebarHelpersEnum.NE]: { description: 'strict not equal to' },
 };
diff --git a/packages/application-generic/src/usecases/compile-template/compile-template.spec.ts b/packages/application-generic/src/usecases/compile-template/compile-template.spec.ts
@@ -209,4 +209,148 @@ describe('Compile Template', function () {
       expect(result).toEqual('<div>Not a number</div>');
     });
   });
+
+  describe('gt helper', () => {
+    const template = `{{#gt steps 5 }}<span>gt block</span>{{else}}<span>else block</span>{{/gt}}`;
+    it('shoud render gt block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 6 },
+        template,
+      });
+
+      expect(result).toEqual('<span>gt block</span>');
+    });
+
+    it('shoud render alternative block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 5 },
+        template,
+      });
+
+      expect(result).toEqual('<span>else block</span>');
+    });
+  });
+
+  describe('gte helper', () => {
+    const template = `{{#gte steps 5 }}<span>gte block</span>{{else}}<span>else block</span>{{/gte}}`;
+    it('shoud render gte block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 5 },
+        template,
+      });
+
+      expect(result).toEqual('<span>gte block</span>');
+    });
+
+    it('shoud render alternative block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 4 },
+        template,
+      });
+
+      expect(result).toEqual('<span>else block</span>');
+    });
+  });
+
+  describe('lt helper', () => {
+    const template = `{{#lt steps 5 }}<span>lt block</span>{{else}}<span>else block</span>{{/lt}}`;
+    it('shoud render lt block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 4 },
+        template,
+      });
+
+      expect(result).toEqual('<span>lt block</span>');
+    });
+
+    it('shoud render alternative block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 5 },
+        template,
+      });
+
+      expect(result).toEqual('<span>else block</span>');
+    });
+  });
+
+  describe('lte helper', () => {
+    const template = `{{#lte steps 5 }}<span>lte block</span>{{else}}<span>else block</span>{{/lte}}`;
+    it('shoud render lte block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 5 },
+        template,
+      });
+
+      expect(result).toEqual('<span>lte block</span>');
+    });
+
+    it('shoud render alternative block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 6 },
+        template,
+      });
+
+      expect(result).toEqual('<span>else block</span>');
+    });
+  });
+
+  describe('eq helper', () => {
+    const template = `{{#eq steps 5 }}<span>eq block</span>{{else}}<span>else block</span>{{/eq}}`;
+    it('shoud render eq block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 5 },
+        template,
+      });
+
+      expect(result).toEqual('<span>eq block</span>');
+    });
+
+    it('shoud use strict check and render alternative block', async () => {
+      const result = await useCase.execute({
+        data: { steps: '5' },
+        template,
+      });
+
+      expect(result).toEqual('<span>else block</span>');
+    });
+
+    it('shoud render alternative block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 6 },
+        template,
+      });
+
+      expect(result).toEqual('<span>else block</span>');
+    });
+  });
+
+  describe('ne helper', () => {
+    const template = `{{#ne steps 5 }}<span>ne block</span>{{else}}<span>else block</span>{{/ne}}`;
+    it('shoud render ne block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 6 },
+        template,
+      });
+
+      expect(result).toEqual('<span>ne block</span>');
+    });
+
+    it('shoud use strict check and render ne block', async () => {
+      const result = await useCase.execute({
+        data: { steps: '5' },
+        template,
+      });
+
+      expect(result).toEqual('<span>ne block</span>');
+    });
+
+    it('shoud render alternative block', async () => {
+      const result = await useCase.execute({
+        data: { steps: 5 },
+        template,
+      });
+
+      expect(result).toEqual('<span>else block</span>');
+    });
+  });
 });
diff --git a/packages/application-generic/src/usecases/compile-template/compile-template.usecase.ts b/packages/application-generic/src/usecases/compile-template/compile-template.usecase.ts
@@ -158,6 +158,60 @@ Handlebars.registerHelper(
   }
 );
 
+Handlebars.registerHelper(
+  HandlebarHelpersEnum.GT,
+  function (arg1, arg2, options) {
+    // eslint-disable-next-line
+    // @ts-expect-error
+    return arg1 > arg2 ? options.fn(this) : options.inverse(this);
+  }
+);
+
+Handlebars.registerHelper(
+  HandlebarHelpersEnum.GTE,
+  function (arg1, arg2, options) {
+    // eslint-disable-next-line
+    // @ts-expect-error
+    return arg1 >= arg2 ? options.fn(this) : options.inverse(this);
+  }
+);
+
+Handlebars.registerHelper(
+  HandlebarHelpersEnum.LT,
+  function (arg1, arg2, options) {
+    // eslint-disable-next-line
+    // @ts-expect-error
+    return arg1 < arg2 ? options.fn(this) : options.inverse(this);
+  }
+);
+
+Handlebars.registerHelper(
+  HandlebarHelpersEnum.LTE,
+  function (arg1, arg2, options) {
+    // eslint-disable-next-line
+    // @ts-expect-error
+    return arg1 <= arg2 ? options.fn(this) : options.inverse(this);
+  }
+);
+
+Handlebars.registerHelper(
+  HandlebarHelpersEnum.EQ,
+  function (arg1, arg2, options) {
+    // eslint-disable-next-line
+    // @ts-expect-error
+    return arg1 === arg2 ? options.fn(this) : options.inverse(this);
+  }
+);
+
+Handlebars.registerHelper(
+  HandlebarHelpersEnum.NE,
+  function (arg1, arg2, options) {
+    // eslint-disable-next-line
+    // @ts-expect-error
+    return arg1 !== arg2 ? options.fn(this) : options.inverse(this);
+  }
+);
+
 @Injectable()
 export class CompileTemplate {
   async execute(command: CompileTemplateCommand): Promise<string> {