bump(release): v0.1.1 → v0.2.0

* refactor(application): refactor questions to separate class
* test(application): add tests for`Application` class

.devcontainer/devcontainer.json

@@ -89,9 +89,9 @@
     "remoteUser": "vscode",
     "postCreateCommand": "bash ./.devcontainer/post-install.sh",
     "mounts": [
-        // "source=${localEnv:HOME}/.git_stop_words,target=/home/vscode/.git_stop_words,type=bind,consistency=cached",
-        // "source=${localEnv:HOME}/.gitconfig.local,target=/home/vscode/.gitconfig.local,type=bind,consistency=cached",
-        // "source=${localEnv:HOME}/tmp,target=/home/vscode/tmp,type=bind"
+        "source=${localEnv:HOME}/.git_stop_words,target=/home/vscode/.git_stop_words,type=bind,consistency=cached",
+        "source=${localEnv:HOME}/.gitconfig.local,target=/home/vscode/.gitconfig.local,type=bind,consistency=cached",
+        "source=${localEnv:HOME}/tmp,target=/home/vscode/tmp,type=bind"
     ]
 
     // Use 'forwardPorts' to make a list of ports inside the container available locally.

.github/workflows/pypi-release.yml

@@ -20,8 +20,16 @@ jobs:
         steps:
             - uses: step-security/harden-runner@18bf8ad2ca49c14cbb28b91346d626ccfb00c518 # v2.1.0
               with:
-                  egress-policy: audit
+                  egress-policy: block
                   disable-sudo: true
+                  allowed-endpoints: >
+                      api.github.com:443
+                      files.pythonhosted.org:443
+                      github.com:443
+                      install.python-poetry.org:443
+                      pypi.org:443
+                      python-poetry.org:443
+                      upload.pypi.org:443
 
             - name: Checkout repository
               uses: actions/checkout@v3

.pre-commit-config.yaml

@@ -5,7 +5,7 @@ default_stages: [commit, manual]
 fail_fast: true
 repos:
     - repo: "https://github.com/commitizen-tools/commitizen"
-      rev: v2.39.1
+      rev: v2.40.0
       hooks:
           - id: commitizen
           - id: commitizen-branch
@@ -39,6 +39,7 @@ repos:
           - id: check-shebang-scripts-are-executable
           - id: check-symlinks
           - id: check-toml
+            exclude: broken_config_file\.toml
           - id: check-vcs-permalinks
           - id: check-xml
           - id: check-yaml
@@ -60,7 +61,7 @@ repos:
             entry: yamllint --strict --config-file .yamllint.yml
 
     - repo: "https://github.com/charliermarsh/ruff-pre-commit"
-      rev: "v0.0.229"
+      rev: "v0.0.230"
       hooks:
           - id: ruff
             args: ["--extend-ignore", "I001,D301,D401,PLR2004"]

CHANGELOG.md

@@ -1,3 +1,20 @@
+## v0.2.0 (2023-01-25)
+
+### Feat
+
+- **configuration**: support multiple vaults in the configuration file (#6)
+
+### Refactor
+
+- **application**: refactor questions to separate class (#7)
+
+## v0.1.1 (2023-01-23)
+
+### Fix
+
+- **notes**: diff now prints values in the form `[value]`
+- **application**: exit after committing changes
+
 ## v0.1.0 (2023-01-22)
 
 ### Feat

README.md

@@ -2,34 +2,29 @@
 # obsidian-metadata
 A script to make batch updates to metadata in an Obsidian vault.  Provides the following capabilities:
 
-- in-text tag: delete every occurrence
-- in-text tags: Rename tag (`#tag1` -> `#tag2`)
-- frontmatter: Delete a key matching a regex pattern and all associated values
-- frontmatter: Rename a key
-- frontmatter: Delete a value matching a regex pattern from a specified key
-- frontmatter: Rename a value from a specified key
-- inline metadata: Delete a key matching a regex pattern and all associated values
-- inline metadata: Rename a key
-- inline metadata: Delete a value matching a regex pattern from a specified key
-- inline metadata: Rename a value from a specified key
-- vault: Create a backup of the Obsidian vault
+- `in-text tag`: delete every occurrence
+- `in-text tags`: Rename tag (`#tag1` -> `#tag2`)
+- `frontmatter`: Delete a key matching a regex pattern and all associated values
+- `frontmatter`: Rename a key
+- `frontmatter`: Delete a value matching a regex pattern from a specified key
+- `frontmatter`: Rename a value from a specified key
+- `inline metadata`: Delete a key matching a regex pattern and all associated values
+- `inline metadata`: Rename a key
+- `inline metadata`: Delete a value matching a regex pattern from a specified key
+- `inline metadata`: Rename a value from a specified key
+- `vault`: Create a backup of the Obsidian vault
 
 
 ## Install
 `obsidian-metadata` requires Python v3.10 or above.
 
-
-Use [PIPX](https://pypa.github.io/pipx/) to install this package from Github.
-
 ```bash
-pipx install git+https://${GITHUB_TOKEN}@github.com/natelandau/obsidian-metadata
+pip install obsidian-metadata
 ```
 
 
-## Disclaimer
-**Important:** It is strongly recommended that you back up your vault prior to committing changes. This script makes changes directly to the markdown files in your vault. Once the changes are committed, there is no ability to recreate the original information unless you have a backup.  Follow the instructions in the script to create a backup of your vault if needed.
-
-The author of this script is not responsible for any data loss that may occur. Use at your own risk.
+## Important Disclaimer
+**It is strongly recommended that you back up your vault prior to committing changes.** This script makes changes directly to the markdown files in your vault. Once the changes are committed, there is no ability to recreate the original information unless you have a backup.  Follow the instructions in the script to create a backup of your vault if needed.  The author of this script is not responsible for any data loss that may occur. Use at your own risk.
 
 ## Usage
 The script provides a menu of available actions. Make as many changes as you require and review them as you go.  No changes are made to the Vault until they are explicitly committed.
@@ -38,16 +33,27 @@ The script provides a menu of available actions. Make as many changes as you req
 
 
 ### Configuration
-`obsidian-metadata` requires a configuration file at `~/.obsidian_metadata.toml`.  On first run, this file will be created.  Read the comments in this file to configure your preferences.  This configuration file contains the following information.
+`obsidian-metadata` requires a configuration file at `~/.obsidian_metadata.toml`.  On first run, this file will be created.  You can specify a new location for the configuration file with the `--config-file` option.
+
+To add additional vaults, copy the default section and add the appropriate information. The script will prompt you to select a vault if multiple exist in the configuration file
+
+Below is an example with two vaults.
 
 ```toml
-# Path to your obsidian vault
-vault = "/path/to/vault"
+["Vault One"] # Name of the vault.
 
-# Folders within the vault to ignore when indexing metadata
-exclude_paths = [".git", ".obsidian"]
+    # Path to your obsidian vault
+    path = "/path/to/vault"
+
+    # Folders within the vault to ignore when indexing metadata
+    exclude_paths = [".git", ".obsidian"]
+
+["Vault Two"]
+    path = "/path/to/second_vault"
+    exclude_paths = [".git", ".obsidian"]
 ```
 
+To bypass the configuration file and specify a vault to use at runtime use the `--vault-path` option.
 
 
 # Contributing
@@ -56,7 +62,7 @@ exclude_paths = [".git", ".obsidian"]
 
 There are two ways to contribute to this project.
 
-### 21. Containerized development (Recommended)
+### 1. Containerized development (Recommended)
 
 1. Clone this repository. `git clone https://github.com/natelandau/obsidian-metadata`
 2. Open the repository in Visual Studio Code

poetry.lock

@@ -699,7 +699,7 @@ python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*"
 name = "tomli"
 version = "2.0.1"
 description = "A lil' TOML parser"
-category = "main"
+category = "dev"
 optional = false
 python-versions = ">=3.7"
 
@@ -707,7 +707,7 @@ python-versions = ">=3.7"
 name = "tomlkit"
 version = "0.11.6"
 description = "Style preserving TOML library"
-category = "dev"
+category = "main"
 optional = false
 python-versions = ">=3.6"
 
@@ -814,7 +814,7 @@ dev = ["black (>=19.3b0)", "pytest (>=4.6.2)"]
 [metadata]
 lock-version = "1.1"
         python-versions = "^3.10"
-content-hash = "db4a41f0b94c3bf84fa548a6733da1cced1fedc2bdfdc6f80396dddbd5619bfd"
+content-hash = "acbde0d9374261931e4f12f4ed8fcbc543008f68c4aed0a6748280a3999b3394"
 
 [metadata.files]
 absolufy-imports = [

pyproject.toml

@@ -11,7 +11,7 @@
     name        = "obsidian-metadata"
     readme      = "README.md"
     repository  = "https://github.com/natelandau/obsidian-metadata"
-    version     = "0.1.0"
+    version     = "0.2.0"
 
     [tool.poetry.scripts] # https://python-poetry.org/docs/pyproject/#scripts
         obsidian-metadata = "obsidian_metadata.cli:app"
@@ -23,7 +23,7 @@
         rich        = "^13.2.0"
         ruamel-yaml = "^0.17.21"
         shellingham = "^1.4.0"
-        tomli       = "^2.0.1"
+        tomlkit     = "^0.11.6"
         typer       = "^0.7.0"
 
     [tool.poetry.group.test.dependencies]
@@ -142,7 +142,7 @@
     bump_message = "bump(release): v$current_version → v$new_version"
     tag_format = "v$version"
     update_changelog_on_bump = true
-    version = "0.1.0"
+    version = "0.2.0"
     version_files = [
         "pyproject.toml:version",
         "src/obsidian_metadata/__version__.py:__version__",

src/obsidian_metadata/__version__.py

@@ -1,2 +1,2 @@
 """obsidian-metadata version."""
-__version__ = "0.1.0"
+__version__ = "0.2.0"

src/obsidian_metadata/_config/__init__.py

@@ -1,5 +1,5 @@
 """Config module for obsidian frontmatter."""
 
-from obsidian_metadata._config.config import Config
+from obsidian_metadata._config.config import Config, VaultConfig
 
-__all__ = ["Config"]
+__all__ = ["Config", "VaultConfig"]

src/obsidian_metadata/_config/config.py

@@ -1,61 +1,89 @@
 """Instantiate the configuration object."""
 
-import re
-import shutil
+
 from pathlib import Path
+from textwrap import dedent
 from typing import Any
 
 import questionary
 import rich.repr
+import tomlkit
 import typer
 
-from obsidian_metadata._utils import alerts, vault_validation
+from obsidian_metadata._utils import alerts
 from obsidian_metadata._utils.alerts import logger as log
 
-try:
-    import tomllib
-except ModuleNotFoundError:
-    import tomli as tomllib  # type: ignore [no-redef]
 
-DEFAULT_CONFIG_FILE: Path = Path(__file__).parent / "default.toml"
+class ConfigQuestions:
+    """Questions to ask the user when creating a configuration file."""
+
+    @staticmethod
+    def ask_for_vault_path() -> Path:  # pragma: no cover
+        """Ask the user for the path to their vault.
+
+        Returns:
+            Path: The path to the vault.
+        """
+        vault_path = questionary.path(
+            "Enter a path to Obsidian vault:",
+            only_directories=True,
+            validate=ConfigQuestions._validate_valid_dir,
+        ).ask()
+        if vault_path is None:
+            raise typer.Exit(code=1)
+
+        return Path(vault_path).expanduser().resolve()
+
+    @staticmethod
+    def _validate_valid_dir(path: str) -> bool | str:
+        """Validates a valid directory.
+
+        Returns:
+            bool | str: True if the path is valid, otherwise a string with the error message.
+        """
+        path_to_validate: Path = Path(path).expanduser().resolve()
+        if not path_to_validate.exists():
+            return f"Path does not exist: {path_to_validate}"
+        if not path_to_validate.is_dir():
+            return f"Path is not a directory: {path_to_validate}"
+
+        return True
 
 
 @rich.repr.auto
 class Config:
-    """Configuration class."""
+    """Representation of a configuration file."""
 
     def __init__(self, config_path: Path = None, vault_path: Path = None) -> None:
-        self.config_path: Path = self._validate_config_path(Path(config_path))
-        self.config: dict[str, Any] = self._load_config()
-        self.config_content: str = self.config_path.read_text()
-        self.vault_path: Path = self._validate_vault_path(vault_path)
+
+        if vault_path is None:
+            self.config_path: Path = self._validate_config_path(Path(config_path))
+            self.config: dict[str, Any] = self._load_config()
+
+            if self.config == {}:
+                log.error(f"Configuration file is empty: '{self.config_path}'")
+                raise typer.Exit(code=1)
+        else:
+            self.config_path = None
+            self.config = {
+                "command_line_vault": {"path": vault_path, "exclude_paths": [".git", ".obsidian"]}
+            }
 
         try:
-            self.exclude_paths: list[Any] = self.config["exclude_paths"]
-        except KeyError:
-            self.exclude_paths = []
-
-        try:
-            self.metadata_location: str = self.config["metadata"]["metadata_location"]
-        except KeyError:
-            self.metadata_location = "frontmatter"
-
-        try:
-            self.tags_location: str = self.config["metadata"]["tags_location"]
-        except KeyError:
-            self.tags_location = "top"
+            self.vaults: list[VaultConfig] = [
+                VaultConfig(vault_name=key, vault_config=self.config[key]) for key in self.config
+            ]
+        except TypeError as e:
+            log.error(f"Configuration file is invalid: '{self.config_path}'")
+            raise typer.Exit(code=1) from e
 
         log.debug(f"Loaded configuration from '{self.config_path}'")
         log.trace(self.config)
 
     def __rich_repr__(self) -> rich.repr.Result:  # pragma: no cover
-        """Define rich representation of Vault."""
+        """Define rich representation of the Config object."""
         yield "config_path", self.config_path
-        yield "config_content",
-        yield "vault_path", self.vault_path
-        yield "metadata_location", self.metadata_location
-        yield "tags_location", self.tags_location
-        yield "exclude_paths", self.exclude_paths
+        yield "vaults", self.vaults
 
     def _validate_config_path(self, config_path: Path | None) -> Path:
         """Load the configuration path."""
@@ -63,7 +91,7 @@ class Config:
             config_path = Path(Path.home() / f".{__package__.split('.')[0]}.toml")
 
         if not config_path.exists():
-            shutil.copy(DEFAULT_CONFIG_FILE, config_path)
+            self._write_default_config(config_path)
             alerts.info(f"Created default configuration file at '{config_path}'")
 
         return config_path.expanduser().resolve()
@@ -71,46 +99,67 @@ class Config:
     def _load_config(self) -> dict[str, Any]:
         """Load the configuration file."""
         try:
-            with self.config_path.open("rb") as f:
-                return tomllib.load(f)
-        except tomllib.TOMLDecodeError as e:
+            with open(self.config_path, encoding="utf-8") as fp:
+                return tomlkit.load(fp)
+        except tomlkit.exceptions.TOMLKitError as e:
             alerts.error(f"Could not parse '{self.config_path}'")
             raise typer.Exit(code=1) from e
 
+    def _write_default_config(self, path_to_config: Path) -> None:
+        """Write the default configuration file when no config file is found."""
+        vault_path = ConfigQuestions.ask_for_vault_path()
+
+        config_text = f"""\
+        # Add another vault by replicating this section and changing the name
+        ["Vault 1"] # Name of the vault.
+
+            # Path to your obsidian vault
+            path = "{vault_path}"
+
+            # Folders within the vault to ignore when indexing metadata
+            exclude_paths = [".git", ".obsidian"]"""
+
+        path_to_config.write_text(dedent(config_text))
+
+
+@rich.repr.auto
+class VaultConfig:
+    """Representation of a vault configuration."""
+
+    def __init__(self, vault_name: str, vault_config: dict) -> None:
+        """Initialize the vault configuration."""
+        self.name: str = vault_name
+        self.config: dict = vault_config
+
+        try:
+            self.path = self._validate_vault_path(self.config["path"])
+
+            Path(self.config["path"]).expanduser().resolve()
+        except KeyError:
+            self.path = None
+
+        try:
+            self.exclude_paths = self.config["exclude_paths"]
+        except KeyError:
+            self.exclude_paths = []
+
+    def __rich_repr__(self) -> rich.repr.Result:  # pragma: no cover
+        """Define rich representation of a vault config."""
+        yield "name", self.name
+        yield "config", self.config
+        yield "path", self.path
+        yield "exclude_paths", self.exclude_paths
+
     def _validate_vault_path(self, vault_path: Path | None) -> Path:
         """Validate the vault path."""
-        if vault_path is None:
-            try:
-                vault_path = Path(self.config["vault"]).expanduser().resolve()
-            except KeyError:
-                vault_path = Path("/I/Do/Not/Exist")
+        vault_path = Path(vault_path).expanduser().resolve()
 
-        if not vault_path.exists():  # pragma: no cover
+        if not vault_path.exists():
             alerts.error(f"Vault path not found: '{vault_path}'")
+            raise typer.Exit(code=1)
 
-            vault_path = questionary.path(
-                "Enter a path to Obsidian vault:",
-                only_directories=True,
-                validate=vault_validation,
-            ).ask()
-            if vault_path is None:
-                raise typer.Exit(code=1)
+        if not vault_path.is_dir():
+            alerts.error(f"Vault path is not a directory: '{vault_path}'")
+            raise typer.Exit(code=1)
 
-            vault_path = Path(vault_path).expanduser().resolve()
-
-            self.write_config_value("vault", str(vault_path))
         return vault_path
-
-    def write_config_value(self, key: str, value: str | int) -> None:
-        """Write a new value to the configuration file.
-
-        Args:
-            key (str): The key to write.
-            value (str|int): The value to write.
-        """
-        self.config_content = re.sub(
-            rf"( *{key} = ['\"])[^'\"]*(['\"].*)", rf"\1{value}\2", self.config_content
-        )
-
-        alerts.notice(f"Writing new configuration for '{key}' to '{self.config_path}'")
-        self.config_path.write_text(self.config_content)

src/obsidian_metadata/_config/default.toml

@@ -1,5 +0,0 @@
-# Path to your obsidian vault
-vault = "/path/to/vault"
-
-# Folders within the vault to ignore when indexing metadata
-exclude_paths = [".git", ".obsidian"]

src/obsidian_metadata/_utils/__init__.py

@@ -9,7 +9,6 @@ from obsidian_metadata._utils.utilities import (
     dict_values_to_lists_strings,
     docstring_parameter,
     remove_markdown_sections,
-    vault_validation,
     version_callback,
 )
 

src/obsidian_metadata/_utils/utilities.py

@@ -1,7 +1,6 @@
 """Utility functions."""
 import re
 from os import name, system
-from pathlib import Path
 from typing import Any
 
 import typer
@@ -83,17 +82,6 @@ def version_callback(value: bool) -> None:
         raise typer.Exit()
 
 
-def vault_validation(path: str) -> bool | str:
-    """Validates the vault path."""
-    path_to_validate: Path = Path(path).expanduser().resolve()
-    if not path_to_validate.exists():
-        return f"Path does not exist: {path_to_validate}"
-    if not path_to_validate.is_dir():
-        return f"Path is not a directory: {path_to_validate}"
-
-    return True
-
-
 def docstring_parameter(*sub: Any) -> Any:
     """Decorator to replace variables within docstrings.
 
@@ -132,7 +120,7 @@ def clean_dictionary(dictionary: dict[str, Any]) -> dict[str, Any]:
     return new_dict
 
 
-def clear_screen() -> None:
+def clear_screen() -> None:  # pragma: no cover
     """Clears the screen."""
     # for windows
     _ = system("cls") if name == "nt" else system("clear")

src/obsidian_metadata/cli.py

@@ -4,11 +4,17 @@
 from pathlib import Path
 from typing import Optional
 
+import questionary
 import typer
 from rich import print
 
 from obsidian_metadata._config import Config
-from obsidian_metadata._utils import alerts, docstring_parameter, version_callback
+from obsidian_metadata._utils import (
+    alerts,
+    clear_screen,
+    docstring_parameter,
+    version_callback,
+)
 from obsidian_metadata.models import Application
 
 app = typer.Typer(add_completion=False, no_args_is_help=True, rich_markup_mode="rich")
@@ -82,7 +88,9 @@ def main(
       - [code]vault:[/] Create a backup of the Obsidian vault.
 
     [bold underline]Usage:[/]
-    Run [tan]obsidian-metadata[/] from the command line. The script will allow you to make batch updates to metadata in an Obsidian vault.  Once you have made your changes, review them prior to committing them to the vault.
+    [tan]Obsidian-metadata[/] allows you to make batch updates to metadata in an Obsidian vault.  Once you have made your changes, review them prior to committing them to the vault.  The script provides a menu of available actions. Make as many changes as you require and review them as you go.  No changes are made to the Vault until they are explicitly committed.
+
+    [bold underline]It is strongly recommended that you back up your vault prior to committing changes.[/] This script makes changes directly to the markdown files in your vault. Once the changes are committed, there is no ability to recreate the original information unless you have a backup.  Follow the instructions in the script to create a backup of your vault if needed.  The author of this script is not responsible for any data loss that may occur. Use at your own risk.
 
     Configuration is specified in a configuration file. On First run, this file will be created at [tan]~/.{0}.env[/]. Any options specified on the command line will override the configuration file.
     """
@@ -93,9 +101,6 @@ def main(
         log_to_file,
     )
 
-    config: Config = Config(config_path=config_file, vault_path=vault_path)
-    application = Application(dry_run=dry_run, config=config)
-
     banner = r"""
    ___  _         _     _ _
   / _ \| |__  ___(_) __| (_) __ _ _ __
@@ -107,7 +112,28 @@ def main(
  | |  | |  __/ || (_| | (_| | (_| | || (_| |
  |_|  |_|\___|\__\__,_|\__,_|\__,_|\__\__,_|
 """
+    clear_screen()
     print(banner)
+
+    config: Config = Config(config_path=config_file, vault_path=vault_path)
+    if len(config.vaults) == 0:
+        typer.echo("No vaults configured. Exiting.")
+        raise typer.Exit(1)
+
+    if len(config.vaults) == 1:
+        application = Application(dry_run=dry_run, config=config.vaults[0])
+    else:
+        vault_names = [vault.name for vault in config.vaults]
+        vault_name = questionary.select(
+            "Select a vault to process:",
+            choices=vault_names,
+        ).ask()
+        if vault_name is None:
+            raise typer.Exit(code=1)
+
+        vault_to_use = next(vault for vault in config.vaults if vault.name == vault_name)
+        application = Application(dry_run=dry_run, config=vault_to_use)
+
     application.main_app()
 
 

src/obsidian_metadata/models/application.py

@@ -4,13 +4,13 @@
 from typing import Any
 
 import questionary
-import typer
 from rich import print
 
-from obsidian_metadata._config import Config
-from obsidian_metadata._utils import alerts, clear_screen
+from obsidian_metadata._config import VaultConfig
 from obsidian_metadata._utils.alerts import logger as log
 from obsidian_metadata.models import Patterns, Vault
+from obsidian_metadata._utils import alerts
+from obsidian_metadata.models.questions import Questions
 
 PATTERNS = Patterns()
 
@@ -23,19 +23,10 @@ class Application:
     More info: https://questionary.readthedocs.io/en/stable/pages/advanced.html#create-questions-from-dictionaries
     """
 
-    def __init__(self, config: Config, dry_run: bool) -> None:
+    def __init__(self, config: VaultConfig, dry_run: bool) -> None:
         self.config = config
         self.dry_run = dry_run
-        self.custom_style = questionary.Style(
-            [
-                ("separator", "bold fg:#6C6C6C"),
-                ("instruction", "fg:#6C6C6C"),
-                ("highlighted", "bold reverse"),
-                ("pointer", "bold"),
-            ]
-        )
-
-        clear_screen()
+        self.questions = Questions()
 
     def load_vault(self, path_filter: str = None) -> None:
         """Load the vault.
@@ -45,98 +36,52 @@ class Application:
         """
         self.vault: Vault = Vault(config=self.config, dry_run=self.dry_run, path_filter=path_filter)
         log.info(f"Indexed {self.vault.num_notes()} notes from {self.vault.vault_path}")
+        self.questions = Questions(vault=self.vault)
 
-    def main_app(self) -> None:  # noqa: C901
+    def main_app(self) -> None:
         """Questions for the main application."""
         self.load_vault()
 
         while True:
+            print("\n")
             self.vault.info()
-            operation = questionary.select(
-                "What do you want to do?",
-                choices=[
-                    questionary.Separator("\n-- VAULT ACTIONS -----------------"),
-                    {"name": "Backup vault", "value": "backup_vault"},
-                    {"name": "Delete vault backup", "value": "delete_backup"},
-                    {"name": "View all metadata", "value": "all_metadata"},
-                    {"name": "List notes in scope", "value": "list_notes"},
-                    {
-                        "name": "Filter the notes being processed by their path",
-                        "value": "filter_notes",
-                    },
-                    questionary.Separator("\n-- INLINE TAG ACTIONS ---------"),
-                    questionary.Separator("Tags in the note body"),
-                    {
-                        "name": "Rename an inline tag",
-                        "value": "rename_inline_tag",
-                    },
-                    {
-                        "name": "Delete an inline tag",
-                        "value": "delete_inline_tag",
-                    },
-                    questionary.Separator("\n-- METADATA ACTIONS -----------"),
-                    questionary.Separator("Frontmatter or inline metadata"),
-                    {"name": "Rename Key", "value": "rename_key"},
-                    {"name": "Delete Key", "value": "delete_key"},
-                    {"name": "Rename Value", "value": "rename_value"},
-                    {"name": "Delete Value", "value": "delete_value"},
-                    questionary.Separator("\n-- REVIEW/COMMIT CHANGES ------"),
-                    {"name": "Review changes", "value": "review_changes"},
-                    {"name": "Commit changes", "value": "commit_changes"},
-                    questionary.Separator("-------------------------------"),
-                    {"name": "Quit", "value": "abort"},
-                ],
-                use_shortcuts=False,
-                style=self.custom_style,
-            ).ask()
 
-            if operation == "filter_notes":
-                path_filter = questionary.text(
-                    "Enter a regex to filter notes by path",
-                    validate=lambda text: len(text) > 0,
-                ).ask()
-                if path_filter is None:
-                    continue
-                self.load_vault(path_filter=path_filter)
+            match self.questions.ask_main_application():  # noqa: E999
+                case None:
+                    break
+                case "filter_notes":
+                    self.load_vault(path_filter=self.questions.ask_for_filter_path())
+                case "all_metadata":
+                    self.vault.metadata.print_metadata()
+                case "backup_vault":
+                    self.vault.backup()
+                case "delete_backup":
+                    self.vault.delete_backup()
+                case "list_notes":
+                    self.vault.list_editable_notes()
+                case "rename_inline_tag":
+                    self.rename_inline_tag()
+                case "delete_inline_tag":
+                    self.delete_inline_tag()
+                case "rename_key":
+                    self.rename_key()
+                case "delete_key":
+                    self.delete_key()
+                case "rename_value":
+                    self.rename_value()
+                case "delete_value":
+                    self.delete_value()
+                case "review_changes":
+                    self.review_changes()
+                case "commit_changes":
+                    if self.commit_changes():
+                        break
 
-            if operation == "all_metadata":
-                self.vault.metadata.print_metadata()
+                    log.error("Commit failed. Please run with -vvv for more info.")
+                    break
 
-            if operation == "backup_vault":
-                self.vault.backup()
-
-            if operation == "delete_backup":
-                self.vault.delete_backup()
-
-            if operation == "list_notes":
-                self.vault.list_editable_notes()
-
-            if operation == "rename_inline_tag":
-                self.rename_inline_tag()
-
-            if operation == "delete_inline_tag":
-                self.delete_inline_tag()
-
-            if operation == "rename_key":
-                self.rename_key()
-
-            if operation == "delete_key":
-                self.delete_key()
-
-            if operation == "rename_value":
-                self.rename_value()
-
-            if operation == "delete_value":
-                self.delete_value()
-
-            if operation == "review_changes":
-                self.review_changes()
-
-            if operation == "commit_changes":
-                self.commit_changes()
-
-            if operation == "abort":
-                break
+                case "abort":
+                    break
 
         print("Done!")
         return
@@ -144,170 +89,126 @@ class Application:
     def rename_key(self) -> None:
         """Renames a key in the vault."""
 
-        def validate_key(text: str) -> bool:
-            """Validate the key name."""
-            if self.vault.metadata.contains(text):
-                return True
-            return False
-
-        def validate_new_key(text: str) -> bool:
-            """Validate the tag name."""
-            if PATTERNS.validate_key_text.search(text) is not None:
-                return False
-            if len(text) == 0:
-                return False
-
-            return True
-
-        original_key = questionary.text(
-            "Which key would you like to rename?",
-            validate=validate_key,
-        ).ask()
+        original_key = self.questions.ask_for_existing_key(
+            question="Which key would you like to rename?"
+        )
         if original_key is None:
             return
 
-        new_key = questionary.text(
-            "New key name",
-            validate=validate_new_key,
-        ).ask()
+        new_key = self.questions.ask_for_new_key()
         if new_key is None:
             return
 
-        self.vault.rename_metadata(original_key, new_key)
+        num_changed = self.vault.rename_metadata(original_key, new_key)
+        if num_changed == 0:
+            alerts.warning(f"No notes were changed")
+            return
+
+        alerts.success(
+            f"Renamed [reverse]{original_key}[/] to [reverse]{new_key}[/] in {num_changed} notes"
+        )
 
     def rename_inline_tag(self) -> None:
         """Rename an inline tag."""
 
-        def validate_new_tag(text: str) -> bool:
-            """Validate the tag name."""
-            if PATTERNS.validate_tag_text.search(text) is not None:
-                return False
-            if len(text) == 0:
-                return False
-
-            return True
-
-        original_tag = questionary.text(
-            "Which tag would you like to rename?",
-            validate=lambda text: True
-            if self.vault.contains_inline_tag(text)
-            else "Tag not found in vault",
-        ).ask()
+        original_tag = self.questions.ask_for_existing_inline_tag(question="Which tag to rename?")
         if original_tag is None:
             return
 
-        new_tag = questionary.text(
-            "New tag name",
-            validate=validate_new_tag,
-        ).ask()
+        new_tag = self.questions.ask_for_new_tag("New tag")
         if new_tag is None:
             return
 
-        self.vault.rename_inline_tag(original_tag, new_tag)
-        alerts.success(f"Renamed [reverse]{original_tag}[/] to [reverse]{new_tag}[/]")
+        num_changed = self.vault.rename_inline_tag(original_tag, new_tag)
+        if num_changed == 0:
+            alerts.warning(f"No notes were changed")
+            return
+
+        alerts.success(
+            f"Renamed [reverse]{original_tag}[/] to [reverse]{new_tag}[/] in {num_changed} notes"
+        )
         return
 
     def delete_inline_tag(self) -> None:
         """Delete an inline tag."""
-        tag = questionary.text(
-            "Which tag would you like to delete?",
-            validate=lambda text: True
-            if self.vault.contains_inline_tag(text)
-            else "Tag not found in vault",
-        ).ask()
-        if tag is None:
+        tag = self.questions.ask_for_existing_inline_tag(
+            question="Which tag would you like to delete?"
+        )
+
+        num_changed = self.vault.delete_inline_tag(tag)
+        if num_changed == 0:
+            alerts.warning(f"No notes were changed")
             return
 
-        self.vault.delete_inline_tag(tag)
-        alerts.success(f"Deleted inline tag: {tag}")
+        alerts.success(f"Deleted inline tag: {tag} in {num_changed} notes")
         return
 
     def delete_key(self) -> None:
         """Delete a key from the vault."""
-        while True:
-            key_to_delete = questionary.text("Regex for the key(s) you'd like to delete?").ask()
-            if key_to_delete is None:
-                return
+        key_to_delete = self.questions.ask_for_existing_keys_regex(
+            question="Regex for the key(s) you'd like to delete?"
+        )
+        if key_to_delete is None:
+            return
 
-            if not self.vault.metadata.contains(key_to_delete, is_regex=True):
-                alerts.warning(f"No matching keys in the vault: {key_to_delete}")
-                continue
+        num_changed = self.vault.delete_metadata(key_to_delete)
+        if num_changed == 0:
+            alerts.warning(f"No notes found with a key matching: [reverse]{key_to_delete}[/]")
+            return
 
-            num_changed = self.vault.delete_metadata(key_to_delete)
-            if num_changed == 0:
-                alerts.warning(f"No notes found matching: [reverse]{key_to_delete}[/]")
-                return
-
-            alerts.success(
-                f"Deleted keys matching: [reverse]{key_to_delete}[/] from {num_changed} notes"
-            )
-            break
+        alerts.success(
+            f"Deleted keys matching: [reverse]{key_to_delete}[/] from {num_changed} notes"
+        )
 
         return
 
     def rename_value(self) -> None:
         """Rename a value in the vault."""
-        key = questionary.text(
-            "Which key contains the value to rename?",
-            validate=lambda text: True
-            if self.vault.metadata.contains(text)
-            else "Key not found in vault",
-        ).ask()
+        key = self.questions.ask_for_existing_key(
+            question="Which key contains the value to rename?"
+        )
         if key is None:
             return
 
-        value = questionary.text(
-            "Which value would you like to rename?",
-            validate=lambda text: True
-            if self.vault.metadata.contains(key, text)
-            else f"Value not found in {key}",
-        ).ask()
+        question_key = Questions(vault=self.vault, key=key)
+        value = question_key.ask_for_existing_value(
+            question="Which value would you like to rename?"
+        )
         if value is None:
             return
 
-        new_value = questionary.text(
-            "New value?",
-            validate=lambda text: True
-            if not self.vault.metadata.contains(key, text)
-            else f"Value already exists in {key}",
-        ).ask()
+        new_value = question_key.ask_for_new_value()
+        if new_value is None:
+            return
 
-        if self.vault.rename_metadata(key, value, new_value):
-            alerts.success(f"Renamed [reverse]{key}: {value}[/] to [reverse]{key}: {new_value}[/]")
+        num_changes = self.vault.rename_metadata(key, value, new_value)
+        if num_changes == 0:
+            alerts.warning(f"No notes were changed")
+            return
+
+        alerts.success(f"Renamed '{key}:{value}' to '{key}:{new_value}' in {num_changes} notes")
 
     def delete_value(self) -> None:
         """Delete a value from the vault."""
-        while True:
-            key = questionary.text(
-                "Which key contains the value to delete?",
-            ).ask()
-            if key is None:
-                return
-            if not self.vault.metadata.contains(key, is_regex=True):
-                alerts.warning(f"No keys in value match: {key}")
-                continue
-            break
+        key = self.questions.ask_for_existing_key(
+            question="Which key contains the value to delete?"
+        )
+        if key is None:
+            return
 
-        while True:
-            value = questionary.text(
-                "Regex for the value to delete",
-            ).ask()
-            if value is None:
-                return
-            if not self.vault.metadata.contains(key, value, is_regex=True):
-                alerts.warning(f"No matching key value pairs found in the vault: {key}: {value}")
-                continue
+        questions2 = Questions(vault=self.vault, key=key)
+        value = questions2.ask_for_existing_value_regex(question="Regex for the value to delete")
+        if value is None:
+            return
 
-            num_changed = self.vault.delete_metadata(key, value)
-            if num_changed == 0:
-                alerts.warning(f"No notes found matching: [reverse]{key}: {value}[/]")
-                return
+        num_changed = self.vault.delete_metadata(key, value)
+        if num_changed == 0:
+            alerts.warning(f"No notes found matching: {key}: {value}")
+            return
 
-            alerts.success(
-                f"Deleted {num_changed} entries matching: [reverse]{key}[/]: [reverse]{value}[/]"
-            )
-
-            break
+        alerts.success(
+            f"Deleted value [reverse]{value}[/] from key [reverse]{key}[/] in {num_changed} notes"
+        )
 
         return
 
@@ -320,7 +221,9 @@ class Application:
             return
 
         print(f"\nFound {len(changed_notes)} changed notes in the vault.\n")
-        answer = questionary.confirm("View diffs of individual files?", default=False).ask()
+        answer = self.questions.ask_confirm(
+            question="View diffs of individual files?", default=False
+        )
         if not answer:
             return
 
@@ -333,38 +236,40 @@ class Application:
             choices.append(_selection)
 
         choices.append(questionary.Separator())
-        choices.append({"name": "Return", "value": "skip"})
+        choices.append({"name": "Return", "value": "return"})
 
         while True:
-            note_to_review = questionary.select(
-                "Select a new to view the diff.",
+            note_to_review = self.questions.ask_for_selection(
                 choices=choices,
-                use_shortcuts=False,
-                style=self.custom_style,
-            ).ask()
-            if note_to_review is None or note_to_review == "skip":
+                question="Select a new to view the diff",
+            )
+            if note_to_review is None or note_to_review == "return":
                 break
             changed_notes[note_to_review].print_diff()
 
-    def commit_changes(self) -> None:
-        """Write all changes to disk."""
+    def commit_changes(self) -> bool:
+        """Write all changes to disk.
+
+        Returns:
+            True if changes were committed, False otherwise.
+        """
         changed_notes = self.vault.get_changed_notes()
 
         if len(changed_notes) == 0:
             print("\n")
             alerts.notice("No changes to commit.\n")
-            return
+            return False
 
         backup = questionary.confirm("Create backup before committing changes").ask()
         if backup is None:
-            return
+            return False
         if backup:
             self.vault.backup()
 
         if questionary.confirm(f"Commit {len(changed_notes)} changed files to disk?").ask():
 
             self.vault.write()
-            alerts.success("Changes committed to disk. Exiting.")
-            typer.Exit()
+            alerts.success(f"{len(changed_notes)} changes committed to disk. Exiting")
+            return True
 
-        return
+        return False

src/obsidian_metadata/models/notes.py

@@ -7,7 +7,6 @@ from pathlib import Path
 
 import rich.repr
 import typer
-from rich import print
 
 from obsidian_metadata._utils import alerts
 from obsidian_metadata._utils.alerts import logger as log
@@ -228,9 +227,9 @@ class Note:
         result = list(diff.compare(a, b))
         for line in result:
             if line.startswith("+"):
-                print(f"[green]{line}[/]")
+                print(f"\033[92m{line}\033[0m")
             elif line.startswith("-"):
-                print(f"[red]{line}[/]")
+                print(f"\033[91m{line}\033[0m")
 
     def sub(self, pattern: str, replacement: str, is_regex: bool = False) -> None:
         """Substitutes text within the note.
@@ -348,13 +347,17 @@ class Note:
             self.file_content = new_frontmatter + self.file_content
             return
 
-        self.sub(current_frontmatter, new_frontmatter)
+        current_frontmatter = re.escape(current_frontmatter)
+        self.sub(current_frontmatter, new_frontmatter, is_regex=True)
 
-    def write(self, path: Path | None = None) -> None:
+    def write(self, path: Path = None) -> None:
         """Writes the note's content to disk.
 
         Args:
             path (Path): Path to write the note to. Defaults to the note's path.
+
+        Raises:
+            typer.Exit: If the note's path is not found.
         """
         p = self.note_path if path is None else path
 

src/obsidian_metadata/models/questions.py

@@ -0,0 +1,425 @@
+"""Functions for asking questions to the user and validating responses.
+
+This module contains wrappers around questionary to ask questions to the user and validate responses. Mocking questionary has proven very difficult. This functionality is separated from the main application logic to make it easier to test.
+
+Progress towards testing questionary can be found on this issue:
+https://github.com/tmbo/questionary/issues/35
+"""
+import re
+from pathlib import Path
+from typing import Any
+
+import questionary
+import typer
+
+from obsidian_metadata.models.patterns import Patterns
+from obsidian_metadata.models.vault import Vault
+
+PATTERNS = Patterns()
+
+
+class Questions:
+    """Class for asking questions to the user and validating responses with questionary."""
+
+    @staticmethod
+    def ask_for_vault_path() -> Path:  # pragma: no cover
+        """Ask the user for the path to their vault.
+
+        Returns:
+            Path: The path to the vault.
+        """
+        vault_path = questionary.path(
+            "Enter a path to Obsidian vault:",
+            only_directories=True,
+            validate=Questions._validate_valid_dir,
+        ).ask()
+        if vault_path is None:
+            raise typer.Exit(code=1)
+
+        return Path(vault_path).expanduser().resolve()
+
+    @staticmethod
+    def _validate_valid_dir(path: str) -> bool | str:
+        """Validates a valid directory.
+
+        Returns:
+            bool | str: True if the path is valid, otherwise a string with the error message.
+        """
+        path_to_validate: Path = Path(path).expanduser().resolve()
+        if not path_to_validate.exists():
+            return f"Path does not exist: {path_to_validate}"
+        if not path_to_validate.is_dir():
+            return f"Path is not a directory: {path_to_validate}"
+
+        return True
+
+    def __init__(self, vault: Vault = None, key: str = None) -> None:
+        """Initialize the class.
+
+        Args:
+            vault_path (Path, optional): The path to the vault. Defaults to None.
+            vault (Vault, optional): The vault object. Defaults to None.
+            key (str, optional): The key to use when validating a key, value pair. Defaults to None.
+        """
+        self.style = questionary.Style(
+            [
+                ("separator", "bold fg:#6C6C6C"),
+                ("instruction", "fg:#6C6C6C"),
+                ("highlighted", "bold reverse"),
+                ("pointer", "bold"),
+            ]
+        )
+        self.vault = vault
+        self.key = key
+
+    def ask_confirm(self, question: str, default: bool = True) -> bool:  # pragma: no cover
+        """Ask the user to confirm an action.
+
+        Args:
+            question (str): The question to ask.
+            default (bool, optional): The default value. Defaults to True.
+
+        Returns:
+            bool: True if the user confirms, otherwise False.
+        """
+        return questionary.confirm(question, default=default, style=self.style).ask()
+
+    def ask_main_application(self) -> str:  # pragma: no cover
+        """Selectable list for the main application interface.
+
+        Args:
+            style (questionary.Style): The style to use for the question.
+
+        Returns:
+            str: The selected application.
+        """
+        return questionary.select(
+            "What do you want to do?",
+            choices=[
+                questionary.Separator("\n-- VAULT ACTIONS -----------------"),
+                {"name": "Backup vault", "value": "backup_vault"},
+                {"name": "Delete vault backup", "value": "delete_backup"},
+                {"name": "View all metadata", "value": "all_metadata"},
+                {"name": "List notes in scope", "value": "list_notes"},
+                {
+                    "name": "Filter the notes being processed by their path",
+                    "value": "filter_notes",
+                },
+                questionary.Separator("\n-- INLINE TAG ACTIONS ---------"),
+                questionary.Separator("Tags in the note body"),
+                {
+                    "name": "Rename an inline tag",
+                    "value": "rename_inline_tag",
+                },
+                {
+                    "name": "Delete an inline tag",
+                    "value": "delete_inline_tag",
+                },
+                questionary.Separator("\n-- METADATA ACTIONS -----------"),
+                questionary.Separator("Frontmatter or inline metadata"),
+                {"name": "Rename Key", "value": "rename_key"},
+                {"name": "Delete Key", "value": "delete_key"},
+                {"name": "Rename Value", "value": "rename_value"},
+                {"name": "Delete Value", "value": "delete_value"},
+                questionary.Separator("\n-- REVIEW/COMMIT CHANGES ------"),
+                {"name": "Review changes", "value": "review_changes"},
+                {"name": "Commit changes", "value": "commit_changes"},
+                questionary.Separator("-------------------------------"),
+                {"name": "Quit", "value": "abort"},
+            ],
+            use_shortcuts=False,
+            style=self.style,
+        ).ask()
+
+    def ask_for_filter_path(self) -> str:  # pragma: no cover
+        """Ask the user for the path to the filter file.
+
+        Returns:
+            str: The regex to use for filtering.
+        """
+        filter_path_regex = questionary.path(
+            "Regex to filter the notes being processed by their path:",
+            only_directories=False,
+            validate=self._validate_valid_vault_regex,
+        ).ask()
+        if filter_path_regex is None:
+            raise typer.Exit(code=1)
+
+        return filter_path_regex
+
+    def ask_for_selection(
+        self, choices: list[Any], question: str = "Select an option"
+    ) -> Any:  # pragma: no cover
+        """Ask the user to select an item from a list.
+
+        Args:
+            question (str, optional): The question to ask. Defaults to "Select an option".
+            choices (list[Any]): The list of choices.
+
+        Returns:
+            any: The selected item value.
+        """
+        return questionary.select(
+            "Select an item:",
+            choices=choices,
+            use_shortcuts=False,
+            style=self.style,
+        ).ask()
+
+    def ask_for_existing_inline_tag(self, question: str = "Enter a tag") -> str:  # pragma: no cover
+        """Ask the user for an existing inline tag."""
+        return questionary.text(
+            question,
+            validate=self._validate_existing_inline_tag,
+        ).ask()
+
+    def ask_for_new_tag(self, question: str = "New tag name") -> str:  # pragma: no cover
+        """Ask the user for a new inline tag."""
+        return questionary.text(
+            question,
+            validate=self._validate_new_tag,
+        ).ask()
+
+    def ask_for_existing_key(self, question: str = "Enter a key") -> str:  # pragma: no cover
+        """Ask the user for a metadata key.
+
+        Args:
+            question (str, optional): The question to ask. Defaults to "Enter a key".
+
+        Returns:
+            str: A metadata key that exists in the vault.
+        """
+        return questionary.text(
+            question,
+            validate=self._validate_key_exists,
+        ).ask()
+
+    def ask_for_existing_keys_regex(
+        self, question: str = "Regex for keys"
+    ) -> str:  # pragma: no cover
+        """Ask the user for a regex for metadata keys.
+
+        Args:
+            question (str, optional): The question to ask. Defaults to "Regex for keys".
+
+        Returns:
+            str: A regex for metadata keys that exist in the vault.
+        """
+        return questionary.text(
+            question,
+            validate=self._validate_key_exists_regex,
+        ).ask()
+
+    def ask_for_existing_value_regex(
+        self, question: str = "Regex for values"
+    ) -> str:  # pragma: no cover
+        """Ask the user for a regex for metadata values.
+
+        Args:
+            question (str, optional): The question to ask. Defaults to "Regex for values".
+
+        Returns:
+            str: A regex for metadata values that exist in the vault.
+        """
+        return questionary.text(
+            question,
+            validate=self._validate_value_exists_regex,
+        ).ask()
+
+    def ask_for_existing_value(self, question: str = "Enter a value") -> str:  # pragma: no cover
+        """Ask the user for a metadata value.
+
+        Args:
+            question (str, optional): The question to ask. Defaults to "Enter a value".
+
+        Returns:
+            str: A metadata value.
+        """
+        return questionary.text(question, validate=self._validate_value).ask()
+
+    def ask_for_new_key(self, question: str = "New key name") -> str:  # pragma: no cover
+        """Ask the user for a new metadata key.
+
+        Args:
+            question (str, optional): The question to ask. Defaults to "New key name".
+
+        Returns:
+            str: A new metadata key.
+        """
+        return questionary.text(
+            question,
+            validate=self._validate_new_key,
+        ).ask()
+
+    def ask_for_new_value(self, question: str = "New value") -> str:  # pragma: no cover
+        """Ask the user for a new metadata value.
+
+        Args:
+            question (str, optional): The question to ask. Defaults to "New value".
+
+        Returns:
+            str: A new metadata value.
+        """
+        return questionary.text(
+            question,
+            validate=self._validate_new_value,
+        ).ask()
+
+    def _validate_key_exists(self, text: str) -> bool | str:
+        """Validates a valid key.
+
+        Returns:
+            bool | str: True if the key is valid, otherwise a string with the error message.
+        """
+        if len(text) < 1:
+            return "Key cannot be empty"
+
+        if not self.vault.metadata.contains(text):
+            return f"'{text}' does not exist as a key in the vault"
+
+        return True
+
+    def _validate_key_exists_regex(self, text: str) -> bool | str:
+        """Validates a valid key.
+
+        Returns:
+            bool | str: True if the key is valid, otherwise a string with the error message.
+        """
+        if len(text) < 1:
+            return "Key cannot be empty"
+
+        try:
+            re.compile(text)
+        except re.error as error:
+            return f"Invalid regex: {error}"
+
+        if not self.vault.metadata.contains(text, is_regex=True):
+            return f"'{text}' does not exist as a key in the vault"
+
+        return True
+
+    def _validate_existing_inline_tag(self, text: str) -> bool | str:
+        """Validates an existing inline tag.
+
+        Returns:
+            bool | str: True if the tag is valid, otherwise a string with the error message.
+        """
+        if len(text) < 1:
+            return "Tag cannot be empty"
+
+        if not self.vault.contains_inline_tag(text):
+            return f"'{text}' does not exist as a tag in the vault"
+
+        return True
+
+    def _validate_valid_vault_regex(self, text: str) -> bool | str:
+        """Validates a valid regex.
+
+        Returns:
+            bool | str: True if the regex is valid, otherwise a string with the error message.
+        """
+        if len(text) < 1:
+            return "Regex cannot be empty"
+
+        try:
+            re.compile(text)
+        except re.error as error:
+            return f"Invalid regex: {error}"
+
+        if self.vault is not None:
+            for subdir in list(self.vault.vault_path.glob("**/*")):
+                if re.search(text, str(subdir)):
+                    return True
+            return "Regex does not match paths in the vault"
+
+        return True
+
+    def _validate_new_key(self, text: str) -> bool | str:
+        """Validate the tag name.
+
+        Args:
+            text (str): The key name to validate.
+
+        Returns:
+            bool | str: True if the key is valid, otherwise a string with the error message.
+        """
+        if PATTERNS.validate_key_text.search(text) is not None:
+            return "Key cannot contain spaces or special characters"
+
+        if len(text) == 0:
+            return "New key cannot be empty"
+
+        return True
+
+    def _validate_new_tag(self, text: str) -> bool | str:
+        """Validate the tag name.
+
+        Args:
+            text (str): The tag name to validate.
+
+        Returns:
+            bool | str: True if the tag is valid, otherwise a string with the error message.
+        """
+        if PATTERNS.validate_tag_text.search(text) is not None:
+            return "Tag cannot contain spaces or special characters"
+
+        if len(text) == 0:
+            return "New tag cannot be empty"
+
+        return True
+
+    def _validate_value(self, text: str) -> bool | str:
+        """Validate the value.
+
+        Args:
+            text (str): The value to validate.
+
+        Returns:
+            bool | str: True if the value is valid, otherwise a string with the error message.
+        """
+        if len(text) < 1:
+            return "Value cannot be empty"
+
+        if self.key is not None and not self.vault.metadata.contains(self.key, text):
+            return f"{self.key}:{text} does not exist"
+
+        return True
+
+    def _validate_value_exists_regex(self, text: str) -> bool | str:
+        """Validate the value.
+
+        Args:
+            text (str): The value to validate.
+
+        Returns:
+            bool | str: True if the value is valid, otherwise a string with the error message.
+        """
+        if len(text) < 1:
+            return "Regex cannot be empty"
+
+        try:
+            re.compile(text)
+        except re.error as error:
+            return f"Invalid regex: {error}"
+
+        if self.key is not None and not self.vault.metadata.contains(self.key, text, is_regex=True):
+            return f"No values in {self.key} match regex: {text}"
+
+        return True
+
+    def _validate_new_value(self, text: str) -> bool | str:
+        """Validate a new value.
+
+        Args:
+            text (str): The value to validate.
+
+        Returns:
+            bool | str: True if the value is valid, otherwise a string with the error message.
+        """
+        if len(text) < 1:
+            return "Value cannot be empty"
+
+        if self.key is not None and self.vault.metadata.contains(self.key, text):
+            return f"{self.key}:{text} already exists"
+
+        return True

src/obsidian_metadata/models/vault.py

@@ -10,7 +10,7 @@ from rich.progress import Progress, SpinnerColumn, TextColumn
 from rich.prompt import Confirm
 from rich.table import Table
 
-from obsidian_metadata._config import Config
+from obsidian_metadata._config import VaultConfig
 from obsidian_metadata._utils import alerts
 from obsidian_metadata._utils.alerts import logger as log
 from obsidian_metadata.models import Note, VaultMetadata
@@ -24,15 +24,13 @@ class Vault:
         vault (Path): Path to the vault.
         dry_run (bool): Whether to perform a dry run.
         backup_path (Path): Path to the backup of the vault.
-        new_vault (Path): Path to a new vault.
         notes (list[Note]): List of all notes in the vault.
     """
 
-    def __init__(self, config: Config, dry_run: bool = False, path_filter: str = None):
-        self.vault_path: Path = config.vault_path
+    def __init__(self, config: VaultConfig, dry_run: bool = False, path_filter: str = None):
+        self.vault_path: Path = config.path
         self.dry_run: bool = dry_run
         self.backup_path: Path = self.vault_path.parent / f"{self.vault_path.name}.bak"
-        self.new_vault_path: Path = self.vault_path.parent / f"{self.vault_path.name}.new"
         self.exclude_paths: list[Path] = []
         self.metadata = VaultMetadata()
         for p in config.exclude_paths:
@@ -55,12 +53,11 @@ class Vault:
                 self.metadata.add_metadata(_note.inline_metadata.dict)
                 self.metadata.add_metadata({_note.inline_tags.metadata_key: _note.inline_tags.list})
 
-    def __rich_repr__(self) -> rich.repr.Result:
+    def __rich_repr__(self) -> rich.repr.Result:  # pragma: no cover
         """Define rich representation of Vault."""
         yield "vault_path", self.vault_path
         yield "dry_run", self.dry_run
         yield "backup_path", self.backup_path
-        yield "new_vault", self.new_vault_path
         yield "num_notes", self.num_notes()
         yield "exclude_paths", self.exclude_paths
 
@@ -149,25 +146,25 @@ class Vault:
         else:
             alerts.info("No backup found")
 
-    def delete_inline_tag(self, tag: str) -> bool:
+    def delete_inline_tag(self, tag: str) -> int:
         """Delete an inline tag in the vault.
 
         Args:
             tag (str): Tag to delete.
 
         Returns:
-            bool: True if tag was deleted.
+            int: Number of notes that had tag deleted.
         """
-        changes = False
+        num_changed = 0
 
         for _note in self.notes:
             if _note.delete_inline_tag(tag):
-                changes = True
+                num_changed += 1
 
-        if changes:
+        if num_changed > 0:
             self.metadata.delete(self.notes[0].inline_tags.metadata_key, tag)
-            return True
-        return False
+
+        return num_changed
 
     def delete_metadata(self, key: str, value: str = None) -> int:
         """Delete metadata in the vault.
@@ -187,7 +184,7 @@ class Vault:
 
         if num_changed > 0:
             self.metadata.delete(key, value)
-            return num_changed
+
         return num_changed
 
     def get_changed_notes(self) -> list[Note]:
@@ -242,7 +239,7 @@ class Vault:
         """
         return len(self.notes)
 
-    def rename_metadata(self, key: str, value_1: str, value_2: str = None) -> bool:
+    def rename_metadata(self, key: str, value_1: str, value_2: str = None) -> int:
         """Renames a key or key-value pair in the note's metadata.
 
         If no value is provided, will rename an entire key.
@@ -253,19 +250,20 @@ class Vault:
             value_2 (str, optional): New value.
 
         Returns:
-            bool: True if metadata was renamed.
+            int: Number of notes that had metadata renamed.
         """
-        changes = False
+        num_changed = 0
+
         for _note in self.notes:
             if _note.rename_metadata(key, value_1, value_2):
-                changes = True
+                num_changed += 1
 
-        if changes:
+        if num_changed > 0:
             self.metadata.rename(key, value_1, value_2)
-            return True
-        return False
 
-    def rename_inline_tag(self, old_tag: str, new_tag: str) -> bool:
+        return num_changed
+
+    def rename_inline_tag(self, old_tag: str, new_tag: str) -> int:
         """Rename an inline tag in the vault.
 
         Args:
@@ -273,30 +271,23 @@ class Vault:
             new_tag (str): New tag name.
 
         Returns:
-            bool: True if tag was renamed.
+            int: Number of notes that had inline tags renamed.
         """
-        changes = False
+        num_changed = 0
+
         for _note in self.notes:
             if _note.rename_inline_tag(old_tag, new_tag):
-                changes = True
+                num_changed += 1
 
-        if changes:
+        if num_changed > 0:
             self.metadata.rename(self.notes[0].inline_tags.metadata_key, old_tag, new_tag)
-            return True
-        return False
 
-    def write(self, new_vault: bool = False) -> None:
+        return num_changed
+
+    def write(self) -> None:
         """Write changes to the vault."""
         log.debug("Writing changes to vault...")
-        if new_vault:
-            log.debug("Writing changes to backup")
+        if self.dry_run is False:
             for _note in self.notes:
-                _new_note_path: Path = Path(
-                    self.new_vault_path / Path(_note.note_path).relative_to(self.vault_path)
-                )
-                log.debug(f"writing to {_new_note_path}")
-                _note.write(path=_new_note_path)
-        else:
-            for _note in self.notes:
-                log.debug(f"writing to {_note.note_path}")
+                log.trace(f"writing to {_note.note_path}")
                 _note.write()

tests/application_test.py

@@ -0,0 +1,414 @@
+# type: ignore
+"""Tests for the application module.
+
+How mocking works in this test suite:
+
+1. The main_app() method is mocked using a side effect iterable. This allows us to pass a value in the first run, and then a KeyError in the second run to exit the loop.
+2. All questions are mocked using return_value. This allows us to pass in a value to the question and then the method will return that value. This is useful for testing questionary prompts without user input.
+"""
+
+import re
+
+import pytest
+
+from tests.helpers import Regex
+
+
+def test_instantiate_application(test_application) -> None:
+    """Test application."""
+    app = test_application
+    app.load_vault()
+
+    assert app.dry_run is False
+    assert app.config.name == "command_line_vault"
+    assert app.config.exclude_paths == [".git", ".obsidian"]
+    assert app.dry_run is False
+    assert app.vault.num_notes() == 13
+
+
+def test_abort(test_application, mocker, capsys) -> None:
+    """Test renaming a key."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        return_value="abort",
+    )
+
+    app.main_app()
+    captured = capsys.readouterr()
+    assert "Vault Info" in captured.out
+    assert "Done!" in captured.out
+
+
+def test_list_notes(test_application, mocker, capsys) -> None:
+    """Test renaming a key."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["list_notes", KeyError],
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert "04 no metadata/no_metadata_1.md" in captured.out
+    assert "02 inline/inline 2.md" in captured.out
+    assert "+inbox/Untitled.md" in captured.out
+    assert "00 meta/templates/data sample.md" in captured.out
+
+
+def test_all_metadata(test_application, mocker, capsys) -> None:
+    """Test renaming a key."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["all_metadata", KeyError],
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    expected = re.escape("┃ Keys               ┃ Values")
+    assert captured.out == Regex(expected)
+    expected = re.escape("Inline Tags        │ breakfast")
+    assert captured.out == Regex(expected)
+
+
+def test_filter_notes(test_application, mocker, capsys) -> None:
+    """Test renaming a key."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["filter_notes", "list_notes", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_filter_path",
+        return_value="inline",
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert "04 no metadata/no_metadata_1.md" not in captured.out
+    assert "02 inline/inline 1.md" in captured.out
+    assert "02 inline/inline 2.md" in captured.out
+    assert "+inbox/Untitled.md" not in captured.out
+    assert "00 meta/templates/data sample.md" not in captured.out
+
+
+def test_rename_key_success(test_application, mocker, capsys) -> None:
+    """Test renaming a key."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["rename_key", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_key",
+        return_value="tags",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_new_key",
+        return_value="new_tags",
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r"Renamed.*tags.*to.*new_tags.*in.*\d+.*notes", re.DOTALL)
+
+
+def test_rename_key_fail(test_application, mocker, capsys) -> None:
+    """Test renaming a key."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["rename_key", KeyError],
+    )
+
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_key",
+        return_value="tag",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_new_key",
+        return_value="new_tags",
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert "WARNING  | No notes were changed" in captured.out
+
+
+def test_rename_inline_tag_success(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["rename_inline_tag", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_inline_tag",
+        return_value="breakfast",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_new_tag",
+        return_value="new_tag",
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r"Renamed.*breakfast.*to.*new_tag.*in.*\d+.*notes", re.DOTALL)
+
+
+def test_rename_inline_tag_fail(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["rename_inline_tag", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_inline_tag",
+        return_value="not_a_tag",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_new_tag",
+        return_value="new_tag",
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r"WARNING +\| No notes were changed", re.DOTALL)
+
+
+def test_delete_inline_tag_success(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["delete_inline_tag", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_inline_tag",
+        return_value="breakfast",
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r"SUCCESS +\| Deleted.*\d+.*notes", re.DOTALL)
+
+
+def test_delete_inline_tag_fail(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["delete_inline_tag", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_inline_tag",
+        return_value="not_a_tag_in_vault",
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r"WARNING +\| No notes were changed", re.DOTALL)
+
+
+def test_delete_key_success(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["delete_key", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_keys_regex",
+        return_value=r"d\w+",
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(
+        r"SUCCESS +\|.*Deleted.*keys.*matching:.*d\\w\+.*from.*10", re.DOTALL
+    )
+
+
+def test_delete_key_fail(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["delete_key", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_keys_regex",
+        return_value=r"\d{7}",
+    )
+
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r"WARNING +\| No notes found with a.*key.*matching", re.DOTALL)
+
+
+def test_rename_value_success(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["rename_value", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_key",
+        return_value="area",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_value",
+        return_value="frontmatter",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_new_value",
+        return_value="new_key",
+    )
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(
+        r"SUCCESS  | Renamed 'area:frontmatter' to 'area:new_key'", re.DOTALL
+    )
+    assert captured.out == Regex(r".*in.*\d+.*notes.*", re.DOTALL)
+
+
+def test_rename_value_fail(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["rename_value", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_key",
+        return_value="area",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_value",
+        return_value="not_exists",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_new_value",
+        return_value="new_key",
+    )
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r"WARNING +\| No notes were changed", re.DOTALL)
+
+
+def test_delete_value_success(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["delete_value", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_key",
+        return_value="area",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_value_regex",
+        return_value=r"^front\w+$",
+    )
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(
+        r"SUCCESS +\| Deleted value.*\^front\\w\+\$.*from.*key.*area.*in.*\d+.*notes", re.DOTALL
+    )
+
+
+def test_delete_value_fail(test_application, mocker, capsys) -> None:
+    """Test renaming an inline tag."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["delete_value", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_key",
+        return_value="area",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_value_regex",
+        return_value=r"\d{7}",
+    )
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r"WARNING +\| No notes found matching:", re.DOTALL)
+
+
+def test_review_no_changes(test_application, mocker, capsys) -> None:
+    """Review changes when no changes to vault."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["review_changes", KeyError],
+    )
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r"INFO +\| No changes to review", re.DOTALL)
+
+
+def test_review_changes(test_application, mocker, capsys) -> None:
+    """Review changes when no changes to vault."""
+    app = test_application
+    app.load_vault()
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_main_application",
+        side_effect=["delete_key", "review_changes", KeyError],
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_existing_keys_regex",
+        return_value=r"d\w+",
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_confirm",
+        return_value=True,
+    )
+    mocker.patch(
+        "obsidian_metadata.models.application.Questions.ask_for_selection",
+        side_effect=[1, "return"],
+    )
+    with pytest.raises(KeyError):
+        app.main_app()
+    captured = capsys.readouterr()
+    assert captured.out == Regex(r".*Found.*\d+.*changed notes in the vault.*", re.DOTALL)
+    assert "- date_created: 2022-12-22" in captured.out
+    assert "+   - breakfast" in captured.out

tests/cli_test.py

@@ -4,7 +4,8 @@
 from typer.testing import CliRunner
 
 from obsidian_metadata.cli import app
-from tests.helpers import Regex
+
+from .helpers import KeyInputs, Regex  # noqa: F401
 
 runner = CliRunner()
 
@@ -14,3 +15,29 @@ def test_version() -> None:
     result = runner.invoke(app, ["--version"])
     assert result.exit_code == 0
     assert result.output == Regex(r"obsidian_metadata: v\d+\.\d+\.\d+$")
+
+
+def test_application(test_vault, tmp_path) -> None:
+    """Test the application."""
+    vault_path = test_vault
+    config_path = tmp_path / "config.toml"
+    result = runner.invoke(
+        app,
+        ["--vault-path", vault_path, "--config-file", config_path],
+        # input=KeyInputs.DOWN + KeyInputs.DOWN + KeyInputs.DOWN + KeyInputs.ENTER, # noqa: ERA001
+    )
+
+    banner = r"""
+   ___  _         _     _ _
+  / _ \| |__  ___(_) __| (_) __ _ _ __
+ | | | | '_ \/ __| |/ _` | |/ _` | '_ \
+ | |_| | |_) \__ \ | (_| | | (_| | | | |
+  \___/|_.__/|___/_|\__,_|_|\__,_|_| |_|
+ |  \/  | ___| |_ __ _  __| | __ _| |_ __ _
+ | |\/| |/ _ \ __/ _` |/ _` |/ _` | __/ _` |
+ | |  | |  __/ || (_| | (_| | (_| | || (_| |
+ |_|  |_|\___|\__\__,_|\__,_|\__,_|\__\__,_|
+"""
+
+    assert banner in result.output
+    assert result.exit_code == 1

tests/config_test.py

@@ -1,28 +1,118 @@
 # type: ignore
 """Tests for the configuration module."""
 
-import re
 from pathlib import Path
+from textwrap import dedent
 
-from obsidian_metadata._config import Config
+import pytest
+import typer
+
+from obsidian_metadata._config.config import Config, ConfigQuestions
 
 
-def test_first_run(tmp_path):
-    """Test creating a config on first run."""
+def test_validate_valid_dir() -> None:
+    """Test vault validation."""
+    assert ConfigQuestions._validate_valid_dir("tests/") is True
+    assert "Path is not a directory" in ConfigQuestions._validate_valid_dir("pyproject.toml")
+    assert "Path does not exist" in ConfigQuestions._validate_valid_dir("tests/vault2")
+
+
+def test_broken_config_file(capsys) -> None:
+    """Test loading a broken config file."""
+    config_file = Path("tests/fixtures/broken_config_file.toml")
+
+    with pytest.raises(typer.Exit):
+        Config(config_path=config_file)
+    captured = capsys.readouterr()
+    assert "Could not parse" in captured.out
+
+
+def test_vault_path_errors(tmp_path, capsys) -> None:
+    """Test loading a config file with a vault path that doesn't exist."""
     config_file = Path(tmp_path / "config.toml")
-    vault_path = Path(tmp_path / "vault/")
-    vault_path.mkdir()
+    with pytest.raises(typer.Exit):
+        Config(config_path=config_file, vault_path=Path("tests/fixtures/does_not_exist"))
+    captured = capsys.readouterr()
+    assert "Vault path not found" in captured.out
 
-    config = Config(config_path=config_file, vault_path=vault_path)
+    with pytest.raises(typer.Exit):
+        Config(config_path=config_file, vault_path=Path("tests/fixtures/sample_note.md"))
+    captured = capsys.readouterr()
+    assert "Vault path is not a directory" in captured.out
+
+
+def test_multiple_vaults_okay() -> None:
+    """Test multiple vaults."""
+    config_file = Path("tests/fixtures/multiple_vaults.toml")
+
+    config = Config(config_path=config_file)
+    assert config.config == {
+        "Sample Vault": {
+            "exclude_paths": [".git", ".obsidian", "ignore_folder"],
+            "path": "tests/fixtures/sample_vault",
+        },
+        "Test Vault": {
+            "exclude_paths": [".git", ".obsidian", "ignore_folder"],
+            "path": "tests/fixtures/test_vault",
+        },
+    }
+    assert len(config.vaults) == 2
+    assert config.vaults[0].name == "Sample Vault"
+    assert config.vaults[0].path == Path("tests/fixtures/sample_vault").expanduser().resolve()
+    assert config.vaults[0].exclude_paths == [".git", ".obsidian", "ignore_folder"]
+    assert config.vaults[1].name == "Test Vault"
+    assert config.vaults[1].path == Path("tests/fixtures/test_vault").expanduser().resolve()
+    assert config.vaults[1].exclude_paths == [".git", ".obsidian", "ignore_folder"]
+
+
+def test_single_vault() -> None:
+    """Test multiple vaults."""
+    config_file = Path("tests/fixtures/test_vault_config.toml")
+
+    config = Config(config_path=config_file)
+    assert config.config == {
+        "Test Vault": {
+            "exclude_paths": [".git", ".obsidian", "ignore_folder"],
+            "path": "tests/fixtures/test_vault",
+        }
+    }
+    assert len(config.vaults) == 1
+    assert config.vaults[0].name == "Test Vault"
+    assert config.vaults[0].path == Path("tests/fixtures/test_vault").expanduser().resolve()
+    assert config.vaults[0].exclude_paths == [".git", ".obsidian", "ignore_folder"]
+
+
+def test_no_config_no_vault(tmp_path, mocker) -> None:
+    """Test creating a config on first run."""
+    fake_vault = Path(tmp_path / "vault")
+    fake_vault.mkdir()
+
+    mocker.patch(
+        "obsidian_metadata._config.config.ConfigQuestions.ask_for_vault_path",
+        return_value=fake_vault,
+    )
+
+    config_file = Path(tmp_path / "config.toml")
+    Config(config_path=config_file)
+
+    content = config_file.read_text()
+    sample_config = f"""\
+    # Add another vault by replicating this section and changing the name
+    ["Vault 1"] # Name of the vault.
+
+        # Path to your obsidian vault
+        path = "{str(fake_vault)}"
+
+        # Folders within the vault to ignore when indexing metadata
+        exclude_paths = [".git", ".obsidian"]"""
 
     assert config_file.exists() is True
-    config.write_config_value("vault", str(vault_path))
-    content = config_file.read_text()
-    assert config.vault_path == vault_path
-    assert re.search(str(vault_path), content) is not None
+    assert content == dedent(sample_config)
 
-
-def test_parse_config():
-    """Test parsing a config file."""
-    config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=None)
-    assert config.vault_path == Path(Path.cwd() / "tests/fixtures/test_vault")
+    new_config = Config(config_path=config_file)
+    assert new_config.config == {
+        "Vault 1": {
+            "path": str(fake_vault),
+            "exclude_paths": [".git", ".obsidian"],
+        }
+    }

tests/conftest.py

@@ -6,6 +6,9 @@ from pathlib import Path
 
 import pytest
 
+from obsidian_metadata._config import Config
+from obsidian_metadata.models.application import Application
+
 
 def remove_all(root: Path):
     """Remove all files and directories in a directory."""
@@ -72,3 +75,27 @@ def test_vault(tmp_path) -> Path:
 
     if backup_dir.exists():
         shutil.rmtree(backup_dir)
+
+
+@pytest.fixture()
+def test_application(tmp_path) -> Application:
+    """Fixture which creates a sample vault."""
+    source_dir = Path(__file__).parent / "fixtures" / "sample_vault"
+    dest_dir = Path(tmp_path / "application")
+    backup_dir = Path(f"{dest_dir}.bak")
+
+    if not source_dir.exists():
+        raise FileNotFoundError(f"Sample vault not found: {source_dir}")
+
+    shutil.copytree(source_dir, dest_dir)
+    config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=dest_dir)
+    vault_config = config.vaults[0]
+    app = Application(config=vault_config, dry_run=False)
+
+    yield app
+
+    # after test - remove fixtures
+    shutil.rmtree(dest_dir)
+
+    if backup_dir.exists():
+        shutil.rmtree(backup_dir)

tests/fixtures/broken_config_file.toml

@@ -0,0 +1,6 @@
+["Sample Vault]
+    exclude_paths = [".git", ".obsidian", "ignore_folder"]
+    path          = "tests/fixtures/sample_vault"
+["Test Vault"]
+    exclude_paths = [".git", ".obsidian", "ignore_folder"]
+    path          = "tests/fixtures/test_vault"

tests/fixtures/multiple_vaults.toml

@@ -0,0 +1,6 @@
+["Sample Vault"]
+    exclude_paths = [".git", ".obsidian", "ignore_folder"]
+    path          = "tests/fixtures/sample_vault"
+["Test Vault"]
+    exclude_paths = [".git", ".obsidian", "ignore_folder"]
+    path          = "tests/fixtures/test_vault"

tests/fixtures/sample_vault_config.toml

@@ -1,8 +1,3 @@
-vault = "tests/fixtures/sample_vault"
-
-# folders to ignore when parsing content
-exclude_paths = [".git", ".obsidian", "ignore_folder"]
-
-[metadata]
-    metadata_location = "frontmatter" # "frontmatter", "top", "bottom"
-    tags_location     = "top"         # "frontmatter", "top", "bottom"
+["Sample Vault"]
+    exclude_paths = [".git", ".obsidian", "ignore_folder"]
+    path          = "tests/fixtures/sample_vault"

tests/fixtures/test_vault/ignore_folder/file_to_ignore.md

@@ -8,6 +8,7 @@ tags:
   - ignored_file_tag1
 author: author name
 type: ["article", "note"]
+ignored_frontmatter: ignore_me
 ---
 #inline_tag_top1 #inline_tag_top2
 #ignored_file_tag2

tests/fixtures/test_vault_config.toml

@@ -1,8 +1,3 @@
-vault = "tests/fixtures/test_vault"
-
-# folders to ignore when parsing content
-exclude_paths = [".git", ".obsidian", "ignore_folder"]
-
-[metadata]
-    metadata_location = "frontmatter" # "frontmatter", "top", "bottom"
-    tags_location     = "top"         # "frontmatter", "top", "bottom"
+["Test Vault"]
+    exclude_paths = [".git", ".obsidian", "ignore_folder"]
+    path          = "tests/fixtures/test_vault"

tests/helpers.py

@@ -4,6 +4,24 @@
 import re
 
 
+class KeyInputs:
+    """Key inputs for testing."""
+
+    DOWN = "\x1b[B"
+    UP = "\x1b[A"
+    LEFT = "\x1b[D"
+    RIGHT = "\x1b[C"
+    ENTER = "\r"
+    ESCAPE = "\x1b"
+    CONTROLC = "\x03"
+    BACK = "\x7f"
+    SPACE = " "
+    TAB = "\x09"
+    ONE = "1"
+    TWO = "2"
+    THREE = "3"
+
+
 class Regex:
     """Assert that a given string meets some expectations.
 

tests/questions_test.py

@@ -0,0 +1,113 @@
+# type: ignore
+"""Test the questions class."""
+
+from pathlib import Path
+
+from obsidian_metadata._config import Config
+from obsidian_metadata.models.questions import Questions
+from obsidian_metadata.models.vault import Vault
+
+VAULT_PATH = Path("tests/fixtures/test_vault")
+CONFIG = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=VAULT_PATH)
+VAULT_CONFIG = CONFIG.vaults[0]
+VAULT = Vault(config=VAULT_CONFIG)
+
+
+def test_validate_valid_dir() -> None:
+    """Test vault validation."""
+    questions = Questions(vault=VAULT)
+    assert questions._validate_valid_dir("tests/") is True
+    assert "Path is not a directory" in questions._validate_valid_dir("pyproject.toml")
+    assert "Path does not exist" in questions._validate_valid_dir("tests/vault2")
+
+
+def test_validate_valid_regex() -> None:
+    """Test regex validation."""
+    questions = Questions(vault=VAULT)
+    assert questions._validate_valid_vault_regex(r".*\.md") is True
+    assert "Invalid regex" in questions._validate_valid_vault_regex("[")
+    assert "Regex cannot be empty" in questions._validate_valid_vault_regex("")
+    assert "Regex does not match paths" in questions._validate_valid_vault_regex(r"\d\d\d\w\d")
+
+
+def test_validate_key_exists() -> None:
+    """Test key validation."""
+    questions = Questions(vault=VAULT)
+    assert "'test' does not exist" in questions._validate_key_exists("test")
+    assert "Key cannot be empty" in questions._validate_key_exists("")
+    assert questions._validate_key_exists("frontmatter_Key1") is True
+
+
+def test_validate_new_key() -> None:
+    """Test new key validation."""
+    questions = Questions(vault=VAULT)
+    assert "Key cannot contain spaces or special characters" in questions._validate_new_key(
+        "new key"
+    )
+    assert "Key cannot contain spaces or special characters" in questions._validate_new_key(
+        "new_key!"
+    )
+    assert "New key cannot be empty" in questions._validate_new_key("")
+    assert questions._validate_new_key("new_key") is True
+
+
+def test_validate_new_tag() -> None:
+    """Test new tag validation."""
+    questions = Questions(vault=VAULT)
+    assert "New tag cannot be empty" in questions._validate_new_tag("")
+    assert "Tag cannot contain spaces or special characters" in questions._validate_new_tag(
+        "new tag"
+    )
+    assert questions._validate_new_tag("new_tag") is True
+
+
+def test_validate_existing_inline_tag() -> None:
+    """Test existing tag validation."""
+    questions = Questions(vault=VAULT)
+    assert "Tag cannot be empty" in questions._validate_existing_inline_tag("")
+    assert "'test' does not exist" in questions._validate_existing_inline_tag("test")
+    assert questions._validate_existing_inline_tag("shared_tag") is True
+
+
+def test_validate_key_exists_regex() -> None:
+    """Test key exists regex validation."""
+    questions = Questions(vault=VAULT)
+    assert "'test' does not exist" in questions._validate_key_exists_regex("test")
+    assert "Key cannot be empty" in questions._validate_key_exists_regex("")
+    assert "Invalid regex" in questions._validate_key_exists_regex("[")
+    assert questions._validate_key_exists_regex(r"\w+_Key\d") is True
+
+
+def test_validate_value() -> None:
+    """Test value validation."""
+    questions = Questions(vault=VAULT)
+    assert questions._validate_value("test") is True
+    assert "Value cannot be empty" in questions._validate_value("")
+
+    questions2 = Questions(vault=VAULT, key="frontmatter_Key1")
+    assert questions2._validate_value("test") == "frontmatter_Key1:test does not exist"
+    assert "Value cannot be empty" in questions2._validate_value("")
+    assert questions2._validate_value("author name") is True
+
+
+def test_validate_value_exists_regex() -> None:
+    """Test value exists regex validation."""
+    questions2 = Questions(vault=VAULT, key="frontmatter_Key1")
+    assert "Invalid regex" in questions2._validate_value_exists_regex("[")
+    assert "Regex cannot be empty" in questions2._validate_value_exists_regex("")
+    assert (
+        questions2._validate_value_exists_regex(r"\d\d\d\w\d")
+        == r"No values in frontmatter_Key1 match regex: \d\d\d\w\d"
+    )
+    assert questions2._validate_value_exists_regex(r"^author \w+") is True
+
+
+def test_validate_new_value() -> None:
+    """Test new value validation."""
+    questions = Questions(vault=VAULT, key="frontmatter_Key1")
+    assert questions._validate_new_value("new_value") is True
+    assert "Value cannot be empty" in questions._validate_new_value("")
+    assert (
+        questions._validate_new_value("author name")
+        == "frontmatter_Key1:author name already exists"
+    )

tests/utilities_test.py

@@ -7,7 +7,6 @@ from obsidian_metadata._utils import (
     dict_contains,
     dict_values_to_lists_strings,
     remove_markdown_sections,
-    vault_validation,
 )
 
 
@@ -67,13 +66,6 @@ def test_dict_values_to_lists_strings():
     }
 
 
-def test_vault_validation():
-    """Test vault validation."""
-    assert vault_validation("tests/") is True
-    assert "Path is not a directory" in vault_validation("pyproject.toml")
-    assert "Path does not exist" in vault_validation("tests/vault2")
-
-
 def test_remove_markdown_sections():
     """Test removing markdown sections."""
     text: str = """

tests/vault_test.py

@@ -12,17 +12,18 @@ def test_vault_creation(test_vault):
     """Test creating a Vault object."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
     assert vault.vault_path == vault_path
     assert vault.backup_path == Path(f"{vault_path}.bak")
-    assert vault.new_vault_path == Path(f"{vault_path}.new")
     assert vault.dry_run is False
     assert str(vault.exclude_paths[0]) == Regex(r".*\.git")
-    assert vault.num_notes() == 2
+    assert vault.num_notes() == 3
 
     assert vault.metadata.dict == {
         "Inline Tags": [
+            "ignored_file_tag2",
             "inline_tag_bottom1",
             "inline_tag_bottom2",
             "inline_tag_top1",
@@ -31,24 +32,29 @@ def test_vault_creation(test_vault):
             "intext_tag2",
             "shared_tag",
         ],
+        "author": ["author name"],
         "bottom_key1": ["bottom_key1_value"],
         "bottom_key2": ["bottom_key2_value"],
         "date_created": ["2022-12-22"],
         "emoji_📅_key": ["emoji_📅_key_value"],
         "frontmatter_Key1": ["author name"],
         "frontmatter_Key2": ["article", "note"],
+        "ignored_frontmatter": ["ignore_me"],
         "intext_key": ["intext_value"],
         "shared_key1": ["shared_key1_value"],
         "shared_key2": ["shared_key2_value1", "shared_key2_value2"],
         "tags": [
             "frontmatter_tag1",
             "frontmatter_tag2",
+            "frontmatter_tag3",
+            "ignored_file_tag1",
             "shared_tag",
             "📅/frontmatter_tag3",
         ],
         "top_key1": ["top_key1_value"],
         "top_key2": ["top_key2_value"],
         "top_key3": ["top_key3_value_as_link"],
+        "type": ["article", "note"],
     }
 
 
@@ -56,13 +62,15 @@ def test_get_filtered_notes(sample_vault) -> None:
     """Test filtering notes."""
     vault_path = sample_vault
     config = Config(config_path="tests/fixtures/sample_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config, path_filter="front")
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config, path_filter="front")
 
     assert vault.num_notes() == 4
 
     vault_path = sample_vault
     config = Config(config_path="tests/fixtures/sample_vault_config.toml", vault_path=vault_path)
-    vault2 = Vault(config=config, path_filter="mixed")
+    vault_config = config.vaults[0]
+    vault2 = Vault(config=vault_config, path_filter="mixed")
 
     assert vault2.num_notes() == 1
 
@@ -71,7 +79,8 @@ def test_backup(test_vault, capsys):
     """Test backing up the vault."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config, dry_run=False)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
     vault.backup()
 
@@ -89,7 +98,8 @@ def test_backup_dryrun(test_vault, capsys):
     """Test backing up the vault."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config, dry_run=True)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config, dry_run=True)
 
     print(f"vault.dry_run: {vault.dry_run}")
     vault.backup()
@@ -103,7 +113,8 @@ def test_delete_backup(test_vault, capsys):
     """Test deleting the vault backup."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config, dry_run=False)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
     vault.backup()
     vault.delete_backup()
@@ -122,7 +133,8 @@ def test_delete_backup_dryrun(test_vault, capsys):
     """Test deleting the vault backup."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config, dry_run=True)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config, dry_run=True)
 
     Path.mkdir(vault.backup_path)
     vault.delete_backup()
@@ -136,7 +148,8 @@ def test_info(test_vault, capsys):
     """Test printing vault information."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
     vault.info()
 
@@ -150,7 +163,8 @@ def test_contains_inline_tag(test_vault) -> None:
     """Test if the vault contains an inline tag."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
     assert vault.contains_inline_tag("tag") is False
     assert vault.contains_inline_tag("intext_tag2") is True
@@ -160,7 +174,8 @@ def test_contains_metadata(test_vault) -> None:
     """Test if the vault contains a metadata key."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
     assert vault.contains_metadata("key") is False
     assert vault.contains_metadata("top_key1") is True
@@ -172,11 +187,13 @@ def test_delete_inline_tag(test_vault) -> None:
     """Test deleting an inline tag."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
-    assert vault.delete_inline_tag("no tag") is False
-    assert vault.delete_inline_tag("intext_tag2") is True
+    assert vault.delete_inline_tag("no tag") == 0
+    assert vault.delete_inline_tag("intext_tag2") == 2
     assert vault.metadata.dict["Inline Tags"] == [
+        "ignored_file_tag2",
         "inline_tag_bottom1",
         "inline_tag_bottom2",
         "inline_tag_top1",
@@ -190,15 +207,16 @@ def test_delete_metadata(test_vault) -> None:
     """Test deleting a metadata key/value."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
     assert vault.delete_metadata("no key") == 0
     assert vault.delete_metadata("top_key1", "no_value") == 0
 
-    assert vault.delete_metadata("top_key1", "top_key1_value") == 1
+    assert vault.delete_metadata("top_key1", "top_key1_value") == 2
     assert vault.metadata.dict["top_key1"] == []
 
-    assert vault.delete_metadata("top_key2") == 1
+    assert vault.delete_metadata("top_key2") == 2
     assert "top_key2" not in vault.metadata.dict
 
 
@@ -206,11 +224,13 @@ def test_rename_inline_tag(test_vault) -> None:
     """Test renaming an inline tag."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
-    assert vault.rename_inline_tag("no tag", "new_tag") is False
-    assert vault.rename_inline_tag("intext_tag2", "new_tag") is True
+    assert vault.rename_inline_tag("no tag", "new_tag") == 0
+    assert vault.rename_inline_tag("intext_tag2", "new_tag") == 2
     assert vault.metadata.dict["Inline Tags"] == [
+        "ignored_file_tag2",
         "inline_tag_bottom1",
         "inline_tag_bottom2",
         "inline_tag_top1",
@@ -225,23 +245,28 @@ def test_rename_metadata(test_vault) -> None:
     """Test renaming a metadata key/value."""
     vault_path = test_vault
     config = Config(config_path="tests/fixtures/test_vault_config.toml", vault_path=vault_path)
-    vault = Vault(config=config)
+    vault_config = config.vaults[0]
+    vault = Vault(config=vault_config)
 
-    assert vault.rename_metadata("no key", "new_key") is False
-    assert vault.rename_metadata("tags", "nonexistent_value", "new_vaule") is False
+    assert vault.rename_metadata("no key", "new_key") == 0
+    assert vault.rename_metadata("tags", "nonexistent_value", "new_vaule") == 0
 
-    assert vault.rename_metadata("tags", "frontmatter_tag1", "new_vaule") is True
+    assert vault.rename_metadata("tags", "frontmatter_tag1", "new_vaule") == 2
     assert vault.metadata.dict["tags"] == [
         "frontmatter_tag2",
+        "frontmatter_tag3",
+        "ignored_file_tag1",
         "new_vaule",
         "shared_tag",
         "📅/frontmatter_tag3",
     ]
 
-    assert vault.rename_metadata("tags", "new_key") is True
+    assert vault.rename_metadata("tags", "new_key") == 2
     assert "tags" not in vault.metadata.dict
     assert vault.metadata.dict["new_key"] == [
         "frontmatter_tag2",
+        "frontmatter_tag3",
+        "ignored_file_tag1",
         "new_vaule",
         "shared_tag",
         "📅/frontmatter_tag3",