Add support for search field transformations

Add search transformation to the document UUID field
to remove dashes.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2019-06-08 20:52:59 -04:00
parent 74f333d16c
commit c7474cae1b
5 changed files with 32 additions and 5 deletions
+1
View File
@@ -284,6 +284,7 @@
* Add support for patchin dependency files using rewriting rules.
* Allow searching documents by UUID.
* Improve search negation logic.
* Add support for search field transformations.
3.1.11 (2019-04-XX)
===================
+1
View File
@@ -713,6 +713,7 @@ Other changes
- Allow searching documents by UUID.
- Improve search negation logic. Only dashes at the start of terms and
outside of quotes are now interpreted as negation.
- Add support for search field transformations.
Removals
+8 -1
View File
@@ -6,6 +6,11 @@ from mayan.apps.dynamic_search.classes import SearchModel
from .permissions import permission_document_view
def format_uuid(term_string):
return term_string.replace('-', '')
document_search = SearchModel(
app_label='documents', model_name='Document',
permission=permission_document_view,
@@ -20,7 +25,9 @@ document_search.add_model_field(
)
document_search.add_model_field(field='label', label=_('Label'))
document_search.add_model_field(field='description', label=_('Description'))
document_search.add_model_field(field='uuid', label=_('UUID'))
document_search.add_model_field(
field='uuid', label=_('UUID'), transformation_function=format_uuid
)
document_search.add_model_field(
field='versions__checksum', label=_('Checksum')
)
+10 -4
View File
@@ -30,8 +30,15 @@ class FieldQuery(object):
if term.string == TERM_OPERATION_OR:
query_operation = QUERY_OPERATION_OR
else:
if search_field.transformation_function:
term_string = search_field.transformation_function(
term_string=term.string
)
else:
term_string = term.string
q_object = Q(
**{'%s__%s' % (search_field.field, 'icontains'): term.string}
**{'%s__%s' % (search_field.field, 'icontains'): term_string}
)
if term.negated:
q_object = ~q_object
@@ -58,10 +65,11 @@ class SearchField(object):
"""
Search for terms in fields that directly belong to the parent SearchModel
"""
def __init__(self, search_model, field, label):
def __init__(self, search_model, field, label, transformation_function=None):
self.search_model = search_model
self.field = field
self.label = label
self.transformation_function = transformation_function
def get_full_name(self):
return self.field
@@ -283,8 +291,6 @@ class SearchTermCollection(object):
else:
is_meta = False
print("NEW TERM", ''.join(term_letters))
if is_meta:
negated = False
else:
@@ -158,3 +158,15 @@ class DocumentSearchTestCase(DocumentTestMixin, BaseTestCase):
{'label': '-"second-document"'}, user=self._test_case_user
)
self.assertEqual(queryset.count(), 0)
def test_search_field_transformation_functions(self):
self.upload_document()
self.grant_access(
obj=self.test_document, permission=permission_document_view
)
queryset = document_search.search(
{'uuid': force_text(self.test_document.uuid)}, user=self._test_case_user
)
self.assertEqual(queryset.count(), 1)