Compare commits

...

4 Commits

Author SHA1 Message Date
457f9d71e6 Weather module unit tests passing 2025-07-27 21:39:08 -07:00
1e2851103f Added unit tests for weather module 2025-07-27 14:54:05 -07:00
1834ddac1b Used Claude Sonnet 3.5 agent to add license and documentation to all
files in the project
2025-07-26 13:31:50 -07:00
a8591da49b Better error handling
[With input from AI in VSCode]
2025-07-26 13:14:05 -07:00
11 changed files with 845 additions and 46 deletions

View File

@@ -2,6 +2,7 @@
name = "unibar"
version = "0.1.0"
edition = "2021"
license = "MIT"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -14,3 +15,4 @@ chrono = "0.4.41"
chrono-tz = "0.10.3"
iana-time-zone = "0.1.63"
clap = { version = "4.5.1", features = ["derive"] }
thiserror = "1.0"

View File

@@ -1,3 +1,30 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! CPU usage monitoring module for Unibar
//!
//! This module tracks CPU utilization by sampling /proc/stat and calculating
//! the percentage of time spent in different CPU states. It provides real-time
//! CPU usage information for display in the status bar.
use std::fs::File;
use std::io::{self, BufRead, BufReader};
use std::thread;
@@ -6,6 +33,11 @@ use std::time::Duration;
use crate::common;
use crate::bar_modules;
/// Represents CPU time spent in various states
///
/// This struct holds counters for different CPU states as reported by /proc/stat.
/// Each field represents the amount of time the CPU has spent in that particular state
/// since system boot, measured in USER_HZ units (typically 100Hz).
#[derive(Debug, Default, Clone)]
struct CpuTimes {
user: u64,

View File

@@ -1,7 +1,40 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! Date module for Unibar
//!
//! This module displays the current date in a formatted string.
//! It updates automatically to show the current date with month,
//! day, and year information.
//!
//! # Features
//! - Formatted date display
//! - Automatic daily updates
//! - Calendar icon
use chrono::{DateTime, Local};
use crate::common;
use crate::bar_modules;
/// Date display module showing current calendar date
#[derive(Clone)]
pub struct UnibarModuleDate {
opts: common::AppOptions,

View File

@@ -1,3 +1,35 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! Memory module for Unibar
//!
//! This module monitors system memory usage by reading /proc/meminfo.
//! It calculates and displays current memory utilization as a percentage
//! of total available memory.
//!
//! # Features
//! - Real-time memory usage monitoring
//! - Percentage-based display
//! - Automatic updates at configured intervals
use std::fs::File;
use std::path::Path;
use std::io::prelude::*;
@@ -6,6 +38,7 @@ use regex::Regex;
use crate::common;
use crate::bar_modules;
/// Memory monitor that displays current system memory usage
#[derive(Clone)]
pub struct UnibarModuleMemory {
opts: common::AppOptions,

View File

@@ -1,8 +1,42 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! Music module for Unibar
//!
//! This module displays current music playback information.
//! It shows the currently playing track and playback progress
//! using the system's music player.
//!
//! # Features
//! - Current track information
//! - Playback progress
//! - Playback state (playing/paused)
//! - Music note icon
use std::process::{Stdio, Command};
use crate::common;
use crate::bar_modules;
/// Music playback monitor showing current track and progress
#[derive(Clone)]
pub struct UnibarModuleMusic {
opts: common::AppOptions,

View File

@@ -1,3 +1,36 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! Network module for Unibar
//!
//! This module monitors network interfaces and displays current connection status
//! and IP addresses. It supports both wireless and ethernet interfaces, with
//! different icons for each connection type.
//!
//! # Features
//! - Automatic interface detection
//! - Priority-based interface selection (ethernet over wireless)
//! - IP address display
//! - Connection status monitoring
use serde_json::json;
use serde_json::Value;
use std::process::{Stdio, Command};
@@ -5,6 +38,7 @@ use std::process::{Stdio, Command};
use crate::common;
use crate::bar_modules;
/// Network interface monitor that displays connection status and IP addresses
#[derive(Clone)]
pub struct UnibarModuleNetwork {
opts: common::AppOptions,

View File

@@ -1,10 +1,42 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! Power module for Unibar
//!
//! This module monitors system power status using UPower.
//! It displays battery level and charging status with appropriate icons.
//!
//! # Features
//! - Battery level monitoring
//! - Charging status detection
//! - Different icons for charging/discharging states
//! - Automatic updates
use std::process::{Stdio, Command};
//use std::collections::HashMap;
use regex::Regex;
use crate::common;
use crate::bar_modules;
/// Power monitor that displays battery status and level
#[derive(Clone)]
pub struct UnibarModulePower {
opts: common::AppOptions,

View File

@@ -1,8 +1,42 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! Time module for Unibar
//!
//! This module displays the current time with timezone information.
//! It automatically updates to show the current time in 12-hour format
//! with AM/PM indicator.
//!
//! # Features
//! - 12-hour time format with AM/PM
//! - Timezone display
//! - Automatic updates
//! - Unicode clock icon
use chrono::{DateTime, TimeZone, Local, Utc};
use crate::common;
use crate::bar_modules;
use chrono_tz::{OffsetName, Tz};
/// Time display module showing current time and timezone
#[derive(Clone)]
pub struct UnibarModuleTime {
opts: common::AppOptions,

View File

@@ -1,13 +1,53 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! Weather module for Unibar
//!
//! Fetches weather data from the National Weather Service API and displays
//! current temperature and conditions using Unicode weather symbols.
//!
//! # Features
//! - Temperature display in Celsius or Fahrenheit
//! - Automatic updates at configurable intervals
//! - Weather condition icons using Unicode symbols
//! - Robust error handling for API interactions
use std::str;
use curl::easy::{Easy, List};
use serde_json::json;
use serde_json::Value;
use regex::Regex;
use thiserror::Error;
use std::num::ParseFloatError;
use crate::common;
use crate::common::UpdateResult;
use crate::bar_modules;
/// Number of cycles between weather updates
const UPDATE_INTERVAL: u32 = 300;
/// Base URL for the National Weather Service API
const WEATHER_API_BASE: &str = "https://api.weather.gov";
#[derive(Clone)]
pub struct UnibarModuleWeather {
opts: common::AppOptions,
@@ -15,7 +55,27 @@ pub struct UnibarModuleWeather {
update_cnt: u32,
}
#[derive(Debug, Error)]
pub enum WeatherError {
#[error("Invalid temperature format: {0}")]
ParseError(String),
#[error("API response missing temperature field: {0}")]
ApiResponseStrErr(String),
}
impl From<ParseFloatError> for WeatherError {
fn from(err: ParseFloatError) -> Self {
WeatherError::ParseError(err.to_string())
}
}
impl UnibarModuleWeather {
const FAHRENHEIT_MULTIPLIER: f64 = 9.0 / 5.0;
const FAHRENHEIT_OFFSET: f64 = 32.0;
fn celsius_to_fahrenheit(celsius: f64) -> f64 {
celsius * Self::FAHRENHEIT_MULTIPLIER + Self::FAHRENHEIT_OFFSET
}
// --------------------
pub fn new(o :common::AppOptions) -> Self {
@@ -27,23 +87,27 @@ impl UnibarModuleWeather {
}
// --------------------
fn get_current_temperature(&self) -> f32 {
let deg_c :f32;
match self.weather_info {
serde_json::Value::Null => {
deg_c = 0.0;
}
fn get_current_temperature(&self) -> Result<f64, WeatherError> {
let deg_c = match &self.weather_info {
serde_json::Value::Null => 0.0,
_ => {
deg_c = self.weather_info["features"][0]["properties"]["temperature"]["value"]
.to_string().parse().unwrap();
// Safely navigate the JSON structure
self.weather_info
.get("features")
.and_then(|f| f.get(0))
.and_then(|f| f.get("properties"))
.and_then(|p| p.get("temperature"))
.and_then(|t| t.get("value"))
.and_then(|v| v.as_f64())
.ok_or(WeatherError::ApiResponseStrErr("as_str likely failed".to_string()))?
// .parse()?
}
}
};
match self.opts.weather_units {
common::TemperatureUnits::Metric => return deg_c,
common::TemperatureUnits::Imperial => return (deg_c * 9.0 / 5.0) + 32.0,
}
Ok(match self.opts.weather_units {
common::TemperatureUnits::Metric => deg_c,
common::TemperatureUnits::Imperial => Self::celsius_to_fahrenheit(deg_c),
})
}
// --------------------
@@ -100,7 +164,8 @@ impl UnibarModuleWeather {
let mut url_string = Vec::new();
let mut curl_ret = Vec::new();
url_string.push("https://api.weather.gov/icons".to_owned());
url_string.push(WEATHER_API_BASE.to_owned());
url_string.push("/icons".to_owned());
curl.url(url_string.concat().as_str()).unwrap();
{
@@ -171,7 +236,7 @@ impl bar_modules::BarModuleActions for UnibarModuleWeather {
// Weather update every 60 cycles
fn should_update(&mut self) -> UpdateResult {
if self.update_cnt == 0 {
self.update_cnt = 300;
self.update_cnt = UPDATE_INTERVAL;
return UpdateResult::Update;
} else {
self.update_cnt -= 1;
@@ -192,7 +257,8 @@ impl bar_modules::BarModuleActions for UnibarModuleWeather {
let mut curl_ret = Vec::new();
let mut curl_err = false;
url_string.push("https://api.weather.gov/stations/".to_owned());
url_string.push(WEATHER_API_BASE.to_owned());
url_string.push("/stations/".to_owned());
url_string.push(self.opts.weather_station.to_owned());
url_string.push("/observations?limit=1".to_owned());
@@ -233,8 +299,8 @@ impl bar_modules::BarModuleActions for UnibarModuleWeather {
// --------------------
fn get_content(&self) -> String {
let temperature_value :f32 = self.get_current_temperature();
let temperature_unit :String = self.get_temperature_unit();
let temperature_value :f64 = self.get_current_temperature().expect("Temperature query");
let temperature_unit :String = self.get_temperature_unit();
// let temperature_icon :String = self.get_icon(v.clone());
return format!("{:.0}{}", temperature_value, temperature_unit);
@@ -251,6 +317,9 @@ impl bar_modules::BarModuleActions for UnibarModuleWeather {
// "icon": "https://api.weather.gov/icons/land/night/ovc?size=medium",
let re = Regex::new(r"(\w+)\?size").unwrap();
let json_val = self.weather_info["features"][0]["properties"]["icon"].to_string();
if self.opts.debug {
println!("-----> weather_data - {:#?}", self.weather_info["features"][0]["properties"]);
}
match self.weather_info["features"][0]["properties"]["icon"] {
serde_json::Value::Null => {
return "".to_string();
@@ -274,3 +343,403 @@ impl bar_modules::BarModuleDebug for UnibarModuleWeather {
self.show_icons();
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::bar_modules::BarModuleActions; // Add this line
use crate::common::AppOptions;
use crate::common::TemperatureUnits;
/// Creates a default AppOptions instance for testing
fn create_test_options(metric: bool) -> AppOptions {
AppOptions {
interval: 1,
weather_units: if metric { TemperatureUnits::Metric } else { TemperatureUnits::Imperial },
weather_station: "test_station".to_string(),
music_progress: false,
debug: false,
debug_modules: false,
debug_update: false,
}
}
#[test]
/// Test get_current_temperature returns correct value for metric and imperial units
fn test_get_current_temperature_units() {
let mut metric_module = UnibarModuleWeather::new(create_test_options(true));
let mut imperial_module = UnibarModuleWeather::new(create_test_options(false));
metric_module.weather_info = json!({
"features": [{
"properties": {
"temperature": {
"value": 25.0
}
}
}]
});
imperial_module.weather_info = metric_module.weather_info.clone();
assert_eq!(metric_module.get_current_temperature().unwrap(), 25.0);
assert!((imperial_module.get_current_temperature().unwrap() - 77.0).abs() < 0.01);
}
#[test]
/// Test get_unicode_symbol returns default for unknown condition
fn test_get_unicode_symbol_default() {
let module = UnibarModuleWeather::new(create_test_options(true));
assert_eq!(module.get_unicode_symbol("not_a_real_condition"), "🌤️");
}
#[test]
/// Test clear resets weather_info to Null
fn test_clear_resets_weather_info() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
module.weather_info = json!({"features": []});
module.clear();
assert_eq!(module.weather_info, json!(serde_json::Value::Null));
}
#[test]
/// Test get_content returns formatted temperature string
fn test_get_content_format() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
module.weather_info = json!({
"features": [{
"properties": {
"temperature": {
"value": 18.7
}
}
}]
});
let content = module.get_content();
assert!(content.starts_with("19°C"));
}
#[test]
/// Test get_icon returns fallback when icon is missing
fn test_get_icon_missing_icon() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
module.weather_info = json!({
"features": [{
"properties": {
"icon": serde_json::Value::Null
}
}]
});
assert_eq!(module.get_icon(), "");
}
#[test]
/// Test get_icon returns fallback when weather_info is Null
fn test_get_icon_null_weather_info() {
let module = UnibarModuleWeather::new(create_test_options(true));
assert_eq!(module.get_icon(), "");
}
#[test]
/// Test weather module initialization
fn test_module_initialization() {
let module = UnibarModuleWeather::new(create_test_options(true));
assert_eq!(module.update_cnt, 0);
assert_eq!(module.weather_info, json!(serde_json::Value::Null));
}
#[test]
/// Test temperature unit display
fn test_temperature_unit_display() {
let metric_module = UnibarModuleWeather::new(create_test_options(true));
let imperial_module = UnibarModuleWeather::new(create_test_options(false));
assert_eq!(metric_module.get_temperature_unit(), "°C");
assert_eq!(imperial_module.get_temperature_unit(), "°F");
}
#[test]
/// Test weather condition to Unicode symbol mapping
fn test_unicode_symbol_mapping() {
let module = UnibarModuleWeather::new(create_test_options(true));
assert_eq!(module.get_unicode_symbol("snow"), "❄️");
assert_eq!(module.get_unicode_symbol("ovc"), "☁️");
assert_eq!(module.get_unicode_symbol("rain"), "🌧️");
assert_eq!(module.get_unicode_symbol("unknown"), "🌤️");
}
#[test]
/// Test error handling for invalid temperature data
fn test_error_handling() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
// Test null weather info
assert!(module.get_current_temperature().is_ok());
assert_eq!(module.get_current_temperature().unwrap(), 0.0);
// Test invalid JSON structure
module.weather_info = json!({
"features": [{
"properties": {
"temperature": {
"value": "invalid"
}
}
}]
});
assert!(module.get_current_temperature().is_err());
}
#[test]
/// Test update counter behavior. Update only when update_cnt==0
fn test_update_counter() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
assert_eq!(module.update_cnt, 0);
assert_eq!(module.should_update(), UpdateResult::Update);
module.update_cnt = UPDATE_INTERVAL - 1;
assert_eq!(module.should_update(), UpdateResult::Skip);
module.update_cnt = UPDATE_INTERVAL;
assert_eq!(module.should_update(), UpdateResult::Skip);
}
#[test]
/// Test JSON parsing with valid weather data
fn test_valid_weather_data_parsing() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
// Simulate valid weather data
module.weather_info = json!({
"features": [{
"properties": {
"temperature": {
"value": 20.5
}
}
}]
});
// println!("{:#?}", module.weather_info);
let result = module.get_current_temperature();
// println!("{:#?}", result);
match result {
Ok(20.5) => {
// This is fine - we expect 20.5 for valid weather_info
assert_eq!(module.weather_info["features"][0]["properties"]["temperature"]["value"], 20.5);
},
Err(WeatherError::ApiResponseStrErr(_)) => {
assert!(false, "Expected valid temperature but got ApiResponseStrErr");
},
other => {
panic!("Unexpected result: {:?}", other);
}
}
}
#[test]
/// Test icon extraction from weather API URL
fn test_icon_extraction() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
// Simulate weather data with icon URL
module.weather_info = json!({
"features": [{
"properties": {
"icon": "https://api.weather.gov/icons/land/night/ovc?size=medium"
}
}]
});
let icon = module.get_icon();
// println!("Extracted icon: {}", icon);
// Check if the icon is correctly extracted
assert_eq!(icon, "☁️");
}
#[test]
/// Test handling of malformed/incomplete JSON structures
fn test_missing_json_structure() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
// Test cases with increasingly incomplete JSON structures
let test_cases = vec![
// Missing value field
json!({
"features": [{
"properties": {
"temperature": {}
}
}]
}),
// Missing temperature object
json!({
"features": [{
"properties": {}
}]
}),
// Missing properties
json!({
"features": [{}]
}),
// Empty features array
json!({
"features": []
}),
// Missing features
json!({}),
// Completely different structure
json!({
"unexpected": "structure"
}),
// Empty object
json!({}),
// Null value
json!(null),
// Array instead of object
json!([1, 2, 3]),
// Wrong data types
json!({
"features": [{
"properties": {
"temperature": {
"value": true // boolean instead of number
}
}
}]
}),
];
for (i, test_case) in test_cases.into_iter().enumerate() {
module.weather_info = test_case;
let result = module.get_current_temperature();
match result {
Ok(0.0) => {
// This is fine - we expect 0.0 for null weather_info
assert_eq!(module.weather_info, json!(null),
"Case {}: Should return 0.0 only for null weather_info", i);
},
Err(WeatherError::ApiResponseStrErr(_)) => {
// This is also fine - we expect ApiResponseStrErr for malformed data
},
other => {
panic!("Case {}: Unexpected result: {:?}", i, other);
}
}
}
}
#[test]
/// Test handling of malformed temperature values
fn test_invalid_temperature_values() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
let test_cases = vec![
// Invalid temperature values
json!({
"features": [{
"properties": {
"temperature": {
"value": "not a number"
}
}
}]
}),
json!({
"features": [{
"properties": {
"temperature": {
"value": ""
}
}
}]
}),
json!({
"features": [{
"properties": {
"temperature": {
"value": null
}
}
}]
}),
json!({
"features": [{
"properties": {
"temperature": {
"value": {}
}
}
}]
}),
json!({
"features": [{
"properties": {
"temperature": {
"value": []
}
}
}]
})
];
for (i, test_case) in test_cases.into_iter().enumerate() {
module.weather_info = test_case;
let result = module.get_current_temperature();
assert!(matches!(result, Err(WeatherError::ApiResponseStrErr(_))),
"Case {}: Expected ApiResponseStrErr for invalid temperature value", i);
}
}
#[test]
/// Test that deep nested access is safe
fn test_deep_nested_access() {
let mut module = UnibarModuleWeather::new(create_test_options(true));
// Test accessing nested fields that don't exist
let test_cases = vec![
// Deeper nesting than expected
json!({
"features": [{
"properties": {
"temperature": {
"value": {
"nested": "too deep"
}
}
}
}]
}),
// Missing intermediate fields
json!({
"features": [{
"properties": {
"temperature": {
"missing_value": 20.5
}
}
}]
}),
// Wrong nesting structure
json!({
"features": { // Object instead of array
"properties": {
"temperature": {
"value": 20.5
}
}
}
})
];
for (i, test_case) in test_cases.into_iter().enumerate() {
module.weather_info = test_case;
let result = module.get_current_temperature();
assert!(matches!(result, Err(WeatherError::ApiResponseStrErr(_))),
"Case {}: Expected ApiResponseStrErr for invalid nested structure", i);
}
}
}

View File

@@ -1,36 +1,67 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! Bar modules for the Unibar status bar
//!
//! This module contains implementations of various status bar components that
//! display system information like weather, CPU usage, memory, etc.
//!
//! Each module implements the `BarModuleActions` trait which defines the core
//! functionality required for status bar components.
use crate::common::UpdateResult;
// --------------------
/// All Bar modules must implement the actions
/// Core trait that must be implemented by all bar modules.
///
/// This trait defines the interface that every status bar component must implement
/// to provide its functionality to the Unibar system.
pub trait BarModuleActions {
/// Return String with name of the module
/// Returns the name of the module
fn get_name(&self) -> String;
/// Do necessary clean up before starting new fetch
/// Cleans up any state before refreshing data
fn clear(&mut self);
/// Do necessary processing to generate data for this bar module
/// Fetches and processes new data for the module
fn generate_data(&mut self);
/// Return String content to be displayed in the bar
/// Returns the formatted content to display in the bar
fn get_content(&self) -> String;
/// Return a Unicode icon to display before content in the bar.
/// This icon may differ based on content of the data
/// Returns a Unicode icon representing the module's current state
fn get_icon(&self) -> String;
/// Returns UpdateResult depending on whether the module
/// should be updated during the current update cycle
/// Determines if the module should update its data
/// Default implementation always returns Update
fn should_update(&mut self) -> UpdateResult {
return UpdateResult::Update;
}
}
pub trait BarModuleDebug {
/// Print debug information at the end
/// Prints debug information about the module
fn post_debug(&self);
}
// Module declarations
pub mod bar_module_weather;
pub mod bar_module_music;
pub mod bar_module_network;

View File

@@ -1,23 +1,68 @@
// MIT License
// Copyright (c) 2025 Mahesh @ HeshApps
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//! Unibar - A Versatile Status Bar Information Provider
//!
//! Unibar is a customizable status bar information provider that displays various
//! system metrics and information in a format suitable for integration with
//! status bars like i3bar, polybar, or similar tools.
//!
//! # Features
//! - System monitoring (CPU, memory, network)
//! - Power management (battery status, charging)
//! - Weather information
//! - Date and time display
//! - Music playback information
//! - Configurable update intervals
//! - Support for both metric and imperial units
//!
//! # Usage
//! ```bash
//! unibar --interval 1 --weather-station khio --weather-metric
//! ```
//!
//! The output is formatted as a string that can be directly used
//! by status bar applications.
use std::str;
use std::thread;
use std::time::Duration;
use clap::Parser;
use crate::common::UpdateResult;
// Common utilities/types
/// Common utilities and types used across modules
mod common;
// Bar Modules
/// Status bar component modules
mod bar_modules;
// Commandline parsing
/// Command-line arguments for configuring Unibar behavior
#[derive(Parser, Debug)]
#[command(name = "unibar")]
#[command(version = "1.0")]
#[command(about = "Get string of info for a status bar")]
#[command(about, long_about = "A tool that returns variety of components in a string
suitable to use in a status bar")]
#[command(about = "A versatile status bar information provider")]
#[command(long_about = "Unibar provides system information, weather, and other metrics \
in a format suitable for status bars. It supports various modules including \
system monitoring, weather information, and music playback status.")]
struct CommandlineArgs {
/// Update interval in seconds
/// The frequency at which information is updated, in seconds.
/// Lower values provide more frequent updates but increase system load.
#[arg(short = 'i', long, default_value = "1")]
interval: u64,
@@ -52,14 +97,25 @@ struct CommandlineArgs {
// Application (Unibar)
//
//#[derive(Clone)]
/// Main application structure that manages all status bar modules
/// and coordinates their updates.
struct Unibar {
opts: common::AppOptions,
bar_modules_enabled: Vec<Box<dyn bar_modules::BarModuleActions>>,
debug_modules_done: bool,
/// Application-wide configuration options
opts: common::AppOptions,
/// List of active status bar modules
bar_modules_enabled: Vec<Box<dyn bar_modules::BarModuleActions>>,
/// Flag to track if module debugging has been performed
debug_modules_done: bool,
}
impl Unibar {
// --------------------
/// Starts the main application loop, initializing all modules and
/// updating them at the configured interval.
///
/// This function:
/// 1. Initializes all enabled modules
/// 2. Enters an infinite loop for updates
/// 3. Coordinates module updates based on their individual timing requirements
fn run(&mut self) {
if self.opts.debug {
self.debug_msg("Debugging ...");
@@ -163,9 +219,18 @@ impl Unibar {
}
}
//
// Entry point
//
/// Main entry point for the Unibar application.
///
/// This function:
/// 1. Parses command-line arguments
/// 2. Creates and configures the main application instance
/// 3. Starts the application loop
///
/// # Example
/// ```bash
/// # Run with metric units and 1-second updates
/// unibar --interval 1 --weather-metric
/// ```
fn main() {
let cmd_args = CommandlineArgs::parse();
let mut app = Unibar {