Refactor configuration handling by renaming ConfigFileKeysEnum to ConfigFileKeys and updating related references

Author: martinmoldrup

README.md

@@ -41,7 +41,7 @@ By default, Toolit looks for a folder named `devtools` in the project root. You
 
 ```toml
 [toolit]
-devtools_folder = "tools"  # Change "tools" to your desired folder name
+tools_folder = "tools"
 ```
 
 ## Create the VS code tasks.json file

tests/configuration_loader_test.py

@@ -4,7 +4,7 @@
 import pytest
 import pathlib
 from toolit import config
-from toolit.constants import ConfigFileKeysEnum
+from toolit.constants import ConfigFileKeys
 
 
 def create_toml_file(path: pathlib.Path, data: dict) -> None:
@@ -84,14 +84,13 @@ def test_load_devtools_folder_returns_configured_path(monkeypatch: pytest.Monkey
     monkeypatch.setattr(
         config,
         "get_config_value",
-        lambda key, default=None: folder if key == ConfigFileKeysEnum.TOOLS_FOLDER else default,
+        lambda key, default=None: folder if key == ConfigFileKeys.TOOLS_FOLDER else default,
     )
     result: pathlib.Path = config.load_devtools_folder()
     assert str(result) == folder
 
 
-def test_load_devtools_folder_returns_default_path(monkeypatch: pytest.MonkeyPatch) -> None:
+def test_load_devtools_folder_returns_default_path() -> None:
     """Test load_devtools_folder returns default folder path if not configured."""
-    monkeypatch.setattr(config, "get_config_value", lambda key, default=None: None)
     result: pathlib.Path = config.load_devtools_folder()
-    assert str(result) == ConfigFileKeysEnum.TOOLS_FOLDER_DEFAULT
+    assert str(result) == ConfigFileKeys.TOOLS_FOLDER_DEFAULT

toolit/config.py

@@ -10,7 +10,7 @@
 
 import toml
 import pathlib
-from .constants import ConfigFileKeysEnum
+from .constants import ConfigFileKeys
 from functools import lru_cache
 from typing import Callable
 
@@ -59,5 +59,5 @@ def get_config_value(key: str, default: str | None = None) -> str | None:
 
 def load_devtools_folder() -> pathlib.Path:
     """Load the tools folder path from configuration or use default."""
-    folder = get_config_value(ConfigFileKeysEnum.TOOLS_FOLDER, ConfigFileKeysEnum.TOOLS_FOLDER_DEFAULT)
-    return pathlib.Path(folder) if isinstance(folder, str) else pathlib.Path(ConfigFileKeysEnum.TOOLS_FOLDER_DEFAULT)
+    folder = get_config_value(ConfigFileKeys.TOOLS_FOLDER, ConfigFileKeys.TOOLS_FOLDER_DEFAULT)
+    return pathlib.Path(folder)

toolit/constants.py

@@ -5,7 +5,7 @@
 MARKER_TOOL = "__toolit_tool_type__"
 
 
-class ConfigFileKeysEnum:
+class ConfigFileKeys:
     """Namespace for the different configuration file keys for user configuration."""
 
     TOOLS_FOLDER: str = "tools_folder"