1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
from django import forms
from django.contrib import admin
from django.contrib.admin.widgets import AutocompleteSelect
from django.forms import ModelChoiceField
from django.test import TestCase, override_settings
from django.utils import translation
from .models import Album, Band, ReleaseEvent, VideoStream
class AlbumForm(forms.ModelForm):
class Meta:
model = Album
fields = ["band", "featuring"]
widgets = {
"band": AutocompleteSelect(
Album._meta.get_field("band"),
admin.site,
attrs={"class": "my-class"},
),
"featuring": AutocompleteSelect(
Album._meta.get_field("featuring"),
admin.site,
),
}
class NotRequiredBandForm(forms.Form):
band = ModelChoiceField(
queryset=Album.objects.all(),
widget=AutocompleteSelect(
Album._meta.get_field("band").remote_field, admin.site
),
required=False,
)
class RequiredBandForm(forms.Form):
band = ModelChoiceField(
queryset=Album.objects.all(),
widget=AutocompleteSelect(
Album._meta.get_field("band").remote_field, admin.site
),
required=True,
)
class VideoStreamForm(forms.ModelForm):
class Meta:
model = VideoStream
fields = ["release_event"]
widgets = {
"release_event": AutocompleteSelect(
VideoStream._meta.get_field("release_event"),
admin.site,
),
}
@override_settings(ROOT_URLCONF="admin_widgets.urls")
class AutocompleteMixinTests(TestCase):
empty_option = '<option value=""></option>'
maxDiff = 1000
def test_build_attrs(self):
form = AlbumForm()
attrs = form["band"].field.widget.get_context(
name="my_field", value=None, attrs={}
)["widget"]["attrs"]
self.assertEqual(
attrs,
{
"class": "my-class admin-autocomplete",
"data-ajax--cache": "true",
"data-ajax--delay": 250,
"data-ajax--type": "GET",
"data-ajax--url": "/autocomplete/",
"data-theme": "admin-autocomplete",
"data-allow-clear": "false",
"data-app-label": "admin_widgets",
"data-field-name": "band",
"data-model-name": "album",
"data-placeholder": "",
"lang": "en",
},
)
def test_build_attrs_no_custom_class(self):
form = AlbumForm()
attrs = form["featuring"].field.widget.get_context(
name="name", value=None, attrs={}
)["widget"]["attrs"]
self.assertEqual(attrs["class"], "admin-autocomplete")
def test_build_attrs_not_required_field(self):
form = NotRequiredBandForm()
attrs = form["band"].field.widget.build_attrs({})
self.assertJSONEqual(attrs["data-allow-clear"], True)
def test_build_attrs_required_field(self):
form = RequiredBandForm()
attrs = form["band"].field.widget.build_attrs({})
self.assertJSONEqual(attrs["data-allow-clear"], False)
def test_get_url(self):
rel = Album._meta.get_field("band")
w = AutocompleteSelect(rel, admin.site)
url = w.get_url()
self.assertEqual(url, "/autocomplete/")
def test_render_options(self):
beatles = Band.objects.create(name="The Beatles", style="rock")
who = Band.objects.create(name="The Who", style="rock")
# With 'band', a ForeignKey.
form = AlbumForm(initial={"band": beatles.uuid})
output = form.as_table()
selected_option = (
'<option value="%s" selected>The Beatles</option>' % beatles.uuid
)
option = '<option value="%s">The Who</option>' % who.uuid
self.assertIn(selected_option, output)
self.assertNotIn(option, output)
# With 'featuring', a ManyToManyField.
form = AlbumForm(initial={"featuring": [beatles.pk, who.pk]})
output = form.as_table()
selected_option = (
'<option value="%s" selected>The Beatles</option>' % beatles.pk
)
option = '<option value="%s" selected>The Who</option>' % who.pk
self.assertIn(selected_option, output)
self.assertIn(option, output)
def test_render_options_required_field(self):
"""Empty option is present if the field isn't required."""
form = NotRequiredBandForm()
output = form.as_table()
self.assertIn(self.empty_option, output)
def test_render_options_not_required_field(self):
"""Empty option isn't present if the field isn't required."""
form = RequiredBandForm()
output = form.as_table()
self.assertNotIn(self.empty_option, output)
def test_render_options_fk_as_pk(self):
beatles = Band.objects.create(name="The Beatles", style="rock")
rubber_soul = Album.objects.create(name="Rubber Soul", band=beatles)
release_event = ReleaseEvent.objects.create(
name="Test Target", album=rubber_soul
)
form = VideoStreamForm(initial={"release_event": release_event.pk})
output = form.as_table()
selected_option = (
'<option value="%s" selected>Test Target</option>' % release_event.pk
)
self.assertIn(selected_option, output)
def test_media(self):
rel = Album._meta.get_field("band").remote_field
base_files = (
"admin/js/vendor/jquery/jquery.min.js",
"admin/js/vendor/select2/select2.full.min.js",
# Language file is inserted here.
"admin/js/jquery.init.js",
"admin/js/autocomplete.js",
)
languages = (
("de", "de"),
# Subsequent language codes are used when the language code is not
# supported.
("de-at", "de"),
("de-ch-1901", "de"),
("en-latn-us", "en"),
("nl-nl-x-informal", "nl"),
("zh-hans-HK", "zh-CN"),
# Language with code 00 does not exist.
("00", None),
# Language files are case sensitive.
("sr-cyrl", "sr-Cyrl"),
("zh-hans", "zh-CN"),
("zh-hant", "zh-TW"),
(None, None),
)
for lang, select_lang in languages:
with self.subTest(lang=lang):
if select_lang:
expected_files = (
base_files[:2]
+ (("admin/js/vendor/select2/i18n/%s.js" % select_lang),)
+ base_files[2:]
)
else:
expected_files = base_files
with translation.override(lang):
self.assertEqual(
AutocompleteSelect(rel, admin.site).media._js,
list(expected_files),
)
|
