Made it easier to override SearchView/SearchForm behavior when no query is present.

No longer do you need to override both ``SearchForm`` & ``SearchView`` if you want to return all results. Use the built-in ``SearchView``, provide your own custom ``SearchForm`` subclass & override the ``no_query_found`` method per the docstring.

Author: toastdriven

haystack/forms.py

@@ -3,7 +3,7 @@
 from django.utils.text import capfirst
 from django.utils.translation import ugettext_lazy as _
 import haystack
-from haystack.query import SearchQuerySet
+from haystack.query import SearchQuerySet, EmptySearchQuerySet
 
 
 def model_choices(site=None):
@@ -26,16 +26,30 @@ def __init__(self, *args, **kwargs):
 
         super(SearchForm, self).__init__(*args, **kwargs)
 
+    def no_query_found(self):
+        """
+        Determines the behavior when no query was found.
+        
+        By default, no results are returned (``EmptySearchQuerySet``).
+        
+        Should you want to show all results, override this method in your
+        own ``SearchForm`` subclass and do ``return self.searchqueryset.all()``.
+        """
+        return EmptySearchQuerySet()
+    
     def search(self):
-        if self.is_valid():
-            sqs = self.searchqueryset.auto_query(self.cleaned_data['q'])
-            
-            if self.load_all:
-                sqs = sqs.load_all()
-            
-            return sqs
-        else:
-            return []
+        if not self.is_valid():
+            return self.no_query_found()
+        
+        if not self.cleaned_data['q']:
+            return self.no_query_found()
+        
+        sqs = self.searchqueryset.auto_query(self.cleaned_data['q'])
+        
+        if self.load_all:
+            sqs = sqs.load_all()
+        
+        return sqs
 
     def get_suggestion(self):
         if not self.is_valid():
@@ -70,8 +84,9 @@ def get_models(self):
         """Return an alphabetical list of model classes in the index."""
         search_models = []
 
-        for model in self.cleaned_data['models']:
-            search_models.append(models.get_model(*model.split('.')))
+        if self.is_valid():
+            for model in self.cleaned_data['models']:
+                search_models.append(models.get_model(*model.split('.')))
 
         return search_models
 

haystack/views.py

@@ -20,7 +20,6 @@ class SearchView(object):
     form = None
     results_per_page = RESULTS_PER_PAGE
 
-    
     def __init__(self, template=None, load_all=True, form_class=ModelSearchForm, searchqueryset=None, context_class=RequestContext, results_per_page=None):
         self.load_all = load_all
         self.form_class = form_class
@@ -83,10 +82,7 @@ def get_results(self):
         
         Returns an empty list if there's no query to search with.
         """
-        if self.query:
-            return self.form.search()
-        
-        return EmptySearchQuerySet()
+        return self.form.search()
 
     def build_page(self):
         """

tests/core/tests/views.py

@@ -53,6 +53,8 @@ def test_invalid_page(self):
 
     def test_empty_results(self):
         sv = SearchView()
+        sv.request = HttpRequest()
+        sv.form = sv.build_form()
         self.assert_(isinstance(sv.get_results(), EmptySearchQuerySet))
 
     def test_initial_data(self):
@@ -141,6 +143,8 @@ def test_search_no_query(self):
 
     def test_empty_results(self):
         fsv = FacetedSearchView()
+        fsv.request = HttpRequest()
+        fsv.form = fsv.build_form()
         self.assert_(isinstance(fsv.get_results(), EmptySearchQuerySet))