Feature/add better test coverage (#5)

woigl · web-flow · commit 4cdf41ac2399 · 2025-02-18T19:32:22.000+04:00
* fix: allow overwritting default comparison
operators

* add: test for custom comparison operators

* add: unit test for exception of unhandled value type

* add: unit test for exception of invalid comparison operator

* fix: replace not useful code with exception

* add: further tests added

* add: enhance unit tests

* add: more tests

* change: version to 1.2.0
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "rsql-query-builder",
-    "version": "1.1.2",
+    "version": "1.2.0",
     "description": "Library for building RSQL query strings.",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
diff --git a/src/RSQLBuilder.test.ts b/src/RSQLBuilder.test.ts
@@ -89,6 +89,67 @@ describe('RSQLBuilder', () => {
     });
 
     it('Test group()', () => {
-        expect(new RSQLBuilder().equal('name', 'John').and().group(new RSQLBuilder().equal('age', 30).or().equal('age', null)).toString()).toBe('name==\"John\";(age==30,age==null)');
+        expect(
+            new RSQLBuilder()
+                .equal('name', 'John')
+                .and()
+                .group(new RSQLBuilder().equal('age', 30).or().equal('age', null))
+                .toString()
+        ).toBe('name=="John";(age==30,age==null)');
+    });
+
+    it('Test concat()', () => {
+        expect(
+            new RSQLBuilder()
+                .equal('name', 'John')
+                .concat(new RSQLBuilder().equal('age', 30).or().equal('age', null))
+                .toString()
+        ).toBe('name=="John";age==30,age==null');
+    });
+
+    it('Test merge()', () => {
+        expect(
+            new RSQLBuilder()
+                .equal('name', 'John')
+                .merge([new RSQLBuilder().equal('age', 30).or().equal('age', null)])
+                .toString()
+        ).toBe('name=="John";(age==30,age==null)');
+
+        expect(
+            new RSQLBuilder()
+                .equal('name', 'John')
+                .merge([new RSQLBuilder().equal('age', 30).or().equal('age', null)], { logicOperator: 'and' })
+                .toString()
+        ).toBe('name=="John";(age==30,age==null)');
+
+        expect(
+            new RSQLBuilder()
+                .equal('name', 'John')
+                .merge([new RSQLBuilder().equal('age', 30).or().equal('age', null)], { logicOperator: 'or' })
+                .toString()
+        ).toBe('name=="John",(age==30,age==null)');
+    });
+
+    it('Test static merge()', () => {
+        expect(
+            RSQLBuilder.merge([
+                new RSQLBuilder().equal('name', 'John'),
+                new RSQLBuilder().equal('age', 30).or().equal('age', null)
+            ]).toString()
+        ).toBe('(name=="John");(age==30,age==null)');
+
+        expect(
+            RSQLBuilder.merge(
+                [new RSQLBuilder().equal('name', 'John'), new RSQLBuilder().equal('age', 30).or().equal('age', null)],
+                { logicOperator: 'and' }
+            ).toString()
+        ).toBe('(name=="John");(age==30,age==null)');
+
+        expect(
+            RSQLBuilder.merge(
+                [new RSQLBuilder().equal('name', 'John'), new RSQLBuilder().equal('age', 30).or().equal('age', null)],
+                { logicOperator: 'or' }
+            ).toString()
+        ).toBe('(name=="John"),(age==30,age==null)');
     });
 });
diff --git a/src/RSQLBuilderBase.ts b/src/RSQLBuilderBase.ts
@@ -27,9 +27,10 @@ export interface RSQLBuilderOptions<TComparisonOperator extends string = never>
  *
  * @template TComparisonOperator - The type of the custom comparison operators
  */
-interface RSQLBuilderBaseOptions<TComparisonOperator extends string = never> extends RSQLBuilderOptions<TComparisonOperator> {
+interface RSQLBuilderBaseOptions<TComparisonOperator extends string = never>
+    extends RSQLBuilderOptions<TComparisonOperator> {
     /* Custom comparison operators */
-    customComparisonOperators?: ComparisonOperators<TComparisonOperator>;
+    customComparisonOperators?: Partial<ComparisonOperators<TComparisonOperator>>;
 }
 
 /** RSQL builder base class
@@ -54,8 +55,9 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
 
     private defaultLogicOperator: LogicOperator = 'and';
     private replaceExistingLogicOperator: boolean = true;
-    private customComparisonOperators: ComparisonOperators<TCustomComparisonOperator> =
-        {} as ComparisonOperators<TCustomComparisonOperator>;
+    private customComparisonOperators: Partial<
+        ComparisonOperators<ComparisonOperatorsDefault | TCustomComparisonOperator>
+    > = {} as ComparisonOperators<ComparisonOperatorsDefault | TCustomComparisonOperator>;
 
     /** Create a new RSQL builder base instance.
      *
@@ -65,7 +67,9 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      * */
-    protected constructor(options: RSQLBuilderBaseOptions<TCustomComparisonOperator> = {}) {
+    protected constructor(
+        options: RSQLBuilderBaseOptions<ComparisonOperatorsDefault | TCustomComparisonOperator> = {}
+    ) {
         if (options.defaultLogicOperator) this.defaultLogicOperator = options.defaultLogicOperator;
         if (options.customComparisonOperators) this.customComparisonOperators = options.customComparisonOperators;
     }
@@ -98,7 +102,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
         if (typeof value === 'number') return value.toString();
         if (typeof value === 'boolean') return value === true ? 'true' : 'false';
         if (value instanceof Date) return value.toISOString();
-        throw new Error('Unhandled value type.');
+        throw new Error('Unhandled value type');
     }
 
     /** Ensure that the string ends with an logic operator.
@@ -158,12 +162,14 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
             this.customComparisonOperators[comparisonOperator as TCustomComparisonOperator] ||
             this.comparisonOperators[comparisonOperator as ComparisonOperatorsDefault];
 
-        if (!operator) throw new Error(`Invalid comparison operator '${operator}'.`);
+        if (!operator) throw new Error(`Invalid comparison operator '${operator}'`);
 
         if (operator.isArray === true) {
-            const strArray = Array.isArray(value)
-                ? value.map((value) => this.valueToString(value))
-                : [this.valueToString(value)];
+            if (!Array.isArray(value)) {
+                throw new Error(`Array comparison operator '${operator}' requires an array value.`);
+            }
+
+            const strArray = value.map((value) => this.valueToString(value));
 
             this.rsqlStr += selector + operator.rsql + '(' + strArray.join(',') + ')';
         } else {
@@ -221,9 +227,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      */
-    public concat(
-        builder: this
-    ): this {
+    public concat(builder: this): this {
         if (!builder.isEmpty()) {
             this.ensureLogicOperator();
             this.rsqlStr += builder.toString();
@@ -241,12 +245,9 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      */
-    public merge(
-        builders: this[],
-        options?: { operator?: LogicOperator }
-    ): this {
+    public merge(builders: this[], options?: { logicOperator?: LogicOperator }): this {
         for (const builder of builders) {
-            this.ensureLogicOperator(options?.operator);
+            this.ensureLogicOperator(options?.logicOperator);
             this.group(builder);
         }
 
@@ -290,10 +291,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      */
-    public equal(
-        selector: TSelector,
-        value: string | number | boolean | Date | null
-    ): this {
+    public equal(selector: TSelector, value: string | number | boolean | Date | null): this {
         return this.addComparison(selector, 'equal', value);
     }
 
@@ -304,10 +302,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      */
-    public notEqual(
-        selector: TSelector,
-        value: string | number | boolean | Date | null
-    ): this {
+    public notEqual(selector: TSelector, value: string | number | boolean | Date | null): this {
         return this.addComparison(selector, 'notEqual', value);
     }
 
@@ -318,10 +313,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      */
-    public lessThan(
-        selector: TSelector,
-        value: string | number | Date | null
-    ): this {
+    public lessThan(selector: TSelector, value: string | number | Date | null): this {
         return this.addComparison(selector, 'lessThan', value);
     }
 
@@ -332,10 +324,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      */
-    public lessThanOrEqual(
-        selector: TSelector,
-        value: string | number | Date | null
-    ): this {
+    public lessThanOrEqual(selector: TSelector, value: string | number | Date | null): this {
         return this.addComparison(selector, 'lessThanOrEqual', value);
     }
 
@@ -346,10 +335,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      */
-    public greaterThan(
-        selector: TSelector,
-        value: string | number | Date | null
-    ): this {
+    public greaterThan(selector: TSelector, value: string | number | Date | null): this {
         return this.addComparison(selector, 'greaterThan', value);
     }
 
@@ -360,10 +346,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      */
-    public greaterThanOrEqual(
-        selector: TSelector,
-        value: string | number | Date | null
-    ): this {
+    public greaterThanOrEqual(selector: TSelector, value: string | number | Date | null): this {
         return this.addComparison(selector, 'greaterThanOrEqual', value);
     }
 
@@ -373,10 +356,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      * @param values - The values to compare
      * @returns The builder instance
      */
-    public in(
-        selector: TSelector,
-        values: Array<string | number | boolean | null>
-    ): this {
+    public in(selector: TSelector, values: Array<string | number | boolean | null>): this {
         return this.addComparison(selector, 'in', values);
     }
 
@@ -387,10 +367,7 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      *
      * @returns The builder instance
      */
-    public notIn(
-        selector: TSelector,
-        values: Array<string | number | boolean | null>
-    ): this {
+    public notIn(selector: TSelector, values: Array<string | number | boolean | null>): this {
         return this.addComparison(selector, 'notIn', values);
     }
 
@@ -406,9 +383,9 @@ class RSQLBuilderBase<TSelector extends string, TCustomComparisonOperator extend
      */
     static merge<TSelector extends string, TCustomComparisonOperator extends string>(
         builders: RSQLBuilderBase<TSelector, TCustomComparisonOperator>[],
-        options: RSQLBuilderOptions<TCustomComparisonOperator> = {}
+        options?: { logicOperator?: LogicOperator }
     ): RSQLBuilderBase<TSelector, TCustomComparisonOperator> {
-        return new RSQLBuilderBase<TSelector, TCustomComparisonOperator>(options).merge(
+        return new RSQLBuilderBase<TSelector, TCustomComparisonOperator>({defaultLogicOperator: options?.logicOperator}).merge(
             builders.filter((b) => b !== undefined && !b.isEmpty())
         );
     }
diff --git a/src/RSQLBuilderCustom.test.ts b/src/RSQLBuilderCustom.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "rsql-query-builder",`
`3`		`- "version": "1.1.2",`
	`3`	`+ "version": "1.2.0",`
`4`	`4`	`"description": "Library for building RSQL query strings.",`
`5`	`5`	`"main": "dist/index.js",`
`6`	`6`	`"module": "dist/index.mjs",`