1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669 |
- ;;; test-org-export.el --- Tests for org-export.el
- ;; Copyright (C) 2012 Nicolas Goaziou
- ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
- ;; 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 <http://www.gnu.org/licenses/>.
- ;;; 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 ((,(intern (format "org-%s-translate-alist" backend))
- ',(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)))
- ;;; Tests
- (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")
- '(: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-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"))))
- ;; 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)))))
- ""))))
- (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"))
- ;; Body only.
- (flet ((org-test-template (body info) (format "BEGIN\n%sEND" body)))
- (push '(template . org-test-template) org-test-translate-alist)
- (should (equal (org-export-as 'test nil nil 'body-only)
- "* Head1\n** Head2\ntext\n*** Head3\n"))
- (should (equal (org-export-as 'test)
- "BEGIN\n* Head1\n** Head2\ntext\n*** Head3\nEND")))
- ;; 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.
- (org-test-with-temp-text "
- * Head1
- #+BEGIN_SRC emacs-lisp :noweb yes :exports results
- <<test>>
- #+END_SRC
- * Head2
- #+NAME: test
- #+BEGIN_SRC emacs-lisp
- \(+ 1 2)
- #+END_SRC"
- (org-test-with-backend test
- (forward-line 1)
- (should (equal (org-export-as 'test 'subtree) ": 3\n")))))
- (ert-deftest test-org-export/expand-include ()
- "Test file inclusion in an Org buffer."
- ;; 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/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 "\\<note\\>"
- (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-parsing-hook ()
- "Test `org-export-before-parsing-hook'."
- (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)))))))))
- (should (equal (org-export-as 'test) "Body 1\nBody 2\n"))))))
- ;;; 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)))))
- ;;; 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
- (let ((org-test-translate-alist
- (cons (cons 'export-snippet
- (lambda (snippet contents info)
- (when (eq (org-export-snippet-backend snippet) 'test)
- (org-element-property :value snippet))))
- org-test-translate-alist)))
- (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
- (let ((org-test-translate-alist
- (cons (cons 'footnote-reference
- (lambda (fn contents info)
- (org-element-interpret-data
- (org-export-get-footnote-definition fn info))))
- org-test-translate-alist)))
- (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"))))))
- (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 - <<test>>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<<target>>][[test]][[target]]\n[1] A\n\n[2] <<test>>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<<target>>\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>> [[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<<target>>\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<<target>>\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>>> 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>>> 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)))))
- ;;; Macro
- (ert-deftest test-org-export/define-macro ()
- "Try defining various Org macro using in-buffer #+MACRO: keyword."
- ;; Parsed macro.
- (should (equal (org-test-with-temp-text "#+MACRO: one 1"
- (org-export--get-inbuffer-options))
- '(:macro-one ("1"))))
- ;; Evaled macro.
- (should (equal (org-test-with-temp-text "#+MACRO: two (eval (+ 1 1))"
- (org-export--get-inbuffer-options))
- '(:macro-two ("(eval (+ 1 1))"))))
- ;; Incomplete macro.
- (should-not (org-test-with-temp-text "#+MACRO: three"
- (org-export--get-inbuffer-options)))
- ;; Macro with newline character.
- (should (equal (org-test-with-temp-text "#+MACRO: four a\\nb"
- (org-export--get-inbuffer-options))
- '(:macro-four ("a\nb"))))
- ;; Macro with protected newline character.
- (should (equal (org-test-with-temp-text "#+MACRO: five a\\\\nb"
- (org-export--get-inbuffer-options))
- '(:macro-five ("a\\nb"))))
- ;; Recursive macro.
- (org-test-with-temp-text "#+MACRO: six 6\n#+MACRO: seven 1 + {{{six}}}"
- (should
- (equal
- (org-export--get-inbuffer-options)
- '(:macro-six
- ("6")
- :macro-seven
- ("1 + " (macro (:key "six" :value "{{{six}}}" :args nil :begin 5 :end 14
- :post-blank 0 :parent nil))))))))
- (ert-deftest test-org-export/expand-macro ()
- "Test `org-export-expand-macro' specifications."
- ;; Standard test.
- (should
- (equal
- "some text"
- (org-test-with-parsed-data "#+MACRO: macro some text\n{{{macro}}}"
- (org-export-expand-macro
- (org-element-map tree 'macro 'identity info t) info))))
- ;; Macro with arguments.
- (should
- (equal
- "some text"
- (org-test-with-parsed-data "#+MACRO: macro $1 $2\n{{{macro(some,text)}}}"
- (org-export-expand-macro
- (org-element-map tree 'macro 'identity info t) info))))
- ;; Macro with "eval"
- (should
- (equal
- "3"
- (org-test-with-parsed-data "#+MACRO: add (eval (+ $1 $2))\n{{{add(1,2)}}}"
- (org-export-expand-macro
- (org-element-map tree 'macro 'identity info t) info))))
- ;; Nested macros.
- (should
- (equal
- "inner outer"
- (org-test-with-parsed-data
- "#+MACRO: in inner\n#+MACRO: out {{{in}}} outer\n{{{out}}}"
- (flet ((translate-macro (macro contents info)
- (org-export-expand-macro macro info)))
- (org-export-expand-macro
- (org-element-map tree 'macro 'identity info t)
- (org-combine-plists
- info `(:translate-alist ((macro . translate-macro))))))))))
- ;;; 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")))))))
- ;;; 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> | | <l> | <l22> |"
- (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 "
- | / | <l> | <6> | <l7> |
- | | 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 "| <l> | <c> | <r> |"
- (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 "
- | <l8> |
- | cell |
- | <r9> |"
- (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))))
- ;;; 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)))))
- (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)))))
- (provide 'test-org-export)
- ;;; test-org-export.el end here
|