1 ;;; test-org-element.el --- Tests for org-element.el
3 ;; Copyright (C) 2012, 2013 Nicolas Goaziou
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
7 ;; This program is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; This program is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
22 (unless (featurep 'org-element
)
23 (signal 'missing-test-dependency
"org-element"))
25 (defun org-test-parse-and-interpret (text)
26 "Parse TEXT as Org syntax and interpret it.
27 Return interpreted string."
31 (org-element-interpret-data (org-element-parse-buffer))))
35 ;;; Test `org-element-map'
37 (ert-deftest test-org-element
/map
()
38 "Test `org-element-map'."
39 ;; Can map to `plain-text' objects.
42 (org-test-with-temp-text "Some text \alpha
48 (org-element-parse-buffer) 'plain-text
49 (lambda (s) (when (string-match "text" s
) (incf count
))))
51 ;; Applies to secondary strings
53 (org-element-map '("some " (bold nil
"bold") "text") 'bold
'identity
))
54 ;; Enter secondary strings before entering contents.
60 (org-test-with-temp-text "* Some \\alpha headline\n\\beta entity."
61 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
)))))
62 ;; Apply NO-RECURSION argument.
64 (org-test-with-temp-text "#+BEGIN_CENTER\n\\alpha\n#+END_CENTER"
66 (org-element-parse-buffer) 'entity
'identity nil nil
'center-block
)))
67 ;; Use WITH-AFFILIATED argument.
71 (org-test-with-temp-text "#+CAPTION[a]: 1\n#+CAPTION[b]: 2\nParagraph"
73 (org-element-at-point) 'plain-text
'identity nil nil nil t
)))))
79 (ert-deftest test-org-element
/put-property
()
80 "Test `org-element-put-property' specifications."
82 (org-test-with-temp-text "* Headline\n *a*"
83 (let ((tree (org-element-parse-buffer)))
84 (org-element-put-property
85 (org-element-map tree
'bold
'identity nil t
) :test
1)
86 (should (org-element-property
87 :test
(org-element-map tree
'bold
'identity nil t
)))))
88 ;; Put property on a string.
90 (org-element-property :test
(org-element-put-property "Paragraph" :test t
))))
92 (ert-deftest test-org-element
/set-contents
()
93 "Test `org-element-set-contents' specifications."
94 ;; Accept multiple entries.
96 (equal '("b" (italic nil
"a"))
97 (org-test-with-temp-text "* Headline\n *a*"
98 (let ((tree (org-element-parse-buffer)))
99 (org-element-set-contents
100 (org-element-map tree
'bold
'identity nil t
) "b" '(italic nil
"a"))
101 (org-element-contents
102 (org-element-map tree
'bold
'identity nil t
))))))
103 ;; Accept atoms and elements.
106 (org-test-with-temp-text "* Headline\n *a*"
107 (let ((tree (org-element-parse-buffer)))
108 (org-element-set-contents
109 (org-element-map tree
'bold
'identity nil t
) "b")
110 (org-element-contents
111 (org-element-map tree
'bold
'identity nil t
))))))
113 (equal '((italic nil
"b"))
114 (org-test-with-temp-text "* Headline\n *a*"
115 (let ((tree (org-element-parse-buffer)))
116 (org-element-set-contents
117 (org-element-map tree
'bold
'identity nil t
) '(italic nil
"b"))
118 (org-element-contents
119 (org-element-map tree
'bold
'identity nil t
))))))
120 ;; Allow nil contents.
122 (org-test-with-temp-text "* Headline\n *a*"
123 (let ((tree (org-element-parse-buffer)))
124 (org-element-set-contents (org-element-map tree
'bold
'identity nil t
))
125 (org-element-contents (org-element-map tree
'bold
'identity nil t
))))))
127 (ert-deftest test-org-element
/set-element
()
128 "Test `org-element-set-element' specifications."
129 (org-test-with-temp-text "* Headline\n*a*"
130 (let ((tree (org-element-parse-buffer)))
131 (org-element-set-element
132 (org-element-map tree
'bold
'identity nil t
)
134 ;; Check if object is correctly replaced.
135 (should (org-element-map tree
'italic
'identity
))
136 (should-not (org-element-map tree
'bold
'identity
))
137 ;; Check if new object's parent is correctly set.
140 (org-element-property :parent
141 (org-element-map tree
'italic
'identity nil t
))
142 (org-element-map tree
'paragraph
'identity nil t
))))))
144 (ert-deftest test-org-element
/adopt-elements
()
145 "Test `org-element-adopt-elements' specifications."
148 (equal '(plain-text italic
)
149 (org-test-with-temp-text "* Headline\n *a*"
150 (let ((tree (org-element-parse-buffer)))
151 (org-element-adopt-elements
152 (org-element-map tree
'bold
'identity nil t
) '(italic nil
"a"))
153 (mapcar (lambda (blob) (org-element-type blob
))
154 (org-element-contents
155 (org-element-map tree
'bold
'identity nil t
)))))))
159 (org-test-with-temp-text "* Headline\n *a*"
160 (let ((tree (org-element-parse-buffer)))
161 (org-element-adopt-elements
162 (org-element-map tree
'bold
'identity nil t
) "b")
163 (org-element-contents
164 (org-element-map tree
'bold
'identity nil t
)))))))
170 ;;;; Affiliated Keywords
172 (ert-deftest test-org-element
/affiliated-keywords-parser
()
173 "Test affiliated keywords parsing."
174 ;; Read simple keywords.
177 (org-element-property
179 (org-test-with-temp-text "#+NAME: para\nParagraph"
180 (org-element-at-point)))))
183 (org-element-property
185 (org-test-with-temp-text "#+NAME: para\nParagraph"
186 (org-element-at-point)))))
187 ;; Parse multiple keywords.
191 (org-element-property
193 (org-test-with-temp-text
194 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
195 (org-element-at-point)))))
196 ;; Parse "parsed" keywords.
200 (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
201 (car (org-element-property :caption
(org-element-at-point))))))
202 ;; Parse dual keywords.
205 '((("long") "short"))
206 (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
207 (org-element-property :caption
(org-element-at-point)))))
208 ;; Allow multiple caption keywords.
211 '((("l2") "s2") (("l1") "s1"))
212 (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
213 (org-element-property :caption
(org-element-at-point)))))
216 '((("l1")) (nil "s1"))
217 (org-test-with-temp-text "#+CAPTION[s1]:\n#+CAPTION: l1\nParagraph"
218 (org-element-property :caption
(org-element-at-point)))))
219 ;; Corner case: orphaned keyword at the end of an element.
222 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
223 (progn (search-forward "name")
224 (org-element-type (org-element-at-point))))))
226 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
227 (progn (search-forward "Some")
228 (org-element-property :name
(org-element-at-point))))))
233 (ert-deftest test-org-element
/babel-call-parser
()
234 "Test `babel-call' parsing."
237 (org-test-with-temp-text "#+CALL: test()"
238 (org-element-map (org-element-parse-buffer) 'babel-call
'identity
)))
241 (org-test-with-temp-text "#+call: test()"
242 (org-element-map (org-element-parse-buffer) 'babel-call
'identity
))))
247 (ert-deftest test-org-element
/bold-parser
()
248 "Test `bold' parser."
251 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
252 (org-test-with-temp-text "*bold*"
253 (org-element-map (org-element-parse-buffer) 'bold
'identity nil t
))))
254 ;; Multi-line markup.
257 (org-element-contents
258 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
259 (org-test-with-temp-text "*first line\nsecond line*"
260 (org-element-map (org-element-parse-buffer) 'bold
'identity nil t
))))
261 '("first line\nsecond line"))))
266 (ert-deftest test-org-element
/center-block-parser
()
267 "Test `center-block' parser."
270 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
271 (org-element-map (org-element-parse-buffer) 'center-block
'identity
)))
274 (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
275 (org-element-map (org-element-parse-buffer) 'center-block
'identity
)))
276 ;; Test folded block.
277 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
280 (org-element-property
283 (org-element-parse-buffer) 'center-block
'identity nil t
))))
284 ;; Ignore incomplete block.
286 (org-test-with-temp-text "#+BEGIN_CENTER"
288 (org-element-parse-buffer) 'center-block
'identity nil t
))))
293 (ert-deftest test-org-element
/clock-parser
()
294 "Test `clock' parser."
296 (let* ((org-clock-string "CLOCK:")
297 (clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
298 (org-element-at-point))))
299 (should (eq (org-element-property :status clock
) 'running
))
301 (equal (org-element-property :raw-value
302 (org-element-property :value clock
))
303 "[2012-01-01 sun. 00:01]"))
304 (should-not (org-element-property :duration clock
)))
306 (let* ((org-clock-string "CLOCK:")
308 (org-test-with-temp-text
309 "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
310 (org-element-at-point))))
311 (should (eq (org-element-property :status clock
) 'closed
))
312 (should (equal (org-element-property :raw-value
313 (org-element-property :value clock
))
314 "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
315 (should (equal (org-element-property :duration clock
) "0:01"))))
320 (ert-deftest test-org-element
/code-parser
()
321 "Test `code' parser."
324 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
325 (org-test-with-temp-text "~code~"
326 (org-element-map (org-element-parse-buffer) 'code
'identity
))))
327 ;; Multi-line markup.
330 (org-element-property
332 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
333 (org-test-with-temp-text "~first line\nsecond line~"
335 (org-element-parse-buffer) 'code
'identity nil t
))))
336 "first line\nsecond line")))
341 (ert-deftest test-org-element
/comment-parser
()
342 "Test `comment' parser."
345 (org-test-with-temp-text "# Comment"
346 (org-element-map (org-element-parse-buffer) 'comment
'identity
)))
349 (org-test-with-temp-text " # Comment"
350 (org-element-map (org-element-parse-buffer) 'comment
'identity
)))
351 ;; Preserve indentation.
354 (org-element-property
356 (org-test-with-temp-text "# No blank\n# One blank"
357 (org-element-map (org-element-parse-buffer) 'comment
'identity nil t
)))
358 "No blank\n One blank"))
359 ;; Comment with blank lines.
362 (org-element-property
364 (org-test-with-temp-text "# First part\n# \n#\n# Second part"
365 (org-element-map (org-element-parse-buffer) 'comment
'identity nil t
)))
366 "First part\n\n\nSecond part"))
367 ;; Do not mix comments and keywords.
370 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
371 (length (org-element-map
372 (org-element-parse-buffer) 'comment
'identity
)))))
375 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
376 (org-element-property
379 (org-element-parse-buffer) 'comment
'identity nil t
))))))
384 (ert-deftest test-org-element
/comment-block-parser
()
385 "Test `comment-block' parser."
388 (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
390 (org-element-parse-buffer) 'comment-block
'identity
)))
393 (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
395 (org-element-parse-buffer) 'comment-block
'identity
)))
396 ;; Test folded block.
397 (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
400 (org-element-property
403 (org-element-parse-buffer) 'comment-block
'identity nil t
))))
404 ;; Ignore incomplete block.
406 (org-test-with-temp-text "#+BEGIN_COMMENT"
408 (org-element-parse-buffer) 'comment-block
'identity nil t
))))
413 (ert-deftest test-org-element
/diary-sexp-parser
()
414 "Test `diary-sexp' parser."
418 (org-test-with-temp-text
419 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old"
420 (org-element-type (org-element-at-point)))))
421 ;; Diary sexp must live at beginning of line
424 (org-test-with-temp-text " %%(org-bbdb-anniversaries)"
425 (org-element-type (org-element-at-point))))))
430 (ert-deftest test-org-element
/drawer-parser
()
431 "Test `drawer' parser."
434 (let ((org-drawers '("TEST")))
435 (org-test-with-temp-text ":TEST:\nText\n:END:"
436 (org-element-map (org-element-parse-buffer) 'drawer
'identity
))))
437 ;; Do not mix regular drawers and property drawers.
439 (let ((org-drawers '("PROPERTIES")))
440 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
442 (org-element-parse-buffer) 'drawer
'identity nil t
))))
443 ;; Ignore incomplete drawer.
445 (let ((org-drawers '("TEST")))
446 (org-test-with-temp-text ":TEST:"
448 (org-element-parse-buffer) 'drawer
'identity nil t
)))))
453 (ert-deftest test-org-element
/dynamic-block-parser
()
454 "Test `dynamic-block' parser."
457 (org-test-with-temp-text
458 "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
459 (org-element-map (org-element-parse-buffer) 'dynamic-block
'identity
)))
461 (org-test-with-temp-text
462 "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
465 (org-element-property
468 (org-element-parse-buffer) 'dynamic-block
'identity nil t
))))
471 (org-test-with-temp-text
472 "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
473 (org-element-map (org-element-parse-buffer) 'dynamic-block
'identity
)))
474 ;; Ignore incomplete block.
476 (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
478 (org-element-parse-buffer) 'dynamic-block
'identity nil t
))))
483 (ert-deftest test-org-element
/entity-parser
()
484 "Test `entity' parser."
487 (org-test-with-temp-text "\\sin"
488 (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
491 (org-element-property
493 (org-test-with-temp-text "\\alpha{}text"
494 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
))))
495 ;; User-defined entity.
498 (org-element-property
500 (let ((org-entities-user
501 '(("test" "test" nil
"test" "test" "test" "test"))))
502 (org-test-with-temp-text "\\test"
503 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
))))
505 ;; Special case: entity at the end of a container.
508 (org-test-with-temp-text "*\\alpha \\beta*"
509 (search-forward "be")
510 (org-element-type (org-element-context))))))
515 (ert-deftest test-org-element
/example-block-parser
()
516 "Test `example-block' parser."
519 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
520 (org-element-map (org-element-parse-buffer) 'example-block
'identity
)))
521 ;; Test folded block.
523 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
525 (org-element-property :hiddenp
(org-element-at-point))))
526 ;; Ignore incomplete block.
529 (org-test-with-temp-text "#+BEGIN_EXAMPLE"
530 (org-element-type (org-element-at-point)))))
531 ;; Properly un-escape code.
533 (equal "* Headline\n #+keyword\nText\n"
534 (org-test-with-temp-text
535 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText\n#+END_EXAMPLE"
536 (org-element-property :value
(org-element-at-point)))))
537 ;; Nil `org-src-preserve-indentation': Remove maximum common
541 (org-test-with-temp-text "#+BEGIN_EXAMPLE\n L1\n L2\n#+END_EXAMPLE"
542 (let ((org-src-preserve-indentation nil
))
543 (org-element-property :value
(org-element-at-point))))))
544 ;; Non-nil `org-src-preserve-indentation': Remove block indentation
545 ;; only, unless block contents are less indented than block
549 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
550 (let ((org-src-preserve-indentation t
))
551 (org-element-property :value
(org-element-at-point))))))
555 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
556 (let ((org-src-preserve-indentation t
))
557 (org-element-property :value
(org-element-at-point)))))))
559 (ert-deftest test-org-element
/block-switches
()
560 "Test `example-block' and `src-block' switches parsing."
561 (let ((org-coderef-label-format "(ref:%s)"))
562 ;; 1. Test "-i" switch.
564 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
565 (org-element-property :preserve-indent
(org-element-at-point))))
567 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
568 (org-element-property :preserve-indent
(org-element-at-point))))
570 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
571 (org-element-property :preserve-indent
(org-element-at-point))))
573 (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
574 (org-element-property :preserve-indent
(org-element-at-point))))
575 ;; 2. "-n -r -k" combination should number lines, retain labels but
576 ;; not use them in coderefs.
578 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
579 (let ((element (org-element-at-point)))
580 (and (org-element-property :number-lines element
)
581 (org-element-property :retain-labels element
)
582 (not (org-element-property :use-labels element
))))))
584 (org-test-with-temp-text
585 "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
586 (let ((element (org-element-at-point)))
587 (and (org-element-property :number-lines element
)
588 (org-element-property :retain-labels element
)
589 (not (org-element-property :use-labels element
))))))
590 ;; 3. "-n -r" combination should number-lines remove labels and not
591 ;; use them in coderefs.
593 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
594 (let ((element (org-element-at-point)))
595 (and (org-element-property :number-lines element
)
596 (not (org-element-property :retain-labels element
))
597 (not (org-element-property :use-labels element
))))))
599 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
600 (let ((element (org-element-at-point)))
601 (and (org-element-property :number-lines element
)
602 (not (org-element-property :retain-labels element
))
603 (not (org-element-property :use-labels element
))))))
604 ;; 4. "-n" or "+n" should number lines, retain labels and use them
607 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
608 (let ((element (org-element-at-point)))
609 (and (org-element-property :number-lines element
)
610 (org-element-property :retain-labels element
)
611 (org-element-property :use-labels element
)))))
613 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
614 (let ((element (org-element-at-point)))
615 (and (org-element-property :number-lines element
)
616 (org-element-property :retain-labels element
)
617 (org-element-property :use-labels element
)))))
619 (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
620 (let ((element (org-element-at-point)))
621 (and (org-element-property :number-lines element
)
622 (org-element-property :retain-labels element
)
623 (org-element-property :use-labels element
)))))
625 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
626 (let ((element (org-element-at-point)))
627 (and (org-element-property :number-lines element
)
628 (org-element-property :retain-labels element
)
629 (org-element-property :use-labels element
)))))
630 ;; 5. No switch should not number lines, but retain labels and use
633 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
634 (let ((element (org-element-at-point)))
635 (and (not (org-element-property :number-lines element
))
636 (org-element-property :retain-labels element
)
637 (org-element-property :use-labels element
)))))
639 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
640 (let ((element (org-element-at-point)))
641 (and (not (org-element-property :number-lines element
))
642 (org-element-property :retain-labels element
)
643 (org-element-property :use-labels element
)))))
644 ;; 6. "-r" switch only: do not number lines, remove labels, and
645 ;; don't use labels in coderefs.
647 (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
648 (let ((element (org-element-at-point)))
649 (and (not (org-element-property :number-lines element
))
650 (not (org-element-property :retain-labels element
))
651 (not (org-element-property :use-labels element
))))))
653 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
654 (let ((element (org-element-at-point)))
655 (and (not (org-element-property :number-lines element
))
656 (not (org-element-property :retain-labels element
))
657 (not (org-element-property :use-labels element
))))))
658 ;; 7. Recognize coderefs with user-defined syntax.
662 (org-test-with-temp-text
663 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
664 (org-element-property :label-fmt
(org-element-at-point)))))
668 (org-test-with-temp-text
669 "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
670 (org-element-property :label-fmt
(org-element-at-point)))))))
675 (ert-deftest test-org-element
/export-block-parser
()
676 "Test `export-block' parser."
679 (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
681 (let ((org-element-block-name-alist
682 '(("LATEX" . org-element-export-block-parser
))))
683 (org-element-parse-buffer))
684 'export-block
'identity
)))
685 ;; Test folded block.
686 (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
689 (org-element-property
692 (let ((org-element-block-name-alist
693 '(("LATEX" . org-element-export-block-parser
))))
694 (org-element-parse-buffer))
695 'export-block
'identity nil t
))))
698 (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
700 (let ((org-element-block-name-alist
701 '(("LATEX" . org-element-export-block-parser
))))
702 (org-element-parse-buffer))
703 'export-block
'identity
)))
704 ;; Ignore incomplete block.
706 (org-test-with-temp-text "#+BEGIN_LATEX"
708 (let ((org-element-block-name-alist
709 '(("LATEX" . org-element-export-block-parser
))))
710 (org-element-parse-buffer))
711 'export-block
'identity nil t
))))
716 (ert-deftest test-org-element
/export-snippet-parser
()
717 "Test `export-snippet' parser."
720 '("back-end" .
"contents")
721 (org-test-with-temp-text "@@back-end:contents@@"
723 (org-element-parse-buffer) 'export-snippet
724 (lambda (snippet) (cons (org-element-property :back-end snippet
)
725 (org-element-property :value snippet
)))
731 (ert-deftest test-org-element
/fixed-width
()
732 "Test fixed-width area parsing."
733 ;; Preserve indentation.
735 (org-test-with-temp-text ": no blank\n: one blank"
736 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
737 ;; Fixed-width with empty lines.
739 (org-test-with-temp-text ": first part\n:\n: \n: second part"
740 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
741 ;; Parse indented fixed-width markers.
743 (org-test-with-temp-text "Text\n : no blank\n : one blank"
744 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
745 ;; Distinguish fixed-width areas within a list and outside of it.
749 (org-test-with-temp-text "
752 : fixed-width outside"
754 (org-element-parse-buffer) 'fixed-width
'identity
))))))
757 ;;;; Footnote Definition
759 (ert-deftest test-org-element
/footnote-definition-parser
()
760 "Test `footnote-definition' parser."
762 (org-test-with-temp-text "[fn:1] Definition"
763 (org-element-map (org-element-parse-buffer) 'footnote-definition
765 ;; Footnote with more contents
768 (org-element-property
770 (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
771 (org-element-map (org-element-parse-buffer) 'footnote-definition
773 ;; Footnote starting with special syntax.
775 (org-test-with-temp-text "[fn:1] - no item"
776 (org-element-map (org-element-parse-buffer) 'item
'identity
)))
777 ;; Correctly handle footnote starting with an empty line.
780 (org-test-with-temp-text "[fn:1]\n\n Body"
781 (org-element-property :contents-begin
782 (org-element-at-point))))))
785 ;;;; Footnotes Reference.
787 (ert-deftest test-org-element
/footnote-reference-parser
()
788 "Test `footnote-reference' parser."
789 ;; 1. Parse a standard reference.
790 (org-test-with-temp-text "Text[fn:label]"
793 (org-element-parse-buffer) 'footnote-reference
'identity
)))
794 ;; 2. Parse a normalized reference.
795 (org-test-with-temp-text "Text[1]"
798 (org-element-parse-buffer) 'footnote-reference
'identity
)))
799 ;; 3. Parse an inline reference.
800 (org-test-with-temp-text "Text[fn:test:def]"
803 (org-element-parse-buffer) 'footnote-reference
'identity
)))
804 ;; 4. Parse an anonymous reference.
805 (org-test-with-temp-text "Text[fn::def]"
808 (org-element-parse-buffer) 'footnote-reference
'identity
)))
809 ;; 5. Parse nested footnotes.
810 (org-test-with-temp-text "Text[fn::def [fn:label]]"
815 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
816 ;; 6. Parse adjacent footnotes.
817 (org-test-with-temp-text "Text[fn:label1][fn:label2]"
822 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
823 ;; 7. Only properly closed footnotes are recognized as such.
824 (org-test-with-temp-text "Text[fn:label"
827 (org-element-parse-buffer) 'footnote-reference
'identity
))))
832 (ert-deftest test-org-element
/headline-quote-keyword
()
833 "Test QUOTE keyword recognition."
835 (org-test-with-temp-text "* Headline"
836 (let ((org-quote-string "QUOTE"))
837 (should-not (org-element-property :quotedp
(org-element-at-point)))))
838 ;; Standard position.
839 (org-test-with-temp-text "* QUOTE Headline"
840 (let* ((org-quote-string "QUOTE")
841 (headline (org-element-at-point)))
842 (should (org-element-property :quotedp headline
))
843 ;; Test removal from raw value.
844 (should (equal (org-element-property :raw-value headline
) "Headline"))))
846 (org-test-with-temp-text "* QUOTE Headline"
847 (let* ((org-quote-string "Quote")
848 (headline (org-element-at-point)))
849 (should-not (org-element-property :quotedp headline
))
850 (should (equal (org-element-property :raw-value headline
)
852 ;; With another keyword.
853 (org-test-with-temp-text "* TODO QUOTE Headline"
854 (let* ((org-quote-string "QUOTE")
855 (org-todo-keywords '((sequence "TODO" "DONE")))
856 (headline (org-element-at-point)))
857 (should (org-element-property :quotedp headline
))
858 (should (equal (org-element-property :raw-value headline
) "Headline"))))
859 ;; With the keyword only.
860 (org-test-with-temp-text "* QUOTE"
861 (let* ((org-quote-string "QUOTE")
862 (headline (org-element-at-point)))
863 (should (org-element-property :quotedp headline
))
864 (should (equal (org-element-property :raw-value headline
) "")))))
866 (ert-deftest test-org-element
/headline-comment-keyword
()
867 "Test COMMENT keyword recognition."
869 (org-test-with-temp-text "* Headline"
870 (let ((org-comment-string "COMMENT"))
871 (should-not (org-element-property :commentedp
(org-element-at-point)))))
872 ;; Standard position.
873 (org-test-with-temp-text "* COMMENT Headline"
874 (let ((org-comment-string "COMMENT")
875 (headline (org-element-at-point)))
876 (should (org-element-property :commentedp headline
))
877 (should (equal (org-element-property :raw-value headline
) "Headline"))))
879 (org-test-with-temp-text "* COMMENT Headline"
880 (let* ((org-comment-string "Comment")
881 (headline (org-element-at-point)))
882 (should-not (org-element-property :commentedp headline
))
883 (should (equal (org-element-property :raw-value headline
)
884 "COMMENT Headline"))))
885 ;; With another keyword.
886 (org-test-with-temp-text "* TODO COMMENT Headline"
887 (let* ((org-comment-string "COMMENT")
888 (org-todo-keywords '((sequence "TODO" "DONE")))
889 (headline (org-element-at-point)))
890 (should (org-element-property :commentedp headline
))
891 (should (equal (org-element-property :raw-value headline
) "Headline"))))
892 ;; With the keyword only.
893 (org-test-with-temp-text "* COMMENT"
894 (let* ((org-comment-string "COMMENT")
895 (headline (org-element-at-point)))
896 (should (org-element-property :commentedp headline
))
897 (should (equal (org-element-property :raw-value headline
) "")))))
899 (ert-deftest test-org-element
/headline-archive-tag
()
900 "Test ARCHIVE tag recognition."
902 (org-test-with-temp-text "* Headline"
903 (let ((org-archive-tag "ARCHIVE"))
904 (should-not (org-element-property :archivedp
(org-element-at-point)))))
906 (org-test-with-temp-text "* Headline :ARCHIVE:"
907 (let ((org-archive-tag "ARCHIVE"))
908 (let ((headline (org-element-at-point)))
909 (should (org-element-property :archivedp headline
))
911 (should-not (org-element-property :tags headline
))))
912 (let ((org-archive-tag "Archive"))
913 (should-not (org-element-property :archivedp
(org-element-at-point)))))
915 (org-test-with-temp-text "* Headline :test:ARCHIVE:"
916 (let ((org-archive-tag "ARCHIVE"))
917 (let ((headline (org-element-at-point)))
918 (should (org-element-property :archivedp headline
))
920 (should (equal (org-element-property :tags headline
) '("test")))))))
922 (ert-deftest test-org-element
/headline-properties
()
923 "Test properties from property drawer."
924 ;; All properties from property drawer have their symbol upper
927 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
928 (org-element-property :FOO
(org-element-at-point))))
930 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
931 (org-element-property :foo
(org-element-at-point)))))
936 (ert-deftest test-org-element
/horizontal-rule-parser
()
937 "Test `horizontal-rule' parser."
940 (org-test-with-temp-text "-----"
941 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
944 (org-test-with-temp-text " -----"
945 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
946 ;; Hyphen must be alone on the line.
948 (org-test-with-temp-text "-----wrong"
949 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
950 ;; 4 hyphens is too small.
952 (org-test-with-temp-text "----"
953 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
))))
956 ;;;; Inline Babel Call
958 (ert-deftest test-org-element
/inline-babel-call-parser
()
959 "Test `inline-babel-call' parser."
961 (org-test-with-temp-text "call_test()"
963 (org-element-parse-buffer) 'inline-babel-call
'identity
))))
966 ;;;; Inline Src Block
968 (ert-deftest test-org-element
/inline-src-block-parser
()
969 "Test `inline-src-block' parser."
971 (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
972 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
973 ;; Test parsing at the beginning of an item.
975 (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
976 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
))))
981 (ert-deftest test-org-element
/inlinetask-parser
()
982 "Test `inlinetask' parser."
983 (when (featurep 'org-inlinetask
)
984 (let ((org-inlinetask-min-level 15))
985 ;; 1. Regular inlinetask.
987 (org-test-with-temp-text
988 "*************** Task\nTest\n*************** END"
989 (org-element-map (org-element-parse-buffer) 'inlinetask
'identity
)))
990 ;; 2. Degenerate inlinetask.
992 (org-test-with-temp-text "*************** Task"
993 (org-element-map (org-element-parse-buffer) 'inlinetask
'identity
)))
998 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
999 (org-test-with-temp-text "*************** TODO Task"
1000 (org-element-property
1002 (org-element-map (org-element-parse-buffer) 'inlinetask
1003 'identity nil t
))))))
1008 (org-test-with-temp-text "
1009 *************** Task
1010 DEADLINE: <2012-03-29 thu.>"
1011 (org-element-property
1013 (org-element-map (org-element-parse-buffer) 'inlinetask
'identity nil t
)))))
1018 (org-test-with-temp-text "
1019 *************** [#A] Task"
1020 (org-element-property
1023 (org-element-parse-buffer) 'inlinetask
'identity nil t
)))))
1028 (org-test-with-temp-text "
1029 *************** Task :test:"
1030 (org-element-property
1033 (org-element-parse-buffer) 'inlinetask
'identity nil t
)))))
1034 ;; Regular properties are accessed through upper case keywords.
1036 (org-test-with-temp-text "
1037 *************** Task
1041 *************** END"
1043 (org-element-property :FOO
(org-element-at-point))))
1045 (org-test-with-temp-text "
1046 *************** Task
1050 *************** END"
1052 (org-element-property :foo
(org-element-at-point)))))))
1057 (ert-deftest test-org-element
/italic-parser
()
1058 "Test `italic' parser."
1061 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1062 (org-test-with-temp-text "/italic/"
1063 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1064 ;; Multi-line markup.
1067 (org-element-contents
1068 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1069 (org-test-with-temp-text "/first line\nsecond line/"
1070 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1071 '("first line\nsecond line"))))
1076 (ert-deftest test-org-element
/item-parser
()
1077 "Test `item' parser."
1080 (org-test-with-temp-text "- item"
1081 (org-element-map (org-element-parse-buffer) 'item
'identity
)))
1085 (org-element-property
1087 (org-test-with-temp-text "6. [@6] item"
1088 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1093 (org-element-property
1095 (org-test-with-temp-text "- tag :: description"
1096 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1097 ;; No tags in ordered lists.
1099 (org-element-property
1101 (org-test-with-temp-text "1. tag :: description"
1102 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
))))
1107 (org-test-with-temp-text "
1112 (org-element-parse-buffer) 'item
1113 (lambda (item) (org-element-property :checkbox item
))))))
1115 (org-test-with-temp-text "* Headline
1120 (let ((org-cycle-include-plain-lists t
)) (org-cycle))
1122 (org-element-property
1124 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
))))
1125 ;; Item starting with special syntax.
1127 (equal '(("- item"))
1128 (org-test-with-temp-text "- - item"
1130 (org-element-parse-buffer) 'paragraph
'org-element-contents
))))
1131 ;; Block in an item: ignore indentation within the block.
1133 (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
1135 (goto-char (org-element-property :end
(org-element-at-point)))
1141 (ert-deftest test-org-element
/keyword-parser
()
1142 "Test `keyword' parser."
1145 (org-test-with-temp-text "#+KEYWORD: value"
1146 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1147 ;; Keywords are case-insensitive.
1149 (org-test-with-temp-text "#+keyword: value"
1150 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1151 ;; Affiliated keywords are not keywords.
1153 (org-test-with-temp-text "#+NAME: value
1155 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1156 ;; Do not mix keywords with Babel calls and dynamic blocks.
1158 (org-test-with-temp-text "#+CALL: fun()"
1159 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1161 (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
1162 (org-element-map (org-element-parse-buffer) 'keyword
'identity
))))
1165 ;;;; Latex Environment
1167 (ert-deftest test-org-element
/latex-environment-parser
()
1168 "Test `latex-environment' parser."
1170 (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
1171 (org-element-map (org-element-parse-buffer) 'latex-environment
'identity
)))
1172 ;; Allow nested environments.
1180 (org-test-with-temp-text "
1186 (org-element-property
1189 (org-element-parse-buffer) 'latex-environment
'identity nil t
)))))
1190 ;; Allow environments with options and arguments.
1192 (eq 'latex-environment
1193 (org-test-with-temp-text
1194 "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
1195 (org-element-type (org-element-at-point)))))
1197 (eq 'latex-environment
1198 (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
1199 (org-element-type (org-element-at-point)))))
1201 (eq 'latex-environment
1202 (org-test-with-temp-text "\\begin{env}{arg} something\nvalue\n\\end{env}"
1203 (org-element-type (org-element-at-point))))))
1208 (ert-deftest test-org-element
/latex-fragment-parser
()
1209 "Test `latex-fragment' parser."
1211 (org-test-with-temp-text "$a$"
1212 (org-element-map (org-element-parse-buffer) 'latex-fragment
'identity
)))
1214 (org-test-with-temp-text "$$a$$"
1215 (org-element-map (org-element-parse-buffer) 'latex-fragment
'identity
)))
1217 (org-test-with-temp-text "\\(a\\)"
1218 (org-element-map (org-element-parse-buffer) 'latex-fragment
'identity
)))
1220 (org-test-with-temp-text "\\[a\\]"
1222 (org-element-parse-buffer) 'latex-fragment
'identity
)))
1223 ;; Test fragment at the beginning of an item.
1226 (org-test-with-temp-text "- $x$"
1227 (progn (search-forward "$")
1228 (org-element-type (org-element-context)))))))
1233 (ert-deftest test-org-element
/line-break-parser
()
1234 "Test `line-break' parser."
1237 (org-test-with-temp-text "Text \\\\"
1238 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1239 ;; Line break with trailing white spaces.
1241 (org-test-with-temp-text "Text \\\\ "
1242 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1243 ;; Three backslashes are too much.
1245 (org-test-with-temp-text "Text \\\\\\"
1246 (org-element-map (org-element-parse-buffer) 'line-break
'identity
))))
1251 (ert-deftest test-org-element
/link-parser
()
1252 "Test `link' parser."
1257 (org-test-with-temp-text "A radio link"
1258 (org-element-property
1261 (let ((org-target-link-regexp "radio")) (org-element-parse-buffer))
1262 'link
'identity nil t
)))))
1265 ;; ... with description.
1269 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1270 (org-element-contents
1271 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1272 ;; ... without description.
1276 (org-test-with-temp-text "[[http://orgmode.org]]"
1277 (org-element-property
1279 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1280 ;; ... with expansion.
1283 "//orgmode.org/worg"
1284 (org-test-with-temp-text "[[Org:worg]]"
1285 (let ((org-link-abbrev-alist '(("Org" .
"http://orgmode.org/"))))
1286 (org-element-property
1288 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
))))))
1289 ;; ... with translation.
1293 (org-test-with-temp-text "[[http://orgmode.org]]"
1294 (flet ((link-translate (type path
) (cons type
"127.0.0.1")))
1295 (let ((org-link-translation-function 'link-translate
))
1296 (org-element-property
1298 (org-element-map (org-element-parse-buffer) 'link
1299 'identity nil t
)))))))
1304 (org-test-with-temp-text "[[id:aaaa]]"
1305 (org-element-property
1307 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1308 ;; ... custom-id link.
1312 (org-test-with-temp-text "[[#some-id]]"
1313 (org-element-property
1315 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1316 ;; ... coderef link.
1320 (org-test-with-temp-text "[[(reference)]]"
1321 (org-element-property
1323 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1328 (org-test-with-temp-text "[[target-or-title]]"
1329 (org-element-property
1331 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1332 ;; ... file-type link with search option.
1335 '(("file" "projects.org" "*task title"))
1336 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1337 (org-element-map (org-element-parse-buffer) 'link
1338 (lambda (l) (list (org-element-property :type l
)
1339 (org-element-property :path l
)
1340 (org-element-property :search-option l
)))))))
1341 ;; ... file-type link with application.
1344 '(("file" "projects.org" "docview"))
1345 (org-test-with-temp-text "[[docview:projects.org]]"
1346 (org-element-map (org-element-parse-buffer) 'link
1347 (lambda (l) (list (org-element-property :type l
)
1348 (org-element-property :path l
)
1349 (org-element-property :application l
)))))))
1352 (org-test-with-temp-text "A link: http://orgmode.org"
1353 (org-element-map (org-element-parse-buffer) 'link
'identity
)))
1356 (org-test-with-temp-text "A link: <http://orgmode.org>"
1357 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))
1358 ;; Link abbreviation.
1361 (org-test-with-temp-text
1362 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1363 (progn (org-mode-restart)
1364 (goto-char (1- (point-max)))
1365 (org-element-property :type
(org-element-context))))))
1366 ;; Link abbreviation in a secondary string.
1369 (org-test-with-temp-text
1370 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1371 (progn (org-mode-restart)
1372 (org-element-map (org-element-parse-buffer) 'link
1373 (lambda (link) (org-element-property :type link
))
1375 ;; Plain links are allowed as description of regular links.
1378 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1379 (search-forward "file:")
1380 (org-element-property :type
(org-element-context))))))
1385 (ert-deftest test-org-element
/macro-parser
()
1386 "Test `macro' parser."
1387 ;; Without arguments.
1389 (org-test-with-temp-text "{{{macro}}}"
1390 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1393 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1394 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1395 ;; Properly handle protected commas in arguments...
1399 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1400 (org-element-property :args
(org-element-context))))))
1401 ;; ... even when last argument ends with a protected comma.
1404 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1405 (org-element-property :args
(org-element-context)))))
1406 ;; Allow to escape escaping character.
1409 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1410 (org-element-property :args
(org-element-context)))))
1411 ;; No need to escape backslashes elsewhere.
1414 (org-test-with-temp-text "{{{macro(\\)}}}"
1415 (org-element-property :args
(org-element-context))))))
1420 (ert-deftest test-org-element
/node-property
()
1421 "Test `node-property' parser."
1424 (equal '("abc" "value")
1425 (org-test-with-temp-text ":PROPERTIES:\n:abc: value\n:END:"
1426 (progn (forward-line)
1427 (let ((element (org-element-at-point)))
1428 (list (org-element-property :key element
)
1429 (org-element-property :value element
)))))))
1430 ;; Value should be trimmed.
1433 (org-test-with-temp-text ":PROPERTIES:\n:abc: value \n:END:"
1434 (progn (forward-line)
1435 (let ((element (org-element-at-point)))
1436 (org-element-property :value element
))))))
1437 ;; A node property requires to be wrapped within a property drawer.
1440 (org-test-with-temp-text ":abc: value"
1441 (org-element-type (org-element-at-point))))))
1446 (ert-deftest test-org-element
/paragraph-parser
()
1447 "Test `paragraph' parser."
1450 (org-test-with-temp-text "Paragraph"
1451 (org-element-map (org-element-parse-buffer) 'paragraph
'identity nil t
)))
1452 ;; Property find end of a paragraph stuck to another element.
1455 (org-test-with-temp-text "Paragraph\n# Comment"
1457 (org-element-parse-buffer) 'paragraph
1458 (lambda (p) (char-after (org-element-property :end p
)))
1460 ;; Include ill-formed Keywords.
1462 (org-test-with-temp-text "#+wrong_keyword something"
1463 (org-element-map (org-element-parse-buffer) 'paragraph
'identity
)))
1464 ;; Include incomplete-drawers.
1466 (let ((org-drawers '("TEST")))
1467 (org-test-with-temp-text ":TEST:\nParagraph"
1468 (let ((elem (org-element-at-point)))
1469 (and (eq (org-element-type elem
) 'paragraph
)
1470 (= (point-max) (org-element-property :end elem
)))))))
1471 ;; Include non-existent drawers.
1473 (let ((org-drawers '("TEST")))
1474 (org-test-with-temp-text ":NONAME:"
1475 (org-element-map (org-element-parse-buffer) 'paragraph
'identity
))))
1476 ;; Include incomplete blocks.
1478 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1479 (let ((elem (org-element-at-point)))
1480 (and (eq (org-element-type elem
) 'paragraph
)
1481 (= (point-max) (org-element-property :end elem
))))))
1482 ;; Include incomplete dynamic blocks.
1484 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1485 (let ((elem (org-element-at-point)))
1486 (and (eq (org-element-type elem
) 'paragraph
)
1487 (= (point-max) (org-element-property :end elem
))))))
1488 ;; Include incomplete latex environments.
1490 (org-test-with-temp-text "\begin{equation}\nParagraph"
1491 (let ((elem (org-element-at-point)))
1492 (and (eq (org-element-type elem
) 'paragraph
)
1493 (= (point-max) (org-element-property :end elem
))))))
1494 ;; Do not steal affiliated keywords from container.
1496 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
1497 (let ((elem (progn (search-forward "item") (org-element-at-point))))
1498 (and (eq (org-element-type elem
) 'paragraph
)
1499 (not (org-element-property :attr_latex elem
))
1500 (/= (org-element-property :begin elem
) 1))))))
1505 (ert-deftest test-org-element
/plain-list-parser
()
1506 "Test `plain-list' parser."
1507 (org-test-with-temp-text "- item"
1508 (should (org-element-map (org-element-parse-buffer) 'plain-list
'identity
)))
1509 ;; Blank lines after the list only belong to outer plain list.
1513 (org-test-with-temp-text "
1518 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1519 (lambda (pl) (org-element-property :end pl
)))))
1521 ;; Move to ending of outer list.
1522 (progn (goto-char (car endings
)) (looking-at "Outside list"))
1523 ;; Move to ending of inner list.
1524 (progn (goto-char (nth 1 endings
)) (looking-at "^$")))))))
1525 ;; Correctly compute end of list if it doesn't end at a line
1528 (org-test-with-temp-text "- list\n \n "
1529 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1534 (ert-deftest test-org-element
/planning-parser
()
1535 "Test `planning' parser."
1537 (equal "[2012-03-29 thu.]"
1538 (org-element-property
1540 (org-element-property
1542 (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
1543 (org-element-at-point))))))
1545 (equal "<2012-03-29 thu.>"
1546 (org-element-property
1548 (org-element-property
1550 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1551 (org-element-at-point))))))
1553 (equal "<2012-03-29 thu.>"
1554 (org-element-property
1556 (org-element-property
1558 (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
1559 (org-element-at-point)))))))
1562 ;;;; Property Drawer
1564 (ert-deftest test-org-element
/property-drawer
()
1565 "Test `property-drawer' parser."
1568 (let ((org-drawers '("PROPERTIES")))
1569 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
1571 (org-element-parse-buffer) 'property-drawer
'identity nil t
))))
1572 ;; Do not mix property drawers and regular drawers.
1574 (let ((org-drawers '("TEST")))
1575 (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
1577 (org-element-parse-buffer) 'property-drawer
'identity nil t
))))
1578 ;; Ignore incomplete drawer.
1580 (let ((org-drawers '("PROPERTIES")))
1581 (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
1583 (org-element-parse-buffer) 'property-drawer
'identity nil t
)))))
1588 (ert-deftest test-org-element
/quote-block-parser
()
1589 "Test `quote-block' parser."
1592 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1593 (org-element-map (org-element-parse-buffer) 'quote-block
'identity
)))
1594 ;; Test folded block.
1595 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1598 (org-element-property
1601 (org-element-parse-buffer) 'quote-block
'identity nil t
))))
1602 ;; Ignore incomplete block.
1604 (org-test-with-temp-text "#+BEGIN_QUOTE"
1606 (org-element-parse-buffer) 'quote-block
'identity nil t
))))
1611 (ert-deftest test-org-element
/quote-section-parser
()
1612 "Test `quote-section' parser."
1614 (let ((org-quote-string "QUOTE"))
1615 (org-test-with-temp-text "* QUOTE Headline\nBody"
1616 (org-element-map (org-element-parse-buffer) 'quote-section
'identity
))))
1618 (let ((org-quote-string "TEST"))
1619 (org-test-with-temp-text "* QUOTE Headline\nBody"
1620 (org-element-map (org-element-parse-buffer) 'quote-section
'identity
)))))
1625 (ert-deftest test-org-element
/radio-target-parser
()
1626 "Test `radio-target' parser."
1629 (org-test-with-temp-text "<<<radio>>>"
1630 (org-element-map (org-element-parse-buffer) 'radio-target
'identity
)))
1631 ;; Radio targets with objects.
1633 (org-test-with-temp-text "<<<radio \\alpha>>>"
1634 (org-element-map (org-element-parse-buffer) 'radio-target
'identity
))))
1639 (ert-deftest test-org-element
/section-parser
()
1640 "Test `section' parser."
1643 (org-test-with-temp-text "* Headline\nText"
1644 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1645 ;; There's a section before the first headline.
1647 (org-test-with-temp-text "Text"
1648 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1649 ;; A section cannot be empty.
1651 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1652 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1653 ;; A section doesn't contain sub-trees.
1655 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1657 (org-element-map (org-element-parse-buffer) 'section
'identity nil t
)
1658 'headline
'identity
))))
1663 (ert-deftest test-org-element
/special-block-parser
()
1664 "Test `special-block' parser."
1668 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1669 (org-element-property :type
(org-element-at-point)))))
1670 ;; Special blocks can contain paragraphs.
1673 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1675 (org-element-type (org-element-at-point)))))
1676 ;; Test folded block.
1678 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1680 (org-element-property :hiddenp
(org-element-at-point))))
1681 ;; Ignore incomplete block.
1684 (org-test-with-temp-text "#+BEGIN_SPECIAL"
1685 (org-element-type (org-element-at-point)))))
1686 ;; Allow special characters in type.
1688 (equal '(special-block "SPECIAL*")
1689 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
1690 (let ((element (org-element-at-point)))
1691 (list (org-element-type element
)
1692 (org-element-property :type element
)))))))
1697 (ert-deftest test-org-element
/src-block-parser
()
1698 "Test `src-block' parser."
1701 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1702 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
1703 ;; Test folded block.
1705 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1707 (org-element-property :hiddenp
(org-element-at-point))))
1708 ;; Ignore incomplete block.
1710 (org-test-with-temp-text "#+BEGIN_SRC"
1711 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
1712 ;; Properly un-escape code.
1714 (equal "* Headline\n #+keyword\nText\n"
1715 (org-test-with-temp-text
1716 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
1717 (org-element-property :value
(org-element-at-point)))))
1718 ;; Nil `org-src-preserve-indentation': Remove maximum common
1722 (org-test-with-temp-text "#+BEGIN_SRC org\n L1\n L2\n#+END_SRC"
1723 (let ((org-src-preserve-indentation nil
))
1724 (org-element-property :value
(org-element-at-point))))))
1725 ;; Non-nil `org-src-preserve-indentation': Remove block indentation
1726 ;; only, unless block contents are less indented than block
1730 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1731 (let ((org-src-preserve-indentation t
))
1732 (org-element-property :value
(org-element-at-point))))))
1736 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1737 (let ((org-src-preserve-indentation t
))
1738 (org-element-property :value
(org-element-at-point)))))))
1741 ;;;; Statistics Cookie
1743 (ert-deftest test-org-element
/statistics-cookie
()
1744 "Test `statistics-cookie' parser."
1747 (org-test-with-temp-text "[1/2]"
1748 (org-element-map (org-element-parse-buffer) 'statistics-cookie
'identity
)))
1751 (org-test-with-temp-text "[33%]"
1753 (org-element-parse-buffer) 'statistics-cookie
'identity
))))
1758 (ert-deftest test-org-element
/strike-through-parser
()
1759 "Test `strike-through' parser."
1762 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1763 (org-test-with-temp-text "+strike-through+"
1764 (org-element-map (org-element-parse-buffer) 'strike-through
'identity
))))
1765 ;; Multi-line markup.
1768 (org-element-contents
1769 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1770 (org-test-with-temp-text "+first line\nsecond line+"
1772 (org-element-parse-buffer) 'strike-through
'identity nil t
))))
1773 '("first line\nsecond line"))))
1778 (ert-deftest test-org-element
/subscript-parser
()
1779 "Test `subscript' parser."
1782 (org-test-with-temp-text "a_b"
1783 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
1786 (org-test-with-temp-text "a_{b}"
1787 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
1788 ;; Multiple subscripts in a paragraph.
1791 (org-test-with-temp-text "a_b and c_d"
1793 (org-element-map (org-element-parse-buffer) 'subscript
'identity
))))))
1798 (ert-deftest test-org-element
/superscript-parser
()
1799 "Test `superscript' parser."
1802 (org-test-with-temp-text "a^b"
1803 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
1806 (org-test-with-temp-text "a^{b}"
1807 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
1808 ;; Multiple superscript in a paragraph.
1811 (org-test-with-temp-text "a^b and c^d"
1814 (org-element-parse-buffer) 'superscript
'identity
))))))
1819 (ert-deftest test-org-element
/table-parser
()
1820 "Test `table' parser."
1822 (org-test-with-temp-text "| a |"
1823 (org-element-map (org-element-parse-buffer) 'table
'identity
)))
1824 ;; TBLFM keyword is case insensitive.
1826 (org-test-with-temp-text "| a |\n#+tblfm: test"
1827 (org-element-property
1829 (org-element-map (org-element-parse-buffer) 'table
'identity nil t
))))
1830 ;; Handle multiple TBLFM lines.
1833 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
1834 (length (org-element-property
1837 (org-element-parse-buffer) 'table
'identity nil t
))))))
1838 ;; Do not error when parsing a table with trailing white spaces.
1839 (should (org-test-with-temp-text "| a |\n " (org-element-parse-buffer))))
1844 (ert-deftest test-org-element
/table-cell-parser
()
1845 "Test `table-cell' parser."
1847 (org-test-with-temp-text "| a |"
1848 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
))))
1853 (ert-deftest test-org-element
/table-row-parser
()
1854 "Test `table-row' parser."
1856 (equal '(standard rule
)
1857 (org-test-with-temp-text "| a |\n|---|"
1859 (org-element-parse-buffer) 'table-row
1860 (lambda (row) (org-element-property :type row
)))))))
1865 (ert-deftest test-org-element
/target-parser
()
1866 "Test `target' parser."
1868 (org-test-with-temp-text "<<target>>"
1869 (org-element-map (org-element-parse-buffer) 'target
'identity
))))
1874 (ert-deftest test-org-element
/timestamp
()
1875 "Test `timestamp' parser."
1876 ;; Active timestamp.
1878 (org-test-with-temp-text "<2012-03-29 16:40>"
1879 (eq (org-element-property :type
(org-element-context)) 'active
)))
1881 (org-test-with-temp-text "<2012-03-29 Thu>"
1882 (let ((timestamp (org-element-context)))
1883 (or (org-element-property :hour-start timestamp
)
1884 (org-element-property :minute-start timestamp
)))))
1886 (equal '(2012 3 29 16 40)
1887 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
1888 (let ((object (org-element-context)))
1889 (list (org-element-property :year-start object
)
1890 (org-element-property :month-start object
)
1891 (org-element-property :day-start object
)
1892 (org-element-property :hour-start object
)
1893 (org-element-property :minute-start object
))))))
1894 ;; Inactive timestamp.
1896 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
1897 (eq (org-element-property :type
(org-element-context)) 'inactive
)))
1900 (equal '(2012 3 29 16 40 7 30)
1901 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
1902 (let ((object (org-element-context)))
1903 (list (org-element-property :year-end object
)
1904 (org-element-property :month-end object
)
1905 (org-element-property :day-end object
)
1906 (org-element-property :hour-end object
)
1907 (org-element-property :minute-end object
)
1908 (org-element-property :hour-start object
)
1909 (org-element-property :minute-start object
))))))
1912 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
1913 (org-element-property :type
(org-element-context)))))
1916 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
1917 (eq (org-element-property :type
(org-element-context)) 'inactive-range
)))
1919 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
1920 (let ((timestamp (org-element-context)))
1921 (or (org-element-property :hour-end timestamp
)
1922 (org-element-property :minute-end timestamp
)))))
1923 ;; With repeater, warning delay and both.
1926 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
1927 (org-element-property :repeater-type
(org-element-context)))))
1930 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
1931 (org-element-property :warning-type
(org-element-context)))))
1933 (equal '(cumulate all
)
1934 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
1935 (let ((ts (org-element-context)))
1936 (list (org-element-property :repeater-type ts
)
1937 (org-element-property :warning-type ts
))))))
1938 ;; Timestamps are not planning elements.
1940 (org-test-with-temp-text "SCHEDULED: <2012-03-29 Thu 16:40>"
1941 (org-element-map (org-element-parse-buffer) 'timestamp
'identity
))))
1946 (ert-deftest test-org-element
/underline-parser
()
1947 "Test `underline' parser."
1950 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1951 (org-test-with-temp-text "_underline_"
1952 (org-element-map (org-element-parse-buffer) 'underline
'identity
))))
1953 ;; Multi-line markup.
1956 (org-element-contents
1957 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1958 (org-test-with-temp-text "_first line\nsecond line_"
1960 (org-element-parse-buffer) 'underline
'identity nil t
))))
1961 '("first line\nsecond line"))))
1966 (ert-deftest test-org-element
/verbatim-parser
()
1967 "Test `verbatim' parser."
1970 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1971 (org-test-with-temp-text "=verbatim="
1972 (org-element-map (org-element-parse-buffer) 'verbatim
'identity
))))
1973 ;; Multi-line markup.
1976 (org-element-property
1978 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1979 (org-test-with-temp-text "=first line\nsecond line="
1981 (org-element-parse-buffer) 'verbatim
'identity nil t
))))
1982 "first line\nsecond line")))
1987 (ert-deftest test-org-element
/verse-block-parser
()
1988 "Test `verse-block' parser."
1990 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
1992 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
1994 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
1996 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
1998 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
1999 (org-hide-block-all)
2001 (org-element-property
2004 (org-element-parse-buffer) 'verse-block
'identity nil t
))))
2005 ;; Parse objects in verse blocks.
2006 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2007 (should (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
2008 ;; Ignore incomplete verse block.
2010 (org-test-with-temp-text "#+BEGIN_VERSE"
2012 (org-element-parse-buffer) 'verse-block
'identity nil t
))))
2016 ;;; Test Interpreters.
2018 (ert-deftest test-org-element
/affiliated-keywords-interpreter
()
2019 "Test if affiliated keywords are correctly interpreted."
2020 ;; Interpret simple keywords.
2023 (org-element-interpret-data
2024 '(org-data nil
(paragraph (:name
"para") "Paragraph")))
2025 "#+NAME: para\nParagraph\n"))
2026 ;; Interpret multiple keywords.
2029 (org-element-interpret-data
2030 '(org-data nil
(paragraph (:attr_ascii
("line2" "line1")) "Paragraph")))
2031 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2032 ;; Interpret parsed keywords.
2035 (org-element-interpret-data
2036 '(org-data nil
(paragraph (:caption
(("caption"))) "Paragraph")))
2037 "#+CAPTION: caption\nParagraph\n"))
2038 ;; Interpret dual keywords.
2041 (org-element-interpret-data
2042 '(org-data nil
(paragraph (:caption
((("long") "short"))) "Paragraph")))
2043 "#+CAPTION[short]: long\nParagraph\n"))
2044 ;; Interpret multiple parsed dual keywords.
2047 (org-element-interpret-data
2048 '(org-data nil
(paragraph
2049 (:caption
((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2050 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n")))
2052 (ert-deftest test-org-element
/center-block-interpreter
()
2053 "Test center block interpreter."
2055 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2056 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2058 (ert-deftest test-org-element
/drawer-interpreter
()
2059 "Test drawer interpreter."
2061 (equal (let ((org-drawers '("TEST")))
2062 (org-test-parse-and-interpret ":TEST:\nTest\n:END:"))
2063 ":TEST:\nTest\n:END:\n")))
2065 (ert-deftest test-org-element
/dynamic-block-interpreter
()
2066 "Test dynamic block interpreter."
2068 (equal (org-test-parse-and-interpret
2069 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2070 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2072 (ert-deftest test-org-element
/footnote-definition-interpreter
()
2073 "Test footnote definition interpreter."
2074 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2076 (ert-deftest test-org-element
/headline-interpreter
()
2077 "Test headline and section interpreters."
2078 ;; 1. Standard test.
2079 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2080 ;; 2. With TODO keywords.
2082 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2083 (org-test-parse-and-interpret "* TODO Headline"))
2084 "* TODO Headline\n"))
2087 ;; 3.1. ... and a positive `org-tags-column' value.
2089 (equal (let ((org-tags-column 20))
2090 (org-test-parse-and-interpret "* Headline :tag:"))
2091 "* Headline :tag:\n"))
2092 ;; 3.2. ... and a negative `org-tags-column' value.
2094 (equal (let ((org-tags-column -
20))
2095 (org-test-parse-and-interpret "* Headline :tag:"))
2096 "* Headline :tag:\n"))
2097 ;; 3.3. ... and a null `org-tags-column' value.
2099 (equal (let ((org-tags-column 0))
2100 (org-test-parse-and-interpret "* Headline :tag:"))
2101 "* Headline :tag:\n"))
2102 ;; 4. With priority cookie.
2104 (equal (org-test-parse-and-interpret "* [#B] Headline")
2105 "* [#B] Headline\n"))
2106 ;; 5. With comment keyword.
2108 (equal (let ((org-comment-string "COMMENT"))
2109 (org-test-parse-and-interpret "* COMMENT Headline"))
2110 "* COMMENT Headline\n"))
2111 ;; 6. With quote section.
2113 (equal (let ((org-quote-string "QUOTE"))
2114 (org-test-parse-and-interpret "* QUOTE Headline"))
2115 "* QUOTE Headline\n"))
2116 ;; 7. Keep same number of blank lines before body.
2118 (equal (org-test-parse-and-interpret
2119 "* Headline\n\n\nText after two blank lines.")
2120 "* Headline\n\n\nText after two blank lines.\n")))
2122 (ert-deftest test-org-element
/inlinetask-interpreter
()
2123 "Test inlinetask interpretation."
2124 (when (featurep 'org-inlinetask
)
2125 (let ((org-inlinetask-min-level 15))
2126 ;; 1. Regular inlinetask.
2127 (should (equal (org-test-parse-and-interpret
2128 "*************** Task\nTest\n*************** END")
2129 "*************** Task\nTest\n*************** END\n"))
2130 ;; 2. Degenerate inlinetask.
2131 (should (equal (org-test-parse-and-interpret "*************** Task")
2132 "*************** Task\n"))
2133 ;; 3. Prefer degenerate form when there are no contents.
2134 (should (equal (org-test-parse-and-interpret
2135 "*************** Task\n*************** END")
2136 "*************** Task\n"))
2137 ;; 4. With TODO keywords.
2139 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2140 (org-test-parse-and-interpret "*************** TODO Task"))
2141 "*************** TODO Task\n"))
2144 ;; 5.1. ... and a positive `org-tags-column' value.
2146 (equal (let ((org-tags-column 30))
2147 (org-test-parse-and-interpret "*************** Task :tag:"))
2148 "*************** Task :tag:\n"))
2149 ;; 5.2. ... and a negative `org-tags-column' value.
2151 (equal (let ((org-tags-column -
30))
2152 (org-test-parse-and-interpret "*************** Task :tag:"))
2153 "*************** Task :tag:\n"))
2154 ;; 5.3. ... and a null `org-tags-column' value.
2156 (equal (let ((org-tags-column 0))
2157 (org-test-parse-and-interpret "*************** Task :tag:"))
2158 "*************** Task :tag:\n"))
2159 ;; 6. With priority cookie.
2161 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2162 "*************** [#B] Task\n")))))
2164 (ert-deftest test-org-element
/plain-list-interpreter
()
2165 "Test plain-list and item interpreters."
2166 (let ((org-list-two-spaces-after-bullet-regexp nil
))
2168 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2169 ;; Description list.
2171 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2174 (equal (let ((org-plain-list-ordered-item-terminator t
))
2175 (org-test-parse-and-interpret "1. Item"))
2178 (equal (let ((org-plain-list-ordered-item-terminator ?\
)))
2179 (org-test-parse-and-interpret "1) Item"))
2181 ;; Ordered list with counter.
2183 (equal (let ((org-plain-list-ordered-item-terminator t
))
2184 (org-test-parse-and-interpret "1. [@5] Item"))
2186 ;; List with check-boxes.
2188 (equal (org-test-parse-and-interpret
2189 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2190 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2191 ;; Item not starting with a paragraph.
2193 (equal (org-test-parse-and-interpret "-\n | a | b |")
2194 "- \n | a | b |\n"))
2195 ;; Special case: correctly handle "*" bullets.
2196 (should (org-test-parse-and-interpret " * item"))
2197 ;; Special case: correctly handle empty items.
2198 (should (org-test-parse-and-interpret "-"))))
2200 (ert-deftest test-org-element
/quote-block-interpreter
()
2201 "Test quote block interpreter."
2202 (should (equal (org-test-parse-and-interpret
2203 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2204 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2206 (ert-deftest test-org-element
/special-block-interpreter
()
2207 "Test special block interpreter."
2208 (should (equal (org-test-parse-and-interpret
2209 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2210 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2212 (ert-deftest test-org-element
/babel-call-interpreter
()
2213 "Test babel call interpreter."
2214 ;; 1. Without argument.
2215 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2216 "#+CALL: test()\n"))
2217 ;; 2. With argument.
2218 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2219 "#+CALL: test(x=2)\n"))
2220 ;; 3. With header arguments.
2221 (should (equal (org-test-parse-and-interpret
2222 "#+CALL: test[:results output]()[:results html]")
2223 "#+CALL: test[:results output]()[:results html]\n")))
2225 (ert-deftest test-org-element
/clock-interpreter
()
2226 "Test clock interpreter."
2229 (equal (let ((org-clock-string "CLOCK:"))
2230 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]"))
2231 "CLOCK: [2012-01-01 sun. 00:01]\n"))
2235 (let ((org-clock-string "CLOCK:"))
2236 (org-test-parse-and-interpret "
2237 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))
2238 "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01\n")))
2240 (ert-deftest test-org-element
/comment-interpreter
()
2241 "Test comment interpreter."
2243 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2245 (should (equal (org-test-parse-and-interpret " # Comment")
2247 ;; Preserve indentation.
2248 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2249 "# No blank\n# One blank\n")))
2251 (ert-deftest test-org-element
/comment-block-interpreter
()
2252 "Test comment block interpreter."
2253 (should (equal (org-test-parse-and-interpret
2254 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2255 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
2257 (ert-deftest test-org-element
/diary-sexp
()
2258 "Test diary-sexp interpreter."
2261 (org-test-parse-and-interpret
2262 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2263 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2265 (ert-deftest test-org-element
/example-block-interpreter
()
2266 "Test example block interpreter."
2267 ;; Without switches.
2268 (should (equal (org-test-parse-and-interpret
2269 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2270 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2273 (equal (org-test-parse-and-interpret
2274 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2275 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2276 ;; Preserve code escaping.
2278 (equal (org-test-parse-and-interpret
2279 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2280 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n")))
2282 (ert-deftest test-org-element
/export-block-interpreter
()
2283 "Test export block interpreter."
2284 (should (equal (org-test-parse-and-interpret
2285 "#+BEGIN_HTML\nTest\n#+END_HTML")
2286 "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
2288 (ert-deftest test-org-element
/fixed-width-interpreter
()
2289 "Test fixed width interpreter."
2291 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2292 ;; Preserve indentation.
2293 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2294 ": 2 blanks\n: 1 blank\n"))
2295 ;; Remove last newline character
2297 (equal (org-element-fixed-width-interpreter
2298 '(fixed-width (:value
"Test\n")) nil
)
2301 (equal (org-element-fixed-width-interpreter
2302 '(fixed-width (:value
"Test")) nil
)
2304 ;; Handle empty string.
2306 (equal (org-element-fixed-width-interpreter
2307 '(fixed-width (:value
"")) nil
)
2309 ;; Handle nil value.
2311 (org-element-fixed-width-interpreter
2312 '(fixed-width (:value nil
)) nil
)))
2314 (ert-deftest test-org-element
/horizontal-rule-interpreter
()
2315 "Test horizontal rule interpreter."
2316 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2318 (ert-deftest test-org-element
/keyword-interpreter
()
2319 "Test keyword interpreter."
2320 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2321 "#+KEYWORD: value\n")))
2323 (ert-deftest test-org-element
/latex-environment-interpreter
()
2324 "Test latex environment interpreter."
2325 (should (equal (org-test-parse-and-interpret
2326 "\\begin{equation}\n1+1=2\n\\end{equation}")
2327 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2328 (should (equal (org-test-parse-and-interpret
2329 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2330 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2332 (ert-deftest test-org-element
/planning-interpreter
()
2333 "Test planning interpreter."
2334 (let ((org-closed-string "CLOSED:")
2335 (org-deadline-string "DEADLINE:")
2336 (org-scheduled-string "SCHEDULED:"))
2339 (org-test-parse-and-interpret
2341 DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01> CLOSED: [2012-01-01]")
2343 DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01> CLOSED: [2012-01-01]\n"))))
2345 (ert-deftest test-org-element
/property-drawer-interpreter
()
2346 "Test property drawer interpreter."
2347 (should (equal (let ((org-property-format "%-10s %s"))
2348 (org-test-parse-and-interpret
2349 ":PROPERTIES:\n:prop: value\n:END:"))
2350 ":PROPERTIES:\n:prop: value\n:END:\n")))
2352 (ert-deftest test-org-element
/src-block-interpreter
()
2353 "Test src block interpreter."
2356 (equal (let ((org-edit-src-content-indentation 2))
2357 (org-test-parse-and-interpret
2358 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2359 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2362 (equal (let ((org-edit-src-content-indentation 2))
2363 (org-test-parse-and-interpret
2364 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2365 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2366 ;; Preserve code escaping.
2368 (equal (let ((org-edit-src-content-indentation 2))
2369 (org-test-parse-and-interpret
2370 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2371 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2372 ;; Do not apply `org-edit-src-content-indentation' when preserving
2375 (equal (let ((org-edit-src-content-indentation 2)
2376 (org-src-preserve-indentation t
))
2377 (org-test-parse-and-interpret
2378 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2379 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2381 (equal (let ((org-edit-src-content-indentation 2)
2382 (org-src-preserve-indentation nil
))
2383 (org-test-parse-and-interpret
2384 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2385 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n")))
2387 (ert-deftest test-org-element
/table-interpreter
()
2388 "Test table, table-row and table-cell interpreters."
2390 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2391 "| a | b |\n| c | d |\n"))
2392 ;; 2. With horizontal rules.
2393 (should (equal (org-test-parse-and-interpret
2394 "| a | b |\n|---+---|\n| c | d |")
2395 "| a | b |\n|---+---|\n| c | d |\n"))
2396 ;; 3. With meta-data.
2397 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2398 "| / | < | > |\n| * | 1 | 2 |\n"))
2399 ;; 4. With a formula.
2401 (equal (org-test-parse-and-interpret
2402 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2403 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2404 ;; 5. With multiple formulas.
2406 (equal (org-test-parse-and-interpret
2407 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2408 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2410 (ert-deftest test-org-element
/timestamp-interpreter
()
2411 "Test timestamp interpreter."
2413 (should (equal (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")
2414 "<2012-03-29 thu. 16:40>\n"))
2416 (string-match "<2012-03-29 .* 16:40>"
2417 (org-element-timestamp-interpreter
2419 (:type active
:year-start
2012 :month-start
3 :day-start
29
2420 :hour-start
16 :minute-start
40)) nil
)))
2422 (should (equal (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")
2423 "[2012-03-29 thu. 16:40]\n"))
2426 "\\[2012-03-29 .* 16:40\\]"
2427 (org-element-timestamp-interpreter
2429 (:type inactive
:year-start
2012 :month-start
3 :day-start
29
2430 :hour-start
16 :minute-start
40)) nil
)))
2432 (should (equal (org-test-parse-and-interpret
2433 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")
2434 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>\n"))
2437 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2438 (org-element-timestamp-interpreter
2440 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2441 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2442 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2444 (should (equal (org-test-parse-and-interpret
2445 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")
2446 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]\n"))
2449 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2450 (org-element-timestamp-interpreter
2452 (:type inactive-range
:year-start
2012 :month-start
3 :day-start
29
2453 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2454 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2456 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2457 "<%%diary-float t 4 2>\n"))
2458 ;; Timestamp with repeater interval, with delay, with both.
2459 (should (equal (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")
2460 "<2012-03-29 thu. +1y>\n"))
2463 "<2012-03-29 .* \\+1y>"
2464 (org-element-timestamp-interpreter
2466 (:type active
:year-start
2012 :month-start
3 :day-start
29
2467 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2471 "<2012-03-29 .* -1y>"
2472 (org-element-timestamp-interpreter
2474 (:type active
:year-start
2012 :month-start
3 :day-start
29
2475 :warning-type all
:warning-value
1 :warning-unit year
))
2479 "<2012-03-29 .* \\+1y -1y>"
2480 (org-element-timestamp-interpreter
2482 (:type active
:year-start
2012 :month-start
3 :day-start
29
2483 :warning-type all
:warning-value
1 :warning-unit year
2484 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2486 ;; Timestamp range with repeater interval
2487 (should (equal (org-test-parse-and-interpret
2488 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")
2489 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>\n"))
2492 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2493 (org-element-timestamp-interpreter
2495 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2496 :year-end
2012 :month-end
3 :day-end
30 :repeater-type cumulate
2497 :repeater-value
1 :repeater-unit year
))
2500 (ert-deftest test-org-element
/verse-block-interpreter
()
2501 "Test verse block interpretation."
2503 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2504 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2506 (ert-deftest test-org-element
/bold-interpreter
()
2507 "Test bold interpreter."
2508 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2510 (ert-deftest test-org-element
/code-interpreter
()
2511 "Test code interpreter."
2512 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2514 (ert-deftest test-org-element
/entity-interpreter
()
2515 "Test entity interpreter."
2516 ;; 1. Without brackets.
2518 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2519 ;; 2. With brackets.
2521 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2523 (ert-deftest test-org-element
/export-snippet-interpreter
()
2524 "Test export snippet interpreter."
2525 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2526 "@@back-end:contents@@\n")))
2528 (ert-deftest test-org-element
/footnote-reference-interpreter
()
2529 "Test footnote reference interpreter."
2530 ;; 1. Regular reference.
2531 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2532 ;; 2. Normalized reference.
2533 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2534 ;; 3. Named reference.
2535 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2536 "Text[fn:label]\n"))
2537 ;; 4. Inline reference.
2538 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2539 "Text[fn:label:def]\n"))
2540 ;; 5. Anonymous reference.
2541 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2542 "Text[fn::def]\n")))
2544 (ert-deftest test-org-element
/inline-babel-call-interpreter
()
2545 "Test inline babel call interpreter."
2546 ;; 1. Without arguments.
2547 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2548 ;; 2. With arguments.
2549 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2550 "call_test(x=2)\n"))
2551 ;; 3. With header arguments.
2552 (should (equal (org-test-parse-and-interpret
2553 "call_test[:results output]()[:results html]")
2554 "call_test[:results output]()[:results html]\n")))
2556 (ert-deftest test-org-element
/inline-src-block-interpreter
()
2557 "Test inline src block interpreter."
2558 ;; 1. Without header argument.
2559 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2560 "src_emacs-lisp{(+ 1 1)}\n"))
2561 ;; 2. With header arguments.
2562 (should (equal (org-test-parse-and-interpret
2563 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2564 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2566 (ert-deftest test-org-element
/italic-interpreter
()
2567 "Test italic interpreter."
2568 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2570 (ert-deftest test-org-element
/latex-fragment-interpreter
()
2571 "Test latex fragment interpreter."
2572 (let ((org-latex-regexps
2573 '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^