Add operators for SIMILAR TO and NOT SIMILAR TO (#24)

Author: syndesis

.gitignore

@@ -1 +1,2 @@
-node_modules
+node_modules
+.idea

README.md

@@ -83,6 +83,8 @@ The following filter operators are exposed by default:
 | NOT LIKE '...' | notLike | Scalar |
 | ILIKE '...' | likeInsensitive | Scalar |
 | NOT ILIKE '...' | notLikeInsensitive | Scalar |
+| SIMILAR TO '...' | similarTo | Scalar |
+| NOT SIMILAR TO '...' | notSimilarTo | Scalar |
 
 ## Examples
 

__tests__/fixtures/queries/connections-filter.graphql

@@ -27,6 +27,8 @@ query {
   string_likeInsensitive_es: allFilterables(filter: { string: { likeInsensitive: "%es%" } }) { ...filterableConnection }
   string_notLike_es: allFilterables(filter: { string: { notLike: "%es%" } }) { ...filterableConnection }
   string_notLikeInsensitive_es: allFilterables(filter: { string: { notLikeInsensitive: "%es%" } }) { ...filterableConnection }
+  string_similarTo_te_or_st: allFilterables(filter:{ string: { similarTo: "%(te|st)%" } }) { ...filterableConnection }
+  string_notSimilarTo_te_or_st: allFilterables(filter:{ string: { notSimilarTo: "%(te|st)%" } }) { ...filterableConnection }
   int_equalTo_2_or_string_endsWith_t: allFilterables(filter: { or: [{ int: { equalTo: 2 } }, { string: { endsWith: "t" } }] }) { ...filterableConnection }
   int_equalTo_2_and_string_endsWith_t: allFilterables(filter: { and: [{ int: { equalTo: 2 } }, { string: { endsWith: "t" } }] }) { ...filterableConnection }
   boolean_null_true: allFilterables(filter: { boolean: { null: true } }) { ...filterableConnection }

__tests__/integration/__snapshots__/queries.test.js.snap

@@ -1768,6 +1768,39 @@ Object {
       },
       "totalCount": 2,
     },
+    "string_notSimilarTo_te_or_st": Object {
+      "edges": Array [
+        Object {
+          "cursor": "WyJwcmltYXJ5X2tleV9hc2MiLFsxXV0=",
+          "node": Object {
+            "boolean": true,
+            "id": 1,
+            "int": 1,
+            "numeric": "0.1",
+            "real": 0.1,
+            "string": "TEST",
+          },
+        },
+        Object {
+          "cursor": "WyJwcmltYXJ5X2tleV9hc2MiLFszXV0=",
+          "node": Object {
+            "boolean": false,
+            "id": 3,
+            "int": 3,
+            "numeric": "0.3",
+            "real": 0.3,
+            "string": "tEST",
+          },
+        },
+      ],
+      "pageInfo": Object {
+        "endCursor": "WyJwcmltYXJ5X2tleV9hc2MiLFszXV0=",
+        "hasNextPage": false,
+        "hasPreviousPage": false,
+        "startCursor": "WyJwcmltYXJ5X2tleV9hc2MiLFsxXV0=",
+      },
+      "totalCount": 2,
+    },
     "string_notStartsWithInsensitive_t": Object {
       "edges": Array [],
       "pageInfo": Object {
@@ -1888,6 +1921,39 @@ Object {
       },
       "totalCount": 1,
     },
+    "string_similarTo_te_or_st": Object {
+      "edges": Array [
+        Object {
+          "cursor": "WyJwcmltYXJ5X2tleV9hc2MiLFsyXV0=",
+          "node": Object {
+            "boolean": true,
+            "id": 2,
+            "int": 2,
+            "numeric": "0.2",
+            "real": 0.2,
+            "string": "Test",
+          },
+        },
+        Object {
+          "cursor": "WyJwcmltYXJ5X2tleV9hc2MiLFs0XV0=",
+          "node": Object {
+            "boolean": false,
+            "id": 4,
+            "int": 4,
+            "numeric": "0.4",
+            "real": 0.4,
+            "string": "test",
+          },
+        },
+      ],
+      "pageInfo": Object {
+        "endCursor": "WyJwcmltYXJ5X2tleV9hc2MiLFs0XV0=",
+        "hasNextPage": false,
+        "hasPreviousPage": false,
+        "startCursor": "WyJwcmltYXJ5X2tleV9hc2MiLFsyXV0=",
+      },
+      "totalCount": 2,
+    },
     "string_startsWithInsensitive_t": Object {
       "edges": Array [
         Object {

__tests__/integration/__snapshots__/schema.test.js.snap

@@ -4261,6 +4261,9 @@ input StringFilter {
   # Raw SQL 'not ilike', wildcards must be present and are not escaped
   notLikeInsensitive: String
 
+  # Raw SQL 'not similar to', wildcards are not escaped
+  notSimilarTo: String
+
   # Checks for strings that do not start with this value.  Case sensitive.
   notStartsWith: String
 
@@ -4270,6 +4273,9 @@ input StringFilter {
   # If set to true, checks for null values.  If set to false, checks for non-null values.
   null: Boolean
 
+  # Raw SQL 'similar to', wildcards are not escaped
+  similarTo: String
+
   # Checks for strings starting with this value.  Case sensitive.
   startsWith: String
 
@@ -7758,6 +7764,9 @@ input StringFilter {
   # Raw SQL 'not ilike', wildcards must be present and are not escaped
   notLikeInsensitive: String
 
+  # Raw SQL 'not similar to', wildcards are not escaped
+  notSimilarTo: String
+
   # Checks for strings that do not start with this value.  Case sensitive.
   notStartsWith: String
 
@@ -7767,6 +7776,9 @@ input StringFilter {
   # If set to true, checks for null values.  If set to false, checks for non-null values.
   null: Boolean
 
+  # Raw SQL 'similar to', wildcards are not escaped
+  similarTo: String
+
   # Checks for strings starting with this value.  Case sensitive.
   startsWith: String
 

src/PgConnectionArgFilterOperatorsPlugin.js

@@ -342,6 +342,28 @@ module.exports = function PgConnectionArgFilterOperatorsPlugin(
           allowedFieldTypes: ["String"],
         }
       );
+      addConnectionFilterOperator(
+        "similarTo",
+        "Raw SQL 'similar to', wildcards are not escaped",
+        typeName => getTypeByName(typeName),
+        (identifier, val) => {
+          return sql.query`${identifier} SIMILAR TO ${val}`;
+        },
+        {
+          allowedFieldTypes: ["String"],
+        }
+      );
+      addConnectionFilterOperator(
+        "notSimilarTo",
+        "Raw SQL 'not similar to', wildcards are not escaped",
+        typeName => getTypeByName(typeName),
+        (identifier, val) => {
+          return sql.query`${identifier} NOT SIMILAR TO ${val}`;
+        },
+        {
+          allowedFieldTypes: ["String"],
+        }
+      );
       return _;
     }
   );