Merge pull request #634 from Blueprints-org/630-feature-request-add-comparisonformula-1

630 feature request add comparisonformula

Author: egarciamendez

blueprints/codes/formula.py

@@ -85,3 +85,73 @@ def _evaluate(*args, **kwargs) -> float | bool:
             The result of the formula.
             This is an abstract method and must be implemented in all subclasses.
         """
+
+
+class ComparisonFormula(Formula):
+    """Base class for comparison formulas used in the codes."""
+
+    def __new__(cls, *args, **kwargs) -> "ComparisonFormula":
+        """Method for creating a new instance of the class."""
+        lhs = cls._evaluate_lhs(*args, **kwargs)
+        rhs = cls._evaluate_rhs(*args, **kwargs)
+        result = cls._evaluate(*args, **kwargs)
+        instance = float.__new__(cls, result)
+        instance._lhs = lhs  # noqa: SLF001
+        instance._rhs = rhs  # noqa: SLF001
+        instance._initialized = False  # noqa: SLF001
+        return instance
+
+    @staticmethod
+    @abstractmethod
+    def _evaluate_lhs(*args, **kwargs) -> float:
+        """Abstract method for the logic of the left-hand side of the comparison formula.
+
+        Returns
+        -------
+        float
+            The left-hand side value of the comparison.
+        """
+
+    @staticmethod
+    @abstractmethod
+    def _evaluate_rhs(*args, **kwargs) -> float:
+        """Abstract method for the logic of the right-hand side of the comparison formula.
+
+        Returns
+        -------
+        float
+            The right-hand side value of the comparison.
+        """
+
+    @property
+    def lhs(self) -> float:
+        """Property for getting the left-hand side of the comparison.
+
+        Returns
+        -------
+        float
+            The left-hand side value of the comparison.
+        """
+        return self._lhs  # type: ignore[attr-defined]
+
+    @property
+    def rhs(self) -> float:
+        """Property for getting the right-hand side of the comparison.
+
+        Returns
+        -------
+        float
+            The right-hand side value of the comparison.
+        """
+        return self._rhs  # type: ignore[attr-defined]
+
+    @property
+    @abstractmethod
+    def unity_check(self) -> float:
+        """Property to present the unity check of the formula.
+
+        Returns
+        -------
+        float
+            The unity check.
+        """

tests/codes/test_formula.py

@@ -1,8 +1,8 @@
-"""Module for testing the Formula class."""
+"""Module for testing the Formula classes."""
 
 import pytest
 
-from blueprints.codes.formula import Formula
+from blueprints.codes.formula import ComparisonFormula, Formula
 
 
 class FormulaTest(Formula):
@@ -32,7 +32,6 @@ def _evaluate(
 
 def test_raise_error_when_changing_value_after_initialization() -> None:
     """Test that an error is raised when changing a value after initialization."""
-    # example values
     first = 1
     second = 2
     dummy_testing_formula = FormulaTest(first=first, second=second)
@@ -42,9 +41,111 @@ def test_raise_error_when_changing_value_after_initialization() -> None:
 
 def test_raise_not_implemented_error_detailed_result() -> None:
     """Test that an error is raised when the detailed result is not implemented."""
-    # example values
     first = 1
     second = 2
     dummy_testing_formula = FormulaTest(first=first, second=second)
     with pytest.raises(NotImplementedError):
         _ = dummy_testing_formula.detailed_result
+
+
+class ComparisonFormulaTest(ComparisonFormula):
+    """Dummy comparison formula for testing purposes."""
+
+    label = "Dummy testing comparison formula"
+    source_document = "Dummy testing document"
+
+    def __init__(
+        self,
+        a: float,
+        b: float,
+        c: float,
+    ) -> None:
+        """Dummy comparison formula for testing purposes."""
+        super().__init__()
+        self.a = a
+        self.b = b
+        self.c = c
+
+    @staticmethod
+    def _evaluate(
+        a: float,
+        b: float,
+        c: float,
+    ) -> float:
+        """Dummy formula for testing purposes."""
+        return ComparisonFormulaTest._evaluate_lhs(a=a, b=b) <= ComparisonFormulaTest._evaluate_rhs(c=c)
+
+    @staticmethod
+    def _evaluate_lhs(a: float, b: float, **_) -> float:
+        """Left-hand side value of the comparison."""
+        return a + b
+
+    @staticmethod
+    def _evaluate_rhs(c: float, **_) -> float:
+        """Right-hand side value of the comparison."""
+        return c / 2
+
+    @property
+    def unity_check(self) -> float:
+        """Property to present the unity check of the formula."""
+        return self.lhs / self.rhs
+
+
+def test_comparison_formula_evaluation() -> None:
+    """Test that the formula returns the correct result."""
+    a = 10
+    b = 5
+    c = 40
+
+    # check passing condition (lhs <= rhs) = True
+    formula = ComparisonFormulaTest(a=a, b=b, c=c)
+    assert formula
+
+    # check failing condition (lhs > rhs) = False
+    a = 30
+    formula = ComparisonFormulaTest(a=a, b=b, c=c)
+    assert not formula
+
+
+def test_comparison_formula_lhs_property() -> None:
+    """Test that the lhs property returns the correct result."""
+    a = 10
+    b = 5
+    c = 40
+    formula = ComparisonFormulaTest(a=a, b=b, c=c)
+
+    # The lhs should be a + b = 10 + 5 = 15
+    assert formula.lhs == 15
+
+
+def test_comparison_formula_rhs_property() -> None:
+    """Test that the rhs property returns the correct result."""
+    a = 10
+    b = 5
+    c = 40
+    formula = ComparisonFormulaTest(a=a, b=b, c=c)
+
+    # The rhs should be c / 2 = 40 / 2 = 20
+    assert formula.rhs == 20
+
+
+def test_comparison_formula_unity_check_property() -> None:
+    """Test that the unity check property returns the correct result."""
+    a = 10
+    b = 5
+    c = 40
+    formula = ComparisonFormulaTest(a=a, b=b, c=c)
+
+    # The unity check should be lhs / rhs = 15 / 20 = 0.75
+    assert formula.unity_check == 0.75
+
+
+def test_comparison_formula_change_value_after_initialization() -> None:
+    """Test that an error is raised when changing a value after initialization."""
+    a = 10
+    b = 5
+    c = 40
+    formula = ComparisonFormulaTest(a=a, b=b, c=c)
+
+    with pytest.raises(AttributeError):
+        formula.a = 30