feat: Add PHP version module (starship#244)

.github/workflows/workflow.yml

@@ -124,6 +124,11 @@ jobs:
         with:
           dotnet-version: "2.2.402"
 
+      # Install PHP at a fixed version
+      - uses: shivammathur/setup-php@master
+        with:
+          php-version: '7.3.8'
+
       # Install Mercurial (pre-installed on linux, installed from pip on macos
       # and from choco on windows),
       - name: Install Mercurial (macos)

README.md

@@ -88,6 +88,7 @@ The prompt shows information you need while you're working, while staying sleek
 - Current Rust version (`🦀`)
 - Current Ruby version (`💎`)
 - Current Python version (`🐍`)
+- Current PHP version (`🐘`)
 - Current Go version (`🐹`)
 - Nix-shell environment detection
 - Print an environment variable

docs/config/README.md

@@ -841,6 +841,31 @@ and `poetry` packages.
 symbol = "🎁 "
 ```
 
+## PHP
+
+The `php` module shows the currently installed version of PHP.
+The module will be shown if any of the following conditions are met:
+
+- The current directory contains a `composer.json` file
+- The current directory contains a `.php` file
+
+### Options
+
+| Variable   | Default      | Description                                            |
+| ---------- | ------------ | ------------------------------------------------------ |
+| `symbol`   | `"🐘 "`      | The symbol used before displaying the version of PHP.  |
+| `style`    | `"bold red"` | The style for the module.                              |
+| `disabled` | `false`      | Disables the `php` module.                             |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[php]
+symbol = "🔹 "
+```
+
 ## Python
 
 The `python` module shows the currently installed version of Python.

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()));
+    }
+}

tests/Dockerfile

@@ -61,6 +61,18 @@ RUN mkdir -p "$DOTNET_HOME" \
 ENV PATH $DOTNET_HOME:$PATH
 RUN dotnet help
 
+# Install PHP
+ENV PHP_VERSION 7.3.8
+ENV PHPENV_ROOT /home/nonroot/.phpenv
+ENV PATH $PHPENV_ROOT/bin:$PHPENV_ROOT/shims:$PATH
+ENV CONFIGURE_OPTS "--without-tidy --disable-zip"
+RUN curl -L https://raw.githubusercontent.com/phpenv/phpenv-installer/master/bin/phpenv-installer | bash \
+  && phpenv install $PHP_VERSION \
+  && phpenv global $PHP_VERSION \
+  && chmod -R a+x $PHPENV_ROOT
+# Check that PHP was correctly installed
+RUN php --version
+
 # Install Mercurial
 RUN HGPYTHON3=1 pip install mercurial
 # Check that Mercurial was correctly installed

tests/testsuite/php.rs

@@ -0,0 +1,56 @@
+use std::fs::File;
+use std::io;
+
+use ansi_term::Color;
+
+use crate::common;
+use crate::common::TestCommand;
+
+#[test]
+fn folder_without_php_files() -> io::Result<()> {
+    let dir = common::new_tempdir()?;
+
+    let output = common::render_module("php")
+        .arg("--path")
+        .arg(dir.path())
+        .output()?;
+    let actual = String::from_utf8(output.stdout).unwrap();
+
+    let expected = "";
+    assert_eq!(expected, actual);
+    Ok(())
+}
+
+#[test]
+#[ignore]
+fn folder_with_composer_file() -> io::Result<()> {
+    let dir = common::new_tempdir()?;
+    File::create(dir.path().join("composer.json"))?;
+
+    let output = common::render_module("php")
+        .arg("--path")
+        .arg(dir.path())
+        .output()?;
+    let actual = String::from_utf8(output.stdout).unwrap();
+
+    let expected = format!("via {} ", Color::Red.bold().paint("🐘 v7.3.8"));
+    assert_eq!(expected, actual);
+    Ok(())
+}
+
+#[test]
+#[ignore]
+fn folder_with_php_file() -> io::Result<()> {
+    let dir = common::new_tempdir()?;
+    File::create(dir.path().join("any.php"))?;
+
+    let output = common::render_module("php")
+        .arg("--path")
+        .arg(dir.path())
+        .output()?;
+    let actual = String::from_utf8(output.stdout).unwrap();
+
+    let expected = format!("via {} ", Color::Red.bold().paint("🐘 v7.3.8"));
+    assert_eq!(expected, actual);
+    Ok(())
+}