feat: Add PHP version module (#244)

src/configs/mod.rs

@@ -19,6 +19,7 @@ pub mod memory_usage;
 pub mod nix_shell;
 pub mod nodejs;
 pub mod package;
+pub mod php;
 pub mod python;
 pub mod ruby;
 pub mod rust;

src/configs/php.rs

@@ -0,0 +1,21 @@
+use crate::config::{ModuleConfig, RootModuleConfig, SegmentConfig};
+
+use ansi_term::{Color, Style};
+use starship_module_config_derive::ModuleConfig;
+
+#[derive(Clone, ModuleConfig)]
+pub struct PhpConfig<'a> {
+    pub symbol: SegmentConfig<'a>,
+    pub style: Style,
+    pub disabled: bool,
+}
+
+impl<'a> RootModuleConfig<'a> for PhpConfig<'a> {
+    fn new() -> Self {
+        PhpConfig {
+            symbol: SegmentConfig::new("🐘 "),
+            style: Color::Red.bold(),
+            disabled: false,
+        }
+    }
+}

src/module.rs

@@ -34,6 +34,7 @@ pub const ALL_MODULES: &[&str] = &[
     "python",
     "ruby",
     "rust",
+    "php",
     "time",
     "username",
 ];

src/modules/mod.rs

@@ -20,6 +20,7 @@ mod memory_usage;
 mod nix_shell;
 mod nodejs;
 mod package;
+mod php;
 mod python;
 mod ruby;
 mod rust;
@@ -61,6 +62,7 @@ pub fn handle<'a>(module: &str, context: &'a Context) -> Option<Module<'a>> {
         "nix_shell" => nix_shell::module(context),
         "nodejs" => nodejs::module(context),
         "package" => package::module(context),
+        "php" => php::module(context),
         "python" => python::module(context),
         "ruby" => ruby::module(context),
         "rust" => rust::module(context),

src/modules/php.rs

@@ -0,0 +1,67 @@
+use std::process::Command;
+
+use super::{Context, Module, RootModuleConfig, SegmentConfig};
+
+use crate::configs::php::PhpConfig;
+
+/// Creates a module with the current PHP version
+///
+/// Will display the PHP version if any of the following criteria are met:
+///     - Current directory contains a `.php` file
+///     - Current directory contains a `composer.json` file
+pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
+    let is_php_project = context
+        .try_begin_scan()?
+        .set_files(&["composer.json"])
+        .set_extensions(&["php"])
+        .is_match();
+
+    if !is_php_project {
+        return None;
+    }
+
+    match get_php_version() {
+        Some(php_version) => {
+            let mut module = context.new_module("php");
+            let config: PhpConfig = PhpConfig::try_load(module.config);
+
+            module.set_style(config.style);
+
+            let formatted_version = format_php_version(&php_version)?;
+            module.create_segment("symbol", &config.symbol);
+            module.create_segment("version", &SegmentConfig::new(&formatted_version));
+
+            Some(module)
+        }
+        None => None,
+    }
+}
+
+fn get_php_version() -> Option<String> {
+    match Command::new("php")
+        .arg("-r")
+        .arg("echo PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION.'.'.PHP_RELEASE_VERSION;")
+        .output()
+    {
+        Ok(output) => Some(String::from_utf8(output.stdout).unwrap()),
+        Err(_) => None,
+    }
+}
+
+fn format_php_version(php_version: &str) -> Option<String> {
+    let mut formatted_version = String::with_capacity(php_version.len() + 1);
+    formatted_version.push('v');
+    formatted_version.push_str(php_version);
+    Some(formatted_version)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_format_php_version() {
+        let input = "7.3.8";
+        assert_eq!(format_php_version(input), Some("v7.3.8".to_string()));
+    }
+}