fix: move custom operator tests from Test Suite to JS tests

Author: josdejong

src/stringify.test.ts

@@ -5,6 +5,7 @@ import suite from '../test-suite/stringify.test.json'
 import schema from '../test-suite/stringify.test.schema.json'
 import { compile } from './compile'
 import { stringify } from './stringify'
+import type { JSONQueryStringifyOptions } from './types'
 
 const groupByCategory = compile(['groupBy', ['get', 'category']])
 const testsByCategory = groupByCategory(suite.groups) as Record<
@@ -30,6 +31,46 @@ for (const [category, testGroups] of Object.entries(testsByCategory)) {
   })
 }
 
+describe('customization', () => {
+  test('should stringify a custom operator', () => {
+    const options: JSONQueryStringifyOptions = {
+      operators: [{ name: 'aboutEq', op: '~=', at: '==' }]
+    }
+
+    expect(stringify(['aboutEq', 2, 3], options)).toEqual('2 ~= 3')
+    expect(stringify(['filter', ['aboutEq', 2, 3]], options)).toEqual('filter(2 ~= 3)')
+    expect(stringify(['object', { result: ['aboutEq', 2, 3] }], options)).toEqual(
+      '{ result: 2 ~= 3 }'
+    )
+    // existing operators should still be there
+    expect(stringify(['eq', 2, 3], options)).toEqual('2 == 3')
+
+    // test precedence and parenthesis
+    expect(stringify(['aboutEq', ['aboutEq', 2, 3], 4], options)).toEqual('(2 ~= 3) ~= 4')
+    expect(stringify(['aboutEq', 2, ['aboutEq', 3, 4]], options)).toEqual('2 ~= (3 ~= 4)')
+    expect(stringify(['aboutEq', ['and', 2, 3], 4], options)).toEqual('(2 and 3) ~= 4')
+    expect(stringify(['aboutEq', 2, ['and', 3, 4]], options)).toEqual('2 ~= (3 and 4)')
+    expect(stringify(['and', ['aboutEq', 2, 3], 4], options)).toEqual('2 ~= 3 and 4')
+    expect(stringify(['and', 2, ['aboutEq', 3, 4]], options)).toEqual('2 and 3 ~= 4')
+    expect(stringify(['aboutEq', ['add', 2, 3], 4], options)).toEqual('2 + 3 ~= 4')
+    expect(stringify(['aboutEq', 2, ['add', 3, 4]], options)).toEqual('2 ~= 3 + 4')
+    expect(stringify(['add', ['aboutEq', 2, 3], 4], options)).toEqual('(2 ~= 3) + 4')
+    expect(stringify(['add', 2, ['aboutEq', 3, 4]], options)).toEqual('2 + (3 ~= 4)')
+  })
+
+  test('should stringify a custom operator which is leftAssociative', () => {
+    const options: JSONQueryStringifyOptions = {
+      operators: [{ name: 'aboutEq', op: '~=', at: '==', leftAssociative: true }]
+    }
+
+    expect(stringify(['aboutEq', ['aboutEq', 2, 3], 4], options)).toEqual('2 ~= 3 ~= 4')
+    expect(stringify(['aboutEq', 2, ['aboutEq', 3, 4]], options)).toEqual('2 ~= (3 ~= 4)')
+  })
+
+  // Note: we do not test the option `CustomOperator.vararg`
+  // since they have no effect on stringification, only on parsing.
+})
+
 describe('test-suite', () => {
   test('should validate the stringify test-suite against its JSON schema', () => {
     const ajv = new Ajv({ allErrors: false })

test-suite/stringify.test.json

@@ -126,19 +126,6 @@
         { "input": ["mod", 2, 3, 4], "output": "2 % 3 % 4" }
       ]
     },
-    {
-      "category": "operator",
-      "description": "should stringify a custom operator",
-      "options": {
-        "operators": [{ "name": "aboutEq", "op": "~=", "at": "==" }]
-      },
-      "tests": [
-        { "input": ["aboutEq", 2, 3], "output": "2 ~= 3" },
-        { "input": ["filter", ["aboutEq", 2, 3]], "output": "filter(2 ~= 3)" },
-        { "input": ["object", { "result": ["aboutEq", 2, 3] }], "output": "{ result: 2 ~= 3 }" },
-        { "input": ["eq", 2, 3], "output": "2 == 3" }
-      ]
-    },
     {
       "category": "function",
       "description": "should stringify a function",

test-suite/stringify.test.schema.json

@@ -20,11 +20,7 @@
             "type": "object",
             "properties": {
               "indentation": { "type": "string" },
-              "maxLineLength": { "type": "number" },
-              "operators": {
-                "type": "array",
-                "items": { "type": "object" }
-              }
+              "maxLineLength": { "type": "number" }
             }
           },
           "tests": {