From 99b1c002009ee776f138b513ed528543208a4edc Mon Sep 17 00:00:00 2001
From: yann <yann@needsome.coffee>
Date: Tue, 8 Jul 2025 16:18:43 +0200
Subject: [PATCH] added docstring and comments

---
 server.py              |  6 ++++--
 tests/test_purchase.py | 33 ++++++++++++++++++++++++++++-----
 tests/test_update.py   | 13 +++++++++++++
 3 files changed, 45 insertions(+), 7 deletions(-)
 create mode 100644 tests/test_update.py

diff --git a/server.py b/server.py
index ecdb098..dc9ea82 100644
--- a/server.py
+++ b/server.py
@@ -57,16 +57,20 @@ def purchasePlaces():
     competition = [c for c in competitions if c['name'] == request.form['competition']][0]
     club = [c for c in clubs if c['name'] == request.form['club']][0]
     placesRequired = int(request.form['places'])
+    # check if that's the first book, and update session
     if competition['name'] in session:
         places = {competition['name']: session[competition['name']] + placesRequired}
     else:
         places = {competition['name']: placesRequired}
     points = int(club['points'])
+    # prevent to book more than 12 places
     if placesRequired <= 12:
         if places[competition['name']] <= 12:
+            # prevent to book more than available points
             if placesRequired <= points:
                 competition['numberOfPlaces'] = int(competition['numberOfPlaces']) - placesRequired
                 club['points'] = int(club['points']) - placesRequired
+                # set the session if that's the first book for this competition
                 if not competition['name'] in session:
                     session[competition['name']] = placesRequired
                 flash(f"Great ! {placesRequired} places booked for {competition['name']}")
@@ -86,5 +90,3 @@ def purchasePlaces():
 def logout():
     return redirect(url_for('index'))
 
-if (__name__ == "__main__"):
-    app.run(debug=True)
diff --git a/tests/test_purchase.py b/tests/test_purchase.py
index 5bf951e..3a1f8a6 100644
--- a/tests/test_purchase.py
+++ b/tests/test_purchase.py
@@ -3,8 +3,13 @@ from flask import session
 
 
 class TestPoints:
-    
+   '''
+   testing both case, book with and without enough points
+   '''
     def test_should_nok_when_too_much_points(self, client, connect, club2):
+        '''
+        test booking an amount of places greater than the available points
+        '''
         points = int(connect.span.text)
         club2.update({"places": points+1})
         response = client.post('/purchasePlaces', data=club2)
@@ -12,6 +17,9 @@ class TestPoints:
         assert "You don't have enough points" == soup.li.text
 
     def test_should_ok_when_enough_points(self, client, connect, club2):
+        '''
+        test booking with enough points
+        '''
         points = int(connect.span.text)
         # One remaining point after that :
         club2.update({"places": points-1})
@@ -19,20 +27,25 @@ class TestPoints:
         soup = BeautifulSoup(response.data, "html.parser")
         assert f"Great ! "+str(points-1)+" places booked for "+club2['competition'] == soup.li.text
 
-    def test_book_more_than_one_should_be_refused(self, client, connect, club2):
-        points = int(connect.span.text)
-        assert int(points) == 1 
-
 
 class TestPlaces:
+    '''
+    test the booking limit of 12 places
+    '''
 
     def test_should_refuse_more_12_once(self, client, club2):
+        '''
+        test to book more than 12 places in one shot
+        '''
         club2.update({"places": 13})
         response = client.post('/purchasePlaces', data=club2)
         soup = BeautifulSoup(response.data, "html.parser")
         assert "You can't book more than 12 places" == soup.li.text
 
     def test_should_refuse_more_12_total(self, client, club2):
+        '''
+        test to book more than 12 places in a two-part reservation
+        '''
         club2.update({"places": 1})
         response = client.post('/purchasePlaces', data=club2)
         soup = BeautifulSoup(response.data, "html.parser")
@@ -44,13 +57,23 @@ class TestPlaces:
 
         
 class TestDate:
+    '''
+    test the booking for the past competitions 
+    '''
 
     def test_should_not_display_book_link_for_past_competitions(self, connect):
+        '''
+        test that the booking link isn't displayed when competition date is older than today
+        '''
         li = connect.find_all("li")
         assert not li[0].a
         assert li[1].a
 
     def test_forged_url_on_past_competition_should_raise_flash(self, client):
+        '''
+        test that a flash warning occur when trying to connect to an URL on an old competition
+        '''
         url = '/book/Spring Festival/Iron Temple'
         response = client.get(url)
         assert "You cannot book for a past competition" in response.data.decode()
+
diff --git a/tests/test_update.py b/tests/test_update.py
new file mode 100644
index 0000000..555edd3
--- /dev/null
+++ b/tests/test_update.py
@@ -0,0 +1,13 @@
+
+class TestPointsUpdate:
+
+    def test_should_not_be_ok_the_second_time(self, connect, client, club2):
+        '''
+        this books an amount of points-1 places
+        then test if 1 points remains displayed on page
+        '''
+        points = int(connect.span.text)
+        club2.update({"places": points-1})
+        response = client.post('/purchasePlaces', data=club2)
+        assert f"Great ! {points-1} places booked for {club2['competition']}" in response.data.decode()
+        print(int(connect.span.text))