30 Commits

Author SHA1 Message Date
jk
675428cfb0 Update README 2025-04-17 08:31:40 +02:00
Jens Krause
28c5d7194c Rust 1.86.0 (#73) 2025-04-13 21:37:47 +02:00
Jens Krause
5b445afe25 fix(countdown): reset MET while editing by local time (#72) 2025-04-13 21:17:56 +02:00
jk
beb12d5ec2 just: run with args 2025-04-13 19:19:46 +02:00
Jens Krause
d9399eafc9 fix(countdown): Reset MET if countdown is set by cli arguments (#71)
* fix: Reset MET if countdown is set by args

* update CHANGELOG
2025-03-03 12:21:17 +01:00
Jens Krause
ffad78e093 fix(just): group commands (#70) 2025-02-26 14:58:54 +01:00
jk
e7a5a1b2da exclude files for packaging 2025-02-26 12:31:18 +01:00
Jens Krause
6f0df4d488 Prepare v1.2.0 (#69)
* prepare v1.2.0

* update README

* update justfile
2025-02-26 12:11:54 +01:00
Jens Krause
3d9b235f12 Rust 1.85.0 + Rust 2024 Edition (#68)
- Add `rust-toolchain.toml`
- Refactor `flake` to consider `rust-toolchain.toml`, especially Rust version
- `just`: Add run-sound command
- Ignore sound files
- Format
2025-02-25 20:30:20 +01:00
jk
e094d7d81b feat(logging): add --log arg to enable logs
and/or to pass a custom log directory.
2025-02-06 20:33:52 +01:00
Jens Krause
843c4d019d set_panic_hook (#67) 2025-02-06 11:16:04 +01:00
Jens Krause
e95ecb9e9c feat(notification): Animate (blink) clock entering done mode (#65)
Optional.
2025-02-05 19:29:56 +01:00
Jens Krause
886deb3311 fix(notification): remove callbacks in favour of mpsc messaging (#64) 2025-02-05 13:35:24 +01:00
Jens Krause
7ff167368d --features sound (#63)
to enable `sound` notification for local builds only. Needed to avoid
endless issues by building the app for different platforms. Sound
support can be hard.
2025-02-04 17:39:50 +01:00
Jens Krause
a54b1b409a feat(clock): sound notification (experimental) (#62) 2025-02-04 17:28:41 +01:00
Jens Krause
8f50bc5fc6 AppEvent (#61)
Extend `events` to provide a `mpsc` channel to send `AppEvent`'s from
anywhere in the app straight to the `App`.
2025-02-04 15:05:02 +01:00
Jens Krause
d3c436da0b feat: native desktop notifications (experimental) (#59)
* desktop notification by entering `Mode::DONE` for `countdown` and `pomodoro`

* remove redundant `on_done_called` check

* remove build warning (release only)

* log notification errors

* cli arg to enable desktop notifications

* persistant notification settings

* ctrl shortcut

* update changelog

* max timer notification
2025-01-28 19:28:34 +01:00
jk
97787f718d remove editor settings (zed) 2025-01-26 18:49:14 +01:00
Jens Krause
557fcf95f0 Prepare v1.1.0 (#58) 2025-01-22 10:55:20 +01:00
Jens Krause
ec18da0664 fix(ci): remove magic nix cache action (#57) 2025-01-22 09:56:28 +01:00
Jens Krause
59c99f4f5c fix(build): statically linked binaries for linux (#55) 2025-01-22 09:43:51 +01:00
Jens Krause
6d2bf5ac09 Edit countdown by local time (#49) 2025-01-13 18:44:56 +01:00
Jens Krause
b1efb1eb62 rust 1.84, update deps (#48)
- `nix flake update`
- `cargo update`
2025-01-11 16:48:37 +01:00
Jens Krause
4ee5d7b4e9 Prepare v1.0.0 (#47)
* update README
* update CHANGELOG
* update demo
* bump v1.0.0
2025-01-10 16:36:57 +01:00
Jens Krause
9ea9f88266 feat(countdown): persist elapsed time (#46) 2025-01-10 16:01:03 +01:00
Jens Krause
c8af76c9e5 feat(countdown): rocket countdown (#45) 2025-01-08 18:52:18 +01:00
Jens Krause
468b4a5abf simplify style settings, improve naming (#44)
* simplify style settings by passing `style` directly to Widgets. No need to store it in `state` of widgets.
* remove unneeded things
* naming (state vs. widgets)
2025-01-07 19:02:57 +01:00
Jens Krause
8603a823e4 fix(footer): 12-hour format incl. tests (#43) 2025-01-06 19:22:02 +01:00
Jens Krause
94bdeeab11 feat(footer): show local time (#42) 2025-01-06 18:31:22 +01:00
Orhun Parmaksız
66c6d7fc46 docs: Add instructions for installing from the AUR (#41) 2025-01-06 09:06:15 +01:00
40 changed files with 3485 additions and 636 deletions

View File

@@ -12,7 +12,6 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: DeterminateSystems/nix-installer-action@main
- uses: DeterminateSystems/magic-nix-cache-action@main
- name: Check formatting
run: nix develop --command cargo fmt --all -- --check
- name: Run clippy
@@ -25,7 +24,6 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: DeterminateSystems/nix-installer-action@main
- uses: DeterminateSystems/magic-nix-cache-action@main
- name: Run tests
run: nix develop --command cargo test
@@ -34,6 +32,5 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: DeterminateSystems/nix-installer-action@main
- uses: DeterminateSystems/magic-nix-cache-action@main
- name: Build project
run: nix build .#timr

View File

@@ -31,7 +31,7 @@ jobs:
- os: ubuntu-latest
os_target: linux
binary_name: timr-tui
arch: x86_64 # `x86_64` by default
arch: x86_64 # based on target 'x86_64-unknown-linux-musl' defined by `CARGO_BUILD_TARGET` in flake.nix
- os: ubuntu-latest
os_target: windows
binary_name: timr-tui.exe
@@ -43,14 +43,17 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: DeterminateSystems/nix-installer-action@main
- uses: DeterminateSystems/magic-nix-cache-action@main
- name: Build (windows)
if: matrix.os_target == 'windows'
run: nix build .#windows
- name: Build (linux/macos)
if: matrix.os_target != 'windows'
- name: Build (linux)
if: matrix.os_target == 'linux'
run: nix build .#linuxStatic
- name: Build (macos)
if: matrix.os_target == 'macos'
run: nix build
- name: Copy artifact

3
.gitignore vendored
View File

@@ -18,3 +18,6 @@ result/**/*
#.idea/
#
.direnv
# ignore (possible) sound files
**/*.{mp3,wav}

View File

@@ -1 +1,2 @@
style_edition = "2024"
reorder_imports = true

View File

@@ -1,30 +0,0 @@
// Folder-specific settings
//
// For a full list of overridable settings, and general information on folder-specific settings,
// see the documentation: https://zed.dev/docs/configuring-zed#settings-files
{
"format_on_save": "on",
"formatter": "language_server",
"lsp": {
"rust-analyzer": {
"initialization_options": {
"check": {
"command": "clippy" // rust-analyzer.check.command (default: "check")
}
}
}
},
"languages": {
"Nix": {
"formatter": {
"external": {
"command": "alejandra",
"arguments": [
"-q"
]
}
},
"format_on_save": "on"
}
}
}

View File

@@ -1,5 +1,58 @@
# Changelog
## [Unreleased]
### Fixes
- (countdown) Reset `Mission Elapsed Time (MET)` if `countdown` is set by _cli arguments_ [#71](https://github.com/sectore/timr-tui/pull/71)
- (countdown) Reset `Mission Elapsed Time (MET)` while setting `countdown` by _local time_ [#72](https://github.com/sectore/timr-tui/pull/72)
### Misc.
- (deps) Use latest `Rust 1.86` [#73](https://github.com/sectore/timr-tui/pull/73)
- (cargo) Exclude files for packaging [e7a5a1b](https://github.com/sectore/timr-tui/commit/e7a5a1b2da7a7967f2602a0b92f391ac768ca638)
- (just) `group` commands [#70](https://github.com/sectore/timr-tui/pull/70)
## v1.2.0 - 2025-02-26
### Features
- (notification) Clock animation (blink) by reaching `done` mode (optional) [#65](https://github.com/sectore/timr-tui/pull/65)
- (notification) Native desktop notification (optional, experimental) [#59](https://github.com/sectore/timr-tui/pull/59)
- (notification) Sound notification (optional, experimental, available in local build only) [#62](https://github.com/sectore/timr-tui/pull/62)
- (logging) Add `--log` arg to enable logs [e094d7d](https://github.com/sectore/timr-tui/commit/e094d7d81b99f58f0d3bc50124859a4e1f6dbe4f)
### Misc.
- (refactor) Extend event handling for using a `mpsc` channel to send `AppEvent`'s from anywhere. [#61](https://github.com/sectore/timr-tui/pull/61)
- (extension) Use `set_panic_hook` for better error handling [#67](https://github.com/sectore/timr-tui/pull/67)
- (deps) Use latest `Rust 1.85` and `Rust 2024 Edition`. Refactor `flake` to consider `rust-toolchain.toml` etc. [#68](https://github.com/sectore/timr-tui/pull/68)
## v1.1.0 - 2025-01-22
### Features
- (countdown) Edit countdown by local time [#49](https://github.com/sectore/timr-tui/pull/49)
### Fixes
- (ci) Build statically linked binaries for Linux [#55](https://github.com/sectore/timr-tui/pull/55)
- (ci) Remove magic nix cache action (#57) [#56](https://github.com/sectore/timr-tui/issues/56)
### Misc.
- (deps) Latest Rust 1.84, update deps [#48](https://github.com/sectore/timr-tui/pull/48)
## v1.0.0 - 2025-01-10
Happy `v1.0.0` 🎉
### Features
- (countdown) Mission Elapsed Time ([MET](https://en.wikipedia.org/wiki/Mission_Elapsed_Time)). [#45](https://github.com/sectore/timr-tui/pull/45), [#46](https://github.com/sectore/timr-tui/pull/46)
- (footer) Local time. Optional and with custom formats. [#42](https://github.com/sectore/timr-tui/pull/42), [#43](https://github.com/sectore/timr-tui/pull/43)
- (docs) More installation instructions: Cargo, AUR (Arch Linux) [#41](https://github.com/sectore/timr-tui/pull/41), pre-built release binaries (Linux, macOS, Windows) [#47](https://github.com/sectore/timr-tui/pull/47)
## v0.9.0 - 2025-01-03
Initial version.
@@ -8,5 +61,6 @@ Initial version.
- Add `Pomodoro`, `Timer`, `Countdown`
- Persist application state
- Change styles
- Custom styles for digits
- Toggle deciseconds
- CLI

1655
Cargo.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,19 +1,21 @@
[package]
name = "timr-tui"
version = "0.9.0"
version = "1.2.0"
description = "TUI to organize your time: Pomodoro, Countdown, Timer."
edition = "2021"
rust-version = "1.82.0"
edition = "2024"
# Reminder: Always keep `channel` in `rust-toolchain.toml` in sync with `rust-version`.
rust-version = "1.86.0"
homepage = "https://github.com/sectore/timr-tui"
repository = "https://github.com/sectore/timr-tui"
readme = "README.md"
license = "MIT"
keywords = ["tui", "timer", "countdown", "pomodoro"]
categories = ["command-line-utilities"]
exclude = [".github/*", "demo/*.tape", "result/*", "*.mp3"]
[dependencies]
ratatui = "0.29.0"
crossterm = {version = "0.28.1", features = ["event-stream", "serde"] }
crossterm = { version = "0.28.1", features = ["event-stream", "serde"] }
color-eyre = "0.6.2"
futures = "0.3"
serde = { version = "1", features = ["derive"] }
@@ -26,3 +28,14 @@ tracing = "0.1.41"
tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
directories = "5.0.1"
clap = { version = "4.5.23", features = ["derive"] }
time = { version = "0.3.37", features = ["formatting", "local-offset"] }
notify-rust = "4.11.4"
rodio = { version = "0.20.1", features = [
"symphonia-mp3",
"symphonia-wav",
], default-features = false, optional = true }
thiserror = { version = "2.0.11", optional = true }
[features]
sound = ["dep:rodio", "dep:thiserror"]

122
README.md
View File

@@ -6,9 +6,9 @@ TUI to organize your time: Pomodoro, Countdown, Timer.
- `[c]ountdown` Use it for your workout, yoga session, meditation, handstand or whatever.
- `[p]omodoro` Organize your working time to be focused all the time by following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique).
It's built with [`Ratatui`](https://ratatui.rs/) written in [Rust 🦀](https://www.rust-lang.org/).
Built with [Ratatui](https://ratatui.rs/) / [Rust 🦀](https://www.rust-lang.org/).
# Preview
# Features
_Side note:_ Theme colors depend on your terminal preferences.
@@ -48,6 +48,18 @@ _Side note:_ Theme colors depend on your terminal preferences.
<img alt="menu" src="demo/menu.gif" />
</a>
## Local time (footer)
<a href="demo/local-time.gif">
<img alt="menu" src="demo/local-time.gif" />
</a>
## Mission Elapsed Time ([MET](https://en.wikipedia.org/wiki/Mission_Elapsed_Time))
<a href="demo/countdown-met.gif">
<img alt="menu" src="demo/countdown-met.gif" />
</a>
# CLI
```sh
@@ -56,33 +68,56 @@ timr-tui --help
Usage: timr-tui [OPTIONS]
Options:
-c, --countdown <COUNTDOWN> Countdown time to start from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 10:00]
-w, --work <WORK> Work time to count down from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 25:00]
-p, --pause <PAUSE> Pause time to count down from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss' [default: 5:00]
-d, --decis Wether to show deciseconds or not. [default: false]
-m, --mode <MODE> Mode to start with. [possible values: countdown, timer, pomodoro] [default: timer]
--menu Whether to open the menu or not.
-s, --style <STYLE> Style to display time with. [possible values: full, light, medium, dark, thick, cross, braille] [default: full]
-r, --reset Reset stored values to default.
-c, --countdown <COUNTDOWN> Countdown time to start from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss'
-w, --work <WORK> Work time to count down from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss'
-p, --pause <PAUSE> Pause time to count down from. Formats: 'ss', 'mm:ss', or 'hh:mm:ss'
-d, --decis Show deciseconds.
-m, --mode <MODE> Mode to start with. [possible values: countdown, timer, pomodoro]
-s, --style <STYLE> Style to display time with. [possible values: full, light, medium, dark, thick, cross, braille]
--menu Open the menu.
-r, --reset Reset stored values to default values.
-n, --notification <NOTIFICATION> Toggle desktop notifications. Experimental. [possible values: on, off]
--blink <BLINK> Toggle blink mode to animate a clock when it reaches its finished mode. [possible values: on, off]
--log [<LOG>] Directory to store log file. If not set, standard application log directory is used (check README for details).
-h, --help Print help
-V, --version Print version
```
Extra option (if `--features sound` is enabled by local build only):
```sh
--sound <SOUND> Path to sound file (.mp3 or .wav) to play as notification. Experimental.
```
# Installation
From [crates.io](https://crates.io/crates/timr-tui) run:
## Cargo
### From [crates.io](https://crates.io/crates/timr-tui)
```sh
cargo install timr-tui
```
Latest version from git repository:
### From GitHub repository
```sh
cargo install --git https://github.com/sectore/timr-tui
```
# Build from source 🔧
## Arch Linux
Install [from the AUR](https://aur.archlinux.org/packages/timr/):
```sh
paru -S timr
```
## Release binaries
Pre-built artifacts are available to download from [latest GitHub release](https://github.com/sectore/timr-tui/releases).
# Development
## Requirements
@@ -92,7 +127,6 @@ cargo install --git https://github.com/sectore/timr-tui
If you have [`direnv`](https://direnv.net) installed, run `direnv allow` once to install dependencies. In other case run `nix develop`.
### Non Nix users
- [`Rust`](https://www.rust-lang.org/learn/get-started)
@@ -103,34 +137,62 @@ If you have [`direnv`](https://direnv.net) installed, run `direnv allow` once to
### Commands
```sh
just --list
just
Available recipes:
build # build app
b # alias for `build`
default
format # format files
f # alias for `format`
lint # lint
l # alias for `lint`
run # run app
r # alias for `run`
test # run tests
t # alias for `test`
default # list commands
[build]
build # build app [alias: b]
[demo]
demo-blink # build demo: blink animation [alias: db]
demo-countdown # build demo: countdown [alias: dc]
demo-countdown-met # build demo: countdown + met [alias: dcm]
demo-decis # build demo: deciseconds [alias: dd]
demo-local-time # build demo: local time [alias: dlt]
demo-menu # build demo: menu [alias: dm]
demo-pomodoro # build demo: pomodoro [alias: dp]
demo-rocket-countdown # build demo: rocket countdown [alias: drc]
demo-style # build demo: styles [alias: ds]
demo-timer # build demo: timer [alias: dt]
[dev]
run # run app [alias: r]
run-args args # run app with arguments. It expects arguments as a string (e.g. "-c 5:00"). [alias: ra]
run-sound path # run app while sound feature is enabled. It expects a path to a sound file. [alias: rs]
run-sound-args path args # run app while sound feature is enabled by adding a path to a sound file and other arguments as string (e.g. "-c 5:00"). [alias: rsa]
[misc]
format # format files [alias: f]
lint # lint [alias: l]
[test]
test # run tests [alias: t]
```
### Build
- Linux
```sh
nix build
# or for bulding w/ statically linked binaries
nix build .#linuxStatic
```
- Windows (cross-compilation)
```sh
nix build .#windows
```
### Run tests
```sh
cargo test
```
# Misc.
## Persistant app state
@@ -148,13 +210,17 @@ C:/Users/{user}/AppData/Local/timr-tui/data/app.data
## Logs
In `debug` mode only. Locations:
To get log output, start the app by passing `--log` to `timr-tui`. See [CLI](./#cli) for details.
Logs will be stored in an `app.log` file at following locations:
```sh
# Linux
~/.local/state/timr/logs/app.log
~/.local/state/timr-tui/logs/app.log
# macOS
/Users/{user}/Library/Application Support/timr-tui/logs/app.log
# `Windows`
C:/Users/{user}/AppData/Local/timr-tui/logs/app.log
```
Optional: You can use a custom directory by passing it via `--log` arg.

BIN
demo/blink.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

23
demo/blink.tape Normal file
View File

@@ -0,0 +1,23 @@
Output demo/blink.gif
# https://github.com/charmbracelet/vhs/blob/main/THEMES.md
Set Theme "nord-light"
Set FontSize 14
Set Width 800
Set Height 400
Set Padding 0
Set Margin 1
# --- START ---
Set LoopOffset 4
Hide
# countdown 1.0s
Type "cargo run -- -r -m countdown -d -c 1 --blink=on"
Enter
Sleep 0.2
Type "m"
Type ":::"
Show
Type "s"
Sleep 4

BIN
demo/countdown-met.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

22
demo/countdown-met.tape Normal file
View File

@@ -0,0 +1,22 @@
Output demo/countdown-met.gif
# https://github.com/charmbracelet/vhs/blob/main/THEMES.md
Set Theme "iceberg-light"
Set FontSize 14
Set Width 800
Set Height 400
Set Padding 0
Set Margin 1
# --- START ---
Set LoopOffset 4
Hide
Type "cargo run -- -m c -c 3"
Enter
Sleep 0.2
Show
Type "s"
Sleep 6
Type "r"
Sleep 1

BIN
demo/local-time.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

22
demo/local-time.tape Normal file
View File

@@ -0,0 +1,22 @@
Output demo/local-time.gif
# https://github.com/charmbracelet/vhs/blob/main/THEMES.md
Set Theme "AtomOneLight"
Set FontSize 14
Set Width 800
Set Height 400
Set Padding 0
Set Margin 1
# --- START ---
Set LoopOffset 4
Hide
Type "cargo run -- -m c"
Enter
Sleep 0.2
Show
Sleep 1
# --- toggle local time ---
Type@1.5s ":::"
Sleep 1.5

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

24
flake.lock generated
View File

@@ -2,11 +2,11 @@
"nodes": {
"crane": {
"locked": {
"lastModified": 1733286231,
"narHash": "sha256-mlIDSv1/jqWnH8JTiOV7GMUNPCXL25+6jmD+7hdxx5o=",
"lastModified": 1744386647,
"narHash": "sha256-DXwQEJllxpYeVOiSlBhQuGjfvkoGHTtILLYO2FvcyzQ=",
"owner": "ipetkov",
"repo": "crane",
"rev": "af1556ecda8bcf305820f68ec2f9d77b41d9cc80",
"rev": "d02c1cdd7ec539699aa44e6ff912e15535969803",
"type": "github"
},
"original": {
@@ -23,11 +23,11 @@
"rust-analyzer-src": "rust-analyzer-src"
},
"locked": {
"lastModified": 1732689334,
"narHash": "sha256-yKI1KiZ0+bvDvfPTQ1ZT3oP/nIu3jPYm4dnbRd6hYg4=",
"lastModified": 1744231114,
"narHash": "sha256-60gLl2rJFt6SRwqWimsTAeHgfsIE1iV0zChdJFOvx8w=",
"owner": "nix-community",
"repo": "fenix",
"rev": "a8a983027ca02b363dfc82fbe3f7d9548a8d3dce",
"rev": "0ccfe532b1433da8e5a23cd513ff6847e0f6a8c2",
"type": "github"
},
"original": {
@@ -56,11 +56,11 @@
},
"nixpkgs": {
"locked": {
"lastModified": 1733212471,
"narHash": "sha256-M1+uCoV5igihRfcUKrr1riygbe73/dzNnzPsmaLCmpo=",
"lastModified": 1744463964,
"narHash": "sha256-LWqduOgLHCFxiTNYi3Uj5Lgz0SR+Xhw3kr/3Xd0GPTM=",
"owner": "NixOS",
"repo": "nixpkgs",
"rev": "55d15ad12a74eb7d4646254e13638ad0c4128776",
"rev": "2631b0b7abcea6e640ce31cd78ea58910d31e650",
"type": "github"
},
"original": {
@@ -81,11 +81,11 @@
"rust-analyzer-src": {
"flake": false,
"locked": {
"lastModified": 1732633904,
"narHash": "sha256-7VKcoLug9nbAN2txqVksWHHJplqK9Ou8dXjIZAIYSGc=",
"lastModified": 1742296961,
"narHash": "sha256-gCpvEQOrugHWLimD1wTFOJHagnSEP6VYBDspq96Idu0=",
"owner": "rust-lang",
"repo": "rust-analyzer",
"rev": "8d5e91c94f80c257ce6dbdfba7bd63a5e8a03fa6",
"rev": "15d87419f1a123d8f888d608129c3ce3ff8f13d4",
"type": "github"
},
"original": {

View File

@@ -1,7 +1,5 @@
{
inputs = {
# Disable `nixos-unstable` for now, it introduced some `VScode` related errors:
# error: function 'buildVscodeExtension' called without required argument 'pname'
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
flake-utils.url = "github:numtide/flake-utils";
crane.url = "github:ipetkov/crane";
@@ -20,34 +18,40 @@
}:
flake-utils.lib.eachDefaultSystem (system: let
pkgs = nixpkgs.legacyPackages.${system};
# Using stable toolchain as base
toolchain = with fenix.packages.${system};
combine [
minimal.rustc
minimal.cargo
targets.x86_64-pc-windows-gnu.latest.rust-std
];
toolchain =
fenix.packages.${system}.fromToolchainFile
{
file = ./rust-toolchain.toml;
# sha256 = nixpkgs.lib.fakeSha256;
sha256 = "sha256-X/4ZBHO3iW0fOenQ3foEvscgAPJYl2abspaBThDOukI=";
};
craneLib = (crane.mkLib pkgs).overrideToolchain toolchain;
# Common build inputs for both native and cross compilation
commonArgs = {
src = craneLib.cleanCargoSource ./.;
cargoArtifacts = craneLib.buildDepsOnly {
src = craneLib.cleanCargoSource ./.;
};
strictDeps = true;
doCheck = false; # skip tests during nix build
};
cargoArtifacts = craneLib.buildDepsOnly commonArgs;
# Native build
timr = craneLib.buildPackage commonArgs;
# Linux build w/ statically linked binaries
staticLinuxBuild = craneLib.buildPackage (commonArgs
// {
inherit cargoArtifacts;
CARGO_BUILD_TARGET = "x86_64-unknown-linux-musl";
CARGO_BUILD_RUSTFLAGS = "-C target-feature=+crt-static";
});
# Windows cross-compilation build
# @see https://crane.dev/examples/cross-windows.html
crossBuild = craneLib.buildPackage {
src = craneLib.cleanCargoSource ./.;
strictDeps = true;
doCheck = false;
windowsBuild = craneLib.buildPackage {
inherit (commonArgs) src strictDeps doCheck;
CARGO_BUILD_TARGET = "x86_64-pc-windows-gnu";
@@ -68,24 +72,32 @@
packages = {
inherit timr;
default = timr;
windows = crossBuild;
linuxStatic = staticLinuxBuild;
windows = windowsBuild;
};
# Development shell with all necessary tools
devShell = with nixpkgs.legacyPackages.${system};
mkShell {
buildInputs = with fenix.packages.${system}.stable; [
rust-analyzer
clippy
rustfmt
devShells.default = with nixpkgs.legacyPackages.${system};
craneLib.devShell {
packages =
[
toolchain
pkgs.just
pkgs.nixd
pkgs.alejandra
]
# some extra pkgs needed to play sound on Linux
++ lib.optionals stdenv.isLinux [
pkgs.pkg-config
pkgs.alsa-lib.dev
pkgs.pipewire
];
inherit (commonArgs) src;
RUST_SRC_PATH = "${toolchain}/lib/rustlib/src/rust/library";
ALSA_PLUGIN_DIR =
if stdenv.isLinux
then "${pkgs.pipewire}/lib/alsa-lib/"
else "";
};
});
}

View File

@@ -2,64 +2,135 @@
set unstable := true
# list commands
default:
@just --list
alias b := build
alias f := format
alias l := lint
alias t := test
alias r := run
# build app
[group('build')]
build:
cargo build
alias t := test
# run tests
[group('test')]
test:
cargo test
alias f := format
# format files
[group('misc')]
format:
just --fmt
cargo fmt
alias l := lint
# lint
[group('misc')]
lint:
cargo clippy --no-deps
alias r := run
# run app
[group('dev')]
run:
cargo run
alias ra := run-args
# run app with arguments. It expects arguments as a string (e.g. "-c 5:00").
[group('dev')]
run-args args:
cargo run -- {{ args }}
alias rs := run-sound
# run app while sound feature is enabled. It expects a path to a sound file.
[group('dev')]
run-sound path:
cargo run --features sound -- --sound={{ path }}
alias rsa := run-sound-args
# run app while sound feature is enabled by adding a path to a sound file and other arguments as string (e.g. "-c 5:00").
[group('dev')]
run-sound-args path args:
cargo run --features sound -- --sound={{ path }} {{ args }}
# demos
alias dp := demo-pomodoro
# build demo: pomodoro
[group('demo')]
demo-pomodoro:
vhs demo/pomodoro.tape
alias dt := demo-timer
# build demo: timer
[group('demo')]
demo-timer:
vhs demo/timer.tape
alias dc := demo-countdown
# build demo: countdown
[group('demo')]
demo-countdown:
vhs demo/countdown.tape
alias dcm := demo-countdown-met
# build demo: countdown + met
[group('demo')]
demo-countdown-met:
vhs demo/countdown-met.tape
alias ds := demo-style
# build demo: styles
[group('demo')]
demo-style:
vhs demo/style.tape
alias dd := demo-decis
# build demo: deciseconds
[group('demo')]
demo-decis:
vhs demo/decis.tape
alias dm := demo-menu
# build demo: menu
[group('demo')]
demo-menu:
vhs demo/menu.tape
alias dlt := demo-local-time
# build demo: local time
[group('demo')]
demo-local-time:
vhs demo/local-time.tape
alias drc := demo-rocket-countdown
# build demo: rocket countdown
[group('demo')]
demo-rocket-countdown:
vhs demo/met.tape
alias db := demo-blink
# build demo: blink animation
[group('demo')]
demo-blink:
vhs demo/blink.tape

6
rust-toolchain.toml Normal file
View File

@@ -0,0 +1,6 @@
[toolchain]
# Reminder: Always keep `rust-version` in `Cargo.toml` in sync with `channel`.
channel = "1.86.0"
components = ["clippy", "rustfmt", "rust-src", "rust-analyzer"]
targets = ["x86_64-pc-windows-gnu", "x86_64-unknown-linux-musl"]
profile = "minimal"

View File

@@ -1,19 +1,23 @@
use crate::{
args::Args,
common::{Content, Style},
common::{AppEditMode, AppTime, AppTimeFormat, ClockTypeId, Content, Style, Toggle},
constants::TICK_VALUE_MS,
events::{Event, EventHandler, Events},
events::{self, TuiEventHandler},
storage::AppStorage,
terminal::Terminal,
widgets::{
clock::{self, Clock, ClockArgs},
countdown::{Countdown, CountdownWidget},
footer::Footer,
clock::{self, ClockState, ClockStateArgs},
countdown::{Countdown, CountdownState, CountdownStateArgs},
footer::{Footer, FooterState},
header::Header,
pomodoro::{Mode as PomodoroMode, Pomodoro, PomodoroArgs, PomodoroWidget},
timer::{Timer, TimerWidget},
pomodoro::{Mode as PomodoroMode, PomodoroState, PomodoroStateArgs, PomodoroWidget},
timer::{Timer, TimerState},
},
};
#[cfg(feature = "sound")]
use crate::sound::Sound;
use color_eyre::Result;
use ratatui::{
buffer::Buffer,
@@ -21,8 +25,10 @@ use ratatui::{
layout::{Constraint, Layout, Rect},
widgets::{StatefulWidget, Widget},
};
use std::path::PathBuf;
use std::time::Duration;
use tracing::debug;
use time::OffsetDateTime;
use tracing::{debug, error};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Mode {
@@ -30,22 +36,29 @@ enum Mode {
Quit,
}
#[derive(Debug)]
pub struct App {
content: Content,
mode: Mode,
show_menu: bool,
countdown: Countdown,
timer: Timer,
pomodoro: Pomodoro,
notification: Toggle,
blink: Toggle,
#[allow(dead_code)] // w/ `--features sound` available only
sound_path: Option<PathBuf>,
app_time: AppTime,
countdown: CountdownState,
timer: TimerState,
pomodoro: PomodoroState,
style: Style,
with_decis: bool,
footer: FooterState,
}
pub struct AppArgs {
pub style: Style,
pub with_decis: bool,
pub notification: Toggle,
pub blink: Toggle,
pub show_menu: bool,
pub app_time_format: AppTimeFormat,
pub content: Content,
pub pomodoro_mode: PomodoroMode,
pub initial_value_work: Duration,
@@ -54,16 +67,30 @@ pub struct AppArgs {
pub current_value_pause: Duration,
pub initial_value_countdown: Duration,
pub current_value_countdown: Duration,
pub elapsed_value_countdown: Duration,
pub current_value_timer: Duration,
pub app_tx: events::AppEventTx,
pub sound_path: Option<PathBuf>,
}
/// Getting `AppArgs` by merging `Args` and `AppStorage`.
/// `Args` wins btw.
impl From<(Args, AppStorage)> for AppArgs {
fn from((args, stg): (Args, AppStorage)) -> Self {
AppArgs {
pub struct FromAppArgs {
pub args: Args,
pub stg: AppStorage,
pub app_tx: events::AppEventTx,
}
/// Creates an `App` by merging `Args` and `AppStorage` (`Args` wins)
/// and adding `AppEventTx`
impl From<FromAppArgs> for App {
fn from(args: FromAppArgs) -> Self {
let FromAppArgs { args, stg, app_tx } = args;
App::new(AppArgs {
with_decis: args.decis || stg.with_decis,
show_menu: args.menu || stg.show_menu,
notification: args.notification.unwrap_or(stg.notification),
blink: args.blink.unwrap_or(stg.blink),
app_time_format: stg.app_time_format,
content: args.mode.unwrap_or(stg.content),
style: args.style.unwrap_or(stg.style),
pomodoro_mode: stg.pomodoro_mode,
@@ -76,8 +103,25 @@ impl From<(Args, AppStorage)> for AppArgs {
initial_value_countdown: args.countdown.unwrap_or(stg.inital_value_countdown),
// invalidate `current_value_countdown` if an initial value is set via args
current_value_countdown: args.countdown.unwrap_or(stg.current_value_countdown),
elapsed_value_countdown: match args.countdown {
// reset value if countdown is set by arguments
Some(_) => Duration::ZERO,
None => stg.elapsed_value_countdown,
},
current_value_timer: stg.current_value_timer,
app_tx,
#[cfg(feature = "sound")]
sound_path: args.sound,
#[cfg(not(feature = "sound"))]
sound_path: None,
})
}
}
fn get_app_time() -> AppTime {
match OffsetDateTime::now_local() {
Ok(t) => AppTime::Local(t),
Err(_) => AppTime::Utc(OffsetDateTime::now_utc()),
}
}
@@ -86,66 +130,164 @@ impl App {
let AppArgs {
style,
show_menu,
app_time_format,
initial_value_work,
initial_value_pause,
initial_value_countdown,
current_value_work,
current_value_pause,
current_value_countdown,
elapsed_value_countdown,
current_value_timer,
content,
with_decis,
pomodoro_mode,
notification,
blink,
sound_path,
app_tx,
} = args;
let app_time = get_app_time();
Self {
mode: Mode::Running,
notification,
blink,
sound_path,
content,
show_menu,
app_time,
style,
with_decis,
countdown: Countdown::new(Clock::<clock::Countdown>::new(ClockArgs {
countdown: CountdownState::new(CountdownStateArgs {
initial_value: initial_value_countdown,
current_value: current_value_countdown,
tick_value: Duration::from_millis(TICK_VALUE_MS),
style,
elapsed_value: elapsed_value_countdown,
app_time,
with_decis,
})),
timer: Timer::new(Clock::<clock::Timer>::new(ClockArgs {
app_tx: app_tx.clone(),
}),
timer: TimerState::new(
ClockState::<clock::Timer>::new(ClockStateArgs {
initial_value: Duration::ZERO,
current_value: current_value_timer,
tick_value: Duration::from_millis(TICK_VALUE_MS),
style,
with_decis,
})),
pomodoro: Pomodoro::new(PomodoroArgs {
app_tx: Some(app_tx.clone()),
})
.with_name("Timer".to_owned()),
),
pomodoro: PomodoroState::new(PomodoroStateArgs {
mode: pomodoro_mode,
initial_value_work,
current_value_work,
initial_value_pause,
current_value_pause,
style,
with_decis,
app_tx: app_tx.clone(),
}),
footer: FooterState::new(show_menu, app_time_format),
}
}
pub async fn run(mut self, mut terminal: Terminal, mut events: Events) -> Result<Self> {
while self.is_running() {
if let Some(event) = events.next().await {
pub async fn run(
mut self,
terminal: &mut Terminal,
mut events: events::Events,
) -> Result<Self> {
// Closure to handle `KeyEvent`'s
let handle_key_event = |app: &mut Self, key: KeyEvent| {
debug!("Received key {:?}", key.code);
match key.code {
KeyCode::Char('q') | KeyCode::Esc => app.mode = Mode::Quit,
KeyCode::Char('c') => app.content = Content::Countdown,
KeyCode::Char('t') => app.content = Content::Timer,
KeyCode::Char('p') => app.content = Content::Pomodoro,
// toogle app time format
KeyCode::Char(':') => app.footer.toggle_app_time_format(),
// toogle menu
KeyCode::Char('m') => app.footer.set_show_menu(!app.footer.get_show_menu()),
KeyCode::Char(',') => {
app.style = app.style.next();
}
KeyCode::Char('.') => {
app.with_decis = !app.with_decis;
// update clocks
app.timer.set_with_decis(app.with_decis);
app.countdown.set_with_decis(app.with_decis);
app.pomodoro.set_with_decis(app.with_decis);
}
KeyCode::Up => app.footer.set_show_menu(true),
KeyCode::Down => app.footer.set_show_menu(false),
_ => {}
};
};
// Closure to handle `TuiEvent`'s
let mut handle_tui_events = |app: &mut Self, event: events::TuiEvent| -> Result<()> {
if matches!(event, events::TuiEvent::Tick) {
app.app_time = get_app_time();
app.countdown.set_app_time(app.app_time);
}
// Pipe events into subviews and handle only 'unhandled' events afterwards
if let Some(unhandled) = match self.content {
Content::Countdown => self.countdown.update(event.clone()),
Content::Timer => self.timer.update(event.clone()),
Content::Pomodoro => self.pomodoro.update(event.clone()),
if let Some(unhandled) = match app.content {
Content::Countdown => app.countdown.update(event.clone()),
Content::Timer => app.timer.update(event.clone()),
Content::Pomodoro => app.pomodoro.update(event.clone()),
} {
match unhandled {
Event::Render | Event::Resize => {
self.draw(&mut terminal)?;
events::TuiEvent::Render | events::TuiEvent::Resize => {
app.draw(terminal)?;
}
Event::Key(key) => self.handle_key_event(key),
events::TuiEvent::Key(key) => handle_key_event(app, key),
_ => {}
}
}
Ok(())
};
#[allow(unused_variables)] // `app` is used by `--features sound` only
// Closure to handle `AppEvent`'s
let handle_app_events = |app: &mut Self, event: events::AppEvent| -> Result<()> {
match event {
events::AppEvent::ClockDone(type_id, name) => {
debug!("AppEvent::ClockDone");
if app.notification == Toggle::On {
let msg = match type_id {
ClockTypeId::Timer => {
format!("{name} stopped by reaching its maximum value.")
}
_ => format!("{:?} {name} done!", type_id),
};
// notification
let result = notify_rust::Notification::new()
.summary(&msg.to_uppercase())
.show();
if let Err(err) = result {
error!("on_done {name} error: {err}");
}
};
#[cfg(feature = "sound")]
if let Some(path) = app.sound_path.clone() {
_ = Sound::new(path).and_then(|sound| sound.play()).or_else(
|err| -> Result<()> {
error!("Sound error: {:?}", err);
Ok(())
},
);
}
}
}
Ok(())
};
while self.is_running() {
if let Some(event) = events.next().await {
let _ = match event {
events::Event::Terminal(e) => handle_tui_events(&mut self, e),
events::Event::App(e) => handle_app_events(&mut self, e),
};
}
}
Ok(self)
@@ -155,17 +297,38 @@ impl App {
self.mode != Mode::Quit
}
fn is_edit_mode(&self) -> bool {
fn get_edit_mode(&self) -> AppEditMode {
match self.content {
Content::Countdown => self.countdown.get_clock().is_edit_mode(),
Content::Timer => self.timer.get_clock().is_edit_mode(),
Content::Pomodoro => self.pomodoro.get_clock().is_edit_mode(),
Content::Countdown => {
if self.countdown.is_clock_edit_mode() {
AppEditMode::Clock
} else if self.countdown.is_time_edit_mode() {
AppEditMode::Time
} else {
AppEditMode::None
}
}
Content::Timer => {
if self.timer.get_clock().is_edit_mode() {
AppEditMode::Clock
} else {
AppEditMode::None
}
}
Content::Pomodoro => {
if self.pomodoro.get_clock().is_edit_mode() {
AppEditMode::Clock
} else {
AppEditMode::None
}
}
}
}
fn clock_is_running(&self) -> bool {
match self.content {
Content::Countdown => self.countdown.get_clock().is_running(),
Content::Countdown => self.countdown.is_running(),
Content::Timer => self.timer.get_clock().is_running(),
Content::Pomodoro => self.pomodoro.get_clock().is_running(),
}
@@ -179,34 +342,6 @@ impl App {
}
}
fn handle_key_event(&mut self, key: KeyEvent) {
debug!("Received key {:?}", key.code);
match key.code {
KeyCode::Char('q') | KeyCode::Esc => self.mode = Mode::Quit,
KeyCode::Char('c') => self.content = Content::Countdown,
KeyCode::Char('t') => self.content = Content::Timer,
KeyCode::Char('p') => self.content = Content::Pomodoro,
KeyCode::Char('m') => self.show_menu = !self.show_menu,
KeyCode::Char(',') => {
self.style = self.style.next();
// update clocks
self.timer.set_style(self.style);
self.countdown.set_style(self.style);
self.pomodoro.set_style(self.style);
}
KeyCode::Char('.') => {
self.with_decis = !self.with_decis;
// update clocks
self.timer.set_with_decis(self.with_decis);
self.countdown.set_with_decis(self.with_decis);
self.pomodoro.set_with_decis(self.with_decis);
}
KeyCode::Up => self.show_menu = true,
KeyCode::Down => self.show_menu = false,
_ => {}
};
}
fn draw(&mut self, terminal: &mut Terminal) -> Result<()> {
terminal.draw(|frame| {
frame.render_stateful_widget(AppWidget, frame.area(), self);
@@ -217,7 +352,10 @@ impl App {
pub fn to_storage(&self) -> AppStorage {
AppStorage {
content: self.content,
show_menu: self.show_menu,
show_menu: self.footer.get_show_menu(),
notification: self.notification,
blink: self.blink,
app_time_format: *self.footer.app_time_format(),
style: self.style,
with_decis: self.with_decis,
pomodoro_mode: self.pomodoro.get_mode().clone(),
@@ -233,6 +371,7 @@ impl App {
current_value_countdown: Duration::from(
*self.countdown.get_clock().get_current_value(),
),
elapsed_value_countdown: Duration::from(*self.countdown.get_elapsed_value()),
current_value_timer: Duration::from(*self.timer.get_clock().get_current_value()),
}
}
@@ -243,9 +382,23 @@ struct AppWidget;
impl AppWidget {
fn render_content(&self, area: Rect, buf: &mut Buffer, state: &mut App) {
match state.content {
Content::Timer => TimerWidget.render(area, buf, &mut state.timer.clone()),
Content::Countdown => CountdownWidget.render(area, buf, &mut state.countdown.clone()),
Content::Pomodoro => PomodoroWidget.render(area, buf, &mut state.pomodoro.clone()),
Content::Timer => {
Timer {
style: state.style,
blink: state.blink == Toggle::On,
}
.render(area, buf, &mut state.timer);
}
Content::Countdown => Countdown {
style: state.style,
blink: state.blink == Toggle::On,
}
.render(area, buf, &mut state.countdown),
Content::Pomodoro => PomodoroWidget {
style: state.style,
blink: state.blink == Toggle::On,
}
.render(area, buf, &mut state.pomodoro),
};
}
}
@@ -256,7 +409,7 @@ impl StatefulWidget for AppWidget {
let [v0, v1, v2] = Layout::vertical([
Constraint::Length(1),
Constraint::Percentage(100),
Constraint::Length(if state.show_menu { 4 } else { 1 }),
Constraint::Length(if state.footer.get_show_menu() { 4 } else { 1 }),
])
.areas(area);
@@ -269,11 +422,11 @@ impl StatefulWidget for AppWidget {
self.render_content(v1, buf, state);
// footer
Footer {
show_menu: state.show_menu,
running_clock: state.clock_is_running(),
selected_content: state.content,
edit_mode: state.is_edit_mode(),
app_edit_mode: state.get_edit_mode(),
app_time: state.app_time,
}
.render(v2, buf);
.render(v2, buf, &mut state.footer);
}
}

View File

@@ -1,10 +1,15 @@
use crate::{
common::{Content, Style},
common::{Content, Style, Toggle},
duration,
};
#[cfg(feature = "sound")]
use crate::{sound, sound::SoundError};
use clap::Parser;
use std::path::PathBuf;
use std::time::Duration;
pub const LOG_DIRECTORY_DEFAULT_MISSING_VALUE: &str = " "; // empty string
#[derive(Parser)]
#[command(version)]
pub struct Args {
@@ -23,7 +28,7 @@ pub struct Args {
)]
pub pause: Option<Duration>,
#[arg(long, short = 'd', help = "Whether to show deciseconds or not.")]
#[arg(long, short = 'd', help = "Show deciseconds.")]
pub decis: bool,
#[arg(long, short = 'm', value_enum, help = "Mode to start with.")]
@@ -32,9 +37,55 @@ pub struct Args {
#[arg(long, short = 's', value_enum, help = "Style to display time with.")]
pub style: Option<Style>,
#[arg(long, value_enum, help = "Whether to open the menu or not.")]
#[arg(long, value_enum, help = "Open the menu.")]
pub menu: bool,
#[arg(long, short = 'r', help = "Reset stored values to default.")]
#[arg(long, short = 'r', help = "Reset stored values to default values.")]
pub reset: bool,
#[arg(
long,
short,
value_enum,
help = "Toggle desktop notifications. Experimental."
)]
pub notification: Option<Toggle>,
#[arg(
long,
value_enum,
help = "Toggle blink mode to animate a clock when it reaches its finished mode."
)]
pub blink: Option<Toggle>,
#[cfg(feature = "sound")]
#[arg(
long,
value_enum,
help = "Path to sound file (.mp3 or .wav) to play as notification. Experimental.",
value_hint = clap::ValueHint::FilePath,
value_parser = sound_file_parser,
)]
pub sound: Option<PathBuf>,
#[arg(
long,
// allows both --log=path and --log path syntax
num_args = 0..=1,
// Note: If no value is passed, use a " " by default,
// this value will be checked later in `main`
// to use another (default) log directory instead
default_missing_value=LOG_DIRECTORY_DEFAULT_MISSING_VALUE,
help = "Directory to store log file. If not set, standard application log directory is used (check README for details).",
value_hint = clap::ValueHint::DirPath,
)]
pub log: Option<PathBuf>,
}
#[cfg(feature = "sound")]
/// Custom parser for sound file
fn sound_file_parser(s: &str) -> Result<PathBuf, SoundError> {
let path = PathBuf::from(s);
sound::validate_sound_file(&path)?;
Ok(path)
}

View File

@@ -1,6 +1,8 @@
use clap::ValueEnum;
use ratatui::symbols::shade;
use serde::{Deserialize, Serialize};
use time::OffsetDateTime;
use time::format_description;
#[derive(
Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, ValueEnum, Default, Serialize, Deserialize,
@@ -15,6 +17,12 @@ pub enum Content {
Pomodoro,
}
#[derive(Clone, Debug)]
pub enum ClockTypeId {
Countdown,
Timer,
}
#[derive(Debug, Copy, Clone, ValueEnum, Default, Serialize, Deserialize)]
pub enum Style {
#[default]
@@ -62,3 +70,138 @@ impl Style {
}
}
}
#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize)]
pub enum AppTimeFormat {
/// `hh:mm:ss`
#[default]
HhMmSs,
/// `hh:mm`
HhMm,
/// `hh:mm AM` (or PM)
Hh12Mm,
/// `` (empty)
Hidden,
}
impl AppTimeFormat {
pub fn next(&self) -> Self {
match self {
AppTimeFormat::HhMmSs => AppTimeFormat::HhMm,
AppTimeFormat::HhMm => AppTimeFormat::Hh12Mm,
AppTimeFormat::Hh12Mm => AppTimeFormat::Hidden,
AppTimeFormat::Hidden => AppTimeFormat::HhMmSs,
}
}
}
#[derive(Debug, Clone, Copy)]
pub enum AppTime {
Local(OffsetDateTime),
Utc(OffsetDateTime),
}
impl From<AppTime> for OffsetDateTime {
fn from(app_time: AppTime) -> Self {
match app_time {
AppTime::Local(t) => t,
AppTime::Utc(t) => t,
}
}
}
impl AppTime {
pub fn format(&self, app_format: &AppTimeFormat) -> String {
let parse_str = match app_format {
AppTimeFormat::HhMmSs => Some("[hour]:[minute]:[second]"),
AppTimeFormat::HhMm => Some("[hour]:[minute]"),
AppTimeFormat::Hh12Mm => Some("[hour repr:12 padding:none]:[minute] [period]"),
AppTimeFormat::Hidden => None,
};
if let Some(str) = parse_str {
format_description::parse(str)
.map_err(|_| "parse error")
.and_then(|fd| {
OffsetDateTime::from(*self)
.format(&fd)
.map_err(|_| "format error")
})
.unwrap_or_else(|e| e.to_string())
} else {
"".to_owned()
}
}
}
#[derive(Debug)]
pub enum AppEditMode {
None,
Clock,
Time,
}
#[derive(Debug, Clone, Copy, ValueEnum, PartialEq, Eq, Default, Serialize, Deserialize)]
pub enum Toggle {
#[value(name = "on")]
On,
#[default]
#[value(name = "off")]
Off,
}
#[cfg(test)]
mod tests {
use super::*;
use time::{Date, Month, PrimitiveDateTime, Time};
#[test]
fn test_format_app_time() {
let dt = PrimitiveDateTime::new(
Date::from_calendar_date(2025, Month::January, 6).unwrap(),
Time::from_hms(18, 6, 10).unwrap(),
)
.assume_utc();
// hh:mm:ss
assert_eq!(
AppTime::Utc(dt).format(&AppTimeFormat::HhMmSs),
"18:06:10",
"utc"
);
assert_eq!(
AppTime::Local(dt).format(&AppTimeFormat::HhMmSs),
"18:06:10",
"local"
);
// hh:mm
assert_eq!(
AppTime::Utc(dt).format(&AppTimeFormat::HhMm),
"18:06",
"utc"
);
assert_eq!(
AppTime::Local(dt).format(&AppTimeFormat::HhMm),
"18:06",
"local"
);
// hh:mm period
assert_eq!(
AppTime::Utc(dt).format(&AppTimeFormat::Hh12Mm),
"6:06 PM",
"utc"
);
assert_eq!(
AppTime::Local(dt).format(&AppTimeFormat::Hh12Mm),
"6:06 PM",
"local"
);
// hidden
assert_eq!(AppTime::Utc(dt).format(&AppTimeFormat::Hidden), "", "utc");
assert_eq!(
AppTime::Local(dt).format(&AppTimeFormat::Hidden),
"",
"local"
);
}
}

View File

@@ -1,8 +1,9 @@
use crate::constants::APP_NAME;
use color_eyre::eyre::{eyre, Result};
use color_eyre::eyre::{Result, eyre};
use directories::ProjectDirs;
use std::fs;
use std::path::PathBuf;
pub struct Config {
pub log_dir: PathBuf,
pub data_dir: PathBuf,
@@ -10,8 +11,11 @@ pub struct Config {
impl Config {
pub fn init() -> Result<Self> {
// default logs dir
let log_dir = get_default_state_dir()?.join("logs");
fs::create_dir_all(&log_dir)?;
// default data dir
let data_dir = get_default_state_dir()?.join("data");
fs::create_dir_all(&data_dir)?;

View File

@@ -1,6 +1,6 @@
use color_eyre::{
eyre::{ensure, eyre},
Report,
eyre::{ensure, eyre},
};
use std::fmt;
use std::time::Duration;
@@ -20,6 +20,10 @@ pub const MINS_PER_HOUR: u64 = 60;
// https://doc.rust-lang.org/src/core/time.rs.html#36
const HOURS_PER_DAY: u64 = 24;
// max. 99:59:59
pub const MAX_DURATION: Duration =
Duration::from_secs(100 * MINS_PER_HOUR * SECS_PER_MINUTE).saturating_sub(ONE_SECOND);
#[derive(Debug, Clone, Copy, PartialOrd)]
pub struct DurationEx {
inner: Duration,
@@ -86,6 +90,10 @@ impl DurationEx {
let inner = self.inner.saturating_sub(ex.inner);
Self { inner }
}
pub fn to_string_with_decis(self) -> String {
format!("{}.{}", self, self.decis())
}
}
impl fmt::Display for DurationEx {

View File

@@ -1,9 +1,11 @@
use crossterm::event::{Event as CrosstermEvent, EventStream, KeyEvent, KeyEventKind};
use futures::{Stream, StreamExt};
use std::{pin::Pin, time::Duration};
use tokio::sync::mpsc;
use tokio::time::interval;
use tokio_stream::{wrappers::IntervalStream, StreamMap};
use tokio_stream::{StreamMap, wrappers::IntervalStream};
use crate::common::ClockTypeId;
use crate::constants::{FPS_VALUE_MS, TICK_VALUE_MS};
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
@@ -12,8 +14,9 @@ enum StreamKey {
Render,
Crossterm,
}
#[derive(Clone, Debug)]
pub enum Event {
pub enum TuiEvent {
Error,
Tick,
Render,
@@ -21,8 +24,17 @@ pub enum Event {
Resize,
}
#[derive(Clone, Debug)]
pub enum AppEvent {
ClockDone(ClockTypeId, String),
}
pub type AppEventTx = mpsc::UnboundedSender<AppEvent>;
pub type AppEventRx = mpsc::UnboundedReceiver<AppEvent>;
pub struct Events {
streams: StreamMap<StreamKey, Pin<Box<dyn Stream<Item = Event>>>>,
streams: StreamMap<StreamKey, Pin<Box<dyn Stream<Item = TuiEvent>>>>,
app_channel: (AppEventTx, AppEventRx),
}
impl Default for Events {
@@ -33,31 +45,46 @@ impl Default for Events {
(StreamKey::Render, render_stream()),
(StreamKey::Crossterm, crossterm_stream()),
]),
app_channel: mpsc::unbounded_channel(),
}
}
}
pub enum Event {
Terminal(TuiEvent),
App(AppEvent),
}
impl Events {
pub fn new() -> Self {
Self::default()
}
pub async fn next(&mut self) -> Option<Event> {
self.streams.next().await.map(|(_, event)| event)
let streams = &mut self.streams;
let app_rx = &mut self.app_channel.1;
tokio::select! {
Some((_, event)) = streams.next() => Some(Event::Terminal(event)),
Some(app_event) = app_rx.recv() => Some(Event::App(app_event)),
}
}
pub fn get_app_event_tx(&self) -> AppEventTx {
self.app_channel.0.clone()
}
}
fn tick_stream() -> Pin<Box<dyn Stream<Item = Event>>> {
fn tick_stream() -> Pin<Box<dyn Stream<Item = TuiEvent>>> {
let tick_interval = interval(Duration::from_millis(TICK_VALUE_MS));
Box::pin(IntervalStream::new(tick_interval).map(|_| Event::Tick))
Box::pin(IntervalStream::new(tick_interval).map(|_| TuiEvent::Tick))
}
fn render_stream() -> Pin<Box<dyn Stream<Item = Event>>> {
fn render_stream() -> Pin<Box<dyn Stream<Item = TuiEvent>>> {
let render_interval = interval(Duration::from_millis(FPS_VALUE_MS));
Box::pin(IntervalStream::new(render_interval).map(|_| Event::Render))
Box::pin(IntervalStream::new(render_interval).map(|_| TuiEvent::Render))
}
fn crossterm_stream() -> Pin<Box<dyn Stream<Item = Event>>> {
fn crossterm_stream() -> Pin<Box<dyn Stream<Item = TuiEvent>>> {
Box::pin(
EventStream::new()
.fuse()
@@ -65,16 +92,16 @@ fn crossterm_stream() -> Pin<Box<dyn Stream<Item = Event>>> {
.filter_map(|event| async move {
match event {
Ok(CrosstermEvent::Key(key)) if key.kind == KeyEventKind::Press => {
Some(Event::Key(key))
Some(TuiEvent::Key(key))
}
Ok(CrosstermEvent::Resize(_, _)) => Some(Event::Resize),
Err(_) => Some(Event::Error),
Ok(CrosstermEvent::Resize(_, _)) => Some(TuiEvent::Resize),
Err(_) => Some(TuiEvent::Error),
_ => None,
}
}),
)
}
pub trait EventHandler {
fn update(&mut self, _: Event) -> Option<Event>;
pub trait TuiEventHandler {
fn update(&mut self, _: TuiEvent) -> Option<TuiEvent>;
}

View File

@@ -1,4 +1,4 @@
use color_eyre::eyre::Result;
use color_eyre::eyre::{Result, eyre};
use std::fs;
use std::path::PathBuf;
use tracing::level_filters::LevelFilter;
@@ -17,7 +17,13 @@ impl Logger {
pub fn init(&self) -> Result<()> {
let log_path = self.log_dir.join("app.log");
let log_file = fs::File::create(log_path)?;
let log_file = fs::File::create(log_path).map_err(|err| {
eyre!(
"Could not create a log file in {:?} : {}",
self.log_dir,
err
)
})?;
let fmt_layer = tracing_subscriber::fmt::layer()
.with_file(true)
.with_line_number(true)

View File

@@ -3,7 +3,6 @@ mod common;
mod config;
mod constants;
mod events;
#[cfg(debug_assertions)]
mod logging;
mod args;
@@ -13,24 +12,50 @@ mod terminal;
mod utils;
mod widgets;
use app::{App, AppArgs};
use args::Args;
#[cfg(feature = "sound")]
mod sound;
use app::{App, FromAppArgs};
use args::{Args, LOG_DIRECTORY_DEFAULT_MISSING_VALUE};
use clap::Parser;
use color_eyre::Result;
use config::Config;
use std::path::PathBuf;
use storage::{AppStorage, Storage};
#[tokio::main]
async fn main() -> Result<()> {
// init `Config`
let cfg = Config::init()?;
#[cfg(debug_assertions)]
logging::Logger::new(cfg.log_dir).init()?;
color_eyre::install()?;
// get args given by CLI
let args = Args::parse();
// Note:
// `log` arg can have three different values:
// (1) not set => None
// (2) set with path => Some(Some(path))
// (3) set without path => Some(None)
let custom_log_dir: Option<Option<&PathBuf>> = if let Some(path) = &args.log {
if path.ne(PathBuf::from(LOG_DIRECTORY_DEFAULT_MISSING_VALUE).as_os_str()) {
// (2)
Some(Some(path))
} else {
// (3)
Some(None)
}
} else {
// (1)
None
};
let terminal = terminal::setup()?;
if let Some(log_dir) = custom_log_dir {
let dir: PathBuf = log_dir.unwrap_or(&cfg.log_dir).to_path_buf();
logging::Logger::new(dir).init()?;
}
let mut terminal = terminal::setup()?;
let events = events::Events::new();
// check persistant storage
@@ -42,9 +67,14 @@ async fn main() -> Result<()> {
storage.load().unwrap_or_default()
};
// merge `Args` and `AppStorage`.
let app_args = AppArgs::from((args, stg));
let app_storage = App::new(app_args).run(terminal, events).await?.to_storage();
let app_storage = App::from(FromAppArgs {
args,
stg,
app_tx: events.get_app_event_tx(),
})
.run(&mut terminal, events)
.await?
.to_storage();
// store app state persistantly
storage.save(app_storage)?;

73
src/sound.rs Normal file
View File

@@ -0,0 +1,73 @@
use rodio::{Decoder, OutputStream, Sink};
use std::fs::File;
use std::io::BufReader;
use std::path::PathBuf;
use thiserror::Error;
#[derive(Debug, Error)]
pub enum SoundError {
#[error("Sound output stream error: {0}")]
OutputStream(String),
#[error("Sound file error: {0}")]
File(String),
#[error("Sound sink error: {0}")]
Sink(String),
#[error("Sound decoder error: {0}")]
Decoder(String),
}
pub fn validate_sound_file(path: &PathBuf) -> Result<&PathBuf, SoundError> {
// validate path
if !path.exists() {
let err = SoundError::File(format!("File not found: {:?}", path));
return Err(err);
};
// Validate file extension
path.extension()
.and_then(|ext| ext.to_str())
.filter(|ext| ["mp3", "wav"].contains(&ext.to_lowercase().as_str()))
.ok_or_else(|| {
SoundError::File(
"Unsupported file extension. Only .mp3 and .wav are supported".to_owned(),
)
})?;
Ok(path)
}
// #[derive(Clone)]
pub struct Sound {
path: PathBuf,
}
impl Sound {
pub fn new(path: PathBuf) -> Result<Self, SoundError> {
Ok(Self { path })
}
pub fn play(&self) -> Result<(), SoundError> {
// validate file again
validate_sound_file(&self.path)?;
// before playing the sound
let path = self.path.clone();
std::thread::spawn(move || -> Result<(), SoundError> {
// Important note: Never (ever) use a single `_` as a placeholder here. `_stream` or something is fine!
// The value will dropped and the sound will fail without any errors
// see https://github.com/RustAudio/rodio/issues/330
let (_stream, handle) =
OutputStream::try_default().map_err(|e| SoundError::OutputStream(e.to_string()))?;
let file = File::open(&path).map_err(|e| SoundError::File(e.to_string()))?;
let sink = Sink::try_new(&handle).map_err(|e| SoundError::Sink(e.to_string()))?;
let decoder = Decoder::new(BufReader::new(file))
.map_err(|e| SoundError::Decoder(e.to_string()))?;
sink.append(decoder);
sink.sleep_until_end();
Ok(())
});
Ok(())
}
}

View File

@@ -1,5 +1,5 @@
use crate::{
common::{Content, Style},
common::{AppTimeFormat, Content, Style, Toggle},
widgets::pomodoro::Mode as PomodoroMode,
};
use color_eyre::eyre::Result;
@@ -12,6 +12,9 @@ use std::time::Duration;
pub struct AppStorage {
pub content: Content,
pub show_menu: bool,
pub notification: Toggle,
pub blink: Toggle,
pub app_time_format: AppTimeFormat,
pub style: Style,
pub with_decis: bool,
pub pomodoro_mode: PomodoroMode,
@@ -24,6 +27,7 @@ pub struct AppStorage {
// countdown
pub inital_value_countdown: Duration,
pub current_value_countdown: Duration,
pub elapsed_value_countdown: Duration,
// timer
pub current_value_timer: Duration,
}
@@ -36,6 +40,9 @@ impl Default for AppStorage {
AppStorage {
content: Content::default(),
show_menu: true,
notification: Toggle::Off,
blink: Toggle::Off,
app_time_format: AppTimeFormat::default(),
style: Style::default(),
with_decis: false,
pomodoro_mode: PomodoroMode::Work,
@@ -48,6 +55,7 @@ impl Default for AppStorage {
// countdown
inital_value_countdown: DEFAULT_COUNTDOWN,
current_value_countdown: DEFAULT_COUNTDOWN,
elapsed_value_countdown: Duration::ZERO,
// timer
current_value_timer: Duration::ZERO,
}

View File

@@ -5,13 +5,14 @@ use crossterm::{
cursor, execute,
terminal::{EnterAlternateScreen, LeaveAlternateScreen},
};
use ratatui::{backend::CrosstermBackend, Terminal as RatatuiTerminal};
use ratatui::{Terminal as RatatuiTerminal, backend::CrosstermBackend};
pub type Terminal = RatatuiTerminal<CrosstermBackend<io::Stdout>>;
pub fn setup() -> Result<Terminal> {
let mut stdout = std::io::stdout();
crossterm::terminal::enable_raw_mode()?;
set_panic_hook();
execute!(stdout, EnterAlternateScreen, cursor::Hide)?;
let mut terminal = RatatuiTerminal::new(CrosstermBackend::new(stdout))?;
terminal.clear()?;
@@ -24,3 +25,13 @@ pub fn teardown() -> Result<()> {
crossterm::terminal::disable_raw_mode()?;
Ok(())
}
// Panic hook
// see https://ratatui.rs/tutorials/counter-app/error-handling/#setup-hooks
fn set_panic_hook() {
let hook = std::panic::take_hook();
std::panic::set_hook(Box::new(move |panic_info| {
let _ = teardown(); // ignore any errors as we are already failing
hook(panic_info);
}));
}

View File

@@ -5,6 +5,7 @@ pub mod clock_elements_test;
#[cfg(test)]
pub mod clock_test;
pub mod countdown;
pub mod edit_time;
pub mod footer;
pub mod header;
pub mod pomodoro;

View File

@@ -10,21 +10,15 @@ use ratatui::{
};
use crate::{
common::Style,
duration::{
DurationEx, MINS_PER_HOUR, ONE_DECI_SECOND, ONE_HOUR, ONE_MINUTE, ONE_SECOND,
SECS_PER_MINUTE,
},
common::{ClockTypeId, Style},
duration::{DurationEx, MAX_DURATION, ONE_DECI_SECOND, ONE_HOUR, ONE_MINUTE, ONE_SECOND},
events::{AppEvent, AppEventTx},
utils::center_horizontal,
widgets::clock_elements::{
Colon, Digit, Dot, COLON_WIDTH, DIGIT_HEIGHT, DIGIT_WIDTH, DOT_WIDTH,
COLON_WIDTH, Colon, DIGIT_HEIGHT, DIGIT_SPACE_WIDTH, DIGIT_WIDTH, DOT_WIDTH, Digit, Dot,
},
};
// max. 99:59:59
const MAX_DURATION: Duration =
Duration::from_secs(100 * MINS_PER_HOUR * SECS_PER_MINUTE).saturating_sub(ONE_SECOND);
#[derive(Debug, Copy, Clone, Display, PartialEq, Eq)]
pub enum Time {
Decis,
@@ -72,27 +66,70 @@ pub enum Format {
HhMmSs,
}
#[derive(Debug, Clone)]
pub struct Clock<T> {
const RANGE_OF_DONE_COUNT: u64 = 4;
const MAX_DONE_COUNT: u64 = RANGE_OF_DONE_COUNT * 5;
pub struct ClockState<T> {
type_id: ClockTypeId,
name: Option<String>,
initial_value: DurationEx,
current_value: DurationEx,
tick_value: DurationEx,
mode: Mode,
format: Format,
pub style: Style,
pub with_decis: bool,
app_tx: Option<AppEventTx>,
/// Tick counter starting whenever `Mode::DONE` has been reached.
/// Initial value is set in `done()`.
/// Updates happened in `update_done_count`
/// Default value: `None`
done_count: Option<u64>,
phantom: PhantomData<T>,
}
pub struct ClockArgs {
pub struct ClockStateArgs {
pub initial_value: Duration,
pub current_value: Duration,
pub tick_value: Duration,
pub style: Style,
pub with_decis: bool,
pub app_tx: Option<AppEventTx>,
}
impl<T> Clock<T> {
impl<T> ClockState<T> {
pub fn with_name(mut self, name: String) -> Self {
self.name = Some(name);
self
}
pub fn get_name(&self) -> String {
self.name.clone().unwrap_or_default()
}
pub fn get_type_id(&self) -> &ClockTypeId {
&self.type_id
}
pub fn with_mode(mut self, mode: Mode) -> Self {
self.mode = mode;
self
}
pub fn get_mode(&self) -> &Mode {
&self.mode
}
pub fn is_initial(&self) -> bool {
self.mode == Mode::Initial
}
pub fn run(&mut self) {
self.mode = Mode::Tick
}
pub fn is_running(&self) -> bool {
self.mode == Mode::Tick
}
pub fn toggle_pause(&mut self) {
self.mode = if self.mode == Mode::Tick {
Mode::Pause
@@ -109,6 +146,11 @@ impl<T> Clock<T> {
&self.current_value
}
pub fn set_current_value(&mut self, duration: DurationEx) {
self.current_value = duration;
self.update_format();
}
pub fn toggle_edit(&mut self) {
self.mode = match self.mode.clone() {
Mode::Editable(_, prev) => {
@@ -187,6 +229,7 @@ impl<T> Clock<T> {
};
self.update_format();
}
pub fn edit_current_down(&mut self) {
self.current_value = match self.mode {
Mode::Editable(Time::Decis, _) => {
@@ -205,14 +248,6 @@ impl<T> Clock<T> {
self.update_mode();
}
pub fn get_mode(&self) -> &Mode {
&self.mode
}
pub fn is_running(&self) -> bool {
self.mode == Mode::Tick
}
pub fn is_edit_mode(&self) -> bool {
matches!(self.mode, Mode::Editable(_, _))
}
@@ -300,6 +335,18 @@ impl<T> Clock<T> {
self.mode == Mode::Done
}
fn done(&mut self) {
if !self.is_done() {
self.mode = Mode::Done;
let type_id = self.get_type_id().clone();
let name = self.get_name();
if let Some(tx) = &self.app_tx {
_ = tx.send(AppEvent::ClockDone(type_id, name));
};
self.done_count = Some(MAX_DONE_COUNT);
}
}
fn update_format(&mut self) {
self.format = self.get_format();
}
@@ -319,21 +366,40 @@ impl<T> Clock<T> {
Format::S
}
}
/// Updates inner value of `done_count`.
/// It should be called whenever `TuiEvent::Tick` is handled.
/// At first glance it might happen in `Clock::tick`, but sometimes
/// `tick` won't be called again after `Mode::Done` event (e.g. in `widget::Countdown`).
/// That's why `update_done_count` is called from "outside".
pub fn update_done_count(&mut self) {
if let Some(count) = self.done_count {
if count > 0 {
let value = count - 1;
self.done_count = Some(value)
} else {
// None means we are done and no counting anymore.
self.done_count = None
}
}
}
}
#[derive(Debug, Clone)]
pub struct Countdown {}
impl Clock<Countdown> {
pub fn new(args: ClockArgs) -> Self {
let ClockArgs {
impl ClockState<Countdown> {
pub fn new(args: ClockStateArgs) -> Self {
let ClockStateArgs {
initial_value,
current_value,
tick_value,
style,
with_decis,
app_tx,
} = args;
let mut instance = Self {
type_id: ClockTypeId::Countdown,
name: None,
initial_value: initial_value.into(),
current_value: current_value.into(),
tick_value: tick_value.into(),
@@ -345,8 +411,9 @@ impl Clock<Countdown> {
Mode::Pause
},
format: Format::S,
style,
with_decis,
app_tx,
done_count: None,
phantom: PhantomData,
};
// update format once
@@ -357,14 +424,14 @@ impl Clock<Countdown> {
pub fn tick(&mut self) {
if self.mode == Mode::Tick {
self.current_value = self.current_value.saturating_sub(self.tick_value);
self.set_done();
self.check_done();
self.update_format();
}
}
fn set_done(&mut self) {
fn check_done(&mut self) {
if self.current_value.eq(&Duration::ZERO.into()) {
self.mode = Mode::Done;
self.done();
}
}
@@ -394,16 +461,18 @@ impl Clock<Countdown> {
#[derive(Debug, Clone)]
pub struct Timer {}
impl Clock<Timer> {
pub fn new(args: ClockArgs) -> Self {
let ClockArgs {
impl ClockState<Timer> {
pub fn new(args: ClockStateArgs) -> Self {
let ClockStateArgs {
initial_value,
current_value,
tick_value,
style,
with_decis,
app_tx,
} = args;
let mut instance = Self {
type_id: ClockTypeId::Timer,
name: None,
initial_value: initial_value.into(),
current_value: current_value.into(),
tick_value: tick_value.into(),
@@ -415,9 +484,10 @@ impl Clock<Timer> {
Mode::Pause
},
format: Format::S,
phantom: PhantomData,
style,
with_decis,
app_tx,
done_count: None,
phantom: PhantomData,
};
// update format once
instance.update_format();
@@ -427,14 +497,14 @@ impl Clock<Timer> {
pub fn tick(&mut self) {
if self.mode == Mode::Tick {
self.current_value = self.current_value.saturating_add(self.tick_value);
self.set_done();
self.check_done();
self.update_format();
}
}
fn set_done(&mut self) {
fn check_done(&mut self) {
if self.current_value.ge(&MAX_DURATION.into()) {
self.mode = Mode::Done;
self.done();
}
}
@@ -455,12 +525,12 @@ impl Clock<Timer> {
}
}
const SPACE_WIDTH: u16 = 1;
pub struct ClockWidget<T>
where
T: std::fmt::Debug,
{
style: Style,
blink: bool,
phantom: PhantomData<T>,
}
@@ -468,8 +538,10 @@ impl<T> ClockWidget<T>
where
T: std::fmt::Debug,
{
pub fn new() -> Self {
pub fn new(style: Style, blink: bool) -> Self {
Self {
style,
blink,
phantom: PhantomData,
}
}
@@ -489,15 +561,15 @@ where
Format::HhMmSs => add_decis(
vec![
DIGIT_WIDTH, // h
SPACE_WIDTH, // (space)
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // h
COLON_WIDTH, // :
DIGIT_WIDTH, // m
SPACE_WIDTH, // (space)
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // m
COLON_WIDTH, // :
DIGIT_WIDTH, // s
SPACE_WIDTH, // (space)
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // s
],
with_decis,
@@ -507,11 +579,11 @@ where
DIGIT_WIDTH, // h
COLON_WIDTH, // :
DIGIT_WIDTH, // m
SPACE_WIDTH, // (space)
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // m
COLON_WIDTH, // :
DIGIT_WIDTH, // s
SPACE_WIDTH, // (space)
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // s
],
with_decis,
@@ -519,11 +591,11 @@ where
Format::MmSs => add_decis(
vec![
DIGIT_WIDTH, // m
SPACE_WIDTH, // (space)
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // m
COLON_WIDTH, // :
DIGIT_WIDTH, // s
SPACE_WIDTH, // (space)
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // s
],
with_decis,
@@ -533,7 +605,7 @@ where
DIGIT_WIDTH, // m
COLON_WIDTH, // :
DIGIT_WIDTH, // s
SPACE_WIDTH, // (space)
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // s
],
with_decis,
@@ -541,7 +613,7 @@ where
Format::Ss => add_decis(
vec![
DIGIT_WIDTH, // s
SPACE_WIDTH, // (space)
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // s
],
with_decis,
@@ -562,18 +634,35 @@ where
pub fn get_height(&self) -> u16 {
DIGIT_HEIGHT
}
/// Checks whether to blink the clock while rendering.
/// Its logic is based on a given `count` value.
fn should_blink(&self, count_value: &Option<u64>) -> bool {
// Example:
// if `RANGE_OF_DONE_COUNT` is 4
// then for ranges `0..4`, `8..12` etc. it will return `true`
count_value
.map(|b| (b % (RANGE_OF_DONE_COUNT * 2)) < RANGE_OF_DONE_COUNT)
.unwrap_or(false)
}
}
impl<T> StatefulWidget for ClockWidget<T>
where
T: std::fmt::Debug,
{
type State = Clock<T>;
type State = ClockState<T>;
fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
let with_decis = state.with_decis;
let format = state.format;
let symbol = state.style.get_digit_symbol();
// to simulate a blink effect, just use an "empty" symbol (string)
// to "empty" all digits and to have an "empty" render area
let symbol = if self.blink && self.should_blink(&state.done_count) {
" "
} else {
self.style.get_digit_symbol()
};
let widths = self.get_horizontal_lengths(&format, with_decis);
let area = center_horizontal(
area,

View File

@@ -9,6 +9,7 @@ pub const DIGIT_WIDTH: u16 = DIGIT_SIZE as u16;
pub const DIGIT_HEIGHT: u16 = DIGIT_SIZE as u16 + 1 /* border height */;
pub const COLON_WIDTH: u16 = 4; // incl. padding left + padding right
pub const DOT_WIDTH: u16 = 4; // incl. padding left + padding right
pub const DIGIT_SPACE_WIDTH: u16 = 1; // space between digits
#[rustfmt::skip]
const DIGIT_0: [u8; DIGIT_SIZE * DIGIT_SIZE] = [

View File

@@ -1,37 +1,33 @@
use crate::{
common::Style,
common::ClockTypeId,
duration::{ONE_DECI_SECOND, ONE_HOUR, ONE_MINUTE, ONE_SECOND},
widgets::clock::*,
};
use std::time::Duration;
#[test]
fn test_toggle_edit() {
let mut c = Clock::<Timer>::new(ClockArgs {
fn default_args() -> ClockStateArgs {
ClockStateArgs {
initial_value: ONE_HOUR,
current_value: ONE_HOUR,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: true,
});
// off by default
assert!(!c.is_edit_mode());
// toggle on
c.toggle_edit();
assert!(c.is_edit_mode());
// toggle off
c.toggle_edit();
assert!(!c.is_edit_mode());
with_decis: false,
app_tx: None,
}
}
#[test]
fn test_type_id() {
let c = ClockState::<Timer>::new(default_args());
assert!(matches!(c.get_type_id(), ClockTypeId::Timer));
let c = ClockState::<Countdown>::new(default_args());
assert!(matches!(c.get_type_id(), ClockTypeId::Countdown));
}
#[test]
fn test_default_edit_mode_hhmmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
initial_value: ONE_HOUR,
current_value: ONE_HOUR,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
let mut c = ClockState::<Timer>::new(ClockStateArgs {
with_decis: true,
..default_args()
});
// toggle on
@@ -41,12 +37,12 @@ fn test_default_edit_mode_hhmmss() {
#[test]
fn test_default_edit_mode_mmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_MINUTE,
current_value: ONE_MINUTE,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: true,
app_tx: None,
});
// toggle on
c.toggle_edit();
@@ -55,12 +51,12 @@ fn test_default_edit_mode_mmss() {
#[test]
fn test_default_edit_mode_ss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_SECOND,
current_value: ONE_SECOND,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: true,
app_tx: None,
});
// toggle on
c.toggle_edit();
@@ -69,12 +65,12 @@ fn test_default_edit_mode_ss() {
#[test]
fn test_edit_next_hhmmssd() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_HOUR,
current_value: ONE_HOUR,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: true,
app_tx: None,
});
// toggle on
@@ -91,12 +87,12 @@ fn test_edit_next_hhmmssd() {
#[test]
fn test_edit_next_hhmmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_HOUR,
current_value: ONE_HOUR,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
app_tx: None,
});
// toggle on
@@ -111,12 +107,12 @@ fn test_edit_next_hhmmss() {
#[test]
fn test_edit_next_mmssd() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_MINUTE,
current_value: ONE_MINUTE,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: true,
app_tx: None,
});
// toggle on
@@ -131,12 +127,12 @@ fn test_edit_next_mmssd() {
#[test]
fn test_edit_next_mmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_MINUTE,
current_value: ONE_MINUTE,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
app_tx: None,
});
// toggle on
@@ -149,12 +145,12 @@ fn test_edit_next_mmss() {
#[test]
fn test_edit_next_ssd() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_SECOND * 3,
current_value: ONE_SECOND * 3,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: true,
app_tx: None,
});
// toggle on
@@ -165,12 +161,12 @@ fn test_edit_next_ssd() {
#[test]
fn test_edit_next_ss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_SECOND * 3,
current_value: ONE_SECOND * 3,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
app_tx: None,
});
// toggle on
@@ -182,12 +178,12 @@ fn test_edit_next_ss() {
#[test]
fn test_edit_prev_hhmmssd() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_HOUR,
current_value: ONE_HOUR,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: true,
app_tx: None,
});
// toggle on
@@ -203,12 +199,12 @@ fn test_edit_prev_hhmmssd() {
#[test]
fn test_edit_prev_hhmmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_HOUR,
current_value: ONE_HOUR,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
app_tx: None,
});
// toggle on
@@ -222,12 +218,12 @@ fn test_edit_prev_hhmmss() {
#[test]
fn test_edit_prev_mmssd() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_MINUTE,
current_value: ONE_MINUTE,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: true,
app_tx: None,
});
// toggle on
@@ -243,12 +239,12 @@ fn test_edit_prev_mmssd() {
#[test]
fn test_edit_prev_mmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_MINUTE,
current_value: ONE_MINUTE,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
app_tx: None,
});
// toggle on
@@ -262,12 +258,12 @@ fn test_edit_prev_mmss() {
#[test]
fn test_edit_prev_ssd() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_SECOND,
current_value: ONE_SECOND,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: true,
app_tx: None,
});
// toggle on
@@ -281,12 +277,12 @@ fn test_edit_prev_ssd() {
#[test]
fn test_edit_prev_ss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: ONE_SECOND,
current_value: ONE_SECOND,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
app_tx: None,
});
// toggle on
@@ -298,12 +294,12 @@ fn test_edit_prev_ss() {
#[test]
fn test_edit_up_ss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: Duration::ZERO,
current_value: Duration::ZERO,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
with_decis: true,
app_tx: None,
});
// toggle on
@@ -315,12 +311,12 @@ fn test_edit_up_ss() {
#[test]
fn test_edit_up_mmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: Duration::ZERO,
current_value: Duration::from_secs(60),
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
with_decis: true,
app_tx: None,
});
// toggle on
@@ -335,12 +331,12 @@ fn test_edit_up_mmss() {
#[test]
fn test_edit_up_hhmmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: Duration::ZERO,
current_value: Duration::from_secs(3600),
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
with_decis: true,
app_tx: None,
});
// toggle on
@@ -357,12 +353,12 @@ fn test_edit_up_hhmmss() {
#[test]
fn test_edit_down_ss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: Duration::ZERO,
current_value: ONE_SECOND,
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
with_decis: true,
app_tx: None,
});
// toggle on
@@ -378,12 +374,12 @@ fn test_edit_down_ss() {
#[test]
fn test_edit_down_mmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: Duration::ZERO,
current_value: Duration::from_secs(120),
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
with_decis: true,
app_tx: None,
});
// toggle on
@@ -401,12 +397,12 @@ fn test_edit_down_mmss() {
#[test]
fn test_edit_down_hhmmss() {
let mut c = Clock::<Timer>::new(ClockArgs {
let mut c = ClockState::<Timer>::new(ClockStateArgs {
initial_value: Duration::ZERO,
current_value: Duration::from_secs(3600),
tick_value: ONE_DECI_SECOND,
style: Style::default(),
with_decis: false,
with_decis: true,
app_tx: None,
});
// toggle on

View File

@@ -1,3 +1,15 @@
use crate::{
common::{AppTime, Style},
constants::TICK_VALUE_MS,
duration::{DurationEx, MAX_DURATION},
events::{AppEventTx, TuiEvent, TuiEventHandler},
utils::center,
widgets::{
clock::{self, ClockState, ClockStateArgs, ClockWidget, Mode as ClockMode},
edit_time::{EditTimeState, EditTimeStateArgs, EditTimeWidget},
},
};
use crossterm::event::KeyModifiers;
use ratatui::{
buffer::Buffer,
crossterm::event::KeyCode,
@@ -5,69 +17,234 @@ use ratatui::{
text::Line,
widgets::{StatefulWidget, Widget},
};
use std::cmp::max;
use std::ops::Sub;
use std::{cmp::max, time::Duration};
use time::OffsetDateTime;
use crate::{
common::Style,
events::{Event, EventHandler},
utils::center,
widgets::clock::{self, Clock, ClockWidget},
};
#[derive(Debug, Clone)]
pub struct Countdown {
clock: Clock<clock::Countdown>,
pub struct CountdownStateArgs {
pub initial_value: Duration,
pub current_value: Duration,
pub elapsed_value: Duration,
pub app_time: AppTime,
pub with_decis: bool,
pub app_tx: AppEventTx,
}
impl Countdown {
pub const fn new(clock: Clock<clock::Countdown>) -> Self {
Self { clock }
}
/// State for Countdown Widget
pub struct CountdownState {
/// clock to count down
clock: ClockState<clock::Countdown>,
/// clock to count time after `DONE` - similar to Mission Elapsed Time (MET)
elapsed_clock: ClockState<clock::Timer>,
app_time: AppTime,
/// Edit by local time
edit_time: Option<EditTimeState>,
}
pub fn set_style(&mut self, style: Style) {
self.clock.style = style;
impl CountdownState {
pub fn new(args: CountdownStateArgs) -> Self {
let CountdownStateArgs {
initial_value,
current_value,
elapsed_value,
with_decis,
app_time,
app_tx,
} = args;
Self {
clock: ClockState::<clock::Countdown>::new(ClockStateArgs {
initial_value,
current_value,
tick_value: Duration::from_millis(TICK_VALUE_MS),
with_decis,
app_tx: Some(app_tx.clone()),
}),
elapsed_clock: ClockState::<clock::Timer>::new(ClockStateArgs {
initial_value: Duration::ZERO,
current_value: elapsed_value,
tick_value: Duration::from_millis(TICK_VALUE_MS),
with_decis: false,
app_tx: None,
})
.with_name("MET".to_owned())
// A previous `elapsed_value > 0` means the `Clock` was running before,
// but not in `Initial` state anymore. Updating `Mode` here
// is needed to handle `Event::Tick` in `EventHandler::update` properly
.with_mode(if elapsed_value.gt(&Duration::ZERO) {
ClockMode::Pause
} else {
ClockMode::Initial
}),
app_time,
edit_time: None,
}
}
pub fn set_with_decis(&mut self, with_decis: bool) {
self.clock.with_decis = with_decis;
self.elapsed_clock.with_decis = with_decis;
}
pub fn get_clock(&self) -> &Clock<clock::Countdown> {
pub fn get_clock(&self) -> &ClockState<clock::Countdown> {
&self.clock
}
pub fn is_running(&self) -> bool {
self.clock.is_running() || self.elapsed_clock.is_running()
}
pub fn get_elapsed_value(&self) -> &DurationEx {
self.elapsed_clock.get_current_value()
}
pub fn set_app_time(&mut self, app_time: AppTime) {
self.app_time = app_time;
}
fn time_to_edit(&self) -> OffsetDateTime {
// get current value
let d: Duration = (*self.clock.get_current_value()).into();
// transform
let dd = time::Duration::try_from(d).unwrap_or(time::Duration::ZERO);
// substract from `app_time`
OffsetDateTime::from(self.app_time).saturating_add(dd)
}
pub fn min_time_to_edit(&self) -> OffsetDateTime {
OffsetDateTime::from(self.app_time)
}
fn max_time_to_edit(&self) -> OffsetDateTime {
OffsetDateTime::from(self.app_time)
.saturating_add(time::Duration::try_from(MAX_DURATION).unwrap_or(time::Duration::ZERO))
}
fn edit_time_done(&mut self, edit_time: &mut EditTimeState) {
// get diff
let d: time::Duration = edit_time
.get_time()
.sub(OffsetDateTime::from(self.app_time));
// transfrom
let dx: DurationEx = Duration::try_from(d).unwrap_or(Duration::ZERO).into();
// update clock
self.clock.set_current_value(dx);
// remove `edit_time`
self.edit_time = None;
}
pub fn is_clock_edit_mode(&self) -> bool {
self.clock.is_edit_mode()
}
pub fn is_time_edit_mode(&self) -> bool {
self.edit_time.is_some()
}
}
impl EventHandler for Countdown {
fn update(&mut self, event: Event) -> Option<Event> {
let edit_mode = self.clock.is_edit_mode();
impl TuiEventHandler for CountdownState {
fn update(&mut self, event: TuiEvent) -> Option<TuiEvent> {
match event {
Event::Tick => {
TuiEvent::Tick => {
if !self.clock.is_done() {
self.clock.tick();
} else {
self.clock.update_done_count();
self.elapsed_clock.tick();
if self.elapsed_clock.is_initial() {
self.elapsed_clock.run();
}
Event::Key(key) if key.code == KeyCode::Char('r') => {
self.clock.reset();
}
Event::Key(key) => match key.code {
let min_time = self.min_time_to_edit();
let max_time = self.max_time_to_edit();
if let Some(edit_time) = &mut self.edit_time {
edit_time.set_min_time(min_time);
edit_time.set_max_time(max_time);
}
}
TuiEvent::Key(key) => match key.code {
KeyCode::Char('r') => {
// reset both clocks to use intial values
self.clock.reset();
self.elapsed_clock.reset();
// reset `edit_time` back initial value
let time = self.time_to_edit();
if let Some(edit_time) = &mut self.edit_time {
edit_time.set_time(time);
}
}
KeyCode::Char('s') => {
// toggle pause status depending on which clock is running
if !self.clock.is_done() {
self.clock.toggle_pause();
} else {
self.elapsed_clock.toggle_pause();
}
// finish `edit_time` and continue for using `clock`
if let Some(edit_time) = &mut self.edit_time.clone() {
self.edit_time_done(edit_time);
}
}
// STRG + e => toggle edit time
KeyCode::Char('e') if key.modifiers.contains(KeyModifiers::CONTROL) => {
// reset both clocks
self.clock.reset();
self.elapsed_clock.reset();
if let Some(edit_time) = &mut self.edit_time.clone() {
self.edit_time_done(edit_time)
} else {
// update `edit_time`
self.edit_time = Some(EditTimeState::new(EditTimeStateArgs {
time: self.time_to_edit(),
min: self.min_time_to_edit(),
max: self.max_time_to_edit(),
}));
}
}
// e => toggle edit clock
KeyCode::Char('e') => {
// toggle edit mode
self.clock.toggle_edit();
// stop `elapsed_clock`
if self.elapsed_clock.is_running() {
self.elapsed_clock.toggle_pause();
}
KeyCode::Left if edit_mode => {
}
KeyCode::Left if self.is_clock_edit_mode() => {
self.clock.edit_next();
}
KeyCode::Right if edit_mode => {
KeyCode::Left if self.is_time_edit_mode() => {
// safe unwrap because of previous check in `is_time_edit_mode`
self.edit_time.as_mut().unwrap().next();
}
KeyCode::Right if self.is_clock_edit_mode() => {
self.clock.edit_prev();
}
KeyCode::Up if edit_mode => {
self.clock.edit_up();
KeyCode::Right if self.is_time_edit_mode() => {
// safe unwrap because of previous check in `is_time_edit_mode`
self.edit_time.as_mut().unwrap().prev();
}
KeyCode::Down if edit_mode => {
KeyCode::Up if self.is_clock_edit_mode() => {
self.clock.edit_up();
// whenever `clock`'s value is changed, reset `elapsed_clock`
self.elapsed_clock.reset();
}
KeyCode::Up if self.is_time_edit_mode() => {
// safe unwrap because of previous check in `is_time_edit_mode`
self.edit_time.as_mut().unwrap().up();
}
KeyCode::Down if self.is_clock_edit_mode() => {
self.clock.edit_down();
// whenever clock value is changed, reset timer
self.elapsed_clock.reset();
}
KeyCode::Down if self.is_time_edit_mode() => {
// safe unwrap because of previous check in `is_time_edit_mode`
self.edit_time.as_mut().unwrap().down();
}
_ => return Some(event),
},
@@ -77,26 +254,82 @@ impl EventHandler for Countdown {
}
}
pub struct CountdownWidget;
pub struct Countdown {
pub style: Style,
pub blink: bool,
}
impl StatefulWidget for CountdownWidget {
type State = Countdown;
fn human_days_diff(a: &OffsetDateTime, b: &OffsetDateTime) -> String {
let days_diff = (a.date() - b.date()).whole_days();
match days_diff {
0 => "today".to_owned(),
1 => "tomorrow".to_owned(),
n => format!("+{}days", n),
}
}
impl StatefulWidget for Countdown {
type State = CountdownState;
fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
let clock = ClockWidget::new();
let label = Line::raw((format!("Countdown {}", state.clock.get_mode())).to_uppercase());
// render `edit_time` OR `clock`
if let Some(edit_time) = &mut state.edit_time {
let label = Line::raw(
format!(
"Countdown {} {}",
edit_time.get_selected().clone(),
human_days_diff(edit_time.get_time(), &state.app_time.into())
)
.to_uppercase(),
);
let widget = EditTimeWidget::new(self.style);
let area = center(
area,
Constraint::Length(max(widget.get_width(), label.width() as u16)),
Constraint::Length(widget.get_height() + 1 /* height of label */),
);
let [v1, v2] =
Layout::vertical(Constraint::from_lengths([widget.get_height(), 1])).areas(area);
widget.render(v1, buf, edit_time);
label.centered().render(v2, buf);
} else {
let label = Line::raw(
if state.clock.is_done() {
if state.clock.with_decis {
format!(
"Countdown {} +{}",
state.clock.get_mode(),
state
.elapsed_clock
.get_current_value()
.to_string_with_decis()
)
} else {
format!(
"Countdown {} +{}",
state.clock.get_mode(),
state.elapsed_clock.get_current_value()
)
}
} else {
format!("Countdown {}", state.clock.get_mode())
}
.to_uppercase(),
);
let widget = ClockWidget::new(self.style, self.blink);
let area = center(
area,
Constraint::Length(max(
clock.get_width(&state.clock.get_format(), state.clock.with_decis),
widget.get_width(&state.clock.get_format(), state.clock.with_decis),
label.width() as u16,
)),
Constraint::Length(clock.get_height() + 1 /* height of label */),
Constraint::Length(widget.get_height() + 1 /* height of label */),
);
let [v1, v2] =
Layout::vertical(Constraint::from_lengths([clock.get_height(), 1])).areas(area);
Layout::vertical(Constraint::from_lengths([widget.get_height(), 1])).areas(area);
clock.render(v1, buf, &mut state.clock);
widget.render(v1, buf, &mut state.clock);
label.centered().render(v2, buf);
}
}
}

231
src/widgets/edit_time.rs Normal file
View File

@@ -0,0 +1,231 @@
use std::fmt;
use time::OffsetDateTime;
use ratatui::{
buffer::Buffer,
layout::{Constraint, Layout, Rect},
widgets::{StatefulWidget, Widget},
};
use crate::{
common::Style,
widgets::clock_elements::{COLON_WIDTH, Colon, DIGIT_SPACE_WIDTH, DIGIT_WIDTH, Digit},
};
use super::clock_elements::DIGIT_HEIGHT;
#[derive(Debug, Clone)]
pub enum Selected {
Seconds,
Minutes,
Hours,
}
impl Selected {
pub fn next(&self) -> Self {
match self {
Selected::Seconds => Selected::Minutes,
Selected::Minutes => Selected::Hours,
Selected::Hours => Selected::Seconds,
}
}
pub fn prev(&self) -> Self {
match self {
Selected::Seconds => Selected::Hours,
Selected::Minutes => Selected::Seconds,
Selected::Hours => Selected::Minutes,
}
}
}
impl fmt::Display for Selected {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Selected::Seconds => write!(f, "[edit seconds]"),
Selected::Minutes => write!(f, "[edit minutes]"),
Selected::Hours => write!(f, "[edit hours]"),
}
}
}
#[derive(Debug, Clone)]
pub struct EditTimeState {
selected: Selected,
time: OffsetDateTime,
min: OffsetDateTime,
max: OffsetDateTime,
}
#[derive(Debug, Clone)]
pub struct EditTimeStateArgs {
pub time: OffsetDateTime,
pub min: OffsetDateTime,
pub max: OffsetDateTime,
}
impl EditTimeState {
pub fn new(args: EditTimeStateArgs) -> Self {
EditTimeState {
time: args.time,
min: args.min,
max: args.max,
selected: Selected::Minutes,
}
}
pub fn set_time(&mut self, time: OffsetDateTime) {
self.time = time;
}
pub fn set_min_time(&mut self, min: OffsetDateTime) {
self.min = min;
}
pub fn set_max_time(&mut self, min: OffsetDateTime) {
self.max = min;
}
pub fn get_time(&mut self) -> &OffsetDateTime {
&self.time
}
pub fn get_selected(&mut self) -> &Selected {
&self.selected
}
pub fn next(&mut self) {
self.selected = self.selected.next();
}
pub fn prev(&mut self) {
self.selected = self.selected.prev();
}
pub fn up(&mut self) {
self.time = match self.selected {
Selected::Seconds => {
if self
.time
.lt(&self.max.saturating_sub(time::Duration::new(1, 0)))
{
self.time.saturating_add(time::Duration::new(1, 0))
} else {
self.time
}
}
Selected::Minutes => {
if self
.time
.lt(&self.max.saturating_sub(time::Duration::new(60, 0)))
{
self.time.saturating_add(time::Duration::new(60, 0))
} else {
self.time
}
}
Selected::Hours => {
if self
.time
.lt(&self.max.saturating_sub(time::Duration::new(60 * 60, 0)))
{
self.time.saturating_add(time::Duration::new(60 * 60, 0))
} else {
self.time
}
}
}
}
pub fn down(&mut self) {
self.time = match self.selected {
Selected::Seconds => {
if self
.time
.ge(&self.min.saturating_add(time::Duration::new(1, 0)))
{
self.time.saturating_sub(time::Duration::new(1, 0))
} else {
self.time
}
}
Selected::Minutes => {
if self
.time
.ge(&self.min.saturating_add(time::Duration::new(60, 0)))
{
self.time.saturating_sub(time::Duration::new(60, 0))
} else {
self.time
}
}
Selected::Hours => {
if self
.time
.ge(&self.min.saturating_add(time::Duration::new(60 * 60, 0)))
{
self.time.saturating_sub(time::Duration::new(60 * 60, 0))
} else {
self.time
}
}
}
}
}
#[derive(Debug, Clone)]
pub struct EditTimeWidget {
style: Style,
}
impl EditTimeWidget {
pub fn new(style: Style) -> Self {
Self { style }
}
fn get_horizontal_lengths(&self) -> Vec<u16> {
vec![
DIGIT_WIDTH, // h
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // h
COLON_WIDTH, // :
DIGIT_WIDTH, // m
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // m
COLON_WIDTH, // :
DIGIT_WIDTH, // s
DIGIT_SPACE_WIDTH, // (space)
DIGIT_WIDTH, // s
]
}
pub fn get_width(&self) -> u16 {
self.get_horizontal_lengths().iter().sum()
}
pub fn get_height(&self) -> u16 {
DIGIT_HEIGHT
}
}
impl StatefulWidget for EditTimeWidget {
type State = EditTimeState;
fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
let symbol = self.style.get_digit_symbol();
let edit_hours = matches!(state.selected, Selected::Hours);
let edit_minutes = matches!(state.selected, Selected::Minutes);
let edit_secs = matches!(state.selected, Selected::Seconds);
let [hh, _, h, c_hm, mm, _, m, c_ms, ss, _, s] =
Layout::horizontal(Constraint::from_lengths(self.get_horizontal_lengths())).areas(area);
Digit::new((state.time.hour() as u64) / 10, edit_hours, symbol).render(hh, buf);
Digit::new((state.time.hour() as u64) % 10, edit_hours, symbol).render(h, buf);
Colon::new(symbol).render(c_hm, buf);
Digit::new((state.time.minute() as u64) / 10, edit_minutes, symbol).render(mm, buf);
Digit::new((state.time.minute() as u64) % 10, edit_minutes, symbol).render(m, buf);
Colon::new(symbol).render(c_ms, buf);
Digit::new((state.time.second() as u64) / 10, edit_secs, symbol).render(ss, buf);
Digit::new((state.time.second() as u64) % 10, edit_secs, symbol).render(s, buf);
}
}

View File

@@ -1,25 +1,57 @@
use std::collections::BTreeMap;
use crate::common::Content;
use crate::common::{AppEditMode, AppTime, AppTimeFormat, Content};
use ratatui::{
buffer::Buffer,
layout::{Constraint, Layout, Rect},
style::{Modifier, Style},
symbols::{border, scrollbar},
text::{Line, Span},
widgets::{Block, Borders, Cell, Row, Table, Widget},
widgets::{Block, Borders, Cell, Row, StatefulWidget, Table, Widget},
};
#[derive(Debug, Clone)]
pub struct Footer {
pub show_menu: bool,
pub running_clock: bool,
pub selected_content: Content,
pub edit_mode: bool,
pub struct FooterState {
show_menu: bool,
app_time_format: AppTimeFormat,
}
impl Widget for Footer {
fn render(self, area: Rect, buf: &mut Buffer) {
impl FooterState {
pub const fn new(show_menu: bool, app_time_format: AppTimeFormat) -> Self {
Self {
show_menu,
app_time_format,
}
}
pub fn set_show_menu(&mut self, value: bool) {
self.show_menu = value;
}
pub const fn get_show_menu(&self) -> bool {
self.show_menu
}
pub const fn app_time_format(&self) -> &AppTimeFormat {
&self.app_time_format
}
pub fn toggle_app_time_format(&mut self) {
self.app_time_format = self.app_time_format.next();
}
}
#[derive(Debug)]
pub struct Footer {
pub running_clock: bool,
pub selected_content: Content,
pub app_edit_mode: AppEditMode,
pub app_time: AppTime,
}
impl StatefulWidget for Footer {
type State = FooterState;
fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
let content_labels: BTreeMap<Content, &str> = BTreeMap::from([
(Content::Countdown, "[c]ountdown"),
(Content::Timer, "[t]imer"),
@@ -31,15 +63,25 @@ impl Widget for Footer {
let [border_area, menu_area] =
Layout::vertical([Constraint::Length(1), Constraint::Percentage(100)]).areas(area);
Block::new()
.borders(Borders::TOP)
.title(
format! {"[m]enu {:} ", if self.show_menu {scrollbar::VERTICAL.end} else {scrollbar::VERTICAL.begin}},
format! {"[m]enu {:} ", if state.show_menu {scrollbar::VERTICAL.end} else {scrollbar::VERTICAL.begin}},
)
.title(
Line::from(
match state.app_time_format {
// `Hidden` -> no (empty) title
AppTimeFormat::Hidden => "".into(),
// others -> add some space around
_ => format!(" {} ", self.app_time.format(&state.app_time_format))
}
).right_aligned())
.border_set(border::PLAIN)
.render(border_area, buf);
// show menu
if self.show_menu {
if state.show_menu {
let content_labels: Vec<Span> = content_labels
.iter()
.enumerate()
@@ -60,7 +102,7 @@ impl Widget for Footer {
const SPACE: &str = " "; // 2 empty spaces
let widths = [Constraint::Length(12), Constraint::Percentage(100)];
Table::new(
let table = Table::new(
[
// content
Row::new(vec![
@@ -80,6 +122,14 @@ impl Widget for Footer {
Span::from("[,]change style"),
Span::from(SPACE),
Span::from("[.]toggle deciseconds"),
Span::from(SPACE),
Span::from(format!(
"[:]toggle {} time",
match self.app_time {
AppTime::Local(_) => "local",
AppTime::Utc(_) => "utc",
}
)),
])),
]),
// edit
@@ -89,21 +139,8 @@ impl Widget for Footer {
Style::default().add_modifier(Modifier::BOLD),
)),
Cell::from(Line::from({
if self.edit_mode {
vec![
Span::from("[e]dit done"),
Span::from(SPACE),
Span::from(format!(
"[{} {}]edit selection",
scrollbar::HORIZONTAL.begin,
scrollbar::HORIZONTAL.end
)), // ← →,
Span::from(SPACE),
Span::from(format!("[{}]edit up", scrollbar::VERTICAL.begin)), // ↑
Span::from(SPACE),
Span::from(format!("[{}]edit up", scrollbar::VERTICAL.end)), // ↓,
]
} else {
match self.app_edit_mode {
AppEditMode::None => {
let mut spans = vec![
Span::from(if self.running_clock {
"[s]top"
@@ -115,6 +152,12 @@ impl Widget for Footer {
Span::from(SPACE),
Span::from("[e]dit"),
];
if self.selected_content == Content::Countdown {
spans.extend_from_slice(&[
Span::from(SPACE),
Span::from("[^e]dit by local time"),
]);
}
if self.selected_content == Content::Pomodoro {
spans.extend_from_slice(&[
Span::from(SPACE),
@@ -123,13 +166,32 @@ impl Widget for Footer {
}
spans
}
others => vec![
Span::from(match others {
AppEditMode::Clock => "[e]dit done",
AppEditMode::Time => "[^e]dit done",
_ => "",
}),
Span::from(SPACE),
Span::from(format!(
"[{} {}]edit selection",
scrollbar::HORIZONTAL.begin,
scrollbar::HORIZONTAL.end
)), // ← →,
Span::from(SPACE),
Span::from(format!("[{}]edit up", scrollbar::VERTICAL.begin)), // ↑
Span::from(SPACE),
Span::from(format!("[{}]edit up", scrollbar::VERTICAL.end)), // ↓,
],
}
})),
]),
],
widths,
)
.column_spacing(1)
.render(menu_area, buf);
.column_spacing(1);
Widget::render(table, menu_area, buf);
}
}
}

View File

@@ -1,9 +1,9 @@
use crate::{
common::Style,
constants::TICK_VALUE_MS,
events::{Event, EventHandler},
events::{AppEventTx, TuiEvent, TuiEventHandler},
utils::center,
widgets::clock::{Clock, ClockWidget, Countdown},
widgets::clock::{ClockState, ClockStateArgs, ClockWidget, Countdown},
};
use ratatui::{
buffer::Buffer,
@@ -12,13 +12,9 @@ use ratatui::{
text::Line,
widgets::{StatefulWidget, Widget},
};
use std::{cmp::max, time::Duration};
use strum::Display;
use serde::{Deserialize, Serialize};
use super::clock::ClockArgs;
use std::{cmp::max, time::Duration};
use strum::Display;
#[derive(Debug, Clone, Display, Hash, Eq, PartialEq, Deserialize, Serialize)]
pub enum Mode {
@@ -26,20 +22,19 @@ pub enum Mode {
Pause,
}
#[derive(Debug, Clone)]
pub struct ClockMap {
work: Clock<Countdown>,
pause: Clock<Countdown>,
work: ClockState<Countdown>,
pause: ClockState<Countdown>,
}
impl ClockMap {
fn get_mut(&mut self, mode: &Mode) -> &mut Clock<Countdown> {
fn get_mut(&mut self, mode: &Mode) -> &mut ClockState<Countdown> {
match mode {
Mode::Work => &mut self.work,
Mode::Pause => &mut self.pause,
}
}
fn get(&self, mode: &Mode) -> &Clock<Countdown> {
fn get(&self, mode: &Mode) -> &ClockState<Countdown> {
match mode {
Mode::Work => &self.work,
Mode::Pause => &self.pause,
@@ -47,67 +42,68 @@ impl ClockMap {
}
}
#[derive(Debug, Clone)]
pub struct Pomodoro {
pub struct PomodoroState {
mode: Mode,
clock_map: ClockMap,
}
pub struct PomodoroArgs {
pub struct PomodoroStateArgs {
pub mode: Mode,
pub initial_value_work: Duration,
pub current_value_work: Duration,
pub initial_value_pause: Duration,
pub current_value_pause: Duration,
pub style: Style,
pub with_decis: bool,
pub app_tx: AppEventTx,
}
impl Pomodoro {
pub fn new(args: PomodoroArgs) -> Self {
let PomodoroArgs {
impl PomodoroState {
pub fn new(args: PomodoroStateArgs) -> Self {
let PomodoroStateArgs {
mode,
initial_value_work,
current_value_work,
initial_value_pause,
current_value_pause,
style,
with_decis,
app_tx,
} = args;
Self {
mode,
clock_map: ClockMap {
work: Clock::<Countdown>::new(ClockArgs {
work: ClockState::<Countdown>::new(ClockStateArgs {
initial_value: initial_value_work,
current_value: current_value_work,
tick_value: Duration::from_millis(TICK_VALUE_MS),
style,
with_decis,
}),
pause: Clock::<Countdown>::new(ClockArgs {
app_tx: Some(app_tx.clone()),
})
.with_name("Work".to_owned()),
pause: ClockState::<Countdown>::new(ClockStateArgs {
initial_value: initial_value_pause,
current_value: current_value_pause,
tick_value: Duration::from_millis(TICK_VALUE_MS),
style,
with_decis,
}),
app_tx: Some(app_tx),
})
.with_name("Pause".to_owned()),
},
}
}
fn get_clock_mut(&mut self) -> &mut Clock<Countdown> {
fn get_clock_mut(&mut self) -> &mut ClockState<Countdown> {
self.clock_map.get_mut(&self.mode)
}
pub fn get_clock(&self) -> &Clock<Countdown> {
pub fn get_clock(&self) -> &ClockState<Countdown> {
self.clock_map.get(&self.mode)
}
pub fn get_clock_work(&self) -> &Clock<Countdown> {
pub fn get_clock_work(&self) -> &ClockState<Countdown> {
&self.clock_map.work
}
pub fn get_clock_pause(&self) -> &Clock<Countdown> {
pub fn get_clock_pause(&self) -> &ClockState<Countdown> {
&self.clock_map.pause
}
@@ -115,11 +111,6 @@ impl Pomodoro {
&self.mode
}
pub fn set_style(&mut self, style: Style) {
self.clock_map.work.style = style;
self.clock_map.pause.style = style;
}
pub fn set_with_decis(&mut self, with_decis: bool) {
self.clock_map.work.with_decis = with_decis;
self.clock_map.pause.with_decis = with_decis;
@@ -133,14 +124,15 @@ impl Pomodoro {
}
}
impl EventHandler for Pomodoro {
fn update(&mut self, event: Event) -> Option<Event> {
impl TuiEventHandler for PomodoroState {
fn update(&mut self, event: TuiEvent) -> Option<TuiEvent> {
let edit_mode = self.get_clock().is_edit_mode();
match event {
Event::Tick => {
TuiEvent::Tick => {
self.get_clock_mut().tick();
self.get_clock_mut().update_done_count();
}
Event::Key(key) => match key.code {
TuiEvent::Key(key) => match key.code {
KeyCode::Char('s') => {
self.get_clock_mut().toggle_pause();
}
@@ -177,12 +169,15 @@ impl EventHandler for Pomodoro {
}
}
pub struct PomodoroWidget;
pub struct PomodoroWidget {
pub style: Style,
pub blink: bool,
}
impl StatefulWidget for PomodoroWidget {
type State = Pomodoro;
type State = PomodoroState;
fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
let clock_widget = ClockWidget::new();
let clock_widget = ClockWidget::new(self.style, self.blink);
let label = Line::raw(
(format!(
"Pomodoro {} {}",

View File

@@ -1,8 +1,8 @@
use crate::{
common::Style,
events::{Event, EventHandler},
events::{TuiEvent, TuiEventHandler},
utils::center,
widgets::clock::{self, Clock, ClockWidget},
widgets::clock::{self, ClockState, ClockWidget},
};
use ratatui::{
buffer::Buffer,
@@ -13,37 +13,33 @@ use ratatui::{
};
use std::cmp::max;
#[derive(Debug, Clone)]
pub struct Timer {
clock: Clock<clock::Timer>,
pub struct TimerState {
clock: ClockState<clock::Timer>,
}
impl Timer {
pub const fn new(clock: Clock<clock::Timer>) -> Self {
impl TimerState {
pub const fn new(clock: ClockState<clock::Timer>) -> Self {
Self { clock }
}
pub fn set_style(&mut self, style: Style) {
self.clock.style = style;
}
pub fn set_with_decis(&mut self, with_decis: bool) {
self.clock.with_decis = with_decis;
}
pub fn get_clock(&self) -> &Clock<clock::Timer> {
pub fn get_clock(&self) -> &ClockState<clock::Timer> {
&self.clock
}
}
impl EventHandler for Timer {
fn update(&mut self, event: Event) -> Option<Event> {
impl TuiEventHandler for TimerState {
fn update(&mut self, event: TuiEvent) -> Option<TuiEvent> {
let edit_mode = self.clock.is_edit_mode();
match event {
Event::Tick => {
TuiEvent::Tick => {
self.clock.tick();
self.clock.update_done_count();
}
Event::Key(key) => match key.code {
TuiEvent::Key(key) => match key.code {
KeyCode::Char('s') => {
self.clock.toggle_pause();
}
@@ -73,13 +69,16 @@ impl EventHandler for Timer {
}
}
pub struct TimerWidget;
pub struct Timer {
pub style: Style,
pub blink: bool,
}
impl StatefulWidget for &TimerWidget {
type State = Timer;
impl StatefulWidget for Timer {
type State = TimerState;
fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State) {
let clock = &mut state.clock;
let clock_widget = ClockWidget::new();
let clock_widget = ClockWidget::new(self.style, self.blink);
let label = Line::raw((format!("Timer {}", clock.get_mode())).to_uppercase());
let area = center(