Add the ability to filter by empty values with "EMPTY" magic value #296 (#487)

Signed-off-by: Thomas Druez <[email protected]>

Author: tdruez

CHANGELOG.rst

@@ -68,6 +68,10 @@ v31.0.0 (next)
   https://github.com/nexB/scancode.io/issues/164
   https://github.com/nexB/scancode.io/issues/464
 
+- Add the ability to filter by empty and none values providing the "EMPTY" magic value
+  to any filters.
+  https://github.com/nexB/scancode.io/issues/296
+
 v30.2.0 (2021-12-17)
 --------------------
 

scanpipe/filters.py

@@ -21,6 +21,7 @@
 # Visit https://github.com/nexB/scancode.io for support and download.
 
 from django.apps import apps
+from django.core.validators import EMPTY_VALUES
 from django.db import models
 
 import django_filters
@@ -36,6 +37,8 @@
 
 
 class FilterSetUtilsMixin:
+    empty_value = "EMPTY"
+
     @staticmethod
     def remove_field_from_query_dict(query_dict, field_name, remove_value=None):
         """
@@ -88,6 +91,20 @@ def get_filters_breadcrumb(self):
     def verbose_name_plural(cls):
         return cls.Meta.model._meta.verbose_name_plural
 
+    def filter_queryset(self, queryset):
+        """
+        Adds the ability to filter by empty and none values providing the "magic"
+        `empty_value` to any filters.
+        """
+
+        for name, value in self.form.cleaned_data.items():
+            if value == self.empty_value:
+                queryset = queryset.filter(**{f"{name}__in": EMPTY_VALUES})
+            else:
+                queryset = self.filters[name].filter(queryset, value)
+
+        return queryset
+
 
 class BulmaLinkWidget(LinkWidget):
     """

scanpipe/templates/scanpipe/includes/run_modal_content.html

@@ -92,7 +92,7 @@
               Resources status
             </p>
             {% for status, count in status_summary.items %}
-              <a class="panel-block" href="{% url 'project_resources' run.project.uuid %}?status={{ status }}" target="_blank">
+              <a class="panel-block" href="{% url 'project_resources' run.project.uuid %}?status={{ status|default:'EMPTY' }}" target="_blank">
                 {% if status %}{{ status }}{% else %}<i>(no status)</i>{% endif %}: {{ count }}
               </a>
             {% endfor %}

scanpipe/templates/scanpipe/project_detail.html

@@ -231,6 +231,7 @@ <h3 class="title is-4 has-text-centered mb-3">
             // Retrieve the data ("name" value for filtering) from the .bb-tooltip section
             let name = document.querySelector(`#${base_chart_div.id} .bb-tooltip .name`).textContent;
             if (base_url && field) {
+              if (name === "(No value detected)") name = "EMPTY";
               let full_url = `${base_url}?${field}=${name}`;
               if (in_package) full_url += `&in_package=${in_package}`;
               if (event.ctrlKey || event.metaKey) window.open(full_url, '_blank');

scanpipe/tests/test_filters.py

@@ -0,0 +1,70 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# http://nexb.com and https://github.com/nexB/scancode.io
+# The ScanCode.io software is licensed under the Apache License version 2.0.
+# Data generated with ScanCode.io is provided as-is without warranties.
+# ScanCode is a trademark of nexB Inc.
+#
+# You may not use this software except in compliance with the License.
+# You may obtain a copy of the License at: http://apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+#
+# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES
+# OR CONDITIONS OF ANY KIND, either express or implied. No content created from
+# ScanCode.io should be considered or used as legal advice. Consult an Attorney
+# for any legal advice.
+#
+# ScanCode.io is a free software code scanning tool from nexB Inc. and others.
+# Visit https://github.com/nexB/scancode.io for support and download.
+
+from django.test import TestCase
+
+from scanpipe.filters import ResourceFilterSet
+from scanpipe.models import CodebaseResource
+from scanpipe.models import Project
+
+
+class ScanPipeFiltersTest(TestCase):
+    def setUp(self):
+        self.project1 = Project.objects.create(name="Analysis")
+
+    def test_scanpipe_filters_filter_queryset_empty_values(self):
+        resource1 = CodebaseResource.objects.create(
+            project=self.project1,
+            path="r1",
+            # CharField blank=True null=False
+            programming_language="Python",
+            # JSONField default=list
+            copyrights=[{"copyright": "Copyright (c)"}],
+        )
+        resource2 = CodebaseResource.objects.create(
+            project=self.project1,
+            path="r2",
+        )
+
+        data = {"programming_language": ""}
+        filterset = ResourceFilterSet(data=data)
+        self.assertEqual([resource1, resource2], list(filterset.qs))
+
+        data = {"programming_language": "Python"}
+        filterset = ResourceFilterSet(data=data)
+        self.assertEqual([resource1], list(filterset.qs))
+
+        data = {"programming_language": "EMPTY"}
+        filterset = ResourceFilterSet(data=data)
+        self.assertEqual([resource2], list(filterset.qs))
+
+        data = {"copyrights": ""}
+        filterset = ResourceFilterSet(data=data)
+        self.assertEqual([resource1, resource2], list(filterset.qs))
+
+        data = {"copyrights": "Copyright"}
+        filterset = ResourceFilterSet(data=data)
+        self.assertEqual([resource1], list(filterset.qs))
+
+        data = {"copyrights": "EMPTY"}
+        filterset = ResourceFilterSet(data=data)
+        self.assertEqual([resource2], list(filterset.qs))