Proper handling of query parameter q with multiple search terms for TinyDB provider. (geopython#2053)

Author: vpmakinen

pygeoapi/provider/tinydb_.py

@@ -401,11 +401,45 @@ def _add_extra_fields(self, json_data: dict) -> dict:
 
         return json_data
 
+    def _prepare_q_param_with_spaces(self, s: str) -> str:
+        """
+        Prepare a search statement for the search term `s`.
+        The term `s` might have spaces.
+
+        Examples (f is shorthand for Q.properties["_metadata-anytext"]):
+        +---------------+--------------------+
+        | search term   | TinyDB search      |
+        +---------------+--------------------+
+        | 'aa'          | f.search('aa')     |
+        | 'aa bb'       | f.search('aa +bb') |
+        | '  aa   bb  ' | f.search('aa +bb') |
+        +---------------+--------------------+
+        """
+        return 'Q.properties["_metadata-anytext"].search("' \
+            + ' +'.join(s.split()) \
+            + '", flags=re.IGNORECASE)'
+
     def _add_search_query(self, query: list, search_term: str = None) -> str:
-        if search_term is not None:
+        """
+        Create a search query according to the OGC API - Records specification.
+
+        https://docs.ogc.org/is/20-004r1/20-004r1.html (Listing 14)
+
+        Examples (f is shorthand for Q.properties["_metadata-anytext"]):
+        +-------------+-----------------------------------+
+        | search term | TinyDB search                     |
+        +-------------+-----------------------------------+
+        | 'aa'        | f.search('aa')                    |
+        | 'aa,bb'     | f.search('aa')|f.search('bb')     |
+        | 'aa,bb cc'  | f.search('aa')|f.search('bb +cc') |
+        +-------------+-----------------------------------+
+        """
+        if search_term is not None and len(search_term) > 0:
             LOGGER.debug('catalogue q= query')
-            for t in search_term.split():
-                query.append(f"(Q.properties['_metadata-anytext'].search('{t}', flags=re.IGNORECASE))")  # noqa
+            terms = [s for s in search_term.split(',') if len(s) > 0]
+            query.append('|'.join(
+                [self._prepare_q_param_with_spaces(t) for t in terms]
+            ))
 
         return query
 

tests/test_tinydb_catalogue_provider.py

@@ -133,10 +133,10 @@ def test_query(config):
         assert results['numberMatched'] == 6
         assert results['numberReturned'] == 6
 
-    results = p.query(q='crops barley')
-    assert len(results['features']) == 2
-    assert results['numberMatched'] == 2
-    assert results['numberReturned'] == 2
+    results = p.query(q='Frost free')
+    assert len(results['features']) == 1
+    assert results['numberMatched'] == 1
+    assert results['numberReturned'] == 1
 
     results = p.query(limit=1)
     assert len(results['features']) == 1