revue 2.71.1

//! Configuration loading utilities
//!
//! Provides standard patterns for loading TOML configuration files
//! from XDG-compliant locations (~/.config/app-name/config.toml).
//!
//! # Example
//!
//! ```ignore
//! use revue::patterns::{AppConfig, ConfigError};
//! use serde::Deserialize;
//!
//! #[derive(Deserialize)]
//! struct MyAppConfig {
//!     server_url: String,
//!     api_token: String,
//!     #[serde(default)]
//!     timeout: u64,
//! }
//!
//! impl AppConfig for MyAppConfig {
//!     fn config_dir() -> &'static str {
//!         "myapp"
//!     }
//!
//!     fn config_file() -> &'static str {
//!         "config.toml"
//!     }
//! }
//!
//! fn main() {
//!     let config = MyAppConfig::load().unwrap_or_else(|e| {
//!         eprintln!("Config error: {}", e);
//!         std::process::exit(1);
//!     });
//! }
//! ```

use serde::de::DeserializeOwned;
use std::fmt;
use std::fs;
use std::path::{Path, PathBuf};

use crate::constants::MAX_CONFIG_FILE_SIZE;

/// Configuration loading errors
#[derive(Debug, Clone)]
pub enum ConfigError {
    /// Config file not found
    NotFound(PathBuf),
    /// Home directory not found
    NoHome,
    /// Failed to read file
    ReadError(PathBuf, String),
    /// Failed to parse TOML
    ParseError(String),
    /// Invalid configuration value
    ValidationError(String),
}

impl fmt::Display for ConfigError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ConfigError::NotFound(path) => {
                write!(
                    f,
                    "Config file not found: {}\n  Hint: Create the file or use load_or_default() to use defaults",
                    path.display()
                )
            }
            ConfigError::NoHome => {
                write!(
                    f,
                    "Could not determine home directory\n  Hint: Ensure HOME environment variable is set"
                )
            }
            ConfigError::ReadError(path, err) => {
                write!(
                    f,
                    "Failed to read config {}: {}\n  Hint: Check file permissions and ensure the file exists",
                    path.display(),
                    err
                )
            }
            ConfigError::ParseError(err) => {
                write!(
                    f,
                    "Failed to parse config: {}\n  Hint: Ensure TOML syntax is valid (check for unmatched brackets, quotes, etc.)",
                    err
                )
            }
            ConfigError::ValidationError(err) => {
                write!(
                    f,
                    "Invalid config: {}\n  Hint: Review config values against expected types and ranges",
                    err
                )
            }
        }
    }
}

impl std::error::Error for ConfigError {}

/// Configuration loading trait
///
/// Implement this for your app's config struct to get standardized loading.
pub trait AppConfig: Sized + DeserializeOwned {
    /// Config directory name under ~/.config/
    ///
    /// # Example
    ///
    /// ```ignore
    /// fn config_dir() -> &'static str {
    ///     "myapp"  // -> ~/.config/myapp/
    /// }
    /// ```
    fn config_dir() -> &'static str;

    /// Config file name
    ///
    /// # Example
    ///
    /// ```ignore
    /// fn config_file() -> &'static str {
    ///     "config.toml"
    /// }
    /// ```
    fn config_file() -> &'static str {
        "config.toml"
    }

    /// Get full config file path
    ///
    /// Returns `~/.config/{config_dir}/{config_file}`
    fn config_path() -> Result<PathBuf, ConfigError> {
        let home = dirs::home_dir().ok_or(ConfigError::NoHome)?;
        Ok(home
            .join(".config")
            .join(Self::config_dir())
            .join(Self::config_file()))
    }

    /// Load config from default location
    ///
    /// # Errors
    ///
    /// Returns error if:
    /// - Home directory not found
    /// - Config file doesn't exist
    /// - File can't be read
    /// - TOML parsing fails
    fn load() -> Result<Self, ConfigError> {
        let path = Self::config_path()?;
        Self::load_from(&path)
    }

    /// Load config from specific path
    fn load_from(path: &Path) -> Result<Self, ConfigError> {
        if !path.exists() {
            return Err(ConfigError::NotFound(path.to_path_buf()));
        }

        // Check file size to prevent DoS
        let metadata = fs::metadata(path)
            .map_err(|e| ConfigError::ReadError(path.to_path_buf(), e.to_string()))?;

        if metadata.len() > MAX_CONFIG_FILE_SIZE {
            return Err(ConfigError::ReadError(
                path.to_path_buf(),
                format!(
                    "Config file too large ({} bytes, max {})",
                    metadata.len(),
                    MAX_CONFIG_FILE_SIZE
                ),
            ));
        }

        let contents = fs::read_to_string(path)
            .map_err(|e| ConfigError::ReadError(path.to_path_buf(), e.to_string()))?;

        toml::from_str(&contents).map_err(|e| ConfigError::ParseError(e.to_string()))
    }

    /// Load config or use default
    ///
    /// # Example
    ///
    /// ```ignore
    /// let config = MyAppConfig::load_or_default();
    /// ```
    fn load_or_default() -> Self
    where
        Self: Default,
    {
        Self::load().unwrap_or_default()
    }

    /// Load config or exit with error message
    ///
    /// Convenience method for simple CLIs.
    ///
    /// # Example
    ///
    /// ```ignore
    /// fn main() {
    ///     let config = MyAppConfig::load_or_exit();
    ///     // ...
    /// }
    /// ```
    fn load_or_exit() -> Self {
        Self::load().unwrap_or_else(|e| {
            eprintln!("Configuration error: {}", e);
            if let ConfigError::NotFound(path) = e {
                eprintln!("\nCreate config file at: {}", path.display());
                eprintln!("\nExample config:");
                eprintln!("{}", Self::example_config());
            }
            std::process::exit(1);
        })
    }

    /// Validate configuration
    ///
    /// Override to add custom validation logic.
    ///
    /// # Example
    ///
    /// ```ignore
    /// fn validate(&self) -> Result<(), ConfigError> {
    ///     if self.api_token.is_empty() {
    ///         return Err(ConfigError::ValidationError(
    ///             "api_token cannot be empty".to_string()
    ///         ));
    ///     }
    ///     Ok(())
    /// }
    /// ```
    fn validate(&self) -> Result<(), ConfigError> {
        Ok(())
    }

    /// Example config string
    ///
    /// Override to provide example config for error messages.
    fn example_config() -> &'static str {
        "# Add example config here"
    }
}

/// Helper to create config directory if it doesn't exist
///
/// # Example
///
/// ```ignore
/// ensure_config_dir("myapp")?;
/// ```
pub fn ensure_config_dir(app_name: &str) -> Result<PathBuf, ConfigError> {
    let home = dirs::home_dir().ok_or(ConfigError::NoHome)?;
    let config_dir = home.join(".config").join(app_name);

    if !config_dir.exists() {
        fs::create_dir_all(&config_dir)
            .map_err(|e| ConfigError::ReadError(config_dir.clone(), e.to_string()))?;
    }

    Ok(config_dir)
}

/// Helper to write default config file
///
/// # Example
///
/// ```ignore
/// write_default_config("myapp", "config.toml", DEFAULT_CONFIG_TOML)?;
/// ```
pub fn write_default_config(
    app_name: &str,
    filename: &str,
    contents: &str,
) -> Result<PathBuf, ConfigError> {
    let config_dir = ensure_config_dir(app_name)?;
    let config_path = config_dir.join(filename);

    if config_path.exists() {
        return Err(ConfigError::ValidationError(format!(
            "Config file already exists: {}",
            config_path.display()
        )));
    }

    fs::write(&config_path, contents)
        .map_err(|e| ConfigError::ReadError(config_path.clone(), e.to_string()))?;

    Ok(config_path)
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde::Deserialize;
    use std::io::Write;
    use tempfile::NamedTempFile;

    #[derive(Deserialize, Default, Debug)]
    struct TestConfig {
        name: String,
        value: i32,
    }

    impl AppConfig for TestConfig {
        fn config_dir() -> &'static str {
            "revue-test"
        }

        fn example_config() -> &'static str {
            "name = \"test\"\nvalue = 42"
        }
    }

    #[derive(Deserialize, Default)]
    struct MinimalConfig {
        #[allow(dead_code)]
        data: String,
    }

    impl AppConfig for MinimalConfig {
        fn config_dir() -> &'static str {
            "revue-minimal"
        }
        // Uses all defaults
    }

    // ConfigError tests
    #[test]
    fn test_config_error_not_found_display() {
        let err = ConfigError::NotFound(PathBuf::from("/test/config.toml"));
        let msg = err.to_string();
        assert!(msg.contains("not found"));
        assert!(msg.contains("/test/config.toml"));
    }

    #[test]
    fn test_config_error_no_home_display() {
        let err = ConfigError::NoHome;
        assert!(err.to_string().contains("home directory"));
    }

    #[test]
    fn test_config_error_read_error_display() {
        let err = ConfigError::ReadError(
            PathBuf::from("/some/path.toml"),
            "permission denied".to_string(),
        );
        let msg = err.to_string();
        assert!(msg.contains("/some/path.toml"));
        assert!(msg.contains("permission denied"));
    }

    #[test]
    fn test_config_error_parse_error_display() {
        let err = ConfigError::ParseError("invalid TOML syntax".to_string());
        let msg = err.to_string();
        assert!(msg.contains("parse"));
        assert!(msg.contains("invalid TOML syntax"));
    }

    #[test]
    fn test_config_error_validation_error_display() {
        let err = ConfigError::ValidationError("field cannot be empty".to_string());
        let msg = err.to_string();
        assert!(msg.contains("Invalid"));
        assert!(msg.contains("field cannot be empty"));
    }

    #[test]
    fn test_config_error_debug() {
        let err = ConfigError::NoHome;
        let debug = format!("{:?}", err);
        assert!(debug.contains("NoHome"));
    }

    #[test]
    fn test_config_error_clone() {
        let err = ConfigError::ParseError("test".to_string());
        let cloned = err.clone();
        assert_eq!(err.to_string(), cloned.to_string());
    }

    #[test]
    fn test_config_error_is_error() {
        let err: Box<dyn std::error::Error> = Box::new(ConfigError::NoHome);
        assert!(err.to_string().contains("home"));
    }

    // AppConfig trait tests
    #[test]
    fn test_config_path() {
        let path = TestConfig::config_path().unwrap();
        let path_str = path.to_string_lossy();
        assert!(
            path_str.contains("revue-test") && path_str.ends_with("config.toml"),
            "Unexpected path: {}",
            path_str
        );
    }

    #[test]
    fn test_config_file_default() {
        assert_eq!(MinimalConfig::config_file(), "config.toml");
    }

    #[test]
    fn test_example_config_default() {
        // MinimalConfig uses the default example_config
        let example = MinimalConfig::example_config();
        assert!(example.contains("example"));
    }

    #[test]
    fn test_example_config_custom() {
        let example = TestConfig::example_config();
        assert!(example.contains("name"));
        assert!(example.contains("value"));
    }

    #[test]
    fn test_validate_default() {
        let config = TestConfig::default();
        assert!(config.validate().is_ok());
    }

    #[test]
    fn test_load_from_string() {
        let toml = "name = \"test\"\nvalue = 42";
        let config: TestConfig = toml::from_str(toml).unwrap();
        assert_eq!(config.name, "test");
        assert_eq!(config.value, 42);
    }

    #[test]
    fn test_load_from_file() {
        let mut file = NamedTempFile::new().unwrap();
        writeln!(file, "name = \"loaded\"\nvalue = 123").unwrap();

        let config = TestConfig::load_from(file.path()).unwrap();
        assert_eq!(config.name, "loaded");
        assert_eq!(config.value, 123);
    }

    #[test]
    fn test_load_from_nonexistent() {
        let result = TestConfig::load_from(Path::new("/nonexistent/path/config.toml"));
        assert!(result.is_err());
        match result.unwrap_err() {
            ConfigError::NotFound(path) => {
                assert!(path.to_string_lossy().contains("nonexistent"));
            }
            _ => panic!("Expected NotFound error"),
        }
    }

    #[test]
    fn test_load_from_invalid_toml() {
        let mut file = NamedTempFile::new().unwrap();
        writeln!(file, "this is not valid {{ toml }}").unwrap();

        let result = TestConfig::load_from(file.path());
        assert!(result.is_err());
        match result.unwrap_err() {
            ConfigError::ParseError(msg) => {
                assert!(!msg.is_empty());
            }
            _ => panic!("Expected ParseError"),
        }
    }

    #[test]
    fn test_load_or_default() {
        // This will fail to load (no file) and return default
        let config = TestConfig::load_or_default();
        assert_eq!(config.name, ""); // Default empty string
        assert_eq!(config.value, 0); // Default i32
    }

    // Helper function tests
    #[test]
    fn test_ensure_config_dir() {
        // This creates a real directory in ~/.config/
        let result = ensure_config_dir("revue-test-ensure");
        assert!(result.is_ok());
        let path = result.unwrap();
        assert!(path.exists());
        // Clean up
        let _ = std::fs::remove_dir(&path);
    }

    #[test]
    fn test_write_default_config_new() {
        let app_name = format!("revue-test-write-{}", std::process::id());
        let result = write_default_config(&app_name, "test.toml", "key = \"value\"");
        assert!(result.is_ok());
        let path = result.unwrap();
        assert!(path.exists());

        // Verify contents
        let contents = std::fs::read_to_string(&path).unwrap();
        assert_eq!(contents, "key = \"value\"");

        // Clean up
        let _ = std::fs::remove_file(&path);
        let _ = std::fs::remove_dir(path.parent().unwrap());
    }

    #[test]
    fn test_write_default_config_exists() {
        let app_name = format!("revue-test-exists-{}", std::process::id());

        // Create first
        let path = write_default_config(&app_name, "test.toml", "first").unwrap();

        // Try to create again - should fail
        let result = write_default_config(&app_name, "test.toml", "second");
        assert!(result.is_err());
        match result.unwrap_err() {
            ConfigError::ValidationError(msg) => {
                assert!(msg.contains("already exists"));
            }
            _ => panic!("Expected ValidationError"),
        }

        // Clean up
        let _ = std::fs::remove_file(&path);
        let _ = std::fs::remove_dir(path.parent().unwrap());
    }
}