feat: add version info to bottom right of screen

- as this is fast-changing I have added version info to the bottom right of the screen
- If enabled in config, will attempt to fetch tag of latest version on load
- if latest version is not the same as the current version, will indicate that the current version is out of date
- can turn this off in the config, at which point it will just show the latest version

Cargo.toml

@@ -29,6 +29,7 @@ ratatui = { version = "0.27.0", features = [
     "serde",
     "unstable-rendered-line-info",
 ] }
+reqwest = { version = "0.12.5", features = ["json"] }
 serde = "1.0.203"
 serde_yml = "0.0.10"
 tokio = { version = "1.38.0", features = [

README.md

@@ -129,12 +129,15 @@ Ducker is configured via a yaml file found in the relevant config directory for
 
 The following table summarises the available config values:
 
-| Key          | Default                       | Description                                                                                                                 |
-| ------------ | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| prompt       | 🦆                             | The default prompt to display in the command pane                                                                           |
-| default_exec | `/bin/bash`                   | The default prompt to display in the command pane. NB - currently uses this for all exec's; it is planned to offer a choice |
-| docker_path  | `unix:///var/run/docker.sock` | The location of the socket on which the docker daemon is exposed (defaults to `npipe:////./pipe/docker_engine` on windows)  |
-| theme        | [See below]                   | The colour theme configuration                                                                                              |
+| Key              | Default                       | Description                                                                                                                    |
+| ---------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| prompt           | 🦆                             | The default prompt to display in the command pane                                                                              |
+| default_exec     | `/bin/bash`                   | The default prompt to display in the command pane. NB - currently uses this for all exec's; it is planned to offer a choice    |
+| docker_path      | `unix:///var/run/docker.sock` | The location of the socket on which the docker daemon is exposed (defaults to `npipe:////./pipe/docker_engine` on windows)     |
+| check_for_update | `true`                        | When true, checks whether there is a newer version on load.  If a newer version is found, indicates via note in bottom right.* |
+| theme            | [See below]                   | The colour theme configuration                                                                                                 |
+
+> :warning: **This is not available in v0.0.5 and below as released on cargo**: to use this feature, install the unstable build or await next release
 
 If a value is unset or if the config file is unfound, Ducker will use the default values.  If a value is malformed, Ducker will fail to run.
 

src/components/footer.rs

@@ -1,26 +1,39 @@
 use itertools::Itertools;
 use ratatui::{
-    layout::Rect,
+    layout::{Constraint, Layout, Rect},
     style::{Modifier, Style},
     text::{Line, Span},
     Frame,
 };
 
 use crate::{config::Config, traits::Component};
 
+use super::version::VersionComponent;
+
 #[derive(Debug)]
 pub struct Footer {
     config: Box<Config>,
+    version: VersionComponent,
 }
 
 impl Footer {
-    pub fn new(config: Box<Config>) -> Self {
-        Self { config }
+    pub async fn new(config: Box<Config>) -> Self {
+        Self {
+            config: config.clone(),
+            version: VersionComponent::new(config).await,
+        }
     }
 }
 
 impl Component for Footer {
     fn draw(&mut self, f: &mut Frame<'_>, area: Rect) {
+        let layout = Layout::horizontal([
+            Constraint::Length(20),
+            Constraint::Min(0),
+            Constraint::Length(20),
+        ]);
+        let [_left, mid, right] = layout.areas(area);
+
         let keys = [
             ("K/↑", "Up"),
             ("J/↓", "Down"),
@@ -48,6 +61,8 @@ impl Component for Footer {
 
         let footer = Line::from(spans).centered().style(Style::new());
 
-        f.render_widget(footer, area)
+        f.render_widget(footer, mid);
+
+        self.version.draw(f, right)
     }
 }

src/components/mod.rs

@@ -6,3 +6,4 @@ pub mod header;
 pub mod help;
 pub mod resize_notice;
 pub mod text_input_wrapper;
+pub mod version;

src/components/version.rs

@@ -0,0 +1,106 @@
+use crate::{config::Config, traits::Component};
+use color_eyre::eyre::Result;
+use ratatui::{
+    layout::{Margin, Rect},
+    style::Style,
+    text::{Line, Span},
+    Frame,
+};
+use reqwest::header::USER_AGENT;
+
+const VERSION: &str = env!("CARGO_PKG_VERSION");
+const TAGS_URL: &str = "https://api.github.com/repos/robertpsoane/ducker/tags";
+
+#[derive(Debug)]
+pub struct VersionComponent {
+    config: Box<Config>,
+    version: String,
+    update_to: Option<String>,
+}
+
+impl VersionComponent {
+    pub async fn new(config: Box<Config>) -> Self {
+        let version = format!("v{VERSION}");
+
+        let update_to = if config.check_for_update {
+            get_update_to(&version).await
+        } else {
+            None
+        };
+
+        Self {
+            config,
+            version,
+            update_to,
+        }
+    }
+}
+
+impl Component for VersionComponent {
+    fn draw(&mut self, f: &mut Frame<'_>, area: Rect) {
+        let area = area.inner(Margin {
+            vertical: 0,
+            horizontal: 1,
+        });
+
+        let current_version = Span::from(self.version.clone());
+
+        let spans = if let Some(update) = &self.update_to {
+            let update_to_span = Span::from(update);
+            let arrow = Span::from(" > ");
+            vec![
+                current_version.style(Style::default().fg(self.config.theme.negative_highlight())),
+                arrow,
+                update_to_span.style(Style::default().fg(self.config.theme.positive_highlight())),
+            ]
+        } else {
+            vec![current_version.style(Style::default().fg(self.config.theme.positive_highlight()))]
+        };
+
+        f.render_widget(
+            Line::from(spans).alignment(ratatui::layout::Alignment::Right),
+            area,
+        )
+    }
+}
+
+async fn get_update_to(version: &str) -> Option<String> {
+    let latest_version = match find_latest_version().await {
+        Ok(v) => v,
+        Err(_) => return None,
+    };
+    if version == latest_version {
+        None
+    } else {
+        Some(latest_version)
+    }
+}
+
+async fn find_latest_version() -> Result<String> {
+    let client = reqwest::Client::new();
+
+    let body: serde_yml::Value = client
+        .get(TAGS_URL)
+        .header(USER_AGENT, format!("Ducker / {VERSION}"))
+        .send()
+        .await?
+        .json()
+        .await?;
+
+    let release = match body.get(0) {
+        Some(v) => v,
+        None => panic!("could not parse response"),
+    };
+
+    let release_name = match release.get("name") {
+        Some(v) => v,
+        None => panic!("could not parse response"),
+    };
+
+    let release_name_value = match release_name.as_str() {
+        Some(v) => String::from(v),
+        None => panic!("could not parse response"),
+    };
+
+    Ok(release_name_value)
+}

src/config.rs

@@ -19,6 +19,9 @@ pub struct Config {
     #[serde(default = "default_docker_path")]
     pub docker_path: String,
 
+    #[serde(default = "default_check_update")]
+    pub check_for_update: bool,
+
     #[serde(default)]
     pub theme: Theme,
 }
@@ -62,6 +65,10 @@ fn default_docker_path() -> String {
     return "npipe:////./pipe/docker_engine".into();
 }
 
+fn default_check_update() -> bool {
+    return true;
+}
+
 fn default_use_theme() -> bool {
     false
 }
@@ -72,6 +79,7 @@ impl Default for Config {
             prompt: default_prompt(),
             default_exec: default_exec(),
             docker_path: default_docker_path(),
+            check_for_update: default_check_update(),
             theme: Theme::default(),
         }
     }

src/ui/app.rs

@@ -64,7 +64,7 @@ impl App {
             resize_screen: ResizeScreen::new(config.clone()),
             title: Header::new(config.clone()),
             page_manager: body,
-            footer: Footer::new(config.clone()),
+            footer: Footer::new(config.clone()).await,
             input_field: CommandInput::new(tx, config.prompt),
             modal: None,
         };