Merge lp:~mhall119/loco-team-portal/fixes-571483 into lp:loco-team-portal

[Michael Hall]

This converts the venue drop-down list on the Event form from a flat unordered list, to a list using optgroups to group venues by country.

[Daniel Holbach (dholbach)]

 - Do you think it'd make sense to move grouped_venue_list() into models.py? It feels a bit more like here's-where-data-comes-from.
 - Are those print statements meant to stay?
 - Maybe it's because it's Ubuntu Release Day today, but I have a bit of a hard time understanding how the list is assembled.

[lp:~mhall119/loco-team-portal/fixes-571483]

118. By Michael Hall on 2010-04-29

Removed debugging print statements, added comments instead

[Michael Hall (mhall119)]

I removed the print statements and added comments.

The list creates something like this:
[
 ('USA', [
  (1, 'venue 1'),
  (2, 'venue 2')
 ]),
 ('France', [
  (3, 'french venue 1'),
  (4, 'french venue 2')
 ])
]

You an see what Django does with that here: http://127.0.0.1:8000/events/team/add/

review: Needs Resubmitting

[Daniel Holbach (dholbach)]

Do you think it should go into models.py maybe?

[Daniel Holbach (dholbach)]

Do you think it should go into models.py maybe?

[Michael Hall (mhall119)]

I don't think so, it's only useful to forms, and this is the only form with a foreign key to venues. Putting it in models.py would only separate it from the only place where it's being used.

[Daniel Holbach (dholbach)]

Good work!

review: Approve

=== modified file 'loco_directory/events/forms.py'
--- loco_directory/events/forms.py	2010-01-20 19:37:55 +0000
+++ loco_directory/events/forms.py	2010-04-29 11:53:26 +0000
@@ -2,6 +2,7 @@
 
 from django import forms
 from models import BaseEvent, GlobalEvent, TeamEvent, Attendee, TeamEventComment
+from venues.models import Venue
 
 
 class BaseEventForm(forms.ModelForm):
@@ -37,7 +38,6 @@
             raise forms.ValidationError("Events can not end before they start.")
         return self.cleaned_data
 
-
 class TeamEventForm(BaseEventForm):
     """ 
     a form to create/update a TeamEvent
@@ -46,6 +46,37 @@
         model = TeamEvent
         exclude = ('teams', 'date_created')
         
+    def __init__(self, *args, **kargs):
+        super(TeamEventForm, self).__init__(*args, **kargs)
+        self.fields['venue'].choices = self.grouped_venue_list()
+        
+    def grouped_venue_list(self):
+        """
+        Returns a list of venues grouped by country
+        in a way that Django will convert to OptGroups
+        """
+        venue_choices = [('', '---------')]
+        country_choices = []
+        current_country = ''
+        # Ordered by country so we can tell when we're done with one
+        # and starting another
+        for venue in Venue.objects.all().order_by('country'):
+            # If this venue has a different country, start a new group
+            if venue.country != current_country:
+                # Add the old group to the list if it's non-empty
+                if len(country_choices) > 0:
+                    venue_choices.append((current_country, country_choices))
+                country_choices = []
+                current_country = venue.country
+            # Add venue to the current country group
+            country_choices.append((venue.id, '%s (%s)'%(venue.name, venue.city)))
+        
+        # Add the last country group to the list if it's non-empty
+        if len(country_choices) > 0:
+            venue_choices.append((current_country, country_choices))
+                
+        return venue_choices
+        
         
 class GlobalEventForm(BaseEventForm):
     """