Merge pull request #98 from Souleymane-T/feature-add-case-insensitive…

…-contains-filter

Add case insensitive contains filter

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ### Added
 
-- nothing added
+- Case insensitive contains filter
 
 ### Changed
 

concrete_datastore/api/v1/filters.py

@@ -334,6 +334,51 @@ def filter_queryset(self, request, queryset, view):
         return queryset.filter(q_object)
 
 
+class FilterSupportingInsensitiveContainsBackend(
+    BaseFilterBackend, CustomShemaOperationParameters
+):
+    def get_schema_operation_parameters(self, view):
+        params = [
+            {
+                'name': f'{field_name}__icontains',
+                'required': False,
+                'in': 'query',
+                'schema': {'type': 'string'},
+            }
+            for field_name in getattr(view, 'filterset_fields', ())
+            if get_filter_field_type(view.model_class, field_name)
+            in ('CharField', 'TextField')
+        ]
+        return self.return_if_not_details(view=view, value=params)
+
+    def filter_queryset(self, request, queryset, view):
+        query_params = request.query_params
+        filterset_fields = getattr(view, 'filterset_fields', ())
+
+        q_object = None
+        for param in query_params:
+            if not param.endswith('__icontains'):
+                continue
+            param_field = param.replace('__icontains', '')
+            if param_field not in filterset_fields:
+                continue
+            if not get_filter_field_type(queryset.model, param_field) in (
+                'CharField',
+                'TextField',
+            ):
+                continue
+
+            custom_filter = {param: query_params.get(param)}
+            if q_object is None:
+                q_object = Q(**custom_filter)
+            else:
+                q_object &= Q(**custom_filter)
+        if q_object is None:
+            return queryset
+
+        return queryset.filter(q_object)
+
+
 class FilterSupportingEmptyBackend(
     BaseFilterBackend, CustomShemaOperationParameters
 ):

concrete_datastore/api/v1/views.py

@@ -76,6 +76,7 @@
     FilterSupportingOrBackend,
     FilterSupportingEmptyBackend,
     FilterSupportingContainsBackend,
+    FilterSupportingInsensitiveContainsBackend,
     FilterSupportingRangeBackend,
     FilterUserByLevel,
     FilterSupportingComparaisonBackend,
@@ -1227,6 +1228,7 @@ class PaginatedViewSet(object):
         FilterSupportingOrBackend,
         FilterSupportingEmptyBackend,
         FilterSupportingContainsBackend,
+        FilterSupportingInsensitiveContainsBackend,
         FilterSupportingRangeBackend,
         FilterUserByLevel,
         FilterSupportingComparaisonBackend,

tests/tests_api_v1_1/test_filters.py

@@ -715,6 +715,43 @@ def test_one_result_with_non_char_field(self):
         self.assertEqual(names, {'Project1', 'Project2'})
 
 
+@override_settings(DEBUG=True)
+class FilterInsensitiveContainsBackend(APITestCase):
+    def setUp(self):
+        self.user = User.objects.create_user('user@netsach.org')
+        self.user.set_password('plop')
+        self.user.set_level('superuser')
+        self.user.save()
+        confirmation = UserConfirmation.objects.create(user=self.user)
+        confirmation.confirmed = True
+        confirmation.save()
+        url = '/api/v1.1/auth/login/'
+        resp = self.client.post(
+            url, {"email": "user@netsach.org", "password": "plop"}
+        )
+        self.token = resp.data['token']
+
+        self.project1 = Project.objects.create(
+            name='Project1', description='text of description1'
+        )
+        self.project1 = Project.objects.create(
+            name='Project2', description='text of description2'
+        )
+
+    def test_success_one_result_with_icontain_filter(self):
+        resp = self.client.get(
+            '/api/v1.1/project/',
+            data={'name__icontains': 'pRoJeCt1'},
+            HTTP_AUTHORIZATION='Token {}'.format(self.token),
+        )
+        self.assertEqual(resp.status_code, status.HTTP_200_OK)
+        self.assertIn('results', resp.data)
+        self.assertIn('total_objects_count', resp.data)
+        self.assertEqual(resp.data['total_objects_count'], 1)
+        names = {project['name'] for project in resp.data['results']}
+        self.assertEqual(names, {'Project1'})
+
+
 @override_settings(DEBUG=True)
 class FilterObjectByUid(APITestCase):
     def setUp(self):