Merge pull request #28 from Duyi-Li/bathe-feature

Add bathe method to Cat class

Author: khider

.gitignore

@@ -2,4 +2,4 @@
 /pyCatSim/__pycache__
 /pyCatSim/api/__pycache__
 **/__pycache__
-./docs/_build/**
+./docs/_build/**

pyCatSim/api/cat.py

@@ -213,6 +213,32 @@ 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 bathe(self):
+        """
+        Bathes the cat, decreasing mood and improving health.
+
+        Cats typically dislike baths, which lowers their mood,
+        but it improves their cleanliness and boosts health.
+
+        Effects
+        -------
+        - mood: decreases by 1
+        - health: increases by 1
+
+        Examples
+        --------
+        .. jupyter-execute::
+
+            import pyCatSim as cats
+            mochi = cats.Cat(name='Mochi', mood=3, health=5)
+            mochi.bathe()
+            print(mochi.mood)   # Output: 2
+            print(mochi.health) # Output: 6
+        """
+        self.mood -= 1
+        self.health += 1
+
 
     def show(self):
         """
@@ -231,11 +257,7 @@ def show(self):
         except:        
             color = random.choice(possible_colors)
             display.show(color)
-        
-        
-        
-        
-        
+       
 
     def groom(self):
 

pyCatSim/tests/test_api_Cat.py

@@ -92,6 +92,15 @@ def test_play_t0(self):
         assert cat.hunger_level == 0
         assert cat.energy == 1
 
+class TestcatCatBathe:
+    ''' Test for the bathe function '''
+
+    def test_bathe_t0(self):
+        cat = Cat(name="Boots", mood=2, health=4)
+        cat.bathe()
+        assert cat.mood == 1
+        assert cat.health == 5
+
 
 class TestcatCatShow:
     ''' Tests for the Cat.show() method '''
@@ -192,4 +201,3 @@ def test_give_fact_t0(self):
         "The average house cat can run at speeds up to 30 mph.",
         "Cats meow only to communicate with humans."
     ]
-