Merge lp:~cjohnston/summit/registration-form into lp:summit

[Chris Johnston]

Adds a registration form to register as attending a sprint.

This adds a registration form as well as a generic form.html template, which I hope to be able to reuse for more (all) forms instead of having to have a custom template for each form. Note: This does not include a link to the registration page. summit.html will need some re-work for that, so I will be doing that in a separate branch.

[Adnane Belmadiaf (daker)]

The timewidget doesn't select the correct value( see bug 1164296 ), for the forms.Select there should an initial value if the user have already set his availability.

[lp:~cjohnston/summit/registration-form]

519. By Chris Johnston on 2013-04-08

Use async loading

520. By Chris Johnston on 2013-04-08

Fixes issue with select widget

521. By Chris Johnston on 2013-04-08

Update from trunk

522. By Chris Johnston on 2013-04-08

Removes css/js

[Adnane Belmadiaf (daker)]

+1 from me :)

review: Approve

=== modified file 'EXTERNALS'
--- EXTERNALS	2012-04-22 20:20:10 +0000
+++ EXTERNALS	2013-04-08 21:02:19 +0000
@@ -19,3 +19,10 @@
 
 - Twitter JS
 http://twitter.com/javascripts/blogger.js
+
+- Date Picker
+provided by the JQuery UI project. See http://jqueryui.com/
+
+- DateTimeWidget inspired by:
+http://copiesofcopies.org/webl/2010/04/26/a-better-datetime-widget-for-django/
+

=== added file 'summit/common/widgets.py'
--- summit/common/widgets.py	1970-01-01 00:00:00 +0000
+++ summit/common/widgets.py	2013-04-08 21:02:19 +0000
@@ -0,0 +1,122 @@
+# -*- coding: utf-8 -*-
+from datetime import time
+from time import strptime, strftime
+
+from django import forms
+
+
+class DateWidget(forms.DateInput):
+    """
+    A more-friendly date widget with a pop-up calendar.
+    """
+    def __init__(self, attrs=None):
+        self.date_class = 'datepicker'
+        if not attrs:
+            attrs = {}
+        if 'date_class' in attrs:
+            self.date_class = attrs.pop('date_class')
+        if 'class' not in attrs:
+            attrs['class'] = 'date'
+
+        super(DateWidget, self).__init__(attrs=attrs)
+
+    def render(self, name, value, attrs=None):
+        return '<span class="%s">%s</span>' % (
+            self.date_class,
+            super(DateWidget, self).render(name, value, attrs)
+        )
+
+
+class TimeWidget(forms.MultiWidget):
+    """
+    A more-friendly time widget.
+    """
+    def __init__(self, attrs=None):
+        self.time_class = 'timepicker'
+        if not attrs:
+            attrs = {}
+        if 'time_class' in attrs:
+            self.time_class = attrs.pop('time_class')
+        if 'class' not in attrs:
+            attrs['class'] = 'time'
+
+        widgets = (
+            forms.Select(
+                attrs=attrs,
+                choices=[(i + 1, "%02d" % (i + 1)) for i in range(0, 12)],
+            ),
+            forms.Select(
+                attrs=attrs,
+                choices=[(i, "%02d" % i) for i in range(00, 60, 15)],
+            ),
+            forms.Select(
+                attrs=attrs,
+                choices=[('AM', 'AM'), ('PM', 'PM')],
+            )
+        )
+
+        super(TimeWidget, self).__init__(widgets, attrs)
+
+    def decompress(self, value):
+        if isinstance(value, str):
+            value = strptime(value, '%I:%M %p')
+            hour = int(value.tm_hour)
+            minute = int(value.tm_min)
+            if hour < 12:
+                meridian = 'AM'
+            else:
+                meridian = 'PM'
+                hour -= 12
+            return (hour, minute, meridian)
+
+        elif isinstance(value, time):
+            hour = int(value.strftime("%I"))
+            minute = int(value.strftime("%M"))
+            meridian = value.strftime("%p")
+            return (hour, minute, meridian)
+        return (None, None, None)
+
+    def value_from_datadict(self, data, files, name):
+        value = super(TimeWidget, self).value_from_datadict(data, files, name)
+        t = strptime(
+            "%02d:%02d %s" % (
+                int(value[0]),
+                int(value[1]),
+                value[2]
+            ),
+            "%I:%M %p",
+        )
+        return strftime("%H:%M:%S", t)
+
+    def format_output(self, rendered_widgets):
+        return '<span class="%s">%s%s%s</span>' % (
+            self.time_class,
+            rendered_widgets[0], rendered_widgets[1], rendered_widgets[2]
+        )
+
+
+class DateTimeWidget(forms.SplitDateTimeWidget):
+    """
+    A more-friendly date/time widget.
+
+    Inspired by:
+
+    http://copiesofcopies.org/webl/2010/04/26/a-better-datetime-widget-for-django/
+    """
+    def __init__(self, attrs=None, date_format=None, time_format=None):
+        super(DateTimeWidget, self).__init__(attrs, date_format, time_format)
+        self.widgets = (
+            DateWidget(attrs=attrs),
+            TimeWidget(attrs=attrs),
+        )
+
+    def decompress(self, value):
+        if value:
+            d = strftime("%Y-%m-%d", value.timetuple())
+            t = strftime("%I:%M %p", value.timetuple())
+            return (d, t)
+        else:
+            return (None, None)
+
+    def format_output(self, rendered_widgets):
+        return '%s%s' % (rendered_widgets[0], rendered_widgets[1])

=== modified file 'summit/media/css/style.css'
--- summit/media/css/style.css	2012-01-22 18:36:40 +0000
+++ summit/media/css/style.css	2013-04-08 21:02:19 +0000
@@ -66,3 +66,20 @@
 .summit-columns ul li h3 a:hover { text-decoration: underline; }
 .summit-columns ul li img { padding: 10px 0 5px; }
 .summit-columns p { margin-bottom: 5px; }
+
+#id_start_utc_0, #id_start_utc_1,
+#id_end_utc_0, #id_end_utc_1,
+#id_start_utc_1_0, #id_start_utc_1_1, #id_start_utc_1_2,
+#id_end_utc_1_0, #id_end_utc_1_1, #id_end_utc_1_2 {
+    width: 100px;
+    display: inline;
+}
+
+#id_start_utc_1_0, #id_start_utc_1_1, #id_start_utc_1_2,
+#id_end_utc_1_0, #id_end_utc_1_1, #id_end_utc_1_2 {
+    width: 60px;
+}
+
+#id_name, #id_announce, #id_registration {
+    width: 350px;
+}

=== added file 'summit/media/js/events-ui.js'
--- summit/media/js/events-ui.js	1970-01-01 00:00:00 +0000
+++ summit/media/js/events-ui.js	2013-04-08 21:02:19 +0000
@@ -0,0 +1,11 @@
+$(document).ready(function(){
+
+    $.datepicker.setDefaults({
+        showOn: 'focus',
+        dateFormat: 'yy-mm-dd',
+    });
+
+    $("#id_start_utc_0").datepicker();
+    $("#id_end_utc_0").datepicker();
+
+});

=== modified file 'summit/schedule/forms.py'
--- summit/schedule/forms.py	2013-03-09 05:14:19 +0000
+++ summit/schedule/forms.py	2013-04-08 21:02:19 +0000
@@ -14,6 +14,7 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+from django.conf import settings
 from django import forms
 
 from summit.schedule.models.meetingmodel import Meeting
@@ -21,6 +22,7 @@
 from summit.schedule.models.participantmodel import Participant
 
 from common.forms import RenderableMixin
+from common.widgets import DateTimeWidget
 
 
 class MultipleAttendeeField(forms.ModelMultipleChoiceField):
@@ -226,3 +228,32 @@
         fields = ('hangout_url', 'broadcast_url')
 
     broadcast_url = YouTubeEmbedURL(label='Broadcast URL')
+
+
+class Registration(forms.ModelForm, RenderableMixin):
+    class Meta:
+        model = Attendee
+        fields = (
+            'start_utc',
+            'end_utc',
+            'crew',
+        )
+
+    def __init__(self, *args, **kargs):
+        super(Registration, self).__init__(*args, **kargs)
+        self.fields['start_utc'].widget = DateTimeWidget()
+        self.fields['end_utc'].widget = DateTimeWidget()
+
+    def clean(self):
+        begin = self.cleaned_data.get('start_utc')
+        end = self.cleaned_data.get('end_utc')
+        if begin and end and begin > end:
+            raise forms.ValidationError(
+                "Availability can not end before it starts."
+            )
+        return self.cleaned_data
+
+    def save(self, commit=True):
+        instance = super(Registration, self).save(commit)
+        instance.from_launchpad = False
+        instance.save()

=== added file 'summit/schedule/templates/schedule/form.html'
--- summit/schedule/templates/schedule/form.html	1970-01-01 00:00:00 +0000
+++ summit/schedule/templates/schedule/form.html	2013-04-08 21:02:19 +0000
@@ -0,0 +1,41 @@
+{% extends "base.html" %}
+
+{% block page_name %}{{ form_title }} - {{ summit.title }}{%endblock %}
+{% block sub_nav %}{% endblock %}
+
+{% block closure %}
+<script type="text/javascript"><!--
+$(document).ready(function(){
+    $('span[rel*=help]').colorTip({color:'orange'});
+});
+--></script>
+<style>
+form ul {
+  height: 12em;
+  overflow-y: scroll;
+  overflow-x: hidden;
+}
+</style>
+{% endblock %}
+
+
+{% block content %}
+<div class="row">
+    <article id="form" class="span-8">
+        {% if form.errors %}
+            <p style="color: red;">
+                Please correct the error{{ form.errors|pluralize }} below.
+            </p>
+        {% endif %}
+
+        <form action="{{ request.path_info }}" method="POST">{% csrf_token %}
+            <fieldset>
+                <h3>{{ form_title }}</h3>
+                {{ form.as_template }}
+                {% if is_popup %}<input type="hidden" name="_popup" value="1">{% endif %}
+                <input type="submit" name="submit" value="Create" class="submit-button" />
+            </fieldset>
+        </form>
+    </article>
+</div>
+{% endblock %}

=== modified file 'summit/schedule/tests/__init__.py'
--- summit/schedule/tests/__init__.py	2013-03-14 20:52:12 +0000
+++ summit/schedule/tests/__init__.py	2013-04-08 21:02:19 +0000
@@ -31,3 +31,4 @@
 from schedule import *
 from summit_model import *
 from propose_meeting import *
+from registration import RegistrationTestCase

=== added file 'summit/schedule/tests/registration.py'
--- summit/schedule/tests/registration.py	1970-01-01 00:00:00 +0000
+++ summit/schedule/tests/registration.py	2013-04-08 21:02:19 +0000
@@ -0,0 +1,222 @@
+# The Summit Scheduler web application
+# Copyright (C) 2008 - 2013 Ubuntu Community, Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import datetime
+
+from django import test as djangotest
+from django.core.urlresolvers import reverse
+
+from django.contrib.auth.models import User
+from django.test.client import Client
+
+from model_mommy import mommy as factory
+
+from summit.schedule.models import (
+    Summit,
+    Attendee,
+)
+
+
+class RegistrationTestCase(djangotest.TestCase):
+    """
+    Tests for registering to attend a Summit
+    """
+    c = Client()
+
+    def setUp(self):
+        self.now = datetime.datetime.utcnow()
+        self.one_hour = datetime.timedelta(0, 3600)
+        self.one_day = datetime.timedelta(days=1)
+        self.week = datetime.timedelta(days=5)
+        self.end_summit = self.now + self.week
+        self.summit = factory.make_one(
+            Summit,
+            name='test-summit',
+            title='Test Summit',
+            virtual_summit=True,
+            date_start=self.now,
+            date_end=self.now + self.week,
+            timezone='UTC',
+        )
+
+        self.user1 = factory.make_one(
+            User,
+            username='testuser',
+            first_name='Test',
+            last_name='User',
+            is_active=True,
+            is_superuser=False,
+        )
+        self.user1.set_password('password')
+        self.user1.save()
+
+    def create_attendee(self):
+        self.attendee1 = factory.make_one(
+            Attendee,
+            summit=self.summit,
+            user=self.user1,
+            start_utc=self.now,
+            end_utc=self.now+self.week
+        )
+
+    def tearDown(self):
+        self.client.logout()
+
+    def login(self):
+        logged_in = self.c.login(
+            username='testuser',
+            password='password')
+        self.assertTrue(logged_in)
+
+    def get_attendee(self):
+        attendee = Attendee.objects.get(user=self.user1)
+        return attendee
+
+    def with_summit_registration_times(self):
+        """
+        Using the start and end of the summit as the registration times
+        """
+        self.start_date = self.now.strftime("%Y-%m-%d")
+        self.start_hour = self.now.strftime("%I")
+        self.start_minute = self.now.strftime("%M")
+        self.start_period = self.now.strftime("%p")
+        self.end_hour = self.end_summit.strftime("%I")
+        self.end_minute = self.end_summit.strftime("%M")
+        self.end_period = self.end_summit.strftime("%p")
+        self.end_date = self.end_summit.strftime("%Y-%m-%d")
+        self.edit_registration_form()
+        attendee = self.get_attendee()
+        self.assertEqual(
+            attendee.start_utc.replace(second=0),
+            self.now.replace(second=0, microsecond=0),
+        )
+        self.assertEqual(
+            attendee.end_utc.replace(second=0, microsecond=0),
+            self.end_summit.replace(second=0, microsecond=0),
+        )
+
+    def with_custom_registration_times(self):
+        """
+        Using custom start and end registration times
+        """
+        start = self.now + self.one_day
+        self.start_date = start.strftime("%Y-%m-%d")
+        self.start_hour = self.now.strftime("%I")
+        self.start_minute = self.now.strftime("%M")
+        self.start_period = self.now.strftime("%p")
+        self.end_hour = self.end_summit.strftime("%I")
+        self.end_minute = self.end_summit.strftime("%M")
+        self.end_period = self.end_summit.strftime("%p")
+        self.end_date = self.end_summit.strftime("%Y-%m-%d")
+        self.edit_registration_form()
+        attendee = self.get_attendee()
+        self.assertEqual(
+            attendee.start_utc.replace(second=0),
+            start.replace(second=0, microsecond=0),
+        )
+        self.assertEqual(
+            attendee.end_utc.replace(second=0, microsecond=0),
+            self.end_summit.replace(second=0, microsecond=0),
+        )
+
+    def edit_registration_form(self):
+        """
+        Tests that a user can register for a Summit
+        """
+        # Define data to fill our the form
+
+        # Post the form
+        post = self.c.post(
+            reverse(
+                'registration',
+                args=(self.summit.name,)
+            ),
+            data={
+                'end_utc_0': self.end_date,
+                'end_utc_1_0': self.end_hour,
+                'end_utc_1_1': self.end_minute,
+                'end_utc_1_2': self.end_period,
+                'start_utc_1_0': self.start_hour,
+                'start_utc_1_1': self.start_minute,
+                'start_utc_1_2': self.start_period,
+                'start_utc_0': self.start_date,
+            }
+        )
+
+        # A successful post should redirect to the summit page
+        response = reverse(
+            'summit.schedule.views.summit',
+            args=(self.summit.name,)
+        )
+        self.assertEqual(post.status_code, 302)
+        self.assertRedirects(post, response)
+        attendee = self.get_attendee()
+        self.assertEqual(attendee.user, self.user1)
+        self.assertEqual(attendee.from_launchpad, False)
+
+    def test_non_attendee_registers(self):
+        self.login()
+        self.assertRaises(Attendee.DoesNotExist, lambda: self.get_attendee())
+        rev_args = [self.summit.name, ]
+        response = self.c.get(reverse('registration', args=rev_args))
+        self.assertEqual(response.status_code, 200)
+        self.assertTemplateUsed(response, 'schedule/form.html')
+        self.assertIn('Register for ' + self.summit.title, response.content)
+        self.with_summit_registration_times()
+
+    def test_attendee_updates_registration(self):
+        self.create_attendee()
+        self.login()
+        self.assertEquals(
+            self.user1.username,
+            self.get_attendee().user.username,
+        )
+        rev_args = [self.summit.name, ]
+        response = self.c.get(reverse('registration', args=rev_args))
+        self.assertEqual(response.status_code, 200)
+        self.assertTemplateUsed(response, 'schedule/form.html')
+        self.assertIn(
+            'Update registration for ' + self.summit.title,
+            response.content
+        )
+        self.with_custom_registration_times()
+
+    def test_update_registration_from_launchpad_true(self):
+        """
+        update resgistration with from_launchpad=True
+        to save from_launchpad=False
+        """
+        self.create_attendee()
+        self.attendee1.from_launchpad = True
+        self.attendee1.save()
+        self.login()
+        self.assertEquals(
+            self.user1.username,
+            self.get_attendee().user.username,
+        )
+        self.assertEquals(
+            True,
+            self.get_attendee().from_launchpad,
+        )
+        rev_args = [self.summit.name, ]
+        response = self.c.get(reverse('registration', args=rev_args))
+        self.assertEqual(response.status_code, 200)
+        self.assertTemplateUsed(response, 'schedule/form.html')
+        self.assertIn(
+            'Update registration for ' + self.summit.title,
+            response.content
+        )
+        self.with_custom_registration_times()

=== modified file 'summit/schedule/views.py'
--- summit/schedule/views.py	2013-03-15 01:06:10 +0000
+++ summit/schedule/views.py	2013-04-08 21:02:19 +0000
@@ -52,7 +52,8 @@
     MeetingReview,
     AttendMeeting,
     OrganizerChangeAttend,
-    EditMeetingHangout
+    EditMeetingHangout,
+    Registration,
 )
 
 __all__ = (
@@ -1173,3 +1174,47 @@
         context,
         RequestContext(request)
     )
+
+
+@login_required
+@summit_required
+def registration_form(request, summit, attendee):
+    registration_args = dict()
+
+    if attendee is None:
+        attendee = Attendee(
+            user=request.user,
+            summit=summit,
+            from_launchpad=False,
+            start_utc=summit.start or summit.date_start,
+            end_utc=summit.end or summit.date_end,
+        )
+        registration_args['instance'] = attendee
+        form_title="Register for %s" % summit.title
+    else:
+        registration_args['instance'] = attendee
+        form_title="Update registration for %s" % summit.title
+
+    if request.method == 'POST':
+        form = Registration(data=request.POST, **registration_args)
+        if form.is_valid():
+            form.save()
+            return HttpResponseRedirect(
+                reverse(
+                    'summit.schedule.views.summit',
+                    args=(summit.name,)
+                )
+            )
+    else:
+        form = Registration(**registration_args)
+
+    context = {
+        'summit': summit,
+        'form': form,
+        'form_title': form_title,
+    }
+    return render_to_response(
+        'schedule/form.html',
+        context,
+        RequestContext(request)
+    )

=== modified file 'summit/urls.py'
--- summit/urls.py	2013-02-26 19:31:21 +0000
+++ summit/urls.py	2013-04-08 21:02:19 +0000
@@ -68,6 +68,11 @@
     (r'^(?P<summit_name>[\w-]+)/$', 'summit'),
     (r'^(?P<summit_name>[\w-]+)/mobile/$', 'mobile'),
     (r'^(?P<summit_name>[\w-]+)/search/$', 'search'),
+    url(
+        r'^(?P<summit_name>[\w-]+)/registration/$',
+        'registration_form',
+        name='registration',
+    ),
     (r'^(?P<summit_name>[\w-]+)/propose_meeting/$', 'propose_meeting'),
     (r'^(?P<summit_name>[\w-]+)/edit_meeting/(?P<meeting_id>\d+)/(?P<meeting_slug>[%+\.\w-]+)/$',
      'edit_meeting'),