diff --git a/HISTORY.rst b/HISTORY.rst index 463a8e4b82..fc5ad50394 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -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) =================== diff --git a/docs/releases/3.2.rst b/docs/releases/3.2.rst index 24858814d3..0adbaedb85 100644 --- a/docs/releases/3.2.rst +++ b/docs/releases/3.2.rst @@ -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 diff --git a/mayan/apps/documents/search.py b/mayan/apps/documents/search.py index f6d5151cf2..b0fbb0d25c 100644 --- a/mayan/apps/documents/search.py +++ b/mayan/apps/documents/search.py @@ -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') ) diff --git a/mayan/apps/dynamic_search/classes.py b/mayan/apps/dynamic_search/classes.py index caa019bb4e..7f1f0c71b2 100644 --- a/mayan/apps/dynamic_search/classes.py +++ b/mayan/apps/dynamic_search/classes.py @@ -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: diff --git a/mayan/apps/dynamic_search/tests/test_models.py b/mayan/apps/dynamic_search/tests/test_models.py index 83114a8b9a..c322d7d0fb 100644 --- a/mayan/apps/dynamic_search/tests/test_models.py +++ b/mayan/apps/dynamic_search/tests/test_models.py @@ -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)