;;; gnosis-dashboard.el --- Spaced Repetition Algorithm for Gnosis -*- lexical-binding: t; -*- ;; Copyright (C) 2024 Thanos Apollo ;; Author: Thanos Apollo ;; Keywords: extensions ;; URL: https://git.thanosapollo.org/gnosis ;; Version: 0.0.1 ;; Package-Requires: ((emacs "27.2") (compat "29.1.4.2")) ;; This program is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. ;; This program is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with this program. If not, see . ;;; Commentary: ;; This an extension of gnosis.el ;;; Code: (require 'cl-lib) (require 'calendar) (declare-function gnosis-select "gnosis.el") (declare-function gnosis-delete-note "gnosis.el") (declare-function gnosis-suspend-note "gnosis.el") (declare-function gnosis-collect-note-ids "gnosis.el") (declare-function gnosis-edit-deck "gnosis.el") (declare-function gnosis-edit-note "gnosis.el") (declare-function gnosis-delete-deck "gnosis.el") (declare-function gnosis-suspend-deck "gnosis.el") (declare-function gnosis-add-deck "gnosis.el") (declare-function gnosis-add-note "gnosis.el") (declare-function gnosis-insert-separator "gnosis.el") (declare-function gnosis-get-date-total-notes "gnosis.el") (declare-function gnosis-center-string "gnosis.el") (declare-function gnosis-get-date-new-notes "gnosis.el") (declare-function gnosis-review-get-due-notes "gnosis.el") (defcustom gnosis-dashboard-months 2 "Number of additional months to display on dashboard." :type 'integer :group 'gnosis) (defvar gnosis-dashboard-note-ids nil "Store note ids for dashboard.") (defvar gnosis-dashboard-search-value nil "Store search value.") (defface gnosis-dashboard-header-face '((t :inherit (outline-1) :weight bold)) "Face for the dashboard header.." :group 'gnosis) (defun gnosis-dashboard-generate-dates (&optional year) "Return a list of all dates (year month day) for YEAR." (let* ((current-year (or (decoded-time-year (decode-time)) year)) (result '())) (dotimes (month 12) (let ((days-in-month (calendar-last-day-of-month (+ month 1) current-year))) (dotimes (day days-in-month) (push (list current-year (+ month 1) (+ day 1)) result)))) (nreverse result))) (defun gnosis-dashboard-year-stats (&optional year) "Return YEAR review stats." (let ((notes nil)) (cl-loop for date in (gnosis-dashboard-generate-dates (and year)) do (setq notes (append notes (list (gnosis-get-date-total-notes date))))) notes)) (defun gnosis-dashboard-month-reviews (month) "Return reviewes for MONTH in current year." (cl-assert (and (integerp month) (< month 12)) nil "Month must be an integer, lower than 12.") (let* ((month-dates (cl-loop for date in (gnosis-dashboard-generate-dates) if (and (= (nth 1 date) month) (= (nth 0 date) (decoded-time-year (decode-time)))) collect date)) (month-reviews (cl-loop for date in month-dates collect (gnosis-get-date-total-notes date)))) month-reviews)) ;; TODO: Optionally, add dates where no review was made. (defun gnosis-dashboard-output-average-rev () "Output the average daily notes reviewed for current year. Skips days where no note was reviewed." (let ((total 0) (entries (gnosis-dashboard-year-stats))) (cl-loop for entry in entries do (setq total (+ total entry))) (/ total (length (remove 0 entries))))) ;; TODO: Add more conds & faces (defun gnosis-dashboard--graph-propertize (string num) "Propertize STRING depending on the NUM of reviews." (cond ((= num 0) (propertize string 'face 'shadow)) ((> num 0) (propertize string 'face 'font-lock-constant-face)))) (defun gnosis-dashboard-reviews-graph (dates &optional remove-spaces) (defun gnosis-dashboard--add-padding (str-length) "Add padding for STR-LENGTH." (let ((padding (/ (- (window-width) str-length) 2))) (make-string padding ?\s))) (defun gnosis-dashboard-reviews-graph (dates &optional ) "Insert graph for month DATES. Optionally, use REMOVE-SPACES when using multiple months." (let ((count 0) (insert-column (current-column))) (cl-loop for day in dates when (= count 0) do (let ((current-column (current-column))) (and (< (move-to-column insert-column) insert-column) ;; TODO: Rewrite this! (insert (make-string (- (- insert-column current-column) remove-spaces) ?\s)))) (insert " ") do (end-of-line) (insert (gnosis-dashboard--graph-propertize (format "[%s] " (if (= day 0) "-" "x")) day)) (cl-incf count) when (= count 7) do (setq count 0) (end-of-line) (when (and (/= (forward-line 1) 0) (eobp)) (insert "\n") (forward-line 0))))) ;; TODO: Refactor this! (defun gnosis-dashboard-month-overview () "Insert the 3 month overview." (let ((point (point))) (gnosis-dashboard-reviews-graph (gnosis-dashboard-month-reviews 7) 0) (goto-char point) (end-of-line) (gnosis-dashboard-reviews-graph (gnosis-dashboard-month-reviews 8) 15) (goto-char point) (end-of-line) (gnosis-dashboard-reviews-graph (gnosis-dashboard-month-reviews 9) 46))) ;; TODO: Create a dashboard utilizing widgets (defun gnosis-dashboard-test () "Test function to create an editable field and a search button." (interactive) (let ((buffer-name "*Gnosis Dashboard*")) (when (get-buffer buffer-name) (kill-buffer buffer-name)) ;; Kill the existing buffer if it exists (let ((buffer (get-buffer-create buffer-name))) (with-current-buffer buffer (widget-insert "\n" (gnosis-center-string (format "%s" (propertize "Gnosis Dashboard" 'face 'gnosis-dashboard-header-face)))) (gnosis-insert-separator) (widget-insert (gnosis-center-string (propertize "Stats:" 'face 'outline-3)) "\n") (widget-insert (gnosis-center-string (format "Reviewed today: %s | New: %s" (propertize (number-to-string (gnosis-get-date-total-notes)) 'face 'font-lock-variable-use-face) (propertize (number-to-string (gnosis-get-date-new-notes)) 'face 'font-lock-keyword-face)))) (insert "\n") (widget-insert (gnosis-center-string (format "Daily Average: %s" (propertize (number-to-string (gnosis-dashboard-output-average-rev)) 'face 'font-lock-type-face)))) (insert "\n") (widget-insert (gnosis-center-string (format "Due notes: %s" (propertize (number-to-string (length (gnosis-review-get-due-notes))) 'face 'error)))) (insert "\n\n") (gnosis-dashboard-month-overview) (use-local-map widget-keymap) (widget-setup)) (pop-to-buffer-same-window buffer)))) (defun gnosis-dashboard-output-note (id) "Output contents for note with ID, formatted for gnosis dashboard." (cl-loop for item in (append (gnosis-select '[main options answer tags type] 'notes `(= id ,id) t) (gnosis-select 'suspend 'review-log `(= id ,id) t)) if (listp item) collect (mapconcat #'identity item ",") else collect (replace-regexp-in-string "\n" " " (format "%s" item)))) (defun gnosis-dashboard-output-notes (note-ids) "Return NOTE-IDS contents on gnosis dashboard." (cl-assert (listp note-ids) t "`note-ids' must be a list of note ids.") (pop-to-buffer-same-window "*gnosis-dashboard*") (gnosis-dashboard-mode) (setf tabulated-list-format `[("Main" ,(/ (window-width) 4) t) ("Options" ,(/ (window-width) 6) t) ("Answer" ,(/ (window-width) 6) t) ("Tags" ,(/ (window-width) 5) t) ("Type" ,(/ (window-width) 10) T) ("Suspend" ,(/ (window-width) 6) t)] tabulated-list-entries (cl-loop for id in note-ids for output = (gnosis-dashboard-output-note id) when output collect (list (number-to-string id) (vconcat output))) gnosis-dashboard-note-ids note-ids) (tabulated-list-init-header) ;; Keybindings, for editing, suspending, deleting notes. ;; We use `local-set-key' to bind keys to the buffer to avoid ;; conflicts when using the dashboard for displaying either notes ;; or decks. (local-set-key (kbd "e") #'gnosis-dashboard-edit-note) (local-set-key (kbd "s") #'(lambda () (interactive) (gnosis-suspend-note (string-to-number (tabulated-list-get-id))) (gnosis-dashboard-output-notes gnosis-dashboard-note-ids) (revert-buffer t t t))) (local-set-key (kbd "a") #'gnosis-add-note) (local-set-key (kbd "r") #'gnosis-dashboard) (local-set-key (kbd "d") #'(lambda () (interactive) (gnosis-delete-note (string-to-number (tabulated-list-get-id))) (gnosis-dashboard-output-notes gnosis-dashboard-note-ids) (revert-buffer t t t))) (local-unset-key (kbd "RET"))) (defun gnosis-dashboard-deck-note-count (id) "Return total note count for deck with ID." (let ((note-count (length (gnosis-select 'id 'notes `(= deck-id ,id) t)))) (when (gnosis-select 'id 'decks `(= id ,id)) (list (number-to-string note-count))))) (defun gnosis-dashboard-output-deck (id) "Output contents from deck with ID, formatted for gnosis dashboard." (cl-loop for item in (append (gnosis-select '[name failure-factor ef-increase ef-decrease ef-threshold initial-interval] 'decks `(= id ,id) t) (mapcar 'string-to-number (gnosis-dashboard-deck-note-count id))) when (listp item) do (cl-remove-if (lambda (x) (and (vectorp x) (zerop (length x)))) item) collect (format "%s" item))) (defun gnosis-dashboard-output-decks () "Return deck contents for gnosis dashboard." (pop-to-buffer-same-window "*gnosis-dashboard*") (gnosis-dashboard-mode) (setq tabulated-list-format [("Name" 15 t) ("failure-factor" 15 t) ("ef-increase" 15 t) ("ef-decrease" 15 t) ("ef-threshold" 15 t) ("Initial Interval" 20 t) ("Total Notes" 10 t)]) (tabulated-list-init-header) (setq tabulated-list-entries (cl-loop for id in (gnosis-select 'id 'decks '1=1 t) for output = (gnosis-dashboard-output-deck id) when output collect (list (number-to-string id) (vconcat output)))) (local-set-key (kbd "e") #'gnosis-dashboard-edit-deck) (local-set-key (kbd "a") #'(lambda () "Add deck & refresh" (interactive) (gnosis-add-deck (read-string "Deck name: ")) (gnosis-dashboard-output-decks) (revert-buffer t t t))) (local-set-key (kbd "s") #'(lambda () "Suspend notes" (interactive) (gnosis-suspend-deck (string-to-number (tabulated-list-get-id))) (gnosis-dashboard-output-decks) (revert-buffer t t t))) (local-set-key (kbd "d") #'(lambda () "Delete deck" (interactive) (gnosis-delete-deck (string-to-number (tabulated-list-get-id))) (gnosis-dashboard-output-decks) (revert-buffer t t t))) (local-set-key (kbd "RET") #'(lambda () "View notes of deck" (interactive) (gnosis-dashboard "notes" (gnosis-collect-note-ids :deck (string-to-number (tabulated-list-get-id))))))) (defun gnosis-dashboard-edit-note (&optional dashboard) "Get note id from tabulated list and edit it. DASHBOARD: Dashboard to return to after editing." (interactive) (let ((id (tabulated-list-get-id)) (dashboard (or dashboard "notes"))) (gnosis-edit-note (string-to-number id) nil dashboard) (message "Editing note with id: %s" id))) (defun gnosis-dashboard-edit-deck () "Get deck id from tabulated list and edit it." (interactive) (let ((id (tabulated-list-get-id))) (gnosis-edit-deck (string-to-number id)))) (defvar-keymap gnosis-dashboard-mode-map :doc "gnosis-dashboard keymap" "q" #'quit-window) (define-derived-mode gnosis-dashboard-mode tabulated-list-mode "Gnosis Dashboard" "Major mode for displaying Gnosis dashboard." :keymap gnosis-dashboard-mode-map (setq tabulated-list-padding 2 tabulated-list-sort-key nil)) ;;;###autoload (cl-defun gnosis-dashboard (&optional dashboard-type (note-ids nil)) "Display gnosis dashboard. NOTE-IDS: List of note ids to display on dashboard. When nil, prompt for dashboard type. DASHBOARD-TYPE: either 'Notes' or 'Decks' to display the respective dashboard." (interactive) (let ((dashboard-type (or dashboard-type (cadr (read-multiple-choice "Display dashboard for:" '((?n "notes") (?d "decks") (?t "tags") (?s "search"))))))) (if note-ids (gnosis-dashboard-output-notes note-ids) (pcase dashboard-type ("notes" (gnosis-dashboard-output-notes (gnosis-collect-note-ids))) ("decks" (gnosis-dashboard-output-decks)) ("tags" (gnosis-dashboard-output-notes (gnosis-collect-note-ids :tags t))) ("search" (gnosis-dashboard-output-notes (gnosis-collect-note-ids :query (read-string "Search for note: ")))))) (tabulated-list-print t))) (provide 'gnosis-dashboard) ;;; gnosis-dashboard.el ends here