├── .github
    ├── CODEOWNERS
    ├── PULL_REQUEST_TEMPLATE.md
    ├── release-drafter.yml
    └── workflows
    │   ├── ci.yml
    │   ├── publish.yml
    │   └── release-drafter.yml
├── .gitignore
├── AUTHORS
├── INSTALL
├── LICENSE
├── MANIFEST.in
├── README.rst
├── demoproject
    ├── __init__.py
    ├── compat.py
    ├── filter
    │   ├── __init__.py
    │   ├── fixtures
    │   │   └── test_data.json
    │   ├── forms.py
    │   ├── models.py
    │   ├── static
    │   │   ├── css
    │   │   │   └── bootstrap-switch.css
    │   │   └── js
    │   │   │   └── bootstrap-switch.min.js
    │   ├── templates
    │   │   └── user
    │   │   │   └── user_list.html
    │   ├── tests.py
    │   ├── urls.py
    │   └── views.py
    ├── manage.py
    ├── settings.py
    ├── templates
    │   └── home.html
    ├── tests.py
    ├── urls.py
    └── wsgi.py
├── django_genericfilters
    ├── __init__.py
    ├── fields.py
    ├── forms.py
    ├── models.py
    ├── static
    │   ├── css
    │   │   ├── filters_list.css
    │   │   └── genericfilters.css
    │   └── js
    │   │   └── genericfilters.js
    ├── templates
    │   ├── genericfilters
    │   │   ├── filter_list.html
    │   │   ├── order_by_list.html
    │   │   └── query_filter.html
    │   └── snippets
    │   │   └── pagination.html
    ├── templatetags
    │   ├── __init__.py
    │   ├── paginator.py
    │   ├── updateurl.py
    │   └── utils.py
    ├── tests
    │   ├── __init__.py
    │   ├── test_fields.py
    │   ├── test_forms.py
    │   ├── test_templatetags.py
    │   └── test_views.py
    └── views.py
├── docker-compose.yml
├── docs
    ├── Makefile
    ├── about
    │   ├── authors.txt
    │   ├── changelog.txt
    │   ├── index.txt
    │   └── license.txt
    ├── api
    │   ├── filtered_form.txt
    │   ├── filtered_list_view.txt
    │   └── index.txt
    ├── conf.py
    ├── dev.txt
    ├── index.txt
    └── install.txt
├── pyproject.toml
├── requirements.txt
├── setup.cfg
├── setup.py
└── tox.ini


/.github/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @peopledoc/python-community
2 | 


--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | Closes #<ticket number>
2 | 
3 | <!-- Please do not remove this, even if you think you don't need it -->
4 | ### Successful PR Checklist:
5 | - [ ] Tests
6 |   - [ ] (not applicable?)
7 | 


--------------------------------------------------------------------------------
/.github/release-drafter.yml:
--------------------------------------------------------------------------------
1 | template: |
2 |   $CHANGES
3 | 
4 |   ## Kudos:
5 | 
6 |   $CONTRIBUTORS
7 | 


--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
  1 | name: CI
  2 | 
  3 | on:
  4 |   pull_request:
  5 |   push:
  6 |     branches:
  7 |       - 'master'
  8 |     tags:
  9 |       - '*'
 10 | 
 11 | jobs:
 12 |   build:
 13 | 
 14 |     # When testing new Python or Django versions, one should use the
 15 |     # filterwarnings definition of setup.cfg to turn deprecation warnings
 16 |     # into errors.
 17 |     strategy:
 18 |       matrix:
 19 |         include:
 20 | 
 21 |           - name: Python 3.7 / Django 3.2
 22 |             python_version: "3.7"
 23 |             tox_env: py37-django32
 24 | 
 25 |           - name: Python 3.8 / Django 3.2
 26 |             python_version: "3.8"
 27 |             tox_env: py38-django32
 28 | 
 29 |           - name: Python 3.9 / Django 2.2
 30 |             python_version: "3.9"
 31 |             tox_env: py39-django22
 32 | 
 33 |           - name: Python 3.9 / Django 3.0
 34 |             python_version: "3.9"
 35 |             tox_env: py39-django30
 36 | 
 37 |           - name: Python 3.9 / Django 3.1
 38 |             python_version: "3.9"
 39 |             tox_env: py39-django31
 40 | 
 41 |           - name: Python 3.9 / Django 3.2
 42 |             python_version: "3.9"
 43 |             tox_env: py39-django32
 44 | 
 45 |           - name: Python 3.9 / Django 4.0
 46 |             python_version: "3.9"
 47 |             tox_env: py39-django40
 48 | 
 49 |           - name: Python 3.10 / Django 3.2
 50 |             python_version: "3.10"
 51 |             tox_env: py310-django32
 52 | 
 53 |           - name: Lint
 54 |             python_version: "3.10"
 55 |             tox_env: lint
 56 | 
 57 | 
 58 |     name: "${{ matrix.name }}"
 59 |     runs-on: ubuntu-latest
 60 | 
 61 |     services:
 62 |       postgres:
 63 |         image: postgres
 64 |         # Set health checks to wait until postgres has started
 65 |         env:
 66 |           POSTGRES_PASSWORD: postgres
 67 |         options: >-
 68 |           --health-cmd pg_isready
 69 |           --health-interval 10s
 70 |           --health-timeout 5s
 71 |         ports:
 72 |           - 5432:5432
 73 | 
 74 |     steps:
 75 |       - uses: actions/checkout@v2
 76 | 
 77 |       - name: Set up Python
 78 |         id: setup-python
 79 |         uses: actions/setup-python@v2
 80 |         with:
 81 |           python-version: ${{ matrix.python_version }}
 82 | 
 83 |       - name: Pip cache
 84 |         uses: actions/cache@v2
 85 |         with:
 86 |           path: |
 87 |             ~/.cache/
 88 |           key: ${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('setup.py') }}
 89 | 
 90 |       - name: Install Tox
 91 |         run: pip install tox
 92 | 
 93 |       - name: Run ${{ matrix.name }}
 94 |         run: tox -e ${{ matrix.tox_env }}
 95 |         env:
 96 |           PGHOST: localhost
 97 |           PGUSER: postgres
 98 |           PGPASSWORD: postgres
 99 | 
100 |   report-status:
101 |     name: success
102 |     runs-on: ubuntu-latest
103 |     needs: build
104 |     steps:
105 | 
106 |       - name: Report success
107 |         run: echo 'Success !'
108 | 


--------------------------------------------------------------------------------
/.github/workflows/publish.yml:
--------------------------------------------------------------------------------
 1 | name: Deploy
 2 | 
 3 | on:
 4 |   push:
 5 |     tags:
 6 |       - '*'
 7 | 
 8 | jobs:
 9 |   deploy:
10 |     name: Publish package to PyPI
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - uses: actions/checkout@v2
14 | 
15 |       - name: Set up Python
16 |         id: setup-python
17 |         uses: actions/setup-python@v2
18 |         with:
19 |           python-version: ${{ matrix.python_version }}
20 | 
21 |       - name: Install
22 |         run: pip install build
23 | 
24 |       - name: Wait for tests to succeed
25 |         uses: fountainhead/action-wait-for-check@v1.0.0
26 |         id: wait-for-ci
27 |         with:
28 |           token: ${{ secrets.GITHUB_TOKEN }}
29 |           checkName: success
30 | 
31 |       - name: Exit if CI did not succeed
32 |         if: steps.wait-for-ci.outputs.conclusion != 'success'
33 |         run: exit 1
34 | 
35 |       - name: Build package
36 |         run: python -m build
37 | 
38 |       - name: Publish a Python distribution to PyPI
39 |         uses: pypa/gh-action-pypi-publish@release/v1
40 |         with:
41 |           user: __token__
42 |           password: "${{ secrets.PYPI_TOKEN }}"
43 | 


--------------------------------------------------------------------------------
/.github/workflows/release-drafter.yml:
--------------------------------------------------------------------------------
 1 | name: Release Drafter
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - master
 7 | 
 8 | jobs:
 9 |   update_release_draft:
10 |     runs-on: ubuntu-latest
11 |     steps:
12 |       # Drafts the next Release notes as Pull Requests are merged into "master"
13 |       - uses: release-drafter/release-drafter@v5
14 |         env:
15 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
16 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | __pycache__
 2 | .coverage
 3 | .DS_Store
 4 | .mypy_cache
 5 | .pytest_cache
 6 | .tox
 7 | .venv
 8 | *.egg-info
 9 | *.pyc
10 | build
11 | dist
12 | docs/_build
13 | htmlcov
14 | 


--------------------------------------------------------------------------------
/AUTHORS:
--------------------------------------------------------------------------------
 1 | ######################
 2 | Authors & contributors
 3 | ######################
 4 | 
 5 | Maintainer: Rémy Hubscher <remy.hubscher@novapost.fr>
 6 | 
 7 | Original code by `Novapost <http://www.novapost.fr>`_ team:
 8 | 
 9 | * Benoît Bryon <benoit@marmelune.net>
10 | * Rémy Hubscher <remy.hubscher@novapost.fr>
11 | * Natal Ngétal <natal.ngetal@novapost.fr>
12 | * Yohann Gabory <yohann.gabory@novapost.fr>


--------------------------------------------------------------------------------
/INSTALL:
--------------------------------------------------------------------------------
 1 | ############
 2 | Installation
 3 | ############
 4 | 
 5 | This project is open-source, published under BSD license.
 6 | See :doc:`/about/license` for details.
 7 | 
 8 | If you want to install a development environment, you should go to :doc:`/dev`
 9 | documentation.
10 | 
11 | Install the package with your favorite Python installer. As an example, with
12 | pip:
13 | 
14 | .. code-block:: sh
15 | 
16 |    pip install django-generic-filters
17 | 
18 | Don't forget to register your application in your Django
19 | ``INSTALLED_APPS`` setting.
20 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | #######
 2 | License
 3 | #######
 4 | 
 5 | Copyright (c) 2013, Novapost SAS.
 6 | All rights reserved.
 7 | 
 8 | Redistribution and use in source and binary forms, with or without
 9 | modification, are permitted provided that the following conditions are met:
10 | 
11 | * Redistributions of source code must retain the above copyright notice, this
12 |   list of conditions and the following disclaimer.
13 | 
14 | * Redistributions in binary form must reproduce the above copyright notice,
15 |   this list of conditions and the following disclaimer in the documentation
16 |   and/or other materials provided with the distribution.
17 | 
18 | * Neither the name of django-generic-filters nor the names of its contributors
19 |   may be used to endorse or promote products derived from this software without
20 |   specific prior written permission.
21 | 
22 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
23 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 | 


--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | recursive-include django_genericfilters *
2 | global-exclude *.pyc .*.swp *~
3 | include *.txt
4 | include AUTHORS CHANGELOG INSTALL LICENSE README.rst VERSION
5 | 


--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
  1 | ######################
  2 | django-generic-filters
  3 | ######################
  4 | 
  5 | `django-generic-filters` is a toolkit to filter results of Django's
  6 | ``ListView``, using forms.
  7 | 
  8 | Main use cases are obviously search forms and filtered lists.
  9 | 
 10 | As a developer, given you have a ``ListView``, in order to let the user
 11 | filter the results:
 12 | 
 13 | * use a form to easily render the filters as HTML;
 14 | * the user typically sends the filters via GET;
 15 | * validate the user's input using a Django form;
 16 | * filter the Django view's queryset using form's cleaned data.
 17 | 
 18 | .. image:: https://secure.travis-ci.org/peopledoc/django-generic-filters.png?branch=master
 19 |    :alt: Build Status
 20 |    :target: https://secure.travis-ci.org/peopledoc/django-generic-filters
 21 | 
 22 | 
 23 | *******
 24 | Example
 25 | *******
 26 | 
 27 | **views.py**
 28 | 
 29 | .. code-block:: python
 30 | 
 31 |     from django_genericfilters.views import FilteredListView
 32 | 
 33 | 
 34 |     class UserListView(FilteredListView):
 35 |         # ListView options. FilteredListView inherits from ListView.
 36 |         model = User
 37 |         template_name = 'user/user_list.html'
 38 |         paginate_by = 10
 39 |         context_object_name = 'users'
 40 | 
 41 |         # FormMixin options. FilteredListView inherits from FormMixin.
 42 |         form_class = UserListForm
 43 | 
 44 |         # FilteredListView options.
 45 |         search_fields = ['first_name', 'last_name', 'username', 'email']
 46 |         filter_fields = ['is_active', 'is_staff', 'is_superuser']
 47 |         default_order = 'last_name'
 48 | 
 49 |         def form_valid(self, form):
 50 |             """Return the queryset when form has been submitted."""
 51 |             queryset = super(UserListView, self).form_valid(form)
 52 | 
 53 |             # Handle specific fields of the custom ListForm
 54 |             # Others are automatically handled by FilteredListView.
 55 | 
 56 |             if form.cleaned_data['is_active'] == 'yes':
 57 |                 queryset = queryset.filter(is_active=True)
 58 |             elif form.cleaned_data['is_active'] == 'no':
 59 |                 queryset = queryset.filter(is_active=False)
 60 | 
 61 |             if form.cleaned_data['is_staff'] == 'yes':
 62 |                 queryset = queryset.filter(is_staff=True)
 63 |             elif form.cleaned_data['is_staff'] == 'no':
 64 |                 queryset = queryset.filter(is_staff=False)
 65 | 
 66 |             if form.cleaned_data['is_superuser'] == 'yes':
 67 |                 queryset = queryset.filter(is_superuser=True)
 68 |             elif form.cleaned_data['is_superuser'] == 'no':
 69 |                 queryset = queryset.filter(is_superuser=False)
 70 | 
 71 |             return queryset
 72 | 
 73 | 
 74 | **forms.py**
 75 | 
 76 | .. code-block:: python
 77 | 
 78 |     from django import forms
 79 |     from django.utils.translation import gettext_lazy as _
 80 |     from django_genericfilters import forms as gf
 81 | 
 82 | 
 83 |     class UserListForm(gf.QueryFormMixin, gf.OrderFormMixin, gf.FilteredForm):
 84 |         is_active = gf.ChoiceField(label=_('Status'),
 85 |                                    choices=(('yes', _('Active')),
 86 |                                             ('no', _('Unactive'))))
 87 | 
 88 |         is_staff = gf.ChoiceField(label=_('Staff'))
 89 | 
 90 |         is_superuser = gf.ChoiceField(label=_('Superuser'))
 91 | 
 92 |         def get_order_by_choices(self):
 93 |             return [('date_joined', _(u'date joined')),
 94 |                     ('last_login', _(u'last login')),
 95 |                     ('last_name', _(u'Name'))]
 96 | 
 97 | 
 98 | *****
 99 | Forms
100 | *****
101 | 
102 | Several form mixins are provided to cover frequent use cases:
103 | 
104 | * ``OrderFormMixin`` with order_by and order_reverse fields.
105 | * ``QueryFormMixin`` for little full-text search using icontains.
106 | 
107 | See "mixin" documentation for details.
108 | 
109 | **********
110 | Ressources
111 | **********
112 | 
113 | * Documentation: https://django-generic-filters.readthedocs.io
114 | * PyPI page: http://pypi.python.org/pypi/django-generic-filters
115 | * Code repository: https://github.com/peopledoc/django-generic-filters
116 | * Bugtracker: https://github.com/peopledoc/django-generic-filters/issues
117 | 


--------------------------------------------------------------------------------
/demoproject/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/peopledoc/django-generic-filters/11b07972174a250b6867c6ae56c45ad5c31693fc/demoproject/__init__.py


--------------------------------------------------------------------------------
/demoproject/compat.py:
--------------------------------------------------------------------------------
1 | try:
2 |     from django.urls import reverse  # noqa
3 | except ImportError:
4 |     from django.core.urlresolvers import reverse  # noqa
5 | 


--------------------------------------------------------------------------------
/demoproject/filter/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/peopledoc/django-generic-filters/11b07972174a250b6867c6ae56c45ad5c31693fc/demoproject/filter/__init__.py


--------------------------------------------------------------------------------
/demoproject/filter/fixtures/test_data.json:
--------------------------------------------------------------------------------
1 | [{"pk": 1, "model": "auth.user", "fields": {"username": "admin", "first_name": "Antoine", "last_name": "SMITH", "is_active": true, "is_superuser": true, "is_staff": true, "last_login": "2013-09-02T07:31:50.863", "groups": [], "user_permissions": [], "password": "pbkdf2_sha256$10000$yYbejhAvkPpm$7ujg/lmvFoNrMmOnX86uM7f80VejlnIDwcRZzxTOYkI=", "email": "antoine.smith@example.com", "date_joined": "2013-09-02T07:31:50.863"}}, {"pk": 3, "model": "auth.user", "fields": {"username": "johndoe", "first_name": "John", "last_name": "DOE", "is_active": true, "is_superuser": false, "is_staff": false, "last_login": "2013-09-02T08:23:41.894", "groups": [], "user_permissions": [], "password": "", "email": "john.doe@tutu.com", "date_joined": "2013-09-02T08:23:41.894"}}, {"pk": 4, "model": "auth.user", "fields": {"username": "phildupont", "first_name": "Phil", "last_name": "DUPONT", "is_active": false, "is_superuser": false, "is_staff": false, "last_login": "2013-09-02T08:25:35.673", "groups": [], "user_permissions": [], "password": "", "email": "phil.dupont@tutu.com", "date_joined": "2013-09-02T08:25:35.673"}}, {"pk": 5, "model": "auth.user", "fields": {"username": "chucknorris", "first_name": "Chuck", "last_name": "NORRIS", "is_active": true, "is_superuser": false, "is_staff": true, "last_login": "2013-09-02T08:26:27.551", "groups": [], "user_permissions": [], "password": "", "email": "chuck.norris@tutu.com", "date_joined": "2013-09-02T08:26:27.551"}}]
2 | 


--------------------------------------------------------------------------------
/demoproject/filter/forms.py:
--------------------------------------------------------------------------------
 1 | from django.utils.translation import gettext_lazy as _
 2 | 
 3 | from django_genericfilters import forms as gf
 4 | 
 5 | 
 6 | class UserListForm(gf.FilteredForm):
 7 |     is_active = gf.ChoiceField(
 8 |         label=_("Status"), choices=(("yes", _("Active")), ("no", _("Unactive")))
 9 |     )
10 | 
11 |     is_staff = gf.ChoiceField(label=_("Staff"))
12 | 
13 |     is_superuser = gf.ChoiceField(label=_("Superuser"))
14 | 
15 |     def get_order_by_choices(self):
16 |         return [
17 |             ("date_joined", _("date joined")),
18 |             ("last_login", _("last login")),
19 |             ("last_name", _("Name")),
20 |         ]
21 | 


--------------------------------------------------------------------------------
/demoproject/filter/models.py:
--------------------------------------------------------------------------------
1 | # Create your models here.
2 | 


--------------------------------------------------------------------------------
/demoproject/filter/static/css/bootstrap-switch.css:
--------------------------------------------------------------------------------
  1 | /* ============================================================
  2 |  * bootstrapSwitch v1.8 by Larentis Mattia @SpiritualGuru
  3 |  * http://www.larentis.eu/
  4 |  *
  5 |  * Enhanced for radiobuttons by Stein, Peter @BdMdesigN
  6 |  * http://www.bdmdesign.org/
  7 |  *
  8 |  * Project site:
  9 |  * http://www.larentis.eu/switch/
 10 |  * ============================================================
 11 |  * Licensed under the Apache License, Version 2.0
 12 |  * http://www.apache.org/licenses/LICENSE-2.0
 13 |  * ============================================================ */
 14 | .has-switch {
 15 |   display: inline-block;
 16 |   cursor: pointer;
 17 |   -webkit-border-radius: 5px;
 18 |   -moz-border-radius: 5px;
 19 |   border-radius: 5px;
 20 |   border: 1px solid;
 21 |   border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
 22 |   position: relative;
 23 |   text-align: left;
 24 |   overflow: hidden;
 25 |   line-height: 8px;
 26 |   -webkit-user-select: none;
 27 |   -moz-user-select: none;
 28 |   -ms-user-select: none;
 29 |   -o-user-select: none;
 30 |   user-select: none;
 31 |   vertical-align: middle;
 32 |   min-width: 100px;
 33 | }
 34 | .has-switch.switch-mini {
 35 |   min-width: 72px;
 36 | }
 37 | .has-switch.switch-mini i.switch-mini-icons {
 38 |   height: 1.20em;
 39 |   line-height: 9px;
 40 |   vertical-align: text-top;
 41 |   text-align: center;
 42 |   transform: scale(0.6);
 43 |   margin-top: -1px;
 44 |   margin-bottom: -1px;
 45 | }
 46 | .has-switch.switch-small {
 47 |   min-width: 80px;
 48 | }
 49 | .has-switch.switch-large {
 50 |   min-width: 120px;
 51 | }
 52 | .has-switch.deactivate {
 53 |   opacity: 0.5;
 54 |   filter: alpha(opacity=50);
 55 |   cursor: default !important;
 56 | }
 57 | .has-switch.deactivate label,
 58 | .has-switch.deactivate span {
 59 |   cursor: default !important;
 60 | }
 61 | .has-switch > div {
 62 |   display: inline-block;
 63 |   width: 150%;
 64 |   position: relative;
 65 |   top: 0;
 66 | }
 67 | .has-switch > div.switch-animate {
 68 |   -webkit-transition: left 0.5s;
 69 |   -moz-transition: left 0.5s;
 70 |   -o-transition: left 0.5s;
 71 |   transition: left 0.5s;
 72 | }
 73 | .has-switch > div.switch-off {
 74 |   left: -50%;
 75 | }
 76 | .has-switch > div.switch-on {
 77 |   left: 0%;
 78 | }
 79 | .has-switch input[type=radio],
 80 | .has-switch input[type=checkbox] {
 81 |   display: none;
 82 | }
 83 | .has-switch span,
 84 | .has-switch label {
 85 |   -webkit-box-sizing: border-box;
 86 |   -moz-box-sizing: border-box;
 87 |   box-sizing: border-box;
 88 |   cursor: pointer;
 89 |   position: relative;
 90 |   display: inline-block;
 91 |   height: 100%;
 92 |   padding-bottom: 4px;
 93 |   padding-top: 4px;
 94 |   font-size: 14px;
 95 |   line-height: 20px;
 96 | }
 97 | .has-switch span.switch-mini,
 98 | .has-switch label.switch-mini {
 99 |   padding-bottom: 4px;
100 |   padding-top: 4px;
101 |   font-size: 10px;
102 |   line-height: 9px;
103 | }
104 | .has-switch span.switch-small,
105 | .has-switch label.switch-small {
106 |   padding-bottom: 3px;
107 |   padding-top: 3px;
108 |   font-size: 12px;
109 |   line-height: 18px;
110 | }
111 | .has-switch span.switch-large,
112 | .has-switch label.switch-large {
113 |   padding-bottom: 9px;
114 |   padding-top: 9px;
115 |   font-size: 16px;
116 |   line-height: normal;
117 | }
118 | .has-switch label {
119 |   text-align: center;
120 |   margin-top: -1px;
121 |   margin-bottom: -1px;
122 |   z-index: 100;
123 |   width: 34%;
124 |   border-left: 1px solid #cccccc;
125 |   border-right: 1px solid #cccccc;
126 |   color: #333333;
127 |   text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
128 |   background-color: #f5f5f5;
129 |   background-image: -moz-linear-gradient(top, #ffffff, #e6e6e6);
130 |   background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#ffffff), to(#e6e6e6));
131 |   background-image: -webkit-linear-gradient(top, #ffffff, #e6e6e6);
132 |   background-image: -o-linear-gradient(top, #ffffff, #e6e6e6);
133 |   background-image: linear-gradient(to bottom, #ffffff, #e6e6e6);
134 |   background-repeat: repeat-x;
135 |   filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffffffff', endColorstr='#ffe6e6e6', GradientType=0);
136 |   border-color: #e6e6e6 #e6e6e6 #bfbfbf;
137 |   border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
138 |   *background-color: #e6e6e6;
139 |   /* Darken IE7 buttons by default so they stand out more given they won't have borders */
140 | 
141 |   filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);
142 | }
143 | .has-switch label:hover,
144 | .has-switch label:focus,
145 | .has-switch label:active,
146 | .has-switch label.active,
147 | .has-switch label.disabled,
148 | .has-switch label[disabled] {
149 |   color: #333333;
150 |   background-color: #e6e6e6;
151 |   *background-color: #d9d9d9;
152 | }
153 | .has-switch label:active,
154 | .has-switch label.active {
155 |   background-color: #cccccc \9;
156 | }
157 | .has-switch label i {
158 |   color: #000;
159 |   text-shadow: 0 1px 0 #fff;
160 |   line-height: 18px;
161 |   pointer-events: none;
162 | }
163 | .has-switch span {
164 |   text-align: center;
165 |   z-index: 1;
166 |   width: 33%;
167 | }
168 | .has-switch span.switch-left {
169 |   -webkit-border-top-left-radius: 4px;
170 |   -moz-border-radius-topleft: 4px;
171 |   border-top-left-radius: 4px;
172 |   -webkit-border-bottom-left-radius: 4px;
173 |   -moz-border-radius-bottomleft: 4px;
174 |   border-bottom-left-radius: 4px;
175 | }
176 | .has-switch span.switch-right {
177 |   color: #333333;
178 |   text-shadow: 0 1px 1px rgba(255, 255, 255, 0.75);
179 |   background-color: #f0f0f0;
180 |   background-image: -moz-linear-gradient(top, #e6e6e6, #ffffff);
181 |   background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#e6e6e6), to(#ffffff));
182 |   background-image: -webkit-linear-gradient(top, #e6e6e6, #ffffff);
183 |   background-image: -o-linear-gradient(top, #e6e6e6, #ffffff);
184 |   background-image: linear-gradient(to bottom, #e6e6e6, #ffffff);
185 |   background-repeat: repeat-x;
186 |   filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffe6e6e6', endColorstr='#ffffffff', GradientType=0);
187 |   border-color: #ffffff #ffffff #d9d9d9;
188 |   border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
189 |   *background-color: #ffffff;
190 |   /* Darken IE7 buttons by default so they stand out more given they won't have borders */
191 | 
192 |   filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);
193 | }
194 | .has-switch span.switch-right:hover,
195 | .has-switch span.switch-right:focus,
196 | .has-switch span.switch-right:active,
197 | .has-switch span.switch-right.active,
198 | .has-switch span.switch-right.disabled,
199 | .has-switch span.switch-right[disabled] {
200 |   color: #333333;
201 |   background-color: #ffffff;
202 |   *background-color: #f2f2f2;
203 | }
204 | .has-switch span.switch-right:active,
205 | .has-switch span.switch-right.active {
206 |   background-color: #e6e6e6 \9;
207 | }
208 | .has-switch span.switch-primary,
209 | .has-switch span.switch-left {
210 |   color: #ffffff;
211 |   text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
212 |   background-color: #005fcc;
213 |   background-image: -moz-linear-gradient(top, #0044cc, #0088cc);
214 |   background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#0044cc), to(#0088cc));
215 |   background-image: -webkit-linear-gradient(top, #0044cc, #0088cc);
216 |   background-image: -o-linear-gradient(top, #0044cc, #0088cc);
217 |   background-image: linear-gradient(to bottom, #0044cc, #0088cc);
218 |   background-repeat: repeat-x;
219 |   filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff0044cc', endColorstr='#ff0088cc', GradientType=0);
220 |   border-color: #0088cc #0088cc #005580;
221 |   border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
222 |   *background-color: #0088cc;
223 |   /* Darken IE7 buttons by default so they stand out more given they won't have borders */
224 | 
225 |   filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);
226 | }
227 | .has-switch span.switch-primary:hover,
228 | .has-switch span.switch-left:hover,
229 | .has-switch span.switch-primary:focus,
230 | .has-switch span.switch-left:focus,
231 | .has-switch span.switch-primary:active,
232 | .has-switch span.switch-left:active,
233 | .has-switch span.switch-primary.active,
234 | .has-switch span.switch-left.active,
235 | .has-switch span.switch-primary.disabled,
236 | .has-switch span.switch-left.disabled,
237 | .has-switch span.switch-primary[disabled],
238 | .has-switch span.switch-left[disabled] {
239 |   color: #ffffff;
240 |   background-color: #0088cc;
241 |   *background-color: #0077b3;
242 | }
243 | .has-switch span.switch-primary:active,
244 | .has-switch span.switch-left:active,
245 | .has-switch span.switch-primary.active,
246 | .has-switch span.switch-left.active {
247 |   background-color: #006699 \9;
248 | }
249 | .has-switch span.switch-info {
250 |   color: #ffffff;
251 |   text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
252 |   background-color: #41a7c5;
253 |   background-image: -moz-linear-gradient(top, #2f96b4, #5bc0de);
254 |   background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#2f96b4), to(#5bc0de));
255 |   background-image: -webkit-linear-gradient(top, #2f96b4, #5bc0de);
256 |   background-image: -o-linear-gradient(top, #2f96b4, #5bc0de);
257 |   background-image: linear-gradient(to bottom, #2f96b4, #5bc0de);
258 |   background-repeat: repeat-x;
259 |   filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff2f96b4', endColorstr='#ff5bc0de', GradientType=0);
260 |   border-color: #5bc0de #5bc0de #28a1c5;
261 |   border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
262 |   *background-color: #5bc0de;
263 |   /* Darken IE7 buttons by default so they stand out more given they won't have borders */
264 | 
265 |   filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);
266 | }
267 | .has-switch span.switch-info:hover,
268 | .has-switch span.switch-info:focus,
269 | .has-switch span.switch-info:active,
270 | .has-switch span.switch-info.active,
271 | .has-switch span.switch-info.disabled,
272 | .has-switch span.switch-info[disabled] {
273 |   color: #ffffff;
274 |   background-color: #5bc0de;
275 |   *background-color: #46b8da;
276 | }
277 | .has-switch span.switch-info:active,
278 | .has-switch span.switch-info.active {
279 |   background-color: #31b0d5 \9;
280 | }
281 | .has-switch span.switch-success {
282 |   color: #ffffff;
283 |   text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
284 |   background-color: #58b058;
285 |   background-image: -moz-linear-gradient(top, #51a351, #62c462);
286 |   background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#51a351), to(#62c462));
287 |   background-image: -webkit-linear-gradient(top, #51a351, #62c462);
288 |   background-image: -o-linear-gradient(top, #51a351, #62c462);
289 |   background-image: linear-gradient(to bottom, #51a351, #62c462);
290 |   background-repeat: repeat-x;
291 |   filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff51a351', endColorstr='#ff62c462', GradientType=0);
292 |   border-color: #62c462 #62c462 #3b9e3b;
293 |   border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
294 |   *background-color: #62c462;
295 |   /* Darken IE7 buttons by default so they stand out more given they won't have borders */
296 | 
297 |   filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);
298 | }
299 | .has-switch span.switch-success:hover,
300 | .has-switch span.switch-success:focus,
301 | .has-switch span.switch-success:active,
302 | .has-switch span.switch-success.active,
303 | .has-switch span.switch-success.disabled,
304 | .has-switch span.switch-success[disabled] {
305 |   color: #ffffff;
306 |   background-color: #62c462;
307 |   *background-color: #4fbd4f;
308 | }
309 | .has-switch span.switch-success:active,
310 | .has-switch span.switch-success.active {
311 |   background-color: #42b142 \9;
312 | }
313 | .has-switch span.switch-warning {
314 |   color: #ffffff;
315 |   text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
316 |   background-color: #f9a123;
317 |   background-image: -moz-linear-gradient(top, #f89406, #fbb450);
318 |   background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#f89406), to(#fbb450));
319 |   background-image: -webkit-linear-gradient(top, #f89406, #fbb450);
320 |   background-image: -o-linear-gradient(top, #f89406, #fbb450);
321 |   background-image: linear-gradient(to bottom, #f89406, #fbb450);
322 |   background-repeat: repeat-x;
323 |   filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff89406', endColorstr='#fffbb450', GradientType=0);
324 |   border-color: #fbb450 #fbb450 #f89406;
325 |   border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
326 |   *background-color: #fbb450;
327 |   /* Darken IE7 buttons by default so they stand out more given they won't have borders */
328 | 
329 |   filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);
330 | }
331 | .has-switch span.switch-warning:hover,
332 | .has-switch span.switch-warning:focus,
333 | .has-switch span.switch-warning:active,
334 | .has-switch span.switch-warning.active,
335 | .has-switch span.switch-warning.disabled,
336 | .has-switch span.switch-warning[disabled] {
337 |   color: #ffffff;
338 |   background-color: #fbb450;
339 |   *background-color: #faa937;
340 | }
341 | .has-switch span.switch-warning:active,
342 | .has-switch span.switch-warning.active {
343 |   background-color: #fa9f1e \9;
344 | }
345 | .has-switch span.switch-danger {
346 |   color: #ffffff;
347 |   text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
348 |   background-color: #d14641;
349 |   background-image: -moz-linear-gradient(top, #bd362f, #ee5f5b);
350 |   background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#bd362f), to(#ee5f5b));
351 |   background-image: -webkit-linear-gradient(top, #bd362f, #ee5f5b);
352 |   background-image: -o-linear-gradient(top, #bd362f, #ee5f5b);
353 |   background-image: linear-gradient(to bottom, #bd362f, #ee5f5b);
354 |   background-repeat: repeat-x;
355 |   filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffbd362f', endColorstr='#ffee5f5b', GradientType=0);
356 |   border-color: #ee5f5b #ee5f5b #e51d18;
357 |   border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
358 |   *background-color: #ee5f5b;
359 |   /* Darken IE7 buttons by default so they stand out more given they won't have borders */
360 | 
361 |   filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);
362 | }
363 | .has-switch span.switch-danger:hover,
364 | .has-switch span.switch-danger:focus,
365 | .has-switch span.switch-danger:active,
366 | .has-switch span.switch-danger.active,
367 | .has-switch span.switch-danger.disabled,
368 | .has-switch span.switch-danger[disabled] {
369 |   color: #ffffff;
370 |   background-color: #ee5f5b;
371 |   *background-color: #ec4844;
372 | }
373 | .has-switch span.switch-danger:active,
374 | .has-switch span.switch-danger.active {
375 |   background-color: #e9322d \9;
376 | }
377 | .has-switch span.switch-default {
378 |   color: #333333;
379 |   text-shadow: 0 1px 1px rgba(255, 255, 255, 0.75);
380 |   background-color: #f0f0f0;
381 |   background-image: -moz-linear-gradient(top, #e6e6e6, #ffffff);
382 |   background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#e6e6e6), to(#ffffff));
383 |   background-image: -webkit-linear-gradient(top, #e6e6e6, #ffffff);
384 |   background-image: -o-linear-gradient(top, #e6e6e6, #ffffff);
385 |   background-image: linear-gradient(to bottom, #e6e6e6, #ffffff);
386 |   background-repeat: repeat-x;
387 |   filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffe6e6e6', endColorstr='#ffffffff', GradientType=0);
388 |   border-color: #ffffff #ffffff #d9d9d9;
389 |   border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
390 |   *background-color: #ffffff;
391 |   /* Darken IE7 buttons by default so they stand out more given they won't have borders */
392 | 
393 |   filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);
394 | }
395 | .has-switch span.switch-default:hover,
396 | .has-switch span.switch-default:focus,
397 | .has-switch span.switch-default:active,
398 | .has-switch span.switch-default.active,
399 | .has-switch span.switch-default.disabled,
400 | .has-switch span.switch-default[disabled] {
401 |   color: #333333;
402 |   background-color: #ffffff;
403 |   *background-color: #f2f2f2;
404 | }
405 | .has-switch span.switch-default:active,
406 | .has-switch span.switch-default.active {
407 |   background-color: #e6e6e6 \9;
408 | }
409 | 


--------------------------------------------------------------------------------
/demoproject/filter/static/js/bootstrap-switch.min.js:
--------------------------------------------------------------------------------
 1 | /*! ============================================================
 2 |  * bootstrapSwitch v1.8 by Larentis Mattia @SpiritualGuru
 3 |  * http://www.larentis.eu/
 4 |  * 
 5 |  * Enhanced for radiobuttons by Stein, Peter @BdMdesigN
 6 |  * http://www.bdmdesign.org/
 7 |  *
 8 |  * Project site:
 9 |  * http://www.larentis.eu/switch/
10 |  * ============================================================
11 |  * Licensed under the Apache License, Version 2.0
12 |  * http://www.apache.org/licenses/LICENSE-2.0
13 |  * ============================================================ */
14 | !function($){"use strict";$.fn['bootstrapSwitch']=function(method){var inputSelector='input[type!="hidden"]';var methods={init:function(){return this.each(function(){var $element=$(this),$div,$switchLeft,$switchRight,$label,$form=$element.closest('form'),myClasses="",classes=$element.attr('class'),color,moving,onLabel="ON",offLabel="OFF",icon=false,textLabel=false;$.each(['switch-mini','switch-small','switch-large'],function(i,el){if(classes.indexOf(el)>=0)myClasses=el});$element.addClass('has-switch');if($element.data('on')!==undefined)color="switch-"+$element.data('on');if($element.data('on-label')!==undefined)onLabel=$element.data('on-label');if($element.data('off-label')!==undefined)offLabel=$element.data('off-label');if($element.data('label-icon')!==undefined)icon=$element.data('label-icon');if($element.data('text-label')!==undefined)textLabel=$element.data('text-label');$switchLeft=$('<span>').addClass("switch-left").addClass(myClasses).addClass(color).html(onLabel);color='';if($element.data('off')!==undefined)color="switch-"+$element.data('off');$switchRight=$('<span>').addClass("switch-right").addClass(myClasses).addClass(color).html(offLabel);$label=$('<label>').html("&nbsp;").addClass(myClasses).attr('for',$element.find(inputSelector).attr('id'));if(icon){$label.html('<i class="icon '+icon+'"></i>')}if(textLabel){$label.html(''+textLabel+'')}$div=$element.find(inputSelector).wrap($('<div>')).parent().data('animated',false);if($element.data('animated')!==false)$div.addClass('switch-animate').data('animated',true);$div.append($switchLeft).append($label).append($switchRight);$element.find('>div').addClass($element.find(inputSelector).is(':checked')?'switch-on':'switch-off');if($element.find(inputSelector).is(':disabled'))$(this).addClass('deactivate');var changeStatus=function($this){if($element.parent('label').is('.label-change-switch')){}else{$this.siblings('label').trigger('mousedown').trigger('mouseup').trigger('click')}};$element.on('keydown',function(e){if(e.keyCode===32){e.stopImmediatePropagation();e.preventDefault();changeStatus($(e.target).find('span:first'))}});$switchLeft.on('click',function(e){changeStatus($(this))});$switchRight.on('click',function(e){changeStatus($(this))});$element.find(inputSelector).on('change',function(e,skipOnChange){var $this=$(this),$element=$this.parent(),thisState=$this.is(':checked'),state=$element.is('.switch-off');e.preventDefault();$element.css('left','');if(state===thisState){if(thisState)$element.removeClass('switch-off').addClass('switch-on');else $element.removeClass('switch-on').addClass('switch-off');if($element.data('animated')!==false)$element.addClass("switch-animate");if(typeof skipOnChange==='boolean'&&skipOnChange)return;$element.parent().trigger('switch-change',{'el':$this,'value':thisState})}});$element.find('label').on('mousedown touchstart',function(e){var $this=$(this);moving=false;e.preventDefault();e.stopImmediatePropagation();$this.closest('div').removeClass('switch-animate');if($this.closest('.has-switch').is('.deactivate')){$this.unbind('click')}else if($this.closest('.switch-on').parent().is('.radio-no-uncheck')){$this.unbind('click')}else{$this.on('mousemove touchmove',function(e){var $element=$(this).closest('.make-switch'),relativeX=(e.pageX||e.originalEvent.targetTouches[0].pageX)-$element.offset().left,percent=(relativeX/$element.width())*100,left=25,right=75;moving=true;if(percent<left)percent=left;else if(percent>right)percent=right;$element.find('>div').css('left',(percent-right)+"%")});$this.on('click touchend',function(e){var $this=$(this),$target=$(e.target),$myRadioCheckBox=$target.siblings('input');e.stopImmediatePropagation();e.preventDefault();$this.unbind('mouseleave');if(moving)$myRadioCheckBox.prop('checked',!(parseInt($this.parent().css('left'))<-25));else $myRadioCheckBox.prop("checked",!$myRadioCheckBox.is(":checked"));moving=false;$myRadioCheckBox.trigger('change')});$this.on('mouseleave',function(e){var $this=$(this),$myInputBox=$this.siblings('input');e.preventDefault();e.stopImmediatePropagation();$this.unbind('mouseleave');$this.trigger('mouseup');$myInputBox.prop('checked',!(parseInt($this.parent().css('left'))<-25)).trigger('change')});$this.on('mouseup',function(e){e.stopImmediatePropagation();e.preventDefault();$(this).unbind('mousemove')})}});if($form.data('bootstrapSwitch')!=='injected'){$form.bind('reset',function(){setTimeout(function(){$form.find('.make-switch').each(function(){var $input=$(this).find(inputSelector);$input.prop('checked',$input.is(':checked')).trigger('change')})},1)});$form.data('bootstrapSwitch','injected')}})},toggleActivation:function(){var $this=$(this);$this.toggleClass('deactivate');$this.find(inputSelector).prop('disabled',$this.is('.deactivate'))},isActive:function(){return!$(this).hasClass('deactivate')},setActive:function(active){var $this=$(this);if(active){$this.removeClass('deactivate');$this.find(inputSelector).removeAttr('disabled')}else{$this.addClass('deactivate');$this.find(inputSelector).attr('disabled','disabled')}},toggleState:function(skipOnChange){var $input=$(this).find(':checkbox');$input.prop('checked',!$input.is(':checked')).trigger('change',skipOnChange)},toggleRadioState:function(skipOnChange){var $radioinput=$(this).find(':radio');$radioinput.not(':checked').prop('checked',!$radioinput.is(':checked')).trigger('change',skipOnChange)},toggleRadioStateAllowUncheck:function(uncheck,skipOnChange){var $radioinput=$(this).find(':radio');if(uncheck){$radioinput.not(':checked').trigger('change',skipOnChange)}else{$radioinput.not(':checked').prop('checked',!$radioinput.is(':checked')).trigger('change',skipOnChange)}},setState:function(value,skipOnChange){$(this).find(inputSelector).prop('checked',value).trigger('change',skipOnChange)},setOnLabel:function(value){var $switchLeft=$(this).find(".switch-left");$switchLeft.html(value)},setOffLabel:function(value){var $switchRight=$(this).find(".switch-right");$switchRight.html(value)},setOnClass:function(value){var $switchLeft=$(this).find(".switch-left");var color='';if(value!==undefined){if($(this).attr('data-on')!==undefined){color="switch-"+$(this).attr('data-on')}$switchLeft.removeClass(color);color="switch-"+value;$switchLeft.addClass(color)}},setOffClass:function(value){var $switchRight=$(this).find(".switch-right");var color='';if(value!==undefined){if($(this).attr('data-off')!==undefined){color="switch-"+$(this).attr('data-off')}$switchRight.removeClass(color);color="switch-"+value;$switchRight.addClass(color)}},setAnimated:function(value){var $element=$(this).find(inputSelector).parent();if(value===undefined)value=false;$element.data('animated',value);$element.attr('data-animated',value);if($element.data('animated')!==false){$element.addClass("switch-animate")}else{$element.removeClass("switch-animate")}},setSizeClass:function(value){var $element=$(this);var $switchLeft=$element.find(".switch-left");var $switchRight=$element.find(".switch-right");var $label=$element.find("label");$.each(['switch-mini','switch-small','switch-large'],function(i,el){if(el!==value){$switchLeft.removeClass(el);$switchRight.removeClass(el);$label.removeClass(el)}else{$switchLeft.addClass(el);$switchRight.addClass(el);$label.addClass(el)}})},status:function(){return $(this).find(inputSelector).is(':checked')},destroy:function(){var $element=$(this),$div=$element.find('div'),$form=$element.closest('form'),$inputbox;$div.find(':not(input)').remove();$inputbox=$div.children();$inputbox.unwrap().unwrap();$inputbox.unbind('change');if($form){$form.unbind('reset');$form.removeData('bootstrapSwitch')}return $inputbox}};if(methods[method])return methods[method].apply(this,Array.prototype.slice.call(arguments,1));else if(typeof method==='object'||!method)return methods.init.apply(this,arguments);else $.error('Method '+method+' does not exist!')}}(jQuery);(function($){$(function(){$('.make-switch')['bootstrapSwitch']()})})(jQuery);
15 | 


--------------------------------------------------------------------------------
/demoproject/filter/templates/user/user_list.html:
--------------------------------------------------------------------------------
 1 | {% load static paginator i18n %}
 2 | <html>
 3 | 	<head>
 4 |         <title>django-generic-filters demo</title>
 5 |         <link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.min.css" rel="stylesheet" />
 6 |         <link href="{% static 'css/bootstrap-switch.css' %}" rel="stylesheet" />
 7 |         <link rel="stylesheet" href="{% static 'css/genericfilters.css' %}" />
 8 | 
 9 |         <script type="text/javascript" src="http://codeorigin.jquery.com/jquery-1.10.2.min.js"></script>
10 |         <script type="text/javascript" src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
11 |         <script type="text/javascript" src="{% static 'js/bootstrap-switch.min.js' %}"></script>
12 |         <script type="text/javascript" src="{% static 'js/genericfilters.js' %}"></script>
13 | 
14 | 	</head>
15 | 	<body>
16 |         <div class="container-fluid">
17 |             <div class="row-fluid">
18 |                 <div class="span3 well" style="margin-top: 20px;">
19 |                     {% include 'genericfilters/filter_list.html' %}
20 |                 </div>
21 |                 <div class="span9">
22 |                     <h3>{% trans "All users" %} ({{ paginator.count }})</h3>
23 | 
24 |                     {% block actions %}
25 |                       <div class="well">
26 |                         <div class="span2">
27 |                           <div class="btn-group">
28 |                             <a class="btn dropdown-toggle" data-toggle="dropdown" href="#">
29 |                               <i class="icon-arrow-down"></i> {% trans "Sort" %} <span class="caret"></span>
30 |                             </a>
31 |                             <ul class="dropdown-menu">
32 |                               {% include 'genericfilters/order_by_list.html' %}
33 |                             </ul>
34 |                           </div>
35 |                         </div>
36 |                         <div class="span10">
37 |                           {% trans "Username, Last name, First name, Email" as placeholder %}
38 |                           {% include 'genericfilters/query_filter.html' %}
39 |                             </div>
40 |                       </div>
41 |                     {% endblock %}
42 | 
43 |                     <table class="table table-striped">
44 |                       <thead>
45 |                         <tr>
46 |                           <th>{% trans "Last name" %}</th>
47 |                           <th>{% trans "First name" %}</th>
48 |                           <th>{% trans "Email" %}</th>
49 |                           <th>{% trans "Active?" %}</th>
50 |                           <th>{% trans "Staff?" %}</th>
51 |                           <th>{% trans "Superuser?" %}</th>
52 |                         </tr>
53 |                       </thead>
54 |                       <tbody>
55 |                         {% for user in users %}
56 |                           <tr>
57 |                             <td>{{ user.last_name }}</td>
58 |                             <td>{{ user.first_name }}</td>
59 |                             <td>{{ user.email }}</td>
60 |                             <td>
61 |                               <div class="make-switch">
62 |                                 <input type="checkbox" disabled{% if user.is_active %} checked{% endif %} />
63 |                               </div>
64 |                             </td>
65 |                             <td>
66 |                               <div class="make-switch">
67 |                                 <input type="checkbox" disabled{% if user.is_staff %} checked{% endif %} />
68 |                               </div>
69 |                             </td>
70 |                             <td>
71 |                               <div class="make-switch">
72 |                                 <input type="checkbox" disabled{% if user.is_superuser %} checked{% endif %} />
73 |                               </div>
74 |                             </td>
75 |                           </tr>
76 |                         {% endfor %}
77 |                       </tbody>
78 |                     </table>
79 |                     {% paginator %}
80 |                 </div>
81 |             </div>
82 |         </div>
83 |     </body>
84 | </html>
85 | 


--------------------------------------------------------------------------------
/demoproject/filter/tests.py:
--------------------------------------------------------------------------------
 1 | from django.test import TestCase
 2 | 
 3 | from demoproject.compat import reverse
 4 | 
 5 | 
 6 | class FilteredListView(TestCase):
 7 |     fixtures = ["test_data.json"]
 8 | 
 9 |     def test_empty_get(self):
10 |         url = reverse("user_filter_view")
11 |         response = self.client.get(url)
12 |         self.assertEqual(response.status_code, 200)
13 | 
14 |     def test_order_by_get(self):
15 |         url = reverse("user_filter_view") + "?order_by=last_login"
16 |         response = self.client.get(url)
17 |         self.assertEqual(response.status_code, 200)
18 | 
19 |     def test_query(self):
20 |         url = reverse("user_filter_view") + "?query=doe"
21 |         response = self.client.get(url)
22 |         self.assertEqual(response.status_code, 200)
23 |         self.assertEqual(len(response.context["users"]), 1)
24 | 


--------------------------------------------------------------------------------
/demoproject/filter/urls.py:
--------------------------------------------------------------------------------
1 | from django.urls import path
2 | 
3 | from demoproject.filter import views
4 | 
5 | urlpatterns = [
6 |     path(r"", views.user_list_view, name="user_filter_view"),
7 | ]
8 | 


--------------------------------------------------------------------------------
/demoproject/filter/views.py:
--------------------------------------------------------------------------------
 1 | from django.contrib.auth.models import User
 2 | 
 3 | from demoproject.filter.forms import UserListForm
 4 | from django_genericfilters.views import FilteredListView
 5 | 
 6 | 
 7 | class UserListView(FilteredListView):
 8 |     # Normal ListView options
 9 |     template_name = "user/user_list.html"
10 |     paginate_by = 10
11 |     context_object_name = "users"
12 |     model = User
13 | 
14 |     # FilteredListView options
15 |     form_class = UserListForm
16 |     search_fields = ["first_name", "last_name", "username", "email"]
17 |     filter_fields = ["is_active", "is_staff", "is_superuser"]
18 |     default_order = "last_name"
19 | 
20 | 
21 | user_list_view = UserListView.as_view()
22 | 


--------------------------------------------------------------------------------
/demoproject/manage.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | import os
 3 | import sys
 4 | 
 5 | from django.core.management import execute_from_command_line
 6 | 
 7 | 
 8 | def main():
 9 |     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demoproject.settings")
10 |     execute_from_command_line(sys.argv)
11 | 
12 | 
13 | if __name__ == "__main__":
14 |     main()
15 | 


--------------------------------------------------------------------------------
/demoproject/settings.py:
--------------------------------------------------------------------------------
 1 | """Django settings for django-generic-filters demo project."""
 2 | 
 3 | from os import environ
 4 | from os.path import abspath, dirname, join
 5 | 
 6 | # Configure some relative directories.
 7 | demoproject_dir = dirname(abspath(__file__))
 8 | root_dir = dirname(demoproject_dir)
 9 | data_dir = join(root_dir, "var")
10 | 
11 | 
12 | # Mandatory settings.
13 | ROOT_URLCONF = "demoproject.urls"
14 | WSGI_APPLICATION = "demoproject.wsgi.application"
15 | 
16 | 
17 | # Database.
18 | DATABASES = {
19 |     "default": {
20 |         "ENGINE": "django.db.backends.postgresql_psycopg2",
21 |         "NAME": environ.get("PGDATABASE", "django_generic_filters")
22 |         # Configure database using standard PG* environment variables
23 |         # https://www.postgresql.org/docs/current/libpq-envars.html
24 |     }
25 | }
26 | 
27 | # Template.
28 | TEMPLATES = [
29 |     {
30 |         "BACKEND": "django.template.backends.django.DjangoTemplates",
31 |         "APP_DIRS": True,
32 |         "OPTIONS": {
33 |             "debug": True,
34 |             "context_processors": (
35 |                 "django.contrib.auth.context_processors.auth",
36 |                 "django.template.context_processors.debug",
37 |                 "django.template.context_processors.i18n",
38 |                 "django.template.context_processors.media",
39 |                 "django.template.context_processors.static",
40 |                 "django.template.context_processors.tz",
41 |                 "django.template.context_processors.request",
42 |                 "django.contrib.messages.context_processors.messages",
43 |             ),
44 |         },
45 |     },
46 | ]
47 | 
48 | 
49 | # Required.
50 | SECRET_KEY = "This is a secret made public on project's repository."
51 | 
52 | # Media and static files.
53 | MEDIA_ROOT = join(data_dir, "media")
54 | MEDIA_URL = "/media/"
55 | STATIC_ROOT = join(data_dir, "static")
56 | STATIC_URL = "/static/"
57 | 
58 | 
59 | # Applications.
60 | INSTALLED_APPS = (
61 |     # Standard Django applications.
62 |     "django.contrib.auth",
63 |     "django.contrib.contenttypes",
64 |     "django.contrib.sessions",
65 |     "django.contrib.sites",
66 |     "django.contrib.messages",
67 |     "django.contrib.staticfiles",
68 |     # The actual django-generic-filters demo.
69 |     "django_genericfilters",
70 |     "demoproject",
71 |     "demoproject.filter",
72 | )
73 | 
74 | 
75 | # Default middlewares. You may alter the list later.
76 | MIDDLEWARE = [
77 |     "django.middleware.common.CommonMiddleware",
78 |     "django.contrib.sessions.middleware.SessionMiddleware",
79 |     "django.middleware.csrf.CsrfViewMiddleware",
80 |     "django.contrib.auth.middleware.AuthenticationMiddleware",
81 |     "django.contrib.messages.middleware.MessageMiddleware",
82 | ]
83 | 
84 | # Development configuration.
85 | DEBUG = True
86 | 
87 | USE_TZ = True
88 | 


--------------------------------------------------------------------------------
/demoproject/templates/home.html:
--------------------------------------------------------------------------------
 1 | <html>
 2 | 	<head>
 3 |         <title>django-generic-filters demo</title>
 4 | 	</head>
 5 | 	<body>
 6 |         <h1>Welcome to django-generic-filters demo!</h1>
 7 |         <p>Here are some demo links. Browse the code to see how they are implemented</p>
 8 | 
 9 |         <h2>Optimized filters</h2>
10 |         <p>Since nginx and other servers aren't installed on the demo, you
11 |            will get raw "X-Sendfile" responses. Look at the headers!</p>
12 |         <ul>
13 |             <li><a href="{% url 'user_filter_view' %}">Django User List View</a></li>
14 |         </ul>
15 |     </body>
16 | </html>
17 | 


--------------------------------------------------------------------------------
/demoproject/tests.py:
--------------------------------------------------------------------------------
 1 | # coding=utf8
 2 | """Test suite for django-generic-filters."""
 3 | from django.test import TestCase
 4 | 
 5 | from demoproject.compat import reverse
 6 | 
 7 | 
 8 | class HomeViewTestCase(TestCase):
 9 |     """Test homepage."""
10 | 
11 |     def test_get(self):
12 |         """Homepage returns HTTP 200."""
13 |         home_url = reverse("home")
14 |         response = self.client.get(home_url)
15 |         self.assertEqual(response.status_code, 200)
16 | 


--------------------------------------------------------------------------------
/demoproject/urls.py:
--------------------------------------------------------------------------------
 1 | from django.urls import include, path
 2 | from django.views.generic import TemplateView
 3 | 
 4 | home = TemplateView.as_view(template_name="home.html")
 5 | 
 6 | 
 7 | urlpatterns = [
 8 |     path(r"filter/", include("demoproject.filter.urls")),
 9 |     # An informative homepage.
10 |     path(r"", home, name="home"),
11 | ]
12 | 


--------------------------------------------------------------------------------
/demoproject/wsgi.py:
--------------------------------------------------------------------------------
 1 | """WSGI config for Django-DownloadView demo project.
 2 | 
 3 | This module contains the WSGI application used by Django's development server
 4 | and any production WSGI deployments. It should expose a module-level variable
 5 | named ``application``. Django's ``runserver`` and ``runfcgi`` commands discover
 6 | this application via the ``WSGI_APPLICATION`` setting.
 7 | 
 8 | Usually you will have the standard Django WSGI application here, but it also
 9 | might make sense to replace the whole Django WSGI application with a custom one
10 | that later delegates to the Django one. For example, you could introduce WSGI
11 | middleware here, or combine a Django application with an application of another
12 | framework.
13 | 
14 | """
15 | import os
16 | 
17 | from django.core.wsgi import get_wsgi_application
18 | 
19 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "%s.settings" % __package__)
20 | 
21 | # This application object is used by any WSGI server configured to use this
22 | # file. This includes Django's development server, if the WSGI_APPLICATION
23 | # setting points here.
24 | application = get_wsgi_application()
25 | 
26 | # Apply WSGI middleware here.
27 | # from helloworld.wsgi import HelloWorldApplication
28 | # application = HelloWorldApplication(application)
29 | 


--------------------------------------------------------------------------------
/django_genericfilters/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/peopledoc/django-generic-filters/11b07972174a250b6867c6ae56c45ad5c31693fc/django_genericfilters/__init__.py


--------------------------------------------------------------------------------
/django_genericfilters/fields.py:
--------------------------------------------------------------------------------
 1 | from django import forms
 2 | from django.utils.translation import gettext_lazy as _
 3 | 
 4 | 
 5 | class ChoiceField(forms.ChoiceField):
 6 |     def __init__(self, *args, **kwargs):
 7 | 
 8 |         kwargs.setdefault("required", False)
 9 | 
10 |         if "choices" not in kwargs:
11 |             kwargs["choices"] = (
12 |                 ("yes", kwargs.get("label", _("Yes"))),
13 |                 ("no", _("No %(label)s") % {"label": kwargs.get("label", "")}),
14 |             )
15 |         super(ChoiceField, self).__init__(*args, **kwargs)
16 | 


--------------------------------------------------------------------------------
/django_genericfilters/forms.py:
--------------------------------------------------------------------------------
 1 | """
 2 | django generic filters implement a set of mixin to work with ordered
 3 | and filtered queryset.
 4 | 
 5 | """
 6 | from django import forms
 7 | from django.utils.translation import gettext_lazy as _
 8 | 
 9 | from .fields import *  # NOQA
10 | 
11 | 
12 | class QueryFormMixin(object):
13 |     """
14 |     Mixin implementing a query parameters for filtering results.
15 |     """
16 | 
17 |     def __init__(self, *args, **kwargs):
18 |         super(QueryFormMixin, self).__init__(*args, **kwargs)
19 |         self.fields["query"] = forms.CharField(required=False, widget=forms.HiddenInput)
20 | 
21 | 
22 | class OrderFormMixin(object):
23 |     """
24 |     Mixin implementing order_by and order_by_reverse for your filtered
25 |     results
26 |     """
27 | 
28 |     def __init__(self, *args, **kwargs):
29 |         super(OrderFormMixin, self).__init__(*args, **kwargs)
30 | 
31 |         self.fields["order_by"] = forms.ChoiceField(
32 |             label=_("order by"),
33 |             required=False,
34 |             widget=forms.HiddenInput,
35 |             choices=self.get_order_by_choices(),
36 |         )
37 |         self.fields["order_reverse"] = forms.BooleanField(
38 |             label=_("order by"), required=False, widget=forms.HiddenInput
39 |         )
40 | 
41 |     def clean_order_by(self):
42 |         if self["order_by"].html_name not in self.data:
43 |             return self.initial.get(
44 |                 self["order_by"].html_name, self.fields["order_by"].initial
45 |             )
46 |         return self.cleaned_data["order_by"]
47 | 
48 |     def get_order_by_choices(self):
49 |         """
50 |         If you use OrderFormMixin, this method must be implemented in
51 |         your form.
52 | 
53 |         get_order_by choices should return a list of tuples. Those
54 |         will be used as choices for the order_by field.
55 | 
56 |         Example:
57 | 
58 |         .. code-block:: python
59 | 
60 |             def get_order_by_choices(self):
61 |                 return [("1", "choice1"),
62 |                         ("2", "choice2")]
63 |         """
64 | 
65 |         raise NotImplementedError(_("Don't forget to implements get_order_by_choices"))
66 | 
67 | 
68 | def clean_yesno(value):
69 |     if isinstance(value, str):
70 |         return {"yes": True, "no": False}.get(value, value)
71 | 
72 |     return value
73 | 
74 | 
75 | class FilteredForm(OrderFormMixin, QueryFormMixin, forms.Form):
76 |     """
77 |     FilteredForm is like a classic forms. But It use OrderFormMixin
78 |     and QueryFormMixin
79 |     """
80 | 
81 |     def clean(self):
82 |         data = self.cleaned_data
83 |         update = {key: clean_yesno(value) for key, value in data.items()}
84 |         data.update(update)
85 |         return data
86 | 


--------------------------------------------------------------------------------
/django_genericfilters/models.py:
--------------------------------------------------------------------------------
1 | """Must be kept even empty. That makes a Django app."""
2 | 


--------------------------------------------------------------------------------
/django_genericfilters/static/css/filters_list.css:
--------------------------------------------------------------------------------
1 | input[type=checkbox] {
2 |     vertical-align: baseline;
3 | }
4 | 


--------------------------------------------------------------------------------
/django_genericfilters/static/css/genericfilters.css:
--------------------------------------------------------------------------------
1 | a.selected {
2 |     color: green;
3 | }


--------------------------------------------------------------------------------
/django_genericfilters/static/js/genericfilters.js:
--------------------------------------------------------------------------------
1 | function search_submit() {
2 |     $("#search_form #id_query").val($("#query").val());
3 |     $("#search_form").submit();
4 | }
5 | 


--------------------------------------------------------------------------------
/django_genericfilters/templates/genericfilters/filter_list.html:
--------------------------------------------------------------------------------
 1 | {% load i18n updateurl utils static %}
 2 | <link rel="stylesheet" href="{% static 'css/filters_list.css' %}" />
 3 | <form method="GET" id="search_form" style="display: block;">
 4 |   <ul class="nav nav-list">
 5 |     {# Hidden fields #}
 6 |     {% for field in form.hidden_fields %}{{ field }}{% endfor %}
 7 | 
 8 |     {# Visible fields #}
 9 |     {% for field in form.visible_fields %}
10 |       {% if field|is_checkbox %}
11 |         <label class="aligned_label" for="{{ field.auto_id }}">{{ field }}{{ field.label }}</label>
12 |       {% elif field.name in stacked_fields %}
13 |         <li class="field">{{ field }}</li>
14 |       {% else %}
15 |         <li class="nav-header">{{ field.label }}</li>
16 |         <li class="field">{{ field }}</li>
17 |       {% endif %}
18 |     {% endfor %}
19 | 
20 |     {# FilterList #}
21 |     {% for filter in filters %}
22 |       <li class="nav-header">{{ filter.label }}</li>
23 |       {% for choice in filter.choices %}
24 |         <li id="{{ filter.name }}_{{ choice.value|default:'all' }}_id">
25 |           <a{% if not choice.is_selected %} href="{% update_query_string with filter.name=choice.value 'page'=1 %}"{% else %} class="selected"{% endif %}>
26 |             {# If safe_label not define or safe_label is True #}
27 |             {% if safe_label|default_if_none:True %}
28 |                 {{ choice.label|safe }}
29 |             {% else %}
30 |                 {{ choice.label }}
31 |             {% endif %}
32 |           </a>
33 |         </li>
34 |       {% endfor %}
35 |     {% endfor %}
36 |   </ul>
37 | </form>
38 | 
39 | 
40 | <script type="text/javascript">
41 |     $(document).ready(function () {
42 |         $('#search_form select:not("[data-auto-submit=\'no\']")').change(search_submit);
43 |     });
44 | </script>
45 | 


--------------------------------------------------------------------------------
/django_genericfilters/templates/genericfilters/order_by_list.html:
--------------------------------------------------------------------------------
 1 | {% load updateurl %}
 2 | {% for order_field in form.fields.order_by.choices %}
 3 | <li>
 4 |   {% if form.cleaned_data.order_by == order_field.0 %}
 5 |     {% with form.order_reverse.value as order_reverse %}
 6 |     {% with order_reverse|add:"0"|yesno:"0,1" as order_reverse_opposite %}
 7 |     <a href="{% update_query_string with 'order_by'=order_field.0 'order_reverse'=order_reverse_opposite 'page'=1 %}"
 8 |        class="{% if form.cleaned_data.order_by == order_field.0 %} active{% else %}0{% endif %}">
 9 |       <i class="icon-chevron-{% if order_reverse == '1' %}down{% else %}up{% endif %}"></i> {{ order_field.1|capfirst }}
10 |     </a>
11 |     {% endwith %}
12 |     {% endwith %}
13 |   {% else %}
14 |   <a href="{% update_query_string with 'order_by'=order_field.0 'order_reverse'=0 'page'=1 %}">
15 |     <i style="width: 14px; display: inline-block;">&nbsp;</i> {{ order_field.1|capfirst }}
16 |   </a>
17 |   {% endif %}
18 | </li>
19 | {% endfor %}
20 | 


--------------------------------------------------------------------------------
/django_genericfilters/templates/genericfilters/query_filter.html:
--------------------------------------------------------------------------------
 1 | {% load i18n %}
 2 | 
 3 | {% trans "Name" as default %}
 4 | 
 5 | <form class="form-search input-append" onsubmit="search_submit(); return false;" style="width: 100%;">
 6 |   <span class="add-on"><i class="icon-search"></i></span>
 7 |   <input id="query" value="{{ form.query.value|default:'' }}" type="search" placeholder="{% firstof placeholder default %}" style="width: 80%;" />
 8 |   <button type="submit" class="btn">{% trans "Search" %}</button>
 9 | </form>
10 | 


--------------------------------------------------------------------------------
/django_genericfilters/templates/snippets/pagination.html:
--------------------------------------------------------------------------------
 1 | {% load updateurl %}
 2 |         {% if page_obj.paginator.page_range|length > 1 %}
 3 |         <div class="pagination center">
 4 |             <ul>
 5 |             {% if page_obj.has_previous %} 
 6 |                 <li><a href="{% update_query_string with 'page'=page_obj.previous_page_number %}">&lt;</a></li>
 7 |             {% else %}
 8 |                 <li class="disabled"><a href="#">&lt;</a></li>
 9 |             {% endif %}
10 | 
11 |             {% if show_first %}
12 |               <li><a href="?page={% update_query_string with 'page'=1 %}">1</a></span>
13 |               <li><a>...</a></li>
14 |             {% endif %}
15 | 
16 |             {% for num_page in page_numbers %}
17 |             {% if num_page == page_obj.number %}
18 |              <li class="active"><a href="{% update_query_string with 'page'=num_page %}">{{num_page}}</a></li>
19 |              {% else %}
20 |              <li><a href="{% update_query_string with 'page'=num_page %}">{{num_page}}</a></li>
21 |              {% endif %}
22 |             {% endfor %}
23 | 
24 |             {% if show_last %}
25 |               <li><a>...</a></li>
26 |               <li><a href="{% update_query_string with 'page'=paginator.num_pages %}">{{ paginator.num_pages }}</a></span>
27 |             {% endif %}
28 | 
29 |             {% if page_obj.has_next %} 
30 |                 <li><a href="{% update_query_string with 'page'=page_obj.next_page_number %}">&gt;</a></li>
31 |             {% else %}
32 |                 <li class="disabled"><a href="#">&gt;</a></li>
33 |             {% endif %}
34 |             </ul>
35 |         </div>
36 |         {% endif %}
37 | 


--------------------------------------------------------------------------------
/django_genericfilters/templatetags/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/peopledoc/django-generic-filters/11b07972174a250b6867c6ae56c45ad5c31693fc/django_genericfilters/templatetags/__init__.py


--------------------------------------------------------------------------------
/django_genericfilters/templatetags/paginator.py:
--------------------------------------------------------------------------------
 1 | #  Based on: http://www.djangosnippets.org/snippets/73/
 2 | #
 3 | #  Modified by Sean Reifschneider to be smarter about surrounding page
 4 | #  link context.  For usage documentation see:
 5 | #
 6 | #     http://www.tummy.com/Community/Articles/django-pagination/
 7 | 
 8 | from django import template
 9 | 
10 | register = template.Library()
11 | 
12 | 
13 | def paginator(context, adjacent_pages=1):
14 |     """
15 |     To be used in conjunction with the object_list generic view.
16 | 
17 |     Adds pagination context variables for use in displaying first, adjacent and
18 |     last page links in addition to those created by the object_list generic
19 |     view.
20 | 
21 |     """
22 |     if "page_obj" in context:
23 |         page_obj = context["page_obj"]
24 |         paginator = context["paginator"]
25 |         startPage = max(page_obj.number - adjacent_pages, 1)
26 |         if startPage <= 3:
27 |             startPage = 1
28 |         endPage = page_obj.number + adjacent_pages + 1
29 |         if endPage >= paginator.num_pages - 1:
30 |             endPage = paginator.num_pages + 1
31 |         page_numbers = [
32 |             n for n in range(startPage, endPage) if n > 0 and n <= paginator.num_pages
33 |         ]
34 | 
35 |         context["page_numbers"] = page_numbers
36 |         context["show_first"] = 1 not in page_numbers
37 |         context["show_last"] = paginator.num_pages not in page_numbers
38 |         return context
39 |     else:
40 |         return {}
41 | 
42 | 
43 | register.inclusion_tag("snippets/pagination.html", takes_context=True)(paginator)
44 | 


--------------------------------------------------------------------------------
/django_genericfilters/templatetags/updateurl.py:
--------------------------------------------------------------------------------
  1 | """Template tag library around URL transformations.
  2 | 
  3 | Provides one template tag: "update_query_string".
  4 | 
  5 | Example:
  6 | 
  7 | .. code-block:: Django
  8 | 
  9 |    {% load updateurl %}
 10 | 
 11 |    First example using strings:
 12 |    {% update_query_string with 'page'='2' %}
 13 | 
 14 |    Second example using variables (both sides of "=" can be variables):
 15 |    {% update_query_string with page=paginator.next_page %}
 16 | 
 17 | """
 18 | 
 19 | import re
 20 | import urllib
 21 | 
 22 | from django import template
 23 | from django.template.base import FilterExpression
 24 | from django.utils.html import conditional_escape
 25 | 
 26 | register = template.Library()
 27 | 
 28 | 
 29 | def token_value(bits, parser):
 30 |     """Parse ``bits`` string and return string or variable (FilterExpression)."""
 31 |     if bits[0] in ('"', "'"):  # Parse a string.
 32 |         if not (bits[0] == bits[-1] or len(bits) < 2):
 33 |             raise template.TemplateSyntaxError("Malformed argument %r" % bits)
 34 |         return bits[1:-1]
 35 |     else:  # Parse a variable.
 36 |         return FilterExpression(bits, parser)
 37 | 
 38 | 
 39 | def token_kwargs(bits, parser):
 40 |     """Return dictionary of keywords arguments from ``bits``.
 41 | 
 42 |     bits
 43 |       A list containing remainder of the token (split by spaces) that is to be
 44 |       checked for arguments. Valid arguments will be removed from this list.
 45 | 
 46 |     parser
 47 |       A template parser instance.
 48 | 
 49 |     There is no requirement for all remaining token ``bits`` to be keyword
 50 |     arguments, so the dictionary will be returned as soon as an invalid
 51 |     argument format is reached.
 52 | 
 53 |     .. note::
 54 | 
 55 |        This function is a fork of :py:func:`django.template.base.token_kwargs`
 56 |        that adds support for variables both sides of the "=" assignation
 57 |        operator.
 58 | 
 59 |     """
 60 |     if not bits:
 61 |         return {}
 62 |     kwarg_re = re.compile(r"(?P<key>.+)=(?P<value>.+)")
 63 |     kwargs = {}
 64 |     while bits:
 65 |         match = kwarg_re.match(bits[0])
 66 |         if not match or not match.group("key") or not match.group("value"):
 67 |             return kwargs
 68 |         key = token_value(match.group("key"), parser)
 69 |         value = token_value(match.group("value"), parser)
 70 |         kwargs[key] = value
 71 |         del bits[:1]
 72 |     return kwargs
 73 | 
 74 | 
 75 | def update_query_string(url, updates):
 76 |     """Update query string in ``url`` with ``updates``."""
 77 |     url_parts = list(urllib.parse.urlparse(str(url)))
 78 |     query_dict = urllib.parse.parse_qs(url_parts[4])
 79 |     query_dict.update(updates)
 80 |     query_string = urllib.parse.urlencode(query_dict, True)
 81 |     url_parts[4] = query_string
 82 |     return urllib.parse.urlunparse(url_parts)
 83 | 
 84 | 
 85 | class UpdateQueryStringNode(template.Node):
 86 |     def __init__(self, url=None, qs_updates={}):
 87 |         self.url = url
 88 |         self.qs_updates = qs_updates
 89 | 
 90 |     def render(self, context):
 91 |         if self.url is None:  # Fallback to current URL.
 92 |             request = context["request"]
 93 |             url = request.get_full_path()
 94 |         else:
 95 |             url = self.url
 96 |         try:
 97 |             url = url.resolve(context)
 98 |         except AttributeError:
 99 |             url = str(url)
100 |         updates = {}
101 |         for key, value in self.qs_updates.items():
102 |             try:
103 |                 key = key.resolve(context)
104 |             except AttributeError:
105 |                 key = str(key)
106 |             try:
107 |                 value = value.resolve(context)
108 |             except AttributeError:
109 |                 value = str(value)
110 |             updates[key] = value
111 |         new_url = update_query_string(url, updates)
112 |         try:
113 |             do_escape = context.autoescape
114 |         except AttributeError:
115 |             do_escape = True  # By default, escape.
116 |         if do_escape:
117 |             new_url = conditional_escape(new_url)
118 |         return new_url
119 | 
120 | 
121 | @register.tag("update_query_string")
122 | def tag_update_query_string(parser, token):
123 |     """Return URL with updated querystring."""
124 |     bits = token.split_contents()
125 |     # Quickly check number of arguments.
126 |     if len(bits) < 2:
127 |         raise template.TemplateSyntaxError(
128 |             "'update_query_string' tag " "requires at least two arguments"
129 |         )
130 |     # Parse options.
131 |     options = {}
132 |     tag_name = bits[0]
133 |     remaining_bits = bits[1:]
134 |     while remaining_bits:
135 |         option = remaining_bits.pop(0)
136 |         if option in options:
137 |             raise template.TemplateSyntaxError(
138 |                 "The %r option was specified more than once." % option
139 |             )
140 |         if option == "with":  # "with" is followed by keyword arguments
141 |             value = token_kwargs(remaining_bits, parser)
142 |             if not value:
143 |                 raise template.TemplateSyntaxError(
144 |                     '"with" in %r tag needs at '
145 |                     "least one keyword "
146 |                     "argument." % tag_name
147 |                 )
148 |         else:
149 |             raise template.TemplateSyntaxError(
150 |                 "Unknown argument for %r tag: %r." % (bits[0], option)
151 |             )
152 |         options[option] = value
153 |     qs_updates = options.get("with", {})
154 |     url = None  # For now, we do not support URL as argument.
155 |     return UpdateQueryStringNode(url=url, qs_updates=qs_updates)
156 | 


--------------------------------------------------------------------------------
/django_genericfilters/templatetags/utils.py:
--------------------------------------------------------------------------------
 1 | """Template tag library.
 2 | 
 3 | Provides one template tag: "check_class".
 4 | 
 5 | Example:
 6 | 
 7 | .. code-block:: Django
 8 | 
 9 |     {% load utils %}
10 | 
11 |     {% if form.field|is_checkbox %}
12 | 
13 | """
14 | 
15 | from django import template
16 | 
17 | register = template.Library()
18 | 
19 | 
20 | @register.filter
21 | def is_checkbox(form_field):
22 |     return form_field.field.widget.__class__.__name__ == "CheckboxInput"
23 | 


--------------------------------------------------------------------------------
/django_genericfilters/tests/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/peopledoc/django-generic-filters/11b07972174a250b6867c6ae56c45ad5c31693fc/django_genericfilters/tests/__init__.py


--------------------------------------------------------------------------------
/django_genericfilters/tests/test_fields.py:
--------------------------------------------------------------------------------
 1 | import unittest
 2 | 
 3 | from django import forms
 4 | 
 5 | from django_genericfilters import forms as gf
 6 | 
 7 | 
 8 | class FieldTestCase(unittest.TestCase):
 9 |     def setUp(self):
10 |         class Form(forms.Form):
11 |             test = gf.ChoiceField(label="Test")
12 | 
13 |         self.form = Form()
14 | 
15 |     def test_filtered_choice_field_required(self):
16 |         self.assertFalse(self.form.fields["test"].required)
17 | 
18 |     def test_filtered_choice_field_auto_choices(self):
19 |         choices = self.form.fields["test"].choices
20 | 
21 |         self.assertEqual(choices[0][0], "yes")
22 |         self.assertEqual(choices[0][1], "Test")
23 | 
24 |         self.assertEqual(choices[1][0], "no")
25 |         self.assertEqual(choices[1][1], "No Test")
26 | 


--------------------------------------------------------------------------------
/django_genericfilters/tests/test_forms.py:
--------------------------------------------------------------------------------
 1 | import unittest
 2 | 
 3 | from django import forms
 4 | 
 5 | from django_genericfilters import forms as gf
 6 | 
 7 | 
 8 | class FormTestCase(unittest.TestCase):
 9 |     def test_query_form_mixin(self):
10 |         class Form(gf.QueryFormMixin, forms.Form):
11 |             pass
12 | 
13 |         form = Form()
14 | 
15 |         self.assertTrue("query" in form.fields)
16 | 
17 |     def test_order_form_mixin(self):
18 |         def get_order_by_choices():
19 |             return (("last_name", "Last Name"), ("first_name", "First Name"))
20 | 
21 |         class Form(gf.OrderFormMixin, forms.Form):
22 |             def get_order_by_choices(self):
23 |                 return get_order_by_choices()
24 | 
25 |         form = Form()
26 | 
27 |         self.assertTrue("order_by" in form.fields)
28 |         self.assertTrue("order_reverse" in form.fields)
29 | 
30 |         self.assertEqual(form.fields["order_by"].choices, list(get_order_by_choices()))
31 | 
32 |     def test_get_order_by_choices_not_implemented(self):
33 |         class Form(gf.OrderFormMixin):
34 |             pass
35 | 
36 |         self.assertRaises(NotImplementedError, Form)
37 | 
38 | 
39 | class FilteredFormTestCase(unittest.TestCase):
40 | 
41 |     # Define a form class for this test case
42 |     class Form(gf.FilteredForm):
43 |         def get_order_by_choices(self):
44 |             return (("last_name", "Last Name"), ("first_name", "First Name"))
45 | 
46 |     def test_empty_form_bound(self):
47 |         form = self.Form(data={}, initial={"order_by": "last_name"})
48 |         self.assertTrue(form.is_bound)
49 |         self.assertTrue(form.is_valid())
50 |         self.assertEqual(form.cleaned_data["order_by"], "last_name")
51 | 
52 |     def test_form_order_by_bound(self):
53 |         form = self.Form(
54 |             data={"order_by": "first_name", "order_reverse": 0},
55 |             initial={"order_by": "last_name"},
56 |         )
57 |         self.assertTrue(form.is_bound)
58 |         self.assertTrue(form.is_valid())
59 |         self.assertEqual(form.cleaned_data["order_by"], "first_name")
60 | 
61 |     def test_filtered_form(self):
62 |         form = self.Form()
63 | 
64 |         self.assertEqual(
65 |             str(type(form.fields["query"].widget)),
66 |             "<class 'django.forms.widgets.HiddenInput'>",
67 |         )
68 | 
69 |         self.assertEqual(
70 |             str(type(form.fields["order_by"].widget)),
71 |             "<class 'django.forms.widgets.HiddenInput'>",
72 |         )
73 | 
74 |         self.assertEqual(
75 |             str(type(form.fields["order_reverse"].widget)),
76 |             "<class 'django.forms.widgets.HiddenInput'>",
77 |         )
78 | 


--------------------------------------------------------------------------------
/django_genericfilters/tests/test_templatetags.py:
--------------------------------------------------------------------------------
 1 | import unittest
 2 | 
 3 | from django import forms
 4 | from django.template import Context, Template
 5 | from django.template.base import Parser, Variable
 6 | from django.test import RequestFactory
 7 | 
 8 | from django_genericfilters.templatetags.updateurl import (
 9 |     token_kwargs,
10 |     token_value,
11 |     update_query_string,
12 | )
13 | from django_genericfilters.templatetags.utils import is_checkbox
14 | 
15 | 
16 | class TemplateTagTestCase(unittest.TestCase):
17 |     def test_token_value(self):
18 |         parser = Parser("")
19 |         self.assertEqual(token_value('"A"', parser), "A")
20 |         var = token_value("a", parser).var
21 |         self.assertTrue(isinstance(var, Variable))
22 | 
23 |     def test_token_kwargs(self):
24 |         parser = Parser("")
25 |         self.assertEqual(token_kwargs([], parser), {})
26 |         bits = ['a="A"']
27 |         token_kwargs(bits, parser)
28 |         self.assertEqual(bits, [])
29 |         bits = ['a="A"', "invalid"]
30 |         token_kwargs(bits, parser)
31 |         self.assertEqual(bits, ["invalid"])
32 | 
33 |     def test_update_query_string(self):
34 |         self.assertEqual(
35 |             update_query_string("/foo/?bar=baz", {"bar": "updated"}),
36 |             "/foo/?bar=updated",
37 |         )
38 |         self.assertEqual(
39 |             update_query_string("/foo/?bar=baz", {"bar": "updated"}),
40 |             "/foo/?bar=updated",
41 |         )
42 |         self.assertEqual(
43 |             update_query_string("/foo/", {"bar": "created"}), "/foo/?bar=created"
44 |         )
45 | 
46 |     def test_tag_update_query_string(self):
47 |         template = Template(
48 |             "{% load updateurl %}{% update_query_string with page=num_page %}"
49 |         )
50 |         self.assertEqual(
51 |             template.render(
52 |                 Context(
53 |                     {
54 |                         "request": RequestFactory().get("/fake"),
55 |                         "page": "page",
56 |                         "num_page": 2,
57 |                     }
58 |                 )
59 |             ),
60 |             "/fake?page=2",
61 |         )
62 | 
63 |     def test_is_checkbox(self):
64 |         class MockForm(forms.Form):
65 |             a = forms.CharField()
66 |             b = forms.BooleanField()
67 | 
68 |         form = MockForm()
69 | 
70 |         boundfield_a, boundfield_b = form.visible_fields()
71 | 
72 |         self.assertEqual("a", boundfield_a.name)
73 |         self.assertFalse(is_checkbox(boundfield_a))
74 | 
75 |         self.assertEqual("b", boundfield_b.name)
76 |         self.assertTrue(is_checkbox(boundfield_b))
77 | 


--------------------------------------------------------------------------------
/django_genericfilters/tests/test_views.py:
--------------------------------------------------------------------------------
  1 | import urllib
  2 | 
  3 | import factory
  4 | from django import forms
  5 | from django.db import models
  6 | from django.http import QueryDict
  7 | from django.test import RequestFactory, TestCase
  8 | from django.utils.datastructures import MultiValueDict
  9 | 
 10 | from django_genericfilters import views
 11 | from django_genericfilters.forms import FilteredForm
 12 | 
 13 | 
 14 | def setup_view(view, request, *args, **kwargs):
 15 |     """Mimic as_view() returned callable, but returns view instance.
 16 | 
 17 |     args and kwargs are the same you would pass to ``reverse()``
 18 | 
 19 |     See also: https://code.djangoproject.com/ticket/20456
 20 | 
 21 |     """
 22 | 
 23 |     view.request = request
 24 |     view.args = args
 25 |     view.kwargs = kwargs
 26 | 
 27 |     return view
 28 | 
 29 | 
 30 | class People(models.Model):
 31 |     """
 32 |     define a parent model
 33 |     """
 34 | 
 35 |     name = models.CharField(max_length=250)
 36 | 
 37 | 
 38 | class Status(models.Model):
 39 |     """
 40 |     define a dummy status model
 41 |     """
 42 | 
 43 |     name = models.CharField(max_length=250)
 44 | 
 45 | 
 46 | class Something(models.Model):
 47 |     """
 48 |     Define a dummy model for this test case
 49 |     """
 50 | 
 51 |     people = models.ForeignKey(People, on_delete=models.CASCADE)
 52 |     city = models.CharField(max_length=250)
 53 |     country = models.CharField(max_length=250)
 54 |     organization = models.CharField(max_length=250)
 55 |     status = models.ForeignKey(Status, null=True, on_delete=models.CASCADE)
 56 | 
 57 | 
 58 | class StatusFactory(factory.django.DjangoModelFactory):
 59 |     name = factory.Faker("word")
 60 | 
 61 |     class Meta:
 62 |         model = Status
 63 | 
 64 | 
 65 | class PeopleFactory(factory.django.DjangoModelFactory):
 66 |     name = factory.Faker("name")
 67 | 
 68 |     class Meta:
 69 |         model = People
 70 | 
 71 | 
 72 | class SomethingFactory(factory.django.DjangoModelFactory):
 73 |     people = factory.SubFactory(PeopleFactory)
 74 |     status = factory.SubFactory(StatusFactory)
 75 |     city = factory.Faker("city")
 76 |     country = factory.Faker("country")
 77 |     organization = factory.Faker("company")
 78 | 
 79 |     class Meta:
 80 |         model = Something
 81 | 
 82 | 
 83 | class FilteredViewTestCase(TestCase):
 84 |     class Form(FilteredForm):
 85 | 
 86 |         city = forms.ChoiceField(
 87 |             label="city", required=False, choices=(("N", "Nantes"), ("P", "Paris"))
 88 |         )
 89 | 
 90 |         country = forms.ChoiceField(
 91 |             label="country",
 92 |             required=False,
 93 |             choices=(("F", "France"), ("P", "Portugal")),
 94 |         )
 95 | 
 96 |         people = forms.ChoiceField(
 97 |             label="people", required=False, choices=(("S", "Some"), ("A", "Any"))
 98 |         )
 99 | 
100 |         organization = forms.MultipleChoiceField(
101 |             label="organization",
102 |             required=False,
103 |             choices=(("A", "A Team"), ("B", "B Team"), ("C", "C Team")),
104 |         )
105 | 
106 |         parent = forms.ModelChoiceField(
107 |             queryset=People.objects.all(), label="parent", required=False
108 |         )
109 | 
110 |         status = forms.ModelMultipleChoiceField(
111 |             label="status", required=False, queryset=Status.objects.all()
112 |         )
113 | 
114 |         def get_order_by_choices(self):
115 |             return (("city", "City"), ("country", "Country"))
116 | 
117 |     @classmethod
118 |     def setUpTestData(cls):
119 |         SomethingFactory.create_batch(20)
120 | 
121 |     def test_default_order_fallback_form_valid(self):
122 |         """Queryset is unordered if no default_order or data (valid form)."""
123 |         data = {"city": "N"}
124 |         view = setup_view(
125 |             views.FilteredListView(model=Something, form_class=self.Form),
126 |             RequestFactory().get("/fake", data),
127 |         )
128 | 
129 |         view.form.is_valid()
130 |         queryset = view.form_valid(view.form)
131 |         self.assertEqual(list(queryset.query.order_by), [])
132 | 
133 |     def test_default_order_fallback_form_invalid(self):
134 |         """Queryset is unordered if no default_order or data (invalid form)."""
135 |         data = {"city": "fake"}
136 |         view = setup_view(
137 |             views.FilteredListView(model=Something, form_class=self.Form),
138 |             RequestFactory().get("/fake", data),
139 |         )
140 | 
141 |         view.form.is_valid()
142 |         queryset = view.form_invalid(view.form)
143 |         self.assertEqual(list(queryset.query.order_by), [])
144 | 
145 |     def test_default_order_fallback_form_empty(self):
146 |         """Queryset is unordered if no default_order or data (empty form)."""
147 |         request = RequestFactory().get("/fake")
148 |         view = setup_view(
149 |             views.FilteredListView(model=Something, form_class=self.Form), request
150 |         )
151 | 
152 |         queryset = view.form_empty()
153 |         self.assertEqual(list(queryset.query.order_by), [])
154 | 
155 |     def test_default_filter(self):
156 |         """Test the default filter"""
157 |         request = RequestFactory().get("/fake")
158 |         view = setup_view(
159 |             views.FilteredListView(
160 |                 model=Something,
161 |                 form_class=self.Form,
162 |                 default_filter={"is_active": "1", "page": "1"},
163 |             ),
164 |             request,
165 |         )
166 | 
167 |         query_filter = urllib.parse.urlencode({"is_active": "1", "page": "1"})
168 |         get_filter = view.get_form_kwargs()
169 |         self.assertEqual(get_filter["data"], QueryDict(query_filter))
170 | 
171 |     def test_default_filter_submit(self):
172 |         """Test the default filter submit"""
173 |         data = {"city": "N"}
174 |         request = RequestFactory().get("/fake", data)
175 |         view = setup_view(
176 |             views.FilteredListView(
177 |                 model=Something,
178 |                 form_class=self.Form,
179 |                 default_filter={"is_active": "1", "page": "1"},
180 |             ),
181 |             request,
182 |         )
183 | 
184 |         query_filter = urllib.parse.urlencode(
185 |             {"is_active": "1", "page": "1", "city": "N"}
186 |         )
187 |         get_filter = view.get_form_kwargs()
188 |         self.assertEqual(get_filter["data"], QueryDict(query_filter))
189 | 
190 |     def test_default_order_form_valid(self):
191 |         """Queryset is ordered by default_order when no order_by in request."""
192 |         data = {"city": "N"}
193 |         view = setup_view(
194 |             views.FilteredListView(
195 |                 model=Something, form_class=self.Form, default_order="city"
196 |             ),
197 |             RequestFactory().get("/fake", data),
198 |         )
199 | 
200 |         view.form.is_valid()
201 |         queryset = view.form_valid(view.form)
202 |         self.assertEqual(list(queryset.query.order_by), ["city"])
203 | 
204 |     def test_default_order_form_invalid(self):
205 |         """Queryset is ordered by default_order when no order_by in request
206 |         and form is invalid."""
207 |         data = {"city": "fake"}
208 |         view = setup_view(
209 |             views.FilteredListView(
210 |                 model=Something, form_class=self.Form, default_order="city"
211 |             ),
212 |             RequestFactory().get("/fake", data),
213 |         )
214 | 
215 |         view.form.is_valid()
216 |         queryset = view.form_invalid(view.form)
217 |         self.assertEqual(list(queryset.query.order_by), ["city"])
218 | 
219 |     def test_default_order_form_empty(self):
220 |         """Queryset is ordered by default_order when no order_by in request."""
221 |         request = RequestFactory().get("/fake")
222 |         view = setup_view(
223 |             views.FilteredListView(
224 |                 model=Something, form_class=self.Form, default_order="city"
225 |             ),
226 |             request,
227 |         )
228 |         queryset = view.form_empty()
229 |         self.assertEqual(list(queryset.query.order_by), ["city"])
230 | 
231 |     def test_default_order_reverse(self):
232 |         """To test order reverse"""
233 |         data = {"city": "N"}
234 |         view = setup_view(
235 |             views.FilteredListView(
236 |                 model=Something, form_class=self.Form, default_order="-city"
237 |             ),
238 |             RequestFactory().get("/fake", data),
239 |         )
240 | 
241 |         view.form.is_valid()
242 |         queryset = view.form_valid(view.form)
243 |         self.assertEqual(list(queryset.query.order_by), ["-city"])
244 | 
245 |     def test_default_order_in_request(self):
246 |         """Test with order_by in data."""
247 |         data = {"city": "N", "order_by": "city"}
248 |         view = setup_view(
249 |             views.FilteredListView(
250 |                 model=Something, form_class=self.Form, default_order="-city"
251 |             ),
252 |             RequestFactory().get("/fake", data),
253 |         )
254 | 
255 |         view.form.is_valid()
256 |         queryset = view.form_valid(view.form)
257 |         self.assertEqual(list(queryset.query.order_by), ["city"])
258 | 
259 |     def test_filtered_list_view(self):
260 |         a = views.FilteredListView(
261 |             filter_fields=["city"], form_class=self.Form, model=Something
262 |         )
263 | 
264 |         b = views.FilteredListView(
265 |             filter_fields=["city", "people"],
266 |             qs_filter_fields={"people__name": "people"},
267 |             form_class=self.Form,
268 |             model=Something,
269 |         )
270 |         setattr(
271 |             a,
272 |             "request",
273 |             type("obj", (object,), {"method": "GET", "GET": {"city": "N"}}),
274 |         )
275 | 
276 |         setattr(
277 |             b,
278 |             "request",
279 |             type("obj", (object,), {"method": "GET", "GET": {"people": "S"}}),
280 |         )
281 | 
282 |         self.assertEqual({"city": "city"}, a.get_qs_filters())
283 |         a.form.is_valid()
284 |         self.assertIn(
285 |             '"django_genericfilters_something"."city" = N',
286 |             a.form_valid(a.form).query.__str__(),
287 |         )
288 | 
289 |         self.assertEqual({"people__name": "people"}, b.get_qs_filters())
290 |         b.form.is_valid()
291 |         self.assertIn(
292 |             '"django_genericfilters_people"."name" = S',
293 |             b.form_valid(b.form).query.__str__(),
294 |         )
295 | 
296 |     def test_filtered_list_view__none(self):
297 |         """
298 |         FIXED : None value understood as "IS NULL" filter instead of being ignored.
299 |         """
300 |         view = views.FilteredListView(
301 |             qs_filter_fields={"city": "city", "people__name": "people"},
302 |             form_class=self.Form,
303 |             model=Something,
304 |         )
305 | 
306 |         data = {"city": "None", "people": "S"}
307 |         setup_view(view, RequestFactory().get("/fake", data))
308 |         view.form.is_valid()
309 |         self.assertIn(
310 |             '"django_genericfilters_people"."name" = S',
311 |             str(view.form_valid(view.form).query),
312 |         )
313 | 
314 |         view = views.FilteredListView(
315 |             qs_filter_fields={"city": "city", "people__name": "people"},
316 |             form_class=self.Form,
317 |             model=Something,
318 |         )
319 | 
320 |         data = {"city": "N", "people": "None"}
321 |         setup_view(view, RequestFactory().get("/fake", data))
322 |         view.form.is_valid()
323 |         self.assertIn(
324 |             '"django_genericfilters_something"."city" = N',
325 |             str(view.form_valid(view.form).query),
326 |         )
327 | 
328 |     def test_filtered_list_view__multiplechoice(self):
329 |         """
330 |         FIXED : filtered fields has HiddenWidget widgets that cannot handle
331 |                 multiple values. Use Field.hidden_widget instead.
332 |         """
333 |         view = views.FilteredListView(
334 |             filter_fields=["organization"], form_class=self.Form, model=Something
335 |         )
336 | 
337 |         data = MultiValueDict({"organization": ["A"]})
338 |         setup_view(view, RequestFactory().get("/fake", data))
339 | 
340 |         self.assertTrue(view.form.is_valid(), view.form.errors)
341 |         self.assertIn(
342 |             '"django_genericfilters_something"."organization" IN (A)',
343 |             str(view.form_valid(view.form).query),
344 |         )
345 | 
346 |         view = views.FilteredListView(
347 |             filter_fields=["organization"], form_class=self.Form, model=Something
348 |         )
349 | 
350 |         data = MultiValueDict({"organization": ["A", "C"]})
351 |         setup_view(view, RequestFactory().get("/fake", data))
352 |         self.assertTrue(view.form.is_valid())
353 | 
354 |     def test_filtered_list_view__multiplechoice__qs_filter_field(self):
355 |         """
356 |         FIXED : When using qs_filter_field, the behaviour changes because
357 |                 the HiddenWidget trick only works with filter_field
358 |                 attribute. But it compares a list with EQUAL operator
359 |                 instead of IN.
360 |         """
361 |         people = People.objects.create(name="fake")
362 | 
363 |         Something.objects.create(organization="A", people=people)
364 |         Something.objects.create(organization="C", people=people)
365 | 
366 |         view = views.FilteredListView(
367 |             qs_filter_fields={"organization": "organization"},
368 |             form_class=self.Form,
369 |             model=Something,
370 |         )
371 | 
372 |         data = MultiValueDict({"organization": ["A"]})
373 |         setup_view(view, RequestFactory().get("/fake", data))
374 | 
375 |         self.assertTrue(view.form.is_valid(), view.form.errors)
376 |         self.assertIn(
377 |             '"django_genericfilters_something"."organization" IN (A)',
378 |             str(view.form_valid(view.form).query),
379 |         )
380 |         self.assertEqual(1, view.form_valid(view.form).count())
381 | 
382 |         view = views.FilteredListView(
383 |             qs_filter_fields={"organization": "organization"},
384 |             form_class=self.Form,
385 |             model=Something,
386 |         )
387 | 
388 |         data = MultiValueDict({"organization": ["A", "C"]})
389 |         setup_view(view, RequestFactory().get("/fake", data))
390 |         self.assertTrue(view.form.is_valid())
391 |         self.assertEqual(2, view.form_valid(view.form).count())
392 | 
393 |     def test_filtered_list_view__modelchoice(self):
394 |         peopleA = People.objects.create(name="fakeA")
395 | 
396 |         view = views.FilteredListView(
397 |             qs_filter_fields={"city": "city", "people": "parent"},
398 |             form_class=self.Form,
399 |             model=Something,
400 |         )
401 | 
402 |         data = {"parent": peopleA.pk}
403 |         setup_view(view, RequestFactory().get("/fake", data))
404 |         view.form.is_valid()
405 |         self.assertIn(
406 |             '"django_genericfilters_something"."people_id" = %s' % (peopleA.pk,),
407 |             str(view.form_valid(view.form).query),
408 |         )
409 | 
410 |     def test_filtered_list_view__modelchoice__empty_queryset(self):
411 |         """
412 |         FIXED : Empty queryset in ModelChoiceField add "IS NULL" filters
413 |                 instead of ignore it.
414 |         """
415 |         view = views.FilteredListView(
416 |             qs_filter_fields={"city": "city", "people": "parent"},
417 |             form_class=self.Form,
418 |             model=Something,
419 |         )
420 | 
421 |         data = {"city": "N", "parent": 1}
422 |         setup_view(view, RequestFactory().get("/fake", data))
423 |         view.form.is_valid()
424 |         self.assertIn(
425 |             '"django_genericfilters_something"."city" = N',
426 |             str(view.form_valid(view.form).query),
427 |         )
428 | 
429 |     def test_filtered_list_view__modelchoice__none(self):
430 |         """
431 |         FIXED : Empty queryset in ModelChoiceField add "IS NULL" filters
432 |                 instead of ignore it.
433 |         """
434 |         view = views.FilteredListView(
435 |             qs_filter_fields={"city": "city", "people": "parent"},
436 |             form_class=self.Form,
437 |             model=Something,
438 |         )
439 | 
440 |         data = {"city": "N", "parent": "None"}
441 |         setup_view(view, RequestFactory().get("/fake", data))
442 |         view.form.is_valid()
443 |         self.assertIn(
444 |             '"django_genericfilters_something"."city" = N',
445 |             str(view.form_valid(view.form).query),
446 |         )
447 | 
448 |     def test_filtered_list_view__modelchoice_unhashable(self):
449 |         """
450 |         On Django3, the ModelChoiceIteratorValue is not hashable
451 |         causing an error on get_filters() method
452 |         """
453 |         peopleA = People.objects.create(name="fakeA")
454 | 
455 |         view = views.FilteredListView(
456 |             qs_filter_fields={"city": "city", "people": "parent"},
457 |             filter_fields=["parent"],
458 |             form_class=self.Form,
459 |             model=Something,
460 |         )
461 |         data = {"parent": peopleA.pk}
462 |         setup_view(view, RequestFactory().get("/fake", data))
463 |         assert view.form.is_valid()
464 |         filters = view.get_filters()
465 |         # assert peopleA is selected on the filter choices
466 |         assert peopleA.pk == next(
467 |             getattr(f.value, "value", f.value)
468 |             for f in filters[0].choices
469 |             if f.is_selected
470 |         )
471 | 
472 |     def test_filtered_list_view__multiplemodelchoice(self):
473 |         """
474 |         FIXED : filtered fields has HiddenWidget widgets that cannot handle
475 |                 multiple values. Use Field.hidden_widget instead.
476 |         """
477 |         stateA = Status.objects.create(name="stateA")
478 |         stateB = Status.objects.create(name="stateB")
479 |         stateC = Status.objects.create(name="stateC")
480 |         people = People.objects.create(name="fake")
481 | 
482 |         A = Something.objects.create(organization="A", people=people, status=stateA)
483 |         B = Something.objects.create(organization="B", people=people, status=stateB)
484 |         C = Something.objects.create(organization="C", people=people, status=stateB)
485 |         Something.objects.create(organization="D", people=people, status=stateC)
486 | 
487 |         view = views.FilteredListView(
488 |             filter_fields=["city", "status"],
489 |             form_class=self.Form,
490 |             model=Something,
491 |         )
492 | 
493 |         data = MultiValueDict({"status": [stateA.pk]})
494 |         setup_view(view, RequestFactory().get("/fake", data))
495 |         view.form.is_valid()
496 | 
497 |         self.assertIsInstance(
498 |             view.form.fields["status"].widget, forms.MultipleHiddenInput
499 |         )
500 | 
501 |         queryset = view.form_valid(view.form)
502 |         self.assertIn("IN (%s)" % stateA.pk, str(queryset.query))
503 |         self.assertEqual([A], list(queryset.all()))
504 | 
505 |         view = views.FilteredListView(
506 |             filter_fields=["city", "status"],
507 |             form_class=self.Form,
508 |             model=Something,
509 |         )
510 | 
511 |         data = MultiValueDict({"status": [stateA.pk, stateB.pk]})
512 |         setup_view(view, RequestFactory().get("/fake", data))
513 |         view.form.is_valid()
514 | 
515 |         queryset = view.form_valid(view.form)
516 |         self.assertEqual([A, B, C], list(queryset.all()))
517 | 
518 |     def test_filtered_list_view__multiplemodelchoice__qs_filter_field(self):
519 |         stateA = Status.objects.create(name="stateA")
520 |         stateB = Status.objects.create(name="stateB")
521 |         stateC = Status.objects.create(name="stateC")
522 |         people = People.objects.create(name="fake")
523 | 
524 |         A = Something.objects.create(organization="A", people=people, status=stateA)
525 |         B = Something.objects.create(organization="B", people=people, status=stateB)
526 |         C = Something.objects.create(organization="C", people=people, status=stateB)
527 |         Something.objects.create(organization="D", people=people, status=stateC)
528 | 
529 |         view = views.FilteredListView(
530 |             qs_filter_fields={"city": "city", "status": "status"},
531 |             form_class=self.Form,
532 |             model=Something,
533 |         )
534 | 
535 |         data = MultiValueDict({"status": [stateA.pk]})
536 |         setup_view(view, RequestFactory().get("/fake", data))
537 |         view.form.is_valid()
538 | 
539 |         self.assertIsInstance(view.form.fields["status"].widget, forms.SelectMultiple)
540 | 
541 |         queryset = view.form_valid(view.form)
542 |         self.assertIn("IN (%s)" % stateA.pk, str(queryset.query))
543 |         self.assertEqual([A], list(queryset))
544 | 
545 |         view = views.FilteredListView(
546 |             qs_filter_fields={"city": "city", "status": "status"},
547 |             form_class=self.Form,
548 |             model=Something,
549 |         )
550 | 
551 |         data = MultiValueDict({"status": [stateA.pk, stateB.pk]})
552 |         setup_view(view, RequestFactory().get("/fake", data))
553 |         view.form.is_valid()
554 | 
555 |         queryset = view.form_valid(view.form)
556 |         self.assertEqual([A, B, C], list(queryset))
557 | 
558 |     def test_filtered_list_view__multiplemodelchoice__invalid_id(self):
559 |         """
560 |         FIXED : Invalid id in MultipleModelChoiceField generate a None
561 |                 value and add "IS NULL" filter instead of ignore it.
562 |         """
563 |         Status.objects.create(name="stateA")
564 |         Status.objects.create(name="stateB")
565 | 
566 |         view = views.FilteredListView(
567 |             qs_filter_fields={"city": "city", "status": "status"},
568 |             form_class=self.Form,
569 |             model=Something,
570 |         )
571 | 
572 |         data = MultiValueDict({"status": [1001]})
573 |         setup_view(view, RequestFactory().get("/fake", data))
574 |         view.form.is_valid()
575 |         # no filter at all
576 |         self.assertNotIn("WHERE", str(view.form_valid(view.form).query))
577 | 
578 |     def test_filtered_list_view__multiplemodelchoice__none(self):
579 |         """
580 |         FIXED : Empty queryset in MultipleModelChoiceField is added as
581 |                 subrequest in filter and raises an sql error instead of
582 |                 ignore it.
583 |         """
584 |         people = People.objects.create(name="fake")
585 | 
586 |         statusA = Status.objects.create(name="stateA")
587 |         statusB = Status.objects.create(name="stateB")
588 | 
589 |         Something.objects.create(organization="A", people=people, status=statusA)
590 |         Something.objects.create(organization="C", people=people, status=statusB)
591 | 
592 |         view = views.FilteredListView(
593 |             qs_filter_fields={"city": "city", "status": "status"},
594 |             form_class=self.Form,
595 |             model=Something,
596 |         )
597 | 
598 |         setup_view(view, RequestFactory().get("/fake", {}))
599 |         view.form.is_valid()
600 |         # no filter at all
601 |         self.assertNotIn("WHERE", str(view.form_valid(view.form).query))
602 | 
603 |     def test_is_form_submitted_method(self):
604 |         """Is form submitted return True when the request method is GET."""
605 |         request = RequestFactory().get("/fake", {"foo": "bar"})
606 |         view = setup_view(views.FilteredListView(), request)
607 |         assert view.is_form_submitted() is True
608 | 
609 |         request = RequestFactory().post("/fake", {"foo": "bar"})
610 |         view = setup_view(views.FilteredListView(), request)
611 |         assert view.is_form_submitted() is False
612 | 
613 |     def test_is_form_submitted_no_args(self):
614 |         """Is form submitted return False when the queryset is empty."""
615 |         request = RequestFactory().get("/fake")
616 |         view = setup_view(views.FilteredListView(), request)
617 |         assert view.is_form_submitted() is False
618 | 


--------------------------------------------------------------------------------
/django_genericfilters/views.py:
--------------------------------------------------------------------------------
  1 | from django import forms
  2 | from django.db.models import Q, QuerySet
  3 | from django.http import QueryDict
  4 | from django.utils.translation import gettext_lazy as _
  5 | from django.views.generic import ListView
  6 | from django.views.generic.edit import FormMixin
  7 | from munch import Munch
  8 | 
  9 | EMPTY_FILTER_VALUES = (None, "", "-1")
 10 | 
 11 | 
 12 | def is_filter(value, form):
 13 |     return bool(value in form.cleaned_data and form.cleaned_data[value])
 14 | 
 15 | 
 16 | class FilteredListView(FormMixin, ListView):
 17 |     """A Generic ListView used to filter and order objects."""
 18 | 
 19 |     default_order = None
 20 |     default_filter = None
 21 | 
 22 |     def is_form_submitted(self):
 23 |         """
 24 |         Return True if the form is already submited. False otherwise
 25 |         """
 26 |         return bool(self.request.method == "GET" and self.request.GET)
 27 | 
 28 |     def get_initial(self):
 29 |         """
 30 |         add "order_by" and "order_reverse" to the initials.
 31 |         """
 32 |         kwargs = super(FilteredListView, self).get_initial()
 33 | 
 34 |         if self.default_order:
 35 |             order_by = self.default_order
 36 | 
 37 |             kwargs["order_by"] = order_by
 38 |             kwargs["order_reverse"] = order_by.startswith("-")
 39 | 
 40 |         return kwargs
 41 | 
 42 |     def get_form_kwargs(self):
 43 |         """Read GET data to return keyword arguments for the form."""
 44 |         kwargs = {"initial": self.get_initial()}
 45 |         data = QueryDict({}).copy()
 46 | 
 47 |         if self.default_filter:
 48 |             data.update(self.default_filter)
 49 | 
 50 |         if self.is_form_submitted():
 51 |             data.update(self.request.GET)
 52 | 
 53 |         kwargs.update({"data": data})
 54 | 
 55 |         return kwargs
 56 | 
 57 |     def __get_queryset(self):
 58 |         """Helper to get ListView default queryset."""
 59 |         return super(ListView, self).get_queryset()
 60 | 
 61 |     def get_queryset(self):
 62 |         """Return filtered queryset. Uses form_valid() or form_invalid()."""
 63 |         if self.form.is_valid():
 64 |             return self.form_valid(self.form)
 65 |         else:
 66 |             return self.form_invalid(self.form)
 67 | 
 68 |     def get_qs_filters(self):
 69 |         """
 70 |         retreive filters from "qs_filter_fields" or "filter_fields"
 71 |         and return them as a dict to be used by self.form_valid
 72 |         """
 73 | 
 74 |         filters = {}
 75 | 
 76 |         if hasattr(self, "qs_filter_fields"):
 77 |             filters = self.qs_filter_fields
 78 | 
 79 |         elif hasattr(self, "filter_fields"):
 80 |             for field in self.filter_fields:
 81 |                 filters[field] = field
 82 | 
 83 |         return filters
 84 | 
 85 |     def clean_qs_filter_field(self, key, value):
 86 |         if value in EMPTY_FILTER_VALUES:
 87 |             return None
 88 | 
 89 |         if isinstance(value, QuerySet):
 90 |             if value.exists():
 91 |                 return {"%s__in" % key: value}
 92 |         elif isinstance(value, (tuple, list)):
 93 |             if len(value) > 0:
 94 |                 return {"%s__in" % key: value}
 95 |         else:
 96 |             return {key: value}
 97 | 
 98 |     def form_valid(self, form):
 99 |         """
100 |         The form_valid is reponsible for filtering and ordering the
101 |         base queryset. It return a queryset.
102 | 
103 |         :param: `django.forms.Forms`
104 |         :return: `django.db.models.query.QuerySet`
105 |         """
106 |         # Get default queryset from ListView parameters (queryset, model, ...)
107 |         queryset = self.__get_queryset()
108 | 
109 |         # Handle QueryFormMixin
110 |         if is_filter("query", form):
111 |             query = form.cleaned_data["query"]
112 |             query_words = query.split()
113 |             filters = None
114 |             for f in self.search_fields:
115 |                 for word in query_words:
116 |                     q = Q(**{f + "__icontains": word})
117 |                     filters = filters | q if filters else q
118 |             if filters:
119 |                 queryset = queryset.filter(filters)
120 | 
121 |         # Handle get_qs_filters
122 |         filters = {}
123 |         extra_conditions = getattr(self, "qs_filter_fields_conditions", None)
124 |         clean_qs_filter_field = self.clean_qs_filter_field
125 | 
126 |         for k, v in self.get_qs_filters().items():
127 |             qs_filter = clean_qs_filter_field(k, form.cleaned_data.get(v))
128 |             if qs_filter is not None:
129 |                 filters.update(qs_filter)
130 | 
131 |                 # Get extra condition for a field to on the filters
132 |                 if extra_conditions is not None:
133 |                     filter_fields_conditions = extra_conditions.get(k, {})
134 | 
135 |                     for key, value in filter_fields_conditions.items():
136 |                         filters[key] = value
137 | 
138 |         queryset = queryset.filter(**filters)
139 | 
140 |         # Handle OrderFormMixin
141 |         if is_filter("order_by", form):
142 |             order_field = form.cleaned_data["order_by"]
143 |             queryset = queryset.order_by(order_field)
144 | 
145 |         if is_filter("order_reverse", form):
146 |             queryset = queryset.reverse()
147 | 
148 |         return queryset
149 | 
150 |     def form_invalid(self, form):
151 |         """Return queryset when submitted form is invalid.
152 | 
153 |         Default implementation uses :meth:`form_empty`.
154 | 
155 |         :param: `django.forms.Forms`
156 |         :return: `django.db.models.query.QuerySet`
157 | 
158 |         """
159 |         return self.form_empty()
160 | 
161 |     def form_empty(self):
162 |         """Return queryset used when form is not submitted."""
163 |         queryset = self.__get_queryset()
164 |         if self.default_order:
165 |             queryset = queryset.order_by(self.default_order)
166 | 
167 |         return queryset
168 | 
169 |     @property
170 |     def form(self):
171 |         """
172 |         guess the form to be used and hide the filter_fields in the template
173 | 
174 |         """
175 |         try:
176 |             return self._form
177 |         except AttributeError:
178 |             form_class = self.get_form_class()
179 |             self._form = self.get_form(form_class)
180 | 
181 |             # Hide filter_fields
182 |             if hasattr(self, "filter_fields"):
183 |                 for fieldname in self.filter_fields:
184 |                     field = self._form.fields[fieldname]
185 |                     hidden_widget = getattr(field, "hidden_widget", forms.HiddenInput)
186 |                     field.widget = hidden_widget()
187 | 
188 |             return self._form
189 | 
190 |     def get_context_data(self, **kwargs):
191 |         """
192 |         Add a list of filters and self.form to the context to be rendered by
193 |         the view.
194 |         """
195 |         kwargs = ListView.get_context_data(self, **kwargs)
196 |         kwargs["form"] = self.form
197 |         kwargs["filters"] = self.get_filters()
198 |         kwargs["stacked_fields"] = getattr(self, "stacked_fields", [])
199 | 
200 |         return kwargs
201 | 
202 |     def get_filters(self):
203 |         """
204 |         Convert some ChoiceField in a list of choices in the
205 |         template.
206 |         """
207 |         filters = []
208 |         if hasattr(self, "filter_fields"):
209 |             for field in self.filter_fields:
210 |                 new_filter = Munch()
211 |                 new_filter.label = self.form.fields[field].label
212 |                 new_filter.name = field
213 |                 new_filter.choices = []
214 |                 selected = False
215 |                 for choice in self.form.fields[field].choices:
216 |                     new_choice = Munch()
217 |                     new_choice.value = choice[0]
218 |                     new_choice.label = choice[1]
219 |                     yesno = {"yes": True, "no": False}
220 |                     if (
221 |                         hasattr(self.form, "cleaned_data")
222 |                         and field in self.form.cleaned_data
223 |                     ):
224 |                         # Get value for ModelChoiceField or ChoiceField
225 |                         value = getattr(
226 |                             self.form.cleaned_data[field],
227 |                             "pk",
228 |                             self.form.cleaned_data[field],
229 |                         )
230 |                         choice_value = getattr(choice[0], "value", choice[0])
231 |                         if value == yesno.get(choice_value, choice_value):
232 |                             new_choice.is_selected = True
233 |                             selected = True
234 |                         else:
235 |                             new_choice.is_selected = False
236 |                     else:
237 |                         new_choice.is_selected = False
238 |                     new_filter.choices.append(new_choice)
239 | 
240 |                 if not self.form.fields[field].required and not [
241 |                     c for c in new_filter.choices if c.value == "-1" or c.value == ""
242 |                 ]:
243 |                     all_choice = Munch(
244 |                         value="", label=_("All"), is_selected=(not selected)
245 |                     )
246 |                     new_filter.choices.insert(0, all_choice)
247 |                 filters.append(new_filter)
248 | 
249 |         return filters
250 | 


--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
 1 | version: '2.1'
 2 | services:
 3 | 
 4 |   postgres:
 5 |     image: postgres
 6 |     ports: [ "5432:5432" ]
 7 |     environment:
 8 |       POSTGRES_DB: db
 9 |       POSTGRES_PASSWORD: password
10 | 


--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
  1 | # Makefile for Sphinx documentation
  2 | #
  3 | 
  4 | # You can set these variables from the command line.
  5 | SPHINXOPTS    =
  6 | SPHINXBUILD   = sphinx-build
  7 | PAPER         =
  8 | BUILDDIR      = ../var/docs
  9 | 
 10 | # Internal variables.
 11 | PAPEROPT_a4     = -D latex_paper_size=a4
 12 | PAPEROPT_letter = -D latex_paper_size=letter
 13 | ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 14 | # the i18n builder cannot share the environment and doctrees with the others
 15 | I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 16 | 
 17 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 18 | 
 19 | help:
 20 | 	@echo "Please use \`make <target>' where <target> is one of"
 21 | 	@echo "  html       to make standalone HTML files"
 22 | 	@echo "  dirhtml    to make HTML files named index.html in directories"
 23 | 	@echo "  singlehtml to make a single large HTML file"
 24 | 	@echo "  pickle     to make pickle files"
 25 | 	@echo "  json       to make JSON files"
 26 | 	@echo "  htmlhelp   to make HTML files and a HTML help project"
 27 | 	@echo "  qthelp     to make HTML files and a qthelp project"
 28 | 	@echo "  devhelp    to make HTML files and a Devhelp project"
 29 | 	@echo "  epub       to make an epub"
 30 | 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 31 | 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 32 | 	@echo "  text       to make text files"
 33 | 	@echo "  man        to make manual pages"
 34 | 	@echo "  texinfo    to make Texinfo files"
 35 | 	@echo "  info       to make Texinfo files and run them through makeinfo"
 36 | 	@echo "  gettext    to make PO message catalogs"
 37 | 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 38 | 	@echo "  linkcheck  to check all external links for integrity"
 39 | 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 40 | 
 41 | clean:
 42 | 	-rm -rf $(BUILDDIR)/*
 43 | 
 44 | html:
 45 | 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 46 | 	@echo
 47 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 48 | 
 49 | dirhtml:
 50 | 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 51 | 	@echo
 52 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 53 | 
 54 | singlehtml:
 55 | 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 56 | 	@echo
 57 | 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 58 | 
 59 | pickle:
 60 | 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 61 | 	@echo
 62 | 	@echo "Build finished; now you can process the pickle files."
 63 | 
 64 | json:
 65 | 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 66 | 	@echo
 67 | 	@echo "Build finished; now you can process the JSON files."
 68 | 
 69 | htmlhelp:
 70 | 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 71 | 	@echo
 72 | 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 73 | 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 74 | 
 75 | qthelp:
 76 | 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 77 | 	@echo
 78 | 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 79 | 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 80 | 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-generic-filters.qhcp"
 81 | 	@echo "To view the help file:"
 82 | 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-generic-filters.qhc"
 83 | 
 84 | devhelp:
 85 | 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 86 | 	@echo
 87 | 	@echo "Build finished."
 88 | 	@echo "To view the help file:"
 89 | 	@echo "# mkdir -p $$HOME/.local/share/devhelp/django-generic-filters"
 90 | 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-generic-filters"
 91 | 	@echo "# devhelp"
 92 | 
 93 | epub:
 94 | 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 95 | 	@echo
 96 | 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 97 | 
 98 | latex:
 99 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100 | 	@echo
101 | 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102 | 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
103 | 	      "(use \`make latexpdf' here to do that automatically)."
104 | 
105 | latexpdf:
106 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107 | 	@echo "Running LaTeX files through pdflatex..."
108 | 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
109 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110 | 
111 | text:
112 | 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113 | 	@echo
114 | 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
115 | 
116 | man:
117 | 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118 | 	@echo
119 | 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120 | 
121 | texinfo:
122 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123 | 	@echo
124 | 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125 | 	@echo "Run \`make' in that directory to run these through makeinfo" \
126 | 	      "(use \`make info' here to do that automatically)."
127 | 
128 | info:
129 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130 | 	@echo "Running Texinfo files through makeinfo..."
131 | 	make -C $(BUILDDIR)/texinfo info
132 | 	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133 | 
134 | gettext:
135 | 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136 | 	@echo
137 | 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138 | 
139 | changes:
140 | 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141 | 	@echo
142 | 	@echo "The overview file is in $(BUILDDIR)/changes."
143 | 
144 | linkcheck:
145 | 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146 | 	@echo
147 | 	@echo "Link check complete; look for any errors in the above output " \
148 | 	      "or in $(BUILDDIR)/linkcheck/output.txt."
149 | 
150 | doctest:
151 | 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152 | 	@echo "Testing of doctests in the sources finished, look at the " \
153 | 	      "results in $(BUILDDIR)/doctest/output.txt."
154 | 


--------------------------------------------------------------------------------
/docs/about/authors.txt:
--------------------------------------------------------------------------------
1 | .. include:: ../../AUTHORS
2 | 


--------------------------------------------------------------------------------
/docs/about/changelog.txt:
--------------------------------------------------------------------------------
1 | .. include:: ../../CHANGELOG
2 | 


--------------------------------------------------------------------------------
/docs/about/index.txt:
--------------------------------------------------------------------------------
 1 | ############################
 2 | About django-generic-filters
 3 | ############################
 4 | 
 5 | .. toctree::
 6 | 
 7 |    license
 8 |    authors
 9 |    changelog
10 | 


--------------------------------------------------------------------------------
/docs/about/license.txt:
--------------------------------------------------------------------------------
1 | .. include:: ../../LICENSE
2 | 


--------------------------------------------------------------------------------
/docs/api/filtered_form.txt:
--------------------------------------------------------------------------------
1 | FilteredForm
2 | ************
3 | 
4 | .. automodule:: django_genericfilters.forms
5 |     :members:
6 | 


--------------------------------------------------------------------------------
/docs/api/filtered_list_view.txt:
--------------------------------------------------------------------------------
  1 | ####################
  2 | FilteredListView API
  3 | ####################
  4 | 
  5 | FilteredListView is a generic ListView allowing to filter queryset.
  6 | It supports RawQuerySet, Python Object List as well as normal
  7 | queryset.
  8 | 
  9 | It use a form to define which filters you want and some options to
 10 | control the way querysets must be managed.
 11 | 
 12 | 
 13 | Example
 14 | *******
 15 | 
 16 | First we define a form to handle our filters
 17 | 
 18 | .. code-block:: python
 19 | 
 20 |     from django import forms
 21 |     from django_genericfilters.forms import FilteredForm
 22 | 
 23 | 
 24 |     class TicketListForm(FilteredForm):
 25 |         query = forms.CharField(label=_('Query'), required=False)
 26 | 
 27 |         priority = forms.ChoiceField(label=_('Priority'),
 28 |                                  required=False,
 29 |                                  choices=(
 30 |                                      ('0', 'High'),
 31 |                                      ('1', 'Normal'),
 32 |                                      ('2', 'Low')
 33 |                                  )
 34 | 
 35 | This form handle filter on a raw query and priority.
 36 | 
 37 | 
 38 | .. code-block:: python
 39 | 
 40 |     from django_genericfilters.views import FilteredListView
 41 |     from myapp.models import Ticket
 42 | 
 43 | 
 44 |     class TicketListView(FilteredListView):
 45 |         model = Ticket
 46 |         paginate_by = 10
 47 |         form_class = TicketListForm
 48 |         search_fields = ['creator__last_name', 'creator__first_name',
 49 |                      'subject', 'body']
 50 |         filter_fields = ['status', 'priority']
 51 |         qs_filter_fields = {'category__last_name': 'category',
 52 |                             'status': 'status',
 53 |                             'priority': 'priority'
 54 |                         }
 55 |         default_order = 'last_updated_at'
 56 | 
 57 | 
 58 | 
 59 | FilteredListView Options
 60 | ************************
 61 | 
 62 | TicketListView define a set of useful specific options:
 63 | 
 64 | search_fields
 65 | -------------
 66 | 
 67 | a list of fields to search against with the "query" field defined on
 68 | the form (see above)
 69 | 
 70 | filter_fields
 71 | -------------
 72 | 
 73 | a list of fields used to construct the form filters in
 74 | the template. In this example, we define status and priority. By
 75 | default, if we do not define a qs_filter_fields it will be used to
 76 | filter the resulting queryset as well.
 77 | 
 78 | qs_filter_fields
 79 | ----------------
 80 | 
 81 | a dict used to filter the results queryset. Useful if you need to make
 82 | complex filters or related models filters.
 83 | 
 84 | qs_filter_fields_conditions
 85 | ---------------------------
 86 | 
 87 | A dict used to filter the results queryset. Useful to add extra condition for
 88 | a special field from qs_filter_fields.
 89 | 
 90 | default_order
 91 | -------------
 92 | 
 93 | the order you want your results to be sorted by default.
 94 | 
 95 | 
 96 | default_filter
 97 | --------------
 98 | 
 99 | The active filter by default.
100 | When using that default filter you need to set ('-1', 'ALL') in your choices
101 | filters for boolean.
102 | 
103 | 
104 | FilteredListView Method
105 | ***********************
106 | 
107 | .. autoclass:: django_genericfilters.views.FilteredListView
108 |     :members:
109 | 


--------------------------------------------------------------------------------
/docs/api/index.txt:
--------------------------------------------------------------------------------
 1 | *************************
 2 | Django Generic Filter API
 3 | *************************
 4 | 
 5 | 
 6 | .. include:: filtered_list_view.txt
 7 | 
 8 | .. include:: filtered_form.txt
 9 | 
10 |     
11 |     
12 |     
13 | 


--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
  1 | #
  2 | # django-generic-filters documentation build configuration file, created by
  3 | # sphinx-quickstart on Mon Aug 27 11:37:23 2012.
  4 | #
  5 | # This file is execfile()d with the current directory set to its containing dir.
  6 | #
  7 | # Note that not all possible configuration values are present in this
  8 | # autogenerated file.
  9 | #
 10 | # All configuration values have a default; values that are commented out
 11 | # serve to show the default.
 12 | 
 13 | import sys, os
 14 | 
 15 | 
 16 | # Minimal Django settings. Required to use sphinx.ext.autodoc, because
 17 | # django-generic-filters depends on Django...
 18 | from django.conf import settings
 19 | 
 20 | 
 21 | settings.configure(
 22 |     DATABASES={},  # Required to load ``django.views.generic``.
 23 | )
 24 | 
 25 | 
 26 | doc_dir = os.path.dirname(os.path.abspath(__file__))
 27 | project_dir = os.path.dirname(doc_dir)
 28 | version_filename = os.path.join(project_dir, "VERSION")
 29 | 
 30 | 
 31 | # If extensions (or modules to document with autodoc) are in another directory,
 32 | # add these directories to sys.path here. If the directory is relative to the
 33 | # documentation root, use os.path.abspath to make it absolute, like shown here.
 34 | # sys.path.insert(0, os.path.abspath('.'))
 35 | 
 36 | # -- General configuration -----------------------------------------------------
 37 | 
 38 | # If your documentation needs a minimal Sphinx version, state it here.
 39 | # needs_sphinx = '1.0'
 40 | 
 41 | # Add any Sphinx extension module names here, as strings. They can be extensions
 42 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 43 | extensions = [
 44 |     "sphinx.ext.autodoc",
 45 |     "sphinx.ext.autosummary",
 46 |     "sphinx.ext.doctest",
 47 |     "sphinx.ext.coverage",
 48 |     "sphinx.ext.viewcode",
 49 | ]
 50 | 
 51 | # Add any paths that contain templates here, relative to this directory.
 52 | templates_path = ["_templates"]
 53 | 
 54 | # The suffix of source filenames.
 55 | source_suffix = ".txt"
 56 | 
 57 | # The encoding of source files.
 58 | # source_encoding = 'utf-8-sig'
 59 | 
 60 | # The master toctree document.
 61 | master_doc = "index"
 62 | 
 63 | # General information about the project.
 64 | project = "django-generic-filters"
 65 | copyright = "2013, Novapost"
 66 | 
 67 | # The version info for the project you're documenting, acts as replacement for
 68 | # |version| and |release|, also used in various other places throughout the
 69 | # built documents.
 70 | #
 71 | # The short X.Y version.
 72 | version = open(version_filename).read().strip()
 73 | # The full version, including alpha/beta/rc tags.
 74 | release = version
 75 | 
 76 | # The language for content autogenerated by Sphinx. Refer to documentation
 77 | # for a list of supported languages.
 78 | language = "en"
 79 | 
 80 | # There are two options for replacing |today|: either, you set today to some
 81 | # non-false value, then it is used:
 82 | # today = ''
 83 | # Else, today_fmt is used as the format for a strftime call.
 84 | # today_fmt = '%B %d, %Y'
 85 | 
 86 | # List of patterns, relative to source directory, that match files and
 87 | # directories to ignore when looking for source files.
 88 | exclude_patterns = ["_build"]
 89 | 
 90 | # The reST default role (used for this markup: `text`) to use for all documents.
 91 | # default_role = None
 92 | 
 93 | # If true, '()' will be appended to :func: etc. cross-reference text.
 94 | # add_function_parentheses = True
 95 | 
 96 | # If true, the current module name will be prepended to all description
 97 | # unit titles (such as .. function::).
 98 | # add_module_names = True
 99 | 
100 | # If true, sectionauthor and moduleauthor directives will be shown in the
101 | # output. They are ignored by default.
102 | # show_authors = False
103 | 
104 | # The name of the Pygments (syntax highlighting) style to use.
105 | pygments_style = "sphinx"
106 | 
107 | # A list of ignored prefixes for module index sorting.
108 | # modindex_common_prefix = []
109 | 
110 | 
111 | # -- Options for HTML output ---------------------------------------------------
112 | 
113 | # The theme to use for HTML and HTML Help pages.  See the documentation for
114 | # a list of builtin themes.
115 | html_theme = "default"
116 | 
117 | # Theme options are theme-specific and customize the look and feel of a theme
118 | # further.  For a list of options available for each theme, see the
119 | # documentation.
120 | # html_theme_options = {}
121 | 
122 | # Add any paths that contain custom themes here, relative to this directory.
123 | # html_theme_path = []
124 | 
125 | # The name for this set of Sphinx documents.  If None, it defaults to
126 | # "<project> v<release> documentation".
127 | # html_title = None
128 | 
129 | # A shorter title for the navigation bar.  Default is the same as html_title.
130 | # html_short_title = None
131 | 
132 | # The name of an image file (relative to this directory) to place at the top
133 | # of the sidebar.
134 | # html_logo = None
135 | 
136 | # The name of an image file (within the static path) to use as favicon of the
137 | # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
138 | # pixels large.
139 | # html_favicon = None
140 | 
141 | # Add any paths that contain custom static files (such as style sheets) here,
142 | # relative to this directory. They are copied after the builtin static files,
143 | # so a file named "default.css" will overwrite the builtin "default.css".
144 | html_static_path = ["_static"]
145 | 
146 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
147 | # using the given strftime format.
148 | # html_last_updated_fmt = '%b %d, %Y'
149 | 
150 | # If true, SmartyPants will be used to convert quotes and dashes to
151 | # typographically correct entities.
152 | # html_use_smartypants = True
153 | 
154 | # Custom sidebar templates, maps document names to template names.
155 | html_sidebars = {
156 |     "**": ["globaltoc.html", "relations.html", "sourcelink.html", "searchbox.html"],
157 | }
158 | 
159 | # Additional templates that should be rendered to pages, maps page names to
160 | # template names.
161 | # html_additional_pages = {}
162 | 
163 | # If false, no module index is generated.
164 | # html_domain_indices = True
165 | 
166 | # If false, no index is generated.
167 | # html_use_index = True
168 | 
169 | # If true, the index is split into individual pages for each letter.
170 | # html_split_index = False
171 | 
172 | # If true, links to the reST sources are added to the pages.
173 | # html_show_sourcelink = True
174 | 
175 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
176 | # html_show_sphinx = True
177 | 
178 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
179 | # html_show_copyright = True
180 | 
181 | # If true, an OpenSearch description file will be output, and all pages will
182 | # contain a <link> tag referring to it.  The value of this option must be the
183 | # base URL from which the finished HTML is served.
184 | # html_use_opensearch = ''
185 | 
186 | # This is the file name suffix for HTML files (e.g. ".xhtml").
187 | # html_file_suffix = None
188 | 
189 | # Output file base name for HTML help builder.
190 | htmlhelp_basename = "django-generic-filtersdoc"
191 | 
192 | 
193 | # -- Options for LaTeX output --------------------------------------------------
194 | 
195 | latex_elements = {
196 |     # The paper size ('letterpaper' or 'a4paper').
197 |     #'papersize': 'letterpaper',
198 |     # The font size ('10pt', '11pt' or '12pt').
199 |     #'pointsize': '10pt',
200 |     # Additional stuff for the LaTeX preamble.
201 |     #'preamble': '',
202 | }
203 | 
204 | # Grouping the document tree into LaTeX files. List of tuples
205 | # (source start file, target name, title, author, documentclass [howto/manual]).
206 | latex_documents = [
207 |     (
208 |         "index",
209 |         "django-generic-filters.tex",
210 |         "django-generic-filters Documentation",
211 |         "Novapost",
212 |         "manual",
213 |     ),
214 | ]
215 | 
216 | # The name of an image file (relative to this directory) to place at the top of
217 | # the title page.
218 | # latex_logo = None
219 | 
220 | # For "manual" documents, if this is true, then toplevel headings are parts,
221 | # not chapters.
222 | # latex_use_parts = False
223 | 
224 | # If true, show page references after internal links.
225 | # latex_show_pagerefs = False
226 | 
227 | # If true, show URL addresses after external links.
228 | # latex_show_urls = False
229 | 
230 | # Documents to append as an appendix to all manuals.
231 | # latex_appendices = []
232 | 
233 | # If false, no module index is generated.
234 | # latex_domain_indices = True
235 | 
236 | 
237 | # -- Options for manual page output --------------------------------------------
238 | 
239 | # One entry per manual page. List of tuples
240 | # (source start file, name, description, authors, manual section).
241 | man_pages = [
242 |     (
243 |         "index",
244 |         "django-generic-filters",
245 |         "django-generic-filters Documentation",
246 |         ["Novapost"],
247 |         1,
248 |     )
249 | ]
250 | 
251 | # If true, show URL addresses after external links.
252 | # man_show_urls = False
253 | 
254 | 
255 | # -- Options for Texinfo output ------------------------------------------------
256 | 
257 | # Grouping the document tree into Texinfo files. List of tuples
258 | # (source start file, target name, title, author,
259 | #  dir menu entry, description, category)
260 | texinfo_documents = [
261 |     (
262 |         "index",
263 |         "django-generic-filters",
264 |         "django-generic-filters Documentation",
265 |         "Novapost",
266 |         "django-generic-filters",
267 |         "One line description of project.",
268 |         "Miscellaneous",
269 |     ),
270 | ]
271 | 
272 | # Documents to append as an appendix to all manuals.
273 | # texinfo_appendices = []
274 | 
275 | # If false, no module index is generated.
276 | # texinfo_domain_indices = True
277 | 
278 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
279 | # texinfo_show_urls = 'footnote'
280 | 


--------------------------------------------------------------------------------
/docs/dev.txt:
--------------------------------------------------------------------------------
  1 | ###########################
  2 | Contributing to the project
  3 | ###########################
  4 | 
  5 | This document provides guidelines for people who want to contribute to the
  6 | project.
  7 | 
  8 | 
  9 | **************
 10 | Create tickets
 11 | **************
 12 | 
 13 | Please use the `bugtracker`_ **before** starting some work:
 14 | 
 15 | * check if the bug or feature request has already been filed. It may have been
 16 |   answered too!
 17 | 
 18 | * else create a new ticket.
 19 | 
 20 | * if you plan to contribute, tell us, so that we are given an opportunity to
 21 |   give feedback as soon as possible.
 22 | 
 23 | * Then, in your commit messages, reference the ticket with some
 24 |   ``refs #TICKET-ID`` syntax.
 25 | 
 26 | 
 27 | ***************
 28 | Fork and branch
 29 | ***************
 30 | 
 31 | * Work in forks and branches.
 32 | 
 33 | * Prefix your branch with the ticket ID corresponding to the issue. As an
 34 |   example, if you are working on ticket #23 which is about contribute
 35 |   documentation, name your branch like ``23-contribute-doc``.
 36 | 
 37 | * If you work in a development branch and want to refresh it with changes from
 38 |   master, please `rebase`_ or `merge-based rebase`_, i.e. don't merge master.
 39 | 
 40 | 
 41 | *******************************
 42 | Setup a development environment
 43 | *******************************
 44 | 
 45 | 
 46 | ***********
 47 | Development
 48 | ***********
 49 | 
 50 | .. code-block:: console
 51 | 
 52 |     $ # Launch a postgres DB with:
 53 |     $ docker-compose up -d
 54 | 
 55 |     $ # Configure environment variables with
 56 |     $ export PGDATABASE=db PGHOST=localhost PGUSER=postgres PGPASSWORD=password
 57 |     $ export DJANGO_SETTINGS_MODULE=demoproject.settings
 58 | 
 59 |     $ # Create a virtualenv, activate it and install dev dependencies
 60 |     $ python3 -m venv .venv
 61 |     $ source .venv/bin/activate
 62 |     $ pip install -r requirements.txt
 63 | 
 64 |     $ # Launch tests with
 65 |     $ tox
 66 | 
 67 |     $ # Format code with
 68 |     $ tox -e format
 69 | 
 70 |     $ # Launch the demo
 71 |     $ python -m django runserver
 72 | 
 73 | *******
 74 | Release
 75 | *******
 76 | 
 77 | Release in GitHub, GitHub Actions should take care of the rest.
 78 | Note that there should be a release draft with a basic PR-based changelog, so
 79 | start from this and iterate.
 80 | 
 81 | *************
 82 | Documentation
 83 | *************
 84 | 
 85 | Follow `style guide for Sphinx-based documentations`_ when editing the
 86 | documentation.
 87 | 
 88 | 
 89 | **************
 90 | Test and build
 91 | **************
 92 | 
 93 | Use ``tox``.
 94 | 
 95 | *********************
 96 | Demo project included
 97 | *********************
 98 | 
 99 | The demo is part of the tests. Maintain it along with code and
100 | documentation.
101 | 
102 | 
103 | **********
104 | References
105 | **********
106 | 
107 | .. target-notes::
108 | 
109 | .. _`bugtracker`:
110 |    https://github.com/novapost/django-generic-filters/issues
111 | .. _`rebase`: http://git-scm.com/book/en/Git-Branching-Rebasing
112 | .. _`merge-based rebase`: http://tech.novapost.fr/psycho-rebasing-en.html
113 | .. _`Python`: http://python.org
114 | .. _`Virtualenv`: http://virtualenv.org
115 | .. _`style guide for Sphinx-based documentations`:
116 |    https://documentation-style-guide-sphinx.readthedocs.io/
117 | 


--------------------------------------------------------------------------------
/docs/index.txt:
--------------------------------------------------------------------------------
 1 | .. include:: ../README.rst
 2 | 
 3 | 
 4 | ********
 5 | Contents
 6 | ********
 7 | 
 8 | .. toctree::
 9 |    :maxdepth: 2
10 |    :titlesonly:
11 | 
12 |    install
13 |    api/index
14 |    about/index
15 |    dev
16 | 


--------------------------------------------------------------------------------
/docs/install.txt:
--------------------------------------------------------------------------------
1 | .. include:: ../INSTALL
2 | 


--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [build-system]
2 | requires = ["setuptools>=45", "wheel", "setuptools_scm>=6.2"]
3 | 
4 | [tool.setuptools_scm]
5 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | -e .[dev]
2 | 


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
 1 | [metadata]
 2 | name = django-generic-filters
 3 | description =
 4 |     Easy filters for your Generic ListView with Django.
 5 | author = PeopleDoc
 6 | author_email = peopleask@novapost.fr
 7 | url = https://github.com/peopledoc/django-generic-filters
 8 | project_urls =
 9 |     GitHub = https://github.com/peopledoc/django-generic-filters
10 |     Changelog = https://github.com/peopledoc/django-generic-filters/releases
11 |     Issue tracker = https://github.com/peopledoc/django-generic-filters/issues
12 |     Documentation = https://django-generic-filters.readthedocs.io
13 | long_description = file: README.rst
14 | keywords = class-based view, generic view, filters
15 | license = BSD
16 | classifiers =
17 |     Development Status :: 5 - Production/Stable
18 |     License :: OSI Approved :: BSD License
19 |     Programming Language :: Python :: 3
20 |     Programming Language :: Python :: 3.7
21 |     Programming Language :: Python :: 3.8
22 |     Programming Language :: Python :: 3.9
23 |     Programming Language :: Python :: 3.10
24 |     Framework :: Django :: 2.2
25 |     Framework :: Django :: 3.0
26 |     Framework :: Django :: 3.1
27 |     Framework :: Django :: 3.2
28 |     Framework :: Django :: 4.0
29 | 
30 | [options]
31 | zip_safe = True
32 | include_package_data = True
33 | packages = find:
34 | install_requires =
35 |     Django
36 |     munch
37 | 
38 | [options.extras_require]
39 | dev =
40 |     psycopg2
41 |     black
42 |     isort
43 |     flake8
44 |     pytest
45 |     pytest-cov
46 |     pytest-django
47 |     tox
48 |     factory-boy
49 | 
50 | [options.packages.find]
51 | include =
52 |     django_genericfilters
53 |     django_genericfilters.*
54 | 
55 | [tool:pytest]
56 | addopts =
57 |     --cov-report term-missing --cov-branch --cov-report html --cov-report term
58 |     --cov=django_genericfilters -vv --strict-markers -rfE
59 | testpaths =
60 |     django_genericfilters/tests
61 |     demoproject/tests.py
62 | filterwarnings =
63 |     # Uncomment below when testing a new version of Python or Django so that
64 |     # DeprecationWarnings can be treated as errors
65 |     # error
66 |     ignore:.*distutils Version classes are deprecated.*:DeprecationWarning
67 | 
68 | DJANGO_SETTINGS_MODULE = demoproject.settings
69 | 
70 | 
71 | 
72 | [isort]
73 | profile = black
74 | known_first_party = demoproject,django_genericfilters
75 | skip = .venv,.tox
76 | 
77 | [flake8]
78 | # This section ensures black and flake8 play nice together
79 | max-line-length = 88
80 | # E203: whitespace before colon on list slice: mylist[1 : 2]
81 | # E501: line too long (black knows better)
82 | extend-ignore = E203,E501
83 | extend-exclude = .venv
84 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | from setuptools import setup
2 | 
3 | setup()
4 | 


--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
 1 | # Tox (http://tox.testrun.org/) is a tool for running tests
 2 | # in multiple virtualenvs. This configuration file will run the
 3 | # test suite on all supported python versions. To use it, "pip install tox"
 4 | # and then run "tox" from this directory.
 5 | 
 6 | [tox]
 7 | isolated_build = true
 8 | envlist =
 9 |     # Making sure that each supported version of Python and each supported
10 |     # version of Django is tested but not each combination (quadratic)
11 |     # When changing this, remember to change the CI accordingly
12 |     py39-django{22,30,31,32,40},
13 |     py{37,38,310}-django{32},
14 |     lint
15 | 
16 | [testenv]
17 | usedevelop = True
18 | extras = dev
19 | deps =
20 |     django22: Django==2.2.*
21 |     django22: psycopg2<2.9  # https://github.com/django/django/commit/837ffcfa681d0f65f444d881ee3d69aec23770be
22 |     django30: Django==3.0.*
23 |     django30: psycopg2<2.9  # https://github.com/django/django/commit/837ffcfa681d0f65f444d881ee3d69aec23770be
24 |     django31: Django==3.1.*
25 |     django32: Django==3.2.*
26 |     django40: Django==4.0.*
27 | commands =
28 |     pytest {posargs}
29 | passenv =
30 |     PG*
31 | 
32 | [testenv:lint]
33 | skip_install = true
34 | basepython = python3
35 | commands =
36 |     flake8 demoproject django_genericfilters
37 |     black --check demoproject django_genericfilters
38 |     isort --check demoproject django_genericfilters
39 | deps =
40 |     flake8
41 |     black
42 |     isort
43 | 
44 | [testenv:format]
45 | skip_install = true
46 | basepython = python3
47 | commands =
48 |     black demoproject django_genericfilters
49 |     isort demoproject django_genericfilters
50 | deps =
51 |     black
52 |     isort
53 | 


--------------------------------------------------------------------------------