Added facets for tags in the search

Jens Kadenbach · Jens Kadenbach · commit cfdbd776feaa · 2013-12-06T01:13:59.000+01:00
Changed the haystack requirement to a fork of haystack
with a fix for faceting with Whoosh until it is implemented
in the main line
diff --git a/functional_tests/tests.py b/functional_tests/tests.py
@@ -93,8 +93,18 @@ def create_pre_authenticated_session(self):
             path='/',
             ))
 
-    def _add_example_item(self):
-        return Item.objects.create(url=EXAMPLE_COM, domain='nothing', owner=self.user)
+    def _add_example_item(self, tags=None):
+        item = Item.objects.create(url=EXAMPLE_COM, domain='nothing', owner=self.user)
+        if tags is not None:
+            item.tags.add(*tags)
+            item.save()
+        return item
+
+    def _add_tagged_items(self):
+        self._add_example_item(('fish', 'boxing'))
+        self._add_example_item(('fish', 'queen'))
+        self._add_example_item(('queen', 'bartender'))
+        self._add_example_item(('queen', 'pypo'))
 
     def _find_tags_from_detail(self):
         self.b.find_element_by_css_selector('a.tags-dropdown').click()
@@ -230,9 +240,6 @@ def test_item_tags_are_shown_in_the_list(self):
         item.save()
 
         self.b.get(self.live_server_url)
-        # Uther activates the tags-list dropdown
-        self.b.find_element_by_css_selector('a.tags-dropdown').click()
-        # Uther sees the two tags for his example entry in a list
         tag_string = ''.join(self._find_tags_from_detail())
         # Uther sees the two tags for his example entry in a list
         self.assertIn('example', tag_string)
@@ -268,4 +275,34 @@ def test_can_update_tags_from_the_list(self):
         self.assertEqual(1, len(items), 'Item not found in results')
         self.assertEqual(EXAMPLE_COM, items[0].get_attribute('href'))
 
+    def _add_item_for_new_user(self):
+        another_user = User.objects.create(username='someone')
+        another_item = Item.objects.create(url=EXAMPLE_COM, domain='nothing', owner=another_user)
+        another_item.tags.add('queen')
+        another_item.save()
+
+    def test_facets_are_shown_in_a_search(self):
+        self.create_pre_authenticated_session()
+        # Uther added some of his tagged items
+        self._add_tagged_items()
+
+        # Another user also adds an item with the same tag
+        self._add_item_for_new_user()
 
+        # Uther starts a search for his queen-tagged items
+        self.b.get(self.live_server_url+'/search')
+        search_input = self.b.find_element_by_name('q')
+        search_input.send_keys('queen')
+        search_input.send_keys(Keys.ENTER)
+        # He sees that his queen-tagged items also have other tags
+        tags = {}
+        for tag in self.b.find_elements_by_css_selector('li.tag'):
+            tags[tag.find_element_by_css_selector('a.taglink').text] = int(
+                tag.find_element_by_css_selector('span.count').text)
+        # And only those items that are shown are counted in the list of tags
+        self.assertEqual({
+            'queen': 3,
+            'fish': 1,
+            'bartender': 1,
+            'pypo': 1
+        }, tags)
diff --git a/readme/search_indexes.py b/readme/search_indexes.py
@@ -7,7 +7,7 @@ class ItemIndex(indexes.SearchIndex, indexes.Indexable):
     title = indexes.CharField(model_attr='title')
     created = indexes.DateTimeField(model_attr='created')
     owner_id = indexes.IntegerField(model_attr='owner_id')
-    tags = indexes.MultiValueField()
+    tags = indexes.MultiValueField(faceted=True)
 
     def prepare_tags(self, obj):
         if not type(obj.tags) is list:
diff --git a/readme/templates/search/search.html b/readme/templates/search/search.html
@@ -1,32 +1,47 @@
-{% extends 'base.html' %}
-{% load crispy_forms_tags %}
-{% block content %}
-    <h2>Search</h2>
-
-    <form method="get" action=".">
-        {{ form|crispy }}
-        <input type="submit" value="Search">
-
-    </form>
-    {% if query %}
-        <h3>Results</h3>
-
-        <div class="row">
-            {% for result in page.object_list %}
-                {% with result.object as item %}
-                    {% include "readme/item_single.html" %}
-                {% endwith %}
-            {% empty %}
-                <p>No results found.</p>
-            {% endfor %}
-        </div>
-
-        {% if page.has_previous or page.has_next %}
-            <div>
-                {% if page.has_previous %}<a href="?q={{ query }}&amp;page={{ page.previous_page_number }}">{% endif %}&laquo; Previous{% if page.has_previous %}</a>{% endif %}
-                |
-                {% if page.has_next %}<a href="?q={{ query }}&amp;page={{ page.next_page_number }}">{% endif %}Next &raquo;{% if page.has_next %}</a>{% endif %}
-            </div>
-        {% endif %}
-    {% endif %}
+{% extends 'base.html' %}
+{% load crispy_forms_tags %}
+{% block content %}
+    <h2>Search</h2>
+
+    <form method="get" action=".">
+        {{ form|crispy }}
+        <input type="submit" value="Search">
+
+    </form>
+    {% if query %}
+        <h3>Results</h3>
+
+        <div class="row">
+            {% for result in page.object_list %}
+                {% with result.object as item %}
+                    {% include "readme/item_single.html" %}
+                {% endwith %}
+            {% empty %}
+                <p>No results found.</p>
+            {% endfor %}
+        </div>
+
+        {% if facets.fields.tags %}
+        <h3>Tags</h3>
+
+        <div class="row">
+            <ul id="taglist">
+                {% for tag in facets.fields.tags %}
+                <li class="tag">
+                    <a class="taglink" href="{{ request.get_full_path }}&amp;selected_facets=tags_exact:{{ tag.0|urlencode }}">{{ tag.0 }}</a>
+                    (<span class="count">{{ tag.1 }}</span>)
+                </li>
+                {% endfor %}
+            </ul>
+
+        </div>
+        {% endif %}
+        {% if page.has_previous or page.has_next %}
+            <div>
+                {% if page.has_previous %}<a href="?q={{ query }}&amp;page={{ page.previous_page_number }}">{% endif %}&laquo; Previous{% if page.has_previous %}</a>{% endif %}
+                |
+                {% if page.has_next %}<a href="?q={{ query }}&amp;page={{ page.next_page_number }}">{% endif %}Next &raquo;{% if page.has_next %}</a>{% endif %}
+            </div>
+        {% endif %}
+    {% endif %}
 {% endblock %}
diff --git a/readme/views.py b/readme/views.py
@@ -1,7 +1,7 @@
 from django.views import generic
-from haystack.forms import SearchForm
+from haystack.forms import FacetedSearchForm
 from haystack.query import SearchQuerySet
-from haystack.views import SearchView, search_view_factory
+from haystack.views import FacetedSearchView, search_view_factory
 from .models import Item
 from .forms import CreateItemForm, UpdateItemForm
 from django.http import HttpResponseRedirect
@@ -94,7 +94,7 @@ class ItemView(RestrictItemAccessMixin, generic.DetailView):
     context_object_name = 'item'
 
 
-class ItemSearchView(SearchView):
+class ItemSearchView(FacetedSearchView):
     """
     SearchView that passes a dynamic SearchQuerySet to the
     form that restricts the result to those owned by
@@ -103,12 +103,12 @@ class ItemSearchView(SearchView):
 
     def build_form(self, form_kwargs=None):
         user_id = self.request.user.id
-        self.searchqueryset = SearchQuerySet().filter(owner_id=user_id)
+        self.searchqueryset = SearchQuerySet().filter(owner_id=user_id).facet('tags')
         return super(ItemSearchView, self).build_form(form_kwargs)
 
 search = login_required(search_view_factory(
     view_class=ItemSearchView,
-    form_class=SearchForm,
+    form_class=FacetedSearchForm,
 ))
 
 # Class based views as normal view function
diff --git a/requirements.txt b/requirements.txt
@@ -1,16 +1,16 @@
-Django==1.6.0
-South==0.8.2
-Whoosh==2.5.4
-django-crispy-forms==1.4.0
-django-filter==0.7
-django-haystack==2.1.0
-django-taggit==0.10
-djangorestframework==2.3.8
-psycopg2==2.5.1
-pycrypto==2.6
-lxml==3.2.4
-requests==2.0.0
-tld==0.6.1
-selenium==2.37.2
-cssselect==0.9.1
-https://github.com/audax/python-readability/archive/master.zip
+Django==1.6.0
+South==0.8.2
+Whoosh==2.5.4
+django-crispy-forms==1.4.0
+django-filter==0.7
+django-taggit==0.10
+djangorestframework==2.3.8
+psycopg2==2.5.1
+pycrypto==2.6
+lxml==3.2.4
+requests==2.0.0
+tld==0.6.1
+selenium==2.37.2
+cssselect==0.9.1
+https://github.com/audax/python-readability/archive/master.zip
+https://github.com/audax/django-haystack/archive/whoosh-basic-facets.zip
