rebrand custom phases as ROIs

halworsen · Mar 2, 2024 · 4aece22 · 4aece22
1 parent fbaf9b4
commit 4aece22
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 13 deletions.
diff --git a/fflogsapi/data/__init__.py b/fflogsapi/data/__init__.py
@@ -10,7 +10,7 @@
                           FFLogsReportComboRanking, FFLogsReportRanking, FFLogsReportTag,
                           FFLogsZoneEncounterRanking, FFLogsZoneRanking, FFMap,)
 
-from .phases import PhaseType, PhaseInformation, OmegaPhaseData, AlexanderPhaseData, ALL_PHASE_DATA
+from .rois import PhaseType, PhaseInformation, OmegaPhaseData, AlexanderPhaseData, ALL_PHASE_DATA
 
 __all__ = [
     # dataclasses.py
@@ -40,7 +40,7 @@
     'FFLogsPartition',
     'FFLogsPhase',
 
-    # .phases
+    # .rois
     'PhaseType',
     'PhaseInformation',
     'OmegaPhaseData',

diff --git a/fflogsapi/data/phases/__init__.py → fflogsapi/data/rois/__init__.py b/fflogsapi/data/phases/__init__.py → fflogsapi/data/rois/__init__.py
diff --git a/fflogsapi/data/phases/alexander.py → fflogsapi/data/rois/alexander.py b/fflogsapi/data/phases/alexander.py → fflogsapi/data/rois/alexander.py
diff --git a/fflogsapi/data/phases/omega.py → fflogsapi/data/rois/omega.py b/fflogsapi/data/phases/omega.py → fflogsapi/data/rois/omega.py
diff --git a/fflogsapi/data/phases/phases.py → fflogsapi/data/rois/phases.py b/fflogsapi/data/phases/phases.py → fflogsapi/data/rois/phases.py
diff --git a/fflogsapi/reports/fight.py b/fflogsapi/reports/fight.py
@@ -183,7 +183,7 @@ def duration(self) -> float:
         return self.end_time() - self.start_time()
 
     @fetch_data('encounterID')
-    def phases(self) -> Optional[list['PhaseInformation']]:
+    def phase_rois(self) -> Optional[list['PhaseInformation']]:
         '''
         WARNING: VERY SLOW!
 

diff --git a/tests/reports/test_phases.py → tests/reports/test_rois.py b/tests/reports/test_phases.py → tests/reports/test_rois.py
@@ -6,9 +6,9 @@
 from ..config import CACHE_EXPIRY, CLIENT_ID, CLIENT_SECRET
 
 
-class FightTest(unittest.TestCase):
+class ROITest(unittest.TestCase):
     '''
-    Test cases for fight phases.
+    Test cases for the ROI toolkit
 
     This test case makes assumptions on the availability of specific reports.
     If the tests break, it may be because visibility settings
@@ -53,7 +53,7 @@ def test_top(self) -> None:
 
         # Test kill
         top_fight = top_report.fight(self.TOP_REPORT[1])
-        phases = top_fight.phases()
+        phases = top_fight.phase_rois()
         # 6 phases and 7 intermissions in total
         self.assertEqual(len(phases), OmegaPhaseData.total_phases())
         self.assertEqual(phases[0].start, top_fight.start_time())
@@ -65,7 +65,7 @@ def test_top(self) -> None:
 
         # Test wipe on P4 (somewhere in the middle)
         top_fight = top_report.fight(self.TOP_REPORT[2])
-        phases = top_fight.phases()
+        phases = top_fight.phase_rois()
         self.assertEqual(len(phases), 6)
         self.assertEqual(phases[0].start, top_fight.start_time())
         self.assertEqual(phases[-1].end, top_fight.end_time())
@@ -85,7 +85,7 @@ def test_top(self) -> None:
 
         # Test a phase 1 wipe
         top_fight = top_report.fight(self.TOP_REPORT[3])
-        phases = top_fight.phases()
+        phases = top_fight.phase_rois()
         self.assertEqual(len(phases), 1)
         self.assertEqual(phases[0].start, top_fight.start_time())
         self.assertEqual(phases[-1].end, top_fight.end_time())
@@ -95,7 +95,7 @@ def test_top(self) -> None:
 
         # Test a phase 6 wipe
         top_fight = top_report.fight(self.TOP_REPORT[4])
-        phases = top_fight.phases()
+        phases = top_fight.phase_rois()
         self.assertEqual(len(phases), OmegaPhaseData.total_phases())
         self.assertEqual(phases[0].start, top_fight.start_time())
         self.assertEqual(phases[-1].end, top_fight.end_time())
@@ -125,7 +125,7 @@ def test_tea(self) -> None:
 
         # Test kill
         tea_fight = tea_report.fight(self.TEA_REPORT[1])
-        phases = tea_fight.phases()
+        phases = tea_fight.phase_rois()
         self.assertEqual(len(phases), AlexanderPhaseData.total_phases())
         self.assertEqual(phases[0].start, tea_fight.start_time())
         self.assertEqual(
@@ -139,7 +139,7 @@ def test_tea(self) -> None:
 
         # Test wipe on temporal stasis
         tea_fight = tea_report.fight(self.TEA_REPORT[2])
-        phases = tea_fight.phases()
+        phases = tea_fight.phase_rois()
         self.assertEqual(len(phases), 4)
         self.assertEqual(phases[0].start, tea_fight.start_time())
         self.assertEqual(phases[-1].end, tea_fight.end_time())
@@ -157,7 +157,7 @@ def test_tea(self) -> None:
 
         # Test a phase 1 wipe
         tea_fight = tea_report.fight(self.TEA_REPORT[3])
-        phases = tea_fight.phases()
+        phases = tea_fight.phase_rois()
         self.assertEqual(len(phases), 1)
         self.assertEqual(phases[0].start, tea_fight.start_time())
         self.assertEqual(
@@ -170,7 +170,7 @@ def test_tea(self) -> None:
 
         # Test a phase 4 wipe just before fate alpha
         tea_fight = tea_report.fight(self.TEA_REPORT[4])
-        phases = tea_fight.phases()
+        phases = tea_fight.phase_rois()
         self.assertEqual(len(phases), 9)
         self.assertEqual(phases[0].start, tea_fight.start_time())
         self.assertEqual(