feat: added startsWith and endsWith filter in QueryBuilder

Author: Nino van Galen

lib/database/utilities/QueryBuilder.js

@@ -114,6 +114,54 @@ module.exports = (sequelize) => {
             return this;
         }
 
+        /**
+         * Sets a starts with filter using the provided value.
+         *
+         * @param {symbol} value The start value.
+         * @returns {QueryBuilder} The current QueryBuilder instance.
+         */
+        startsWith(value) {
+            if (!this.queryBuilder.options.where) {
+                this.queryBuilder.options.where = {};
+            }
+
+            if (this.notFlag) {
+                this.queryBuilder.options.where[this.column] = {
+                    [Op.notLike]: `${value}%`,
+                };
+            } else {
+                this.queryBuilder.options.where[this.column] = {
+                    [Op.startsWith]: value,
+                };
+            }
+
+            return this.queryBuilder;
+        }
+
+        /**
+         * Sets a ends with filter using the provided value.
+         *
+         * @param {symbol} value The end value.
+         * @returns {QueryBuilder} The current QueryBuilder instance.
+         */
+        endsWith(value) {
+            if (!this.queryBuilder.options.where) {
+                this.queryBuilder.options.where = {};
+            }
+
+            if (this.notFlag) {
+                this.queryBuilder.options.where[this.column] = {
+                    [Op.notLike]: `%${value}`,
+                };
+            } else {
+                this.queryBuilder.options.where[this.column] = {
+                    [Op.endsWith]: value,
+                };
+            }
+
+            return this.queryBuilder;
+        }
+
         /**
          * Sets the operation.
          *

test/database/utilities/QueryBuilder.test.js

@@ -117,5 +117,45 @@ module.exports = () => {
                 expect(result[1].id).to.equal(2);
             });
         });
+
+        describe('startsWith', () => {
+            it('should return a single entity of which the title starts with ...', async () => {
+                const queryBuilder = new QueryBuilder()
+                    .where('text').startsWith('Power interruption')
+                    .orderBy('id', 'asc');
+
+                const result = await LogRepository.findOne(queryBuilder);
+                expect(result.text).to.equal('Power interruption due to unplugged wire.');
+            });
+
+            it('should return a single entity of which the title not starts with ...', async () => {
+                const queryBuilder = new QueryBuilder()
+                    .where('text').not().startsWith('Power interruption')
+                    .orderBy('id', 'asc');
+
+                const result = await LogRepository.findOne(queryBuilder);
+                expect(result.text).to.equal('Detected particle ABC123');
+            });
+        });
+
+        describe('endsWith', () => {
+            it('should return a single entity of which the title ends with ...', async () => {
+                const queryBuilder = new QueryBuilder()
+                    .where('text').endsWith('accelerator!')
+                    .orderBy('id', 'asc');
+
+                const result = await LogRepository.findOne(queryBuilder);
+                expect(result.text).to.equal('Cake at the particle accelerator!');
+            });
+
+            it('should return a single entity of which the title not ends with ...', async () => {
+                const queryBuilder = new QueryBuilder()
+                    .where('text').not().endsWith('accelerator!')
+                    .orderBy('id', 'asc');
+
+                const result = await LogRepository.findOne(queryBuilder);
+                expect(result.text).to.equal('Power interruption due to unplugged wire.');
+            });
+        });
     });
 };