PlexSheep
/
crock
generated from PlexSheep/rs-base
1
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases 9 Wiki Activity

Merge branch 'devel'
cargo devel CI / cargo CI (push) Successful in 1m41s Details

This commit is contained in:
Christoph J. Scherr 2024-07-12 19:05:53 +02:00
parent c5df9cce34 e6fc387419
commit 98af379193
8 changed files with 551 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitea/workflows/cargo.yaml
View File

@ -21,6 +21,10 @@ jobs:
run: |
rustup component add rustfmt
rustup component add clippy
- name: install additional system dependencies
run: |
apt update
apt install libdbus-1-dev libasound2-dev -y
- name: config custom registry
run: |
mkdir -p ~/.cargo/

45
.github/workflows/cargo.yaml vendored
View File

@ -1,45 +0,0 @@
name: cargo devel CI
on:
push:
branches:
- '**'
# - '!master'
jobs:
CI:
runs-on: ubuntu-latest
name: cargo CI
permissions:
# Give the default GITHUB_TOKEN write permission to commit and push the
# added or changed files to the repository.
contents: write
steps:
- name: get repo
uses: actions/checkout@v4
- name: install rust
uses: dtolnay/rust-toolchain@stable
- name: install additional rust things
run: |
rustup component add rustfmt
rustup component add clippy
- name: config custom registry
run: |
mkdir -p ~/.cargo/
echo "" > ~/.cargo/config.toml
echo "[registry]" >> ~/.cargo/config.toml
echo 'cscherr = "cscherr"' >> ~/.cargo/config.toml
echo '[registries.cscherr]' >> ~/.cargo/config.toml
echo 'index = "https://git.cscherr.de/PlexSheep/_cargo-index.git"' >> ~/.cargo/config.toml
cat ~/.cargo/config.toml
- name: cargo clippy check
run: cargo clippy --all-features --all-targets --workspace
- name: cargo clippy fix
run: cargo clippy --fix --all-features --all-targets --workspace
- name: cargo fmt
run: cargo fmt --all
- name: commit back to repository
uses: stefanzweifel/git-auto-commit-action@v5
with:
# Optional. Commit message for the created commit.
# Defaults to "Apply automatic changes"
commit_message: automatic cargo CI changes

14
Cargo.toml
View File

@ -1,6 +1,6 @@
[package]
name = "crock"
version = "0.1.4"
version = "0.2.0"
edition = "2021"
publish = true
authors = ["Christoph J. Scherr <software@cscherr.de>"]
@ -12,10 +12,22 @@ repository = "https://git.cscherr.de/PlexSheep/crock"
keywords = ["time", "clock", "tui"]
categories = ["date-and-time"]
[features]
default = ["desktop", "sound"]
desktop = ["dep:notify-rust"]
sound = ["dep:rodio"]
[dependencies]
anyhow = "1.0.86"
chrono = "0.4.38"
humantime = "2.1.0"
libpt = { version = "0.6.0", features = ["cli"] }
notify-rust = { version = "4.11.0", default-features = false, features = [
"d",
], optional = true }
ratatui = "0.27.0"
rodio = { version = "0.19.0", optional = true, default-features = false, features = [
"mp3",
] }
tui-big-text = "0.4.5"

19
README.md
View File

@ -4,7 +4,6 @@
![Crates.io License](https://img.shields.io/crates/l/crock)
![Gitea Release](https://img.shields.io/gitea/v/release/PlexSheep/crock?gitea_url=https%3A%2F%2Fgit.cscherr.de)
![Gitea language count](https://img.shields.io/gitea/languages/count/PlexSheep/crock?gitea_url=https%3A%2F%2Fgit.cscherr.de)
[![cargo checks and tests](https://github.com/PlexSheep/crock/actions/workflows/cargo.yaml/badge.svg)](https://github.com/PlexSheep/crock/actions/workflows/cargo.yaml)
A little clock for your terminal, written in rust.
@ -13,3 +12,21 @@ A little clock for your terminal, written in rust.
* [Original Repository](https://git.cscherr.de/PlexSheep/crock)
* [GitHub Mirror](https://github.com/PlexSheep/crock)
* [crates.io](https://crates.io/crates/crock)
## Compilation
The `desktop` and `sound` features require additional system dependencies:
| Feature | Dependency | PKG Name on Debian based Distributions |
|-----------|------------|----------------------------------------|
| `desktop` | dbus | `libdbus-1-dev` |
| `sound` | alsa | `libasound2-dev` |
If you want to compile without these features, you will not have notifications
and sound alerts for countdown mode. (Use `cargo build -r --no-default-features`)
## Acknoledgements
The included alarm sound is from [freesound.org](https://freesound.org):
-> ["effect_notify.wav" by ricemaster (CC-0)](https://freesound.org/people/ricemaster/sounds/278142/)

BIN
data/media/278142__ricemaster__effect_notify.wav Executable file
View File

Binary file not shown.

BIN
data/media/alarm.mp3 Executable file
View File

Binary file not shown.

507
src/clock.rs
View File

@ -1,31 +1,269 @@
#![warn(clippy::pedantic, clippy::style, clippy::nursery)]
#![allow(clippy::question_mark_used)]
use clap::Parser;
use libpt::cli::{args::VerbosityLevel, args::HELP_TEMPLATE, clap};
use chrono::SubsecRound;
use chrono::{DateTime, Local, SubsecRound, Timelike};
use clap::Parser;
use libpt::cli::args::HELP_TEMPLATE;
use libpt::cli::clap::ArgGroup;
use libpt::cli::{args::VerbosityLevel, clap};
use libpt::log::{debug, error, trace};
use ratatui::backend::CrosstermBackend;
use ratatui::crossterm::event::{self, poll, Event, KeyCode, KeyModifiers};
use ratatui::layout::{Alignment, Constraint, Direction, Layout, Rect};
use ratatui::style::{Style, Stylize};
use ratatui::widgets::{Block, Padding, Paragraph};
use ratatui::widgets::{Block, LineGauge, Padding, Paragraph};
use ratatui::Terminal;
use std::io::Stdout;
use std::time::Duration;
use std::io::{Cursor, Stdout, Write};
use std::time::{Duration, Instant};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TimeBarLength {
Minute,
Hour,
Custom(i128),
/// implementing a bar that would grow smaller would be weird, so it's a count up instead of
/// a countdown
Countup(i128),
Day,
}
impl TimeBarLength {
pub(crate) const fn as_secs(self) -> i128 {
match self {
Self::Minute => 60,
Self::Day => 24 * 60 * 60,
Self::Hour => 60 * 60,
Self::Custom(secs) | Self::Countup(secs) => secs,
}
}
}
impl Default for TimeBarLength {
fn default() -> Self {
Self::Minute
}
}
/// Make your terminal into a big clock
#[derive(Parser, Debug, Clone, PartialEq, Eq, Hash)]
#[command(help_template = HELP_TEMPLATE)]
#[derive(Parser, Debug, Clone)]
#[command(help_template = HELP_TEMPLATE, author, version)]
#[clap(group( ArgGroup::new("timebarlen") .args(&["minute","day", "hour", "custom", "countdown"]),))]
#[allow(clippy::struct_excessive_bools)] // the struct is for cli parsing and we already use an
// ArgGroup
pub struct Clock {
#[command(flatten)]
pub verbose: VerbosityLevel,
/// Show time since start
#[clap(short, long)]
pub timer: bool,
// timebar options
/// show a time bar that tracks progress of the minute
#[clap(short, long)]
pub minute: bool,
/// show a time bar that tracks progress of the day
#[clap(short, long)]
pub day: bool,
/// show a time bar that tracks progress of the hour
#[clap(short = 'o', long)]
pub hour: bool,
/// show a time bar that tracks progress of a custom duration
///
/// Precision: only to seconds
#[clap(short, long, value_parser = humantime::parse_duration)]
pub custom: Option<std::time::Duration>,
/// show a time bar that tracks progress of a custom duration without resetting
///
/// Precision: only to seconds
#[clap(short = 'u', long, value_parser = humantime::parse_duration)]
pub countdown: Option<std::time::Duration>,
/// Play a notification sound when the countdown is up
pub sound: bool,
// internal variables
#[clap(skip)]
pub(crate) last_reset: Option<DateTime<Local>>,
#[clap(skip)]
pub(crate) did_notify: bool,
}
#[derive(Debug, Clone, PartialEq, Default)]
pub struct UiData {
fdate: [String; 2],
ftime: [String; 2],
timebar_ratio: [Option<f64>; 2],
data_idx: usize,
}
impl UiData {
pub fn update(&mut self, fdate: String, ftime: String, timebar_ratio: Option<f64>) {
self.data_idx ^= 1;
self.fdate[self.data_idx] = fdate;
self.ftime[self.data_idx] = ftime;
self.timebar_ratio[self.data_idx] = timebar_ratio;
#[cfg(debug_assertions)]
if self.changed() {
trace!("update with change: {:#?}", self);
}
}
/// did the data change with the last update?
#[must_use]
#[inline]
pub fn changed(&self) -> bool {
// the timebar ratio is discarded, so that we only render the ui when the time
// (second) changes
self.fdate[0] != self.fdate[1] || self.ftime[0] != self.ftime[1]
}
#[must_use]
#[inline]
pub fn fdate(&self) -> &str {
&self.fdate[self.data_idx]
}
#[must_use]
#[inline]
pub fn ftime(&self) -> &str {
&self.ftime[self.data_idx]
}
#[must_use]
#[inline]
#[allow(clippy::missing_const_for_fn)] // no it's not const
pub fn timebar_ratio(&self) -> Option<f64> {
self.timebar_ratio[self.data_idx]
}
}
impl Clock {
#[must_use]
#[allow(clippy::missing_const_for_fn)]
fn timebar_len(&self) -> Option<TimeBarLength> {
if self.minute {
Some(TimeBarLength::Minute)
} else if self.day {
Some(TimeBarLength::Day)
} else if self.hour {
Some(TimeBarLength::Hour)
} else if self.countdown.is_some() {
Some(TimeBarLength::Countup(i128::from(
self.countdown.unwrap().as_secs(),
)))
} else if self.custom.is_some() {
Some(TimeBarLength::Custom(i128::from(
self.custom.unwrap().as_secs(),
)))
} else {
None
}
}
#[allow(clippy::cast_precision_loss)] // okay, good to know, but I accept the loss. It
// shouldn't come to more than 2^52 seconds anyway
pub(crate) fn timebar_ratio(&self, current_time: DateTime<Local>) -> Option<f64> {
let len = self.timebar_len()?;
let since = current_time
.signed_duration_since(self.last_reset.unwrap())
.num_seconds() as f64;
#[cfg(debug_assertions)]
if since < 1.0 {
trace!("ratio calculation since is now <1: {:#?}", since);
}
Some((since / len.as_secs() as f64).clamp(0.0, 1.0))
}
pub(crate) fn maybe_reset_since_zero(&mut self) {
if let Some(len) = self.timebar_len() {
let since_last_reset = Local::now().signed_duration_since(self.last_reset.unwrap());
match len {
TimeBarLength::Countup(_) => {
// the count up should not reset. If the time is over, just keep it at 100%
}
TimeBarLength::Custom(_) => {
if since_last_reset.num_seconds() >= 1
&& i128::from(since_last_reset.num_seconds()) >= len.as_secs()
{
self.last_reset = Some(Local::now());
}
}
TimeBarLength::Minute => {
if since_last_reset.num_seconds() >= 1 && Local::now().second() == 0 {
self.last_reset = Some(Local::now());
debug!("reset the time of the time bar (minute)");
}
}
TimeBarLength::Hour => {
if since_last_reset.num_minutes() >= 1 && Local::now().minute() == 0 {
self.last_reset = Some(Local::now());
debug!("reset the time of the time bar (hour)");
}
}
TimeBarLength::Day => {
if since_last_reset.num_hours() >= 1 && Local::now().hour() == 0 {
self.last_reset = Some(Local::now());
debug!("reset the time of the time bar (day)");
}
}
}
}
}
fn setup_last_reset(&mut self) {
if let Some(len) = self.timebar_len() {
trace!("Local Time: {}", Local::now());
match len {
TimeBarLength::Custom(_) | TimeBarLength::Countup(_) => {
self.last_reset = Some(Local::now());
}
TimeBarLength::Minute => {
self.last_reset = Some(
Local::now()
.with_second(0)
.expect("tried to use a time that does not exist"),
);
}
TimeBarLength::Hour => {
self.last_reset = Some(
Local::now()
.with_minute(0)
.expect("tried to use a time that does not exist"),
);
}
TimeBarLength::Day => {
self.last_reset = Some(
Local::now()
.with_hour(0)
.expect("tried to use a time that does not exist"),
);
}
}
debug!("set up initial last reset as {:#?}", self.last_reset);
}
}
#[allow(clippy::unnecessary_wraps)] // we have that to be future proof
pub(crate) fn setup(&mut self) -> anyhow::Result<()> {
self.setup_last_reset();
Ok(())
}
/// Run the clock TUI
///
/// # Errors
///
/// * The [setup](Self::setup) fails
/// * Drawing the [ui](Self::ui) fails
/// * Polling or reading an event fails
pub(crate) fn run(
self,
mut self,
terminal: &mut Terminal<CrosstermBackend<Stdout>>,
) -> anyhow::Result<()> {
let tick_rate = Duration::from_millis(100);
let mut last_tick = Instant::now();
let mut uidata: UiData = UiData::default();
self.setup()?;
loop {
let raw_time = chrono::Local::now().round_subsecs(0);
let splits: Vec<String> = raw_time
@ -34,62 +272,231 @@ impl Clock {
.split_whitespace()
.map(str::to_string)
.collect();
let fdate: String = splits[0].clone();
let ftime: String = splits[1].clone();
terminal.draw(|frame| {
let root = frame.size();
let space = Block::bordered()
.padding(Padding::new(
root.width / 8,
root.width / 8,
root.height / 8,
root.height / 8,
))
.title(env!("CARGO_PKG_NAME"))
.title_bottom(env!("CARGO_PKG_VERSION"))
.title_alignment(Alignment::Center)
.title_style(Style::new().bold());
let a = space.inner(root);
let parts = Self::partition(a);
let timew = tui_big_text::BigText::builder()
.style(Style::new().red())
.lines(vec![ftime.into()])
.alignment(Alignment::Center)
.build()
.expect("could not render time widget");
let datew = Paragraph::new(fdate)
.blue()
.alignment(Alignment::Left)
.block(Block::new().padding(Padding::new(
parts.0.left(),
parts.0.right() / 3,
0,
0,
)));
frame.render_widget(space, root);
frame.render_widget(timew, parts.1);
frame.render_widget(datew, parts.0);
})?;
if poll(Duration::from_millis(100))? {
// We somehow fill timebar_ratio with a bad value here if we don't add 1 second. It's
// always the value that would be right for now-1s. The start of the minute is
// special, with this strategy it is 100%. #10
//
// If we manually add a second, it works as expected, but it feels weird. We use the
// same time for all of the datapoints here, so it can't be because of time diff in
// calculation. I noticed that we don't start at 0% this way (with len=minute)
// . Normally, chrono does not include 60 seconds, only letting it range between 0 and
// 59. This makes sense but feels weird to the human understanding, of course there are
// seconds in a minute! If we do it this way, we don't quite start at 0%, but 100%,
// which feels correct.
//
// In short: if we add a second here, we get the correct percentages. 01:00 is 100%,
// 01:30 is 50%, 01:59 is 98%, 01:60 does not exist because that's how counting from
// 0 works.
uidata.update(
splits[0].clone(),
splits[1].clone(),
self.timebar_ratio(raw_time + chrono::Duration::seconds(1)),
);
if uidata.changed() {
self.ui(terminal, &uidata)?;
}
let timeout = tick_rate.saturating_sub(last_tick.elapsed());
if poll(timeout)? {
if let Event::Key(key) = event::read()? {
if key.code == KeyCode::Char('q')
|| key.code == KeyCode::Esc
|| (key.modifiers.contains(KeyModifiers::CONTROL)
&& key.code == KeyCode::Char('c'))
{
break;
return Ok(());
}
}
}
if last_tick.elapsed() >= tick_rate {
self.on_tick();
last_tick = Instant::now();
}
}
}
fn on_tick(&mut self) {
self.maybe_reset_since_zero();
}
fn ui(
&mut self,
terminal: &mut Terminal<CrosstermBackend<Stdout>>,
data: &UiData,
) -> anyhow::Result<()> {
terminal.draw(|frame| {
debug!("rendering the ui");
let root = frame.size();
let space = Block::bordered()
.padding(Padding::new(
root.width / 16,
root.width / 16,
root.height / 16,
root.height / 16,
))
.title(env!("CARGO_PKG_NAME"))
.title_bottom(env!("CARGO_PKG_VERSION"))
.title_alignment(Alignment::Center)
.title_style(Style::new().bold());
let a = space.inner(root);
frame.render_widget(space, root);
let parts = Self::partition(a);
let mut clockw = tui_big_text::BigText::builder();
if a.width > 80 {
clockw.pixel_size(tui_big_text::PixelSize::Full);
} else {
clockw.pixel_size(tui_big_text::PixelSize::Quadrant);
}
let clockw = clockw
.style(Style::new().red())
.lines(vec![data.ftime().into()])
.alignment(Alignment::Center)
.build()
.expect("could not render time widget");
// render the timebar which counts up to the full minute and so on
//
// Will not be rendered if it is None
let timebarw: Option<LineGauge> = if self.timebar_len().is_some() {
debug!("time bar ration: {:?}", data.timebar_ratio());
let ratio = data.timebar_ratio().unwrap();
if !self.did_notify && (ratio - 1.0).abs() < 0.000_001 {
if let Some(TimeBarLength::Countup(_)) = self.timebar_len() {
let _ = self.notify().inspect_err(|e| {
error!("could not notify: {e}");
debug!("complete error: {e:#?}");
});
self.did_notify = true;
}
}
let timebarw = LineGauge::default()
.filled_style(if self.did_notify {
Style::default()
.slow_blink()
.bold()
.underlined()
.yellow()
.crossed_out()
} else {
Style::default().blue()
})
.unfilled_style(Style::default())
.block(Block::default().padding(Padding::right(if a.width > 80 {
(f32::from(parts[2].width) * 0.43) as u16
} else {
(f32::from(parts[2].width) * 0.25) as u16
})))
.ratio(ratio);
Some(timebarw)
} else {
None
};
// render the small date
let datew = Paragraph::new(data.fdate())
.blue()
.block(Block::default().padding(Padding::right(2)))
.alignment(Alignment::Right);
frame.render_widget(&timebarw, parts[2]);
frame.render_widget(datew, parts[1]);
// render the clock
frame.render_widget(clockw, parts[0]);
})?;
debug!("done rendering the ui");
Ok(())
}
fn notify(&mut self) -> anyhow::Result<()> {
Self::beep()?;
#[cfg(feature = "sound")]
if self.sound {
std::thread::spawn(|| {
use rodio::{Decoder, OutputStream, Sink};
// only 30 KiB, so let's just include it in the binary and not worry about reading it
// from the fs and somehow making the file be there
const SOUND_RAW: &[u8] = include_bytes!("../data/media/alarm.mp3");
trace!("playing bundled sound");
let sound_data: Cursor<_> = std::io::Cursor::new(SOUND_RAW);
let (_stream, stream_handle) = OutputStream::try_default().unwrap();
let sink = Sink::try_new(&stream_handle).unwrap();
sink.append(
Decoder::new(sound_data).expect("could not decode the bundled alarm sound"),
);
sink.sleep_until_end();
debug!("played bundled sound");
});
}
#[cfg(feature = "desktop")]
{
let mut notify = notify_rust::Notification::new();
notify.appname(env!("CARGO_BIN_NAME"));
// see [FreeDesktop Sound Naming Specification](http://0pointer.de/public/sound-naming-spec.html)
// a sound exists for our use-case
//
// NOTE: sadly, notify_rust does not (yet) support KDE plasma, because
// they have a weird way of making sounds and notifications in general
// work. At least we get a little notification.
//
// TODO: add something to make a sound without the notification system,
// as that is not reliable but the user might depend on it.
// only play this when we don't use built in sound, this
// isn't as consistent
#[cfg(not(feature = "sound"))]
notify.sound_name("alarm-clock-elapsed");
// The user sets the time with the expectation to be notified, but it's
// not like the moon is crashing into the earth
notify.urgency(notify_rust::Urgency::Normal);
// We don't need to have it be displayed for ever, the TUI shows that the time is up
// (100%) already.
notify.timeout(notify_rust::Timeout::Default);
notify.summary(&format!(
"Your countdown of {} is up.",
humantime::Duration::from(self.countdown.unwrap())
));
// NOTE: this will only work on machines with a proper desktop, not
// with things like WSL2 or a docker container. Therefore, it is behind
// the desktop feature.
let _ = notify.show().inspect_err(|e| {
error!("could not notify of finished countup: {e}");
debug!(": {e:#?}");
});
}
Ok(())
}
fn partition(r: Rect) -> (Rect, Rect) {
fn beep() -> anyhow::Result<()> {
print!("\x07");
std::io::stdout().flush()?;
Ok(())
}
fn partition(r: Rect) -> Vec<Rect> {
let part = Layout::default()
.direction(Direction::Vertical)
.constraints([Constraint::Percentage(13), Constraint::Min(0)])
.constraints([
Constraint::Length(3),
Constraint::Length(if r.width > 80 { 8 } else { 5 }),
])
.split(r);
let hlen_date: u16 = (f32::from(part[1].width) * 0.35) as u16;
let subparts = Layout::default()
.direction(Direction::Horizontal)
.constraints([
Constraint::Length(hlen_date),
Constraint::Length(part[0].width - hlen_date),
])
.split(part[0]);
(part[0], part[1])
vec![part[1], subparts[0], subparts[1]]
}
}

62
src/main.rs
View File

@ -1,6 +1,7 @@
use std::io;
use libpt::cli::clap::Parser;
use libpt::log::{debug, Level, Logger};
use ratatui::backend::CrosstermBackend;
use ratatui::crossterm::event::{DisableMouseCapture, EnableMouseCapture};
use ratatui::crossterm::execute;
@ -14,6 +15,24 @@ use self::clock::Clock;
mod clock;
fn main() -> anyhow::Result<()> {
// setup the cli
let clock = Clock::parse();
if clock.verbose.level() >= Level::DEBUG {
let _logger = Logger::builder()
.log_to_file(true)
.log_dir("/tmp/crock/".into())
.set_level(clock.verbose.level())
.display_time(true)
.build()?;
} else {
// no logger
}
debug!("set up logger");
#[cfg(debug_assertions)]
mock_tests();
debug!("taking over terminal");
// setup terminal
enable_raw_mode()?;
let mut stdout = io::stdout();
@ -21,9 +40,10 @@ fn main() -> anyhow::Result<()> {
let backend = CrosstermBackend::new(stdout);
let mut terminal = Terminal::new(backend)?;
let clock = Clock::parse();
clock.run(&mut terminal)?;
debug!("entering clock");
let result = clock.run(&mut terminal);
debug!("restoring terminal");
// restore terminal
disable_raw_mode()?;
execute!(
@ -33,5 +53,41 @@ fn main() -> anyhow::Result<()> {
)?;
terminal.show_cursor()?;
Ok(())
debug!("done");
result
}
#[cfg(debug_assertions)]
#[allow(clippy::cast_precision_loss)]
fn mock_tests() {
use chrono::{Local, Timelike};
use libpt::log::info;
use self::clock::UiData;
info!("doing the mock tests");
{
let mut c = Clock::parse_from(["some exec", "-mvvv"]);
let now = Local::now();
c.last_reset = Some(now.with_second(0).unwrap());
assert_eq!(c.timebar_ratio(now.with_second(30).unwrap()), Some(0.5));
info!("30s=0.5");
assert_eq!(
c.timebar_ratio(now.with_second(59).unwrap()),
Some(0.9833333333333333)
);
info!("60s=1.0");
assert_eq!(c.timebar_ratio(now.with_second(0).unwrap()), Some(0.0));
info!("0s=0.0");
}
{
let mut data = UiData::default();
data.update("date".to_owned(), "time".to_owned(), Some(0.1));
assert_eq!(data.timebar_ratio(), Some(0.1));
data.update("date".to_owned(), "time".to_owned(), Some(0.2));
assert_eq!(data.timebar_ratio(), Some(0.2));
data.update("date".to_owned(), "time".to_owned(), Some(0.3));
assert_eq!(data.timebar_ratio(), Some(0.3));
}
info!("finished the mock tests");
}