From 88b8f5cbb034476a36d26df704811a14c749b5ca Mon Sep 17 00:00:00 2001
From: Lucas Queiroz <lucas.fn4@gmail.com>
Date: Fri, 9 Aug 2024 23:04:00 -0300
Subject: [PATCH] feat: adds ira calculator with unit tests

---
 api/utils/ira_calculator.py            | 37 ++++++++++++++++++
 api/utils/tests/test_ira_calculator.py | 52 ++++++++++++++++++++++++++
 2 files changed, 89 insertions(+)
 create mode 100644 api/utils/ira_calculator.py
 create mode 100644 api/utils/tests/test_ira_calculator.py

diff --git a/api/utils/ira_calculator.py b/api/utils/ira_calculator.py
new file mode 100644
index 0000000..9e34e88
--- /dev/null
+++ b/api/utils/ira_calculator.py
@@ -0,0 +1,37 @@
+class IraCalculator:
+    def __init__(self) -> None:
+        self.mencaoMap = {
+            'SS': 5,
+            'MS': 4,
+            'MM': 3,
+            'MI': 2,
+            'II': 1,
+            'SR': 0,
+        }
+
+    def get_ira_value(self, mencoes):
+        """
+        Obter o valor do IRA a partir de um conjunto de menções.
+
+        :param mencoes: A lista de menções. Uma menção está no formato {'mencao': string, 'qtdCreditos': int, 'semestre': int}.
+        """
+        valor_final = 0
+        for mencao in mencoes:
+
+            if not (1 <= mencao['semestre'] <= 6):
+                raise ValueError
+
+            if mencao['mencao'] not in self.mencaoMap.keys():
+                raise ValueError
+
+            numerador = self.mencaoMap[mencao['mencao']] * \
+                mencao['qtdCreditos'] * \
+                mencao['semestre']
+
+            denominador = mencao['qtdCreditos'] * mencao['semestre']
+            valor_final += numerador/denominador
+
+        return valor_final
+            
+
+
diff --git a/api/utils/tests/test_ira_calculator.py b/api/utils/tests/test_ira_calculator.py
new file mode 100644
index 0000000..22abb98
--- /dev/null
+++ b/api/utils/tests/test_ira_calculator.py
@@ -0,0 +1,52 @@
+from django.test import TestCase
+from utils.ira_calculator import IraCalculator
+
+
+class IraTestCase(TestCase):
+    def setUp(self):
+        self.ira_calc = IraCalculator()
+
+    def test_one_discipline_with_MM(self):
+        args = [
+            {
+                'mencao': 'MM',
+                'semestre': 1,
+                'qtdCreditos': 2,
+            }
+        ]
+
+        self.assertEqual(self.ira_calc.get_ira_value(args), 3)
+
+    def test_discipline_with_right_out_of_bounds_semester_value(self):
+        args = [
+            {
+                'mencao': 'MM',
+                'semestre': 7,
+                'qtdCreditos': 2,
+            },
+        ]
+
+        self.assertRaises(ValueError, self.ira_calc.get_ira_value, args)
+
+    def test_discipline_with_left_out_of_bounds_semester_value(self):
+        args = [
+            {
+                'mencao': 'MM',
+                'semestre': 0,
+                'qtdCreditos': 2,
+            },
+        ]
+
+        self.assertRaises(ValueError, self.ira_calc.get_ira_value, args)
+
+
+    def test_inexistent_grade(self):
+        args = [
+            {
+                'mencao': 'NE',
+                'semestre': 3,
+                'qtdCreditos': 2,
+            },
+        ]
+        self.assertRaises(ValueError, self.ira_calc.get_ira_value, args)
+