magicformula class - add process and calc_rank now does ranking only

Author: thobiast

src/magicformulabr/main.py

@@ -297,16 +297,13 @@ def _filter_data(self):
         self._remove_rows(self.ret_on_capital, 0)
         self._remove_rows("Liq.2meses", 0)
 
-    def calc_rank(self):
+    def _calculate_rank(self):
         """
         Calculates the Magic Formula ranking for companies in `pd_df`.
 
         Adds ranking columns to `pd_df` based on the earnings yield and return on capital,
         then calculates a final rank.
         """
-        self._apply_converters()
-        self._filter_data()
-
         if self.pd_df.empty:
             return self.pd_df
 
@@ -323,6 +320,15 @@ def calc_rank(self):
 
         return self.pd_df
 
+    def process(self):
+        """
+        Executes the full Magic Formula process: conversion, filtering, and ranking.
+        """
+        self._apply_converters()
+        self._filter_data()
+        df_ranked = self._calculate_rank()
+        return df_ranked
+
 
 def display_results(df, args):
     """
@@ -388,7 +394,7 @@ def main():
     pd_df = data_handler.get_data()
 
     magicformula = MagicFormula(pd_df, args.method)
-    ranked_df = magicformula.calc_rank()
+    ranked_df = magicformula.process()
     if ranked_df.empty:
         print("No companies passed the filtering criteria. The ranking is empty.")
     else:

tests/test_magicformula_calc_rank.py

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
 """Test calc_rank method."""
 
-from unittest.mock import Mock
-
 import pandas as pd
 import pytest
 
 from magicformulabr.main import MagicFormula
 
 
-@pytest.fixture(scope="function")
-def sample_df():
+@pytest.fixture(name="sample_df", scope="function")
+def _sample_df():
     """Create fake dataframe."""
     dic_com = {"EV/EBIT": [0.2, 8, 4, 2], "ROIC": [10, 60, 40, 90]}
     my_df = pd.DataFrame(data=dic_com, index=["AAAA3", "BBBB3", "CCCC3", "DDDD4"])
     return my_df
 
 
-def test_calc_rank_method_2(sample_df):  # pylint: disable=redefined-outer-name
+def test_calc_rank_method_2(sample_df):
     """Test calc_rank method."""
     expected_result = """\
        EV/EBIT  ROIC  Rank_earnings_yield  Rank_return_on_capital  Rank_Final
@@ -27,7 +25,5 @@ def test_calc_rank_method_2(sample_df):  # pylint: disable=redefined-outer-name
 CCCC3      4.0    40                  3.0                     3.0         6.0"""
 
     magic_formula = MagicFormula(sample_df, magic_method=2)
-    magic_formula._apply_converters = Mock()  # pylint: disable=protected-access
-    magic_formula._filter_data = Mock()  # pylint: disable=protected-access
-    pd_df = magic_formula.calc_rank()
+    pd_df = magic_formula._calculate_rank()  # pylint: disable=protected-access
     assert pd_df.to_string() == expected_result