Implement deletion of singular contact + its tests, update documentation

dokumentaatio/changelog.md

@@ -31,3 +31,6 @@
 
 - Testattu että käyttäjän rekisteröityminen ja kirjautuminen toimii oikeilla tunnuksilla ja epäonnistuu liian lyhyillä, käytössä olevilla tai väärillä tunnuksilla
 - Testattu että kontaktien luominen, hakeminen ja poistaminen toimii odotetulla tavalla kirjautuneelle käyttäjälle
+- Käyttäjä voi kirjautuneena ollessaan poistaa yksittäisen lisäämänsä yhteystiedon graafisen käyttöliittymän kautta
+- Lisätty käyttöohjeet, docstring-dokumentaatio sekä laajempi arkkitehtuurikuvaus
+- Parannettu koodin laatua ja luettavuutta

dokumentaatio/kayttoohje.md

@@ -44,6 +44,12 @@ Kirjautunut käyttäjä voi nähdä yhteystietojen listausnäkymän, jonka yllä
 
 Luomisnäkymässä käyttäjä voi syöttää uuden yhteystiedon etu- ja sukunimen, sähköpostiosoitteen, puhelinnumeron sekä roolin ja lopuksi painaa "Create"-painiketta luodakseen yhteystiedon ja lisätäkseen sen omaan yhteystietolistaansa. Tämän jälkeen käyttäjä siirtyy takaisin listausnäkymään, johon uusi yhteystieto on ilmestynyt. "Cancel"-painiketta painamalla käyttäjä siirtyy takaisin listausnäkymään luomatta uutta yhteystietoa.
 
-![](./image/screenshot-list-delete.png)
+![](./image/screenshot-list-delete-all.png)
 
-Käyttäjä voi nähdä luomansa yhteystiedot listausnäkymässä. Käyttäjä voi poistaa kaikki luomansa yhteystiedot ja tyhjentää yhteystietolistansa painamalla "Delete all"-painiketta. Käyttäjä voi myös kirjautua ulos sovelluksesta painamalla "Log out"-painiketta, joka siirtää käyttäjän takaisin kirjautumisnäkymään.
+Käyttäjä voi nähdä luomansa yhteystiedot listausnäkymässä. Käyttäjä voi poistaa kaikki luomansa yhteystiedot ja tyhjentää yhteystietolistansa painamalla "Delete all"-painiketta.
+
+![](./image/screenshot-list-delete-one.png)
+
+Käyttäjä voi poistaa yksittäisen yhteystiedon painamalla "X"-painiketta kyseisen yhteystiedon kohdalla.
+
+Käyttäjä voi myös kirjautua ulos sovelluksesta painamalla "Log out"-painiketta, joka siirtää käyttäjän takaisin kirjautumisnäkymään.

dokumentaatio/tuntikirjanpito.md

@@ -13,4 +13,5 @@
 | 23.4. | 4        | Kontaktilistan käyttöliittymän parannukset, kontaktien poiston toteutus, kontaktirepositorion testit, dokumentaatio |
 | 25.4. | 3        | UserServicen ja ContactServicen testien implementointi, user id:n tarkistamisen refaktorointi                       |
 | 26.4. | 3        | Käyttöohjeiden lisääminen, käyttöliittymäkoodin siistiminen, arkkitehtuurikuvaus, docstring-dokumentaatio           |
-| Yht   | 27       |                                                                                                                     |
+| 28.4. | 1        | Yksittäisen yhteystiedon poiston toteutus, testit ja dokumentaatio toiminnallisuudelle                              |
+| Yht   | 28       |                                                                                                                     |

src/repositories/contact_repository.py

@@ -76,16 +76,17 @@ def delete_all(self, user_id):
         cursor.execute("DELETE FROM contacts WHERE user = ?", (user_id, ))
         self._connection.commit()
 
-    def delete_one(self, contact_id):
+    def delete_one(self, user_id, contact_id):
         """Poistaa yhden kontaktin annetun id'n perusteella.
 
         Args:
+            user_id: käyttäjän id, jonka luoma kontakti poistetaan
             contact_id: poistettavan kontaktin id 
         """
 
         cursor = self._connection.cursor()
         cursor.execute(
-            "DELETE FROM contacts WHERE id = ?", (contact_id, ))
+            "DELETE FROM contacts WHERE id = ? AND user = ?", (contact_id, user_id, ))
         self._connection.commit()
 
     def create(self, contact):

src/services/contact_service.py

@@ -83,15 +83,26 @@ def delete_all(self, user_id):
 
         Args:
             user_id käyttäjän id
+        """
 
-        Returns:
-            Palauttaa listan Contact-olioita
+        if user_id is None:
+            raise NoUserError("No user is logged in.")
+
+        self._contact_repository.delete_all(user_id)
+
+    def delete_one(self, user_id, contact_id):
+        """Tarkistaa käyttäjän id'n ja kutsuu contact_repositoryn delete_one-metodia 
+        poistaakseen yhden kontaktin annetun id'n perusteella.
 
+        Args: 
+            user_id käyttäjän id
+            contact_id poistettavan käyttäjän id 
         """
+
         if user_id is None:
             raise NoUserError("No user is logged in.")
 
-        self._contact_repository.delete_all(user_id)
+        self._contact_repository.delete_one(user_id, contact_id)
 
 
 contact_service = ContactService()

src/tests/repositories/contact_repository_test.py

@@ -57,6 +57,6 @@ def test_delete_all(self):
 
     def test_delete_one(self):
         contact_repository.create(self.contact_one)
-        contact_repository.delete_one(self.contact_one.id)
+        contact_repository.delete_one(self.user_one.id, self.contact_one.id)
         contact = contact_repository.find_one(self.contact_one.id)
         self.assertEqual(contact, None)

src/tests/services/contact_service_test.py

@@ -16,7 +16,9 @@ def __init__(self):
         self.contacts = []
 
     def create(self, contact):
+        contact.id = uuid.uuid4().hex
         self.contacts.append(contact)
+        return contact
 
     def find_all(self, user_id):
         return [contact for contact in self.contacts if contact.user == user_id]
@@ -25,6 +27,10 @@ def delete_all(self, user_id):
         self.contacts = [
             contact for contact in self.contacts if contact.user != user_id]
 
+    def delete_one(self, user_id, contact_id):
+        self.contacts = [
+            contact for contact in self.contacts if not (contact.user == user_id and contact.id == contact_id)]
+
 
 class FakeUserRepository:
     def __init__(self, users=None):
@@ -84,6 +90,17 @@ def test_delete_all(self):
         contacts = self.contact_service.get_contacts(user.id)
         self.assertEqual(len(contacts), 0)
 
+    def test_delete_one(self):
+        user = User('testusername', 'testpassword', '123')
+        contact = self.contact_service.create_contact(
+            'Pekka', 'Pouta', '[email protected]', '123456789', 'Meteorologi', user.id)
+
+        self.contact_service.delete_one(user.id, contact.id)
+
+        contacts = self.contact_service.get_contacts(user.id)
+        self.assertEqual(len(contacts), 0)
+        print(len(contacts))
+
     def test_create_contact_without_user(self):
         with self.assertRaises(NoUserError):
             self.contact_service.create_contact(
@@ -93,6 +110,10 @@ def test_delete_all_without_user(self):
         with self.assertRaises(NoUserError):
             self.contact_service.delete_all(None)
 
+    def test_delete_one_without_user(self):
+        with self.assertRaises(NoUserError):
+            self.contact_service.delete_one(None, "1")
+
     def test_get_contacts_without_user(self):
         with self.assertRaises(NoUserError):
             self.contact_service.get_contacts(None)

src/ui/contacts_view.py

@@ -9,14 +9,15 @@ class ContactCreationError(Exception):
 
 
 class ContactsView:
-    def __init__(self, root, handle_logout, handle_create, handle_delete):
+    def __init__(self, root, handle_logout, handle_create, handle_delete_all, handle_delete_one):
         self._root = root
         self._frame = None
         self._canvas = None
         self._scrollbar = None
         self._handle_logout = handle_logout
         self._handle_create = handle_create
-        self._handle_delete = handle_delete
+        self._handle_delete_all = handle_delete_all
+        self._handle_delete_one = handle_delete_one
         self._contacts = []
         self._contact_form_frame = None
         self._contact_form_view = None
@@ -35,7 +36,11 @@ def _logout_handler(self):
 
     def _delete_all_handler(self):
         contact_service.delete_all(self._user.id)
-        self._handle_delete()
+        self._handle_delete_all()
+
+    def _delete_one_handler(self, contact_id):
+        contact_service.delete_one(self._user.id, contact_id)
+        self._handle_delete_one()
 
     def _initialize(self):
         self._frame = ttk.Frame(master=self._root)
@@ -130,4 +135,16 @@ def _initialize_contact(self, contact):
             value_label.grid(row=row, column=column + 1, sticky="w",
                              padx=padx_value)
 
+        delete_button = ttk.Button(
+            master=contact_frame,
+            text="X",
+            command=lambda: self._delete_one_handler(contact.id),
+            style="Red.TButton",
+        )
+        delete_button.grid(row=0, column=5, sticky="ne")
+
+        style = ttk.Style()
+        style.map("Red.TButton", background=[
+            ('active', 'red'), ('!active', 'lightgrey')], )
+
         contact_frame.pack(fill=constants.X, expand=True, padx=10, pady=(5, 0))

src/ui/ui.py

@@ -49,7 +49,7 @@ def _show_register_view(self):
     def _show_contacts_view(self):
         self._hide_current_view()
         self._current_view = ContactsView(
-            self._root, self._show_login_view, self._show_contact_form_view, self._show_contacts_view)
+            self._root, self._show_login_view, self._show_contact_form_view, self._show_contacts_view, self._show_contacts_view)
         self._current_view.pack()
 
     def _show_contact_form_view(self):