Merge pull request #41 from HackAssistant/production

Casassarnau · web-flow · commit 0b01a9d2e1bd · 2022-10-02T14:32:23.000+02:00
Production
diff --git a/DEV.md b/DEV.md
@@ -1,8 +1,51 @@
 # Documentation
-## Forms
+## BootstrapFormMixin
+BootstrapFormMixin is a class that allows an easy way to render any form type.
+
+At the start of the class you will need to override the `bootstrap_field_info` where all the render information is stored.
+```python
+bootstrap_field_info = {'TITLE': {
+    'fields': [{'name': 'FIELD_NAME', 'space': GRID_NUMBER, 'visible': VALUE_DICT},], 
+    'description': 'DESCRIPTION'},}
+```
+In this example the TITLE will be the h2 text of the formset that will contain all the fields on the array.
+The description is an optional text to be displayed after the TITLE.
+The FIELD_NAME will be the names of the fields of your form, this is required.
+GRID_NUMBER will be the grid (1-12) space that will fill your field in the Bootstrap row, if omitted the space will be 0.
+Lastly, the VALUE_DICT refers to a dictionary that will tell your field when can be visible, if omitted the field will always be visible.
+IMPORTANT: if you miss a field on the `bootstrap_field_info` it will set to not required.
+
+An important feature of this form, is the use of the TypeHead lib for autocomplete CharFields, so the user has already some possible answers.
+This can be done by adding the `api_fields` .
+This information is stored in the `api_fields` to the Meta class inside your form, where the API url is required. Other optional fields are `restrict` and 
+`others` field to restrict the options of the field or add the Others option. For example, in this application, 
+it has been used to list all the possible countries and avoid custom answers.
+
+```python
+class Meta(ApplicationForm.Meta):
+    api_fields = {
+        'country': {'url': static('data/countries.json'), 'restrict': True, 'others': True},
+        'university': {'url': static('data/universities.json')},
+        'degree': {'url': static('data/degrees.json')},
+    }
+```
+
+### Methods
+
+#### get_bootstrap_field_info
+
+If you want to dynamically change the `bootstrap_field_info` you can override this method.
+It's important to not remove the initial call `super` to get a COPY of the `bootstrap_field_info` otherwise you will be overriding the full variable.
+You will also need to be cautious with `ModelForm` and understanding how forms work.
+
+#### set_read_only
+
+This method is in order to make the form not editable. Keep in mind that you will need to disable the POST method on your view for this condition.
+
+## Application Forms
 Despite having different types of application, all of them are based in a common structure, defined in the 
 `ApplicationForm` class. Then, for each type (hacker, volunteer, mentor and sponsor) specific parameters are 
-added.
+added. This class inherits the `BootstrapFormMixin`, so all the features of it are available.
 
 Each class starts with `bootstrap_field_info`, where all the fields of the form that have to be rendered are described.
 First, it indicates the part of the form which will be modified (e.g. Personal Info, Hackathons,...). Then, each field 
@@ -18,7 +61,7 @@ be shown(e.g. when diet is "Other", the applicant should specify their case.)
 
 If the information that contains the field was previously specified (e.g. diet, gender), it won't require additional 
 methods. However, if a new one is introduced (e.g. `under_age` in `HackerForm`), the corresponding class will include a 
-method defining the type of answer, if it's required, it's possible choices (which sometimes may be defined as constants 
+method defining the type of answer, if it's required, its possible choices (which sometimes may be defined as constants 
 at the beginning of the file) and the default value amongst others.
 
 ```python
@@ -35,23 +78,29 @@ The method `exclude_save` is used to not store the information of the specified
 have to be accepted in order to participate in the event. Therefore, once the application is submitted, this field will
 always be `True`, so it's not necessary to consider that information anymore.
 
-The `Meta` class is useful to link a json file to a specific field, so the user has already some possible answers.
-This information is stored in the `api_fields` where the API url is required. Other optional fields are `restrict` and 
-`others` field to restrict the options of the field or add the Others option. For example, in this application, 
-it has been used to list all the possible countries and avoid custom answers.
-
-```python
-class Meta(ApplicationForm.Meta):
-    api_fields = {
-        'country': {'url': static('data/countries.json'), 'restrict': True, 'others': True},
-        'university': {'url': static('data/universities.json')},
-        'degree': {'url': static('data/degrees.json')},
-    }
-```
-
 It's important to notice that all the text that will be printed out is surrounded by a low bash and parentheses. In 
 future versions, this will allow to translate the displayed text in an easy way.
 
 ```python
 label = _('How old are you?')
 ```
+
+## TabsViewMixin
+
+This is a simple Mixin to display Tab navigation on your TemplateView or any View class that inherits this class.
+The navigation tabs are the navigation that is displayed on top of your template container.
+
+### Methods
+
+#### get_current_tabs
+This method is meant to be overridden and return an array to be with tuples. The first element of the tuple will be the text of the tab and the second will be the url, those 2 are mandatory.
+The 3rd is and optional variable that can be set to None to be omitted and displays a warning symbol.
+Finally, the 4th variable is to set the tab to active with a boolean, if None or unset the tab will be active if the path equals the url.
+Data can be passed to the method with the `get_context_data` kwargs at the super of your view.
+
+#### get_back_url
+Method that returns the url that will be updated to the context with the name `back`.
+
+## PermissionRequiredMixin
+This Mixin is mean to inherit any type of View class and expands the base [Django PermissionRequiredMixin](https://docs.djangoproject.com/en/4.1/topics/auth/default/#the-permissionrequiredmixin-mixin) class.
+The new functionality is that you can put a dictionary on the `permission_required` in order to change the permissions between the HTTP method: GET, POST, etc.
diff --git a/app/static/css/main.css b/app/static/css/main.css
@@ -140,6 +140,14 @@ footer {
     color: black;
 }
 
+.bg-dark .bg-contrast {
+    background-color: rgba(255, 255, 255, 0.075);
+}
+
+.bg-light .bg-contrast {
+    background-color: rgba(0, 0, 0, 0.075);
+}
+
 .g-recaptcha {
     display: inline-block;
 }
diff --git a/app/static/css/theme.scss b/app/static/css/theme.scss
@@ -33,6 +33,38 @@ $table-variants: (
 
 @import './bootstrap/bootstrap';
 
+.bg-primary {
+    color: $dark;
+}
+
+.bg-secondary {
+    color: $white;
+}
+
+.bg-info {
+    color: $black;
+}
+
+.bg-danger {
+    color: $black;
+}
+
+.bg-warning {
+    color: $black;
+}
+
+.bg-success {
+    color: $black;
+}
+
+.bg-light {
+    color: $black;
+}
+
+.bg-dark {
+    color: $white;
+}
+
 body.light {
   background-image: linear-gradient(darken($primary, 15%), $primary);
 }
diff --git a/app/static/lib/QRCode/qrcode.min.js b/app/static/lib/QRCode/qrcode.min.js
diff --git a/app/templatetags/util.py b/app/templatetags/util.py
@@ -25,6 +25,11 @@ def nav_active(text, starts):
     return False
 
 
+@register.filter
+def get_type_list(app_list):
+    return [app.type.name for app in app_list]
+
+
 @register.simple_tag
 def crispy(*args, **kwargs):
     return None
diff --git a/application/forms.py b/application/forms.py
@@ -116,6 +116,7 @@ def clean_promotional_code(self):
 
     class Meta:
         model = Application
+        description = ''
         exclude = ['user', 'uuid', 'data', 'submission_date', 'status_update_date', 'status', 'contacted_by', 'type',
                    'last_modified', 'edition']
         help_texts = {
@@ -225,6 +226,8 @@ def get_hidden_edit_fields(self):
         return hidden_fields
 
     class Meta(ApplicationForm.Meta):
+        description = _('You will join a team with which you will do a project in a weekend. '
+                        'You will meet new people and learn a lot, don\'t think about it and apply!')
         api_fields = {
             'country': {'url': static('data/countries.json'), 'restrict': True, 'others': True},
             'university': {'url': static('data/universities.json')},
@@ -328,6 +331,9 @@ class VolunteerForm(ApplicationForm):
                                     label=_('How did you discover %s?' % getattr(settings, 'HACKATHON_NAME')))
 
     class Meta(ApplicationForm.Meta):
+        description = _('Volunteers make the event possible by assisting the hackers and preparing the physical '
+                        'spaces of the event. By joining our team of volunteers, you will get to know how this '
+                        'amazing event works from the inside and meet amazing people and live a great experience!')
         api_fields = {
             'country': {'url': static('data/countries.json'), 'restrict': True, 'others': True},
             'university': {'url': static('data/universities.json')},
@@ -429,6 +435,9 @@ class MentorForm(ApplicationForm):
     )
 
     class Meta(ApplicationForm.Meta):
+        description = _('Help and motivate hackers with your knowledge. Either because you are passionate about it'
+                        ', or if you\'ve graduated more than a year ago and can\'t participate as a hacker, '
+                        'apply now as a mentor!')
         api_fields = {
             'country': {'url': static('data/countries.json'), 'restrict': True, 'others': True},
             'university': {'url': static('data/universities.json')},
diff --git a/application/models.py b/application/models.py
@@ -67,6 +67,16 @@ class ApplicationTypeConfig(models.Model):
     auto_confirm = models.BooleanField(default=False, help_text=_('Applications set on status confirmed by default'))
     compatible_with_others = models.BooleanField(default=False, help_text=_('User can confirm in more than one type'))
 
+    def get_description(self):
+        from application import forms
+        aux = forms
+        lookup = ['%sForm' % self.name.title(), 'Meta', 'description']
+        for item in lookup:
+            aux = getattr(aux, item, None)
+            if aux is None:
+                return ''
+        return aux
+
     def get_file_review_fields(self):
         try:
             return ast.literal_eval(self.file_review_fields)
@@ -211,14 +221,15 @@ class Application(models.Model):
     }
     STATUS_DESCRIPTION = {
         STATUS_NEEDS_CHANGE: _('Your application might have some misleading information. '
-                               'Please edit what the organizing team told you to'),
+                               'Please edit what the organizing team told you to.'),
         STATUS_LAST_REMINDER: _('You have been invited but not accepted yet. '
                                 'In less than 24h you will lose your invitation'),
         STATUS_PENDING: _('The organizing team is reviewing your application. Please be patient.'),
         STATUS_CONFIRMED: _('You have confirmed your application. Can\'t wait seeing you in the hack!'),
         STATUS_INVITED: _('Congratulations! You have been invited, accept your invitation.'),
         STATUS_CANCELLED: _('You have cancelled your application, we hope to see you next year.'),
-        STATUS_EXPIRED: _('Your application have been expired. Please contact us quick if you want to come.'),
+        STATUS_EXPIRED: _('Your application invitation have been expired. '
+                          'Please contact us quick if you want to come.'),
         STATUS_INVALID: _('Your application have been invalidated. It seems you cannot join us with this role.'),
         STATUS_REJECTED: _('We are so sorry, but our hack is full...'),
         STATUS_BLOCKED: _('User was blocked by your organization.'),
diff --git a/application/signals.py b/application/signals.py
@@ -1,3 +1,4 @@
+from django.contrib.auth import get_user_model
 from django.contrib.auth.models import Group
 from django.db.models.signals import post_save, post_delete
 from django.dispatch import receiver
@@ -15,6 +16,8 @@ def clear_groups(sender, instance, **kwargs):
             group.user_set.clear()
             sender.get_default_edition(force_update=True)
             sender.get_last_edition(force_update=True)
+            user_model = get_user_model()
+            user_model.objects.update(qr_code='')
 
 
 @receiver(post_delete, sender=ApplicationTypeConfig)
diff --git a/application/templates/application_home.html b/application/templates/application_home.html
@@ -1,65 +1,20 @@
 {% extends 'base.html' %}
 {% load i18n %}
+{% load util %}
+{% load static %}
 {% block subtitle %}{% translate 'Home' %}{% endblock %}
+{% block head %}
+    <script type="text/javascript" src="{% static 'lib/QRCode/qrcode.min.js' %}"></script>
+{% endblock %}
 {% block content %}
     <div>
         <h1 style="text-align: center">{% translate 'Home' %}</h1>
         <p>{% blocktrans %}This is the main application of {{ app_hack }}. From here you can apply as all the possible roles and participate to {{ app_hack }}.{% endblocktrans %}</p>
-        {% if not accepted_application %}
-            <p>{% blocktrans %}All the applications are reviewed by the organizing team, please be patient if your application is still on review.{% endblocktrans %}</p>
-            <h2>{% translate 'Applicable roles' %} <a class="h6" target="_blank" href="{{ app_landing }}">{% translate 'More info' %}</a></h2>
-
-            {% for application_type in application_types %}
-                <div class="list-group rounded-3" style="margin-bottom: 10px">
-                    {% if application_type.user_instance and application_type.user_instance.invited %}
-                        <div class="list-group-item list-group-item-{{ application_type.user_instance.get_public_status_color|default:theme }} {% if not application_type.user_instance and not application_type.active %}disabled{% endif %}">
-                            <div class="d-flex w-100 justify-content-between">
-                                <h3 class="mb-1">{{ application_type.name }}</h3>
-                                {% if not application_type.user_instance %}
-                                <small>{% if application_type.closed %}{% translate 'Closed' %}{% elif application_type.active %}{% translate 'Open. Closes in' %} {{ application_type.time_left }}{% else %}{% translate 'Closed. Opens in' %} {{ application_type.time_left }}{% endif %}</small>
-                                {% endif %}
-                            </div>
-                            <p>
-                                <strong>{% translate 'Status' %} {% if not application_type.user_instance %}{% translate 'Not applied' %}</strong>{% else %}{{ application_type.user_instance.get_public_status_display }}</strong>: {{ application_type.user_instance.get_public_status_description }}{% endif %}
-                            </p>
-                            <div class="d-grid gap-4 d-flex justify-content-around">
-                                <a style="flex: inherit" href="{% url 'change_status_application' application_type.user_instance.get_uuid application_type.user_instance.STATUS_CANCELLED %}" onclick="return confirm('{% trans 'Are you sure you want to cancel this application?' %}')" class="btn btn-danger col-4">{% trans 'Cancel application' %}</a>
-                                <a style="flex: inherit" href="{% url 'edit_application' application_type.user_instance.get_uuid %}" class="btn btn-secondary col-4">{% trans 'View application' %}</a>
-                                <a style="flex: inherit" href="{% url 'change_status_application' application_type.user_instance.get_uuid application_type.user_instance.STATUS_CONFIRMED %}" onclick="return confirm('{% blocktrans %}Your {{ application_type }} invitation will be confirmed. This means that all your other applications will be cancelled. Are you sure you want to confirm this one?{% endblocktrans %}')" class="btn btn-primary col-4">{% trans 'Confirm invitation' %}</a>
-                        </div>
-                        </div>
-                    {% else %}
-                        <a href="{% if application_type.user_instance %}{% url 'edit_application' application_type.user_instance.get_uuid %}{% elif application_type.active %}{% url 'apply' %}?type={{ application_type.name }}{% endif %}" class="list-group-item list-group-item-action list-group-item-{{ application_type.user_instance.get_public_status_color|default:theme }} {% if not application_type.user_instance and not application_type.active %}disabled{% endif %}">
-                            <div class="d-flex w-100 justify-content-between">
-                                <h3 class="mb-1">{{ application_type.name }}</h3>
-                                {% if not application_type.user_instance %}
-                                <small>{% if application_type.closed %}{% translate 'Closed' %}{% elif application_type.active %}{% translate 'Open. Closes in' %} {{ application_type.time_left }}{% else %}{% translate 'Closed. Opens in' %} {{ application_type.time_left }}{% endif %}</small>
-                                {% endif %}
-                            </div>
-                            <p>
-                                <strong>{% translate 'Status' %} {% if not application_type.user_instance %}{% translate 'Not applied' %}</strong>{% else %}{{ application_type.user_instance.get_public_status_display }}</strong>: {{ application_type.user_instance.get_public_status_description }}{% endif %}
-                            </p>
-                        </a>
-                    {% endif %}
-                </div>
-            {% endfor %}
-
-        {% else %}
-            <p>{% blocktrans %}You confirmed your {{ accepted_application.type.name }} application. See you soon at {{ app_hack }}.{% endblocktrans %}</p>
-            <div class="list-group rounded-3" style="margin-bottom: 10px">
-                <div class="list-group-item list-group-item-{{ accepted_application.get_public_status_color|default:theme }}">
-                    <div class="d-flex w-100 justify-content-between">
-                        <h3 class="mb-1">{{ accepted_application.type.name }}</h3>
-                    </div>
-                    <p>
-                        <strong>{% translate 'Status' %} {{ accepted_application.get_public_status_display }}</strong>: {{ accepted_application.get_public_status_description }}
-                    </p>
-                    <div class="d-grid gap-4 d-flex justify-content-around">
-                        <a href="{% url 'change_status_application' accepted_application.get_uuid accepted_application.STATUS_CANCELLED %}" onclick="return confirm('{% trans 'Are you sure you want to cancel this application? You will lose your invitation.' %}')" class="btn btn-danger col-4">{% trans 'Cancel application' %}</a>
-                        <a style="flex: inherit" href="{% url 'edit_application' accepted_application.get_uuid %}" class="btn btn-secondary col-4">{% trans 'View application' %}</a>
-                    </div>
-                </div>
-            </div>
+        {% if user_applications %}
+            {% include 'application_home/user_applications.html' %}
+        {% endif %}
+        {% if apply_types and not user_applications_grouped|get_item:'C' and not user_applications_grouped|get_item:'A' %}
+            {% include 'application_home/apply.html' %}
         {% endif %}
 
     </div>
diff --git a/application/templates/application_home/apply.html b/application/templates/application_home/apply.html
@@ -0,0 +1,23 @@
+{% load i18n %}
+<div class="mt-2 rounded-3 p-3 bg-contrast">
+    <h2>{% trans 'Apply' %}</h2>
+    {% if user_applications %}
+        <p>{% translate 'You have already applied but if you are interested in any other role, you can apply with them as well' %}</p>
+    {% endif %}
+    <ul>
+        {% for apply_type in apply_types %}
+            <li>
+                {{ apply_type.get_description }}<br>
+                <strong>
+                    {% if apply_type.active %}{% translate 'Closes in' %}{% else %}{% translate 'Opens in' %}{% endif %}{{ apply_type.time_left }}
+                </strong>
+                <div class="row justify-content-around mt-3 mb-3">
+                    <div class="col-6 d-grid d-md-block">
+                        <a href="{% url 'apply' %}?type={{ apply_type.name }}" class="btn {% if user_applications %}btn-secondary{% else %}btn-primary{% endif %} col-12">{% trans 'Apply as' %} {{ apply_type.name }}</a>
+                    </div>
+                </div>
+            </li>
+        {% endfor %}
+    </ul>
+
+</div>
diff --git a/application/templates/application_home/user_applications.html b/application/templates/application_home/user_applications.html
diff --git a/application/views.py b/application/views.py

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,14 @@ footer {`
`140`	`140`	`color: black;`
`141`	`141`	`}`
`142`	`142`
	`143`	`+.bg-dark .bg-contrast {`
	`144`	`+ background-color: rgba(255, 255, 255, 0.075);`
	`145`	`+}`
	`146`	`+`
	`147`	`+.bg-light .bg-contrast {`
	`148`	`+ background-color: rgba(0, 0, 0, 0.075);`
	`149`	`+}`
	`150`	`+`
`143`	`151`	`.g-recaptcha {`
`144`	`152`	`display: inline-block;`
`145`	`153`	`}`