event_rsvp.models: 132 total statements, 84.8% covered

Generated: Tue 2013-04-16 10:12 CEST

Source file: /home/tobi/Projects/event-rsvp/src/event_rsvp/models.py

Stats: 95 executed, 17 missed, 20 excluded, 230 ignored

1. """Models for the ``event_rsvp`` application."""
2. from django import forms
3. from django.core import exceptions
4. from django.core.urlresolvers import reverse
5. from django.db import models
6. from django.template.defaultfilters import date, slugify
7. from django.utils import timezone
8. from django.utils.text import capfirst
9. from django.utils.translation import ugettext
10. from django.utils.translation import ugettext_lazy as _
13. class MultiSelectFormField(forms.MultipleChoiceField):
14. widget = forms.CheckboxSelectMultiple
16. def clean(self, value):
17. if not value and self.required:
18. raise forms.ValidationError(self.error_messages['required'])
19. return value
22. class MultiSelectField(models.Field):
23. __metaclass__ = models.SubfieldBase
25. def get_internal_type(self):
26. return "CharField"
28. def get_choices_default(self):
29. return self.get_choices(include_blank=False)
31. def formfield(self, **kwargs):
32. # don't call super, as that overrides default widget if it has choices
33. defaults = {'required': not self.blank,
34. 'label': capfirst(self.verbose_name),
35. 'help_text': self.help_text, 'choices': self.choices}
36. if self.has_default():
37. defaults['initial'] = self.get_default()
38. defaults.update(kwargs)
39. return MultiSelectFormField(**defaults)
41. def get_prep_value(self, value):
42. return value
44. def get_db_prep_value(self, value, connection=None, prepared=False):
45. if isinstance(value, basestring):
46. return value
47. elif isinstance(value, list):
48. return ",".join(value)
50. def to_python(self, value):
51. if value is not None:
52. return value if isinstance(value, list) else value.split(',')
53. return ''
55. def contribute_to_class(self, cls, name):
56. super(MultiSelectField, self).contribute_to_class(cls, name)
57. if self.choices:
58. func = lambda self, fieldname = name, choicedict = dict(
59. self.choices): ",".join([choicedict.get(
60. value, value) for value in getattr(self, fieldname)])
61. setattr(cls, 'get_%s_display' % self.name, func)
63. def validate(self, value, model_instance):
64. arr_choices = self.get_choices_selected(self.get_choices_default())
65. for opt_select in value:
66. if opt_select not in arr_choices:
67. raise exceptions.ValidationError(
68. self.error_messages['invalid_choice'] % value)
69. return
71. def get_choices_selected(self, arr_choices=''):
72. if not arr_choices:
73. return False
74. list = []
75. for choice_selected in arr_choices:
76. list.append(choice_selected[0])
77. return list
79. def value_to_string(self, obj):
80. value = self._get_val_from_obj(obj)
81. return self.get_db_prep_value(value)
84. from south.modelsinspector import add_introspection_rules
85. add_introspection_rules([], ["^event_rsvp\.models\.MultiSelectField"])
88. class Event(models.Model):
89. """
90. Model to create event templates for recurring events etc.
92. :created_by: User, who owns this template.
93. :creation_date: Date of the template creation.
94. :title: Title of the template.
95. :description: Description of the template.
96. :start: Starting date of the event.
97. :end: Ending date of the event.
98. :venue: The event location.
99. :street: Street of the event location.
100. :city: City of the event location.
101. :zip: ZIP code of the event location.
102. :country: Country of the event location.
103. :contact_person: Name of a person to contact.
104. :contact_email: Email of a person to contact.
105. :contact_phone: Phone of a person to contact.
106. :available_seats: Amount of seats available for this event.
107. :hide_available_seats: Checkfield to hide the information about available
108. seats in the templates.
109. :max_seats_per_guest: Maximum amount of seats per guest.
110. :allow_anonymous_rsvp: Checkbox to allow anonymous responses.
111. :required_fields: Checkbox to select required guest fields.
112. :template_name: Name can be set, if this event should be reusable.
113. :is_published: Checkbox to publish/unpublish an event.
115. """
116. created_by = models.ForeignKey(
117. 'auth.User',
118. verbose_name=_('Created by'),
119. )
121. creation_date = models.DateTimeField(
122. auto_now_add=True,
123. verbose_name=_('Creation date'),
124. )
126. title = models.CharField(
127. max_length=256,
128. verbose_name=_('Title'),
129. help_text=_('The title will also be used for the event URL.'),
130. )
132. slug = models.SlugField(
133. max_length=256,
134. verbose_name=_('Slug'),
135. )
137. description = models.TextField(
138. max_length=1000,
139. verbose_name=_('Description'),
140. blank=True, null=True,
141. )
143. start = models.DateTimeField(
144. default=timezone.now(),
145. verbose_name=_('Start date'),
146. )
148. end = models.DateTimeField(
149. default=timezone.now() + timezone.timedelta(days=1),
150. verbose_name=_('End date'),
151. )
153. venue = models.CharField(
154. max_length=100,
155. verbose_name=_('Venue'),
156. )
158. street = models.CharField(
159. max_length=100,
160. verbose_name=_('Street'),
161. blank=True,
162. )
164. city = models.CharField(
165. max_length=100,
166. verbose_name=_('City'),
167. blank=True,
168. )
170. zip = models.CharField(
171. max_length=100,
172. verbose_name=_('ZIP code'),
173. blank=True,
174. )
176. country = models.CharField(
177. max_length=100,
178. verbose_name=_('Country'),
179. blank=True,
180. )
182. contact_person = models.CharField(
183. max_length=100,
184. verbose_name=_('Contact name'),
185. blank=True,
186. )
188. contact_email = models.EmailField(
189. verbose_name=_('Contact email'),
190. blank=True,
191. )
193. contact_phone = models.CharField(
194. max_length=100,
195. verbose_name=_('Contact phone'),
196. blank=True,
197. )
199. available_seats = models.PositiveIntegerField(
200. verbose_name=_('Available seats'),
201. blank=True, null=True,
202. )
204. hide_available_seats = models.BooleanField(
205. default=False,
206. verbose_name=_('Hide available seat information'),
207. )
209. allow_anonymous_rsvp = models.BooleanField(
210. default=False,
211. verbose_name=_('Allow anonymous RSVP'),
212. help_text=_('Even anonymous users can rsvp, without adding any info.'),
213. )
215. required_fields = MultiSelectField(
216. verbose_name=_('Required fields'),
217. max_length=250, blank=True,
218. choices=(
219. ('name', _('Name')),
220. ('email', _('Email')),
221. ('phone', _('Phone')),
222. ),
223. )
225. max_seats_per_guest = models.PositiveIntegerField(
226. blank=True, null=True,
227. verbose_name=_('Maximum amount of seats per guest'),
228. )
230. template_name = models.CharField(
231. max_length=100,
232. verbose_name=_('Save as template'),
233. blank=True,
234. help_text=_('Save this event as a template to re-use it later.'),
235. )
237. is_published = models.BooleanField(
238. verbose_name=_('is published'),
239. default=False,
240. )
242. def __unicode__(self):
243. if self.template_name:
244. return '{0} ({1})'.format(self.template_name, ugettext('Template'))
245. return '{0} ({1})'.format(self.title, date(self.start))
247. def save(self, *args, **kwargs):
248. self.slug = slugify(self.title)
249. suspects = Event.objects.filter(slug=self.slug)
250. if suspects.count() > 0 and suspects[0] != self:
251. while Event.objects.filter(slug=self.slug).count() > 0:
252. try:
253. number = int(self.slug[-1])
254. except ValueError:
255. self.slug = self.slug + '0'
256. else:
257. self.slug = self.slug[:-1] + str(number + 1)
258. super(Event, self).save(*args, **kwargs)
260. def get_absolute_url(self, url='rsvp_event_detail'):
261. return reverse(url, kwargs={
262. 'slug': self.slug,
263. 'year': '{0:04d}'.format(self.start.year),
264. 'month': '{0:02d}'.format(self.start.month),
265. 'day': '{0:02d}'.format(self.start.day),
266. })
268. def get_update_url(self):
269. return self.get_absolute_url(url='rsvp_event_update')
271. def get_delete_url(self):
272. return self.get_absolute_url(url='rsvp_event_delete')
274. def get_template_url(self):
275. return reverse('rsvp_event_create_from_template', kwargs={
276. 'pk': self.pk})
278. def get_free_seats(self):
279. reserved = self.guests.all().aggregate(models.Sum('number_of_seats'))
280. if self.available_seats:
281. return self.available_seats - int(reserved.get(
282. 'number_of_seats__sum') or 0)
283. return _('Unlimited seats available.')
285. def is_bookable(self):
286. if self.start < timezone.now():
287. return False
288. return True
291. class Guest(models.Model):
292. """
293. Model to create event templates for recurring events etc.
295. :event: Event to visit.
296. :user: User model of the guest.
297. :name: Name of the guest.
298. :email: Email of the guest.
299. :phone: Phone number of the guest.
300. :number_of_seats: Amount of seats to book.
301. :creation_date: Date of the guest model creation.
302. :is_attending: If the user is attending or not. Default: True
303. :message: A response from a potential attendee.
305. """
306. event = models.ForeignKey(
307. 'event_rsvp.Event',
308. verbose_name=_('Event'),
309. related_name='guests',
310. )
312. user = models.ForeignKey(
313. 'auth.User',
314. verbose_name=_('User'),
315. blank=True, null=True,
316. )
318. name = models.CharField(
319. max_length=50,
320. verbose_name=_('Name'),
321. blank=True,
322. )
324. email = models.EmailField(
325. verbose_name=_('Email'),
326. blank=True,
327. )
329. phone = models.CharField(
330. max_length=50,
331. verbose_name=_('Phone'),
332. blank=True,
333. )
335. number_of_seats = models.PositiveIntegerField(
336. verbose_name=_('Number of seats'),
337. blank=True, null=True,
338. )
340. creation_date = models.DateTimeField(
341. auto_now_add=True,
342. verbose_name=_('Creation date'),
343. )
345. is_attending = models.BooleanField(
346. verbose_name=_('Attending'),
347. default=True,
348. )
350. message = models.TextField(
351. verbose_name=_('Message'),
352. max_length=4000,
353. blank=True,
354. )
356. def __unicode__(self):
357. if self.user:
358. return '{0} - {1}'.format(
359. self.user.get_full_name() or self.user.email, self.event)
360. elif self.name or self.email:
361. return '{0} - {1}'.format(self.name or self.email, self.event)
362. return '{0} - {1}'.format(ugettext('anonymous'), self.event)