django-searchkit 0.1__py3-none-any.whl → 1.1__py3-none-any.whl

build/lib/searchkit/views.py

@@ -0,0 +1,23 @@
+from django.utils.translation import gettext_lazy as _
+from django.http import HttpResponse
+from django.http import Http404, HttpResponseBadRequest
+from django.apps import apps
+from django.contrib.contenttypes.models import ContentType
+from django.views.generic import View
+from .forms import SearchkitModelForm
+from .forms import searchkit_formset_factory
+
+
+# FIXME: Check permissions and authentication.
+class SearchkitAjaxView(View):
+    """
+    Reload the formset via ajax.
+    """
+    def get(self, request, **kwargs):
+        contenttype_form = SearchkitModelForm(data=self.request.GET)
+        if contenttype_form.is_valid():
+            model = contenttype_form.cleaned_data['searchkit_model'].model_class()
+            formset = searchkit_formset_factory(model=model)(data=request.GET)
+            return HttpResponse(formset.render())
+        else:
+            return HttpResponseBadRequest(_('Invalid searchkit-model-form.'))

{django_searchkit-0.1.dist-info → django_searchkit-1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-searchkit
-Version: 0.1
+Version: 1.1
 Summary: Finally a real searchkit for django!
 Home-page: https://github.com/thomst/django-searchkit
 Author: Thomas Leichtfuß
@@ -9,9 +9,6 @@ License: BSD License
 Platform: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.0
-Classifier: Framework :: Django :: 3.1
-Classifier: Framework :: Django :: 3.2
 Classifier: Framework :: Django :: 4.0
 Classifier: Framework :: Django :: 4.1
 Classifier: Framework :: Django :: 4.2
@@ -23,8 +20,6 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -33,7 +28,9 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Description-Content-Type: text/markdown
 License-File: LICENCE
-Requires-Dist: Django>=3.0
+Requires-Dist: Django>=4.0
+Requires-Dist: django-picklefield>=2.0
+Requires-Dist: django-modeltree
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -50,13 +47,19 @@ Dynamic: summary
 
 [<img src="https://github.com/thomst/django-searchkit/actions/workflows/ci.yml/badge.svg">](https://github.com/thomst/django-searchkit/)
 [<img src="https://coveralls.io/repos/github/thomst/django-searchkit/badge.svg?branch=main">](https://coveralls.io/github/thomst/django-searchkit?branch=main)
-[<img src="https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue">](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
-[<img src="https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1-orange">](https://img.shields.io/badge/django-3.1%20%7C%203.2%20%7C%204.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1-orange)
+[<img src="https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue">](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue)
+[<img src="https://img.shields.io/badge/django-4.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1%20%7C%205.2-orange">](https://img.shields.io/badge/django-4.0%20%7C%204.1%20%7C%204.2%20%7C%205.0%20%7C%205.1%20%7C%205.2-orange)
 
 
 ## Description
 
-TODO
+Finally there is a real searchkit application for django that integrates best
+with the django admin backend.
+
+Build and apply complex searches on model instances right in the backend without
+any coding. Save and reuse your searches by a handy django admin filter with a
+single click.
+
 
 ## Setup
 
@@ -73,10 +76,28 @@ INSTALLED_APPS = [
 ]
 ```
 
-## Getting started
+Add the `SearkitFilter` to your `ModelAdmin`:
+```
+from django.contrib import admin
+from searchkit.filters import SearchkitFilter
+from .models import MyModel
+
 
-TODO
+@admin.register(MyModel)
+class MyModelAdmin(admin.ModelAdmin):
+   ...
+    list_filter = [
+      SearchkitFilter,
+      ...
+      ]
+   ...
+```
 
 ## Usage
 
-TODO
+1. Open the admin changelist of your Model.
+2. Click the "Add filter" button of the Searchkit filter.
+3. Give your Filter a name.
+4. Configure as many filter rules as you want.
+5. Click "Save and apply".
+6. Reuse your filter whenever you want using the Searchkit filter section.

django_searchkit-1.1.dist-info/RECORD

@@ -0,0 +1,99 @@
+build/lib/build/lib/example/example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/build/lib/example/example/admin.py,sha256=eTZ5mCA1ToGouqYgIf-6xDl2nvYAz7T9lU1Bnu_gP9c,462
+build/lib/build/lib/example/example/asgi.py,sha256=mqLnzcCH9X-8UhDo5ZhcM8tF3jtALEGSjsBmphbkLcs,391
+build/lib/build/lib/example/example/models.py,sha256=fB9X782cX01Yg2uIiPCVgrS8C7DkgG9U-9mxGtX3P7Q,1097
+build/lib/build/lib/example/example/settings.py,sha256=du9bWbAceSvDkYeNYOc_3KxKL1p1se93TdAueT2RQ_E,3256
+build/lib/build/lib/example/example/urls.py,sha256=D8LxjiTdJSA87AVh3BzpVo5E2aC30hlp20HshPDrfvU,800
+build/lib/build/lib/example/example/wsgi.py,sha256=OAXHHeNQoj7FBDc5NMET39i_kIGpFrcdNDdY1thrh58,391
+build/lib/build/lib/example/example/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/build/lib/example/example/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/build/lib/example/example/management/commands/createtestdata.py,sha256=IVtyUqak133h9Ua-Ag_GP8mw3dUdiDYAa2tGmLkKluU,2737
+build/lib/build/lib/example/example/migrations/0001_initial.py,sha256=62tOi17oHGuqqLmSAYWLep6AMkxCJF6Tp13odghS7gI,2014
+build/lib/build/lib/example/example/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/build/lib/searchkit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/build/lib/searchkit/__version__.py,sha256=YHc4yqTXD8EGEgS4jTIrg3vbI45fTQWhAF19GPsIcZM,661
+build/lib/build/lib/searchkit/admin.py,sha256=URZgMKnfKlDqOgmQXJHu7mFGrjwkElpunAUbp2_9JcA,1182
+build/lib/build/lib/searchkit/apps.py,sha256=17m6wPu5N59Dq4MLoWaQd0aNHEzMT4z4emQD632GIMA,150
+build/lib/build/lib/searchkit/filters.py,sha256=z3L2bWIk-LRWwW_95JwZk14fjtOnsBqXI8LZx3foV-0,1135
+build/lib/build/lib/searchkit/models.py,sha256=G3kCU_bsLVzcToKgk1Gbh_8B3FCw3KofFubyddaxTUU,985
+build/lib/build/lib/searchkit/tests.py,sha256=p_YHEVNo9JbpwdIk_8Hz6yda2ei-ALTKRIK7IaKii6g,14946
+build/lib/build/lib/searchkit/urls.py,sha256=Mhrq4CUOhrh28ZhRocSP2AYnfWFW2c_eJyMR81q5fps,162
+build/lib/build/lib/searchkit/views.py,sha256=EvCJOsxackQAzk3-uc6V4cmgEqkS-f2ZVBVRmXoMukA,937
+build/lib/build/lib/searchkit/forms/__init__.py,sha256=FBggDa1owkYrceIU3cqNhqsMB49RJWZRAkA4OfvUMcM,207
+build/lib/build/lib/searchkit/forms/fields.py,sha256=TpFZdAyWKaMhOoZFTuy5ODNrW6RLy289Lk1fcMSGJ20,1621
+build/lib/build/lib/searchkit/forms/search.py,sha256=mca67piLDqKUhXzaKIOztk5Gg8V1XL21n27aIffH88A,2330
+build/lib/build/lib/searchkit/forms/searchkit.py,sha256=pg3vw6dMdtaHja-g1Yh72XJkLp7I48nXht9zxWbGW9Y,6022
+build/lib/build/lib/searchkit/forms/utils.py,sha256=m8vwB-3AoYuMx0QxlJTwSWbDHBG8MyCxFmsyK6xyai8,5221
+build/lib/build/lib/searchkit/migrations/0001_initial.py,sha256=cP886X1UMrDTf-KxfHfuoQ4b1T1lhdNJyVNOGMNyWNw,1093
+build/lib/build/lib/searchkit/migrations/0002_rename_searchkitsearch_search.py,sha256=RHXShizf689AdPb2Ca-hONWmwZbB2Fs5DQhXlEPE-f0,389
+build/lib/build/lib/searchkit/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/build/lib/searchkit/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/build/lib/searchkit/templatetags/searchkit.py,sha256=HpEGTGYi_enDh_bgTgWdVbZftNuZqRt4J9N5A0Nc1AM,581
+build/lib/example/example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/example/example/admin.py,sha256=eTZ5mCA1ToGouqYgIf-6xDl2nvYAz7T9lU1Bnu_gP9c,462
+build/lib/example/example/asgi.py,sha256=mqLnzcCH9X-8UhDo5ZhcM8tF3jtALEGSjsBmphbkLcs,391
+build/lib/example/example/models.py,sha256=fB9X782cX01Yg2uIiPCVgrS8C7DkgG9U-9mxGtX3P7Q,1097
+build/lib/example/example/settings.py,sha256=du9bWbAceSvDkYeNYOc_3KxKL1p1se93TdAueT2RQ_E,3256
+build/lib/example/example/urls.py,sha256=D8LxjiTdJSA87AVh3BzpVo5E2aC30hlp20HshPDrfvU,800
+build/lib/example/example/wsgi.py,sha256=OAXHHeNQoj7FBDc5NMET39i_kIGpFrcdNDdY1thrh58,391
+build/lib/example/example/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/example/example/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/example/example/management/commands/createtestdata.py,sha256=IVtyUqak133h9Ua-Ag_GP8mw3dUdiDYAa2tGmLkKluU,2737
+build/lib/example/example/migrations/0001_initial.py,sha256=62tOi17oHGuqqLmSAYWLep6AMkxCJF6Tp13odghS7gI,2014
+build/lib/example/example/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/searchkit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/searchkit/__version__.py,sha256=YHc4yqTXD8EGEgS4jTIrg3vbI45fTQWhAF19GPsIcZM,661
+build/lib/searchkit/admin.py,sha256=URZgMKnfKlDqOgmQXJHu7mFGrjwkElpunAUbp2_9JcA,1182
+build/lib/searchkit/apps.py,sha256=17m6wPu5N59Dq4MLoWaQd0aNHEzMT4z4emQD632GIMA,150
+build/lib/searchkit/filters.py,sha256=z3L2bWIk-LRWwW_95JwZk14fjtOnsBqXI8LZx3foV-0,1135
+build/lib/searchkit/models.py,sha256=G3kCU_bsLVzcToKgk1Gbh_8B3FCw3KofFubyddaxTUU,985
+build/lib/searchkit/tests.py,sha256=p_YHEVNo9JbpwdIk_8Hz6yda2ei-ALTKRIK7IaKii6g,14946
+build/lib/searchkit/urls.py,sha256=Mhrq4CUOhrh28ZhRocSP2AYnfWFW2c_eJyMR81q5fps,162
+build/lib/searchkit/views.py,sha256=EvCJOsxackQAzk3-uc6V4cmgEqkS-f2ZVBVRmXoMukA,937
+build/lib/searchkit/forms/__init__.py,sha256=FBggDa1owkYrceIU3cqNhqsMB49RJWZRAkA4OfvUMcM,207
+build/lib/searchkit/forms/fields.py,sha256=TpFZdAyWKaMhOoZFTuy5ODNrW6RLy289Lk1fcMSGJ20,1621
+build/lib/searchkit/forms/search.py,sha256=mca67piLDqKUhXzaKIOztk5Gg8V1XL21n27aIffH88A,2330
+build/lib/searchkit/forms/searchkit.py,sha256=pg3vw6dMdtaHja-g1Yh72XJkLp7I48nXht9zxWbGW9Y,6022
+build/lib/searchkit/forms/utils.py,sha256=m8vwB-3AoYuMx0QxlJTwSWbDHBG8MyCxFmsyK6xyai8,5221
+build/lib/searchkit/migrations/0001_initial.py,sha256=cP886X1UMrDTf-KxfHfuoQ4b1T1lhdNJyVNOGMNyWNw,1093
+build/lib/searchkit/migrations/0002_rename_searchkitsearch_search.py,sha256=RHXShizf689AdPb2Ca-hONWmwZbB2Fs5DQhXlEPE-f0,389
+build/lib/searchkit/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/searchkit/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+build/lib/searchkit/templatetags/searchkit.py,sha256=HpEGTGYi_enDh_bgTgWdVbZftNuZqRt4J9N5A0Nc1AM,581
+django_searchkit-1.1.dist-info/licenses/LICENCE,sha256=oqmlRYPA5GHG2T1yp8fPFGQdOO-NnJPdGITeFiJYWLg,1521
+example/example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+example/example/admin.py,sha256=KDjYyHPEqNdv7Xe8yx0VuWdx-bDn7qKKHM5ZYhFwdU0,445
+example/example/asgi.py,sha256=mqLnzcCH9X-8UhDo5ZhcM8tF3jtALEGSjsBmphbkLcs,391
+example/example/models.py,sha256=fB9X782cX01Yg2uIiPCVgrS8C7DkgG9U-9mxGtX3P7Q,1097
+example/example/settings.py,sha256=du9bWbAceSvDkYeNYOc_3KxKL1p1se93TdAueT2RQ_E,3256
+example/example/urls.py,sha256=D8LxjiTdJSA87AVh3BzpVo5E2aC30hlp20HshPDrfvU,800
+example/example/wsgi.py,sha256=OAXHHeNQoj7FBDc5NMET39i_kIGpFrcdNDdY1thrh58,391
+example/example/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+example/example/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+example/example/management/commands/createtestdata.py,sha256=IVtyUqak133h9Ua-Ag_GP8mw3dUdiDYAa2tGmLkKluU,2737
+example/example/migrations/0001_initial.py,sha256=62tOi17oHGuqqLmSAYWLep6AMkxCJF6Tp13odghS7gI,2014
+example/example/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+searchkit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+searchkit/__version__.py,sha256=YHc4yqTXD8EGEgS4jTIrg3vbI45fTQWhAF19GPsIcZM,661
+searchkit/admin.py,sha256=URZgMKnfKlDqOgmQXJHu7mFGrjwkElpunAUbp2_9JcA,1182
+searchkit/apps.py,sha256=17m6wPu5N59Dq4MLoWaQd0aNHEzMT4z4emQD632GIMA,150
+searchkit/filters.py,sha256=z3L2bWIk-LRWwW_95JwZk14fjtOnsBqXI8LZx3foV-0,1135
+searchkit/models.py,sha256=G3kCU_bsLVzcToKgk1Gbh_8B3FCw3KofFubyddaxTUU,985
+searchkit/tests.py,sha256=p_YHEVNo9JbpwdIk_8Hz6yda2ei-ALTKRIK7IaKii6g,14946
+searchkit/urls.py,sha256=Mhrq4CUOhrh28ZhRocSP2AYnfWFW2c_eJyMR81q5fps,162
+searchkit/views.py,sha256=EvCJOsxackQAzk3-uc6V4cmgEqkS-f2ZVBVRmXoMukA,937
+searchkit/forms/__init__.py,sha256=FBggDa1owkYrceIU3cqNhqsMB49RJWZRAkA4OfvUMcM,207
+searchkit/forms/fields.py,sha256=TpFZdAyWKaMhOoZFTuy5ODNrW6RLy289Lk1fcMSGJ20,1621
+searchkit/forms/search.py,sha256=mca67piLDqKUhXzaKIOztk5Gg8V1XL21n27aIffH88A,2330
+searchkit/forms/searchkit.py,sha256=pg3vw6dMdtaHja-g1Yh72XJkLp7I48nXht9zxWbGW9Y,6022
+searchkit/forms/utils.py,sha256=m8vwB-3AoYuMx0QxlJTwSWbDHBG8MyCxFmsyK6xyai8,5221
+searchkit/migrations/0001_initial.py,sha256=cP886X1UMrDTf-KxfHfuoQ4b1T1lhdNJyVNOGMNyWNw,1093
+searchkit/migrations/0002_rename_searchkitsearch_search.py,sha256=RHXShizf689AdPb2Ca-hONWmwZbB2Fs5DQhXlEPE-f0,389
+searchkit/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+searchkit/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+searchkit/templatetags/searchkit.py,sha256=HpEGTGYi_enDh_bgTgWdVbZftNuZqRt4J9N5A0Nc1AM,581
+django_searchkit-1.1.dist-info/METADATA,sha256=oFRweWx1Rxx8Nshj_rrsoGCbLkAk_JIGoBzFYjQT-ew,3325
+django_searchkit-1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+django_searchkit-1.1.dist-info/top_level.txt,sha256=-4gF42VIaG-ckn2rb2wFa7LhxIZymHBsYVedNOr_NIY,29
+django_searchkit-1.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+django_searchkit-1.1.dist-info/RECORD,,

{django_searchkit-0.1.dist-info → django_searchkit-1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{django_searchkit-0.1.dist-info → django_searchkit-1.1.dist-info}/top_level.txt

@@ -1,3 +1,4 @@
+build
 dist
 example
 searchkit

example/example/admin.py

@@ -7,7 +7,7 @@ from .models import ModelB
 @admin.register(ModelA)
 class ModelAAdmin(admin.ModelAdmin):
     list_display = [f.name for f in ModelA._meta.fields]
-    list_filter = [SearchkitFilter, 'chars_choices']
+    list_filter = [SearchkitFilter]
 
 
 @admin.register(ModelB)

searchkit/__version__.py

@@ -13,4 +13,4 @@ Version 0.x should be considered a development version with an unstable API,
 and backwards compatibility is not guaranteed for minor versions.
 """
 
-__version__ = "0.1"
+__version__ = "1.1"

searchkit/admin.py

@@ -1,14 +1,14 @@
 from django.contrib import admin
 from django.http import HttpResponseRedirect
 from django.urls import reverse
-from .models import SearchkitSearch
-from .forms import SearchkitSearchForm
+from .models import Search
+from .forms import SearchForm
 from .filters import SearchkitFilter
 
 
-@admin.register(SearchkitSearch)
+@admin.register(Search)
 class SearchkitSearchAdmin(admin.ModelAdmin):
-    form = SearchkitSearchForm
+    form = SearchForm
     list_display = ('name', 'contenttype', 'created_date')
 
     def get_url_for_applied_search(self, obj):

searchkit/filters.py

@@ -1,8 +1,6 @@
 from django.contrib.admin import SimpleListFilter
 from django.contrib.contenttypes.models import ContentType
-from .models import SearchkitSearch
-from .forms import SearchkitFormSet
-from .forms.utils import get_filter_rules
+from .models import Search
 
 
 class SearchkitFilter(SimpleListFilter):
@@ -11,21 +9,19 @@ class SearchkitFilter(SimpleListFilter):
     template = 'searchkit/searchkit_filter.html'
 
     def __init__(self, request, params, model, model_admin):
-        # We need the app_label and model_name for the reverse url lookup in the
-        # template.
-        self.app_label = model._meta.app_label
-        self.model_name = model._meta.model_name
+        # We need the app_label and model as get parameter for the new search
+        # link.
+        self.searchkit_model = ContentType.objects.get_for_model(model)
         super().__init__(request, params, model, model_admin)
 
     def lookups(self, request, model_admin):
         # Fetch the last three objects from SearchkitSearch and return them as
         # choices.
-        ct = ContentType.objects.get_for_model(model_admin.model)
-        searches = SearchkitSearch.objects.filter(contenttype=ct).order_by('-created_date')[:3]
+        searches = Search.objects.filter(contenttype=self.searchkit_model).order_by('-created_date')[:3]
         return [(str(obj.id), obj.name) for obj in searches]
 
     def queryset(self, request, queryset):
         # Filter the queryset based on the selected SearchkitSearch object
         if self.value():
-            search = SearchkitSearch.objects.get(id=int(self.value()))
-            return queryset.filter(**search.get_filter_rules())
+            search = Search.objects.get(id=int(self.value()))
+            return search.as_queryset()

searchkit/forms/__init__.py

@@ -1,2 +1,5 @@
-from .search import SearchkitSearchForm
-from .searchkit import SearchkitFormSet
+from .search import SearchForm
+from .searchkit import SearchkitModelForm
+from .searchkit import BaseSearchkitFormSet
+from .searchkit import BaseSearchkitForm
+from .searchkit import searchkit_formset_factory

searchkit/forms/search.py

@@ -1,25 +1,40 @@
 from django import forms
 from django.utils.functional import cached_property
-from ..models import SearchkitSearch
-from .searchkit import SearchkitFormSet
+from django.contrib.contenttypes.models import ContentType
+from ..models import Search
+from .searchkit import SearchkitModelForm
+from .searchkit import searchkit_formset_factory
+from .utils import MediaMixin
 
 
-class SearchkitSearchForm(forms.ModelForm):
+class SearchForm(MediaMixin, forms.ModelForm):
     """
     Represents a SearchkitSearch model. Using a SearchkitFormSet for the data
     json field.
     """
     class Meta:
-        model = SearchkitSearch
+        model = Search
         fields = ['name']
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
+    @cached_property
+    def searchkit_model(self):
+        if self.instance.pk:
+            return self.instance.contenttype.model_class()
+        elif self.searchkit_model_form.is_valid():
+            return self.searchkit_model_form.cleaned_data['searchkit_model'].model_class()
+        elif 'searchkit_model' in self.searchkit_model_form.initial:
+            value = self.searchkit_model_form.initial['searchkit_model']
+            try:
+                return self.searchkit_model_form.fields['searchkit_model'].clean(value).model_class()
+            except forms.ValidationError:
+                return None
 
-    @property
-    def media(self):
-        # TODO: Check if child classes inherit those media files.
-        return self.formset.media
+    @cached_property
+    def searchkit_model_form(self):
+        kwargs = dict(data=self.data or None, initial=self.initial or None)
+        if self.instance.pk:
+            kwargs['initial'] = dict(searchkit_model=self.instance.contenttype)
+        return SearchkitModelForm(**kwargs)
 
     @cached_property
     def formset(self):
@@ -27,19 +42,21 @@ class SearchkitSearchForm(forms.ModelForm):
         A searchkit formset for the model.
         """
         kwargs = dict()
-        kwargs['data'] = self.data or None
-        kwargs['prefix'] = self.prefix
-        if self.instance.pk:
-            kwargs['model'] = self.instance.contenttype.model_class()
-            kwargs['initial'] = self.instance.data
-        return SearchkitFormSet(**kwargs)
+        if self.searchkit_model and self.data:
+            kwargs = dict(data=self.data)
+        elif self.searchkit_model and self.instance.pk:
+            kwargs = dict(initial=self.instance.data)
+
+        extra = 0 if self.instance.pk else 1
+        formset = searchkit_formset_factory(model=self.searchkit_model, extra=extra)
+        return formset(**kwargs)
 
     def is_valid(self):
-        return self.formset.is_valid() and super().is_valid()
+        return self.formset.is_valid() and self.searchkit_model_form.is_valid and super().is_valid()
 
     def clean(self):
-        if self.formset.contenttype_form.is_valid():
-            self.instance.contenttype = self.formset.contenttype_form.cleaned_data['contenttype']
+        if self.searchkit_model_form.is_valid():
+            self.instance.contenttype = self.searchkit_model_form.cleaned_data['searchkit_model']
         if self.formset.is_valid():
             self.instance.data = self.formset.cleaned_data
         return super().clean()

searchkit/forms/searchkit.py

@@ -1,17 +1,29 @@
-from collections import OrderedDict
 from django import forms
 from django.utils.translation import gettext_lazy as _
 from django.utils.functional import cached_property
-from django.contrib.contenttypes.models import ContentType
-from .utils import CSS_CLASSES, FIELD_PLAN, OPERATOR_DESCRIPTION
-from .utils import SUPPORTED_FIELDS, SUPPORTED_RELATIONS
+from .utils import CssClassMixin, FIELD_PLAN, OPERATOR_DESCRIPTION
+from .utils import SUPPORTED_FIELDS
+from .utils import ModelTree
+from .utils import MediaMixin
+from .utils import get_searchable_models
 
 
-# FIXME: Make this a setting
-RELATION_DEPTH = 3
+class SearchkitModelForm(forms.Form):
+    """
+    Form to select a content type.
+    """
+    searchkit_model = forms.ModelChoiceField(
+        queryset=get_searchable_models(),
+        label=_('Model'),
+        empty_label=_('Select a Model'),
+        widget=forms.Select(attrs={
+            "class": CssClassMixin.reload_on_change_css_class,
+            "data-total-forms": 1,
+        }),
+    )
 
 
-class SearchkitForm(CSS_CLASSES, forms.Form):
+class BaseSearchkitForm(MediaMixin, CssClassMixin, forms.Form):
     """
     Searchkit form representing a model field lookup based on the field name,
     the operator and one or two values.
@@ -24,9 +36,11 @@ class SearchkitForm(CSS_CLASSES, forms.Form):
 
     See the FIELD_PLAN variable for the logic of building the form.
     """
-    def __init__(self, model, *args, **kwargs):
+    model = None  # Set by the formset factory.
+
+    def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.model = model
+        self.model_tree = ModelTree(self.model)
         self.model_field = None
         self.field_plan = None
         self.operator = None
@@ -56,7 +70,7 @@ class SearchkitForm(CSS_CLASSES, forms.Form):
                 # Do we have a valid value?
                 return self.fields[field_name].clean(self.unprefixed_data[field_name])
             except forms.ValidationError:
-                pass
+                return self.fields[field_name].choices[0][0]
         else:
             # At last simply return the first option which will be the selected
             # one.
@@ -64,40 +78,44 @@ class SearchkitForm(CSS_CLASSES, forms.Form):
 
     def _get_model_field(self, lookup):
         path = lookup.split('__')
-        model = self.model
-        for index, field_name in enumerate(path, 1):
-            field = model._meta.get_field(field_name)
-            if index < len(path):
-                model = field.remote_field.model
-        return field
-
-    def _get_model_field_choices(self, model, fields=[]):
+        field_name = path[-1]
+        if path[:-1]:
+            model = self.model_tree.get('__'.join(path[:-1])).model
+        else:
+            model = self.model
+        return model._meta.get_field(field_name)
+
+    def _get_model_field_choices(self):
         choices = list()
-        for model_field in model._meta.fields:
-            if any(isinstance(model_field, f) for f in SUPPORTED_FIELDS):
-                lookup = '__'.join([f.name for f in [*fields, model_field]])
-                label = ' -> '.join(f.verbose_name for f in [*fields, model_field])
+        label_path = list()
+        for node in self.model_tree.iterate():
+            label_path.append
+            for model_field in node.model._meta.fields:
+                if not any(isinstance(model_field, f) for f in SUPPORTED_FIELDS):
+                    continue
+                if node.is_root:
+                    lookup = model_field.name
+                    label = f'`{model_field.verbose_name}`'
+                else:
+                    lookup = f'{node.field_path}__{model_field.name}'
+                    get_field_name = lambda f: getattr(f, 'verbose_name', f.name)
+                    label_path = [f'`{get_field_name(n.field)}` => <{n.model._meta.verbose_name}>' for n in node.path[1:]]
+                    label = ".".join(label_path + [f'`{model_field.verbose_name}`'])
                 choices.append((lookup, label))
-        if len(fields) < RELATION_DEPTH:
-            for model_field in model._meta.fields:
-                if any(isinstance(model_field, f) for f in SUPPORTED_RELATIONS):
-                    related_model = model_field.remote_field.model
-                    fields = [*fields, model_field]
-                    choices += self._get_model_field_choices(related_model, fields)
         return choices
 
     def _add_field_name_field(self):
         initial = self.initial.get('field')
-        choices = self._get_model_field_choices(self.model)
+        choices = self._get_model_field_choices()
         field = forms.ChoiceField(label=_('Model field'), choices=choices, initial=initial)
-        field.widget.attrs.update({"class": CSS_CLASSES.reload_on_change_css_class})
+        field.widget.attrs.update({"class": self.reload_on_change_css_class})
         self.fields['field'] = field
 
     def _add_operator_field(self):
         initial = self.initial.get('operator')
         choices = [(o, OPERATOR_DESCRIPTION[o]) for o in self.field_plan.keys()]
         field = forms.ChoiceField(label=_('Operator'), choices=choices, initial=initial)
-        field.widget.attrs.update({"class": CSS_CLASSES.reload_on_change_css_class})
+        field.widget.attrs.update({"class": self.reload_on_change_css_class})
         self.fields['operator'] = field
 
     def _add_value_field(self):
@@ -110,83 +128,27 @@ class SearchkitForm(CSS_CLASSES, forms.Form):
         self.fields['value'] = field
 
 
-class ContentTypeForm(CSS_CLASSES, forms.Form):
-    """
-    Form to select a content type.
-    """
-    contenttype = forms.ModelChoiceField(
-        queryset=ContentType.objects.all(),
-        label=_('Model'),
-        empty_label=_('Select a Model'),
-        widget=forms.Select(attrs={"class": CSS_CLASSES.reload_on_change_css_class}),
-    )
-
-    class Media:
-        js = [
-            'admin/js/vendor/jquery/jquery.min.js',
-            'admin/js/jquery.init.js',
-            "searchkit/searchkit.js"
-        ]
-
-
-class BaseSearchkitFormset(CSS_CLASSES, forms.BaseFormSet):
+class BaseSearchkitFormSet(CssClassMixin, forms.BaseFormSet):
     """
     Formset holding all searchkit forms.
     """
     template_name = "searchkit/searchkit.html"
     template_name_div = "searchkit/searchkit.html"
-    default_prefix = 'searchkit'
-    form = SearchkitForm
-    contenttype_form_class = ContentTypeForm
-
-    def __init__(self, *args, **kwargs):
-        self.contenttype_form = self.get_conttenttype_form(kwargs)
-        self.model = self.get_model(kwargs)
-        super().__init__(*args, **kwargs)
-        if self.initial:
-            self.extra = 0
-
-    def get_conttenttype_form(self, kwargs):
-        ct_kwargs = dict()
-        ct_kwargs['data'] = kwargs.get('data')
-        ct_kwargs['prefix'] = kwargs.get('prefix')
-        if model := kwargs.pop('model', None):
-            ct_kwargs['initial'] = dict(contenttype=ContentType.objects.get_for_model(model))
-        return self.contenttype_form_class(**ct_kwargs)
-
-    def get_model(self, kwargs):
-        if self.contenttype_form.initial:
-            return self.contenttype_form.initial['contenttype'].model_class()
-        elif self.contenttype_form.is_valid():
-            return self.contenttype_form.cleaned_data['contenttype'].model_class()
-
-    def get_form_kwargs(self, index):
-        kwargs = self.form_kwargs.copy()
-        kwargs['model'] = self.model
-        return kwargs
+    model = None  # Set by the formset factory.
 
     def add_prefix(self, index):
-        if self.model:
-            return "%s-%s-%s" % (self.prefix, self.model._meta.model_name, index)
+        return "%s-%s-%s-%s" % (self.prefix, self.model._meta.app_label, self.model._meta.model_name, index)
 
     @classmethod
-    def get_default_prefix(cls):
-        return cls.default_prefix
-
-    @cached_property
-    def forms(self):
-        # We won't render any forms if we got no model.
-        return super().forms if self.model else []
-
-    @property
-    def media(self):
-        return self.contenttype_form.media
-
-    def is_valid(self):
-        return self.contenttype_form.is_valid() and self.forms and super().is_valid()
+    def get_default_prefix(self):
+        return "searchkit"
 
 
-SearchkitFormSet = forms.formset_factory(
-        form=SearchkitForm,
-        formset=BaseSearchkitFormset,
+def searchkit_formset_factory(model, **kwargs):
+    form = type('SearchkitForm', (BaseSearchkitForm,), dict(model=model))
+    formset = type('SearchkitFormSet', (BaseSearchkitFormSet,), dict(model=model))
+    return forms.formset_factory(
+        form=form,
+        formset=formset,
+        **kwargs
     )