refactor: move statics related to config into the appropriate module

Author: nik-rev

src/commands/gen_patch.rs

@@ -5,18 +5,18 @@ use std::path::PathBuf;
 
 use anyhow::bail;
 
-use crate::config::{CommitId, PatchName};
+use crate::config::{self, CommitId, PatchName};
+use crate::git;
 use crate::utils::normalize_commit_msg;
-use crate::{CONFIG_PATH, git};
 
 /// Generate patch `filename` at the given `Commit`
 pub fn gen_patch(commit: CommitId, filename: Option<PatchName>) -> anyhow::Result<()> {
-    if !CONFIG_PATH.exists() {
+    if !config::PATH.exists() {
         log::info!(
             "Config directory {} does not exist, creating it...",
-            CONFIG_PATH.to_string_lossy()
+            config::PATH.to_string_lossy()
         );
-        fs::create_dir_all(&*CONFIG_PATH)?;
+        fs::create_dir_all(&*config::PATH)?;
     }
 
     // 1. if the user provides a custom filename for the patch file, use that
@@ -34,7 +34,7 @@ pub fn gen_patch(commit: CommitId, filename: Option<PatchName>) -> anyhow::Resul
         )
     });
 
-    let patch_file_path = CONFIG_PATH.join(format!("{patch_filename}.patch"));
+    let patch_file_path = config::PATH.join(format!("{patch_filename}.patch"));
 
     // Paths are UTF-8 encoded. If we cannot convert to UTF-8 that means it is not a
     // valid path

src/commands/init.rs

@@ -6,26 +6,26 @@ use std::io::Write as _;
 use anyhow::bail;
 use colored::Colorize as _;
 
-use crate::{CONFIG_FILE_PATH, CONFIG_PATH, confirm_prompt};
+use crate::{config, confirm_prompt};
 
 /// Initialize the Patchy config file
 pub fn init() -> anyhow::Result<()> {
-    if CONFIG_FILE_PATH.exists()
+    if config::FILE_PATH.exists()
         && !confirm_prompt!(
             "File {} already exists. Overwrite it?",
-            CONFIG_FILE_PATH.to_string_lossy().bright_blue(),
+            config::FILE_PATH.to_string_lossy().bright_blue(),
         )
     {
-        bail!("Did not overwrite {}", CONFIG_FILE_PATH.display());
+        bail!("Did not overwrite {}", config::FILE_PATH.display());
     }
 
-    fs::create_dir_all(&*CONFIG_PATH)?;
+    fs::create_dir_all(&*config::PATH)?;
 
-    let mut file = File::create(&*CONFIG_FILE_PATH)?;
+    let mut file = File::create(&*config::FILE_PATH)?;
 
     file.write_all(include_bytes!("../../example-config.toml"))?;
 
-    log::info!("Created config file {}", CONFIG_FILE_PATH.display());
+    log::info!("Created config file {}", config::FILE_PATH.display());
 
     Ok(())
 }

src/commands/run.rs

@@ -1,6 +1,6 @@
 //! `run` subcommand
 
-use crate::config::{BranchName, Config, PullRequest};
+use crate::config::{self, BranchName, Config, PullRequest};
 use std::ffi::OsString;
 use std::fs::{self, File};
 use std::io::Write as _;
@@ -12,9 +12,7 @@ use colored::Colorize as _;
 use crate::git_high_level;
 use crate::github_api::{self, Branch, Remote, RemoteBranch};
 use crate::utils::{display_link, with_uuid};
-use crate::{
-    CONFIG_FILE, CONFIG_FILE_PATH, CONFIG_PATH, CONFIG_ROOT, commands, confirm_prompt, git,
-};
+use crate::{commands, confirm_prompt, git};
 
 /// Backup for a file
 struct FileBackup {
@@ -26,10 +24,13 @@ struct FileBackup {
 
 /// Run patchy, if `yes` then there will be no prompt
 pub async fn run(yes: bool) -> anyhow::Result<()> {
-    let root = CONFIG_ROOT.as_str();
+    let root = config::ROOT.as_str();
 
-    let Ok(config_string) = fs::read_to_string(&*CONFIG_FILE_PATH) else {
-        log::error!("Could not find configuration file at {root}/{CONFIG_FILE}");
+    let Ok(config_string) = fs::read_to_string(&*config::FILE_PATH) else {
+        log::error!(
+            "Could not find configuration file at {root}/{}",
+            config::FILE
+        );
 
         // We don't want to have *any* sort of prompt when using the -y flag since that
         // would be problematic in scripts
@@ -47,13 +48,16 @@ pub async fn run(yes: bool) -> anyhow::Result<()> {
         return Ok(());
     };
 
-    log::trace!("Using configuration file {}", CONFIG_FILE_PATH.display());
+    log::trace!("Using configuration file {}", config::FILE_PATH.display());
 
     let config = toml::from_str::<Config>(&config_string).map_err(|err| {
-        anyhow!("Could not parse `{root}/{CONFIG_FILE}` configuration file:\n{err}",)
+        anyhow!(
+            "Could not parse `{root}/{}` configuration file:\n{err}",
+            config::FILE
+        )
     })?;
 
-    let crate::config::Branch {
+    let config::Branch {
         name: remote_branch,
         commit,
     } = config.remote_branch;
@@ -70,10 +74,10 @@ pub async fn run(yes: bool) -> anyhow::Result<()> {
 
     // --- Backup all files in the `.patchy` config directory
 
-    let config_files = fs::read_dir(&*CONFIG_PATH).map_err(|err| {
+    let config_files = fs::read_dir(&*config::PATH).map_err(|err| {
         anyhow!(
             "Failed to read files in directory `{}`:\n{err}",
-            &CONFIG_PATH.display()
+            &config::PATH.display()
         )
     })?;
 
@@ -211,15 +215,18 @@ pub async fn run(yes: bool) -> anyhow::Result<()> {
         }
     }
 
-    if let Err(err) = fs::create_dir_all(git::ROOT.join(CONFIG_ROOT.as_str())) {
+    if let Err(err) = fs::create_dir_all(git::ROOT.join(config::ROOT.as_str())) {
         git::checkout(&previous_branch)?;
 
         git::delete_remote_and_branch(
             &info.remote.local_remote_alias,
             &info.branch.local_branch_name,
         )?;
 
-        bail!("Could not create directory {}\n{err}", CONFIG_ROOT.as_str());
+        bail!(
+            "Could not create directory {}\n{err}",
+            config::ROOT.as_str()
+        );
     }
 
     // Restore all the backup files
@@ -228,7 +235,7 @@ pub async fn run(yes: bool) -> anyhow::Result<()> {
         filename, contents, ..
     } in &backed_up_files
     {
-        let path = git::ROOT.join(PathBuf::from(CONFIG_ROOT.as_str()).join(filename));
+        let path = git::ROOT.join(PathBuf::from(config::ROOT.as_str()).join(filename));
         let mut file =
             File::create(&path).map_err(|err| anyhow!("failed to restore backup: {err}"))?;
 
@@ -239,7 +246,7 @@ pub async fn run(yes: bool) -> anyhow::Result<()> {
 
     for patch in config.patches {
         let file_name = git::ROOT
-            .join(CONFIG_ROOT.as_str())
+            .join(config::ROOT.as_str())
             .join(format!("{patch}.patch"));
 
         if !file_name.exists() {
@@ -265,7 +272,7 @@ pub async fn run(yes: bool) -> anyhow::Result<()> {
         );
     }
 
-    git::add(CONFIG_ROOT.as_str())?;
+    git::add(config::ROOT.as_str())?;
     git::commit("restore configuration files")?;
 
     let temporary_branch = with_uuid("temp-branch");

src/config.rs

@@ -3,12 +3,25 @@
 use anyhow::{anyhow, bail};
 use itertools::Itertools;
 use nutype::nutype;
-use std::{convert::Infallible, fmt::Display, path::PathBuf, str::FromStr};
+use std::{convert::Infallible, env, fmt::Display, path::PathBuf, str::FromStr, sync::LazyLock};
 use tap::Pipe as _;
 
 use indexmap::IndexSet;
 use serde::Deserialize;
 
+/// Relative path to root of patchy's configuration
+pub static ROOT: LazyLock<String> =
+    LazyLock::new(|| env::var("PATCHY_CONFIG_ROOT").unwrap_or_else(|_| ".patchy".into()));
+
+/// Absolute path to root of patchy's configuration
+pub static PATH: LazyLock<PathBuf> = LazyLock::new(|| crate::git::ROOT.join(&*ROOT));
+
+/// Absolute path to patchy's config file
+pub static FILE_PATH: LazyLock<PathBuf> = LazyLock::new(|| PATH.join(FILE));
+
+/// Patchy's config file name
+pub const FILE: &str = "config.toml";
+
 /// Represents the TOML config
 #[derive(Deserialize, Debug, Eq, PartialEq)]
 #[serde(rename_all = "kebab-case")]

src/lib.rs

@@ -1,9 +1,6 @@
 //! Patchy
 
 #![cfg_attr(doc, doc = include_str!("../README.md"))]
-use std::env;
-use std::path::PathBuf;
-use std::sync::LazyLock;
 
 mod cli;
 mod commands;
@@ -13,17 +10,4 @@ mod git_high_level;
 mod github_api;
 mod utils;
 
-/// Relative path to root of patchy's configuration
-static CONFIG_ROOT: LazyLock<String> =
-    LazyLock::new(|| env::var("PATCHY_CONFIG_ROOT").unwrap_or_else(|_| ".patchy".into()));
-
-/// Absolute path to root of patchy's configuration
-static CONFIG_PATH: LazyLock<PathBuf> = LazyLock::new(|| git::ROOT.join(&*CONFIG_ROOT));
-
-/// Absolute path to patchy's config file
-static CONFIG_FILE_PATH: LazyLock<PathBuf> = LazyLock::new(|| CONFIG_PATH.join(CONFIG_FILE));
-
-/// Patchy's config file name
-const CONFIG_FILE: &str = "config.toml";
-
 pub use cli::Cli;