aboutsummaryrefslogtreecommitdiff
path: root/tests/test-org-drill-route-rating-result.el
blob: 5ea29b750bd033ea6c4ace8aedfbdfbb64f928b5 (plain)
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
;;; test-org-drill-route-rating-result.el --- Tests for --route-rating-result  -*- lexical-binding: t; -*-

;;; Commentary:
;; Tests for `org-drill--route-rating-result', which translates the return
;; value of `org-drill-entry' into one of `quit', `edit', `skip', `next'
;; while updating the session queues.

;;; Code:

(require 'ert)
(require 'cl-lib)
(require 'org)
(require 'org-drill)

(defun make-marker-for-test ()
  (let ((m (make-marker))) (set-marker m 1) m))

(ert-deftest test-route-rating-result-nil-returns-quit-and-stashes-end-pos ()
  "When the entry returned nil (user quit), result is `quit' and end-pos is :quit."
  (let ((session (org-drill-session))
        (m (make-marker-for-test)))
    (cl-letf (((symbol-function 'message) #'ignore))
      (should (eq 'quit (org-drill--route-rating-result session m nil))))
    (should (eq :quit (oref session end-pos)))))

(ert-deftest test-route-rating-result-edit-stashes-marker-end-pos ()
  "When the entry returned `edit', end-pos becomes a marker and result is `edit'."
  (let ((session (org-drill-session))
        (m (make-marker-for-test)))
    (with-temp-buffer
      (insert "x")
      (goto-char (point-min))
      (should (eq 'edit (org-drill--route-rating-result session m 'edit))))
    (should (markerp (oref session end-pos)))))

(ert-deftest test-route-rating-result-skip-clears-current-item ()
  "Skip result drops the current-item slot to nil and returns `skip'."
  (let ((session (org-drill-session))
        (m (make-marker-for-test)))
    (oset session current-item m)
    (should (eq 'skip (org-drill--route-rating-result session m 'skip)))
    (should (null (oref session current-item)))))

(ert-deftest test-route-rating-result-failure-pushes-onto-again-entries ()
  "A failed-quality result puts the marker on again-entries and returns `next'."
  (let ((session (org-drill-session))
        (m (make-marker-for-test)))
    (should (eq 'next (org-drill--route-rating-result session m 0)))
    (should (member m (oref session again-entries)))))

(ert-deftest test-route-rating-result-success-pushes-onto-done-entries ()
  "A passing-quality result puts the marker on done-entries and returns `next'."
  (let ((session (org-drill-session))
        (m (make-marker-for-test)))
    (should (eq 'next (org-drill--route-rating-result session m 5)))
    (should (member m (oref session done-entries)))))

(ert-deftest test-route-rating-result-failure-with-existing-again-shuffles-it ()
  "When again-entries already has items, the failure path re-shuffles the list."
  (let* ((session (org-drill-session))
         (m1 (let ((mk (make-marker))) (set-marker mk 1) mk))
         (m2 (let ((mk (make-marker))) (set-marker mk 2) mk))
         (shuffle-called nil))
    (oset session again-entries (list m1 m2))
    (cl-letf (((symbol-function 'org-drill-shuffle)
               (lambda (lst) (setq shuffle-called t) lst)))
      (org-drill--route-rating-result session m1 0))
    (should shuffle-called)))

;;;; org-drill--pick-next-marker

(ert-deftest test-pick-next-marker-not-resuming-pops-from-queue ()
  "Without resuming-p, the result is the popped pending entry."
  (let ((session (org-drill-session)))
    (cl-letf (((symbol-function 'org-drill-pop-next-pending-entry)
               (lambda (_) 'popped-marker)))
      (let ((result (org-drill--pick-next-marker session nil)))
        (should (equal '(popped-marker . nil) result))))))

(ert-deftest test-pick-next-marker-resuming-with-current-item-keeps-it ()
  "When resuming-p is t and current-item is a live drill entry, return it
and flip resume-p to nil so subsequent ticks don't repeat the same entry."
  (let ((session (org-drill-session)))
    (with-temp-buffer
      (insert "* Drill :drill:\nbody\n")
      (org-mode)
      (goto-char (point-min))
      (let ((m (point-marker)))
        (oset session current-item m)
        (let ((result (org-drill--pick-next-marker session t)))
          (should (eq m (car result)))
          (should (null (cdr result))))))))

(ert-deftest test-pick-next-marker-resuming-with-nil-current-item-pops-fresh ()
  "When resuming-p is t but current-item is nil, fall through to popping a
fresh entry from the pending queue."
  (let ((session (org-drill-session)))
    (oset session current-item nil)
    (cl-letf (((symbol-function 'org-drill-pop-next-pending-entry)
               (lambda (_) 'fresh-marker)))
      (let ((result (org-drill--pick-next-marker session t)))
        (should (eq 'fresh-marker (car result)))
        ;; resuming-p still flowing through.
        (should (eq t (cdr result)))))))

(ert-deftest test-pick-next-marker-resuming-with-non-drill-current-item-pops-fresh ()
  "When current-item is set but no longer points at a drill entry, fall
through to popping a fresh entry."
  (let ((session (org-drill-session)))
    (with-temp-buffer
      (insert "Plain text — not a drill heading.\n")
      (org-mode)
      (goto-char (point-min))
      (oset session current-item (point-marker))
      (cl-letf (((symbol-function 'org-drill-pop-next-pending-entry)
                 (lambda (_) 'fresh-marker)))
        (let ((result (org-drill--pick-next-marker session t)))
          (should (eq 'fresh-marker (car result))))))))

(provide 'test-org-drill-route-rating-result)
;;; test-org-drill-route-rating-result.el ends here