Compare commits

...

24 commits

Author SHA1 Message Date
Benbb96
e7fa49a6e2
Prevent literal "None" placeholders (#591) 2020-02-25 11:50:21 +01:00
Johannes Hoppe
39ab326884 Add support for Django 3.0 2020-01-05 17:23:31 +01:00
Mario Frasca
d63f410bca Improve getting started documentation (#542) 2019-12-13 14:52:03 +01:00
Adrien Delhorme
5680f0daf9 Update Select2 library to version 4.0.12 2019-11-21 22:27:02 +07:00
Johannes Hoppe
8deb2b6a11
Create FUNDING.yml 2019-10-30 10:09:30 +09:00
Johannes Hoppe
37e2515be6
Add name to setup.py to enable GH dependency graph 2019-10-29 11:30:12 +09:00
Johannes Hoppe
cc8989a625 Fix typo 2019-10-10 13:09:03 -10:00
Johannes Hoppe
1ae52d7436 Fix #574 -- Update jQuery documentation
Update jQuery documentation to reflect jQuery versino support.
2019-10-10 13:09:03 -10:00
Johannes Hoppe
dca7dbc5d1 Fix #565 -- Support empty_label on ModelSelect fields. 2019-08-26 17:13:27 +02:00
predatell
8bd7f7209f Try to get queryset form choices, if possible (#509)
Get queryset for model widgets from choices. This omits the need to explicitly supply a queryset or model to the widget.
2019-07-09 18:38:59 +02:00
Johannes Hoppe
6b1ca10b06 Fix typo 2019-07-08 18:57:23 +02:00
Johannes Hoppe
4f96e21333 Resolve #557 -- Improve documentation for ModelSelect2TagWidget 2019-07-08 18:57:23 +02:00
Johannes Hoppe
8494b10fcc Fix pycodestyle issue 2019-06-10 18:03:23 +02:00
Johannes Hoppe
ff68bf1050 Fix #550 -- Omit tests from wheel 2019-06-10 18:03:23 +02:00
Mario Frasca
c15de464d5 Fix #544 -- Ensure correct attribute defaults (#547)
dict.setdefault() does not change the default value if called twice.
Therefore, defaults need to passed to the super call instead.
2019-06-10 17:09:04 +02:00
Vipul Chaudhary
898b2e84dd Fix #418 –– Remove extra Q created in the ORM query (#548)
The iterator for reduce function should not have the first element
select &= reduce(lambda x, y: x | Q(**{y: t}), search_fields[1:], Q(**{search_fields[0]: t}))
2019-06-10 16:57:17 +02:00
Pablo Montepagano
1e4056bd62 fixed typo in docs 2019-06-10 16:54:36 +02:00
Johannes Hoppe
2bb6f3a974 Set Sphinx project settings in conf.py file 2019-04-11 12:29:40 +02:00
Johannes Hoppe
fa9d8baba8 Set master_doc for readthedocs 2019-04-11 12:21:12 +02:00
Johannes Hoppe
df5bf9e893 Fix travis deployment pipeline 2019-04-10 14:05:57 +02:00
Johannes Hoppe
4d0d702aaf Don't skip after_success 2019-04-10 13:50:22 +02:00
Johannes Hoppe
0c82edf65c Fix release process 2019-04-10 13:34:15 +02:00
Johannes Hoppe
0021f35b2a Use setuptools_scm for versioning 2019-04-10 11:58:40 +02:00
Johannes Hoppe
ad42a01083 Fix #535 -- Add static files to dist package 2019-04-10 11:58:40 +02:00
17 changed files with 285 additions and 148 deletions

2
.github/FUNDING.yml vendored Normal file
View file

@ -0,0 +1,2 @@
github: codingjoe
custom: https://paypal.me/codingjoe

3
.gitignore vendored
View file

@ -20,3 +20,6 @@ venv/
geckodriver.log geckodriver.log
ghostdriver.log ghostdriver.log
.coverage .coverage
coverage.xml
.eggs/

View file

@ -4,10 +4,10 @@ dist: xenial
python: python:
- "3.6" - "3.6"
- "3.7" - "3.7"
- "3.8"
env: env:
- DJANGO=20
- DJANGO=21
- DJANGO=22 - DJANGO=22
- DJANGO=30
- DJANGO=master - DJANGO=master
matrix: matrix:
@ -34,9 +34,14 @@ script: tox
after_success: codecov after_success: codecov
stages:
- test
- name: deploy
if: tag is present
jobs: jobs:
include: include:
- python: "3.5" - python: "3.7"
env: TOXENV=docs env: TOXENV=docs
addons: addons:
apt: apt:
@ -51,29 +56,32 @@ jobs:
node_js: lts/* node_js: lts/*
cache: npm cache: npm
- stage: deploy - stage: deploy
if: tag IS present python: "3.8"
python: 3.7
install: skip install: skip
script: skip script: skip
after_success: skip after_success: true
deploy:
before_deploy: provider: pypi
- git stash --all distributions: sdist bdist_wheel
- ./set_version.py on:
_deploy_provider: &_deploy_provider tags: true
skip_cleanup: true user: codingjoe
on: password:
tags: true secure: fEP9K7y0ZF9fRvQEUN4kgPXQEZvi3Cx3ikUebG2UM/2uhcaUQm0+KpgZ2S+lvOTYcBnNgzPzFsVIZMcVcTxwIKuQDEMq9y2eop2hnisb9KXsIm9qPYSzOnRm74VuiOt4hNOZMe0qVBK2cO3vC9NDXuzdI8A0JynJhthfl4t+kFM=
repo: applegrew/django-select2 - stage: deploy
deploy: language: node_js
- <<: *_deploy_provider node_js: lts/*
provider: pypi python: "3.8"
distributions: sdist bdist_wheel install: skip
user: codingjoe script: skip
password: after_success: true
secure: fEP9K7y0ZF9fRvQEUN4kgPXQEZvi3Cx3ikUebG2UM/2uhcaUQm0+KpgZ2S+lvOTYcBnNgzPzFsVIZMcVcTxwIKuQDEMq9y2eop2hnisb9KXsIm9qPYSzOnRm74VuiOt4hNOZMe0qVBK2cO3vC9NDXuzdI8A0JynJhthfl4t+kFM= skip_cleanup: true
- <<: *_deploy_provider before_deploy:
provider: npm - ./set_version.py
email: info@johanneshoppe.com deploy:
api_key: provider: npm
secure: PV38cQx9qhEFkpSdytbM72UzIMCfhpjmRJ8dzT+bCAaOIs5rEcyKN+h1r5ranunCxWyuFsMW4A2iW/SCxnKCR/oPAguuwUbT5ogBXlsskqPFWUxuoTHYMrd+zB+SC6+bMgq+o5ul+kJCYtEkWP6cMlIEzKyTLab7m5PsnDXNVnI= on:
tags: true
email: info@johanneshoppe.com
api_key:
secure: PV38cQx9qhEFkpSdytbM72UzIMCfhpjmRJ8dzT+bCAaOIs5rEcyKN+h1r5ranunCxWyuFsMW4A2iW/SCxnKCR/oPAguuwUbT5ogBXlsskqPFWUxuoTHYMrd+zB+SC6+bMgq+o5ul+kJCYtEkWP6cMlIEzKyTLab7m5PsnDXNVnI=

22
CONTRIBUTING.rst Normal file
View file

@ -0,0 +1,22 @@
Contributing
============
This package uses the pyTest test runner. To run the tests locally simply run::
python setup.py test
If you need to the development dependencies installed of you local IDE, you can run::
python setup.py develop
Documentation pull requests welcome. The Sphinx documentation can be compiled via::
python setup.py build_sphinx
Bug reports welcome, even more so if they include a correct patch. Much
more so if you start your patch by adding a failing unit test, and correct
the code until zero unit tests fail.
The list of supported Django and Python version can be found in the CI suite setup.
Please make sure to verify that none of the linters or tests failed, before you submit
a patch for review.

6
MANIFEST.in Normal file
View file

@ -0,0 +1,6 @@
include django_select2/static/django_select2/django_select2.js
prune tests
prune .github
exclude .fussyfox.yml
exclude .travis.yml
exclude .gitignore

View file

@ -8,7 +8,7 @@ __all__ = ('settings', 'Select2Conf')
class Select2Conf(AppConf): class Select2Conf(AppConf):
"""Settings for Django-Select2.""" """Settings for Django-Select2."""
LIB_VERSION = '4.0.5' LIB_VERSION = '4.0.12'
"""Version of the Select2 library.""" """Version of the Select2 library."""
CACHE_BACKEND = 'default' CACHE_BACKEND = 'default'

View file

@ -20,10 +20,11 @@ Widgets are generally of two types:
drop-in-replacement for Django's default drop-in-replacement for Django's default
select widgets. select widgets.
2. **Heavy** -- 2(a). **Heavy** --
They are suited for scenarios when the number of options They are suited for scenarios when the number of options
are large and need complex queries (from maybe different are large and need complex queries (from maybe different
sources) to get the options. sources) to get the options.
This dynamic fetching of options undoubtedly requires This dynamic fetching of options undoubtedly requires
Ajax communication with the server. Django-Select2 includes Ajax communication with the server. Django-Select2 includes
a helper JS file which is included automatically, a helper JS file which is included automatically,
@ -31,15 +32,15 @@ Widgets are generally of two types:
Although on the server side you do need to create a view Although on the server side you do need to create a view
specifically to respond to the queries. specifically to respond to the queries.
3. **Model** -- 2(b). **Model** --
Model-widgets are a further specialized versions of Heavies. Model-widgets are a further specialized versions of Heavies.
These do not require views to serve Ajax requests. These do not require views to serve Ajax requests.
When they are instantiated, they register themselves When they are instantiated, they register themselves
with one central view which handles Ajax requests for them. with one central view which handles Ajax requests for them.
Heavy widgets have the word 'Heavy' in their name. Heavy and Model widgets have respectively the word 'Heavy' and 'Model' in
Light widgets are normally named, i.e. there is no their name. Light widgets are normally named, i.e. there is no 'Light' word
'Light' word in their names. in their names.
.. inheritance-diagram:: django_select2.forms .. inheritance-diagram:: django_select2.forms
:parts: 1 :parts: 1
@ -70,16 +71,20 @@ class Select2Mixin:
form media. form media.
""" """
def build_attrs(self, *args, **kwargs): empty_label = ''
"""Add select2 data attributes."""
attrs = super(Select2Mixin, self).build_attrs(*args, **kwargs) def build_attrs(self, base_attrs, extra_attrs=None):
if self.is_required: """Add select2 data attributes."""
attrs.setdefault('data-allow-clear', 'false') default_attrs = {'data-minimum-input-length': 0}
else: if self.is_required:
attrs.setdefault('data-allow-clear', 'true') default_attrs['data-allow-clear'] = 'false'
attrs.setdefault('data-placeholder', '') else:
default_attrs['data-allow-clear'] = 'true'
default_attrs['data-placeholder'] = self.empty_label or ""
default_attrs.update(base_attrs)
attrs = super().build_attrs(default_attrs, extra_attrs=extra_attrs)
attrs.setdefault('data-minimum-input-length', 0)
if 'class' in attrs: if 'class' in attrs:
attrs['class'] += ' django-select2' attrs['class'] += ' django-select2'
else: else:
@ -120,12 +125,15 @@ class Select2Mixin:
class Select2TagMixin: class Select2TagMixin:
"""Mixin to add select2 tag functionality.""" """Mixin to add select2 tag functionality."""
def build_attrs(self, *args, **kwargs): def build_attrs(self, base_attrs, extra_attrs=None):
"""Add select2's tag attributes.""" """Add select2's tag attributes."""
self.attrs.setdefault('data-minimum-input-length', 1) default_attrs = {
self.attrs.setdefault('data-tags', 'true') 'data-minimum-input-length': 1,
self.attrs.setdefault('data-token-separators', '[",", " "]') 'data-tags': 'true',
return super(Select2TagMixin, self).build_attrs(*args, **kwargs) 'data-token-separators': '[",", " "]'
}
default_attrs.update(base_attrs)
return super().build_attrs(default_attrs, extra_attrs=extra_attrs)
class Select2Widget(Select2Mixin, forms.Select): class Select2Widget(Select2Mixin, forms.Select):
@ -203,6 +211,7 @@ class HeavySelect2Mixin:
widget could be dependent on a country. widget could be dependent on a country.
Key is a name of a field in a form. Key is a name of a field in a form.
Value is a name of a field in a model (used in `queryset`). Value is a name of a field in a model (used in `queryset`).
""" """
self.choices = choices self.choices = choices
if attrs is not None: if attrs is not None:
@ -226,20 +235,26 @@ class HeavySelect2Mixin:
return self.data_url return self.data_url
return reverse(self.data_view) return reverse(self.data_view)
def build_attrs(self, *args, **kwargs): def build_attrs(self, base_attrs, extra_attrs=None):
"""Set select2's AJAX attributes.""" """Set select2's AJAX attributes."""
attrs = super(HeavySelect2Mixin, self).build_attrs(*args, **kwargs) default_attrs = {
'data-ajax--url': self.get_url(),
'data-ajax--cache': "true",
'data-ajax--type': "GET",
'data-minimum-input-length': 2,
}
if self.dependent_fields:
default_attrs['data-select2-dependent-fields'] = " ".join(self.dependent_fields)
default_attrs.update(base_attrs)
attrs = super().build_attrs(default_attrs, extra_attrs=extra_attrs)
# encrypt instance Id # encrypt instance Id
self.widget_id = signing.dumps(id(self)) self.widget_id = signing.dumps(id(self))
attrs['data-field_id'] = self.widget_id attrs['data-field_id'] = self.widget_id
attrs.setdefault('data-ajax--url', self.get_url())
attrs.setdefault('data-ajax--cache', "true")
attrs.setdefault('data-ajax--type', "GET")
attrs.setdefault('data-minimum-input-length', 2)
if self.dependent_fields:
attrs.setdefault('data-select2-dependent-fields', " ".join(self.dependent_fields))
attrs['class'] += ' django-select2-heavy' attrs['class'] += ' django-select2-heavy'
return attrs return attrs
@ -328,6 +343,12 @@ class ModelSelect2Mixin:
max_results = 25 max_results = 25
"""Maximal results returned by :class:`.AutoResponseView`.""" """Maximal results returned by :class:`.AutoResponseView`."""
@property
def empty_label(self):
if isinstance(self.choices, ModelChoiceIterator):
return self.choices.field.empty_label
return ''
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
""" """
Overwrite class parameters if passed as keyword arguments. Overwrite class parameters if passed as keyword arguments.
@ -391,7 +412,7 @@ class ModelSelect2Mixin:
term = term.replace('\t', ' ') term = term.replace('\t', ' ')
term = term.replace('\n', ' ') term = term.replace('\n', ' ')
for t in [t for t in term.split(' ') if not t == '']: for t in [t for t in term.split(' ') if not t == '']:
select &= reduce(lambda x, y: x | Q(**{y: t}), search_fields, select &= reduce(lambda x, y: x | Q(**{y: t}), search_fields[1:],
Q(**{search_fields[0]: t})) Q(**{search_fields[0]: t}))
if dependent_fields: if dependent_fields:
select &= Q(**dependent_fields) select &= Q(**dependent_fields)
@ -408,6 +429,8 @@ class ModelSelect2Mixin:
""" """
if self.queryset is not None: if self.queryset is not None:
queryset = self.queryset queryset = self.queryset
elif hasattr(self.choices, 'queryset'):
queryset = self.choices.queryset
elif self.model is not None: elif self.model is not None:
queryset = self.model._default_manager.all() queryset = self.model._default_manager.all()
else: else:
@ -541,14 +564,15 @@ class ModelSelect2TagWidget(ModelSelect2Mixin, HeavySelect2TagWidget):
queryset = MyModel.objects.all() queryset = MyModel.objects.all()
def value_from_datadict(self, data, files, name): def value_from_datadict(self, data, files, name):
values = super().value_from_datadict(self, data, files, name) '''Create objects for given non-pimary-key values. Return list of all primary keys.'''
qs = self.queryset.filter(**{'pk__in': list(values)}) values = set(super().value_from_datadict(data, files, name))
pks = set(str(getattr(o, pk)) for o in qs) # This may only work for MyModel, if MyModel has title field.
cleaned_values = [] # You need to implement this method yourself, to ensure proper object creation.
for val in value: pks = self.queryset.filter(**{'pk__in': list(values)}).values_list('pk', flat=True)
if str(val) not in pks: pks = set(map(str, pks))
val = queryset.create(title=val).pk cleaned_values = list(values)
cleaned_values.append(val) for val in values - pks:
cleaned_values.append(self.queryset.create(title=val).pk)
return cleaned_values return cleaned_values
""" """

1
docs/CONTRIBUTING.rst Normal file
View file

@ -0,0 +1 @@
.. include:: ../CONTRIBUTING.rst

View file

@ -1,6 +1,8 @@
import os import os
import sys import sys
from pkg_resources import get_distribution
# This is needed since django_select2 requires django model modules # This is needed since django_select2 requires django model modules
# and those modules assume that django settings is configured and # and those modules assume that django settings is configured and
# have proper DB settings. # have proper DB settings.
@ -13,6 +15,17 @@ os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.testapp.settings")
sys.path.insert(0, os.path.abspath('../tests.testapp')) sys.path.insert(0, os.path.abspath('../tests.testapp'))
sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('..'))
project = "Django-Select2"
author = "Johannes Hoppe"
copyright = "2017, Johannes Hoppe"
release = get_distribution('django_select2').version
version = '.'.join(release.split('.')[:2])
master_doc = 'index' # default in Sphinx v2
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',

View file

@ -49,8 +49,9 @@ DjangoSelect2 handles the initialization of select2 fields automatically. Just i
``{{ form.media.js }}`` in your template before the closing ``body`` tag. That's it! ``{{ form.media.js }}`` in your template before the closing ``body`` tag. That's it!
If you insert forms after page load or if you want to handle the initialization If you insert forms after page load or if you want to handle the initialization
yourself, DjangoSelect2 provides a jQuery plugin. It will handle both normal and yourself, DjangoSelect2 provides a jQuery plugin, replacing and enhancing the Select2
heavy fields. Simply call ``djangoSelect2(options)`` on your select fields.:: plugin. It will handle both normal and heavy fields. Simply call
``djangoSelect2(options)`` on your select fields.::
$('.django-select2').djangoSelect2(); $('.django-select2').djangoSelect2();
@ -59,6 +60,9 @@ You can pass see `Select2 options <https://select2.github.io/options.html>`_ if
$('.django-select2').djangoSelect2({placeholder: 'Select an option'}); $('.django-select2').djangoSelect2({placeholder: 'Select an option'});
Please replace all your ``.select2`` invocations with the here provided
``.djangoSelect2``.
Security & Authentication Security & Authentication
------------------------- -------------------------
@ -81,6 +85,6 @@ want to be accessible to the general public. Doing so is easy::
kwargs['data_view'] = 'user-select2-view' kwargs['data_view'] = 'user-select2-view'
super(UserSelect2WidgetMixin, self).__init__(*args, **kwargs) super(UserSelect2WidgetMixin, self).__init__(*args, **kwargs)
class MySecretWidget(UserSelect2WidgetMixin, Select2ModelWidget): class MySecretWidget(UserSelect2WidgetMixin, ModelSelect2Widget):
model = MySecretModel model = MySecretModel
search_fields = ['title__icontains'] search_fields = ['title__icontains']

View file

@ -8,6 +8,12 @@ Overview
.. automodule:: django_select2 .. automodule:: django_select2
:members: :members:
Assumptions
-----------
* You have a running Django up and running.
* You have form fully working without Django-Select2.
Installation Installation
------------ ------------
@ -17,11 +23,12 @@ Installation
2. Add ``django_select2`` to your ``INSTALLED_APPS`` in your project settings. 2. Add ``django_select2`` to your ``INSTALLED_APPS`` in your project settings.
3. Add ``django_select`` to your ``urlconf``::
3. Add ``django_select`` to your ``urlconf`` **if** you use any path('select2/', include('django_select2.urls')),
:class:`ModelWidgets <.django_select2.forms.ModelSelect2Mixin>`::
url(r'^select2/', include('django_select2.urls')), You can safely skip this one if you do not use any
:class:`ModelWidgets <.django_select2.forms.ModelSelect2Mixin>`
Quick Start Quick Start
----------- -----------
@ -30,19 +37,22 @@ Here is a quick example to get you started:
0. Follow the installation instructions above. 0. Follow the installation instructions above.
1. Add a select2 widget to the form. For example if you wanted Select2 with multi-select you would use 1. Replace native Django forms widgets with one of the several ``django_select2.form`` widgets.
``Select2MultipleWidget`` Start by importing them into your ``forms.py``, right next to Django own ones::
Replacing::
class MyForm(forms.Form): from django import forms
things = ModelMultipleChoiceField(queryset=Thing.objects.all()) from django_select2 import forms as s2forms
with:: Then let's assume you have a model with a choice, a :class:`.ForeignKey`, and a
:class:`.ManyToManyField`, you would add this information to your Form Meta
class::
from django_select2.forms import Select2MultipleWidget widgets = {
'category': s2forms.Select2Widget,
class MyForm(forms.Form): 'author': s2forms.ModelSelect2Widget(model=auth.get_user_model(),
things = ModelMultipleChoiceField(queryset=Thing.objects.all(), widget=Select2MultipleWidget) search_fields=['first_name__istartswith', 'last_name__icontains']),
'attending': s2forms.ModelSelect2MultipleWidget …
}
2. Add the CSS to the ``head`` of your Django template:: 2. Add the CSS to the ``head`` of your Django template::
@ -57,9 +67,9 @@ with::
External Dependencies External Dependencies
--------------------- ---------------------
* jQuery version 2 * jQuery (version >=2)
This is not included in the package since it is expected jQuery is not included in the package since it is expected
that in most scenarios this would already be available. that in most scenarios jQuery is already loaded.
Example Application Example Application
------------------- -------------------

View file

@ -15,6 +15,7 @@ Contents:
get_started get_started
django_select2 django_select2
extra extra
CONTRIBUTING
Indices and tables Indices and tables
================== ==================

View file

@ -19,12 +19,12 @@ classifier =
[options] [options]
include_package_data = True include_package_data = True
packages = find: packages = django_select2
install_requires = install_requires =
django>=2.0 django>=2.2
django-appconf>=0.6.0 django-appconf>=0.6.0
setup_requires = setup_requires =
very-good-setuptools-git-version setuptools_scm
sphinx sphinx
pytest-runner pytest-runner
tests_require = tests_require =
@ -33,13 +33,6 @@ tests_require =
pytest-django pytest-django
selenium selenium
[options.package_data]
* = *.txt, *.rst, *.html, *.po
[options.packages.find]
exclude =
tests
[bdist_wheel] [bdist_wheel]
universal = 1 universal = 1
@ -54,22 +47,19 @@ test = pytest
[build_sphinx] [build_sphinx]
source-dir = docs source-dir = docs
build-dir = docs/_build build-dir = docs/_build
project = Django-Select2
copyright = 2017 Johannes Hoppe
[tool:pytest] [tool:pytest]
addopts = --cov=django_select2 --cov-report xml addopts = --cov=django_select2 --cov-report xml
DJANGO_SETTINGS_MODULE=tests.testapp.settings DJANGO_SETTINGS_MODULE=tests.testapp.settings
[tox:tox] [tox:tox]
envlist = py{35,36,37}-dj{22,21,20,master},docs envlist = py{36,37,38}-dj{22,30,master},docs
[testenv] [testenv]
passenv=CI passenv=CI
deps = deps =
dj20: https://github.com/django/django/archive/stable/2.0.x.tar.gz#egg=django dj22: django~=2.2
dj21: https://github.com/django/django/archive/stable/2.1.x.tar.gz#egg=django dj30: django~=3.0
dj22: https://github.com/django/django/archive/stable/2.2.x.tar.gz#egg=django
djmaster: https://github.com/django/django/archive/master.tar.gz#egg=django djmaster: https://github.com/django/django/archive/master.tar.gz#egg=django
commands = python setup.py test commands = python setup.py test

View file

@ -2,4 +2,4 @@
from setuptools import setup from setuptools import setup
setup(version_format='{tag}') setup(name='django-select2', use_scm_version=True)

View file

@ -2,7 +2,6 @@ import random
import string import string
import pytest import pytest
from django.utils.encoding import force_text
from selenium import webdriver from selenium import webdriver
from selenium.common.exceptions import WebDriverException from selenium.common.exceptions import WebDriverException
@ -26,7 +25,7 @@ def driver():
try: try:
b = webdriver.Chrome(options=chrome_options) b = webdriver.Chrome(options=chrome_options)
except WebDriverException as e: except WebDriverException as e:
pytest.skip(force_text(e)) pytest.skip(str(e))
else: else:
yield b yield b
b.quit() b.quit()

View file

@ -95,7 +95,9 @@ class TestSelect2Mixin:
multiple_select = self.multiple_form.fields['featured_artists'] multiple_select = self.multiple_form.fields['featured_artists']
assert multiple_select.required is False assert multiple_select.required is False
assert multiple_select.widget.allow_multiple_selected assert multiple_select.widget.allow_multiple_selected
assert '<option value=""></option>' not in multiple_select.widget.render('featured_artists', None) output = multiple_select.widget.render('featured_artists', None)
assert '<option value=""></option>' not in output
assert 'data-placeholder=""' in output
def test_i18n(self): def test_i18n(self):
translation.activate('de') translation.activate('de')
@ -217,12 +219,17 @@ class TestHeavySelect2Mixin(TestSelect2Mixin):
driver.find_element_by_css_selector('.select2-results') driver.find_element_by_css_selector('.select2-results')
elem1, elem2 = driver.find_elements_by_css_selector('.select2-selection') elem1, elem2 = driver.find_elements_by_css_selector('.select2-selection')
elem1.click()
elem1.click()
search1 = driver.find_element_by_css_selector('.select2-search__field')
search1.send_keys('fo')
result1 = WebDriverWait(driver, 60).until( result1 = WebDriverWait(driver, 60).until(
expected_conditions.presence_of_element_located((By.CSS_SELECTOR, '.select2-results li:first-child')) expected_conditions.presence_of_element_located((By.CSS_SELECTOR, '.select2-results li:first-child'))
).text ).text
elem2.click() elem2.click()
search2 = driver.find_element_by_css_selector('.select2-search__field')
search2.send_keys('fo')
result2 = WebDriverWait(driver, 60).until( result2 = WebDriverWait(driver, 60).until(
expected_conditions.presence_of_element_located((By.CSS_SELECTOR, '.select2-results li:first-child')) expected_conditions.presence_of_element_located((By.CSS_SELECTOR, '.select2-results li:first-child'))
).text ).text
@ -315,6 +322,37 @@ class TestModelSelect2Mixin(TestHeavySelect2Mixin):
widget.queryset = Genre.objects.all() widget.queryset = Genre.objects.all()
assert isinstance(widget.get_queryset(), QuerySet) assert isinstance(widget.get_queryset(), QuerySet)
def test_tag_attrs_Select2Widget(self):
widget = Select2Widget()
output = widget.render('name', 'value')
assert 'data-minimum-input-length="0"' in output
def test_custom_tag_attrs_Select2Widget(self):
widget = Select2Widget(attrs={'data-minimum-input-length': '3'})
output = widget.render('name', 'value')
assert 'data-minimum-input-length="3"' in output
def test_tag_attrs_ModelSelect2Widget(self):
widget = ModelSelect2Widget(queryset=Genre.objects.all(), search_fields=['title__icontains'])
output = widget.render('name', 'value')
assert 'data-minimum-input-length="2"' in output
def test_tag_attrs_ModelSelect2TagWidget(self):
widget = ModelSelect2TagWidget(queryset=Genre.objects.all(), search_fields=['title__icontains'])
output = widget.render('name', 'value')
assert 'data-minimum-input-length="2"' in output
def test_tag_attrs_HeavySelect2Widget(self):
widget = HeavySelect2Widget(data_url='/foo/bar/')
output = widget.render('name', 'value')
assert 'data-minimum-input-length="2"' in output
def test_custom_tag_attrs_ModelSelect2Widget(self):
widget = ModelSelect2Widget(
queryset=Genre.objects.all(), search_fields=['title__icontains'], attrs={'data-minimum-input-length': '3'})
output = widget.render('name', 'value')
assert 'data-minimum-input-length="3"' in output
def test_get_search_fields(self): def test_get_search_fields(self):
widget = ModelSelect2Widget() widget = ModelSelect2Widget()
with pytest.raises(NotImplementedError): with pytest.raises(NotImplementedError):
@ -376,13 +414,21 @@ class TestModelSelect2Mixin(TestHeavySelect2Mixin):
form = forms.GroupieForm(instance=groupie) form = forms.GroupieForm(instance=groupie)
assert '<option value="Take That" selected>TAKE THAT</option>' in form.as_p() assert '<option value="Take That" selected>TAKE THAT</option>' in form.as_p()
def test_empty_label(self, db):
# Empty options is only required for single selects
# https://select2.github.io/options.html#allowClear
single_select = self.form.fields['primary_genre']
single_select.empty_label = 'Hello World'
assert single_select.required is False
assert 'data-placeholder="Hello World"' in single_select.widget.render('primary_genre', None)
class TestHeavySelect2TagWidget(TestHeavySelect2Mixin): class TestHeavySelect2TagWidget(TestHeavySelect2Mixin):
def test_tag_attrs(self): def test_tag_attrs(self):
widget = ModelSelect2TagWidget(queryset=Genre.objects.all(), search_fields=['title__icontains']) widget = ModelSelect2TagWidget(queryset=Genre.objects.all(), search_fields=['title__icontains'])
output = widget.render('name', 'value') output = widget.render('name', 'value')
assert 'data-minimum-input-length="1"' in output assert 'data-minimum-input-length="2"' in output
assert 'data-tags="true"' in output assert 'data-tags="true"' in output
assert 'data-token-separators' in output assert 'data-token-separators' in output

View file

@ -149,11 +149,19 @@ class HeavySelect2WidgetForm(forms.Form):
class HeavySelect2MultipleWidgetForm(forms.Form): class HeavySelect2MultipleWidgetForm(forms.Form):
title = forms.CharField(max_length=50) title = forms.CharField(max_length=50)
genres = forms.MultipleChoiceField( genres = forms.MultipleChoiceField(
widget=HeavySelect2MultipleWidget(data_view='heavy_data_1', choices=NUMBER_CHOICES), widget=HeavySelect2MultipleWidget(
data_view='heavy_data_1',
choices=NUMBER_CHOICES,
attrs={'data-minimum-input-length': 0},
),
choices=NUMBER_CHOICES choices=NUMBER_CHOICES
) )
featured_artists = forms.MultipleChoiceField( featured_artists = forms.MultipleChoiceField(
widget=HeavySelect2MultipleWidget(data_view='heavy_data_2', choices=NUMBER_CHOICES), widget=HeavySelect2MultipleWidget(
data_view='heavy_data_2',
choices=NUMBER_CHOICES,
attrs={'data-minimum-input-length': 0},
),
choices=NUMBER_CHOICES, choices=NUMBER_CHOICES,
required=False required=False
) )
@ -178,10 +186,10 @@ class AddressChainedSelect2WidgetForm(forms.Form):
queryset=Country.objects.all(), queryset=Country.objects.all(),
label='Country', label='Country',
widget=ModelSelect2Widget( widget=ModelSelect2Widget(
model=Country,
search_fields=['name__icontains'], search_fields=['name__icontains'],
max_results=500, max_results=500,
dependent_fields={'city': 'cities'}, dependent_fields={'city': 'cities'},
attrs={'data-minimum-input-length': 0},
) )
) )
@ -189,10 +197,10 @@ class AddressChainedSelect2WidgetForm(forms.Form):
queryset=City.objects.all(), queryset=City.objects.all(),
label='City', label='City',
widget=ModelSelect2Widget( widget=ModelSelect2Widget(
model=City,
search_fields=['name__icontains'], search_fields=['name__icontains'],
dependent_fields={'country': 'country'}, dependent_fields={'country': 'country'},
max_results=500, max_results=500,
attrs={'data-minimum-input-length': 0},
) )
) )