P05/P11: As Participant, I would like to enroll/withdraw for an upcoming Hackathon. #113

mkuti · 2020-10-30T14:08:55Z

Description

Fixes issues #22 - #P05 and #28 - #P11
Followed up the pull request of #S06/#S09 As Staff I would like to enroll/withdraw as a Judge #90, merged from https://github.com/Ri-Dearg/ci-hackathon-app
Separated JS script to its separate file in static folder
Added a filter in my_tags.py to compare end date of hackaton to today's date
Added participants field in the model of Hackaton.
Changed enroll.html to enrollstaff.html and added enrollpart.html inside hackaton/templates/include
Added an if statement on hackatondetail template to show a button to enroll or withdraw that is only visible to participant user.
Added if statement in ajax_enroll view to allow the database to add or remove users as participants.

Pull request type

Related Issue

#22
#28
#35
#38

Testing

Manual testing with a different user type to ensure the button to enroll and its text changes between participant and staff.
Tested the feature of date comparator to ensure the enroll button does not show if hackaton has ended

Screenshots

Additional Information

When testing, noticed that all users are automatically showing as judges or participants and the enrol or withdrawing button does not make changes in the admin panel.
Not sure if this is the type of field, 'ManytoManyField' chosen in the Hackaton model.

Does this introduce a breaking change

[ x] Yes
[] No

Added basic view and connected it to ListView.

Includes logic to display judges and the option to enroll.

Does not process any data yet, simply proof of concept.

Merge with original fork

Toast popup function is reformatted. Fetch now catches errors

This should now fix issues #S09 - Code-Institute-Community#38 and #S06 - Code-Institute-Community#35

The first "Unenroll" click wouldn't change because of whitespace.

S06 - Merging so othes can pull my changes easily.

Merging with Ri-Dearg latest commits for issue S06/S09 on Hackaton app

stefdworschak

@mkuti This is a very good Pull Request and quite complex at that. Well done!! 👍 I have left some minor comments, please have a look and let me know when I can look at the PR again.

Also, there are a lot of migrations that have been changed and deleted. I would prefer to keep the migration history as it is and only add new migrations to alter the databases. Please make sure that you revert those changes before the next review. Thanks!

stefdworschak · 2020-10-30T23:24:16Z

hackathon/fixtures/hackathons.json

@@ -14,6 +14,7 @@
            "organiser":12,


I think this as been resolved in #111 and now creates a merge conflict. Could you please resolve the merge conflict?

stefdworschak · 2020-10-30T23:25:10Z

hackathon/models.py

@@ -66,7 +72,6 @@ class Hackathon(models.Model):
    def __str__(self):
        return self.display_name

-


As per PEP8 there should be two blank lines between classes, please add back the removed line.

stefdworschak · 2020-10-30T23:26:57Z

hackathon/templates/hackathon/hackathon_detail.html

+            {% endif %}
+            {% if hackathon.end_date|event_ended %}
+                {% if request.user.is_staff %}
+                    {% include 'hackathon/includes/enrollstaff.html' %}


It seems a bit much to create separate templates for 5 lines of code. I would just add the code directly in the template.

I followed and respected he code of @ri.dearg for his original enroll.html. I do actually find it clearer with separate templates due to the form. But if you really want me to remove those enroll.html templates and add code directly in hackatondetail.html, I can do it

@TravelTimN Hi Tim, could you have a look at this comment here and let me know if I should still apply the change requested by Stefan. I find it clearer with separate templates.

stefdworschak · 2020-10-30T23:27:50Z

hackathon/templatetags/my_tags.py

@@ -2,6 +2,8 @@
 # range snippet from: https://www.djangosnippets.org/snippets/1357/
 # adjusted to current project needs based on https://docs.djangoproject.com/en/3.1/howto/custom-template-tags/
 from django.template import Library
+import datetime


As per PEP8 standard libraries should be imported first, then 3rd party libraries (e.g. django libraries) and they should be separated by a blank line.

stefdworschak · 2020-10-30T23:28:24Z

hackathon/templatetags/my_tags.py

@@ -2,6 +2,8 @@
 # range snippet from: https://www.djangosnippets.org/snippets/1357/
 # adjusted to current project needs based on https://docs.djangoproject.com/en/3.1/howto/custom-template-tags/
 from django.template import Library
+import datetime
+from django.conf import settings

 register = Library()



Must have overlooked this earlier, but please add an extra blank line here as well.

stefdworschak · 2020-10-30T23:32:38Z

hackathon/views.py

+    # Checks to make sure the user has the permissions to enroll
+    user = request.user
+    data = {}
+    if (request.method == "POST"):


I don't think the parenthesis here are needed.

stefdworschak · 2020-10-30T23:34:34Z

hackathon/views.py

+                data["message"] = "You have enrolled as a judge."
+
+        else:
+            '''Check if user is already enrolled


You are mixing your comment format here. As mentioned above though, I think you can remove this comment as well.

Removed all comments on this view

stefdworschak · 2020-10-30T23:35:33Z

hackathon/views.py

+
+def ajax_enroll_toggle(request):
+    """Swaps between being enrolled as a judge and unenrolling."""
+    # Checks to make sure the user has the permissions to enroll


This comment is not needed. Also, in general you don't need to comment every condition. The code itself should be readable and only on special occasions you should add comments if extra context is necessary. Please remove also the comments below, I think it should be fine to understand what you are trying to achieve.

Did you not leave another comment on removing 'ajax' in the view name and url?

stefdworschak · 2020-10-30T23:40:49Z

static/js/script.js

@@ -1,3 +1,67 @@
+function toastMessage(tag, message) {
+            // Sets the toast HTML.


Please make sure that your indentation here is correct.

stefdworschak · 2020-10-30T23:41:22Z

templates/base.html

@@ -48,6 +48,12 @@
        integrity="sha384-w1Q4orYjBQndcko6MimVbzY0tgp4pWB4lZ7lr30WKz0vr/aWKhXdBNmNb5D92v7s" crossorigin="anonymous">
    </script>
 {% block js %}
+<script>
+// Fires toast popups if there are messages
+{% if messages %}


What is this needed for?

This is from @Ri-Dearg but I am guessing this is to fire toast alert when a message happens in Django. It's explained here: https://pypi.org/project/django-toast-messages/. We need to insert a script in the middle of a django template tag

mkuti · 2020-10-31T12:35:12Z

Thanks :) the most complex code is from @Ri-Dearg though from whom I followed his choice and added few parts to fix the issue of particpant to enrol and withdraw.

TravelTimN

Looking great! Was there a reason the Tertiary Orange color was deleted and a few items changed for the CSS file?

TravelTimN · 2020-11-02T10:33:24Z

static/css/style.css

@@ -10,7 +10,6 @@
    --s-pink: #FF5A60;
    --s-teal: #23BBBB;
    --t-grey: #E0E7FF;
-    --t-orange: #E8461030;


Why was the tertiary orange color?

Hi @TravelTimN I am not sure why was this added or removed. When I pulled last upstream from master, I had a merging conflict on style.css with two very different files. As advised by Stefan, I accepted incoming change and made sure the only change made by @Ri-Dearg before me was saved.Then I committed and pushed.

TravelTimN · 2020-11-02T10:34:04Z

static/css/style.css

+    top: 80px;
+    right: 20px;
+    min-height: 200px;
+    z-index: 1021;
 }


Needs a blank line at the end of the file.

TravelTimN · 2020-11-02T10:34:16Z

templates/includes/messages.html

+        {% endfor %}
+        {% endif %}
+    </div>
+</div>


Needs a blank line at the end of the file.

TravelTimN · 2020-11-02T10:34:40Z

hackathon/templates/hackathon/hackathon_detail.html

+    <script src="{% static 'js/script.js' %}"></script>
+
+{% endblock %}
+{% endif %}


Needs a blank line at the end of the file.

mkuti · 2020-11-03T21:33:24Z

I have applied all changes requested and resolved migration issue as well. There is no current merge conflict.
I have replied to the comment where changes were requested to separate enrollstaff.html and enrollpart.html from hackaton_detail.html as I think it looks clearer separate.
Thanks

stefdworschak

LGTM

Ri-Dearg and others added 28 commits October 19, 2020 15:51

HackathonDetailView added and hooked up.

9ea2d60

Added basic view and connected it to ListView.

Fixed formatting error with unclosed bracket.

2c9ff01

Created Hackathon detail template

2d09b0e

Includes logic to display judges and the option to enroll.

Test ajax view created.

300a98a

Basic Ajax function created

e2b5b8f

Does not process any data yet, simply proof of concept.

Created fetch async form for enrolling.

08068b8

Merge branch 'master' into s06

6074d9f

Merge with original fork

Created message pop-ups as toasts

c7a36d6

Added styling to toast popups.

540313b

Reformatted functions.

0346a9d

Toast popup function is reformatted. Fetch now catches errors

Formatting for verification

e91569a

Ajax enrollment tests added.

1e99b34

This should now fix issues #S09 - Code-Institute-Community#38 and #S06 - Code-Institute-Community#35

Bugfix for the button text script.

da34f40

The first "Unenroll" click wouldn't change because of whitespace.

Merge pull request #1 from Ri-Dearg/s06

dcb9941

S06 - Merging so othes can pull my changes easily.

Merge pull request #1 from Ri-Dearg/master

cd05c86

Merging with Ri-Dearg latest commits for issue S06/S09 on Hackaton app

#ID: Your commit message details

f18a343

#P05: Duplicated enroll.html to make it for participant

dc23773

#P05: Added specific button to enrol as participant

0963bb9

#P05/S06: Moved JS script for enrolling to separate file

730b318

#P05: Added field of participant to Hackaton model

56857b4

Added functionality to enrol as participant

ae37a4e

#P05: Fixed models file

516dbc4

Fixed merging conflicts

bf5a9c9

Added migrations

13981d8

#P05: Reverting models

1339341

Pulled from upstream and fixed merging conflicts

200a312

Added judging_status column to fixtures

c0688b6

#P05/P11:Added date filter to not show enrol if event ended

d1819e3

stefdworschak requested changes Oct 30, 2020

View reviewed changes

stefdworschak added the hacktoberfest-accepted Accepted PR during Hacktoberfest label Oct 31, 2020

mkuti added 4 commits October 31, 2020 11:24

Fixed merge conflict

4ac8ba5

#P05: Re-added one line between models

f6088a1

#P05: Ordered libraries import

860fab9

Fixed indentation

17ad1ab

mkuti added 4 commits November 1, 2020 00:31

Fixed merging conflict after reverting commit

96eda3d

Added upstream changes and fixed merging conflict

b5b9e1e

Changed view name to enroll_toggle

ca6d2fa

Changed url name to add _

f720049

TravelTimN requested changes Nov 2, 2020

View reviewed changes

mkuti added 5 commits November 3, 2020 09:36

Added blank line

d058323

Added blank line at end of file

ffebd4d

Copied style.css from master and added code for toast

9ee951f

Removed a migration file to fix error

fac9015

Fixed url names to add underscore

bcbe730

Added blank lines where needed

5b37dbb

Ri-Dearg mentioned this pull request Nov 5, 2020

#S06/#S09 As Staff I would like to enroll/withdraw as a Judge #90

Closed

16 tasks

stefdworschak approved these changes Nov 5, 2020

View reviewed changes

stefdworschak merged commit 9e97f2b into Code-Institute-Community:master Nov 5, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

P05/P11: As Participant, I would like to enroll/withdraw for an upcoming Hackathon. #113

P05/P11: As Participant, I would like to enroll/withdraw for an upcoming Hackathon. #113

mkuti commented Oct 30, 2020

stefdworschak left a comment

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

mkuti Nov 3, 2020

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

stefdworschak Oct 30, 2020

mkuti Oct 31, 2020

mkuti commented Oct 31, 2020

TravelTimN left a comment

TravelTimN Nov 2, 2020

mkuti Nov 3, 2020

TravelTimN Nov 2, 2020

mkuti Nov 3, 2020

TravelTimN Nov 2, 2020

mkuti Nov 3, 2020

TravelTimN Nov 2, 2020

mkuti Nov 3, 2020

mkuti commented Nov 3, 2020

stefdworschak left a comment

		@@ -66,7 +72,6 @@ class Hackathon(models.Model):
		def __str__(self):
		return self.display_name

		@@ -1,3 +1,67 @@
		function toastMessage(tag, message) {
		// Sets the toast HTML.

P05/P11: As Participant, I would like to enroll/withdraw for an upcoming Hackathon. #113

P05/P11: As Participant, I would like to enroll/withdraw for an upcoming Hackathon. #113

Conversation

mkuti commented Oct 30, 2020

Description

Pull request type

Related Issue

Testing

Screenshots

Additional Information

Does this introduce a breaking change

stefdworschak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkuti commented Oct 31, 2020

TravelTimN left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkuti commented Nov 3, 2020

stefdworschak left a comment

Choose a reason for hiding this comment