SearchModel no longer returns result_set. It is unfiltered and unused.

Signed-off-by: Michael Price <loneviking72@gmail.com>

HISTORY.rst

@@ -15,6 +15,7 @@ Next (2018-XX-XX)
 - Update to the latest version the packages for building, development, documentation and testing.
 - Add statistics script to produce a report of the views, APIs and test for each app.
 - Merge base64 filename patch from Cornelius Ludmann.
+- SearchModel retrun interface changed. The class no longer returns the result_set value. Use the queryset returned instead.
 
 2.8 (2018-02-27)
 ================

mayan/apps/dynamic_search/api_views.py

@@ -38,7 +38,7 @@ class APISearchView(SearchModelMixin, generics.ListAPIView):
             self.mayan_object_permissions = {'GET': (search_model.permission,)}
 
         try:
-            queryset, ids, timedelta = search_model.search(
+            queryset, timedelta = search_model.search(
                 query_string=self.request.GET, user=self.request.user
             )
         except Exception as exception:
@@ -86,7 +86,7 @@ class APIAdvancedSearchView(SearchModelMixin, generics.ListAPIView):
             global_and_search = False
 
         try:
-            queryset, ids, timedelta = self.search_model.search(
+            queryset, timedelta = self.search_model.search(
                 query_string=self.request.GET, user=self.request.user,
                 global_and_search=global_and_search
             )

mayan/apps/dynamic_search/classes.py

@@ -236,7 +236,7 @@ class SearchModel(object):
                 self.permission, user, queryset
             )
 
-        return queryset, result_set, elapsed_time
+        return queryset, elapsed_time
 
 
 # SearchField classes

mayan/apps/dynamic_search/tests/test_models.py

@@ -31,24 +31,24 @@ class DocumentSearchTestCase(BaseTestCase):
         document versions and document version pages
         """
 
-        model_list, result_set, elapsed_time = document_search.search(
+        queryset, elapsed_time = document_search.search(
             {'q': 'Mayan'}, user=self.admin_user
         )
-        self.assertEqual(len(result_set), 1)
-        self.assertEqual(list(model_list), [self.document])
+        self.assertEqual(queryset.count(), 1)
+        self.assertTrue(self.document in queryset)
 
     def test_advanced_search_after_related_name_change(self):
         # Test versions__filename
-        model_list, result_set, elapsed_time = document_search.search(
+        queryset, elapsed_time = document_search.search(
             {'label': self.document.label}, user=self.admin_user
         )
-        self.assertEqual(len(result_set), 1)
-        self.assertEqual(list(model_list), [self.document])
+        self.assertEqual(queryset.count(), 1)
+        self.assertTrue(self.document in queryset)
 
         # Test versions__mimetype
-        model_list, result_set, elapsed_time = document_search.search(
+        queryset, elapsed_time = document_search.search(
             {'versions__mimetype': self.document.file_mimetype},
             user=self.admin_user
         )
-        self.assertEqual(len(result_set), 1)
-        self.assertEqual(list(model_list), [self.document])
+        self.assertEqual(queryset.count(), 1)
+        self.assertTrue(self.document in queryset)

mayan/apps/dynamic_search/tests/test_views.py

@@ -39,10 +39,10 @@ class Issue46TestCase(GenericViewTestCase):
 
     def test_advanced_search_past_first_page(self):
         # Make sure all documents are returned by the search
-        model_list, result_set, elapsed_time = document_search.search(
+        queryset, elapsed_time = document_search.search(
             {'label': 'test document'}, user=self.admin_user
         )
-        self.assertEqual(len(result_set), self.document_count)
+        self.assertEqual(queryset.count(), self.document_count)
 
         with self.settings(COMMON_PAGINATE_BY=2):
             # Funcitonal test for the first page of advanced results

mayan/apps/dynamic_search/views.py

@@ -39,7 +39,7 @@ class ResultsView(SearchModelMixin, SingleObjectListView):
             else:
                 global_and_search = False
 
-            queryset, ids, timedelta = self.search_model.search(
+            queryset, timedelta = self.search_model.search(
                 query_string=self.request.GET, user=self.request.user,
                 global_and_search=global_and_search
             )