1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073 |
- ;;; test-ox.el --- Tests for ox.el
- ;; Copyright (C) 2012, 2013, 2014 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 'ox)
- (signal 'missing-test-dependency "org-export"))
- (defun org-test-default-backend ()
- "Return a default export back-end.
- This back-end simply returns parsed data as Org syntax."
- (org-export-create-backend
- :transcoders (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)))))
- (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-allow-bind-keywords' set to t.
- (should
- (org-test-with-temp-text "#+BIND: test-ox-var value"
- (let ((org-export-allow-bind-keywords t))
- (org-export-get-environment)
- (eq test-ox-var 'value))))
- ;; Test with `org-export-allow-bind-keywords' set to nil.
- (should-not
- (org-test-with-temp-text "#+BIND: test-ox-var value"
- (let ((org-export-allow-bind-keywords nil))
- (org-export-get-environment)
- (boundp 'test-ox-var))))
- ;; BIND keywords are case-insensitive.
- (should
- (org-test-with-temp-text "#+bind: test-ox-var value"
- (let ((org-export-allow-bind-keywords t))
- (org-export-get-environment)
- (eq test-ox-var 'value))))
- ;; Preserve order of BIND keywords.
- (should
- (org-test-with-temp-text "#+BIND: test-ox-var 1\n#+BIND: test-ox-var 2"
- (let ((org-export-allow-bind-keywords t))
- (org-export-get-environment)
- (eq test-ox-var 2))))
- ;; Read BIND keywords in setup files.
- (should
- (org-test-with-temp-text
- (format "#+SETUPFILE: \"%s/examples/setupfile.org\"" org-test-dir)
- (let ((org-export-allow-bind-keywords t))
- (org-export-get-environment)
- (eq variable 'value))))
- ;; Verify that bound variables are seen during export.
- (should
- (equal "Yes\n"
- (org-test-with-temp-text "#+BIND: test-ox-var value"
- (let ((org-export-allow-bind-keywords t))
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((section . (lambda (s c i)
- (if (eq test-ox-var 'value) "Yes" "No")))))))))))
- (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."
- ;; Properties should follow buffer order.
- (should
- (equal
- (org-test-with-temp-text "#+LANGUAGE: fr\n#+CREATOR: Me\n#+EMAIL: email"
- (org-export--get-inbuffer-options))
- '(:language "fr" :creator "Me" :email "email")))
- ;; Parse document keywords.
- (should
- (equal
- (org-test-with-temp-text "#+AUTHOR: Me"
- (org-export--get-inbuffer-options))
- '(:author ("Me"))))
- ;; Test `space' behaviour.
- (should
- (equal
- (org-test-with-temp-text "#+TITLE: Some title\n#+TITLE: with spaces"
- (org-export--get-inbuffer-options))
- '(:title ("Some title with spaces"))))
- ;; Test `newline' behaviour.
- (should
- (equal
- (org-test-with-temp-text "#+DESCRIPTION: With\n#+DESCRIPTION: two lines"
- (org-export--get-inbuffer-options))
- '(:description "With\ntwo lines")))
- ;; Test `split' behaviour.
- (should
- (equal
- (org-test-with-temp-text "#+SELECT_TAGS: a\n#+SELECT_TAGS: b"
- (org-export--get-inbuffer-options))
- '(:select-tags ("a" "b"))))
- ;; Options set through SETUPFILE.
- (should
- (equal
- (org-test-with-temp-text
- (format "#+DESCRIPTION: l1
- #+LANGUAGE: es
- #+SELECT_TAGS: a
- #+TITLE: a
- #+SETUPFILE: \"%s/examples/setupfile.org\"
- #+DESCRIPTION: l3
- #+LANGUAGE: fr
- #+SELECT_TAGS: c
- #+TITLE: c"
- org-test-dir)
- (org-export--get-inbuffer-options))
- '(:description "l1\nl2\nl3":language "fr" :select-tags ("a" "b" "c")
- :title ("a b c"))))
- ;; More than one property can refer to the same buffer keyword.
- (should
- (equal '(:k2 "value" :k1 "value")
- (let ((backend (org-export-create-backend
- :options '((:k1 "KEYWORD")
- (:k2 "KEYWORD")))))
- (org-test-with-temp-text "#+KEYWORD: value"
- (org-export--get-inbuffer-options backend))))))
- (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"))))
- ;; Still grab correct options when section above is empty.
- (should
- (equal '("H1")
- (org-test-with-temp-text "* H1\n** H11\n** H12"
- (progn (forward-line 2)
- (plist-get (org-export-get-environment nil t) :title))))))
- (ert-deftest test-org-export/set-title ()
- "Test title setting."
- ;; If no title if specified, use file name.
- (should
- (apply
- 'equal
- (org-test-with-temp-text-in-file "Test"
- (org-mode)
- (list (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (text info)
- (org-element-interpret-data
- (plist-get info :title)))))))
- (file-name-nondirectory
- (file-name-sans-extension (buffer-file-name)))))))
- ;; If no title is specified, and no file is associated to the
- ;; buffer, use buffer's name.
- (should
- (apply
- 'equal
- (org-test-with-temp-text "Test"
- (org-mode)
- (list (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (text info)
- (org-element-interpret-data
- (plist-get info :title)))))))
- (buffer-name)))))
- ;; If a title is specified, use it.
- (should
- (equal
- "Title"
- (org-test-with-temp-text-in-file "#+TITLE: Title\nTest"
- (org-mode)
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (text info)
- (org-element-interpret-data
- (plist-get info :title))))))))))
- ;; If an empty title is specified, do not set it.
- (should
- (equal
- ""
- (org-test-with-temp-text-in-file "#+TITLE:\nTest"
- (org-mode)
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (text info)
- (org-element-interpret-data
- (plist-get info :title)))))))))))
- (ert-deftest test-org-export/handle-options ()
- "Test if export options have an impact on output."
- ;; Test exclude tags for headlines and inlinetasks.
- (should
- (equal ""
- (org-test-with-temp-text "* Head1 :noexp:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:exclude-tags ("noexp"))))))
- ;; Test include tags for headlines and inlinetasks.
- (should
- (equal "* H2\n** Sub :exp:\n*** Sub Sub\n"
- (org-test-with-temp-text "* H1\n* H2\n** Sub :exp:\n*** Sub Sub\n* H3"
- (let ((org-tags-column 0))
- (org-export-as (org-test-default-backend)
- nil nil nil '(:select-tags ("exp")))))))
- ;; If there is an include tag, ignore the section before the first
- ;; headline, if any.
- (should
- (equal "* H1 :exp:\nBody\n"
- (org-test-with-temp-text "First section\n* H1 :exp:\nBody"
- (let ((org-tags-column 0))
- (org-export-as (org-test-default-backend)
- nil nil nil '(:select-tags ("exp")))))))
- (should-not
- (equal "* H1 :exp:\n"
- (org-test-with-temp-text "* H1 :exp:\nBody"
- (let ((org-tags-column 0))
- (org-export-as (org-test-default-backend)
- nil nil nil '(:select-tags ("exp")))))))
- ;; Test mixing include tags and exclude tags.
- (should
- (string-match
- "\\* Head1[ \t]+:export:\n\\*\\* Sub-Head2\n"
- (org-test-with-temp-text "
- * Head1 :export:
- ** Sub-Head1 :noexport:
- ** Sub-Head2
- * Head2 :noexport:
- ** Sub-Head1 :export:"
- (org-export-as (org-test-default-backend) nil nil nil
- '(:select-tags ("export") :exclude-tags ("noexport"))))))
- ;; Ignore tasks.
- (should
- (equal ""
- (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
- (org-test-with-temp-text "* TODO Head1"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-tasks nil))))))
- (should
- (equal "* TODO Head1\n"
- (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
- (org-test-with-temp-text "* TODO Head1"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-tasks t))))))
- ;; Archived tree.
- (should
- (equal ""
- (org-test-with-temp-text "* Head1 :archive:"
- (let ((org-archive-tag "archive"))
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-archived-trees nil))))))
- (should
- (string-match
- "\\* Head1[ \t]+:archive:"
- (org-test-with-temp-text "* Head1 :archive:\nbody\n** Sub-head 2"
- (let ((org-archive-tag "archive"))
- (org-export-as (org-test-default-backend) nil nil nil
- '(:with-archived-trees headline))))))
- (should
- (string-match
- "\\`\\* Head1[ \t]+:archive:\n\\'"
- (org-test-with-temp-text "* Head1 :archive:"
- (let ((org-archive-tag "archive"))
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-archived-trees t))))))
- ;; Clocks.
- (should
- (string-match "CLOCK: \\[2012-04-29 .* 10:45\\]"
- (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-clocks t)))))
- (should
- (equal ""
- (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-clocks nil)))))
- ;; Drawers.
- (should
- (equal ""
- (org-test-with-temp-text ":TEST:\ncontents\n:END:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-drawers nil)))))
- (should
- (equal ":TEST:\ncontents\n:END:\n"
- (org-test-with-temp-text ":TEST:\ncontents\n:END:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-drawers t)))))
- (should
- (equal ":FOO:\nkeep\n:END:\n"
- (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-drawers ("FOO"))))))
- (should
- (equal ":FOO:\nkeep\n:END:\n"
- (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-drawers (not "BAR"))))))
- ;; Fixed-width.
- (should
- (equal ": A\n"
- (org-test-with-temp-text ": A"
- (org-export-as (org-test-default-backend) nil nil nil
- '(:with-fixed-width t)))))
- (should
- (equal ""
- (org-test-with-temp-text ": A"
- (org-export-as (org-test-default-backend) nil nil nil
- '(:with-fixed-width nil)))))
- ;; Footnotes.
- (should
- (equal "Footnote?"
- (let ((org-footnote-section nil))
- (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
- (org-trim (org-export-as (org-test-default-backend)
- nil nil nil '(:with-footnotes nil)))))))
- (should
- (equal "Footnote?[fn:1]\n\n[fn:1] Def"
- (let ((org-footnote-section nil))
- (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
- (org-trim (org-export-as (org-test-default-backend)
- nil nil nil '(:with-footnotes t)))))))
- ;; Inlinetasks.
- (when (featurep 'org-inlinetask)
- (should
- (equal
- ""
- (let ((org-inlinetask-min-level 15))
- (org-test-with-temp-text "*************** Task"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-inlinetasks nil))))))
- (should
- (equal
- ""
- (let ((org-inlinetask-min-level 15))
- (org-test-with-temp-text
- "*************** Task\nContents\n*************** END"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-inlinetasks nil)))))))
- ;; Plannings.
- (should
- (string-match
- "CLOSED: \\[2012-04-29 .* 10:45\\]"
- (let ((org-closed-string "CLOSED:"))
- (org-test-with-temp-text "CLOSED: [2012-04-29 sun. 10:45]"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-planning t))))))
- (should
- (equal ""
- (let ((org-closed-string "CLOSED:"))
- (org-test-with-temp-text "CLOSED: [2012-04-29 sun. 10:45]"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-planning nil))))))
- ;; Property Drawers.
- (should
- (equal "* H1\n"
- (org-test-with-temp-text
- "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-properties nil)))))
- (should
- (equal "* H1\n:PROPERTIES:\n:PROP: value\n:END:\n"
- (org-test-with-temp-text
- "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-properties t)))))
- (should
- (equal "* H1\n:PROPERTIES:\n:B: 2\n:END:\n"
- (org-test-with-temp-text
- "* H1\n :PROPERTIES:\n :A: 1\n :B: 2\n:END:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-properties ("B"))))))
- ;; Statistics cookies.
- (should
- (equal ""
- (org-test-with-temp-text "[0/0]"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-statistics-cookies nil)))))
- ;; Tables.
- (should
- (equal "| A |\n"
- (org-test-with-temp-text "| A |"
- (org-export-as (org-test-default-backend) nil nil nil
- '(:with-tables t)))))
- (should
- (equal ""
- (org-test-with-temp-text "| A |"
- (org-export-as (org-test-default-backend) nil nil nil
- '(:with-tables nil))))))
- (ert-deftest test-org-export/with-timestamps ()
- "Test `org-export-with-timestamps' specifications."
- ;; t value.
- (should
- (string-match
- "\\[2012-04-29 .*? 10:45\\]<2012-04-29 .*? 10:45>"
- (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-timestamps t)))))
- ;; nil value.
- (should
- (equal
- ""
- (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-timestamps nil)))))
- ;; `active' value.
- (should
- (string-match
- "<2012-03-29 .*?>\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
- (org-test-with-temp-text
- "<2012-03-29 Thu>[2012-03-29 Thu]
- Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-timestamps active)))))
- ;; `inactive' value.
- (should
- (string-match
- "\\[2012-03-29 .*?\\]\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
- (org-test-with-temp-text
- "<2012-03-29 Thu>[2012-03-29 Thu]
- Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-timestamps inactive))))))
- (ert-deftest test-org-export/comment-tree ()
- "Test if export process ignores commented trees."
- (should
- (equal ""
- (org-test-with-temp-text "* COMMENT Head1"
- (org-export-as (org-test-default-backend))))))
- (ert-deftest test-org-export/uninterpreted ()
- "Test handling of uninterpreted elements."
- ;; Entities.
- (should
- (equal "dummy\n"
- (org-test-with-temp-text "\\alpha"
- (org-export-as
- (org-export-create-backend
- :transcoders '((entity . (lambda (e c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-entities t)))))
- (should
- (equal "\\alpha\n"
- (org-test-with-temp-text "\\alpha"
- (org-export-as
- (org-export-create-backend
- :transcoders '((entity . (lambda (e c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-entities nil)))))
- ;; Emphasis.
- (should
- (equal "dummy\n"
- (org-test-with-temp-text "*bold*"
- (org-export-as
- (org-export-create-backend
- :transcoders '((bold . (lambda (b c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-emphasize t)))))
- (should
- (equal "*bold*\n"
- (org-test-with-temp-text "*bold*"
- (org-export-as
- (org-export-create-backend
- :transcoders '((bold . (lambda (b c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-emphasize nil)))))
- ;; LaTeX environment.
- (should
- (equal "dummy\n"
- (org-test-with-temp-text "\\begin{equation}\n1+1=2\n\\end{equation}"
- (org-export-as
- (org-export-create-backend
- :transcoders '((latex-environment . (lambda (l c i) "dummy"))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-latex t)))))
- (should
- (equal "\\begin{equation}\n1+1=2\n\\end{equation}\n"
- (org-test-with-temp-text "\\begin{equation}\n1+1=2\n\\end{equation}"
- (org-export-as
- (org-export-create-backend
- :transcoders '((latex-environment . (lambda (l c i) "dummy"))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-latex verbatim)))))
- ;; LaTeX fragment.
- (should
- (equal "dummy\n"
- (org-test-with-temp-text "$1$"
- (org-export-as
- (org-export-create-backend
- :transcoders '((latex-fragment . (lambda (l c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-latex t)))))
- (should
- (equal "$1$\n"
- (org-test-with-temp-text "$1$"
- (org-export-as
- (org-export-create-backend
- :transcoders '((latex-fragment . (lambda (l c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-latex verbatim)))))
- ;; Sub/superscript.
- (should
- (equal "adummy\n"
- (org-test-with-temp-text "a_b"
- (org-export-as
- (org-export-create-backend
- :transcoders '((subscript . (lambda (s c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-sub-superscript t)))))
- (should
- (equal "a_b\n"
- (org-test-with-temp-text "a_b"
- (org-export-as
- (org-export-create-backend
- :transcoders '((subscript . (lambda (s c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-sub-superscript nil)))))
- (should
- (equal "a_b\n"
- (org-test-with-temp-text "a_b"
- (org-export-as
- (org-export-create-backend
- :transcoders '((subscript . (lambda (s c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-sub-superscript {})))))
- (should
- (equal "adummy\n"
- (org-test-with-temp-text "a_{b}"
- (org-export-as
- (org-export-create-backend
- :transcoders '((subscript . (lambda (s c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-sub-superscript {})))))
- ;; Also handle uninterpreted objects in title.
- (should
- (equal "a_b"
- (org-test-with-temp-text "#+TITLE: a_b"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((subscript . (lambda (s c i) "dummy"))
- (template . (lambda (c i) (org-export-data
- (plist-get i :title) i)))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-sub-superscript nil)))))
- ;; Special case: multiples uninterpreted objects in a row.
- (should
- (equal "a_b_c_d\n"
- (org-test-with-temp-text "a_b_c_d"
- (org-export-as
- (org-export-create-backend
- :transcoders '((subscript . (lambda (s c i) "dummy"))
- (paragraph . (lambda (p c i) c))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-sub-superscript {}))))))
- (ert-deftest test-org-export/export-scope ()
- "Test all export scopes."
- (org-test-with-temp-text "
- * Head1
- ** Head2
- text
- *** Head3"
- ;; Subtree.
- (forward-line 3)
- (should (equal (org-export-as (org-test-default-backend) 'subtree)
- "text\n*** Head3\n"))
- ;; Visible.
- (goto-char (point-min))
- (forward-line)
- (org-cycle)
- (should (equal (org-export-as (org-test-default-backend) 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 (org-test-default-backend)) "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
- <<test>>
- #+END_SRC
- * Head2
- #+NAME: test
- #+BEGIN_SRC emacs-lisp
- \(+ 1 2)
- #+END_SRC"
- (forward-line 1)
- (org-export-as (org-test-default-backend) 'subtree))))
- ;; Body only.
- (let ((backend (org-test-default-backend)))
- (setf (org-export-backend-transcoders backend)
- (cons '(template . (lambda (body i)
- (format "BEGIN\n%sEND" body)))
- (org-export-backend-transcoders backend)))
- (org-test-with-temp-text "Text"
- (should (equal (org-export-as backend nil nil 'body-only)
- "Text\n"))
- (should (equal (org-export-as backend) "BEGIN\nText\nEND")))))
- (ert-deftest test-org-export/output-file-name ()
- "Test `org-export-output-file-name' specifications."
- ;; Export from a file: name is built from original file name.
- (should
- (org-test-with-temp-text-in-file "Test"
- (equal (concat (file-name-as-directory ".")
- (file-name-nondirectory
- (file-name-sans-extension (buffer-file-name))))
- (file-name-sans-extension (org-export-output-file-name ".ext")))))
- ;; When exporting to subtree, check EXPORT_FILE_NAME property first.
- (should
- (org-test-with-temp-text-in-file
- "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
- (equal (org-export-output-file-name ".ext" t) "./test.ext")))
- ;; From a buffer not associated to a file, too.
- (should
- (org-test-with-temp-text
- "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
- (equal (org-export-output-file-name ".ext" t) "./test.ext")))
- ;; When provided name is absolute, preserve it.
- (should
- (org-test-with-temp-text
- (format "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: %s\n :END:"
- (expand-file-name "test"))
- (file-name-absolute-p (org-export-output-file-name ".ext" t))))
- ;; When PUB-DIR argument is provided, use it.
- (should
- (org-test-with-temp-text-in-file "Test"
- (equal (file-name-directory
- (org-export-output-file-name ".ext" nil "dir/"))
- "dir/")))
- ;; When returned name would overwrite original file, add EXTENSION
- ;; another time.
- (should
- (org-test-at-id "75282ba2-f77a-4309-a970-e87c149fe125"
- (equal (org-export-output-file-name ".org") "./normal.org.org"))))
- (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.
- (should
- (equal
- "* Top heading\n** Heading\nbody\n"
- (org-test-with-temp-text
- (format
- "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-\""
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- (should
- (equal
- "* Top heading\n* Heading\nbody\n"
- (org-test-with-temp-text
- (format
- "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-\" :minlevel 1"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; 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")))
- ;; Footnotes labels are local to each included file.
- (should
- (= 6
- (length
- (delete-dups
- (let ((contents "
- Footnotes[fn:1], [fn:test] and [fn:inline:anonymous footnote].
- \[fn:1] Footnote 1
- \[fn:test] Footnote \"test\""))
- (org-test-with-temp-text-in-file contents
- (let ((file1 (buffer-file-name)))
- (org-test-with-temp-text-in-file contents
- (let ((file2 (buffer-file-name)))
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\""
- file1 file2)
- (org-export-expand-include-keyword)
- (org-element-map (org-element-parse-buffer)
- 'footnote-reference
- (lambda (ref)
- (org-element-property :label ref)))))))))))))
- ;; Footnotes labels are not local to each include keyword.
- (should
- (= 3
- (length
- (delete-dups
- (let ((contents "
- Footnotes[fn:1], [fn:test] and [fn:inline:anonymous footnote].
- \[fn:1] Footnote 1
- \[fn:test] Footnote \"test\""))
- (org-test-with-temp-text-in-file contents
- (let ((file (buffer-file-name)))
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\"" file file)
- (org-export-expand-include-keyword)
- (org-element-map (org-element-parse-buffer)
- 'footnote-reference
- (lambda (ref) (org-element-property :label ref))))))))))))
- (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-export-as (org-test-default-backend)))))
- ;; 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-export-as (org-test-default-backend))))
- (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-export-as (org-test-default-backend))))
- (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-export-as (org-test-default-backend))))
- (substring output (string-match ".*\n\\'" output)))))))
- (ert-deftest test-org-export/user-ignore-list ()
- "Test if `:ignore-list' accepts user input."
- (let ((backend (org-test-default-backend)))
- (setf (org-export-backend-transcoders backend)
- (cons '(template . (lambda (body i)
- (format "BEGIN\n%sEND" body)))
- (org-export-backend-transcoders backend)))
- (org-test-with-temp-text "Text"
- (should (equal (org-export-as backend nil nil 'body-only)
- "Text\n"))
- (should (equal (org-export-as backend) "BEGIN\nText\nEND"))))
- (should
- (equal
- "* Head1\n"
- (let ((org-export-filter-parse-tree-functions
- '((lambda (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))))
- (org-test-with-temp-text "* Head1\n* Head2 (note)\n"
- (org-export-as (org-test-default-backend)))))))
- (ert-deftest test-org-export/before-processing-hook ()
- "Test `org-export-before-processing-hook'."
- (should
- (equal
- "#+MACRO: mac val\nTest\n"
- (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 (org-test-default-backend)))))))
- (ert-deftest test-org-export/before-parsing-hook ()
- "Test `org-export-before-parsing-hook'."
- (should
- (equal "Body 1\nBody 2\n"
- (org-test-with-temp-text "* Headline 1\nBody 1\n* Headline 2\nBody 2"
- (let ((org-export-before-parsing-hook
- '((lambda (backend)
- (goto-char (point-min))
- (while (re-search-forward org-outline-regexp-bol nil t)
- (delete-region
- (point-at-bol) (progn (forward-line) (point))))))))
- (org-export-as (org-test-default-backend)))))))
- ;;; 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))))
- ;; Return nil on "nil" string.
- (should
- (equal '(:a nil :b nil)
- (org-export-read-attribute
- :attr_html
- (org-test-with-temp-text "#+ATTR_HTML: :a nil :b nil\nParagraph"
- (org-element-at-point)))))
- ;; Return nil on empty string.
- (should
- (equal '(:a nil :b nil)
- (org-export-read-attribute
- :attr_html
- (org-test-with-temp-text "#+ATTR_HTML: :a :b\nParagraph"
- (org-element-at-point)))))
- ;; Return empty string when value is "".
- (should
- (equal '(:a "")
- (org-export-read-attribute
- :attr_html
- (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\nParagraph"
- (org-element-at-point)))))
- ;; Return \"\" when value is """".
- (should
- (equal '(:a "\"\"")
- (org-export-read-attribute
- :attr_html
- (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\"\"\nParagraph"
- (org-element-at-point)))))
- ;; Ignore text before first property.
- (should-not
- (member "ignore"
- (org-export-read-attribute
- :attr_html
- (org-test-with-temp-text "#+ATTR_HTML: ignore :a 1\nParagraph"
- (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-get-all-transcoders '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 (org-export-get-backend '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 (org-export-get-backend '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 (org-export-get-backend '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-get-all-transcoders 'test))))
- ;; Options defined in the new back have priority over those defined
- ;; in parent.
- (should
- (eq 'test
- (let (org-export--registered-backends)
- (org-export-define-backend 'parent
- '((:headline . parent))
- :options-alist '((:a nil nil 'parent)))
- (org-export-define-derived-backend 'test 'parent
- :options-alist '((:a nil nil 'test)))
- (plist-get (org-export--get-global-options
- (org-export-get-backend 'test))
- :a)))))
- (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/get-all-transcoders ()
- "Test `org-export-get-all-transcoders' specifications."
- ;; Return nil when back-end cannot be found.
- (should-not (org-export-get-all-transcoders nil))
- ;; Same as `org-export-transcoders' if no parent.
- (should
- (equal '((headline . ignore))
- (org-export-get-all-transcoders
- (org-export-create-backend
- :transcoders '((headline . ignore))))))
- ;; But inherit from all ancestors whenever possible.
- (should
- (equal '((section . ignore) (headline . ignore))
- (let (org-export--registered-backends)
- (org-export-define-backend 'b1 '((headline . ignore)))
- (org-export-get-all-transcoders
- (org-export-create-backend
- :parent 'b1 :transcoders '((section . ignore)))))))
- (should
- (equal '((paragraph . ignore) (section . ignore) (headline . ignore))
- (let (org-export--registered-backends)
- (org-export-define-backend 'b1 '((headline . ignore)))
- (org-export-define-derived-backend 'b2 'b1
- :translate-alist '((section . ignore)))
- (org-export-get-all-transcoders
- (org-export-create-backend
- :parent 'b2 :transcoders '((paragraph . ignore)))))))
- ;; Back-end transcoders overrule inherited ones.
- (should
- (eq 'b
- (let (org-export--registered-backends)
- (org-export-define-backend 'b1 '((headline . a)))
- (cdr (assq 'headline
- (org-export-get-all-transcoders
- (org-export-create-backend
- :parent 'b1 :transcoders '((headline . b))))))))))
- (ert-deftest test-org-export/get-all-options ()
- "Test `org-export-get-all-options' specifications."
- ;; Return nil when back-end cannot be found.
- (should-not (org-export-get-all-options nil))
- ;; Same as `org-export-options' if no parent.
- (should
- (equal '((headline . ignore))
- (org-export-get-all-options
- (org-export-create-backend
- :options '((headline . ignore))))))
- ;; But inherit from all ancestors whenever possible.
- (should
- (equal '((:key2 value2) (:key1 value1))
- (let (org-export--registered-backends)
- (org-export-define-backend 'b1 nil :options-alist '((:key1 value1)))
- (org-export-get-all-options
- (org-export-create-backend
- :parent 'b1 :options '((:key2 value2)))))))
- (should
- (equal '((:key3 value3) (:key2 value2) (:key1 value1))
- (let (org-export--registered-backends)
- (org-export-define-backend 'b1 nil :options-alist '((:key1 value1)))
- (org-export-define-derived-backend 'b2 'b1
- :options-alist '((:key2 value2)))
- (org-export-get-all-options
- (org-export-create-backend
- :parent 'b2 :options '((:key3 value3)))))))
- ;; Back-end options overrule inherited ones.
- (should
- (eq 'b
- (let (org-export--registered-backends)
- (org-export-define-backend 'b1 nil :options-alist '((:key1 . a)))
- (cdr (assq :key1
- (org-export-get-all-options
- (org-export-create-backend
- :parent 'b1 :options '((:key1 . b))))))))))
- (ert-deftest test-org-export/get-all-filters ()
- "Test `org-export-get-all-filters' specifications."
- ;; Return nil when back-end cannot be found.
- (should-not (org-export-get-all-filters nil))
- ;; Same as `org-export-filters' if no parent.
- (should
- (equal '((:filter-headline . ignore))
- (org-export-get-all-filters
- (org-export-create-backend
- :filters '((:filter-headline . ignore))))))
- ;; But inherit from all ancestors whenever possible.
- (should
- (equal '((:filter-section . ignore) (:filter-headline . ignore))
- (let (org-export--registered-backends)
- (org-export-define-backend 'b1
- nil :filters-alist '((:filter-headline . ignore)))
- (org-export-get-all-filters
- (org-export-create-backend
- :parent 'b1 :filters '((:filter-section . ignore)))))))
- (should
- (equal '((:filter-paragraph . ignore)
- (:filter-section . ignore)
- (:filter-headline . ignore))
- (let (org-export--registered-backends)
- (org-export-define-backend 'b1
- nil :filters-alist '((:filter-headline . ignore)))
- (org-export-define-derived-backend 'b2 'b1
- :filters-alist '((:filter-section . ignore)))
- (org-export-get-all-filters
- (org-export-create-backend
- :parent 'b2 :filters '((:filter-paragraph . ignore)))))))
- ;; Back-end filters overrule inherited ones.
- (should
- (eq 'b
- (let (org-export--registered-backends)
- (org-export-define-backend 'b1 '((:filter-headline . a)))
- (cdr (assq :filter-headline
- (org-export-get-all-filters
- (org-export-create-backend
- :parent 'b1 :filters '((:filter-headline . b))))))))))
- (ert-deftest test-org-export/with-backend ()
- "Test `org-export-with-backend' definition."
- ;; Error when calling an undefined back-end
- (should-error (org-export-with-backend nil "Test"))
- ;; Error when called back-end doesn't have an appropriate
- ;; transcoder.
- (should-error
- (org-export-with-backend
- (org-export-create-backend :transcoders '((headline . ignore)))
- "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"))))
- ;; Provide correct back-end if transcoder needs to use recursive
- ;; calls anyway.
- (should
- (equal "Success\n"
- (let ((test-back-end
- (org-export-create-backend
- :transcoders
- '((headline . (lambda (headline contents info)
- (org-export-data
- (org-element-property :title headline)
- info)))
- (plain-text . (lambda (text info) "Success"))))))
- (org-export-string-as
- "* Test"
- (org-export-create-backend
- :transcoders
- '((headline . (lambda (headline contents info)
- (org-export-with-backend
- test-back-end headline contents info))))))))))
- (ert-deftest test-org-export/data-with-backend ()
- "Test `org-export-data-with-backend' specifications."
- ;; Error when calling an undefined back-end.
- (should-error (org-export-data-with-backend nil "nil" nil))
- ;; Otherwise, export data recursively, using correct back-end.
- (should
- (equal
- "Success!"
- (org-export-data-with-backend
- '(bold nil "Test")
- (org-export-create-backend
- :transcoders
- '((plain-text . (lambda (text info) "Success"))
- (bold . (lambda (bold contents info) (concat contents "!")))))
- '(:with-emphasize t)))))
- ;;; Export Snippets
- (ert-deftest test-org-export/export-snippet ()
- "Test export snippets transcoding."
- ;; Standard test.
- (org-test-with-temp-text "@@test:A@@@@t:B@@"
- (let ((backend (org-test-default-backend)))
- (setf (org-export-backend-name backend) 'test)
- (setf (org-export-backend-transcoders backend)
- (cons (cons 'export-snippet
- (lambda (snippet contents info)
- (when (eq (org-export-snippet-backend snippet) 'test)
- (org-element-property :value snippet))))
- (org-export-backend-transcoders backend)))
- (let ((org-export-snippet-translation-alist nil))
- (should (equal (org-export-as backend) "A\n")))
- (let ((org-export-snippet-translation-alist '(("t" . "test"))))
- (should (equal (org-export-as backend) "AB\n")))))
- ;; Ignored export snippets do not remove any blank.
- (should
- (equal "begin end\n"
- (org-test-with-parsed-data "begin @@test:A@@ end"
- (org-export-data-with-backend
- tree
- (org-export-create-backend
- :transcoders
- '((paragraph . (lambda (paragraph contents info) contents))
- (section . (lambda (section contents info) contents))))
- info)))))
- ;;; 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.
- (should
- (equal
- '((1 . "fn:1") (2 . "fn:2") (3 . "fn:3") (4))
- (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."
- (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.
- (should
- (= 4
- (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
- \[fn:2] B [fn:3] [fn::D].
- \[fn:3] C."
- (length (org-export-collect-footnote-definitions tree info)))))
- ;; 5. Test export of footnotes defined outside parsing scope.
- (should
- (equal
- "ParagraphOut of scope\n"
- (org-test-with-temp-text "[fn:1] Out of scope
- * Title
- Paragraph[fn:1]"
- (let ((backend (org-test-default-backend)))
- (setf (org-export-backend-transcoders backend)
- (cons (cons 'footnote-reference
- (lambda (fn contents info)
- (org-element-interpret-data
- (org-export-get-footnote-definition fn info))))
- (org-export-backend-transcoders backend)))
- (forward-line)
- (org-export-as backend 'subtree)))))
- ;; 6. Footnotes without a definition should be provided a fallback
- ;; definition.
- (should
- (org-test-with-parsed-data "[fn:1]"
- (org-export-get-footnote-definition
- (org-element-map tree 'footnote-reference 'identity info t) info)))
- ;; 7. Footnote section should be ignored in TOC and in headlines
- ;; numbering.
- (should
- (= 1 (let ((org-footnote-section "Footnotes"))
- (length (org-test-with-parsed-data "* H1\n* Footnotes\n"
- (org-export-collect-headlines info))))))
- (should
- (equal '(2)
- (let ((org-footnote-section "Footnotes"))
- (org-test-with-parsed-data "* H1\n* Footnotes\n* H2"
- (org-element-map tree 'headline
- (lambda (hl)
- (when (equal (org-element-property :raw-value hl) "H2")
- (org-export-get-headline-number hl info)))
- info t)))))))
- ;;; 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-optional-title ()
- "Test `org-export-get-alt-title' specifications."
- ;; If ALT_TITLE property is defined, use it.
- (should
- (equal '("opt")
- (org-test-with-parsed-data
- "* Headline\n:PROPERTIES:\n:ALT_TITLE: opt\n:END:"
- (org-export-get-alt-title
- (org-element-map tree 'headline 'identity info t)
- info))))
- ;; Otherwise, fall-back to regular title.
- (should
- (equal '("Headline")
- (org-test-with-parsed-data "* Headline"
- (org-export-get-alt-title
- (org-element-map tree 'headline 'identity info t)
- info)))))
- (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))))))
- (ert-deftest test-org-export/handle-inlinetasks ()
- "Test inlinetask export."
- ;; Inlinetask with an exclude tag.
- (when (featurep 'org-inlinetask)
- (should
- (equal
- ""
- (let ((org-inlinetask-min-level 3))
- (org-test-with-temp-text "*** Inlinetask :noexp:\nContents\n*** end"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:exclude-tags ("noexp")))))))
- ;; Inlinetask with an include tag.
- (should
- (equal
- "* H2\n*** Inline :exp:\n"
- (let ((org-inlinetask-min-level 3)
- (org-tags-column 0))
- (org-test-with-temp-text "* H1\n* H2\n*** Inline :exp:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:select-tags ("exp")))))))
- ;; Ignore inlinetask with a TODO keyword and tasks excluded.
- (should
- (equal ""
- (let ((org-todo-keywords '((sequence "TODO" "DONE")))
- (org-inlinetask-min-level 3))
- (org-test-with-temp-text "*** TODO Inline"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-tasks nil))))))))
- ;;; Keywords
- (ert-deftest test-org-export/get-date ()
- "Test `org-export-get-date' specifications."
- ;; Return a properly formatted string when
- ;; `org-export-date-timestamp-format' is non-nil and DATE keyword
- ;; consists in a single timestamp.
- (should
- (equal "29 03 2012"
- (let ((org-export-date-timestamp-format "%d %m %Y"))
- (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
- (org-export-get-date info)))))
- ;; Return a secondary string otherwise.
- (should-not
- (stringp
- (let ((org-export-date-timestamp-format nil))
- (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
- (org-export-get-date info)))))
- (should
- (equal '("Date")
- (org-test-with-parsed-data "#+DATE: Date"
- (org-export-get-date info))))
- ;; Optional argument has precedence over
- ;; `org-export-date-timestamp-format'.
- (should
- (equal "29 03"
- (let ((org-export-date-timestamp-format "%d %m %Y"))
- (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
- (org-export-get-date info "%d %m"))))))
- ;;; 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."
- ;; 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))))
- ;; 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))))
- ;; 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))))
- ;; 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))))
- ;; 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))))
- ;; Space are not significant when matching a fuzzy link.
- (should
- (org-test-with-parsed-data "* Head 1\n[[Head\n 1]]"
- (org-element-map tree 'link
- (lambda (link) (org-export-resolve-fuzzy-link link info))
- info t)))
- ;; Statistics cookies are ignored for headline match.
- (should
- (org-test-with-parsed-data "* Head [0/0]\n[[Head]]"
- (org-element-map tree 'link
- (lambda (link) (org-export-resolve-fuzzy-link link info))
- info t)))
- (should
- (org-test-with-parsed-data "* Head [100%]\n[[Head]]"
- (org-element-map tree 'link
- (lambda (link) (org-export-resolve-fuzzy-link link info))
- info t)))
- ;; Headline match is position dependent.
- (should-not
- (apply
- 'eq
- (org-test-with-parsed-data "* H1\n[[*H1]]\n* H1\n[[*H1]]"
- (org-element-map tree 'link
- (lambda (link) (org-export-resolve-fuzzy-link link info)) info)))))
- (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."
- ;; Match target objects.
- (should
- (org-test-with-parsed-data "<<target>> [[target]]"
- (org-export-resolve-fuzzy-link
- (org-element-map tree 'link 'identity info t) info)))
- ;; Match named elements.
- (should
- (org-test-with-parsed-data "#+NAME: target\nParagraph\n\n[[target]]"
- (org-export-resolve-fuzzy-link
- (org-element-map tree 'link 'identity info t) info)))
- ;; Match exact headline's name.
- (should
- (org-test-with-parsed-data "* My headline\n[[My headline]]"
- (org-export-resolve-fuzzy-link
- (org-element-map tree 'link 'identity info t) info)))
- ;; Targets objects have priority over named elements and headline
- ;; titles.
- (should
- (eq 'target
- (org-test-with-parsed-data
- "* target\n#+NAME: target\n<<target>>\n\n[[target]]"
- (org-element-type
- (org-export-resolve-fuzzy-link
- (org-element-map tree 'link 'identity info t) info)))))
- ;; Named elements have priority over headline titles.
- (should
- (eq 'paragraph
- (org-test-with-parsed-data
- "* target\n#+NAME: target\nParagraph\n\n[[target]]"
- (org-element-type
- (org-export-resolve-fuzzy-link
- (org-element-map tree 'link 'identity info t) info)))))
- ;; If link's path starts with a "*", only match headline titles,
- ;; though.
- (should
- (eq 'headline
- (org-test-with-parsed-data
- "* target\n#+NAME: target\n<<target>>\n\n[[*target]]"
- (org-element-type
- (org-export-resolve-fuzzy-link
- (org-element-map tree 'link 'identity info t) info)))))
- ;; Return nil if no match.
- (should-not
- (org-test-with-parsed-data "[[target]]"
- (org-export-resolve-fuzzy-link
- (org-element-map tree 'link 'identity info t) info)))
- ;; Match fuzzy link even when before first headline.
- (should
- (eq 'headline
- (org-test-with-parsed-data "[[hl]]\n* hl"
- (org-element-type
- (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.
- (should
- (org-test-with-temp-text "<<<radio>>> radio"
- (org-update-radio-target-regexp)
- (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 targets are case-insensitive.
- (should
- (org-test-with-temp-text "<<<RADIO>>> radio"
- (org-update-radio-target-regexp)
- (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.
- (should
- (org-test-with-temp-text "<<<radio \\alpha>>> radio \\alpha"
- (org-update-radio-target-regexp)
- (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 at its beginning.
- (should
- (org-test-with-temp-text "<<<\\alpha radio>>> \\alpha radio"
- (org-update-radio-target-regexp)
- (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 link next to an apostrophe.
- (should
- (org-test-with-temp-text "<<<radio>>> radio's"
- (org-update-radio-target-regexp)
- (let* ((tree (org-element-parse-buffer))
- (info `(:parse-tree ,tree)))
- (org-export-resolve-radio-link
- (org-element-map tree 'link 'identity info t)
- info))))
- ;; Multiple radio targets.
- (should
- (equal '("radio1" "radio2")
- (org-test-with-temp-text "<<<radio1>>> <<<radio2>>> radio1 radio2"
- (org-update-radio-target-regexp)
- (let* ((tree (org-element-parse-buffer))
- (info `(:parse-tree ,tree)))
- (org-element-map tree 'link
- (lambda (link)
- (org-element-property
- :value (org-export-resolve-radio-link link info)))
- info)))))
- ;; Radio target is whitespace insensitive.
- (should
- (org-test-with-temp-text "<<<a radio>>> a\n radio"
- (org-update-radio-target-regexp)
- (let* ((tree (org-element-parse-buffer))
- (info `(:parse-tree ,tree)))
- (org-element-map tree 'link
- (lambda (link) (org-export-resolve-radio-link link info)) info t)))))
- ;;; Src-block and example-block
- (ert-deftest test-org-export/unravel-code ()
- "Test `org-export-unravel-code' function."
- ;; Code without reference.
- (should
- (equal '("(+ 1 1)\n")
- (org-test-with-temp-text "#+BEGIN_EXAMPLE\n(+ 1 1)\n#+END_EXAMPLE"
- (org-export-unravel-code (org-element-at-point)))))
- ;; Code with reference.
- (should
- (equal '("(+ 1 1)\n" (1 . "test"))
- (org-test-with-temp-text
- "#+BEGIN_EXAMPLE\n(+ 1 1) (ref:test)\n#+END_EXAMPLE"
- (let ((org-coderef-label-format "(ref:%s)"))
- (org-export-unravel-code (org-element-at-point))))))
- ;; Code with user-defined reference.
- (should
- (equal
- '("(+ 1 1)\n" (1 . "test"))
- (org-test-with-temp-text
- "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\n(+ 1 1) [ref:test]\n#+END_EXAMPLE"
- (let ((org-coderef-label-format "(ref:%s)"))
- (org-export-unravel-code (org-element-at-point))))))
- ;; Code references keys are relative to the current block.
- (should
- (equal '("(+ 2 2)\n(+ 3 3)\n" (2 . "one"))
- (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)
- (let ((org-coderef-label-format "(ref:%s)"))
- (org-export-unravel-code (org-element-at-point)))))))
- (ert-deftest test-org-export/format-code-default ()
- "Test `org-export-format-code-default' specifications."
- ;; Return the empty string when code is empty.
- (should
- (equal ""
- (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n\n\n#+END_SRC"
- (org-export-format-code-default
- (org-element-map tree 'src-block 'identity info t) info))))
- ;; Number lines, two whitespace characters before the actual loc.
- (should
- (equal "1 a\n2 b\n"
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp +n\na\nb\n#+END_SRC"
- (org-export-format-code-default
- (org-element-map tree 'src-block 'identity info t) info))))
- ;; Put references 6 whitespace characters after the widest line,
- ;; wrapped within parenthesis.
- (should
- (equal "123 (a)\n1 (b)\n"
- (let ((org-coderef-label-format "(ref:%s)"))
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp\n123 (ref:a)\n1 (ref:b)\n#+END_SRC"
- (org-export-format-code-default
- (org-element-map tree 'src-block 'identity info t) info))))))
- ;;; 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> | | <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.
- (should
- (equal '(1 rule 2)
- (org-test-with-parsed-data "
- | a | b |
- |---+---|
- | 1 | 2 |"
- (org-element-map tree 'table-row
- (lambda (row)
- (if (eq (org-element-property :type row) 'rule) 'rule
- (org-export-table-row-group row info)))))))
- ;; 2. Special rows are ignored in count.
- (should
- (equal
- '(rule 1)
- (org-test-with-parsed-data "
- | / | < | > |
- |---|---+---|
- | | 1 | 2 |"
- (org-element-map tree 'table-row
- (lambda (row)
- (if (eq (org-element-property :type row) 'rule) 'rule
- (org-export-table-row-group row info)))
- info))))
- ;; 3. Double rules also are ignored in count.
- (should
- (equal '(1 rule rule 2)
- (org-test-with-parsed-data "
- | a | b |
- |---+---|
- |---+---|
- | 1 | 2 |"
- (org-element-map tree 'table-row
- (lambda (row)
- (if (eq (org-element-property :type row) 'rule) 'rule
- (org-export-table-row-group row info))))))))
- (ert-deftest test-org-export/table-row-number ()
- "Test `org-export-table-row-number' specifications."
- ;; Standard test. Number is 0-indexed.
- (should
- (equal '(0 1)
- (org-test-with-parsed-data "| a | b | c |\n| d | e | f |"
- (org-element-map tree 'table-row
- (lambda (row) (org-export-table-row-number row info)) info))))
- ;; Number ignores separators.
- (should
- (equal '(0 1)
- (org-test-with-parsed-data "
- | a | b | c |
- |---+---+---|
- | d | e | f |"
- (org-element-map tree 'table-row
- (lambda (row) (org-export-table-row-number row info)) info))))
- ;; Number ignores special rows.
- (should
- (equal '(0 1)
- (org-test-with-parsed-data "
- | / | < | > |
- | | b | c |
- |---+-----+-----|
- | | <c> | <c> |
- | | e | f |"
- (org-element-map tree 'table-row
- (lambda (row) (org-export-table-row-number row info)) info)))))
- (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."
- ;; 1. Alignment is primarily determined by alignment cookies.
- (should
- (equal '(left center right)
- (let ((org-table-number-fraction 0.5)
- (org-table-number-regexp "^[0-9]+$"))
- (org-test-with-parsed-data "| <l> | <c> | <r> |"
- (mapcar (lambda (cell)
- (org-export-table-cell-alignment cell info))
- (org-element-map tree 'table-cell 'identity))))))
- ;; 2. The last alignment cookie has precedence.
- (should
- (equal '(right right right)
- (org-test-with-parsed-data "
- | <l8> |
- | cell |
- | <r9> |"
- (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.
- (should
- (equal '(right right right)
- (let ((org-table-number-fraction 0.5)
- (org-table-number-regexp "^[0-9]+$"))
- (org-test-with-parsed-data "
- | 123 |
- | some text |
- | 12345 |"
- (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.
- (should
- (equal '(left left left)
- (org-test-with-parsed-data "
- | text |
- | some text |
- | \alpha |"
- (mapcar (lambda (cell)
- (org-export-table-cell-alignment cell info))
- (org-element-map tree 'table-cell 'identity info))))))
- (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))))
- ;;; Tables of Contents
- (ert-deftest test-org-export/collect-headlines ()
- "Test `org-export-collect-headlines' specifications."
- ;; Standard test.
- (should
- (= 2
- (length
- (org-test-with-parsed-data "* H1\n** H2"
- (org-export-collect-headlines info)))))
- ;; Do not collect headlines below optional argument.
- (should
- (= 1
- (length
- (org-test-with-parsed-data "* H1\n** H2"
- (org-export-collect-headlines info 1)))))
- ;; Never collect headlines below maximum headline level.
- (should
- (= 1
- (length
- (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
- (org-export-collect-headlines info)))))
- (should
- (= 1
- (length
- (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
- (org-export-collect-headlines info 2))))))
- ;;; Templates
- (ert-deftest test-org-export/inner-template ()
- "Test `inner-template' translator specifications."
- (should
- (equal "Success!"
- (org-test-with-temp-text "* Headline"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((inner-template . (lambda (contents info) "Success!"))
- (headline . (lambda (h c i) "Headline"))))))))
- ;; Inner template is applied even in a "body-only" export.
- (should
- (equal "Success!"
- (org-test-with-temp-text "* Headline"
- (org-export-as
- (org-export-create-backend
- :transcoders '((inner-template . (lambda (c i) "Success!"))
- (headline . (lambda (h c i) "Headline"))))
- nil nil 'body-only)))))
- (ert-deftest test-org-export/template ()
- "Test `template' translator specifications."
- (should
- (equal "Success!"
- (org-test-with-temp-text "* Headline"
- (org-export-as
- (org-export-create-backend
- :transcoders '((template . (lambda (contents info) "Success!"))
- (headline . (lambda (h c i) "Headline"))))))))
- ;; Template is not applied in a "body-only" export.
- (should-not
- (equal "Success!"
- (org-test-with-temp-text "* Headline"
- (org-export-as
- (org-export-create-backend
- :transcoders '((template . (lambda (contents info) "Success!"))
- (headline . (lambda (h c i) "Headline"))))
- nil nil 'body-only)))))
- ;;; 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)))))
- (should
- (eq 'verbatim
- (org-test-with-parsed-data "* /italic/ =verb="
- (org-element-type
- (org-export-get-next-element
- (org-element-map tree 'italic '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)))))
- (should
- (eq 'verbatim
- (org-test-with-parsed-data "* =verb= /italic/"
- (org-element-type
- (org-export-get-previous-element
- (org-element-map tree 'italic '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 '(underline italic bold)
- (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 '(italic bold)
- (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-ox)
- ;;; test-org-export.el end here
|