refactor: Use enums for GPX examples (#105)

Author: ThomasParistech

examples/hiking/araillé.gpx examples/hiking/araille.gpxexamples/hiking/araillé.gpx renamed to examples/hiking/araille.gpx

@@ -0,0 +1,76 @@
+#!/usr/bin/python3
+"""GPX examples."""
+import os
+from enum import auto
+from enum import Enum
+
+from pretty_gpx.common.utils.paths import EXAMPLES_DIR
+
+
+class CyclingGpx(Enum):
+    """Cycling GPX examples."""
+    AMBERIEU = auto()
+    ANCIZAN_PEYRESOURDE_AZET_ASPIN = auto()
+    COUILLOLE = auto()
+    HAWAII = auto()
+    MARMOTTE = auto()
+    SOULOR_AUBISQUE_SPANDELLES = auto()
+    VENTOUX = auto()
+
+    @staticmethod
+    def folder() -> str:
+        """Return the folder where cycling GPX examples are stored."""
+        return os.path.join(EXAMPLES_DIR, 'cycling')
+
+    @property
+    def path(self) -> str:
+        """Path to the GPX file."""
+        return os.path.join(self.folder(), f'{self.name.lower()}.gpx')
+
+
+class HikingGpx(Enum):
+    """Hiking GPX examples."""
+    ARAILLE = auto()
+    CABALIROS = auto()
+    DIAGONALE_DES_FOUS = auto()
+    UTMB = auto()
+    VANOISE = auto()
+    VANOISE_1 = auto()
+    VANOISE_2 = auto()
+    VANOISE_3 = auto()
+
+    @staticmethod
+    def folder() -> str:
+        """Return the folder where hiking GPX examples are stored."""
+        return os.path.join(EXAMPLES_DIR, 'hiking')
+
+    @property
+    def path(self) -> str:
+        """Path to the GPX file."""
+        return os.path.join(self.folder(), f'{self.name.lower()}.gpx')
+
+
+class RunningGpx(Enum):
+    """Running GPX examples."""
+    HALF_MARATHON_DEAUVILLE = auto()
+    MARATHON_BERLIN = auto()
+    MARATHON_BORDEAUX = auto()
+    MARATHON_CHICAGO = auto()
+    MARATHON_LONDON = auto()
+    MARATHON_NEW_YORK = auto()
+    MARATHON_NICE_CANNES = auto()
+    MARATHON_PARIS = auto()
+    MARATHON_RENNES = auto()
+    PARIS_VERSAILLES = auto()
+    ROUTE_4_CHATEAUX = auto()
+    TEN_K_PARIS = auto()
+
+    @staticmethod
+    def folder() -> str:
+        """Return the folder where running GPX examples are stored."""
+        return os.path.join(EXAMPLES_DIR, 'running')
+
+    @property
+    def path(self) -> str:
+        """Path to the GPX file."""
+        return os.path.join(self.folder(), f'{self.name.lower()}.gpx')

examples/hiking/diagonale-des-fous.gpx examples/hiking/diagonale_des_fous.gpxexamples/hiking/diagonale-des-fous.gpx renamed to examples/hiking/diagonale_des_fous.gpx

@@ -9,9 +9,6 @@
 COLOR_EXPLORATION_DIR = os.path.join(DATA_DIR, 'color_exploration')
 
 EXAMPLES_DIR = os.path.join(MAIN_DIR, 'examples')
-CYCLING_DIR = os.path.join(EXAMPLES_DIR, 'cycling')
-HIKING_DIR = os.path.join(EXAMPLES_DIR, 'hiking')
-RUNNING_DIR = os.path.join(EXAMPLES_DIR, 'running')
 
 ASSETS_DIR = os.path.join(MAIN_DIR, 'assets')
 ICONS_DIR = os.path.join(ASSETS_DIR, 'icons')

examples/hiking/vanoise1.gpx examples/hiking/vanoise_1.gpxexamples/hiking/vanoise1.gpx renamed to examples/hiking/vanoise_1.gpx

@@ -1,19 +1,18 @@
 #!/usr/bin/python3
 """Test Bridges."""
-import os
 
+from pretty_gpx.common.data.examples import RunningGpx
 from pretty_gpx.common.gpx.gpx_track import GpxTrack
 from pretty_gpx.common.request.overpass_request import OverpassQuery
 from pretty_gpx.common.utils.asserts import assert_same_keys
-from pretty_gpx.common.utils.paths import RUNNING_DIR
 from pretty_gpx.rendering_modes.city.data.bridges import prepare_download_city_bridges
 from pretty_gpx.rendering_modes.city.data.bridges import process_city_bridges
 
 
-def __core_test_bridges(path: str, gt_names: set[str]) -> None:
+def __core_test_bridges(scene: RunningGpx, gt_names: set[str]) -> None:
     """Test Bridges."""
     # GIVEN
-    gpx = GpxTrack.load(path)
+    gpx = GpxTrack.load(scene.path)
 
     # WHEN
     query = OverpassQuery()
@@ -26,7 +25,7 @@ def __core_test_bridges(path: str, gt_names: set[str]) -> None:
 
 def test_chicago_bridges() -> None:
     """Test Chicago Bridges."""
-    __core_test_bridges(os.path.join(RUNNING_DIR, "marathon_chicago.gpx"),
+    __core_test_bridges(RunningGpx.MARATHON_CHICAGO,
                         {'William P. Fahey Bridge',
                          'State Street Bridge (Chicago)',
                          'Marshall Suloway Bridge',
@@ -37,14 +36,14 @@ def test_chicago_bridges() -> None:
 
 def test_paris_bridges() -> None:
     """Test Paris Bridges."""
-    __core_test_bridges(os.path.join(RUNNING_DIR, "10k_paris.gpx"),
+    __core_test_bridges(RunningGpx.TEN_K_PARIS,
                         {'Pont des Invalides',
                          'Pont du Carrousel'})
 
 
 def test_new_york_bridges() -> None:
     """Test New York Bridges."""
-    __core_test_bridges(os.path.join(RUNNING_DIR, "marathon_new_york.gpx"),
+    __core_test_bridges(RunningGpx.MARATHON_NEW_YORK,
                         {"Madison Avenue Bridge",
                          "Pulaski Bridge",
                          "Willis Avenue Bridge",
@@ -54,7 +53,7 @@ def test_new_york_bridges() -> None:
 
 def test_berlin_bridges() -> None:
     """Test Berlin Bridges."""
-    __core_test_bridges(os.path.join(RUNNING_DIR, "marathon_berlin.gpx"),
+    __core_test_bridges(RunningGpx.MARATHON_BERLIN,
                         {"Charlottenburger Brücke",
                          "Kronprinzenbrücke",
                          "Marchbrücke",
@@ -67,12 +66,12 @@ def test_berlin_bridges() -> None:
 
 def test_london_bridges() -> None:
     """Test London Bridges."""
-    __core_test_bridges(os.path.join(RUNNING_DIR, "marathon_london.gpx"),
+    __core_test_bridges(RunningGpx.MARATHON_LONDON,
                         {"Tower Bridge"})
 
 
 def test_bordeaux_bridges() -> None:
     """Test Bordeaux Bridges."""
-    __core_test_bridges(os.path.join(RUNNING_DIR, "marathon_bordeaux.gpx"),
+    __core_test_bridges(RunningGpx.MARATHON_BORDEAUX,
                         {"Pont de Pierre",
                          "Pont Jacques Chaban-Delmas"})

examples/hiking/vanoise2.gpx examples/hiking/vanoise_2.gpxexamples/hiking/vanoise2.gpx renamed to examples/hiking/vanoise_2.gpx

@@ -1,19 +1,18 @@
 #!/usr/bin/python3
 """Test City Drawer."""
-import os
 
 import matplotlib.pyplot as plt
 
+from pretty_gpx.common.data.examples import RunningGpx
 from pretty_gpx.common.layout.paper_size import PAPER_SIZES
-from pretty_gpx.common.utils.paths import RUNNING_DIR
 from pretty_gpx.rendering_modes.city.drawing.city_drawer import CityDrawer
 from pretty_gpx.rendering_modes.city.drawing.city_params import CityParams
 
 
-def __core_test_city_drawer(path: str) -> None:
+def __core_test_city_drawer(scene: RunningGpx) -> None:
     """Test City Drawer."""
     drawer = CityDrawer(params=CityParams.default(), top_ratio=0.18, bot_ratio=0.22, margin_ratio=0.1)
-    drawer.change_gpx(path, PAPER_SIZES["A4"])
+    drawer.change_gpx(scene.path, PAPER_SIZES["A4"])
     for paper_size in [PAPER_SIZES["32x32"], PAPER_SIZES["A4"], PAPER_SIZES["40x30"]]:
         drawer.change_papersize(paper_size)
         fig, ax = plt.subplots()
@@ -22,4 +21,4 @@ def __core_test_city_drawer(path: str) -> None:
 
 def test_10k_paris_city_drawer() -> None:
     """Test 10k Paris City Drawer."""
-    __core_test_city_drawer(os.path.join(RUNNING_DIR, "10k_paris.gpx"))
+    __core_test_city_drawer(RunningGpx.TEN_K_PARIS)