path: root/mingling_core/src/program/config.rs

/// Program stdout settings
#[derive(Debug, Clone)]
pub struct ProgramStdoutSetting {
    /// Output error messages
    pub error_output: bool,

    /// Render results and output
    pub render_output: bool,

    /// Silence panic messages
    pub silence_panic: bool,

    /// Verbose output: provide detailed information
    ///
    /// **NOTE**: Convention only, not a configuration
    pub verbose: bool,

    /// Quiet mode: suppress status messages, show only errors and results
    ///
    /// **NOTE**: Convention only, not a configuration
    pub quiet: bool,

    /// Debug mode: output internal state and detailed diagnostics
    ///
    /// **NOTE**: Convention only, not a configuration
    pub debug: bool,

    /// Enable colored output
    ///
    /// **NOTE**: Convention only, not a configuration
    pub color: bool,

    /// Show progress indicators (e.g. progress bars, spinners)
    ///
    /// Automatically disabled when stdout is not a tty.
    ///
    /// **NOTE**: Convention only, not a configuration
    pub progress: bool,

    #[cfg(feature = "clap")]
    /// Behavior when Clap Dispatcher outputs help information
    pub clap_help_print_behaviour: ClapHelpPrintBehaviour,
}

#[cfg(feature = "clap")]
#[derive(Debug, Default, Clone)]
pub enum ClapHelpPrintBehaviour {
    /// Write to RenderResult
    WriteToRenderResult,

    /// Print directly
    #[default]
    PrintDirectly,
}

impl Default for ProgramStdoutSetting {
    fn default() -> Self {
        ProgramStdoutSetting {
            error_output: true,
            render_output: true,
            silence_panic: false,
            verbose: false,
            quiet: false,
            debug: false,
            color: true,
            progress: true,
            #[cfg(feature = "clap")]
            clap_help_print_behaviour: ClapHelpPrintBehaviour::default(),
        }
    }
}

/// Program user context
#[derive(Debug, Clone)]
pub struct ProgramUserContext {
    /// View help information instead of running the command
    pub help: bool,

    /// Execute hooks during the program lifecycle
    pub run_hook: bool,

    /// Skip user confirmation step
    ///
    /// **NOTE**: Convention only, not a configuration
    pub confirm: bool,

    /// Dry-run mode: simulate actions without making changes
    ///
    /// **NOTE**: Convention only, not a configuration
    pub dry_run: bool,

    /// Force execution, skipping safety checks
    ///
    /// **NOTE**: Convention only, not a configuration
    pub force: bool,

    /// Whether the program is running in an interactive terminal (has a tty)
    ///
    /// **NOTE**: Convention only, not a configuration
    pub interactive: bool,

    /// Assume "yes" for all confirmation prompts
    ///
    /// **NOTE**: Convention only, not a configuration
    pub assume_yes: bool,
}

impl Default for ProgramUserContext {
    fn default() -> Self {
        Self {
            help: false,
            run_hook: true,
            confirm: false,
            dry_run: false,
            force: false,
            interactive: false,
            assume_yes: false,
        }
    }
}

#[cfg(feature = "general_renderer")]
#[derive(Debug, Clone, Default)]
/// Settings for the general renderer output format.
///
/// Controls how structured data (e.g., JSON, YAML, TOML) is rendered to stdout.
pub enum GeneralRendererSetting {
    /// Do not render structured output (use default formatting).
    #[default]
    Disable,
    /// Render output as compact JSON.
    #[cfg(feature = "json_serde_fmt")]
    Json,
    /// Render output as pretty-printed JSON.
    #[cfg(feature = "json_serde_fmt")]
    JsonPretty,
    /// Render output as YAML.
    #[cfg(feature = "yaml_serde_fmt")]
    Yaml,
    /// Render output as TOML.
    #[cfg(feature = "toml_serde_fmt")]
    Toml,
    /// Render output as RON.
    #[cfg(feature = "ron_serde_fmt")]
    Ron,
    /// Render output as pretty-printed RON.
    #[cfg(feature = "ron_serde_fmt")]
    RonPretty,
}

#[cfg(feature = "general_renderer")]
impl std::str::FromStr for GeneralRendererSetting {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match just_fmt::kebab_case!(s).as_str() {
            "disable" => Ok(GeneralRendererSetting::Disable),
            #[cfg(feature = "json_serde_fmt")]
            "json" => Ok(GeneralRendererSetting::Json),
            #[cfg(feature = "json_serde_fmt")]
            "json-pretty" => Ok(GeneralRendererSetting::JsonPretty),
            #[cfg(feature = "yaml_serde_fmt")]
            "yaml" => Ok(GeneralRendererSetting::Yaml),
            #[cfg(feature = "toml_serde_fmt")]
            "toml" => Ok(GeneralRendererSetting::Toml),
            #[cfg(feature = "ron_serde_fmt")]
            "ron" => Ok(GeneralRendererSetting::Ron),
            #[cfg(feature = "ron_serde_fmt")]
            "ron-pretty" => Ok(GeneralRendererSetting::RonPretty),
            _ => Err(format!("Invalid renderer: '{s}'")),
        }
    }
}

#[cfg(feature = "general_renderer")]
impl From<&str> for GeneralRendererSetting {
    fn from(s: &str) -> Self {
        s.parse().unwrap_or(GeneralRendererSetting::Disable)
    }
}

#[cfg(feature = "general_renderer")]
impl From<String> for GeneralRendererSetting {
    fn from(s: String) -> Self {
        s.as_str().into()
    }
}

#[cfg(feature = "general_renderer")]
impl std::fmt::Display for GeneralRendererSetting {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            GeneralRendererSetting::Disable => write!(f, "disable"),
            #[cfg(feature = "json_serde_fmt")]
            GeneralRendererSetting::Json => write!(f, "json"),
            #[cfg(feature = "json_serde_fmt")]
            GeneralRendererSetting::JsonPretty => write!(f, "json-pretty"),
            #[cfg(feature = "yaml_serde_fmt")]
            GeneralRendererSetting::Yaml => write!(f, "yaml"),
            #[cfg(feature = "toml_serde_fmt")]
            GeneralRendererSetting::Toml => write!(f, "toml"),
            #[cfg(feature = "ron_serde_fmt")]
            GeneralRendererSetting::Ron => write!(f, "ron"),
            #[cfg(feature = "ron_serde_fmt")]
            GeneralRendererSetting::RonPretty => write!(f, "ron-pretty"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn program_stdout_setting_default() {
        let s = ProgramStdoutSetting::default();
        assert!(s.error_output);
        assert!(s.render_output);
        assert!(!s.silence_panic);
        assert!(!s.verbose);
        assert!(!s.quiet);
        assert!(!s.debug);
        assert!(s.color);
        assert!(s.progress);
    }

    #[test]
    fn program_user_context_default() {
        let ctx = ProgramUserContext::default();
        assert!(!ctx.help);
        assert!(ctx.run_hook);
        assert!(!ctx.confirm);
        assert!(!ctx.dry_run);
        assert!(!ctx.force);
        assert!(!ctx.interactive);
        assert!(!ctx.assume_yes);
    }

    #[cfg(feature = "general_renderer")]
    mod general_renderer_tests {
        use super::*;

        #[test]
        fn from_str_disable() {
            let val: GeneralRendererSetting = "disable".parse().unwrap();
            assert!(matches!(val, GeneralRendererSetting::Disable));
        }

        #[cfg(feature = "json_serde_fmt")]
        #[test]
        fn from_str_json() {
            let val: GeneralRendererSetting = "json".parse().unwrap();
            assert!(matches!(val, GeneralRendererSetting::Json));
        }

        #[cfg(feature = "json_serde_fmt")]
        #[test]
        fn from_str_json_pretty() {
            let val: GeneralRendererSetting = "json-pretty".parse().unwrap();
            assert!(matches!(val, GeneralRendererSetting::JsonPretty));
        }

        #[cfg(feature = "yaml_serde_fmt")]
        #[test]
        fn from_str_yaml() {
            let val: GeneralRendererSetting = "yaml".parse().unwrap();
            assert!(matches!(val, GeneralRendererSetting::Yaml));
        }

        #[cfg(feature = "toml_serde_fmt")]
        #[test]
        fn from_str_toml() {
            let val: GeneralRendererSetting = "toml".parse().unwrap();
            assert!(matches!(val, GeneralRendererSetting::Toml));
        }

        #[cfg(feature = "ron_serde_fmt")]
        #[test]
        fn from_str_ron() {
            let val: GeneralRendererSetting = "ron".parse().unwrap();
            assert!(matches!(val, GeneralRendererSetting::Ron));
        }

        #[cfg(feature = "ron_serde_fmt")]
        #[test]
        fn from_str_ron_pretty() {
            let val: GeneralRendererSetting = "ron-pretty".parse().unwrap();
            assert!(matches!(val, GeneralRendererSetting::RonPretty));
        }

        #[test]
        fn from_str_invalid() {
            let res: Result<GeneralRendererSetting, String> = "invalid".parse();
            assert!(res.is_err());
        }

        #[test]
        fn from_str_kebab_case() {
            let val: GeneralRendererSetting = "JsonPretty".parse().unwrap();
            assert!(matches!(val, GeneralRendererSetting::JsonPretty));
        }

        #[test]
        fn from_str_case_insensitive() {
            let val: GeneralRendererSetting = "JSON".parse().unwrap();
            assert!(matches!(val, GeneralRendererSetting::Json));
        }

        #[test]
        fn from_and_str() {
            let val = <GeneralRendererSetting as From<&str>>::from("json");
            assert!(
                matches!(val, GeneralRendererSetting::Disable)
                    || matches!(val, GeneralRendererSetting::Json)
            );

            let val = <GeneralRendererSetting as From<&str>>::from("invalid");
            assert!(matches!(val, GeneralRendererSetting::Disable));
        }

        #[test]
        fn from_string() {
            let val = <GeneralRendererSetting as From<String>>::from("json-pretty".to_string());
            assert!(
                matches!(val, GeneralRendererSetting::Disable)
                    || matches!(val, GeneralRendererSetting::JsonPretty)
            );
        }

        #[test]
        fn display_disable() {
            assert_eq!(GeneralRendererSetting::Disable.to_string(), "disable");
        }

        #[cfg(feature = "json_serde_fmt")]
        #[test]
        fn display_json() {
            assert_eq!(GeneralRendererSetting::Json.to_string(), "json");
        }

        #[cfg(feature = "json_serde_fmt")]
        #[test]
        fn display_json_pretty() {
            assert_eq!(
                GeneralRendererSetting::JsonPretty.to_string(),
                "json-pretty"
            );
        }
    }
}