Merge pull request #124 from AltSchool/fix/boolean-filter

Convert filter values to booleans for boolean fields

Author: aleontiev

dynamic_rest/filters.py

@@ -6,6 +6,7 @@
 from django.utils import six
 from rest_framework import serializers
 from rest_framework.exceptions import ValidationError
+from rest_framework.fields import BooleanField, NullBooleanField
 from rest_framework.filters import BaseFilterBackend, OrderingFilter
 
 from dynamic_rest.conf import settings
@@ -81,6 +82,7 @@ def generate_query_key(self, serializer):
         rewritten = []
         last = len(self.field) - 1
         s = serializer
+        field = None
         for i, field_name in enumerate(self.field):
             # Note: .fields can be empty for related serializers that aren't
             # sideloaded. Fields that are deferred also won't be present.
@@ -128,7 +130,7 @@ def generate_query_key(self, serializer):
         if self.operator:
             rewritten.append(self.operator)
 
-        return '__'.join(rewritten)
+        return ('__'.join(rewritten), field)
 
 
 class DynamicFilterBackend(BaseFilterBackend):
@@ -283,7 +285,9 @@ def _filters_to_query(self, includes, excludes, serializer, q=None):
         def rewrite_filters(filters, serializer):
             out = {}
             for k, node in six.iteritems(filters):
-                filter_key = node.generate_query_key(serializer)
+                filter_key, field = node.generate_query_key(serializer)
+                if isinstance(field, (BooleanField, NullBooleanField)):
+                    node.value = node.value.lower() not in self.FALSEY_STRINGS
                 out[filter_key] = node.value
 
             return out

tests/migrations/0004_user_is_dead.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9 on 2016-08-08 13:28
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tests', '0003_auto_20160401_1656'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='user',
+            name='is_dead',
+            field=models.NullBooleanField(default=False),
+        ),
+    ]

tests/models.py

@@ -17,6 +17,7 @@ class User(models.Model):
         'favorite_pet_type',
         'favorite_pet_id',
     )
+    is_dead = models.NullBooleanField(default=False)
 
 
 class Profile(models.Model):

tests/serializers.py

@@ -149,7 +149,8 @@ class Meta:
             'profile',
             'date_of_birth',
             'favorite_pet_id',
-            'favorite_pet'
+            'favorite_pet',
+            'is_dead',
         )
         deferred_fields = (
             'last_name',
@@ -159,6 +160,7 @@ class Meta:
             'thumbnail_url',
             'favorite_pet_id',
             'favorite_pet',
+            'is_dead',
         )
         read_only_fields = ('profile',)
 

tests/test_api.py

@@ -26,6 +26,11 @@ def setUp(self):
         self.fixture = create_fixture()
         self.maxDiff = None
 
+    def _get_json(self, url, expected_status=200):
+        response = self.client.get(url)
+        self.assertEquals(expected_status, response.status_code)
+        return json.loads(response.content.decode('utf-8'))
+
     def test_get(self):
         with self.assertNumQueries(1):
             # 1 for User, 0 for Location
@@ -487,7 +492,8 @@ def test_post(self):
                     "thumbnail_url": None,
                     "number_of_cats": 1,
                     "profile": None,
-                    "date_of_birth": None
+                    "date_of_birth": None,
+                    "is_dead": False,
                 }
             })
 
@@ -783,6 +789,37 @@ def test_get_with_request_filters_and_requires(self):
                 }]
             }, json.loads(response.content.decode('utf-8')))
 
+    def test_boolean_filters_on_boolean_field(self):
+        # create one dead user
+        User.objects.create(name='Dead', last_name='Mort', is_dead=True)
+
+        # set up test specs
+        tests = {
+            True: ['true', 'True', '1', 'okies'],
+            False: ['false', 'False', '0', '']
+        }
+
+        # run through test scenarios
+        for expected_value, test_values in tests.items():
+            for test_value in test_values:
+                url = (
+                    '/users/?include[]=is_dead&filter{is_dead}=%s' % test_value
+                )
+                data = self._get_json(url)
+
+                expected = set([expected_value])
+                actual = set([o['is_dead'] for o in data['users']])
+                self.assertEqual(
+                    expected,
+                    actual,
+                    "Boolean filter '%s' failed. Expected=%s Actual=%s" % (
+                        test_value,
+                        expected,
+                        actual,
+                    )
+
+                )
+
 
 @override_settings(
     DYNAMIC_REST={

tests/test_viewsets.py

@@ -123,7 +123,7 @@ def test_is_null_casting(self):
     def test_nested_filter_rewrite(self):
         node = FilterNode(['members', 'id'], 'in', [1])
         gs = GroupSerializer(include_fields='*')
-        filter_key = node.generate_query_key(gs)
+        filter_key, field = node.generate_query_key(gs)
         self.assertEqual(filter_key, 'users__id__in')