aboutsummaryrefslogtreecommitdiff
path: root/tests/test-card-type-twosided.el
blob: cda508f9ffbc2516f62f744eabd5d4de3566d94f (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
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
;;; test-card-type-twosided.el --- Tests for two-sided card type

;;; Commentary:
;; Tests for the two-sided card type in org-drill.
;;
;; Two-sided cards have two subheadings representing two "sides" of a card.
;; When presented, one of the first two subheadings is randomly chosen
;; and shown as the question, while the other serves as the answer.
;;
;; Card type: "twosided"
;; Presentation function: org-drill-present-two-sided-card

;;; Code:

(require 'ert)
(require 'assess)
(require 'org-drill)

;;; Test Data

(defconst test-card-type-twosided-basic-card
  "* Two-Sided Card :drill:
:PROPERTIES:
:DRILL_CARD_TYPE: twosided
:END:

** Side 1

English: Apple

** Side 2

Spanish: Manzana
"
  "Basic two-sided card for vocabulary.")

(defconst test-card-type-twosided-with-extra-sides
  "* Card with Extra Sides :drill:
:PROPERTIES:
:DRILL_CARD_TYPE: twosided
:END:

** Side A

First side content.

** Side B

Second side content.

** Side C

Third side (should not be shown in two-sided mode).

** Side D

Fourth side (should not be shown in two-sided mode).
"
  "Two-sided card with more than 2 subheadings.")

(defconst test-card-type-twosided-single-side
  "* Card with Single Side :drill:
:PROPERTIES:
:DRILL_CARD_TYPE: twosided
:END:

** Only Side

Only one subheading present.
"
  "Two-sided card with only one subheading.")

(defconst test-card-type-twosided-empty-sides
  "* Card with Empty Sides :drill:
:PROPERTIES:
:DRILL_CARD_TYPE: twosided
:END:

** Side 1

** Side 2

"
  "Two-sided card with empty side content.")

;;; Helper Functions

(defun test-card-type-twosided--with-card (content callback)
  "Execute CALLBACK in temp buffer with drill card CONTENT."
  (with-temp-buffer
    (org-mode)
    (insert content)
    (goto-char (point-min))
    (funcall callback)))

(defun test-card-type-twosided--count-subheadings ()
  "Count number of level-2 subheadings under current entry."
  (save-excursion
    (org-back-to-heading)
    (let ((count 0)
          (end (save-excursion (org-end-of-subtree t t))))
      (while (and (re-search-forward "^\\*\\* " end t))
        (cl-incf count))
      count)))

;;; Normal Cases - Card Recognition

(ert-deftest test-card-type-twosided-normal-card-type-property ()
  "Test that two-sided cards have correct DRILL_CARD_TYPE property."
  (test-card-type-twosided--with-card
   test-card-type-twosided-basic-card
   (lambda ()
     (should (org-drill-entry-p))
     (should (equal "twosided" (org-entry-get (point) "DRILL_CARD_TYPE"))))))

(ert-deftest test-card-type-twosided-normal-has-presentation-function ()
  "Test that twosided card type has correct presentation function registered."
  (let ((entry (assoc "twosided" org-drill-card-type-alist)))
    (should entry)
    (should (eq (cadr entry) 'org-drill-present-two-sided-card))))

(ert-deftest test-card-type-twosided-normal-drill-empty-p-flag ()
  "Test that twosided card type has drill-empty-p flag set.
This allows two-sided cards to be presented even if main body is empty."
  (let ((entry (assoc "twosided" org-drill-card-type-alist)))
    (should entry)
    ;; Fourth element is drill-empty-p flag
    (should (nth 3 entry))))

;;; Normal Cases - Card Structure

(ert-deftest test-card-type-twosided-normal-two-subheadings ()
  "Test two-sided card with exactly two subheadings."
  (test-card-type-twosided--with-card
   test-card-type-twosided-basic-card
   (lambda ()
     (should (org-drill-entry-p))
     (should (= 2 (test-card-type-twosided--count-subheadings))))))

(ert-deftest test-card-type-twosided-normal-more-than-two-subheadings ()
  "Test two-sided card with more than two subheadings.
Only first two should be used for presentation."
  (test-card-type-twosided--with-card
   test-card-type-twosided-with-extra-sides
   (lambda ()
     (should (org-drill-entry-p))
     (should (> (test-card-type-twosided--count-subheadings) 2)))))

;;; Boundary Cases

(ert-deftest test-card-type-twosided-boundary-single-subheading ()
  "Test two-sided card with only one subheading.
Should still be a valid card, though not ideal."
  (test-card-type-twosided--with-card
   test-card-type-twosided-single-side
   (lambda ()
     (should (org-drill-entry-p))
     (should (= 1 (test-card-type-twosided--count-subheadings))))))

(ert-deftest test-card-type-twosided-boundary-empty-side-content ()
  "Test two-sided card where sides have no content."
  (test-card-type-twosided--with-card
   test-card-type-twosided-empty-sides
   (lambda ()
     (should (org-drill-entry-p))
     (should (= 2 (test-card-type-twosided--count-subheadings))))))

(ert-deftest test-card-type-twosided-boundary-no-main-body ()
  "Test two-sided card with no main body content.
This is valid because twosided has drill-empty-p flag."
  (let ((content "* No Body :drill:\n:PROPERTIES:\n:DRILL_CARD_TYPE: twosided\n:END:\n\n** A\n\nContent A\n\n** B\n\nContent B\n"))
    (test-card-type-twosided--with-card
     content
     (lambda ()
       (should (org-drill-entry-p))
       (should (equal "twosided" (org-entry-get (point) "DRILL_CARD_TYPE")))))))

;;; Card Type Semantics

(ert-deftest test-card-type-twosided-normal-vocabulary-use-case ()
  "Test typical vocabulary card use case.
Two sides for word translation pairs."
  (test-card-type-twosided--with-card
   test-card-type-twosided-basic-card
   (lambda ()
     (should (org-drill-entry-p))
     ;; Verify both sides exist
     (let ((sides nil))
       (save-excursion
         (org-back-to-heading)
         (while (re-search-forward "^\\*\\* " nil t)
           (let ((heading-text (buffer-substring
                                (point)
                                (line-end-position))))
             (push heading-text sides))))
       (should (= 2 (length sides)))
       (should (member "Side 1" sides))
       (should (member "Side 2" sides))))))

(ert-deftest test-card-type-twosided-normal-concept-definition-use-case ()
  "Test concept/definition card use case."
  (let ((content "* Concept Card :drill:\n:PROPERTIES:\n:DRILL_CARD_TYPE: twosided\n:END:\n\n** Concept\n\nPolymorphism\n\n** Definition\n\nAbility of different objects to respond to same message in different ways.\n"))
    (test-card-type-twosided--with-card
     content
     (lambda ()
       (should (org-drill-entry-p))
       (should (= 2 (test-card-type-twosided--count-subheadings)))))))

(ert-deftest test-card-type-twosided-normal-different-from-simple ()
  "Test that twosided is registered differently from simple."
  (let ((twosided-fn (cadr (assoc "twosided" org-drill-card-type-alist)))
        (simple-fn (cadr (assoc "simple" org-drill-card-type-alist))))
    (should-not (eq twosided-fn simple-fn))
    (should (eq twosided-fn 'org-drill-present-two-sided-card))
    (should (eq simple-fn 'org-drill-present-simple-card))))

(provide 'test-card-type-twosided)
;;; test-card-type-twosided.el ends here