#M21. Add functionality to set maximum number of registrations. (#201)

Author: stefdworschak

accounts/urls.py

@@ -4,5 +4,5 @@
 
 urlpatterns = [
     path("edit_profile/", views.edit_profile, name="edit_profile"),
-    path('admin/', LoginView.as_view()),
+    path('external/', LoginView.as_view()),
 ]

hackathon/forms.py

@@ -75,7 +75,7 @@ class HackathonForm(forms.ModelForm):
     team_size = forms.IntegerField(
         label="Team Size",
         required=True,
-        widget=forms.TextInput(attrs={'min':3,'max': 6,'type': 'number'})
+        widget=forms.TextInput(attrs={'min': 3, 'max': 6, 'type': 'number'})
     )
     organisation = forms.ModelChoiceField(
         label="Organisation",
@@ -88,12 +88,17 @@ class HackathonForm(forms.ModelForm):
         })
     )
     is_public = forms.BooleanField(required=False)
+    max_participants = forms.IntegerField(
+        label="Max Number Of Participants (leave empty for no max)",
+        required=False,
+        widget=forms.TextInput({'type': 'number'})
+    )
 
     class Meta:
         model = Hackathon
         fields = ['display_name', 'description', 'theme', 'start_date',
                   'end_date', 'status', 'organisation', 'score_categories',
-                  'team_size', 'tag_line', 'is_public',
+                  'team_size', 'tag_line', 'is_public', 'max_participants',
                   ]
 
     def __init__(self, *args, **kwargs):

hackathon/migrations/0044_auto_20210717_1654.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.1.8 on 2021-07-17 16:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('hackathon', '0043_hackathon_is_public'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='hackathon',
+            name='max_participants',
+            field=models.IntegerField(blank=True, default=None, null=True),
+        ),
+        migrations.AlterField(
+            model_name='hackathon',
+            name='theme',
+            field=models.CharField(default='', max_length=264),
+        ),
+    ]

hackathon/models.py

@@ -50,9 +50,8 @@ class Hackathon(models.Model):
                                     related_name='judged_hackathons')
     # Hackathons can have multiple participants judges and
     # users could be participating in more than one Hackathon: Many to Many
-    participants = models.ManyToManyField(User,
-                                    blank=True,
-                                    related_name='participated_hackathons')
+    participants = models.ManyToManyField(
+        User, blank=True, related_name='participated_hackathons')
     # Hackathons can have multiple score categories and score categories
     # Can belong to multiple hackahtons: Many to Many
     score_categories = models.ManyToManyField(
@@ -82,6 +81,7 @@ class Hackathon(models.Model):
         help_text=("Hackathon image.")
     )
     is_public = models.BooleanField(default=False)
+    max_participants = models.IntegerField(default=None, null=True, blank=True)
 
     def __str__(self):
         return self.display_name
@@ -90,6 +90,12 @@ class Meta:
         verbose_name = "Hackathon"
         verbose_name_plural = "Hackathons"
 
+    def max_participants_reached(self):
+        if not self.max_participants:
+            return False
+
+        return self.participants.count() >= self.max_participants
+
 
 class HackAwardCategory(models.Model):
     """Model representing a HackAwardCategory which represents a type of award

hackathon/templates/hackathon/create-event.html

@@ -55,9 +55,12 @@ <h1>Create Hackathon</h1>
         <div class="col-12 mb-3">
           {{ form.score_categories|as_crispy_field }}
         </div>
-        <div class="col-12 mb-3">
+        <div class="col-12 col-md-6 mb-3">
           {{ form.is_public|as_crispy_field }}
         </div>
+        <div class="col-12 col-md-6 mb-3">
+          {{ form.max_participants|as_crispy_field }}
+        </div>
         <div class="col-12 mb-5">
           <input type="submit" class="btn-ci mr-2">
           <a href="{% url 'hackathon:hackathon-list' %}" type="button" class="btn-ci button">Cancel</a>

hackathon/templates/hackathon/hackathon_view.html

@@ -98,8 +98,13 @@
                                 {% if request.user.user_type|is_types:authorised_types %}
                                 <p class="hackathon-sub-details"><i class="far fa-question-circle"></i> Status: {{ hackathon.status }}</p>
                                 <p class="hackathon-sub-details"><i class="fas fa-chalkboard-teacher"></i> Organiser: {{ hackathon.organiser }}</p>
+                                <p class="hackathon-sub-details"><i class="fas fa-users"></i>
+                                    Max Participants: {% if hackathon.max_participants %}{{ hackathon.max_participants }}{% else %}Unlimited{% endif %}
+                                    {% if hackathon.max_participants_reached %}(Max Reached){% endif %}
+                                </p>
                                 {% else %}
-                                <p class="hackathon-sub-details"><i class="far fa-question-circle"></i> Status: {{hackathon.status|prettify_status}}</p>
+                                <p class="hackathon-sub-details"><i class="far fa-question-circle"></i> Status: 
+                                    {{hackathon.status|prettify_status:hackathon.max_participants_reached}}</p>
                                 {% endif %}
                                 <p class="hackathon-sub-details"><i class="far fa-clock"></i> Start: {{ hackathon.start_date }}</p>
                                 <p class="hackathon-sub-details"><i class="fas fa-clock"></i> End: {{ hackathon.end_date }}</p>

hackathon/templates/hackathon/includes/enroll_card.html

@@ -0,0 +1,10 @@
+{% if not hackathon.max_participants_reached %}
+<form id="enroll-form" action="{% url 'hackathon:enroll_toggle' %}" method="POST">
+    {% csrf_token %}
+    <input type="hidden" name="hackathon-id" value="{{ hackathon.id }}">
+    <button id="enroll-part" type="submit" 
+        class="btn btn-ci mt-4 mb-2 form-control">
+            <i class="fas fa-user-plus mr-2"></i>Enroll as Participant
+    </button>
+</form>
+{% endif %}

hackathon/templates/hackathon/includes/enrollpart.html

@@ -1,6 +1,6 @@
 {% load custom_tags %}
 
-{% if hackathon.status == 'registration_open' %}
+{% if hackathon.status == 'registration_open' and not hackathon.max_participants_reached %}
 <form id="enroll-form" action="{% url 'hackathon:enroll_toggle' %}" method="POST">
     {% csrf_token %}
     <!--It only sends the hackathon ID.-->

hackathon/templates/hackathon/includes/hackathon_card.html

@@ -31,10 +31,14 @@ <h5 class="p-orange card-title"><a href="/hackathon/{{hackathon.id}}/" class="ci
                 <p class="card-subtitle mb-2 text-muted"><i class="fas fa-user-plus p-2"></i>Registration closed for this hackathon</p>
                 {% endif %}
                 {% else %}
-                {% if hackathon.status == 'registration_open' and request.user not in hackathon.participants.all %}
-                <p class="card-subtitle mb-2 ci-orange"><i class="fas fa-user-plus p-2"></i>Registrations open!</p>
-                {% elif hackathon.status == 'registration_open' and request.user in hackathon.participants.all %}
-                <p class="card-subtitle mb-2 ci-orange"><i class="fas fa-user p-2"></i>You are enrolled in this hackathon!</p>
+                {% if hackathon.status == 'registration_open' %}
+                    {% if hackathon.max_participants_reached %}
+                        <p class="card-subtitle mb-2 text-muted"><i class="fas fa-user-plus p-2"></i>Registrations closed.</p>
+                    {% elif request.user not in hackathon.participants.all %}
+                        <p class="card-subtitle mb-2 ci-orange"><i class="fas fa-user-plus p-2"></i>Registrations open!</p>
+                    {% elif request.user in hackathon.participants.all %}
+                        <p class="card-subtitle mb-2 ci-orange"><i class="fas fa-user p-2"></i>You are enrolled in this hackathon!</p>
+                    {% endif %}
                 {% elif hackathon.status == 'hack_in_progress' or hackathon.status == 'judging' or hackathon.status == 'hack_prep' %}
                 {% if request.user in hackathon.participants.all %}
                 <p class="card-subtitle mb-2 ci-orange"><i class="fas fa-user-plus p-2"></i>You are participating in this hackathon</p>
@@ -59,7 +63,7 @@ <h5 class="p-orange card-title"><a href="/hackathon/{{hackathon.id}}/" class="ci
                 {% endif %}
                 <a href="{% url 'hackathon:view_hackathon' hackathon.id %}" class="btn btn-ci mr-3">Read More</a>
                 {% if request.user.is_authenticated and hackathon.status == 'registration_open' and not request.user.user_type|is_types:authorised_types_on_card and request.user not in hackathon.participants.all %}
-                <div class="enroll-hackathon-card">{% include 'hackathon/includes/enrollpart.html' %}</div>
+                <div class="enroll-hackathon-card">{% include 'hackathon/includes/enroll_card.html' %}</div>
                 {% endif %}
                 {% endwith %}
 

hackathon/templatetags/custom_tags.py

@@ -72,11 +72,13 @@ def place_identifier(num):
 
 
 @register.filter
-def prettify_status(status):
+def prettify_status(status, max_participants_reached):
     if status == 'published' or status == 'draft':
         return "Registration Starts Soon"
-    elif status == 'registration_open':
+    elif status == 'registration_open' and not max_participants_reached:
         return "Registration Open"
+    elif status == 'registration_open' and max_participants_reached:
+        return "Registration Closed"
     elif status == 'hack_prep':
         return "Hackathon Starting Soon"
     elif status == 'hack_in_progress':