summaryrefslogtreecommitdiff
path: root/tests/test-org-contacts-capture-finalize.el
blob: d379a912859055d2660a0cfc44c76a2d2290a5a8 (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
;;; test-org-contacts-capture-finalize.el --- Tests for org-contacts capture template finalization -*- lexical-binding: t; -*-

;; Copyright (C) 2025 Craig Jennings

;; Author: Craig Jennings <c@cjennings.net>

;; 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.

;;; Commentary:

;; Unit tests for the org-contacts capture template finalization function
;; that automatically inserts birthday timestamps.

;;; Code:

;; Initialize package system for batch mode
(when noninteractive
  (package-initialize))

(require 'ert)
(require 'org)

;; Define the function to test (copied from org-contacts-config.el)
(defun cj/org-contacts-finalize-birthday-timestamp ()
  "Add yearly repeating timestamp after properties drawer if BIRTHDAY is set.
This function is called during `org-capture' finalization to automatically
insert a plain timestamp for birthdays, enabling them to appear in org-agenda
without requiring org-contacts to be loaded in the async subprocess."
  (when (string= (plist-get org-capture-plist :key) "C")
    (save-excursion
      (goto-char (point-min))
      ;; Find the properties drawer
      (when (re-search-forward "^:PROPERTIES:" nil t)
        (let ((drawer-start (point))
              (drawer-end (save-excursion
                            (when (re-search-forward "^:END:" nil t)
                              (point)))))
          (when drawer-end
            ;; Get BIRTHDAY property value
            (goto-char drawer-start)
            (when (re-search-forward "^:BIRTHDAY:[ \t]*\\(.+\\)$" drawer-end t)
              (let ((birthday-value (string-trim (match-string 1))))
                ;; Only process non-empty birthdays
                (when (and birthday-value
                           (not (string-blank-p birthday-value)))
                  ;; Parse birthday and create timestamp
                  (let* ((parsed (cond
                                  ;; Format: YYYY-MM-DD
                                  ((string-match "^\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)$" birthday-value)
                                   (list (string-to-number (match-string 1 birthday-value))
                                         (string-to-number (match-string 2 birthday-value))
                                         (string-to-number (match-string 3 birthday-value))))
                                  ;; Format: MM-DD
                                  ((string-match "^\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)$" birthday-value)
                                   (list nil
                                         (string-to-number (match-string 1 birthday-value))
                                         (string-to-number (match-string 2 birthday-value))))
                                  (t nil)))
                         (year (when parsed (or (nth 0 parsed) (nth 5 (decode-time)))))
                         (month (when parsed (nth 1 parsed)))
                         (day (when parsed (nth 2 parsed))))
                    (when (and year month day)
                      ;; Create timestamp
                      (let* ((time (encode-time 0 0 0 day month year))
                             (dow (format-time-string "%a" time))
                             (date-str (format "%04d-%02d-%02d" year month day))
                             (timestamp (format "<%s %s +1y>" date-str dow)))
                        ;; Insert after :END: if not already present
                        (goto-char drawer-end)
                        (let ((heading-end (save-excursion (outline-next-heading) (point))))
                          (unless (re-search-forward "<[0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}[^>]*\\+1y>" heading-end t)
                            (goto-char drawer-end)
                            (end-of-line)
                            (insert "\n" timestamp)))))))))))))

;;; Tests for birthday timestamp finalization

(ert-deftest test-contacts-capture-finalize-with-full-birthday ()
  "Test that finalize adds timestamp for YYYY-MM-DD birthday."
  (with-temp-buffer
    (org-mode)
    (insert "* Alice Anderson\n")
    (insert ":PROPERTIES:\n")
    (insert ":EMAIL: alice@example.com\n")
    (insert ":BIRTHDAY: 1985-03-15\n")
    (insert ":END:\n")
    (insert "Added: [2025-11-01 Fri 20:30]\n")

    ;; Simulate capture context
    (let ((org-capture-plist '(:key "C")))
      (cj/org-contacts-finalize-birthday-timestamp)

      (let ((content (buffer-string)))
        ;; Should have birthday timestamp
        (should (string-match-p "<1985-03-15 [A-Za-z]\\{3\\} \\+1y>" content))
        ;; Timestamp should be after :END:
        (should (string-match-p ":END:\n<1985-03-15" content))))))

(ert-deftest test-contacts-capture-finalize-with-partial-birthday ()
  "Test that finalize adds timestamp for MM-DD birthday with current year."
  (let ((current-year (nth 5 (decode-time))))
    (with-temp-buffer
      (org-mode)
      (insert "* Bob Baker\n")
      (insert ":PROPERTIES:\n")
      (insert ":BIRTHDAY: 07-04\n")
      (insert ":END:\n")

      (let ((org-capture-plist '(:key "C")))
        (cj/org-contacts-finalize-birthday-timestamp)

        (let ((content (buffer-string)))
          ;; Should have birthday timestamp with current year
          (should (string-match-p (format "<%d-07-04 [A-Za-z]\\{3\\} \\+1y>" current-year) content)))))))

(ert-deftest test-contacts-capture-finalize-without-birthday ()
  "Test that finalize does nothing when no birthday property."
  (with-temp-buffer
    (org-mode)
    (insert "* Carol Chen\n")
    (insert ":PROPERTIES:\n")
    (insert ":EMAIL: carol@example.com\n")
    (insert ":END:\n")

    (let ((original-content (buffer-string))
          (org-capture-plist '(:key "C")))
      (cj/org-contacts-finalize-birthday-timestamp)

      ;; Content should be unchanged
      (should (string= (buffer-string) original-content))
      ;; Should have no timestamp
      (should-not (string-match-p "<[0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}" (buffer-string))))))

(ert-deftest test-contacts-capture-finalize-with-empty-birthday ()
  "Test that finalize skips empty birthday values."
  (with-temp-buffer
    (org-mode)
    (insert "* David Davis\n")
    (insert ":PROPERTIES:\n")
    (insert ":BIRTHDAY: \n")
    (insert ":END:\n")

    (let ((original-content (buffer-string))
          (org-capture-plist '(:key "C")))
      (cj/org-contacts-finalize-birthday-timestamp)

      ;; Content should be unchanged
      (should (string= (buffer-string) original-content))
      ;; Should have no timestamp
      (should-not (string-match-p "<[0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}" (buffer-string))))))

(ert-deftest test-contacts-capture-finalize-prevents-duplicates ()
  "Test that finalize doesn't add duplicate timestamps."
  (with-temp-buffer
    (org-mode)
    (insert "* Eve Evans\n")
    (insert ":PROPERTIES:\n")
    (insert ":BIRTHDAY: 2000-01-01\n")
    (insert ":END:\n")
    (insert "<2000-01-01 Sat +1y>\n")

    (let ((org-capture-plist '(:key "C")))
      (cj/org-contacts-finalize-birthday-timestamp)

      ;; Should have exactly one timestamp
      (should (= 1 (how-many "<2000-01-01 [A-Za-z]\\{3\\} \\+1y>" (point-min) (point-max)))))))

(ert-deftest test-contacts-capture-finalize-only-for-contact-template ()
  "Test that finalize only runs for 'C' template key."
  (with-temp-buffer
    (org-mode)
    (insert "* Task with birthday property\n")
    (insert ":PROPERTIES:\n")
    (insert ":BIRTHDAY: 2000-01-01\n")
    (insert ":END:\n")

    (let ((original-content (buffer-string))
          (org-capture-plist '(:key "t"))) ; Different template key
      (cj/org-contacts-finalize-birthday-timestamp)

      ;; Content should be unchanged
      (should (string= (buffer-string) original-content)))))

(ert-deftest test-contacts-capture-finalize-preserves-existing-content ()
  "Test that finalize preserves all existing content."
  (with-temp-buffer
    (org-mode)
    (insert "* Alice Anderson\n")
    (insert ":PROPERTIES:\n")
    (insert ":EMAIL: alice@example.com\n")
    (insert ":PHONE: 555-1234\n")
    (insert ":BIRTHDAY: 1985-03-15\n")
    (insert ":NICKNAME: Ali\n")
    (insert ":NOTE: Met at conference\n")
    (insert ":END:\n")
    (insert "Added: [2025-11-01 Fri 20:30]\n")

    (let ((org-capture-plist '(:key "C")))
      (cj/org-contacts-finalize-birthday-timestamp)

      (let ((content (buffer-string)))
        ;; All properties should still be present
        (should (string-search ":EMAIL: alice@example.com" content))
        (should (string-search ":PHONE: 555-1234" content))
        (should (string-search ":BIRTHDAY: 1985-03-15" content))
        (should (string-search ":NICKNAME: Ali" content))
        (should (string-search ":NOTE: Met at conference" content))
        ;; Added timestamp should still be there
        (should (string-search "Added: [2025-11-01 Fri 20:30]" content))
        ;; Birthday timestamp should be added
        (should (string-match-p "<1985-03-15 [A-Za-z]\\{3\\} \\+1y>" content))))))

(provide 'test-org-contacts-capture-finalize)
;;; test-org-contacts-capture-finalize.el ends here