Merge pull request #27 from jsacerot/main

Adding the groom function and its respective test

Author: nickmckay

pyCatSim/api/cat.py

@@ -211,6 +211,27 @@ def play(self, mood_boost=1, hunger_boost=1, energy_boost=-1):
             self.mood += mood_boost
             self.hunger_level += hunger_boost
             self.energy += energy_boost
+                        
+    def groom(self):
+            
+            """
+            Grooms a cat, increasing its health and mood levels by one unit.
+        
+            
+            Examples
+            --------
+            
+            .. jupyter-execute::
+                
+                import pyCatSim as cats
+                nutmeg = cats.Cat(name = 'Nutmeg', age = 3, color = 'tortoiseshell')
+                nutmeg.groom()
+                
+            
+            """
+            self.mood += 1
+            self.health += 1
+            print(f"{self.name} has been groomed. Health: {self.health}, Mood: {self.mood}")
 
     def eat(self):
         """
@@ -363,4 +384,4 @@ def remove_cat(self,cat):
         try:
             self.catlist.remove(cat)
         except ValueError:
-            raise ValueError("Cat not found in Clowder")
+            raise ValueError("Cat not found in Clowder")

pyCatSim/tests/test_api_Cat.py

@@ -89,6 +89,19 @@ def test_play_t0(self):
 
         assert cat.mood == 3
         assert cat.hunger_level == 0
+        assert cat.energy == 1
+		
+class TestcatCatGroom:
+    ''' Test for the groom function'''
+    
+    def test_groom_t0(self):
+        cat=Cat(name="Boots", age=2, color="tabby", mood=2, hunger_level=-1,
+                energy = 2, health = 3)
+        
+        cat.groom()
+        
+        assert cat.health == 4
+        assert cat.mood == 3
         assert cat.energy == 1  
 
 class TestcatCatEat: