Initial commit

This commit is contained in:
Ryan Heywood 2024-11-20 11:51:47 -05:00
commit 3a9bc55a22
Signed by: ryan
GPG Key ID: 8E401478A3FBEF72
4 changed files with 512 additions and 0 deletions

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
/target
*.json
*.json.bak

314
Cargo.lock generated Normal file
View File

@ -0,0 +1,314 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 3
[[package]]
name = "anstream"
version = "0.6.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8acc5369981196006228e28809f761875c0327210a891e941f4c683b3a99529b"
dependencies = [
"anstyle",
"anstyle-parse",
"anstyle-query",
"anstyle-wincon",
"colorchoice",
"is_terminal_polyfill",
"utf8parse",
]
[[package]]
name = "anstyle"
version = "1.0.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9"
[[package]]
name = "anstyle-parse"
version = "0.2.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3b2d16507662817a6a20a9ea92df6652ee4f94f914589377d69f3b21bc5798a9"
dependencies = [
"utf8parse",
]
[[package]]
name = "anstyle-query"
version = "1.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "79947af37f4177cfead1110013d678905c37501914fba0efea834c3fe9a8d60c"
dependencies = [
"windows-sys",
]
[[package]]
name = "anstyle-wincon"
version = "3.0.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2109dbce0e72be3ec00bed26e6a7479ca384ad226efdd66db8fa2e3a38c83125"
dependencies = [
"anstyle",
"windows-sys",
]
[[package]]
name = "autocfg"
version = "1.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ace50bade8e6234aa140d9a2f552bbee1db4d353f69b8217bc503490fc1a9f26"
[[package]]
name = "chrono"
version = "0.4.38"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a21f936df1771bf62b77f047b726c4625ff2e8aa607c01ec06e5a05bd8463401"
dependencies = [
"num-traits",
]
[[package]]
name = "clap"
version = "4.5.21"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fb3b4b9e5a7c7514dfa52869339ee98b3156b0bfb4e8a77c4ff4babb64b1604f"
dependencies = [
"clap_builder",
"clap_derive",
]
[[package]]
name = "clap_builder"
version = "4.5.21"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b17a95aa67cc7b5ebd32aa5370189aa0d79069ef1c64ce893bd30fb24bff20ec"
dependencies = [
"anstream",
"anstyle",
"clap_lex",
"strsim",
]
[[package]]
name = "clap_derive"
version = "4.5.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4ac6a0c7b1a9e9a5186361f67dfa1b88213572f427fb9ab038efb2bd8c582dab"
dependencies = [
"heck",
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "clap_lex"
version = "0.7.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "afb84c814227b90d6895e01398aee0d8033c00e7466aca416fb6a8e0eb19d8a7"
[[package]]
name = "colorchoice"
version = "1.0.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5b63caa9aa9397e2d9480a9b13673856c78d8ac123288526c37d7839f2a86990"
[[package]]
name = "heck"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
[[package]]
name = "is_terminal_polyfill"
version = "1.70.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
[[package]]
name = "itoa"
version = "1.0.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7a73e9fe3c49d7afb2ace819fa181a287ce54a0983eda4e0eb05c22f82ffe534"
[[package]]
name = "memchr"
version = "2.7.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
[[package]]
name = "num-traits"
version = "0.2.19"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
dependencies = [
"autocfg",
]
[[package]]
name = "proc-macro2"
version = "1.0.89"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f139b0662de085916d1fb67d2b4169d1addddda1919e696f3252b740b629986e"
dependencies = [
"unicode-ident",
]
[[package]]
name = "punchin"
version = "0.1.0"
dependencies = [
"chrono",
"clap",
"serde",
"serde_json",
]
[[package]]
name = "quote"
version = "1.0.37"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b5b9d34b8991d19d98081b46eacdd8eb58c6f2b201139f7c5f643cc155a633af"
dependencies = [
"proc-macro2",
]
[[package]]
name = "ryu"
version = "1.0.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f3cb5ba0dc43242ce17de99c180e96db90b235b8a9fdc9543c96d2209116bd9f"
[[package]]
name = "serde"
version = "1.0.215"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6513c1ad0b11a9376da888e3e0baa0077f1aed55c17f50e7b2397136129fb88f"
dependencies = [
"serde_derive",
]
[[package]]
name = "serde_derive"
version = "1.0.215"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ad1e866f866923f252f05c889987993144fb74e722403468a4ebd70c3cd756c0"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "serde_json"
version = "1.0.133"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c7fceb2473b9166b2294ef05efcb65a3db80803f0b03ef86a5fc88a2b85ee377"
dependencies = [
"itoa",
"memchr",
"ryu",
"serde",
]
[[package]]
name = "strsim"
version = "0.11.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
[[package]]
name = "syn"
version = "2.0.87"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "25aa4ce346d03a6dcd68dd8b4010bcb74e54e62c90c573f394c46eae99aba32d"
dependencies = [
"proc-macro2",
"quote",
"unicode-ident",
]
[[package]]
name = "unicode-ident"
version = "1.0.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "adb9e6ca4f869e1180728b7950e35922a7fc6397f7b641499e8f3ef06e50dc83"
[[package]]
name = "utf8parse"
version = "0.2.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
[[package]]
name = "windows-sys"
version = "0.59.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
dependencies = [
"windows-targets",
]
[[package]]
name = "windows-targets"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
dependencies = [
"windows_aarch64_gnullvm",
"windows_aarch64_msvc",
"windows_i686_gnu",
"windows_i686_gnullvm",
"windows_i686_msvc",
"windows_x86_64_gnu",
"windows_x86_64_gnullvm",
"windows_x86_64_msvc",
]
[[package]]
name = "windows_aarch64_gnullvm"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
[[package]]
name = "windows_aarch64_msvc"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
[[package]]
name = "windows_i686_gnu"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
[[package]]
name = "windows_i686_gnullvm"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
[[package]]
name = "windows_i686_msvc"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
[[package]]
name = "windows_x86_64_gnu"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
[[package]]
name = "windows_x86_64_gnullvm"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
[[package]]
name = "windows_x86_64_msvc"
version = "0.52.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"

10
Cargo.toml Normal file
View File

@ -0,0 +1,10 @@
[package]
name = "punchin"
version = "0.1.0"
edition = "2021"
[dependencies]
chrono = { version = "0.4.38", default-features = false, features = ["std"] }
clap = { version = "4.5.21", features = ["derive"] }
serde = { version = "1.0.215", features = ["derive"] }
serde_json = "1.0.133"

185
src/main.rs Normal file
View File

@ -0,0 +1,185 @@
use std::path::PathBuf;
use std::io::Write;
use std::time::{SystemTime, Duration};
use chrono::{DateTime, offset::Utc};
use serde::{Deserialize, Serialize};
use clap::Parser;
const SECONDS_IN_MINUTE: u64 = 60;
#[derive(clap::ValueEnum, Clone, Debug)]
enum ReportFormat {
Markdown,
#[allow(clippy::upper_case_acronyms)]
CSV,
}
#[derive(clap::ValueEnum, Clone, Debug)]
enum ReportTimescale {
Hours,
Minutes,
}
impl std::fmt::Display for ReportTimescale {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
ReportTimescale::Hours => write!(f, "h"),
ReportTimescale::Minutes => write!(f, "m"),
}
}
}
impl ReportTimescale {
fn header(&self) -> &'static str {
match self {
ReportTimescale::Hours => "Hours",
ReportTimescale::Minutes => "Minutes",
}
}
fn divisor(&self) -> f64 {
match self {
ReportTimescale::Hours => 60f64 * 60f64,
ReportTimescale::Minutes => 60f64,
}
}
}
#[derive(Parser)]
enum PunchIn {
Start {
/// The file to store time-tracking information.
file: PathBuf,
/// Round up to this many minutes.
#[arg(long, default_value = "30")]
round_up_to: u64,
},
Report {
/// The format to generate the report in.
#[arg(long, value_enum, default_value_t = ReportFormat::Markdown)]
format: ReportFormat,
/// The timescale to represent tracked time as.
#[arg(long, value_enum, default_value_t = ReportTimescale::Hours)]
timescale: ReportTimescale,
/// The file to store time-tracking information.
file: PathBuf,
}
}
#[derive(Serialize, Deserialize, Clone, Debug)]
struct TimeTracking {
start: SystemTime,
end: Duration,
project: String,
}
fn main() {
let args = PunchIn::parse();
match args {
PunchIn::Start { file: path, round_up_to } => {
let tt = if std::fs::exists(&path).is_ok_and(|v| v) {
let file = std::fs::File::open(&path).unwrap();
let mut tt: Vec<TimeTracking> = serde_json::from_reader(&file).unwrap();
start(&mut tt, round_up_to);
let mut new_path = path.clone();
let mut new_filename = new_path
.components()
.last()
.unwrap()
.as_os_str()
.to_os_string();
new_path.pop();
new_filename.push(".bak");
new_path.push(new_filename);
std::fs::rename(&path, new_path).unwrap();
tt
} else {
let mut tt = vec![];
start(&mut tt, round_up_to);
tt
};
println!("Writing to file: {tt:?}");
std::fs::write(&path, serde_json::to_string(&tt).unwrap()).unwrap();
},
PunchIn::Report { format: ReportFormat::Markdown, timescale, file: path } => {
let header = timescale.header();
println!("| Date | {header} | Project |");
println!("|------------|-{}-|---------|", String::from("-").repeat(header.len()));
let file = std::fs::File::open(&path).unwrap();
let tt: Vec<TimeTracking> = serde_json::from_reader(&file).unwrap();
for entry in tt {
let date = DateTime::<Utc>::from(entry.start);
println!("| {date} | {duration:>4}{timescale} | {project} |",
date = date.date_naive(),
duration = entry.end.as_secs() as f64 / timescale.divisor(),
project = entry.project,
);
}
},
PunchIn::Report { format: ReportFormat::CSV, timescale, file: path } => {
let header = timescale.header().to_lowercase();
println!("date,{header},project");
let file = std::fs::File::open(&path).unwrap();
let tt: Vec<TimeTracking> = serde_json::from_reader(&file).unwrap();
for entry in tt {
let date = DateTime::<Utc>::from(entry.start);
println!("{date},{duration}{timescale},{project}",
date = date.date_naive(),
duration = entry.end.as_secs() as f64 / timescale.divisor(),
project = entry.project,
);
}
},
}
}
fn start(tt: &mut Vec<TimeTracking>, round_up_to: u64) {
println!("Welcome to PunchIn, the #1 Distrust-recommended software for timetracking!");
let time_modulus = round_up_to * SECONDS_IN_MINUTE;
let mut lines = std::io::stdin().lines();
let stdout = std::io::stdout();
let mut last_time = SystemTime::now();
let mut last_project = String::new();
loop {
println!();
println!("Enter the project you're working on, or send EOL to terminate. When starting");
println!("work on a new project, or when sending EOL, your time will be locked in for");
println!("the current project");
print!("Project: ");
stdout.lock().flush().unwrap();
let mut has_line = false;
let line = lines.next();
// invariant: because line is never empty, last_project is only empty on first run
if !last_project.is_empty() {
// append the last project to the tt list
let elapsed_secs = last_time.elapsed().unwrap().as_secs();
// TODO: Rounding error: If this somehow gets to _exactly_ a round_up_to boundary, to
// the second, it will round up. Is there a better math way to do this?
let rounded_secs = elapsed_secs + time_modulus -
((elapsed_secs + time_modulus) % time_modulus);
tt.push(TimeTracking {
start: last_time,
// Assume the human is not faster than the machine's ability to go back in time.
end: Duration::from_secs(rounded_secs),
project: last_project.clone(),
});
}
if let Some(Ok(line)) = line {
if !line.is_empty() {
has_line = true;
println!("Starting tracking for: {line}");
last_project = line;
last_time = SystemTime::now();
}
}
if !has_line {
break;
}
}
}