mirror of
https://github.com/0xrsydn/idx-cli.git
synced 2026-08-07 01:33:52 +00:00
594 lines
19 KiB
Rust
594 lines
19 KiB
Rust
use std::fs;
|
|
use std::path::PathBuf;
|
|
|
|
use clap::ValueEnum;
|
|
use directories::ProjectDirs;
|
|
use serde::Deserialize;
|
|
|
|
use crate::cli::Cli;
|
|
use crate::error::IdxError;
|
|
use crate::output::OutputFormat;
|
|
|
|
#[derive(Debug, Clone, Copy, Deserialize, PartialEq, Eq)]
|
|
#[serde(rename_all = "lowercase")]
|
|
pub enum ProviderKind {
|
|
Yahoo,
|
|
Msn,
|
|
}
|
|
|
|
#[derive(Debug, Clone, Copy, Deserialize, ValueEnum, PartialEq, Eq)]
|
|
#[serde(rename_all = "lowercase")]
|
|
#[value(rename_all = "lower")]
|
|
pub enum HistoryProviderKind {
|
|
Auto,
|
|
Yahoo,
|
|
Msn,
|
|
}
|
|
|
|
impl ProviderKind {
|
|
pub fn as_str(self) -> &'static str {
|
|
match self {
|
|
Self::Yahoo => "yahoo",
|
|
Self::Msn => "msn",
|
|
}
|
|
}
|
|
|
|
fn parse(value: &str) -> Result<Self, IdxError> {
|
|
if value.eq_ignore_ascii_case("yahoo") {
|
|
Ok(Self::Yahoo)
|
|
} else if value.eq_ignore_ascii_case("msn") {
|
|
Ok(Self::Msn)
|
|
} else {
|
|
Err(IdxError::ConfigError(format!(
|
|
"invalid provider '{value}' (expected yahoo or msn)"
|
|
)))
|
|
}
|
|
}
|
|
}
|
|
|
|
impl HistoryProviderKind {
|
|
pub fn as_str(self) -> &'static str {
|
|
match self {
|
|
Self::Auto => "auto",
|
|
Self::Yahoo => "yahoo",
|
|
Self::Msn => "msn",
|
|
}
|
|
}
|
|
|
|
fn parse(value: &str) -> Result<Self, IdxError> {
|
|
if value.eq_ignore_ascii_case("auto") {
|
|
Ok(Self::Auto)
|
|
} else if value.eq_ignore_ascii_case("yahoo") {
|
|
Ok(Self::Yahoo)
|
|
} else if value.eq_ignore_ascii_case("msn") {
|
|
Ok(Self::Msn)
|
|
} else {
|
|
Err(IdxError::ConfigError(format!(
|
|
"invalid history provider '{value}' (expected auto, yahoo, or msn)"
|
|
)))
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct IdxConfig {
|
|
pub provider: ProviderKind,
|
|
pub history_provider: HistoryProviderKind,
|
|
pub exchange: String,
|
|
pub output: OutputFormat,
|
|
pub no_color: bool,
|
|
pub quote_ttl: u64,
|
|
pub fundamental_ttl: u64,
|
|
}
|
|
|
|
#[derive(Debug, Deserialize, Default)]
|
|
struct FileConfig {
|
|
general: Option<FileGeneral>,
|
|
cache: Option<FileCache>,
|
|
}
|
|
|
|
#[derive(Debug, Deserialize, Default)]
|
|
struct FileGeneral {
|
|
provider: Option<ProviderKind>,
|
|
history_provider: Option<HistoryProviderKind>,
|
|
exchange: Option<String>,
|
|
output: Option<OutputFormat>,
|
|
color: Option<bool>,
|
|
}
|
|
|
|
#[derive(Debug, Deserialize, Default)]
|
|
struct FileCache {
|
|
quote_ttl: Option<u64>,
|
|
fundamental_ttl: Option<u64>,
|
|
}
|
|
|
|
impl Default for IdxConfig {
|
|
fn default() -> Self {
|
|
Self {
|
|
provider: ProviderKind::Msn,
|
|
history_provider: HistoryProviderKind::Auto,
|
|
exchange: "JK".to_string(),
|
|
output: OutputFormat::Table,
|
|
no_color: false,
|
|
quote_ttl: 300,
|
|
fundamental_ttl: 3600,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl IdxConfig {
|
|
pub fn load_with_cli(cli: &Cli) -> Result<Self, IdxError> {
|
|
let mut cfg = Self::load()?;
|
|
|
|
if let Ok(provider) = std::env::var("IDX_PROVIDER") {
|
|
cfg.provider = ProviderKind::parse(&provider)?;
|
|
}
|
|
if let Ok(history_provider) = std::env::var("IDX_HISTORY_PROVIDER") {
|
|
cfg.history_provider = HistoryProviderKind::parse(&history_provider)?;
|
|
}
|
|
if let Ok(exchange) = std::env::var("IDX_EXCHANGE") {
|
|
cfg.exchange = exchange;
|
|
}
|
|
if let Ok(output) = std::env::var("IDX_OUTPUT") {
|
|
cfg.output = if output.eq_ignore_ascii_case("json") {
|
|
OutputFormat::Json
|
|
} else if output.eq_ignore_ascii_case("table") {
|
|
OutputFormat::Table
|
|
} else {
|
|
return Err(IdxError::ConfigError(format!(
|
|
"invalid IDX_OUTPUT value: '{}', expected 'json' or 'table'",
|
|
output
|
|
)));
|
|
};
|
|
}
|
|
if let Ok(no_color) = std::env::var("IDX_NO_COLOR") {
|
|
cfg.no_color = no_color == "1" || no_color.eq_ignore_ascii_case("true");
|
|
}
|
|
if let Ok(v) = std::env::var("IDX_CACHE_QUOTE_TTL")
|
|
&& let Ok(parsed) = v.parse::<u64>()
|
|
{
|
|
cfg.quote_ttl = parsed;
|
|
}
|
|
if let Ok(v) = std::env::var("IDX_CACHE_FUNDAMENTAL_TTL")
|
|
&& let Ok(parsed) = v.parse::<u64>()
|
|
{
|
|
cfg.fundamental_ttl = parsed;
|
|
}
|
|
|
|
if let Some(output) = cli.output {
|
|
cfg.output = output;
|
|
}
|
|
cfg.no_color = cfg.no_color || cli.no_color;
|
|
|
|
Ok(cfg)
|
|
}
|
|
|
|
pub fn load() -> Result<Self, IdxError> {
|
|
let mut cfg = Self::default();
|
|
let path = config_path()?;
|
|
if path.exists() {
|
|
let raw = fs::read_to_string(&path).map_err(|e| IdxError::Io(e.to_string()))?;
|
|
let parsed: FileConfig =
|
|
toml::from_str(&raw).map_err(|e| IdxError::ConfigError(e.to_string()))?;
|
|
if let Some(general) = parsed.general {
|
|
if let Some(provider) = general.provider {
|
|
cfg.provider = provider;
|
|
}
|
|
if let Some(history_provider) = general.history_provider {
|
|
cfg.history_provider = history_provider;
|
|
}
|
|
if let Some(exchange) = general.exchange {
|
|
cfg.exchange = exchange;
|
|
}
|
|
if let Some(output) = general.output {
|
|
cfg.output = output;
|
|
}
|
|
if let Some(color) = general.color {
|
|
cfg.no_color = !color;
|
|
}
|
|
}
|
|
if let Some(cache) = parsed.cache {
|
|
if let Some(v) = cache.quote_ttl {
|
|
cfg.quote_ttl = v;
|
|
}
|
|
if let Some(v) = cache.fundamental_ttl {
|
|
cfg.fundamental_ttl = v;
|
|
}
|
|
}
|
|
}
|
|
Ok(cfg)
|
|
}
|
|
}
|
|
|
|
pub fn default_config_toml() -> String {
|
|
"[general]\nprovider = \"msn\"\nhistory_provider = \"auto\"\nexchange = \"JK\"\noutput = \"table\"\ncolor = true\n\n[cache]\nquote_ttl = 300\nfundamental_ttl = 3600\n".to_string()
|
|
}
|
|
|
|
pub fn config_path() -> Result<PathBuf, IdxError> {
|
|
if let Ok(dir) = std::env::var("XDG_CONFIG_HOME")
|
|
&& !dir.is_empty()
|
|
{
|
|
let path = PathBuf::from(dir);
|
|
if path.is_absolute() {
|
|
return Ok(path.join("idx").join("config.toml"));
|
|
}
|
|
}
|
|
ProjectDirs::from("", "", "idx")
|
|
.map(|d| d.config_dir().join("config.toml"))
|
|
.ok_or_else(|| IdxError::ConfigError("unable to resolve config dir".to_string()))
|
|
}
|
|
|
|
pub fn ensure_default_config() -> Result<PathBuf, IdxError> {
|
|
let path = config_path()?;
|
|
if path.exists() {
|
|
return Ok(path);
|
|
}
|
|
if let Some(parent) = path.parent() {
|
|
fs::create_dir_all(parent).map_err(|e| IdxError::Io(e.to_string()))?;
|
|
}
|
|
fs::write(&path, default_config_toml()).map_err(|e| IdxError::Io(e.to_string()))?;
|
|
Ok(path)
|
|
}
|
|
|
|
pub fn get_config_value(key: &str) -> Result<Option<String>, IdxError> {
|
|
let path = config_path()?;
|
|
if !path.exists() {
|
|
return Ok(None);
|
|
}
|
|
let raw = fs::read_to_string(path).map_err(|e| IdxError::Io(e.to_string()))?;
|
|
let value: toml::Value =
|
|
toml::from_str(&raw).map_err(|e| IdxError::ConfigError(e.to_string()))?;
|
|
|
|
let mut cur = &value;
|
|
for part in key.split('.') {
|
|
let Some(next) = cur.get(part) else {
|
|
return Ok(None);
|
|
};
|
|
cur = next;
|
|
}
|
|
Ok(Some(cur.to_string().trim_matches('"').to_string()))
|
|
}
|
|
|
|
/// Known configuration keys and their valid values
|
|
const KNOWN_CONFIG_KEYS: &[&str] = &[
|
|
"general.provider",
|
|
"general.history_provider",
|
|
"general.exchange",
|
|
"general.output",
|
|
"general.color",
|
|
"cache.quote_ttl",
|
|
"cache.fundamental_ttl",
|
|
"ownership.db_path",
|
|
];
|
|
|
|
/// Validates a config key and value before writing
|
|
fn validate_config_key_value(key: &str, value: &str) -> Result<(), IdxError> {
|
|
normalize_config_value(key, value).map(|_| ())
|
|
}
|
|
|
|
fn normalize_config_value(key: &str, value: &str) -> Result<toml::Value, IdxError> {
|
|
match key {
|
|
"general.provider" => Ok(toml::Value::String(
|
|
ProviderKind::parse(value)?.as_str().to_string(),
|
|
)),
|
|
"general.history_provider" => Ok(toml::Value::String(
|
|
HistoryProviderKind::parse(value)?.as_str().to_string(),
|
|
)),
|
|
"general.output" => {
|
|
if !value.eq_ignore_ascii_case("table") && !value.eq_ignore_ascii_case("json") {
|
|
return Err(IdxError::InvalidInput(format!(
|
|
"invalid output format '{}': expected 'table' or 'json'",
|
|
value
|
|
)));
|
|
}
|
|
Ok(toml::Value::String(value.to_ascii_lowercase()))
|
|
}
|
|
"cache.quote_ttl" | "cache.fundamental_ttl" => {
|
|
let parsed: i64 = value.parse().map_err(|_| {
|
|
IdxError::InvalidInput(format!(
|
|
"invalid TTL value '{}': must be a non-negative integer",
|
|
value
|
|
))
|
|
})?;
|
|
if parsed < 0 {
|
|
return Err(IdxError::InvalidInput(format!(
|
|
"invalid TTL value '{}': must be non-negative",
|
|
value
|
|
)));
|
|
}
|
|
Ok(toml::Value::Integer(parsed))
|
|
}
|
|
"general.exchange" => {
|
|
// Exchange is free-form (e.g. JK, US, etc.)
|
|
Ok(toml::Value::String(value.to_string()))
|
|
}
|
|
"ownership.db_path" => {
|
|
// Ownership DB path is free-form and may be absolute or relative.
|
|
Ok(toml::Value::String(value.to_string()))
|
|
}
|
|
"general.color" => {
|
|
if !value.eq_ignore_ascii_case("true") && !value.eq_ignore_ascii_case("false") {
|
|
return Err(IdxError::InvalidInput(format!(
|
|
"invalid color value '{}': expected 'true' or 'false'",
|
|
value
|
|
)));
|
|
}
|
|
Ok(toml::Value::Boolean(value.eq_ignore_ascii_case("true")))
|
|
}
|
|
_ => Err(IdxError::InvalidInput(format!(
|
|
"unknown config key '{}'. Valid keys: {}",
|
|
key,
|
|
KNOWN_CONFIG_KEYS.join(", ")
|
|
))),
|
|
}
|
|
}
|
|
|
|
pub fn set_config_value(key: &str, value: &str) -> Result<(), IdxError> {
|
|
validate_config_key_value(key, value)?;
|
|
let normalized = normalize_config_value(key, value)?;
|
|
|
|
let path = ensure_default_config()?;
|
|
let raw = fs::read_to_string(&path).map_err(|e| IdxError::Io(e.to_string()))?;
|
|
let mut root: toml::Value =
|
|
toml::from_str(&raw).map_err(|e| IdxError::ConfigError(e.to_string()))?;
|
|
|
|
let mut parts = key.split('.').peekable();
|
|
let mut current = root
|
|
.as_table_mut()
|
|
.ok_or_else(|| IdxError::ConfigError("config root is not a table".to_string()))?;
|
|
|
|
while let Some(part) = parts.next() {
|
|
if parts.peek().is_none() {
|
|
current.insert(part.to_string(), normalized.clone());
|
|
} else {
|
|
let entry = current
|
|
.entry(part.to_string())
|
|
.or_insert_with(|| toml::Value::Table(toml::map::Map::new()));
|
|
if !entry.is_table() {
|
|
*entry = toml::Value::Table(toml::map::Map::new());
|
|
}
|
|
current = entry
|
|
.as_table_mut()
|
|
.ok_or_else(|| IdxError::ConfigError("invalid config path".to_string()))?;
|
|
}
|
|
}
|
|
|
|
fs::write(
|
|
&path,
|
|
toml::to_string_pretty(&root).map_err(|e| IdxError::ConfigError(e.to_string()))?,
|
|
)
|
|
.map_err(|e| IdxError::Io(e.to_string()))
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::IdxConfig;
|
|
|
|
#[test]
|
|
fn default_values_are_sane() {
|
|
let cfg = IdxConfig::default();
|
|
assert_eq!(cfg.provider, super::ProviderKind::Msn);
|
|
assert_eq!(cfg.history_provider, super::HistoryProviderKind::Auto);
|
|
assert_eq!(cfg.exchange, "JK");
|
|
assert_eq!(cfg.quote_ttl, 300);
|
|
}
|
|
|
|
#[test]
|
|
fn parses_provider_values() {
|
|
assert_eq!(
|
|
super::ProviderKind::parse("yahoo").expect("yahoo provider"),
|
|
super::ProviderKind::Yahoo
|
|
);
|
|
assert_eq!(
|
|
super::ProviderKind::parse("MSN").expect("msn provider"),
|
|
super::ProviderKind::Msn
|
|
);
|
|
assert!(super::ProviderKind::parse("unknown").is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn parses_history_provider_values() {
|
|
assert_eq!(
|
|
super::HistoryProviderKind::parse("auto").expect("auto history provider"),
|
|
super::HistoryProviderKind::Auto
|
|
);
|
|
assert_eq!(
|
|
super::HistoryProviderKind::parse("yahoo").expect("yahoo history provider"),
|
|
super::HistoryProviderKind::Yahoo
|
|
);
|
|
assert_eq!(
|
|
super::HistoryProviderKind::parse("MSN").expect("msn history provider"),
|
|
super::HistoryProviderKind::Msn
|
|
);
|
|
assert!(super::HistoryProviderKind::parse("unknown").is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_rejects_unknown_keys() {
|
|
let result = super::validate_config_key_value("unknown.key", "value");
|
|
assert!(result.is_err());
|
|
let err = result.unwrap_err();
|
|
assert!(matches!(err, super::IdxError::InvalidInput(_)));
|
|
assert!(err.to_string().contains("unknown config key"));
|
|
}
|
|
|
|
#[test]
|
|
fn validate_rejects_invalid_provider() {
|
|
let result = super::validate_config_key_value("general.provider", "bogus");
|
|
assert!(result.is_err());
|
|
assert!(result.unwrap_err().to_string().contains("invalid provider"));
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_provider_yahoo() {
|
|
assert!(super::validate_config_key_value("general.provider", "yahoo").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_provider_msn() {
|
|
assert!(super::validate_config_key_value("general.provider", "msn").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_provider_case_insensitive() {
|
|
assert!(super::validate_config_key_value("general.provider", "YAHOO").is_ok());
|
|
assert!(super::validate_config_key_value("general.provider", "Msn").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn normalize_provider_lowercases_value() {
|
|
assert_eq!(
|
|
super::normalize_config_value("general.provider", "Msn").unwrap(),
|
|
toml::Value::String("msn".to_string())
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn validate_rejects_invalid_history_provider() {
|
|
let result = super::validate_config_key_value("general.history_provider", "bogus");
|
|
assert!(result.is_err());
|
|
assert!(
|
|
result
|
|
.unwrap_err()
|
|
.to_string()
|
|
.contains("invalid history provider")
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_history_provider_auto() {
|
|
assert!(super::validate_config_key_value("general.history_provider", "auto").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_history_provider_yahoo() {
|
|
assert!(super::validate_config_key_value("general.history_provider", "yahoo").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_history_provider_msn() {
|
|
assert!(super::validate_config_key_value("general.history_provider", "msn").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn normalize_history_provider_lowercases_value() {
|
|
assert_eq!(
|
|
super::normalize_config_value("general.history_provider", "Auto").unwrap(),
|
|
toml::Value::String("auto".to_string())
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn validate_rejects_invalid_output() {
|
|
let result = super::validate_config_key_value("general.output", "bogus");
|
|
assert!(result.is_err());
|
|
assert!(
|
|
result
|
|
.unwrap_err()
|
|
.to_string()
|
|
.contains("invalid output format")
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_output_table() {
|
|
assert!(super::validate_config_key_value("general.output", "table").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_output_json() {
|
|
assert!(super::validate_config_key_value("general.output", "json").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_output_case_insensitive() {
|
|
assert!(super::validate_config_key_value("general.output", "TABLE").is_ok());
|
|
assert!(super::validate_config_key_value("general.output", "Json").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn normalize_output_lowercases_value() {
|
|
assert_eq!(
|
|
super::normalize_config_value("general.output", "Json").unwrap(),
|
|
toml::Value::String("json".to_string())
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn validate_rejects_negative_ttl() {
|
|
let result = super::validate_config_key_value("cache.quote_ttl", "-1");
|
|
assert!(result.is_err());
|
|
assert!(
|
|
result
|
|
.unwrap_err()
|
|
.to_string()
|
|
.contains("must be non-negative")
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn validate_rejects_non_numeric_ttl() {
|
|
let result = super::validate_config_key_value("cache.quote_ttl", "not-a-number");
|
|
assert!(result.is_err());
|
|
assert!(
|
|
result
|
|
.unwrap_err()
|
|
.to_string()
|
|
.contains("must be a non-negative integer")
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_ttl() {
|
|
assert!(super::validate_config_key_value("cache.quote_ttl", "300").is_ok());
|
|
assert!(super::validate_config_key_value("cache.fundamental_ttl", "3600").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_zero_ttl() {
|
|
assert!(super::validate_config_key_value("cache.quote_ttl", "0").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_exchange_any_value() {
|
|
assert!(super::validate_config_key_value("general.exchange", "JK").is_ok());
|
|
assert!(super::validate_config_key_value("general.exchange", "US").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_ownership_db_path() {
|
|
assert!(super::validate_config_key_value("ownership.db_path", "/tmp/ownership.db").is_ok());
|
|
assert!(super::validate_config_key_value("ownership.db_path", "data/ownership.db").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn validate_accepts_valid_color() {
|
|
assert!(super::validate_config_key_value("general.color", "true").is_ok());
|
|
assert!(super::validate_config_key_value("general.color", "false").is_ok());
|
|
assert!(super::validate_config_key_value("general.color", "TRUE").is_ok());
|
|
assert!(super::validate_config_key_value("general.color", "False").is_ok());
|
|
}
|
|
|
|
#[test]
|
|
fn normalize_color_writes_boolean() {
|
|
assert_eq!(
|
|
super::normalize_config_value("general.color", "True").unwrap(),
|
|
toml::Value::Boolean(true)
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn validate_rejects_invalid_color() {
|
|
let result = super::validate_config_key_value("general.color", "foo");
|
|
assert!(result.is_err());
|
|
assert!(
|
|
result
|
|
.unwrap_err()
|
|
.to_string()
|
|
.contains("invalid color value")
|
|
);
|
|
|
|
let result = super::validate_config_key_value("general.color", "123");
|
|
assert!(result.is_err());
|
|
}
|
|
}
|