Calming3 program (#120)

* feat : calming3 program added * doc : CHANGELOG.md updated * fix : tests updated * update : `PROGRAMS.md` updated with new program. --------- Co-authored-by: Sadra Sabouri <[email protected]>
sepandhaghighi · Jan 13, 2025 · fc52cdc · fc52cdc
1 parent 3cb2bc7
commit fc52cdc
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Calming3 program
 ## [0.9] - 2025-01-06
 ### Added
 - Energizing program

diff --git a/PROGRAMS.md b/PROGRAMS.md
@@ -1,6 +1,6 @@
 # Nafas Breathing Programs
 
-**Last Update: 2024-12-13**
+**Last Update: 2025-01-11**
 
 | **Program**         | **Description**                                                                                                                 | **Level**         | **Ratios**<br>**(I:R:E:S)**            | **Unit**<br>**(Seconds)** | **Cycles**      |
 |----------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------|-----------------------|--------------------------|----------------|
@@ -10,6 +10,7 @@
 | Relax3               | Deeper relaxation exercise for stress relief and a more meditative state. Ideal for unwinding after complex projects.        | B<br>M<br>A       | 7:0:11:0<br>7:0:11:0<br>7:0:11:0 | 1<br>1<br>1                | 15<br>20<br>24 |
 | Calming1             | Soothing breathing pattern, helpful for reducing anxiety. Beneficial for long working hours and maintaining calm.           | B<br>M<br>A       | 1:2:1:2<br>1:3:1:3<br>1:4:1:4 | 3<br>3<br>3                | 24<br>22<br>20 |
 | Calming2             | An extended version of the calming routine, providing a longer period of relaxation and anxiety reduction. Useful for balancing high-stress situations. | B<br>M<br>A       | 5:0:5:5<br>5:0:5:5<br>5:0:5:5 | 1<br>1<br>1                | 4<br>6<br>8    |
+| Calming3             | A breathing routine designed to deepen relaxation and improve focus. Suitable for transitioning from mild stress to a state of balance and tranquility. | B<br>M<br>A       | 4:0:6:0<br>6:1:8:4<br>4:1:12:1 | 1<br>1<br>1               | 6<br>8<br>10    |
 | Power                | Energizing breathing, designed for boosting energy and alertness. Suitable for users feeling fatigue.                       | B<br>M<br>A       | 1:2:2:0<br>1:3:2:0<br>1:4:2:0 | 3<br>3<br>3                | 28<br>24<br>20 |
 | Harmony              | Balancing exercise to promote relaxation and focus. Ideal for programmers looking to maintain concentration.                | B<br>M<br>A       | 1:3:2:1<br>1:4:2:1<br>1:5:2:1 | 3<br>3<br>3                | 20<br>18<br>16 |
 | Anti-Stress          | Specialized for stress relief, particularly useful during high-stress tasks or debugging sessions.                             | B<br>M<br>A       | 3:0:0.66:0<br>4:0:0.66:0<br>5:0:0.66:0 | 3<br>3<br>3                | 20<br>17<br>14 |

diff --git a/nafas/params.py b/nafas/params.py
@@ -77,14 +77,15 @@
         4: "Relax3",
         5: "Calming1",
         6: "Calming2",
-        7: "Power",
-        8: "Harmony",
-        9: "Anti-Stress",
-        10: "Anti-Appetite",
-        11: "Cigarette Replace",
-        12: "Decision-Making",
-        13: "Balancing",
-        14: "Energizing"},
+        7: "Calming3",
+        8: "Power",
+        9: "Harmony",
+        10: "Anti-Stress",
+        11: "Anti-Appetite",
+        12: "Cigarette Replace",
+        13: "Decision-Making",
+        14: "Balancing",
+        15: "Energizing"},
     "level": {
         1: "Beginner",
         2: "Medium",
@@ -118,6 +119,12 @@
 
 CALMING2_ADVANCED = {"ratio": [5, 0, 5, 5], "unit": 1, "pre": 3, "cycle": 8}
 
+CALMING3_BEGINNER = {"ratio": [4, 0, 6, 0], "unit": 1, "pre": 3, "cycle": 6}
+
+CALMING3_MEDIUM = {"ratio": [6, 1, 8, 4], "unit": 1, "pre": 3, "cycle": 8}
+
+CALMING3_ADVANCED = {"ratio": [4, 1, 12, 1], "unit": 1, "pre": 3, "cycle": 10}
+
 POWER_BEGINNER = {"ratio": [1, 2, 2, 0], "unit": 3, "pre": 3, "cycle": 28}
 
 POWER_MEDIUM = {"ratio": [1, 3, 2, 0], "unit": 3, "pre": 3, "cycle": 24}
@@ -384,6 +391,9 @@
             "Calming2": {"Beginner": CALMING2_BEGINNER,
                          "Medium": CALMING2_MEDIUM,
                          "Advanced": CALMING2_ADVANCED},
+            "Calming3": {"Beginner": CALMING3_BEGINNER,
+                         "Medium": CALMING3_MEDIUM,
+                         "Advanced": CALMING3_ADVANCED},
             "Power": {"Beginner": POWER_BEGINNER,
                       "Medium": POWER_MEDIUM,
                       "Advanced": POWER_ADVANCED},

diff --git a/test/test.py b/test/test.py
@@ -76,14 +76,15 @@
 4- Relax3 (~ 6 minutes)
 5- Calming1 (~ 9 minutes)
 6- Calming2 (~ 2 minutes)
-7- Power (~ 7 minutes)
-8- Harmony (~ 7 minutes)
-9- Anti-Stress (~ 4 minutes)
-10- Anti-Appetite (~ 10 minutes)
-11- Cigarette Replace (~ 5 minutes)
-12- Decision-Making (~ 2 minutes)
-13- Balancing (~ 2 minutes)
-14- Energizing (~ 2 minutes)
+7- Calming3 (~ 2 minutes)
+8- Power (~ 7 minutes)
+9- Harmony (~ 7 minutes)
+10- Anti-Stress (~ 4 minutes)
+11- Anti-Appetite (~ 10 minutes)
+12- Cigarette Replace (~ 5 minutes)
+13- Decision-Making (~ 2 minutes)
+14- Balancing (~ 2 minutes)
+15- Energizing (~ 2 minutes)
 - Choose a level:
 <BLANKLINE>
 1- Beginner