mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-12-11 21:57:52 +00:00
2d4b183fce
* refactor: replace module_config_derive with serde Changes include: * Removing `starship_module_config_derive` and replacing it with `serde::Deserialize` * Removing `RootModuleConfig::load_config`. While potentially useful, it was only used in tests. And it would require something like `serde::DeserializeSeed` which is not derived by serde. * Merging `RootModuleConfig` into `ModuleConfig` * Implementing a `ValueDeserializer` that holds a reference to a `toml::Value` in `serde_utils.rs` * Deserialization errors (invalid type) are now logged and include the current key and the struct names * Unknown keys are now considered an error. "Did you mean?"-messages are still possible * fix typo Co-authored-by: Matan Kushner <hello@matchai.dev> Co-authored-by: Matan Kushner <hello@matchai.dev>
192 lines
5.8 KiB
Rust
192 lines
5.8 KiB
Rust
use super::{Context, Module, ModuleConfig};
|
|
|
|
use crate::configs::ruby::RubyConfig;
|
|
use crate::formatter::{StringFormatter, VersionFormatter};
|
|
|
|
/// Creates a module with the current Ruby version
|
|
///
|
|
/// Will display the Ruby version if any of the following criteria are met:
|
|
/// - Current directory contains a `.rb` file
|
|
/// - Current directory contains a `Gemfile` or `.ruby-version` file
|
|
/// - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
|
|
pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
|
|
let mut module = context.new_module("ruby");
|
|
let config = RubyConfig::try_load(module.config);
|
|
|
|
let is_rb_project = context
|
|
.try_begin_scan()?
|
|
.set_files(&config.detect_files)
|
|
.set_extensions(&config.detect_extensions)
|
|
.set_folders(&config.detect_folders)
|
|
.is_match();
|
|
|
|
let is_rb_env = &config
|
|
.detect_variables
|
|
.iter()
|
|
.any(|variable| context.get_env(variable).is_some());
|
|
|
|
if !is_rb_project && !is_rb_env {
|
|
return None;
|
|
}
|
|
|
|
let parsed = StringFormatter::new(config.format).and_then(|formatter| {
|
|
formatter
|
|
.map_meta(|var, _| match var {
|
|
"symbol" => Some(config.symbol),
|
|
_ => None,
|
|
})
|
|
.map_style(|variable| match variable {
|
|
"style" => Some(Ok(config.style)),
|
|
_ => None,
|
|
})
|
|
.map(|variable| match variable {
|
|
"version" => format_ruby_version(
|
|
&context.exec_cmd("ruby", &["-v"])?.stdout,
|
|
config.version_format,
|
|
)
|
|
.map(Ok),
|
|
_ => None,
|
|
})
|
|
.parse(None, Some(context))
|
|
});
|
|
|
|
module.set_segments(match parsed {
|
|
Ok(segments) => segments,
|
|
Err(error) => {
|
|
log::warn!("Error in module `ruby`:\n{}", error);
|
|
return None;
|
|
}
|
|
});
|
|
|
|
Some(module)
|
|
}
|
|
|
|
fn format_ruby_version(ruby_version: &str, version_format: &str) -> Option<String> {
|
|
let version = ruby_version
|
|
// split into ["ruby", "2.6.0p0", "linux/amd64"]
|
|
.split_whitespace()
|
|
// return "2.6.0p0"
|
|
.nth(1)?
|
|
// split into ["2.6.0", "0"]
|
|
.split('p')
|
|
// return "2.6.0"
|
|
.next()?;
|
|
|
|
match VersionFormatter::format_version(version, version_format) {
|
|
Ok(formatted) => Some(formatted),
|
|
Err(error) => {
|
|
log::warn!("Error formatting `ruby` version:\n{}", error);
|
|
Some(format!("v{}", version))
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use crate::test::ModuleRenderer;
|
|
use ansi_term::Color;
|
|
use std::fs::File;
|
|
use std::io;
|
|
|
|
#[test]
|
|
fn folder_without_ruby_files() -> io::Result<()> {
|
|
let dir = tempfile::tempdir()?;
|
|
|
|
let actual = ModuleRenderer::new("ruby").path(dir.path()).collect();
|
|
|
|
let expected = None;
|
|
assert_eq!(expected, actual);
|
|
dir.close()
|
|
}
|
|
|
|
#[test]
|
|
fn folder_with_gemfile() -> io::Result<()> {
|
|
let dir = tempfile::tempdir()?;
|
|
File::create(dir.path().join("Gemfile"))?.sync_all()?;
|
|
|
|
let actual = ModuleRenderer::new("ruby").path(dir.path()).collect();
|
|
|
|
let expected = Some(format!("via {}", Color::Red.bold().paint("💎 v2.5.1 ")));
|
|
assert_eq!(expected, actual);
|
|
dir.close()
|
|
}
|
|
|
|
#[test]
|
|
fn folder_with_ruby_version() -> io::Result<()> {
|
|
let dir = tempfile::tempdir()?;
|
|
File::create(dir.path().join(".ruby-version"))?.sync_all()?;
|
|
|
|
let actual = ModuleRenderer::new("ruby").path(dir.path()).collect();
|
|
|
|
let expected = Some(format!("via {}", Color::Red.bold().paint("💎 v2.5.1 ")));
|
|
assert_eq!(expected, actual);
|
|
dir.close()
|
|
}
|
|
|
|
#[test]
|
|
fn folder_with_rb_file() -> io::Result<()> {
|
|
let dir = tempfile::tempdir()?;
|
|
File::create(dir.path().join("any.rb"))?.sync_all()?;
|
|
|
|
let actual = ModuleRenderer::new("ruby").path(dir.path()).collect();
|
|
|
|
let expected = Some(format!("via {}", Color::Red.bold().paint("💎 v2.5.1 ")));
|
|
assert_eq!(expected, actual);
|
|
dir.close()
|
|
}
|
|
|
|
#[test]
|
|
fn with_ruby_version_env() -> io::Result<()> {
|
|
let dir = tempfile::tempdir()?;
|
|
let actual = ModuleRenderer::new("ruby")
|
|
.path(dir.path())
|
|
.env("RUBY_VERSION", "2.5.1")
|
|
.collect();
|
|
|
|
let expected = Some(format!("via {}", Color::Red.bold().paint("💎 v2.5.1 ")));
|
|
assert_eq!(expected, actual);
|
|
dir.close()
|
|
}
|
|
|
|
#[test]
|
|
fn with_rbenv_version_env() -> io::Result<()> {
|
|
let dir = tempfile::tempdir()?;
|
|
let actual = ModuleRenderer::new("ruby")
|
|
.path(dir.path())
|
|
.env("RBENV_VERSION", "2.6.8")
|
|
.collect();
|
|
|
|
// rbenv variable is only detected; its value is not used
|
|
let expected = Some(format!("via {}", Color::Red.bold().paint("💎 v2.5.1 ")));
|
|
assert_eq!(expected, actual);
|
|
dir.close()
|
|
}
|
|
|
|
#[test]
|
|
fn test_format_ruby_version() {
|
|
let config = RubyConfig::default();
|
|
assert_eq!(
|
|
format_ruby_version(
|
|
"ruby 2.1.10p492 (2016-04-01 revision 54464) [x86_64-darwin19.0]",
|
|
config.version_format
|
|
),
|
|
Some("v2.1.10".to_string())
|
|
);
|
|
assert_eq!(
|
|
format_ruby_version(
|
|
"ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux-gnu]",
|
|
config.version_format
|
|
),
|
|
Some("v2.5.1".to_string())
|
|
);
|
|
assert_eq!(
|
|
format_ruby_version(
|
|
"ruby 2.7.0p0 (2019-12-25 revision 647ee6f091) [x86_64-linux-musl]",
|
|
config.version_format
|
|
),
|
|
Some("v2.7.0".to_string())
|
|
);
|
|
}
|
|
}
|