Util to get sometimes-empty config property

The get_property function needs to say that there is no property so that
the caller can respond appropriately. I'm going to need to frequently
respond to the "no such property" path by treating it as *not* an error.

If the config file doesn't specify a property, that's not an error, it's
just not specified and the default should be used instead. This util fn
makes that a bit more ergonomic.

.gitea/workflows/release.yml

@@ -8,6 +8,11 @@ jobs:
     name: Compile and upload a release build
     steps:
       - uses: actions/checkout@v4
+      - name: Get Cargo version
+        run: echo "cargo_version=v$(grep "^version" Cargo.toml | cut -d \" -f2)" >> $GITHUB_ENV
+      - name: Abort if Cargo.toml & Git Tag versions don't match
+        if: ${{ env.cargo_version != github.ref_name }}
+        run: exit 1
       - name: Install Rust Stable
         uses: dtolnay/rust-toolchain@stable
       - name: Build binary crate

Cargo.toml

@@ -1,13 +1,16 @@
 [package]
 name = "gt-tool"
-version = "1.0.0"
+version = "2.2.0"
 edition = "2024"
 
 [dependencies]
 clap = { version = "4.0.7", features = ["derive", "env"] }
+colored = "2.0.0"
+itertools = "0.10.0"
 reqwest = { version = "0.11.13", features = ["json", "stream", "multipart"] }
 serde = { version = "1.0.152", features = ["derive"] }
 tokio = { version = "1.24.2", features = ["macros", "rt-multi-thread"] }
+toml = "0.5"
 
 # Packages available in Debian (Sid)
 # clap = "4.5.23"

README.md

@@ -1,4 +1,4 @@
-# gt-tools
+# gt-tool
 
 CLI tools for interacting with the Gitea API. Use interactively to talk to your Gitea instance, or automatically via a CI/CD pipeline.
 

src/api/release.rs

@@ -1,12 +1,9 @@
-
 use crate::{
     Result,
-    structs::{
-        release::{CreateReleaseOption, Release},
-    },
+    structs::release::{CreateReleaseOption, Release},
 };
 
-pub fn get_release(id: u64) -> Result<Release> {
+pub fn get_release(_id: u64) -> Result<Release> {
     todo!();
 }
 pub fn get_latest_release() -> Result<Release> {
@@ -20,7 +17,7 @@ pub async fn list_releases(
 ) -> Result<Vec<Release>> {
     let request_url = format!("{gitea_url}/api/v1/repos/{repo}/releases/");
     let req = client.get(request_url).send().await;
-    let response = req.map_err(|reqwest_err| crate::Error::WrappedReqwestErr(reqwest_err))?;
+    let response = req.map_err(crate::Error::WrappedReqwestErr)?;
     if response.status().is_success() {
         let release_list = response
             .json::<Vec<Release>>()
@@ -50,22 +47,22 @@ pub async fn create_release(
         .json(&submission)
         .send()
         .await
-        .map_err(|e| crate::Error::from(e))?;
+        .map_err(crate::Error::from)?;
     if response.status().is_success() {
         let new_release = response
             .json::<Release>()
             .await
-            .map_err(|e| crate::Error::from(e))?;
+            .map_err(crate::Error::from)?;
         return Ok(new_release);
     } else if response.status().is_client_error() {
         let mesg = crate::decode_client_error(response).await?;
-        return Err(crate::Error::ApiErrorMessage(mesg))
+        return Err(crate::Error::ApiErrorMessage(mesg));
     }
     panic!("Reached end of create_release without matching a return path");
 }
-pub fn edit_release(id: u64) -> Result<Release> {
+pub fn edit_release(_id: u64) -> Result<Release> {
     todo!();
 }
-pub fn delete_release(id: u64) -> Result<()> {
+pub fn delete_release(_id: u64) -> Result<()> {
     todo!();
 }

src/api/release_attachment.rs

@@ -22,8 +22,10 @@ pub async fn create_release_attachment(
         Ok(false) => return Err(crate::Error::NoSuchFile),
         Err(e) => {
             eprintln!("Uh oh! The file-exists check couldn't be done: {e}");
-            panic!("TODO: Deal with scenario where the file's existence cannot be checked (e.g.: no permission)");
-        },
+            panic!(
+                "TODO: Deal with scenario where the file's existence cannot be checked (e.g.: no permission)"
+            );
+        }
     }
 
     println!("Uploading file {}", &file);
@@ -44,7 +46,7 @@ pub async fn create_release_attachment(
         let attachment_desc = response
             .json::<Attachment>()
             .await
-            .map_err(|e| crate::Error::from(e))?;
+            .map_err(crate::Error::from)?;
         return Ok(attachment_desc);
     } else if response.status().is_client_error() {
         let mesg = crate::decode_client_error(response).await?;

src/config.rs

@@ -0,0 +1,109 @@
+use toml::{Value, value::Table};
+
+pub type Result<T> = core::result::Result<T, Error>;
+
+#[derive(Debug)]
+#[cfg_attr(test, derive(PartialEq))]
+pub enum Error {
+    BadFormat,
+    NoSuchProperty,
+    NoSuchTable,
+    TomlWrap(toml::de::Error),
+}
+
+impl From<toml::de::Error> for Error {
+    fn from(value: toml::de::Error) -> Self {
+        Error::TomlWrap(value)
+    }
+}
+
+impl core::fmt::Display for Error{
+	fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		// FIXME: Print a nice output, don't just reuse the Debug impl
+		write!(fmt, "{self:?}")
+	}
+}
+
+impl std::error::Error for Error {}
+
+/// The outer value must be a Table so we can get the sub-table from it.
+fn get_table<'outer>(outer: &'outer Table, table_name: impl ToString) -> Result<&'outer Table> {
+    Ok(outer
+        .get(&table_name.to_string())
+        .ok_or(Error::NoSuchTable)?
+        .as_table()
+        .ok_or(Error::BadFormat)?)
+}
+
+
+/// Similar to `get_property()` but maps the "Error::NoSuchProperty" result to
+/// Option::None. Some properties aren't specified, and that's okay... sometimes.
+fn get_maybe_property<'outer> (outer: &'outer Table, property: impl ToString) -> Result<Option<&'outer String>> {
+    let maybe_prop = get_property(outer, property);
+    match maybe_prop {
+        Ok(value) => Ok(Some(value)),
+        Err(e) => {
+            if let Error::NoSuchProperty = e {
+                return Ok(None);
+            } else {
+                return Err(e);
+            }
+        }
+    }
+}
+
+/// The config properties are individual strings. This gets the named property,
+/// or an error explaining why it couldn't be fetched.
+fn get_property<'outer>(outer: &'outer Table, property: impl ToString) -> Result<&'outer String> {
+    let maybe_prop = outer.get(&property.to_string()).ok_or(Error::NoSuchProperty)?;
+    if let Value::String(text) = maybe_prop {
+        Ok(text)
+    } else {
+        Err(Error::BadFormat)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use toml::map::Map;
+
+    use super::*;
+
+    #[test]
+    fn read_single_prop() -> Result<()> {
+        let fx_input_str = "owner = \"dingus\"";
+        let fx_value = fx_input_str.parse::<Value>()?;
+        let fx_value = fx_value.as_table().ok_or(Error::NoSuchTable)?;
+        let expected = "dingus";
+
+        let res = get_property(&fx_value, String::from("owner"))?;
+        assert_eq!(res, expected);
+        Ok(())
+    }
+
+    // The property is given the value of empty-string `""`
+    #[test]
+    fn read_single_prop_empty_quotes() -> Result<()> {
+        let fx_input_str = "owner = \"\"";
+        let fx_value = fx_input_str.parse::<Value>()?;
+        let fx_value = fx_value.as_table().ok_or(Error::NoSuchTable)?;
+        let expected = "";
+
+        let res = get_property(&fx_value, String::from("owner"))?;
+        assert_eq!(res, expected);
+        Ok(())
+    }
+
+    #[test]
+    fn read_table() -> Result<()> {
+        let fx_input_str = "[tab]\nwith_a_garbage = \"value\"";
+        let fx_value = fx_input_str.parse::<Value>()?;
+        let fx_value = fx_value.as_table().ok_or(Error::BadFormat)?;
+        let mut expected: Map<String, Value> = Map::new();
+        expected.insert(String::from("with_a_garbage"), Value::String(String::from("value")));
+
+        let res = get_table(&fx_value, String::from("tab"))?;
+        assert_eq!(res, &expected);
+        Ok(())
+    }
+}

src/lib.rs

@@ -2,6 +2,7 @@ use serde::{Deserialize, Serialize};
 
 pub mod api;
 pub mod cli;
+pub mod config;
 pub mod structs;
 
 #[derive(Debug, Deserialize, Serialize)]
@@ -10,13 +11,11 @@ pub struct ApiError {
     url: String,
 }
 
-pub (crate) async fn decode_client_error(response: reqwest::Response) -> Result<ApiError> {
+pub(crate) async fn decode_client_error(response: reqwest::Response) -> Result<ApiError> {
     response
         .json::<ApiError>()
         .await
-        .map_err(|reqwest_err| {
-            crate::Error::WrappedReqwestErr(reqwest_err)
-        })
+        .map_err(crate::Error::WrappedReqwestErr)
 }
 
 #[derive(Debug)]

src/main.rs

@@ -1,4 +1,3 @@
-
 use std::path;
 
 use gt_tool::cli::Args;
@@ -22,10 +21,7 @@ async fn main() -> Result<(), gt_tool::Error> {
         headers.append("Authorization", token.parse().unwrap());
     }
     let client = reqwest::Client::builder()
-        .user_agent(format!(
-            "gt-tools-agent-{}",
-            env!("CARGO_PKG_VERSION")
-        ))
+        .user_agent(format!("gt-tools-agent-{}", env!("CARGO_PKG_VERSION")))
         .default_headers(headers)
         .build()?;
 
@@ -33,9 +29,15 @@ async fn main() -> Result<(), gt_tool::Error> {
         gt_tool::cli::Commands::ListReleases => {
             let releases =
                 gt_tool::api::release::list_releases(&client, &args.gitea_url, &args.repo).await?;
-            for release in releases {
-                println!("{:?}", release);
-            }
+            // Print in reverse order so the newest items are closest to the
+            // user's command prompt. Otherwise the newest item scrolls off the
+            // screen and can't be seen.
+            itertools::Itertools::intersperse(
+                releases.iter().rev().map(|release| release.colorized()),
+                String::from(""),
+            )
+            .map(|release| println!("{}", release))
+            .fold((), |_, _| ());
         }
         gt_tool::cli::Commands::CreateRelease {
             name,
@@ -52,13 +54,8 @@ async fn main() -> Result<(), gt_tool::Error> {
                 tag_name,
                 target_commitish,
             };
-            gt_tool::api::release::create_release(
-                &client,
-                &args.gitea_url,
-                &args.repo,
-                submission,
-            )
-            .await?;
+            gt_tool::api::release::create_release(&client, &args.gitea_url, &args.repo, submission)
+                .await?;
         }
         gt_tool::cli::Commands::UploadRelease {
             tag_name,
@@ -88,8 +85,10 @@ async fn main() -> Result<(), gt_tool::Error> {
                         Ok(false) => return Err(gt_tool::Error::NoSuchFile),
                         Err(e) => {
                             eprintln!("Uh oh! The file-exists check couldn't be done: {e}");
-                            panic!("TODO: Deal with scenario where the file's existence cannot be checked (e.g.: no permission)");
-                        },
+                            panic!(
+                                "TODO: Deal with scenario where the file's existence cannot be checked (e.g.: no permission)"
+                            );
+                        }
                     }
                 }
                 for file in files {
@@ -143,5 +142,5 @@ fn match_release_by_tag(tag: &String, releases: Vec<Release>) -> Option<Release>
             }
         }
     }
-    return release;
+    release
 }

src/structs/release.rs

@@ -1,3 +1,4 @@
+use colored::Colorize;
 use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Deserialize, Serialize)]
@@ -19,6 +20,36 @@ pub struct Release {
     author: Author,
 }
 
+impl Release {
+    pub fn colorized(&self) -> String {
+        let tag = "Tag:".green().bold();
+        let name = "Name:".green();
+        let published = "Published:".bright_green();
+        let created = "Created:".green().dimmed();
+        let author = "Author:".blue();
+        let body = if !self.body.is_empty() {
+            &self.body.white()
+        } else {
+            &String::from("(empty body)").dimmed()
+        };
+
+        format!(
+            "{tag} {}
+{name} {}
+  {}
+{published} {} ({created} {})
+{author} {} ({})",
+            self.tag_name.bold(),
+            self.name,
+            body,
+            self.published_at,
+            self.created_at.dimmed(),
+            self.author.login,
+            self.author.email,
+        )
+    }
+}
+
 #[derive(Debug, Deserialize, Serialize)]
 pub struct Author {
     id: usize,