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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
;;; gnosis.el --- Learning tool for GNU Emacs -*- lexical-binding: t; -*-
;; Copyright (C) 2023 Thanos Apollo
;; Author: Thanos Apollo <[email protected]>
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Work in progress
;;; Code:
;; TODO: Create cloze question type & make it easily extensible for
;; other types
(require 'emacsql)
(require 'cl-lib)
(require 'animate)
(defgroup gnosis nil
"Spaced repetition learning tool."
:group 'external
:prefix "gnosis-")
(defvar gnosis-db (emacsql-sqlite (concat user-emacs-directory "gnosis.db")))
(cl-defun gnosis--select (value table &optional (restrictions '1=1))
"Select VALUE from TABLE, optionally with RESTRICTIONS."
(emacsql gnosis-db `[:select ,value :from ,table :where ,restrictions]))
(cl-defun gnosis--create-table (table &optional values)
"Create TABLE for VALUES."
(emacsql gnosis-db `[:create-table ,table ,values]))
(cl-defun gnosis--drop-table (table)
"Drop TABLE from gnosis-db."
(emacsql gnosis-db `[:drop-table ,table]))
(cl-defun gnosis--insert-into (table values)
"Insert VALUES to TABLE."
(emacsql gnosis-db `[:insert :into ,table :values ,values]))
(cl-defun gnosis-update (table value where)
"Update records in TABLE with to new VALUE based on the given WHERE condition.
Example:
(gnosis-update 'notes '(= main \"NEW VALUE\") '(= id 12))"
(emacsql gnosis-db `[:update ,table :set ,value :where ,where]))
(cl-defun gnosis-get (value table &optional (restrictions '1=1))
"Get VALUE from TABLE, optionally with where RESTRICTIONS."
(caar (gnosis--select value table restrictions)))
(defun gnosis--delete (table value)
"From TABLE use where to delete VALUE."
(emacsql gnosis-db `[:delete :from ,table :where ,value]))
(defun gnosis--display-question (id)
"Display main row for question ID."
(let ((question (gnosis-get 'main 'notes `(= id ,id))))
(erase-buffer)
(insert question 1)
(sit-for 0.5)))
(defun gnosis--ask-input (prompt)
"PROMPT user for input until `q' is given.
The user is prompted to provide input for the 'PROMPT' message, and
the returns the list of inputs in reverse order."
(let ((input nil))
(while (not (equal (car input) "q"))
(push (read-string (concat prompt " (q for quit): ")) input))
(when (equal (car input) "q")
(pop input))
(reverse input)))
(defun gnosis-add-deck (name)
"Create deck with NAME."
(interactive (list (read-string "Deck Name: ")))
(gnosis--insert-into 'decks `([nil ,name])))
(defun gnosis--get-deck-name ()
"Get name from table DECKS."
(when (equal (gnosis--select 'name 'decks) nil)
(error "No decks found"))
(completing-read "Deck: " (gnosis--select 'name 'decks)))
(defun gnosis--get-deck-id ()
"Select id for deck name."
(let ((deck (gnosis--get-deck-name)))
(gnosis-get 'id 'decks `(= name ,deck))))
(defun gnosis-delete-deck (id)
"Delete deck with id value of ID."
(interactive (list (gnosis--get-deck-id)))
(gnosis--delete 'decks `(= id ,id)))
(cl-defun gnosis-add-note-mcq (&key deck question choices correct-answer tags)
"Create a NOTE with a list of multiple CHOICES.
MCQ type consists of a main `QUESTION' that is displayed to the user.
The user will be prompted to select the correct answer from a list of
`CHOICES'. The `CORRECT-ANSWER' should be the index of the correct
choice in the `CHOICES' list. Each note must correspond to one `DECK'.
TAGS are used to organize questions."
(interactive
(list :deck (gnosis--get-deck-id)
:question (read-string "Question: ")
:choices (gnosis--ask-input "Choices")
;; NOTE: string-to-number transforms non-number strings to 0
:correct-answer (string-to-number (read-string "Which is the correct answer (number)? "))
:tags (gnosis--ask-input "Tags")))
(cond ((or (not (numberp correct-answer)) (equal correct-answer 0))
(error "Correct answer value must be the index number of the correct answer"))
((null tags)
(setq tags 'untagged)))
(gnosis--insert-into 'notes `([nil "mcq" ,question ,choices ,correct-answer ,tags ,deck]))
;; Get last inserted note-id
(let ((note-id (caar (last (gnosis--select 'id 'notes))))
(date (gnosis-date-current)))
(gnosis--insert-into 'review `([,note-id ,gnosis-ef ,gnosis-ff 0 0]))
(gnosis--insert-into 'review-log `([,note-id 0 ,date 0 0]))))
(defun gnosis-add-note (type)
"Create note as TYPE."
(interactive (list (completing-read "Type: " '(MCQ Cloze Basic))))
(pcase type
("MCQ" (call-interactively 'gnosis-add-note-mcq))
("Cloze" (message "Not ready yet."))
("Basic" (message "Not ready yet."))
(_ (message "No such type."))))
(defun gnosis-mcq-answer (id)
"Choose the correct answer, from mcq choices for question ID."
(let ((choices (gnosis-get 'options 'notes `(= id ,id)))
(history-add-new-input nil)) ;; Disable history
(completing-read "Answer: " choices)))
(defun gnosis-review-mcq-choices (id)
"Display multiple choice answers for question ID."
(let ((answer (gnosis-get 'answer 'notes `(= id ,id)))
(choices (gnosis-get 'options 'notes `(= id ,id)))
(user-choice (gnosis-mcq-answer id)))
(if (equal (nth (- answer 1) choices) user-choice)
(message "Correct!")
(message "False"))))
(defun gnosis-review (id)
"Start review for question ID."
(let ((type (gnosis-get 'type 'notes `(= id id))))
(pcase type
("mcq" (gnosis-review-mcq-choices id))
("basic" (message "Not Ready yet."))
("cloze" (message "Not Ready yet."))
(_ (error "Malformed note type")))))
;; Database Schemas
(defvar gnosis-db-decks-schema '([(id integer :primary-key :autoincrement)
(name text :not-null)]))
(defvar gnosis-db-notes-schema '([(id integer :primary-key :autoincrement)
(type text :not-null)
(main text :not-null)
(options text :not-null)
(answer text :not-null)
(tags text :default untagged)
(deck-id integer)]
(:foreign-key [deck-id] :references decks [id]
:on-delete :cascade)))
(defvar gnosis-db-review-schema '([(id integer :not-null) ;; note-id
(ef integer :not-null) ;; Easiness factor
(ff integer :not-null) ;; Forgetting factor
(n integer :not-null) ;; Number of reviews
(interval integer :not-null)] ;; Interval
(:foreign-key [id] :references notes [id]
:on-delete :cascade)))
(defvar gnosis-db-review-log-schema '([(id integer :not-null) ;; note-id
(last-rev integer :not-null) ;; Last review date
(next-rev integer :not-null) ;; Next review date
(failures integer :not-null)] ;; Number of consecutive review failures
(:foreign-key [id] :references notes [id]
:on-delete :cascade)))
;; testing
(defun gnosis-test-buffer ()
"Create testing buffer."
(interactive)
(with-current-buffer
(switch-to-buffer (get-buffer-create "*gnosis*"))
(read-only-mode 0)
(erase-buffer)
(gnosis--display-question 4)
(gnosis-review 4)
(gnosis-mode)))
(defun gnosis-init ()
"Create notes content table."
(interactive)
;;(make-directory (concat user-emacs-directory "gnosis"))
(dolist (table '(notes decks review review-log))
(condition-case nil
(gnosis--drop-table table)
(error (message "No %s table to drop." table))))
;; Enable foreign_keys
(emacsql gnosis-db "PRAGMA foreign_keys = ON")
;; Create decks table
(gnosis--create-table 'decks gnosis-db-decks-schema)
;; Create notes table
(gnosis--create-table 'notes gnosis-db-notes-schema)
;; Create review table
(gnosis--create-table 'review gnosis-db-review-schema)
;; Create review-log table
(gnosis--create-table 'review-log gnosis-db-review-log-schema)
(gnosis-add-deck "Anatomy"))
;; Gnosis mode ;;
;;;;;;;;;;;;;;;;;
(define-derived-mode gnosis-mode special-mode "Gnosis"
"Gnosis Mode."
:interactive t
(display-line-numbers-mode 0)
:lighter " gnosis-mode")
(provide 'gnosis)
;;; gnosis.el ends here
|
