Merge pull request #223 from cbmi/issue-172

Add field to DataField and DataConcept for excluding from search index

avocado/core/utils.py

@@ -70,8 +70,10 @@ def get_heuristic_flags(field):
     # For strings and booleans, set the enumerable flag by default
     # it below the enumerable threshold
     # TextFields are typically used for free text
+    enumerable = is_enumerable(field)
     return {
-        'enumerable': is_enumerable(field),
+        'enumerable': enumerable,
+        'indexable': enumerable or is_searchable(field),
     }
 
 

avocado/models.py

@@ -135,6 +135,10 @@ class DataField(BasePlural, PublishArchiveMixin):
     # no full text data.
     enumerable = models.BooleanField(default=False)
 
+    # Set this field to False if you wish to exclude this field's data from the
+    # Haystack index.
+    indexable = models.BooleanField(default=True)
+
     type = models.CharField(max_length=100, blank=True, null=True,
                             help_text='Logical type of this field. Typically '
                                       'used downstream for defining behavior '
@@ -736,6 +740,10 @@ class DataConcept(BasePlural, PublishArchiveMixin):
     # represents.
     sortable = models.BooleanField(default=True)
 
+    # Set this field to False if you wish to exclude DataFields associated
+    # with this concept from the Haystack index.
+    indexable = models.BooleanField(default=True)
+
     objects = managers.DataConceptManager()
 
     def format(self, *args, **kwargs):

avocado/templates/search/indexes/avocado/dataconcept_text.txt

@@ -3,5 +3,6 @@
 {{ object.description|default:"" }}
 {{ object.keywords|default:"" }}
 {% if object.category %}{% include "search/indexes/avocado/datacategory_text.txt" with object=object.category %}{% endif %}
-{% for cfield in object.concept_fields.all %}{{ cfield }}{% include "search/indexes/avocado/datafield_text.txt" with object=cfield.field %}
-{% endfor %}
+{% if object.indexable %}
+{% for cfield in object.concept_fields.all %}{{ cfield }}{% include "search/indexes/avocado/datafield_text.txt" with object=cfield.field %}{% endfor %}
+{% endif %}

avocado/templates/search/indexes/avocado/datafield_text.txt

@@ -4,5 +4,5 @@
 {{ object.keywords|default:"" }}
 {{ object.model_name }}
 {% if object.category %}{% include "search/indexes/avocado/datacategory_text.txt" with object=object.category %}{% endif %}
-{% if object.enumerable or object.searchable %}{% for value in object.labels %}{{ value }}
+{% if object.indexable %}{% for value in object.labels %}{{ value }}
 {% endfor %}{% endif %}

tests/cases/search/tests.py

@@ -24,6 +24,37 @@ def setUp(self):
                                 verbosity=0)
 
 
+class ExcludedIndexSearchTest(SearchTest):
+    def test_field_search(self):
+        search = DataField.objects.search
+
+        self.assertEqual(len(search('Erick')), 1)
+
+        employee = DataField.objects.get_by_natural_key(
+            'search.employee.first_name')
+        employee.indexable = False
+        employee.save()
+
+        management.call_command('rebuild_index', interactive=False,
+                                verbosity=0)
+
+        self.assertEqual(len(search('Erick')), 0)
+
+    def test_concept_search(self):
+        search = DataConcept.objects.search
+
+        self.assertEqual(len(search('Erick')), 1)
+
+        employee = DataConcept.objects.get(name='First Name')
+        employee.indexable = False
+        employee.save()
+
+        management.call_command('rebuild_index', interactive=False,
+                                verbosity=0)
+
+        self.assertEqual(len(search('Erick')), 0)
+
+
 class FieldSearchTest(SearchTest):
     def test_empty(self):
         self.assertEqual(len(DataField.objects.published()), 12)