hashcards 0.3.0

A plain text-based spaced repetition system.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

// Copyright 2025 Fernando Borretti
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::fmt::Display;
use std::fmt::Formatter;

use clap::ValueEnum;
use serde::Serialize;

use crate::collection::Collection;
use crate::error::Fallible;
use crate::types::date::Date;

#[derive(ValueEnum, Clone)]
pub enum StatsFormat {
    /// HTML output.
    Html,
    /// JSON output.
    Json,
}

impl Display for StatsFormat {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            StatsFormat::Html => write!(f, "html"),
            StatsFormat::Json => write!(f, "json"),
        }
    }
}

pub fn print_stats(directory: Option<String>, format: StatsFormat) -> Fallible<()> {
    let stats = get_stats(directory)?;
    // Print.
    match format {
        StatsFormat::Html => {
            eprintln!("HTML output is not implemented yet.");
        }
        StatsFormat::Json => {
            let stats_json = serde_json::to_string_pretty(&stats)?;
            println!("{}", stats_json);
        }
    }
    Ok(())
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Stats {
    cards_in_deck_count: usize,
    cards_in_db_count: usize,
    tex_macro_count: usize,
    cards_reviewed_today_count: usize,
}

fn get_stats(directory: Option<String>) -> Fallible<Stats> {
    let coll = Collection::new(directory)?;
    let cards_in_db_count = coll.db.card_hashes()?.len();
    let today = Date::today();
    let stats = Stats {
        cards_in_deck_count: coll.cards.len(),
        cards_in_db_count,
        tex_macro_count: coll.macros.len(),
        cards_reviewed_today_count: coll.db.count_reviews_in_date(today)?,
    };
    Ok(stats)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::helper::create_tmp_copy_of_test_directory;

    #[test]
    fn test_display_stats_format() {
        assert_eq!(StatsFormat::Html.to_string(), "html");
        assert_eq!(StatsFormat::Json.to_string(), "json");
    }

    #[test]
    fn test_print_stats_json() -> Fallible<()> {
        let directory = create_tmp_copy_of_test_directory()?;
        print_stats(Some(directory), StatsFormat::Json)?;
        Ok(())
    }

    #[test]
    fn test_get_stats() -> Fallible<()> {
        let directory = create_tmp_copy_of_test_directory()?;
        let stats = get_stats(Some(directory)).unwrap();
        let Stats {
            cards_in_deck_count,
            cards_in_db_count,
            tex_macro_count,
            cards_reviewed_today_count,
        } = stats;
        assert_eq!(cards_in_deck_count, 2);
        assert_eq!(cards_in_db_count, 0);
        assert_eq!(tex_macro_count, 1);
        assert_eq!(cards_reviewed_today_count, 0);
        Ok(())
    }
}