;;; test-org-export.el --- Tests for org-export.el ;; Copyright (C) 2012 Nicolas Goaziou ;; Author: Nicolas Goaziou ;; This file is not part of GNU Emacs. ;; This program is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. ;; This program is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with this program. If not, see . ;;; Code: (unless (featurep 'org-export) (signal 'missing-test-dependency "org-export")) (defmacro org-test-with-backend (backend &rest body) "Execute body with an export back-end defined. BACKEND is the name of the back-end. BODY is the body to execute. The defined back-end simply returns parsed data as Org syntax." (declare (debug (form body)) (indent 1)) `(let ((org-export-registered-backends ',(list (list backend :translate-alist (let (transcode-table) (dolist (type (append org-element-all-elements org-element-all-objects) transcode-table) (push (cons type (lambda (obj contents info) (funcall (intern (format "org-element-%s-interpreter" type)) obj contents))) transcode-table))))))) (progn ,@body))) (defmacro org-test-with-parsed-data (data &rest body) "Execute body with parsed data available. DATA is a string containing the data to be parsed. BODY is the body to execute. Parse tree is available under the `tree' variable, and communication channel under `info'. This function calls `org-export-collect-tree-properties'. As such, `:ignore-list' (for `org-element-map') and `:parse-tree' (for `org-export-get-genealogy') properties are already filled in `info'." (declare (debug (form body)) (indent 1)) `(org-test-with-temp-text ,data (let* ((tree (org-element-parse-buffer)) (info (org-export-collect-tree-properties tree (org-export-get-environment)))) ,@body))) ;;; Internal Tests (ert-deftest test-org-export/bind-keyword () "Test reading #+BIND: keywords." ;; Test with `org-export-all-BIND' set to t. (should (org-test-with-temp-text "#+BIND: variable value" (let ((org-export-allow-BIND t)) (org-export--install-letbind-maybe) (eq variable 'value)))) ;; Test with `org-export-all-BIND' set to nil. (should-not (org-test-with-temp-text "#+BIND: variable value" (let ((org-export-allow-BIND nil)) (org-export--install-letbind-maybe) (boundp 'variable)))) ;; Test with `org-export-all-BIND' set to 'confirm and ;; `org-export--allow-BIND-local' to t . (should (org-test-with-temp-text "#+BIND: variable value" (let ((org-export-allow-BIND 'confirm)) (org-set-local 'org-export--allow-BIND-local t) (org-export--install-letbind-maybe) (eq variable 'value)))) ;; Test with `org-export-all-BIND' set to 'confirm and ;; `org-export--allow-BIND-local' to nil. (should-not (org-test-with-temp-text "#+BIND: variable value" (let ((org-export-allow-BIND 'confirm)) (org-set-local 'org-export--allow-BIND-local nil) (org-export--install-letbind-maybe) (boundp 'variable)))) ;; BIND keywords are case-insensitive. (should (org-test-with-temp-text "#+bind: variable value" (let ((org-export-allow-BIND t)) (org-export--install-letbind-maybe) (eq variable 'value))))) (ert-deftest test-org-export/parse-option-keyword () "Test reading all standard #+OPTIONS: items." (should (equal (org-export--parse-option-keyword "H:1 num:t \\n:t timestamp:t arch:t author:t creator:t d:t email:t *:t e:t ::t f:t pri:t -:t ^:t toc:t |:t tags:t tasks:t <:t todo:t inline:nil stat:t") '(:headline-levels 1 :preserve-breaks t :section-numbers t :time-stamp-file t :with-archived-trees t :with-author t :with-creator t :with-drawers t :with-email t :with-emphasize t :with-entities t :with-fixed-width t :with-footnotes t :with-inlinetasks nil :with-priority t :with-special-strings t :with-statistics-cookies t :with-sub-superscript t :with-toc t :with-tables t :with-tags t :with-tasks t :with-timestamps t :with-todo-keywords t))) ;; Test some special values. (should (equal (org-export--parse-option-keyword "arch:headline creator:comment d:(\"TEST\") ^:{} toc:1 tags:not-in-toc tasks:todo num:2 <:active") '( :section-numbers 2 :with-archived-trees headline :with-creator comment :with-drawers ("TEST") :with-sub-superscript {} :with-toc 1 :with-tags not-in-toc :with-tasks todo :with-timestamps active)))) (ert-deftest test-org-export/get-inbuffer-options () "Test reading all standard export keywords." (should (equal (org-test-with-temp-text "#+AUTHOR: Me, Myself and I #+CREATOR: Idem #+DATE: Today #+DESCRIPTION: Testing #+DESCRIPTION: with two lines #+EMAIL: some@email.org #+EXCLUDE_TAGS: noexport invisible #+KEYWORDS: test #+LANGUAGE: en #+SELECT_TAGS: export #+TITLE: Some title #+TITLE: with spaces" (org-export--get-inbuffer-options)) '(:author ("Me, Myself and I") :creator "Idem" :date ("Today") :description "Testing\nwith two lines" :email "some@email.org" :exclude-tags ("noexport" "invisible") :keywords "test" :language "en" :select-tags ("export") :title ("Some title with spaces"))))) (ert-deftest test-org-export/get-subtree-options () "Test setting options from headline's properties." ;; EXPORT_TITLE. (org-test-with-temp-text "#+TITLE: Title * Headline :PROPERTIES: :EXPORT_TITLE: Subtree Title :END: Paragraph" (forward-line) (should (equal (plist-get (org-export-get-environment nil t) :title) '("Subtree Title")))) :title '("subtree-title") ;; EXPORT_OPTIONS. (org-test-with-temp-text "#+OPTIONS: H:1 * Headline :PROPERTIES: :EXPORT_OPTIONS: H:2 :END: Paragraph" (forward-line) (should (= 2 (plist-get (org-export-get-environment nil t) :headline-levels)))) ;; EXPORT_DATE. (org-test-with-temp-text "#+DATE: today * Headline :PROPERTIES: :EXPORT_DATE: 29-03-2012 :END: Paragraph" (forward-line) (should (equal (plist-get (org-export-get-environment nil t) :date) '("29-03-2012")))) ;; Properties with `split' behaviour are stored as a list of ;; strings. (should (equal '("a" "b") (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport * Headline :PROPERTIES: :EXPORT_EXCLUDE_TAGS: a b :END: Paragraph" (progn (forward-line) (plist-get (org-export-get-environment nil t) :exclude-tags))))) ;; Handle :PROPERTY+: syntax. (should (equal '("a" "b") (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport * Headline :PROPERTIES: :EXPORT_EXCLUDE_TAGS: a :EXPORT_EXCLUDE_TAGS+: b :END: Paragraph" (progn (forward-line) (plist-get (org-export-get-environment nil t) :exclude-tags))))) ;; Export properties are case-insensitive. (org-test-with-temp-text "* Headline :PROPERTIES: :EXPORT_Date: 29-03-2012 :END: Paragraph" (should (equal (plist-get (org-export-get-environment nil t) :date) '("29-03-2012"))))) (ert-deftest test-org-export/handle-options () "Test if export options have an impact on output." ;; Test exclude tags. (org-test-with-temp-text "* Head1 :noexport:" (org-test-with-backend test (should (equal (org-export-as 'test nil nil nil '(:exclude-tags ("noexport"))) "")))) ;; Test include tags. (org-test-with-temp-text " * Head1 * Head2 ** Sub-Head2.1 :export: *** Sub-Head2.1.1 * Head2" (org-test-with-backend test (should (equal "* Head2\n** Sub-Head2.1 :export:\n*** Sub-Head2.1.1\n" (let ((org-tags-column 0)) (org-export-as 'test nil nil nil '(:select-tags ("export")))))))) ;; Test mixing include tags and exclude tags. (org-test-with-temp-text " * Head1 :export: ** Sub-Head1 :noexport: ** Sub-Head2 * Head2 :noexport: ** Sub-Head1 :export:" (org-test-with-backend test (should (string-match "\\* Head1[ \t]+:export:\n\\*\\* Sub-Head2\n" (org-export-as 'test nil nil nil '(:select-tags ("export") :exclude-tags ("noexport"))))))) ;; Ignore tasks. (let ((org-todo-keywords '((sequence "TODO" "DONE")))) (org-test-with-temp-text "* TODO Head1" (org-test-with-backend test (should (equal (org-export-as 'test nil nil nil '(:with-tasks nil)) ""))))) (let ((org-todo-keywords '((sequence "TODO" "DONE")))) (org-test-with-temp-text "* TODO Head1" (org-test-with-backend test (should (equal (org-export-as 'test nil nil nil '(:with-tasks t)) "* TODO Head1\n"))))) ;; Archived tree. (org-test-with-temp-text "* Head1 :archive:" (let ((org-archive-tag "archive")) (org-test-with-backend test (should (equal (org-export-as 'test nil nil nil '(:with-archived-trees nil)) ""))))) (org-test-with-temp-text "* Head1 :archive:\nbody\n** Sub-head 2" (let ((org-archive-tag "archive")) (org-test-with-backend test (should (string-match "\\* Head1[ \t]+:archive:" (org-export-as 'test nil nil nil '(:with-archived-trees headline))))))) (org-test-with-temp-text "* Head1 :archive:" (let ((org-archive-tag "archive")) (org-test-with-backend test (should (string-match "\\`\\* Head1[ \t]+:archive:\n\\'" (org-export-as 'test nil nil nil '(:with-archived-trees t))))))) ;; Drawers. (let ((org-drawers '("TEST"))) (org-test-with-temp-text ":TEST:\ncontents\n:END:" (org-test-with-backend test (should (equal (org-export-as 'test nil nil nil '(:with-drawers nil)) "")) (should (equal (org-export-as 'test nil nil nil '(:with-drawers t)) ":TEST:\ncontents\n:END:\n"))))) (let ((org-drawers '("FOO" "BAR"))) (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:" (org-test-with-backend test (should (equal (org-export-as 'test nil nil nil '(:with-drawers ("FOO"))) ":FOO:\nkeep\n:END:\n"))))) ;; Timestamps. (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>" (org-test-with-backend test (should (equal (org-export-as 'test nil nil nil '(:with-timestamps t)) "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>\n")) (should (equal (org-export-as 'test nil nil nil '(:with-timestamps nil)) "")) (should (equal (org-export-as 'test nil nil nil '(:with-timestamps active)) "<2012-04-29 sun. 10:45>\n")) (should (equal (org-export-as 'test nil nil nil '(:with-timestamps inactive)) "[2012-04-29 sun. 10:45]\n")))) ;; Clocks. (let ((org-clock-string "CLOCK:")) (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]" (org-test-with-backend test (should (equal (org-export-as 'test nil nil nil '(:with-clocks t)) "CLOCK: [2012-04-29 sun. 10:45]\n")) (should (equal (org-export-as 'test nil nil nil '(:with-clocks nil)) ""))))) ;; Plannings. (let ((org-closed-string "CLOSED:")) (org-test-with-temp-text "CLOSED: [2012-04-29 sun. 10:45]" (org-test-with-backend test (should (equal (org-export-as 'test nil nil nil '(:with-plannings t)) "CLOSED: [2012-04-29 sun. 10:45]\n")) (should (equal (org-export-as 'test nil nil nil '(:with-plannings nil)) ""))))) ;; Inlinetasks. (when (featurep 'org-inlinetask) (should (equal (let ((org-inlinetask-min-level 15)) (org-test-with-temp-text "*************** Task" (org-test-with-backend test (org-export-as 'test nil nil nil '(:with-inlinetasks nil))))) "")) (should (equal (let ((org-inlinetask-min-level 15)) (org-test-with-temp-text "*************** Task\nContents\n*************** END" (org-test-with-backend test (org-export-as 'test nil nil nil '(:with-inlinetasks nil))))) ""))) ;; Statistics cookies. (should (equal "" (org-test-with-temp-text "[0/0]" (org-test-with-backend test (org-export-as 'test nil nil nil '(:with-statistics-cookies nil))))))) (ert-deftest test-org-export/comment-tree () "Test if export process ignores commented trees." (let ((org-comment-string "COMMENT")) (org-test-with-temp-text "* COMMENT Head1" (org-test-with-backend test (should (equal (org-export-as 'test) "")))))) (ert-deftest test-org-export/export-scope () "Test all export scopes." (org-test-with-temp-text " * Head1 ** Head2 text *** Head3" (org-test-with-backend test ;; Subtree. (forward-line 3) (should (equal (org-export-as 'test 'subtree) "text\n*** Head3\n")) ;; Visible. (goto-char (point-min)) (forward-line) (org-cycle) (should (equal (org-export-as 'test nil 'visible) "* Head1\n")) ;; Region. (goto-char (point-min)) (forward-line 3) (transient-mark-mode 1) (push-mark (point) t t) (goto-char (point-at-eol)) (should (equal (org-export-as 'test) "text\n")))) ;; Subtree with a code block calling another block outside. (should (equal ": 3\n" (org-test-with-temp-text " * Head1 #+BEGIN_SRC emacs-lisp :noweb yes :exports results <> #+END_SRC * Head2 #+NAME: test #+BEGIN_SRC emacs-lisp \(+ 1 2) #+END_SRC" (org-test-with-backend test (forward-line 1) (org-export-as 'test 'subtree))))) ;; Body only. (org-test-with-temp-text "Text" (org-test-with-backend test (plist-put (cdr (assq 'test org-export-registered-backends)) :translate-alist (cons (cons 'template (lambda (body info) (format "BEGIN\n%sEND" body))) (org-export-backend-translate-table 'test))) (should (equal (org-export-as 'test nil nil 'body-only) "Text\n")) (should (equal (org-export-as 'test) "BEGIN\nText\nEND"))))) (ert-deftest test-org-export/expand-include () "Test file inclusion in an Org buffer." ;; Error when file isn't specified. (should-error (org-test-with-temp-text "#+INCLUDE: dummy.org" (org-export-expand-include-keyword))) ;; Full insertion with recursive inclusion. (org-test-with-temp-text (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir) (org-export-expand-include-keyword) (should (equal (buffer-string) "Small Org file with an include keyword. #+BEGIN_SRC emacs-lisp :exports results\n(+ 2 1)\n#+END_SRC Success! * Heading body\n"))) ;; Localized insertion. (org-test-with-temp-text (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\"" org-test-dir) (org-export-expand-include-keyword) (should (equal (buffer-string) "Small Org file with an include keyword.\n"))) ;; Insertion with constraints on headlines level. (org-test-with-temp-text (format "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-\"" org-test-dir) (org-export-expand-include-keyword) (should (equal (buffer-string) "* Top heading\n** Heading\nbody\n"))) ;; Inclusion within an example block. (org-test-with-temp-text (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" example" org-test-dir) (org-export-expand-include-keyword) (should (equal (buffer-string) "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n"))) ;; Inclusion within a src-block. (org-test-with-temp-text (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"4-5\" src emacs-lisp" org-test-dir) (org-export-expand-include-keyword) (should (equal (buffer-string) "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n")))) (ert-deftest test-org-export/expand-macro () "Test macro expansion in an Org buffer." ;; Standard macro expansion. (should (equal "#+MACRO: macro1 value\nvalue\n" (org-test-with-temp-text "#+MACRO: macro1 value\n{{{macro1}}}" (org-test-with-backend test (org-export-as 'test))))) ;; Expand specific macros. (should (equal "me 2012-03-29 me@here Title\n" (org-test-with-temp-text " #+TITLE: Title #+DATE: 2012-03-29 #+AUTHOR: me #+EMAIL: me@here {{{author}}} {{{date}}} {{{email}}} {{{title}}}" (let ((output (org-test-with-backend test (org-export-as 'test)))) (substring output (string-match ".*\n\\'" output)))))) ;; Expand specific macros when property contained a regular macro ;; already. (should (equal "value\n" (org-test-with-temp-text " #+MACRO: macro1 value #+TITLE: {{{macro1}}} {{{title}}}" (let ((output (org-test-with-backend test (org-export-as 'test)))) (substring output (string-match ".*\n\\'" output)))))) ;; Expand macros with templates in included files. (should (equal "success\n" (org-test-with-temp-text (format "#+INCLUDE: \"%s/examples/macro-templates.org\" {{{included-macro}}}" org-test-dir) (let ((output (org-test-with-backend test (org-export-as 'test)))) (substring output (string-match ".*\n\\'" output))))))) (ert-deftest test-org-export/user-ignore-list () "Test if `:ignore-list' accepts user input." (org-test-with-backend test (flet ((skip-note-head (data backend info) ;; Ignore headlines with the word "note" in their title. (org-element-map data 'headline (lambda (headline) (when (string-match "\\" (org-element-property :raw-value headline)) (org-export-ignore-element headline info))) info) data)) ;; Install function in parse tree filters. (let ((org-export-filter-parse-tree-functions '(skip-note-head))) (org-test-with-temp-text "* Head1\n* Head2 (note)\n" (should (equal (org-export-as 'test) "* Head1\n"))))))) (ert-deftest test-org-export/before-processing-hook () "Test `org-export-before-processing-hook'." (should (equal "#+MACRO: mac val\nTest\n" (org-test-with-backend test (org-test-with-temp-text "#+MACRO: mac val\n{{{mac}}} Test" (let ((org-export-before-processing-hook '((lambda (backend) (while (re-search-forward "{{{" nil t) (let ((object (org-element-context))) (when (eq (org-element-type object) 'macro) (delete-region (org-element-property :begin object) (org-element-property :end object))))))))) (org-export-as 'test))))))) (ert-deftest test-org-export/before-parsing-hook () "Test `org-export-before-parsing-hook'." (should (equal "Body 1\nBody 2\n" (org-test-with-backend test (org-test-with-temp-text "* Headline 1\nBody 1\n* Headline 2\nBody 2" (let ((org-export-before-parsing-hook '((lambda (backend) (org-map-entries (lambda () (delete-region (point) (progn (forward-line) (point))))))))) (org-export-as 'test))))))) ;;; Affiliated Keywords (ert-deftest test-org-export/read-attribute () "Test `org-export-read-attribute' specifications." ;; Standard test. (should (equal (org-export-read-attribute :attr_html (org-test-with-temp-text "#+ATTR_HTML: :a 1 :b 2\nParagraph" (org-element-at-point))) '(:a 1 :b 2))) ;; Return nil on empty attribute. (should-not (org-export-read-attribute :attr_html (org-test-with-temp-text "Paragraph" (org-element-at-point))))) (ert-deftest test-org-export/get-caption () "Test `org-export-get-caption' specifications." ;; Without optional argument, return long caption (should (equal '("l") (org-test-with-temp-text "#+CAPTION[s]: l\nPara" (org-export-get-caption (org-element-at-point))))) ;; With optional argument, return short caption. (should (equal '("s") (org-test-with-temp-text "#+CAPTION[s]: l\nPara" (org-export-get-caption (org-element-at-point) t)))) ;; Multiple lines are separated by white spaces. (should (equal '("a" " " "b") (org-test-with-temp-text "#+CAPTION: a\n#+CAPTION: b\nPara" (org-export-get-caption (org-element-at-point)))))) ;;; Back-End Tools (ert-deftest test-org-export/define-backend () "Test back-end definition and accessors." ;; Translate table. (should (equal '((headline . my-headline-test)) (let (org-export-registered-backends) (org-export-define-backend test ((headline . my-headline-test))) (org-export-backend-translate-table 'test)))) ;; Filters. (should (equal '((:filter-headline . my-filter)) (let (org-export-registered-backends) (org-export-define-backend test ((headline . my-headline-test)) :filters-alist ((:filter-headline . my-filter))) (org-export-backend-filters 'test)))) ;; Options. (should (equal '((:prop value)) (let (org-export-registered-backends) (org-export-define-backend test ((headline . my-headline-test)) :options-alist ((:prop value))) (org-export-backend-options 'test)))) ;; Menu. (should (equal '(?k "Test Export" test) (let (org-export-registered-backends) (org-export-define-backend test ((headline . my-headline-test)) :menu-entry (?k "Test Export" test)) (org-export-backend-menu 'test)))) ;; Export Blocks. (should (equal '(("TEST" . org-element-export-block-parser)) (let (org-export-registered-backends org-element-block-name-alist) (org-export-define-backend test ((headline . my-headline-test)) :export-block ("test")) org-element-block-name-alist)))) (ert-deftest test-org-export/define-derived-backend () "Test `org-export-define-derived-backend' specifications." ;; Error when parent back-end is not defined. (should-error (let (org-export-registered-backends) (org-export-define-derived-backend test parent))) ;; Append translation table to parent's. (should (equal '((:headline . test) (:headline . parent)) (let (org-export-registered-backends) (org-export-define-backend parent ((:headline . parent))) (org-export-define-derived-backend test parent :translate-alist ((:headline . test))) (org-export-backend-translate-table 'test))))) (ert-deftest test-org-export/derived-backend-p () "Test `org-export-derived-backend-p' specifications." ;; Non-nil with direct match. (should (let (org-export-registered-backends) (org-export-define-backend test ((headline . test))) (org-export-derived-backend-p 'test 'test))) (should (let (org-export-registered-backends) (org-export-define-backend test ((headline . test))) (org-export-define-derived-backend test2 test) (org-export-derived-backend-p 'test2 'test2))) ;; Non-nil with a direct parent. (should (let (org-export-registered-backends) (org-export-define-backend test ((headline . test))) (org-export-define-derived-backend test2 test) (org-export-derived-backend-p 'test2 'test))) ;; Non-nil with an indirect parent. (should (let (org-export-registered-backends) (org-export-define-backend test ((headline . test))) (org-export-define-derived-backend test2 test) (org-export-define-derived-backend test3 test2) (org-export-derived-backend-p 'test3 'test))) ;; Nil otherwise. (should-not (let (org-export-registered-backends) (org-export-define-backend test ((headline . test))) (org-export-define-backend test2 ((headline . test2))) (org-export-derived-backend-p 'test2 'test))) (should-not (let (org-export-registered-backends) (org-export-define-backend test ((headline . test))) (org-export-define-backend test2 ((headline . test2))) (org-export-define-derived-backend test3 test2) (org-export-derived-backend-p 'test3 'test)))) (ert-deftest test-org-export/with-backend () "Test `org-export-with-backend' definition." ;; Error when calling an undefined back-end (should-error (let (org-export-registered-backends) (org-export-with-backend 'test "Test"))) ;; Error when called back-end doesn't have an appropriate ;; transcoder. (should-error (let (org-export-registered-backends) (org-export-define-backend test ((headline . ignore))) (org-export-with-backend 'test "Test"))) ;; Otherwise, export using correct transcoder (should (equal "Success" (let (org-export-registered-backends) (org-export-define-backend test ((plain-text . (lambda (text contents info) "Failure")))) (org-export-define-backend test2 ((plain-text . (lambda (text contents info) "Success")))) (org-export-with-backend 'test2 "Test"))))) ;;; Export Snippets (ert-deftest test-org-export/export-snippet () "Test export snippets transcoding." (org-test-with-temp-text "@@test:A@@@@t:B@@" (org-test-with-backend test (plist-put (cdr (assq 'test org-export-registered-backends)) :translate-alist (cons (cons 'export-snippet (lambda (snippet contents info) (when (eq (org-export-snippet-backend snippet) 'test) (org-element-property :value snippet)))) (org-export-backend-translate-table 'test))) (let ((org-export-snippet-translation-alist nil)) (should (equal (org-export-as 'test) "A\n"))) (let ((org-export-snippet-translation-alist '(("t" . "test")))) (should (equal (org-export-as 'test) "AB\n")))))) ;;; Footnotes (ert-deftest test-org-export/footnotes () "Test footnotes specifications." (let ((org-footnote-section nil) (org-export-with-footnotes t)) ;; 1. Read every type of footnote. (should (equal '((1 . "A\n") (2 . "B") (3 . "C") (4 . "D")) (org-test-with-parsed-data "Text[fn:1] [1] [fn:label:C] [fn::D]\n\n[fn:1] A\n\n[1] B" (org-element-map tree 'footnote-reference (lambda (ref) (let ((def (org-export-get-footnote-definition ref info))) (cons (org-export-get-footnote-number ref info) (if (eq (org-element-property :type ref) 'inline) (car def) (car (org-element-contents (car (org-element-contents def)))))))) info)))) ;; 2. Test nested footnotes order. (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].\n\n[fn:2] B [fn:3] [fn::D].\n\n[fn:3] C." (should (equal '((1 . "fn:1") (2 . "fn:2") (3 . "fn:3") (4)) (org-element-map tree 'footnote-reference (lambda (ref) (when (org-export-footnote-first-reference-p ref info) (cons (org-export-get-footnote-number ref info) (org-element-property :label ref)))) info)))) ;; 3. Test nested footnote in invisible definitions. (org-test-with-temp-text "Text[1]\n\n[1] B [2]\n\n[2] C." ;; Hide definitions. (narrow-to-region (point) (point-at-eol)) (let* ((tree (org-element-parse-buffer)) (info (org-combine-plists `(:parse-tree ,tree) (org-export-collect-tree-properties tree (org-export-get-environment))))) ;; Both footnotes should be seen. (should (= (length (org-export-collect-footnote-definitions tree info)) 2)))) ;; 4. Test footnotes definitions collection. (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3]. \[fn:2] B [fn:3] [fn::D]. \[fn:3] C." (should (= (length (org-export-collect-footnote-definitions tree info)) 4))) ;; 5. Test export of footnotes defined outside parsing scope. (org-test-with-temp-text "[fn:1] Out of scope * Title Paragraph[fn:1]" (org-test-with-backend test (plist-put (cdr (assq 'test org-export-registered-backends)) :translate-alist (cons (cons 'footnote-reference (lambda (fn contents info) (org-element-interpret-data (org-export-get-footnote-definition fn info)))) (org-export-backend-translate-table 'test))) (forward-line) (should (equal "ParagraphOut of scope\n" (org-export-as 'test 'subtree))))))) ;;; Headlines and Inlinetasks (ert-deftest test-org-export/get-relative-level () "Test `org-export-get-relative-level' specifications." ;; Standard test. (should (equal '(1 2) (let ((org-odd-levels-only nil)) (org-test-with-parsed-data "* Headline 1\n** Headline 2" (org-element-map tree 'headline (lambda (h) (org-export-get-relative-level h info)) info))))) ;; Missing levels (should (equal '(1 3) (let ((org-odd-levels-only nil)) (org-test-with-parsed-data "** Headline 1\n**** Headline 2" (org-element-map tree 'headline (lambda (h) (org-export-get-relative-level h info)) info)))))) (ert-deftest test-org-export/low-level-p () "Test `org-export-low-level-p' specifications." (should (equal '(no yes) (let ((org-odd-levels-only nil)) (org-test-with-parsed-data "* Headline 1\n** Headline 2" (org-element-map tree 'headline (lambda (h) (if (org-export-low-level-p h info) 'yes 'no)) (plist-put info :headline-levels 1))))))) (ert-deftest test-org-export/get-headline-number () "Test `org-export-get-headline-number' specifications." ;; Standard test. (should (equal '((1) (1 1)) (let ((org-odd-levels-only nil)) (org-test-with-parsed-data "* Headline 1\n** Headline 2" (org-element-map tree 'headline (lambda (h) (org-export-get-headline-number h info)) info))))) ;; Missing levels are replaced with 0. (should (equal '((1) (1 0 1)) (let ((org-odd-levels-only nil)) (org-test-with-parsed-data "* Headline 1\n*** Headline 2" (org-element-map tree 'headline (lambda (h) (org-export-get-headline-number h info)) info)))))) (ert-deftest test-org-export/numbered-headline-p () "Test `org-export-numbered-headline-p' specifications." ;; If `:section-numbers' is nil, never number headlines. (should-not (org-test-with-parsed-data "* Headline" (org-element-map tree 'headline (lambda (h) (org-export-numbered-headline-p h info)) (plist-put info :section-numbers nil)))) ;; If `:section-numbers' is a number, only number headlines with ;; a level greater that it. (should (equal '(yes no) (org-test-with-parsed-data "* Headline 1\n** Headline 2" (org-element-map tree 'headline (lambda (h) (if (org-export-numbered-headline-p h info) 'yes 'no)) (plist-put info :section-numbers 1))))) ;; Otherwise, headlines are always numbered. (should (org-test-with-parsed-data "* Headline" (org-element-map tree 'headline (lambda (h) (org-export-numbered-headline-p h info)) (plist-put info :section-numbers t))))) (ert-deftest test-org-export/number-to-roman () "Test `org-export-number-to-roman' specifications." ;; If number is negative, return it as a string. (should (equal (org-export-number-to-roman -1) "-1")) ;; Otherwise, return it as a roman number. (should (equal (org-export-number-to-roman 1449) "MCDXLIX"))) (ert-deftest test-org-export/get-tags () "Test `org-export-get-tags' specifications." (let ((org-export-exclude-tags '("noexport")) (org-export-select-tags '("export"))) ;; Standard test: tags which are not a select tag, an exclude tag, ;; or specified as optional argument shouldn't be ignored. (should (org-test-with-parsed-data "* Headline :tag:" (org-export-get-tags (org-element-map tree 'headline 'identity info t) info))) ;; Exclude tags are removed. (should-not (org-test-with-parsed-data "* Headline :noexport:" (org-export-get-tags (org-element-map tree 'headline 'identity info t) info))) ;; Select tags are removed. (should-not (org-test-with-parsed-data "* Headline :export:" (org-export-get-tags (org-element-map tree 'headline 'identity info t) info))) (should (equal '("tag") (org-test-with-parsed-data "* Headline :tag:export:" (org-export-get-tags (org-element-map tree 'headline 'identity info t) info)))) ;; Tags provided in the optional argument are also ignored. (should-not (org-test-with-parsed-data "* Headline :ignore:" (org-export-get-tags (org-element-map tree 'headline 'identity info t) info '("ignore")))) ;; Allow tag inheritance. (should (equal '(("tag") ("tag")) (org-test-with-parsed-data "* Headline :tag:\n** Sub-heading" (org-element-map tree 'headline (lambda (hl) (org-export-get-tags hl info nil t)) info)))) ;; Tag inheritance checks FILETAGS keywords. (should (equal '(("a" "b" "tag")) (org-test-with-parsed-data "#+FILETAGS: :a:b:\n* Headline :tag:" (org-element-map tree 'headline (lambda (hl) (org-export-get-tags hl info nil t)) info)))))) (ert-deftest test-org-export/get-node-property () "Test`org-export-get-node-property' specifications." ;; Standard test. (should (equal "value" (org-test-with-parsed-data "* Headline :PROPERTIES: :prop: value :END:" (org-export-get-node-property :prop (org-element-map tree 'headline 'identity nil t))))) ;; Test inheritance. (should (equal "value" (org-test-with-parsed-data "* Parent :PROPERTIES: :prop: value :END: ** Headline Paragraph" (org-export-get-node-property :prop (org-element-map tree 'paragraph 'identity nil t) t)))) ;; Cannot return a value before the first headline. (should-not (org-test-with-parsed-data "Paragraph * Headline :PROPERTIES: :prop: value :END:" (org-export-get-node-property :prop (org-element-map tree 'paragraph 'identity nil t))))) (ert-deftest test-org-export/get-category () "Test `org-export-get-category' specifications." ;; Standard test. (should (equal "value" (org-test-with-parsed-data "* Headline :PROPERTIES: :CATEGORY: value :END:" (org-export-get-category (org-element-map tree 'headline 'identity nil t) info)))) ;; Test inheritance from a parent headline. (should (equal '("value" "value") (org-test-with-parsed-data "* Headline1 :PROPERTIES: :CATEGORY: value :END: ** Headline2" (org-element-map tree 'headline (lambda (hl) (org-export-get-category hl info)) info)))) ;; Test inheritance from #+CATEGORY keyword (should (equal "value" (org-test-with-parsed-data "#+CATEGORY: value * Headline" (org-export-get-category (org-element-map tree 'headline 'identity nil t) info)))) ;; Test inheritance from file name. (should (equal "test" (org-test-with-parsed-data "* Headline" (let ((info (plist-put info :input-file "~/test.org"))) (org-export-get-category (org-element-map tree 'headline 'identity nil t) info))))) ;; Fall-back value. (should (equal "???" (org-test-with-parsed-data "* Headline" (org-export-get-category (org-element-map tree 'headline 'identity nil t) info))))) (ert-deftest test-org-export/first-sibling-p () "Test `org-export-first-sibling-p' specifications." ;; Standard test. (should (equal '(yes yes no) (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3" (org-element-map tree 'headline (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no)) info)))) ;; Ignore headlines not exported. (should (equal '(yes) (let ((org-export-exclude-tags '("ignore"))) (org-test-with-parsed-data "* Headline :ignore:\n* Headline 2" (org-element-map tree 'headline (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no)) info)))))) (ert-deftest test-org-export/last-sibling-p () "Test `org-export-last-sibling-p' specifications." ;; Standard test. (should (equal '(yes no yes) (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3" (org-element-map tree 'headline (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no)) info)))) ;; Ignore headlines not exported. (should (equal '(yes) (let ((org-export-exclude-tags '("ignore"))) (org-test-with-parsed-data "* Headline\n* Headline 2 :ignore:" (org-element-map tree 'headline (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no)) info)))))) ;;; Links (ert-deftest test-org-export/get-coderef-format () "Test `org-export-get-coderef-format' specifications." ;; A link without description returns "%s" (should (equal (org-export-get-coderef-format "(ref:line)" nil) "%s")) ;; Return "%s" when path is matched within description. (should (equal (org-export-get-coderef-format "path" "desc (path)") "desc %s")) ;; Otherwise return description. (should (equal (org-export-get-coderef-format "path" "desc") "desc"))) (ert-deftest test-org-export/inline-image-p () "Test `org-export-inline-image-p' specifications." (should (org-export-inline-image-p (org-test-with-temp-text "[[#id]]" (org-element-map (org-element-parse-buffer) 'link 'identity nil t)) '(("custom-id" . "id"))))) (ert-deftest test-org-export/fuzzy-link () "Test fuzzy links specifications." ;; 1. Links to invisible (keyword) targets should be ignored. (org-test-with-parsed-data "Paragraph.\n#+TARGET: Test\n[[Test]]" (should-not (org-element-map tree 'link (lambda (link) (org-export-get-ordinal (org-export-resolve-fuzzy-link link info) info)) info))) ;; 2. Link to an headline should return headline's number. (org-test-with-parsed-data "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]" (should ;; Note: Headline's number is in fact a list of numbers. (equal '(2) (org-element-map tree 'link (lambda (link) (org-export-get-ordinal (org-export-resolve-fuzzy-link link info) info)) info t)))) ;; 3. Link to a target in an item should return item's number. (org-test-with-parsed-data "- Item1\n - Item11\n - <>Item12\n- Item2\n\n\n[[test]]" (should ;; Note: Item's number is in fact a list of numbers. (equal '(1 2) (org-element-map tree 'link (lambda (link) (org-export-get-ordinal (org-export-resolve-fuzzy-link link info) info)) info t)))) ;; 4. Link to a target in a footnote should return footnote's ;; number. (org-test-with-parsed-data " Paragraph[1][2][fn:lbl3:C<>][[test]][[target]]\n[1] A\n\n[2] <>B" (should (equal '(2 3) (org-element-map tree 'link (lambda (link) (org-export-get-ordinal (org-export-resolve-fuzzy-link link info) info)) info)))) ;; 5. Link to a named element should return sequence number of that ;; element. (org-test-with-parsed-data "#+NAME: tbl1\n|1|2|\n#+NAME: tbl2\n|3|4|\n#+NAME: tbl3\n|5|6|\n[[tbl2]]" (should (= 2 (org-element-map tree 'link (lambda (link) (org-export-get-ordinal (org-export-resolve-fuzzy-link link info) info)) info t)))) ;; 6. Link to a target not within an item, a table, a footnote ;; reference or definition should return section number. (org-test-with-parsed-data "* Head1\n* Head2\nParagraph<>\n* Head3\n[[target]]" (should (equal '(2) (org-element-map tree 'link (lambda (link) (org-export-get-ordinal (org-export-resolve-fuzzy-link link info) info)) info t))))) (ert-deftest test-org-export/resolve-coderef () "Test `org-export-resolve-coderef' specifications." (let ((org-coderef-label-format "(ref:%s)")) ;; 1. A link to a "-n -k -r" block returns line number. (org-test-with-parsed-data "#+BEGIN_EXAMPLE -n -k -r\nText (ref:coderef)\n#+END_EXAMPLE" (should (= (org-export-resolve-coderef "coderef" info) 1))) (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp -n -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC" (should (= (org-export-resolve-coderef "coderef" info) 1))) ;; 2. A link to a "-n -r" block returns line number. (org-test-with-parsed-data "#+BEGIN_EXAMPLE -n -r\nText (ref:coderef)\n#+END_EXAMPLE" (should (= (org-export-resolve-coderef "coderef" info) 1))) (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1) (ref:coderef)\n#+END_SRC" (should (= (org-export-resolve-coderef "coderef" info) 1))) ;; 3. A link to a "-n" block returns coderef. (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1) (ref:coderef)\n#+END_SRC" (should (equal (org-export-resolve-coderef "coderef" info) "coderef"))) (org-test-with-parsed-data "#+BEGIN_EXAMPLE -n\nText (ref:coderef)\n#+END_EXAMPLE" (should (equal (org-export-resolve-coderef "coderef" info) "coderef"))) ;; 4. A link to a "-r" block returns line number. (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1) (ref:coderef)\n#+END_SRC" (should (= (org-export-resolve-coderef "coderef" info) 1))) (org-test-with-parsed-data "#+BEGIN_EXAMPLE -r\nText (ref:coderef)\n#+END_EXAMPLE" (should (= (org-export-resolve-coderef "coderef" info) 1))) ;; 5. A link to a block without a switch returns coderef. (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n(+ 1 1) (ref:coderef)\n#+END_SRC" (should (equal (org-export-resolve-coderef "coderef" info) "coderef"))) (org-test-with-parsed-data "#+BEGIN_EXAMPLE\nText (ref:coderef)\n#+END_EXAMPLE" (should (equal (org-export-resolve-coderef "coderef" info) "coderef"))) ;; 6. Correctly handle continued line numbers. A "+n" switch ;; should resume numbering from previous block with numbered ;; lines, ignoring blocks not numbering lines in the process. ;; A "-n" switch resets count. (org-test-with-parsed-data " #+BEGIN_EXAMPLE -n Text. #+END_EXAMPLE #+BEGIN_SRC emacs-lisp \(- 1 1) #+END_SRC #+BEGIN_SRC emacs-lisp +n -r \(+ 1 1) (ref:addition) #+END_SRC #+BEGIN_EXAMPLE -n -r Another text. (ref:text) #+END_EXAMPLE" (should (= (org-export-resolve-coderef "addition" info) 2)) (should (= (org-export-resolve-coderef "text" info) 1))) ;; 7. Recognize coderef with user-specified syntax. (org-test-with-parsed-data "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText. [ref:text]\n#+END_EXAMPLE" (should (equal (org-export-resolve-coderef "text" info) "text"))))) (ert-deftest test-org-export/resolve-fuzzy-link () "Test `org-export-resolve-fuzzy-link' specifications." ;; 1. Match target objects. (org-test-with-parsed-data "<> [[target]]" (should (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))) ;; 2. Match target elements. (org-test-with-parsed-data "#+TARGET: target\n[[target]]" (should (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))) ;; 3. Match named elements. (org-test-with-parsed-data "#+NAME: target\nParagraph\n\n[[target]]" (should (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))) ;; 4. Match exact headline's name. (org-test-with-parsed-data "* My headline\n[[My headline]]" (should (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))) ;; 5. Targets objects have priority over named elements and headline ;; titles. (org-test-with-parsed-data "* target\n#+NAME: target\n<>\n\n[[target]]" (should (eq 'target (org-element-type (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))))) ;; 6. Named elements have priority over headline titles. (org-test-with-parsed-data "* target\n#+NAME: target\nParagraph\n\n[[target]]" (should (eq 'paragraph (org-element-type (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))))) ;; 7. If link's path starts with a "*", only match headline titles, ;; though. (org-test-with-parsed-data "* target\n#+NAME: target\n<>\n\n[[*target]]" (should (eq 'headline (org-element-type (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))))) ;; 8. Return nil if no match. (org-test-with-parsed-data "[[target]]" (should-not (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info)))) (ert-deftest test-org-export/resolve-id-link () "Test `org-export-resolve-id-link' specifications." ;; 1. Regular test for custom-id link. (org-test-with-parsed-data "* Headline1 :PROPERTIES: :CUSTOM-ID: test :END: * Headline 2 \[[#test]]" (should (org-export-resolve-id-link (org-element-map tree 'link 'identity info t) info))) ;; 2. Failing test for custom-id link. (org-test-with-parsed-data "* Headline1 :PROPERTIES: :CUSTOM-ID: test :END: * Headline 2 \[[#no-match]]" (should-not (org-export-resolve-id-link (org-element-map tree 'link 'identity info t) info))) ;; 3. Test for internal id target. (org-test-with-parsed-data "* Headline1 :PROPERTIES: :ID: aaaa :END: * Headline 2 \[[id:aaaa]]" (should (org-export-resolve-id-link (org-element-map tree 'link 'identity info t) info))) ;; 4. Test for external id target. (org-test-with-parsed-data "[[id:aaaa]]" (should (org-export-resolve-id-link (org-element-map tree 'link 'identity info t) (org-combine-plists info '(:id-alist (("aaaa" . "external-file")))))))) (ert-deftest test-org-export/resolve-radio-link () "Test `org-export-resolve-radio-link' specifications." ;; Standard test. (org-test-with-temp-text "<<>> radio" (org-update-radio-target-regexp) (should (let* ((tree (org-element-parse-buffer)) (info `(:parse-tree ,tree))) (org-export-resolve-radio-link (org-element-map tree 'link 'identity info t) info)))) ;; Radio target with objects. (org-test-with-temp-text "<<>> radio \\alpha" (org-update-radio-target-regexp) (should (let* ((tree (org-element-parse-buffer)) (info `(:parse-tree ,tree))) (org-export-resolve-radio-link (org-element-map tree 'link 'identity info t) info))))) ;;; Src-block and example-block (ert-deftest test-org-export/unravel-code () "Test `org-export-unravel-code' function." (let ((org-coderef-label-format "(ref:%s)")) ;; 1. Code without reference. (org-test-with-temp-text "#+BEGIN_EXAMPLE\n(+ 1 1)\n#+END_EXAMPLE" (should (equal (org-export-unravel-code (org-element-at-point)) '("(+ 1 1)\n")))) ;; 2. Code with reference. (org-test-with-temp-text "#+BEGIN_EXAMPLE\n(+ 1 1) (ref:test)\n#+END_EXAMPLE" (should (equal (org-export-unravel-code (org-element-at-point)) '("(+ 1 1)\n" (1 . "test"))))) ;; 3. Code with user-defined reference. (org-test-with-temp-text "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\n(+ 1 1) [ref:test]\n#+END_EXAMPLE" (should (equal (org-export-unravel-code (org-element-at-point)) '("(+ 1 1)\n" (1 . "test"))))) ;; 4. Code references keys are relative to the current block. (org-test-with-temp-text " #+BEGIN_EXAMPLE -n \(+ 1 1) #+END_EXAMPLE #+BEGIN_EXAMPLE +n \(+ 2 2) \(+ 3 3) (ref:one) #+END_EXAMPLE" (goto-line 5) (should (equal (org-export-unravel-code (org-element-at-point)) '("(+ 2 2)\n(+ 3 3)\n" (2 . "one"))))))) ;;; Smart Quotes (ert-deftest test-org-export/activate-smart-quotes () "Test `org-export-activate-smart-quotes' specifications." ;; Opening double quotes: standard test. (should (equal '("some “paragraph") (let ((org-export-default-language "en")) (org-test-with-parsed-data "some \"paragraph" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Opening quotes: at the beginning of a paragraph. (should (equal '("“begin") (let ((org-export-default-language "en")) (org-test-with-parsed-data "\"begin" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Opening quotes: after an object. (should (equal '("“begin") (let ((org-export-default-language "en")) (org-test-with-parsed-data "=verb= \"begin" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Closing quotes: standard test. (should (equal '("some” paragraph") (let ((org-export-default-language "en")) (org-test-with-parsed-data "some\" paragraph" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Closing quotes: at the end of a paragraph. (should (equal '("end”") (let ((org-export-default-language "en")) (org-test-with-parsed-data "end\"" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Apostrophe: standard test. (should (equal '("It shouldn’t fail") (let ((org-export-default-language "en")) (org-test-with-parsed-data "It shouldn't fail" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Apostrophe: before an object. (should (equal '("a’") (let ((org-export-default-language "en")) (org-test-with-parsed-data "a'=b=" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Apostrophe: after an object. (should (equal '("’s") (let ((org-export-default-language "en")) (org-test-with-parsed-data "=code='s" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Special case: isolated quotes. (should (equal '("“" "”") (let ((org-export-default-language "en")) (org-test-with-parsed-data "\"$x$\"" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Smart quotes in secondary strings. (should (equal '("“" "”") (let ((org-export-default-language "en")) (org-test-with-parsed-data "* \"$x$\"" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Smart quotes in document keywords. (should (equal '("“" "”") (let ((org-export-default-language "en")) (org-test-with-parsed-data "#+TITLE: \"$x$\"" (org-element-map (plist-get info :title) 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info))))) ;; Smart quotes in parsed affiliated keywords. (should (equal '("“" "”" "Paragraph") (let ((org-export-default-language "en")) (org-test-with-parsed-data "#+CAPTION: \"$x$\"\nParagraph" (org-element-map tree 'plain-text (lambda (s) (org-export-activate-smart-quotes s :html info)) info nil nil t)))))) ;;; Tables (ert-deftest test-org-export/special-column () "Test if the table's special column is properly recognized." ;; 1. First column is special if it contains only a special marking ;; characters or empty cells. (org-test-with-temp-text " | ! | 1 | | | 2 |" (should (org-export-table-has-special-column-p (org-element-map (org-element-parse-buffer) 'table 'identity nil 'first-match)))) ;; 2. If the column contains anything else, it isn't special. (org-test-with-temp-text " | ! | 1 | | b | 2 |" (should-not (org-export-table-has-special-column-p (org-element-map (org-element-parse-buffer) 'table 'identity nil 'first-match)))) ;; 3. Special marking characters are "#", "^", "*", "_", "/", "$" ;; and "!". (org-test-with-temp-text " | # | 1 | | ^ | 2 | | * | 3 | | _ | 4 | | / | 5 | | $ | 6 | | ! | 7 |" (should (org-export-table-has-special-column-p (org-element-map (org-element-parse-buffer) 'table 'identity nil 'first-match)))) ;; 4. A first column with only empty cells isn't considered as ;; special. (org-test-with-temp-text " | | 1 | | | 2 |" (should-not (org-export-table-has-special-column-p (org-element-map (org-element-parse-buffer) 'table 'identity nil 'first-match))))) (ert-deftest test-org-export/table-row-is-special-p () "Test `org-export-table-row-is-special-p' specifications." ;; 1. A row is special if it has a special marking character in the ;; special column. (org-test-with-parsed-data "| ! | 1 |" (should (org-export-table-row-is-special-p (org-element-map tree 'table-row 'identity nil 'first-match) info))) ;; 2. A row is special when its first field is "/" (org-test-with-parsed-data " | / | 1 | | a | b |" (should (org-export-table-row-is-special-p (org-element-map tree 'table-row 'identity nil 'first-match) info))) ;; 3. A row only containing alignment cookies is also considered as ;; special. (org-test-with-parsed-data "| <5> | | | |" (should (org-export-table-row-is-special-p (org-element-map tree 'table-row 'identity nil 'first-match) info))) ;; 4. Everything else isn't considered as special. (org-test-with-parsed-data "| \alpha | | c |" (should-not (org-export-table-row-is-special-p (org-element-map tree 'table-row 'identity nil 'first-match) info))) ;; 5. Table's rules are never considered as special rows. (org-test-with-parsed-data "|---+---|" (should-not (org-export-table-row-is-special-p (org-element-map tree 'table-row 'identity nil 'first-match) info)))) (ert-deftest test-org-export/has-header-p () "Test `org-export-table-has-header-p' specifications." ;; 1. With an header. (org-test-with-parsed-data " | a | b | |---+---| | c | d |" (should (org-export-table-has-header-p (org-element-map tree 'table 'identity info 'first-match) info))) ;; 2. Without an header. (org-test-with-parsed-data " | a | b | | c | d |" (should-not (org-export-table-has-header-p (org-element-map tree 'table 'identity info 'first-match) info))) ;; 3. Don't get fooled with starting and ending rules. (org-test-with-parsed-data " |---+---| | a | b | | c | d | |---+---|" (should-not (org-export-table-has-header-p (org-element-map tree 'table 'identity info 'first-match) info)))) (ert-deftest test-org-export/table-row-group () "Test `org-export-table-row-group' specifications." ;; 1. A rule creates a new group. (org-test-with-parsed-data " | a | b | |---+---| | 1 | 2 |" (should (equal '(1 nil 2) (mapcar (lambda (row) (org-export-table-row-group row info)) (org-element-map tree 'table-row 'identity))))) ;; 2. Special rows are ignored in count. (org-test-with-parsed-data " | / | < | > | |---|---+---| | | 1 | 2 |" (should (equal '(nil nil 1) (mapcar (lambda (row) (org-export-table-row-group row info)) (org-element-map tree 'table-row 'identity))))) ;; 3. Double rules also are ignored in count. (org-test-with-parsed-data " | a | b | |---+---| |---+---| | 1 | 2 |" (should (equal '(1 nil nil 2) (mapcar (lambda (row) (org-export-table-row-group row info)) (org-element-map tree 'table-row 'identity)))))) (ert-deftest test-org-export/table-cell-width () "Test `org-export-table-cell-width' specifications." ;; 1. Width is primarily determined by width cookies. If no cookie ;; is found, cell's width is nil. (org-test-with-parsed-data " | / | | <6> | | | | a | b | c |" (should (equal '(nil 6 7) (mapcar (lambda (cell) (org-export-table-cell-width cell info)) (org-element-map tree 'table-cell 'identity info))))) ;; 2. The last width cookie has precedence. (org-test-with-parsed-data " | <6> | | <7> | | a |" (should (equal '(7) (mapcar (lambda (cell) (org-export-table-cell-width cell info)) (org-element-map tree 'table-cell 'identity info))))) ;; 3. Valid width cookies must have a specific row. (org-test-with-parsed-data "| <6> | cell |" (should (equal '(nil nil) (mapcar (lambda (cell) (org-export-table-cell-width cell info)) (org-element-map tree 'table-cell 'identity)))))) (ert-deftest test-org-export/table-cell-alignment () "Test `org-export-table-cell-alignment' specifications." (let ((org-table-number-fraction 0.5) (org-table-number-regexp "^[0-9]+$")) ;; 1. Alignment is primarily determined by alignment cookies. (org-test-with-temp-text "| | | |" (let* ((tree (org-element-parse-buffer)) (info `(:parse-tree ,tree))) (should (equal '(left center right) (mapcar (lambda (cell) (org-export-table-cell-alignment cell info)) (org-element-map tree 'table-cell 'identity)))))) ;; 2. The last alignment cookie has precedence. (org-test-with-parsed-data " | | | cell | | |" (should (equal '(right right right) (mapcar (lambda (cell) (org-export-table-cell-alignment cell info)) (org-element-map tree 'table-cell 'identity))))) ;; 3. If there's no cookie, cell's contents determine alignment. ;; A column mostly made of cells containing numbers will align ;; its cells to the right. (org-test-with-parsed-data " | 123 | | some text | | 12345 |" (should (equal '(right right right) (mapcar (lambda (cell) (org-export-table-cell-alignment cell info)) (org-element-map tree 'table-cell 'identity))))) ;; 4. Otherwise, they will be aligned to the left. (org-test-with-parsed-data " | text | | some text | | \alpha |" (should (equal '(left left left) (mapcar (lambda (cell) (org-export-table-cell-alignment cell info)) (org-element-map tree 'table-cell 'identity))))))) (ert-deftest test-org-export/table-cell-borders () "Test `org-export-table-cell-borders' specifications." ;; 1. Recognize various column groups indicators. (org-test-with-parsed-data "| / | < | > | <> |" (should (equal '((right bottom top) (left bottom top) (right bottom top) (right left bottom top)) (mapcar (lambda (cell) (org-export-table-cell-borders cell info)) (org-element-map tree 'table-cell 'identity))))) ;; 2. Accept shortcuts to define column groups. (org-test-with-parsed-data "| / | < | < |" (should (equal '((right bottom top) (right left bottom top) (left bottom top)) (mapcar (lambda (cell) (org-export-table-cell-borders cell info)) (org-element-map tree 'table-cell 'identity))))) ;; 3. A valid column groups row must start with a "/". (org-test-with-parsed-data " | | < | | a | b |" (should (equal '((top) (top) (bottom) (bottom)) (mapcar (lambda (cell) (org-export-table-cell-borders cell info)) (org-element-map tree 'table-cell 'identity))))) ;; 4. Take table rules into consideration. (org-test-with-parsed-data " | 1 | |---| | 2 |" (should (equal '((below top) (bottom above)) (mapcar (lambda (cell) (org-export-table-cell-borders cell info)) (org-element-map tree 'table-cell 'identity))))) ;; 5. Top and (resp. bottom) rules induce both `top' and `above' ;; (resp. `bottom' and `below') borders. Any special row is ;; ignored. (org-test-with-parsed-data " |---+----| | / | | | | 1 | |---+----|" (should (equal '((bottom below top above)) (last (mapcar (lambda (cell) (org-export-table-cell-borders cell info)) (org-element-map tree 'table-cell 'identity))))))) (ert-deftest test-org-export/table-dimensions () "Test `org-export-table-dimensions' specifications." ;; 1. Standard test. (org-test-with-parsed-data " | 1 | 2 | 3 | | 4 | 5 | 6 |" (should (equal '(2 . 3) (org-export-table-dimensions (org-element-map tree 'table 'identity info 'first-match) info)))) ;; 2. Ignore horizontal rules and special columns. (org-test-with-parsed-data " | / | < | > | | 1 | 2 | 3 | |---+---+---| | 4 | 5 | 6 |" (should (equal '(2 . 3) (org-export-table-dimensions (org-element-map tree 'table 'identity info 'first-match) info))))) (ert-deftest test-org-export/table-cell-address () "Test `org-export-table-cell-address' specifications." ;; 1. Standard test: index is 0-based. (org-test-with-parsed-data "| a | b |" (should (equal '((0 . 0) (0 . 1)) (org-element-map tree 'table-cell (lambda (cell) (org-export-table-cell-address cell info)) info)))) ;; 2. Special column isn't counted, nor are special rows. (org-test-with-parsed-data " | / | <> | | | c |" (should (equal '(0 . 0) (org-export-table-cell-address (car (last (org-element-map tree 'table-cell 'identity info))) info)))) ;; 3. Tables rules do not count either. (org-test-with-parsed-data " | a | |---| | b | |---| | c |" (should (equal '(2 . 0) (org-export-table-cell-address (car (last (org-element-map tree 'table-cell 'identity info))) info)))) ;; 4. Return nil for special cells. (org-test-with-parsed-data "| / | a |" (should-not (org-export-table-cell-address (org-element-map tree 'table-cell 'identity nil 'first-match) info)))) (ert-deftest test-org-export/get-table-cell-at () "Test `org-export-get-table-cell-at' specifications." ;; 1. Address ignores special columns, special rows and rules. (org-test-with-parsed-data " | / | <> | | | a | |---+----| | | b |" (should (equal '("b") (org-element-contents (org-export-get-table-cell-at '(1 . 0) (org-element-map tree 'table 'identity info 'first-match) info))))) ;; 2. Return value for a non-existent address is nil. (org-test-with-parsed-data "| a |" (should-not (org-export-get-table-cell-at '(2 . 2) (org-element-map tree 'table 'identity info 'first-match) info))) (org-test-with-parsed-data "| / |" (should-not (org-export-get-table-cell-at '(0 . 0) (org-element-map tree 'table 'identity info 'first-match) info)))) (ert-deftest test-org-export/table-cell-starts-colgroup-p () "Test `org-export-table-cell-starts-colgroup-p' specifications." ;; 1. A cell at a beginning of a row always starts a column group. (org-test-with-parsed-data "| a |" (should (org-export-table-cell-starts-colgroup-p (org-element-map tree 'table-cell 'identity info 'first-match) info))) ;; 2. Special column should be ignored when determining the ;; beginning of the row. (org-test-with-parsed-data " | / | | | | a |" (should (org-export-table-cell-starts-colgroup-p (org-element-map tree 'table-cell 'identity info 'first-match) info))) ;; 2. Explicit column groups. (org-test-with-parsed-data " | / | | < | | a | b | c |" (should (equal '(yes no yes) (org-element-map tree 'table-cell (lambda (cell) (if (org-export-table-cell-starts-colgroup-p cell info) 'yes 'no)) info))))) (ert-deftest test-org-export/table-cell-ends-colgroup-p () "Test `org-export-table-cell-ends-colgroup-p' specifications." ;; 1. A cell at the end of a row always ends a column group. (org-test-with-parsed-data "| a |" (should (org-export-table-cell-ends-colgroup-p (org-element-map tree 'table-cell 'identity info 'first-match) info))) ;; 2. Special column should be ignored when determining the ;; beginning of the row. (org-test-with-parsed-data " | / | | | | a |" (should (org-export-table-cell-ends-colgroup-p (org-element-map tree 'table-cell 'identity info 'first-match) info))) ;; 3. Explicit column groups. (org-test-with-parsed-data " | / | < | | | a | b | c |" (should (equal '(yes no yes) (org-element-map tree 'table-cell (lambda (cell) (if (org-export-table-cell-ends-colgroup-p cell info) 'yes 'no)) info))))) (ert-deftest test-org-export/table-row-starts-rowgroup-p () "Test `org-export-table-row-starts-rowgroup-p' specifications." ;; 1. A row at the beginning of a table always starts a row group. ;; So does a row following a table rule. (org-test-with-parsed-data " | a | |---| | b |" (should (equal '(yes no yes) (org-element-map tree 'table-row (lambda (row) (if (org-export-table-row-starts-rowgroup-p row info) 'yes 'no)) info)))) ;; 2. Special rows should be ignored when determining the beginning ;; of the row. (org-test-with-parsed-data " | / | < | | | a | |---+---| | / | < | | | b |" (should (equal '(yes no yes) (org-element-map tree 'table-row (lambda (row) (if (org-export-table-row-starts-rowgroup-p row info) 'yes 'no)) info))))) (ert-deftest test-org-export/table-row-ends-rowgroup-p () "Test `org-export-table-row-ends-rowgroup-p' specifications." ;; 1. A row at the end of a table always ends a row group. So does ;; a row preceding a table rule. (org-test-with-parsed-data " | a | |---| | b |" (should (equal '(yes no yes) (org-element-map tree 'table-row (lambda (row) (if (org-export-table-row-ends-rowgroup-p row info) 'yes 'no)) info)))) ;; 2. Special rows should be ignored when determining the beginning ;; of the row. (org-test-with-parsed-data " | | a | | / | < | |---+---| | | b | | / | < |" (should (equal '(yes no yes) (org-element-map tree 'table-row (lambda (row) (if (org-export-table-row-ends-rowgroup-p row info) 'yes 'no)) info))))) (ert-deftest test-org-export/table-row-starts-header-p () "Test `org-export-table-row-starts-header-p' specifications." ;; 1. Only the row starting the first row group starts the table ;; header. (org-test-with-parsed-data " | a | | b | |---| | c |" (should (equal '(yes no no no) (org-element-map tree 'table-row (lambda (row) (if (org-export-table-row-starts-header-p row info) 'yes 'no)) info)))) ;; 2. A row cannot start an header if there's no header in the ;; table. (org-test-with-parsed-data " | a | |---|" (should-not (org-export-table-row-starts-header-p (org-element-map tree 'table-row 'identity info 'first-match) info)))) (ert-deftest test-org-export/table-row-ends-header-p () "Test `org-export-table-row-ends-header-p' specifications." ;; 1. Only the row starting the first row group starts the table ;; header. (org-test-with-parsed-data " | a | | b | |---| | c |" (should (equal '(no yes no no) (org-element-map tree 'table-row (lambda (row) (if (org-export-table-row-ends-header-p row info) 'yes 'no)) info)))) ;; 2. A row cannot start an header if there's no header in the ;; table. (org-test-with-parsed-data " | a | |---|" (should-not (org-export-table-row-ends-header-p (org-element-map tree 'table-row 'identity info 'first-match) info)))) ;;; Timestamps (ert-deftest test-org-export/timestamp-has-time-p () "Test `org-export-timestamp-has-time-p' specifications." ;; With time. (should (org-test-with-temp-text "<2012-03-29 Thu 16:40>" (org-export-timestamp-has-time-p (org-element-context)))) ;; Without time. (should-not (org-test-with-temp-text "<2012-03-29 Thu>" (org-export-timestamp-has-time-p (org-element-context))))) (ert-deftest test-org-export/format-timestamp () "Test `org-export-format-timestamp' specifications." ;; Regular test. (should (equal "2012-03-29 16:40" (org-test-with-temp-text "<2012-03-29 Thu 16:40>" (org-export-format-timestamp (org-element-context) "%Y-%m-%d %R")))) ;; Range end. (should (equal "2012-03-29" (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]" (org-export-format-timestamp (org-element-context) "%Y-%m-%d" t))))) (ert-deftest test-org-export/split-timestamp-range () "Test `org-export-split-timestamp-range' specifications." ;; Extract range start (active). (should (equal '(2012 3 29) (org-test-with-temp-text "<2012-03-29 Thu>--<2012-03-30 Fri>" (let ((ts (org-export-split-timestamp-range (org-element-context)))) (mapcar (lambda (p) (org-element-property p ts)) '(:year-end :month-end :day-end)))))) ;; Extract range start (inactive) (should (equal '(2012 3 29) (org-test-with-temp-text "[2012-03-29 Thu]--[2012-03-30 Fri]" (let ((ts (org-export-split-timestamp-range (org-element-context)))) (mapcar (lambda (p) (org-element-property p ts)) '(:year-end :month-end :day-end)))))) ;; Extract range end (active). (should (equal '(2012 3 30) (org-test-with-temp-text "<2012-03-29 Thu>--<2012-03-30 Fri>" (let ((ts (org-export-split-timestamp-range (org-element-context) t))) (mapcar (lambda (p) (org-element-property p ts)) '(:year-end :month-end :day-end)))))) ;; Extract range end (inactive) (should (equal '(2012 3 30) (org-test-with-temp-text "[2012-03-29 Thu]--[2012-03-30 Fri]" (let ((ts (org-export-split-timestamp-range (org-element-context) t))) (mapcar (lambda (p) (org-element-property p ts)) '(:year-end :month-end :day-end)))))) ;; Return the timestamp if not a range. (should (org-test-with-temp-text "[2012-03-29 Thu]" (let* ((ts-orig (org-element-context)) (ts-copy (org-export-split-timestamp-range ts-orig))) (eq ts-orig ts-copy)))) (should (org-test-with-temp-text "<%%(org-float t 4 2)>" (let* ((ts-orig (org-element-context)) (ts-copy (org-export-split-timestamp-range ts-orig))) (eq ts-orig ts-copy)))) ;; Check that parent is the same when a range was split. (should (org-test-with-temp-text "[2012-03-29 Thu]--[2012-03-30 Fri]" (let* ((ts-orig (org-element-context)) (ts-copy (org-export-split-timestamp-range ts-orig))) (eq (org-element-property :parent ts-orig) (org-element-property :parent ts-copy)))))) (ert-deftest test-org-export/translate-timestamp () "Test `org-export-translate-timestamp' specifications." ;; Translate whole date range. (should (equal "<29>--<30>" (org-test-with-temp-text "<2012-03-29 Thu>--<2012-03-30 Fri>" (let ((org-display-custom-times t) (org-time-stamp-custom-formats '("<%d>" . "<%d>"))) (org-export-translate-timestamp (org-element-context)))))) ;; Translate date range start. (should (equal "<29>" (org-test-with-temp-text "<2012-03-29 Thu>--<2012-03-30 Fri>" (let ((org-display-custom-times t) (org-time-stamp-custom-formats '("<%d>" . "<%d>"))) (org-export-translate-timestamp (org-element-context) 'start))))) ;; Translate date range end. (should (equal "<30>" (org-test-with-temp-text "<2012-03-29 Thu>--<2012-03-30 Fri>" (let ((org-display-custom-times t) (org-time-stamp-custom-formats '("<%d>" . "<%d>"))) (org-export-translate-timestamp (org-element-context) 'end))))) ;; Translate time range. (should (equal "<08>--<16>" (org-test-with-temp-text "<2012-03-29 Thu 8:30-16:40>" (let ((org-display-custom-times t) (org-time-stamp-custom-formats '("<%d>" . "<%H>"))) (org-export-translate-timestamp (org-element-context)))))) ;; Translate non-range timestamp. (should (equal "<29>" (org-test-with-temp-text "<2012-03-29 Thu>" (let ((org-display-custom-times t) (org-time-stamp-custom-formats '("<%d>" . "<%d>"))) (org-export-translate-timestamp (org-element-context)))))) ;; Do not change `diary' timestamps. (should (equal "<%%(org-float t 4 2)>" (org-test-with-temp-text "<%%(org-float t 4 2)>" (let ((org-display-custom-times t) (org-time-stamp-custom-formats '("<%d>" . "<%d>"))) (org-export-translate-timestamp (org-element-context))))))) ;;; Topology (ert-deftest test-org-export/get-next-element () "Test `org-export-get-next-element' specifications." ;; Standard test. (should (equal "b" (org-test-with-parsed-data "* Headline\n*a* b" (org-export-get-next-element (org-element-map tree 'bold 'identity info t) info)))) ;; Return nil when no previous element. (should-not (org-test-with-parsed-data "* Headline\na *b*" (org-export-get-next-element (org-element-map tree 'bold 'identity info t) info))) ;; Non-exportable elements are ignored. (should-not (let ((org-export-with-timestamps nil)) (org-test-with-parsed-data "\alpha <2012-03-29 Thu>" (org-export-get-next-element (org-element-map tree 'entity 'identity info t) info)))) ;; Find next element in secondary strings. (should (eq 'verbatim (org-test-with-parsed-data "* a =verb=" (org-element-type (org-export-get-next-element (org-element-map tree 'plain-text 'identity info t) info))))) ;; Find next element in document keywords. (should (eq 'verbatim (org-test-with-parsed-data "#+TITLE: a =verb=" (org-element-type (org-export-get-next-element (org-element-map (plist-get info :title) 'plain-text 'identity info t) info))))) ;; Find next element in parsed affiliated keywords. (should (eq 'verbatim (org-test-with-parsed-data "#+CAPTION: a =verb=\nParagraph" (org-element-type (org-export-get-next-element (org-element-map tree 'plain-text 'identity info t nil t) info))))) ;; With optional argument N, return a list containing all the ;; following elements. (should (equal '(bold code underline) (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_" (mapcar 'car (org-export-get-next-element (org-element-map tree 'italic 'identity info t) info t))))) ;; When N is a positive integer, return a list containing up to ;; N following elements. (should (equal '(bold code) (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_" (mapcar 'car (org-export-get-next-element (org-element-map tree 'italic 'identity info t) info 2)))))) (ert-deftest test-org-export/get-previous-element () "Test `org-export-get-previous-element' specifications." ;; Standard test. (should (equal "a " (org-test-with-parsed-data "* Headline\na *b*" (org-export-get-previous-element (org-element-map tree 'bold 'identity info t) info)))) ;; Return nil when no previous element. (should-not (org-test-with-parsed-data "* Headline\n*a* b" (org-export-get-previous-element (org-element-map tree 'bold 'identity info t) info))) ;; Non-exportable elements are ignored. (should-not (let ((org-export-with-timestamps nil)) (org-test-with-parsed-data "<2012-03-29 Thu> \alpha" (org-export-get-previous-element (org-element-map tree 'entity 'identity info t) info)))) ;; Find previous element in secondary strings. (should (eq 'verbatim (org-test-with-parsed-data "* =verb= a" (org-element-type (org-export-get-previous-element (org-element-map tree 'plain-text 'identity info t) info))))) ;; Find previous element in document keywords. (should (eq 'verbatim (org-test-with-parsed-data "#+TITLE: =verb= a" (org-element-type (org-export-get-previous-element (org-element-map (plist-get info :title) 'plain-text 'identity info t) info))))) ;; Find previous element in parsed affiliated keywords. (should (eq 'verbatim (org-test-with-parsed-data "#+CAPTION: =verb= a\nParagraph" (org-element-type (org-export-get-previous-element (org-element-map tree 'plain-text 'identity info t nil t) info))))) ;; With optional argument N, return a list containing up to ;; N previous elements. (should (equal '(bold italic underline) (org-test-with-parsed-data "_a_ /b/ *c* ~d~" (mapcar 'car (org-export-get-previous-element (org-element-map tree 'code 'identity info t) info t))))) ;; When N is a positive integer, return a list containing up to ;; N previous elements. (should (equal '(bold italic) (org-test-with-parsed-data "_a_ /b/ *c* ~d~" (mapcar 'car (org-export-get-previous-element (org-element-map tree 'code 'identity info t) info 2)))))) (provide 'test-org-export) ;;; test-org-export.el end here