12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171 |
- ;;; test-ox.el --- Tests for ox.el -*- lexical-binding: t; -*-
- ;; Copyright (C) 2012-2016, 2019 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 <https://www.gnu.org/licenses/>.
- ;;; Code:
- (require 'cl-lib)
- (require 'ox)
- (require 'org-inlinetask)
- (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
- (mapcar (lambda (type)
- (cons type
- (lambda (o c _)
- (funcall
- (intern (format "org-element-%s-interpreter" type))
- o c))))
- (append org-element-all-elements org-element-all-objects))))
- (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'."
- (declare (debug (form body)) (indent 1))
- `(org-test-with-temp-text ,data
- (org-export--delete-comment-trees)
- (let* ((tree (org-element-parse-buffer))
- (info (org-combine-plists
- (org-export--get-export-attributes)
- (org-export-get-environment))))
- (org-export--prune-tree tree info)
- (org-export--remove-uninterpreted-data tree info)
- (let ((info (org-combine-plists
- info (org-export--collect-tree-properties tree info))))
- (ignore info) ;; Don't warn if the var is unused.
- ,@body))))
- ;;; Internal Tests
- (ert-deftest test-org-export/org-export-copy-buffer ()
- "Test `org-export-copy-buffer' specifications."
- ;; The copy must not overwrite the original file.
- (org-test-with-temp-text-in-file
- "* Heading"
- (let ((file (buffer-file-name)))
- (with-current-buffer (org-export-copy-buffer)
- (insert "This must not go into the original file.")
- (save-buffer)
- (should
- (equal
- "* Heading"
- (with-temp-buffer
- (insert-file-contents file)
- (buffer-string)))))))
- ;; The copy must not show when re-opening the original file.
- (org-test-with-temp-text-in-file
- "* Heading"
- (let ((file (buffer-file-name))
- (buffer-copy (generate-new-buffer " *Org export copy*")))
- (org-export-with-buffer-copy
- :to-buffer buffer-copy
- (insert "This must not show as the original file.")
- (save-buffer))
- ;; Unassign the original buffer from file.
- (setq buffer-file-name nil)
- (should-not
- (equal buffer-copy (get-file-buffer file))))))
- (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)
- ;; `variable' is bound inside the setupfile.
- (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
- (let ((options
- (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 title:t")))
- (and (eq (plist-get options :headline-levels) 1)
- (eq (plist-get options :section-numbers) t)
- (eq (plist-get options :preserve-breaks) t)
- (eq (plist-get options :time-stamp-file) t)
- (eq (plist-get options :with-archived-trees) t)
- (eq (plist-get options :with-author) t)
- (eq (plist-get options :with-drawers) t)
- (eq (plist-get options :with-email) t)
- (eq (plist-get options :with-emphasize) t)
- (eq (plist-get options :with-entities) t)
- (eq (plist-get options :with-fixed-width) t)
- (eq (plist-get options :with-footnotes) t)
- (eq (plist-get options :with-priority) t)
- (eq (plist-get options :with-special-strings) t)
- (eq (plist-get options :with-sub-superscript) t)
- (eq (plist-get options :with-toc) t)
- (eq (plist-get options :with-tables) t)
- (eq (plist-get options :with-tags) t)
- (eq (plist-get options :with-tasks) t)
- (eq (plist-get options :with-timestamps) t)
- (eq (plist-get options :with-todo-keywords) t)
- (eq (plist-get options :with-inlinetasks) nil)
- (eq (plist-get options :with-statistics-cookies) t)
- (eq (plist-get options :with-title) t))))
- ;; Test some special values.
- (should
- (let ((options
- (org-export--parse-option-keyword
- "arch:headline d:(\"TEST\") ^:{} toc:1 tags:not-in-toc tasks:todo \
- num:2 <:active")))
- (and (eq (plist-get options :with-archived-trees) 'headline)
- (eq (plist-get options :with-sub-superscript) '{})
- (eq (plist-get options :with-toc) 1)
- (eq (plist-get options :with-tags) 'not-in-toc)
- (eq (plist-get options :with-tasks) 'todo)
- (eq (plist-get options :section-numbers) 2)
- (eq (plist-get options :with-timestamps) 'active)
- (equal (plist-get options :with-drawers) '("TEST")))))
- ;; Test back-end specific values.
- (should
- (equal
- (org-export--parse-option-keyword
- "opt:t" (org-export-create-backend :options '((:option nil "opt"))))
- '(:option t)))
- ;; More than one property can refer to the same option item.
- (should
- (equal '(:opt1 t :opt2 t)
- (org-export--parse-option-keyword
- "opt:t"
- (org-export-create-backend
- :options '((:opt1 nil "opt") (:opt2 nil "opt"))))))
- ;; Ignore options with a missing value.
- (should
- (let ((options (org-export--parse-option-keyword "H: num:t")))
- (and (not (plist-get options :headline-levels))
- (plist-get options :section-numbers)))))
- (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")))
- ;; Test `space' behaviour.
- (should
- (equal
- (let ((back-end (org-export-create-backend
- :options '((:keyword "KEYWORD" nil nil space)))))
- (org-test-with-temp-text "#+KEYWORD: With\n#+KEYWORD: spaces"
- (org-export--get-inbuffer-options back-end)))
- '(:keyword "With spaces")))
- ;; Test `newline' behaviour.
- (should
- (equal
- (let ((back-end (org-export-create-backend
- :options '((:keyword "KEYWORD" nil nil newline)))))
- (org-test-with-temp-text "#+KEYWORD: With\n#+KEYWORD: two lines"
- (org-export--get-inbuffer-options back-end)))
- '(:keyword "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"))))
- ;; Test `parse' behaviour. `parse' implies `space' but preserve
- ;; line breaks. Multi-line objects are allowed.
- (should
- (org-element-map
- (org-test-with-temp-text "#+TITLE: *bold*"
- (plist-get (org-export--get-inbuffer-options) :title))
- 'bold #'identity nil t))
- (should
- (equal
- (org-test-with-temp-text "#+TITLE: Some title\n#+TITLE: with spaces"
- (plist-get (org-export--get-inbuffer-options) :title))
- '("Some title with spaces")))
- (should
- (org-element-map
- (org-test-with-temp-text "#+TITLE: Some title\\\\\n#+TITLE: with spaces"
- (plist-get (org-export--get-inbuffer-options) :title))
- 'line-break #'identity nil t))
- (should
- (org-element-map
- (org-test-with-temp-text "#+TITLE: *bold\n#+TITLE: sentence*"
- (plist-get (org-export--get-inbuffer-options) :title))
- 'bold #'identity nil t))
- ;; 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\"
- #+LANGUAGE: fr
- #+SELECT_TAGS: c
- #+TITLE: c"
- org-test-dir)
- (org-export--get-inbuffer-options))
- '(:language "fr" :select-tags ("a" "b" "c") :title ("a b c"))))
- ;; Options set through SETUPFILE specified using a URL.
- (let ((buffer (generate-new-buffer "url-retrieve-output"))
- (org-resource-download-policy t))
- (unwind-protect
- ;; Simulate successful retrieval of a setupfile from URL.
- (cl-letf (((symbol-function 'url-retrieve-synchronously)
- (lambda (&rest_)
- (with-current-buffer buffer
- (insert "HTTP/1.1 200 OK
- # Contents of http://link-to-my-setupfile.org
- #+BIND: variable value
- #+DESCRIPTION: l2
- #+LANGUAGE: en
- #+SELECT_TAGS: b
- #+TITLE: b
- #+PROPERTY: a 1
- "))
- buffer)))
- (should
- (equal
- (org-test-with-temp-text
- "#+DESCRIPTION: l1
- #+LANGUAGE: es
- #+SELECT_TAGS: a
- #+TITLE: a
- #+SETUPFILE: \"http://link-to-my-setupfile.org\"
- #+LANGUAGE: fr
- #+SELECT_TAGS: c
- #+TITLE: c"
- (org-export--get-inbuffer-options))
- '(:language "fr" :select-tags ("a" "b" "c") :title ("a b c")))))
- (kill-buffer buffer)))
- ;; 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)))))
- ;; Keywords in commented subtrees are ignored.
- (should-not
- (equal "Me"
- (org-test-with-parsed-data "* COMMENT H1\n#+AUTHOR: Me"
- (plist-get info :author))))
- (should-not
- (equal "Mine"
- (org-test-with-parsed-data "* COMMENT H1\n** H2\n#+EMAIL: Mine"
- (plist-get info :email))))
- ;; Keywords can be set to an empty value.
- (should-not
- (let ((user-full-name "Me"))
- (org-test-with-parsed-data "#+AUTHOR:"
- (plist-get info :author)))))
- (ert-deftest test-org-export/get-subtree-options ()
- "Test setting options from headline's properties."
- ;; EXPORT_TITLE.
- (should
- (equal '("Subtree Title")
- (org-test-with-temp-text "#+TITLE: Title
- * Headline<point>
- :PROPERTIES:
- :EXPORT_TITLE: Subtree Title
- :END:
- Paragraph"
- (plist-get (org-export-get-environment nil t) :title))))
- ;; EXPORT_OPTIONS.
- (should
- (= 2
- (org-test-with-temp-text "#+OPTIONS: H:1
- * Headline<point>
- :PROPERTIES:
- :EXPORT_OPTIONS: H:2
- :END:
- Paragraph"
- (plist-get (org-export-get-environment nil t) :headline-levels))))
- ;; EXPORT_DATE.
- (should
- (equal '("29-03-2012")
- (org-test-with-temp-text "#+DATE: today
- * Headline<point>
- :PROPERTIES:
- :EXPORT_DATE: 29-03-2012
- :END:
- Paragraph"
- (plist-get (org-export-get-environment nil t) :date))))
- ;; Properties with `split' behaviour are stored as a list of
- ;; strings.
- (should
- (equal '("a" "b")
- (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport
- * Headline<point>
- :PROPERTIES:
- :EXPORT_EXCLUDE_TAGS: a b
- :END:
- Paragraph"
- (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<point>
- :PROPERTIES:
- :EXPORT_EXCLUDE_TAGS: a
- :EXPORT_EXCLUDE_TAGS+: b
- :END:
- Paragraph"
- (plist-get (org-export-get-environment nil t) :exclude-tags))))
- ;; Export properties are case-insensitive.
- (should
- (equal '("29-03-2012")
- (org-test-with-temp-text "* Headline
- :PROPERTIES:
- :EXPORT_Date: 29-03-2012
- :END:
- Paragraph"
- (plist-get (org-export-get-environment nil t) :date))))
- ;; Still grab correct options when section above is empty.
- (should
- (equal '("H1")
- (org-test-with-temp-text "* H1\n** H11\n** H12<point>"
- (plist-get (org-export-get-environment nil t) :title))))
- ;; More than one property can refer to the same node property.
- (should
- (equal '("1" "1")
- (org-test-with-temp-text
- "* H\n:PROPERTIES:\n:EXPORT_A: 1\n:END:\n<point>"
- (let* ((backend (org-export-create-backend
- :options '((:k1 "A")
- (:k2 "A"))))
- (options (org-export-get-environment backend t)))
- (list (plist-get options :k1) (plist-get options :k2)))))))
- (ert-deftest test-org-export/set-title ()
- "Test title setting."
- ;; Without TITLE keyword.
- (should
- (equal
- ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (org-test-with-temp-text "Test"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (text info)
- (org-element-interpret-data
- (plist-get info :title)))))))))))
- ;; With a blank TITLE keyword.
- (should
- (equal
- ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (org-test-with-temp-text "#+TITLE:\nTest"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (text info)
- (org-element-interpret-data
- (plist-get info :title)))))))))))
- ;; With a non-empty TITLE keyword.
- (should
- (equal
- "Title"
- (org-test-with-temp-text "#+TITLE: Title\nTest"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (text info)
- (org-element-interpret-data
- (plist-get info :title))))))))))
- ;; When exporting a subtree, its heading becomes the headline of the
- ;; document...
- (should
- (equal
- "Headline"
- (org-test-with-temp-text "* Headline\nBody"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (text info)
- (org-element-interpret-data
- (plist-get info :title))))))
- 'subtree))))
- ;; ... unless there is an EXPORT_TITLE property at the root of the
- ;; subtree.
- (should
- (equal
- "B"
- (org-test-with-temp-text
- "* A\n :PROPERTIES:\n :EXPORT_TITLE: B\n :END:\nBody"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (text info)
- (org-element-interpret-data
- (plist-get info :title))))))
- 'subtree)))))
- (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 ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (org-test-with-temp-text "* Head1 :noexp:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:exclude-tags ("noexp")))))))
- (should
- (equal "#+filetags: noexp\n"
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (org-test-with-temp-text "#+FILETAGS: noexp\n* Head1"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:exclude-tags ("noexp")))))))
- ;; Excluding a tag excludes its whole group.
- (should
- (equal ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (org-test-with-temp-text "* Head1 :baz:"
- (let ((org-tag-alist '((:startgrouptag)
- ("foo") (:grouptags) ("bar") ("baz")
- (:endgrouptag))))
- (org-export-as (org-test-default-backend)
- nil nil nil '(:exclude-tags ("foo"))))))))
- ;; Test include tags for headlines and inlinetasks.
- (should
- (equal (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")))))
- "* H2\n** Sub :exp:\n*** Sub Sub\n"))
- ;; Including a tag includes its whole group.
- (should
- (string-match-p
- "\\`\\* H2"
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (org-test-with-temp-text "* H1\n* H2 :bar:"
- (let ((org-tag-alist '((:startgrouptag)
- ("foo") (:grouptags) ("bar") ("baz")
- (:endgrouptag))))
- (org-export-as (org-test-default-backend)
- nil nil nil '(:select-tags ("foo"))))))))
- ;; If there is an include tag, ignore the section before the first
- ;; headline, if any.
- (should
- (equal (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")))))
- "* H1 :exp:\nBody\n"))
- (should
- (equal (org-test-with-temp-text "#+FILETAGS: exp\nFirst section\n* H1\nBody"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:select-tags ("exp"))))
- "* H1\nBody\n"))
- (should-not
- (equal (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")))))
- "* H1 :exp:\n"))
- ;; 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-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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 ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (org-test-with-temp-text "* Head1 :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"
- (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:"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-archived-trees t)))))
- ;; Broken links. Depending on `org-export-with-broken-links', raise
- ;; an error, ignore link or mark is as broken in output.
- (should-error
- (org-test-with-temp-text "[[#broken][link]]"
- (let ((backend
- (org-export-create-backend
- :transcoders
- '((section . (lambda (_e c _i) c))
- (paragraph . (lambda (_e c _i) c))
- (link . (lambda (l c i) (org-export-resolve-id-link l i)))))))
- (org-export-as backend nil nil nil '(:with-broken-links nil)))))
- (should
- (org-test-with-temp-text "[[#broken][link]]"
- (let ((backend
- (org-export-create-backend
- :transcoders
- '((section . (lambda (_e c _i) c))
- (paragraph . (lambda (_e c _i) c))
- (link . (lambda (l c i) (org-export-resolve-id-link l i)))))))
- (org-export-as backend nil nil nil '(:with-broken-links t)))))
- (should
- (org-test-with-temp-text "[[#broken][link]]"
- (let ((backend
- (org-export-create-backend
- :transcoders
- '((section . (lambda (_e c _i) c))
- (paragraph . (lambda (_e c _i) c))
- (link . (lambda (l c i) (org-export-resolve-id-link l i)))))))
- (org-string-nw-p
- (org-export-as backend nil nil nil '(:with-broken-links mark))))))
- ;; 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 ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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 ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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 ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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
- "* H\nCLOSED: \\[2012-04-29 .* 10:45\\]"
- (let ((org-closed-string "CLOSED:"))
- (org-test-with-temp-text "* H\nCLOSED: [2012-04-29 sun. 10:45]"
- (org-export-as (org-test-default-backend)
- nil nil nil '(:with-planning t))))))
- (should
- (equal "* H\n"
- (let ((org-closed-string "CLOSED:"))
- (org-test-with-temp-text "* H\nCLOSED: [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 "* Stats"
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (org-trim
- (org-test-with-temp-text "* Stats [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 ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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
- ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (org-trim
- (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 ""
- (let (org-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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)))))
- (should
- (equal "/simple/ /example/\n"
- (org-test-with-temp-text "/simple/ /example/"
- (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)))))
- (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 {})))))
- (should
- (equal "a_entity\n"
- (org-test-with-temp-text "a_\\alpha"
- (org-export-as
- (org-export-create-backend
- :transcoders '((entity . (lambda (e c i) "entity"))
- (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)))))
- ;; Handle uninterpreted objects in parsed keywords.
- (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)))))
- (should
- (equal "a_b"
- (org-test-with-temp-text "#+FOO: a_b"
- (org-export-as
- (org-export-create-backend
- :options
- '((:foo "FOO" nil nil parse))
- :transcoders
- '((subscript . (lambda (s c i) "dummy"))
- (template . (lambda (c i)
- (org-export-data (plist-get i :foo) i)))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-sub-superscript nil)))))
- ;; Objects in parsed keywords are "uninterpreted" before filters are
- ;; applied.
- (should
- (org-test-with-temp-text "#+TITLE: a_b"
- (org-export-as
- (org-export-create-backend
- :filters
- '((:filter-options
- (lambda (i _)
- (org-element-map (plist-get i :title) 'subscript
- (lambda (_) (error "There should be no subscript here")))))))
- nil nil nil '(:with-sub-superscript nil))))
- ;; Handle uninterpreted objects in captions.
- (should
- (equal "adummy\n"
- (org-test-with-temp-text "#+CAPTION: a_b\nParagraph"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((subscript . (lambda (s c i) "dummy"))
- (paragraph . (lambda (p c i)
- (org-export-data (org-export-get-caption p) i)))
- (section . (lambda (s c i) c))))
- nil nil nil '(:with-sub-superscript t)))))
- (should
- (equal "a_b\n"
- (org-test-with-temp-text "#+CAPTION: a_b\nParagraph"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((subscript . (lambda (s c i) "dummy"))
- (paragraph . (lambda (p c i)
- (org-export-data (org-export-get-caption p) 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."
- ;; Subtree.
- (should
- (equal "text\n*** H3\n"
- (org-test-with-temp-text "* H1\n<point>** H2\ntext\n*** H3"
- (org-export-as (org-test-default-backend) 'subtree))))
- (should
- (equal "text\n*** H3\n"
- (org-test-with-temp-text "* H1\n** H2\n<point>text\n*** H3"
- (org-export-as (org-test-default-backend) 'subtree))))
- ;; Subtree with a code block calling another block outside.
- (should
- (equal ": 3\n"
- (org-test-with-temp-text "
- <point>* Head1
- #+BEGIN_SRC emacs-lisp :noweb yes :exports results
- <<test>>
- #+END_SRC
- * Head2
- #+NAME: test
- #+BEGIN_SRC emacs-lisp
- \(+ 1 2)
- #+END_SRC"
- (let ((org-export-use-babel t))
- (org-export-as (org-test-default-backend) 'subtree)))))
- ;; Subtree export should ignore leading planning line and property
- ;; drawer.
- (should
- (equal "Text\n"
- (org-test-with-temp-text "
- <point>* H
- SCHEDULED: <2012-03-29 Thu>
- :PROPERTIES:
- :A: 1
- :END:
- Text"
- (org-export-as (org-test-default-backend)
- 'subtree nil nil
- '(:with-planning t :with-properties t)))))
- ;; Visible.
- (should
- (equal "* H1\n"
- (org-test-with-temp-text "* H1\n** H2\ntext\n*** H3"
- (org-cycle)
- (org-export-as (org-test-default-backend) nil 'visible))))
- ;; Region.
- (should
- (equal "text\n"
- (org-test-with-temp-text "* H1\n** H2\n<point>text\n*** H3"
- (transient-mark-mode 1)
- (push-mark (point) t t)
- (end-of-line)
- (org-export-as (org-test-default-backend)))))
- ;; Body only.
- (should
- (equal "Text\n"
- (org-test-with-temp-text "Text"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (b _i) (format "BEGIN\n%sEND" b)))
- (section . (lambda (_s c _i) c))
- (paragraph . (lambda (_p c _i) c))))
- nil nil 'body-only))))
- (should
- (equal "BEGIN\nText\nEND"
- (org-test-with-temp-text "Text"
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((template . (lambda (b _i) (format "BEGIN\n%sEND" b)))
- (section . (lambda (_s c _i) c))
- (paragraph . (lambda (_p c _i) c))))))))
- ;; Pathological case: Body only on an empty buffer is expected to
- ;; return an empty string, not nil.
- (should
- (org-test-with-temp-text ""
- (org-export-as (org-test-default-backend) nil nil t))))
- (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 (file-name-base (buffer-file-name))
- (file-name-base (org-export-output-file-name ".ext")))))
- ;; When #+EXPORT_FILE_NAME is defined, use it.
- (should
- (equal "test.ext"
- (org-test-with-temp-text-in-file "#+EXPORT_FILE_NAME: test"
- (org-export-output-file-name ".ext" t))))
- ;; When exporting to subtree, check EXPORT_FILE_NAME property first.
- (should
- (equal "test.ext"
- (org-test-with-temp-text-in-file
- "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
- (org-export-output-file-name ".ext" t))))
- (should
- (equal "property.ext"
- (org-test-with-temp-text
- "#+EXPORT_FILE_NAME: keyword
- * Test<point>
- :PROPERTIES:
- :EXPORT_FILE_NAME: property
- :END:"
- (org-export-output-file-name ".ext" t))))
- ;; From a buffer not associated to a file, too.
- (should
- (equal "test.ext"
- (org-test-with-temp-text
- "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
- (org-export-output-file-name ".ext" t))))
- ;; 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
- (equal "dir/"
- (org-test-with-temp-text-in-file "Test"
- (file-name-directory
- (org-export-output-file-name ".ext" nil "dir/")))))
- ;; PUB-DIR has precedence over EXPORT_FILE_NAME keyword or property.
- (should
- (equal "pub-dir/"
- (org-test-with-temp-text-in-file
- "#+EXPORT_FILE_NAME: /dir/keyword\nTest"
- (file-name-directory
- (org-export-output-file-name ".ext" nil "pub-dir/")))))
- ;; When returned name would overwrite original file, add EXTENSION
- ;; another time.
- (should
- (equal "normal.org.org"
- (org-test-at-id "75282ba2-f77a-4309-a970-e87c149fe125"
- (org-export-output-file-name ".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)))
- ;; Refuse to expand keywords in commented headings.
- (should
- (org-test-with-temp-text "* COMMENT H1\n#+INCLUDE: dummy.org"
- (org-export-expand-include-keyword)
- t))
- ;; Full insertion with recursive inclusion.
- (should
- (equal
- (with-temp-buffer
- (insert-file
- (expand-file-name "examples/include.org" org-test-dir))
- (replace-regexp-in-string
- (regexp-quote "#+INCLUDE: \"include2.org\"")
- "Success!" (buffer-string)))
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; 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-11\""
- 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-11\" :minlevel 1"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; Inclusion within an example block.
- (should
- (equal
- "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n"
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" EXAMPLE"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; Inclusion within a src-block.
- (should
- (equal
- "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n"
- (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)
- (buffer-string))))
- ;; Inclusion within an html export-block.
- (should
- (equal
- "#+BEGIN_EXPORT html\n<p>HTML!</p>\n#+END_EXPORT\n"
- (org-test-with-temp-text
- (format
- "#+INCLUDE: \"%s/examples/include.html\" EXPORT html"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; Inclusion within an center paragraph
- (should
- (equal
- "#+BEGIN_CENTER\nSuccess!\n#+END_CENTER\n"
- (org-test-with-temp-text
- (format
- "#+INCLUDE: \"%s/examples/include2.org\" CENTER"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; Footnotes labels are local to each included file.
- (should
- (= 6
- (length
- (delete-dups
- (let ((contents "
- Footnotes[fn:1], [fn:test], [fn:test] and [fn:inline:inline 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 (r) (org-element-property :label r)))))))))))))
- ;; Footnotes labels are not local to each include keyword.
- (should
- (= 3
- (length
- (delete-dups
- (let ((contents "
- Footnotes[fn:1], [fn:test] and [fn:inline:inline 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)))))))))))
- ;; Footnotes are supported by :lines-like elements and unnecessary
- ;; footnotes are dropped.
- (should
- (= 3
- (length
- (delete-dups
- (let ((contents "
- * foo
- Footnotes[fn:1]
- * bar
- Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote]
- \[fn:1] Footnote 1
- \[fn:2] Footnote 1
- * Footnotes
- \[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::*bar\"\n" file)
- (org-export-expand-include-keyword)
- (org-element-map (org-element-parse-buffer)
- 'footnote-definition
- (lambda (ref) (org-element-property :label ref)))))))))))
- ;; If only-contents is non-nil only include contents of element.
- (should
- (equal
- "body\n"
- (org-test-with-temp-text
- (concat
- (format "#+INCLUDE: \"%s/examples/include.org::*Heading\" "
- org-test-dir)
- ":only-contents t")
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; Headings can be included via CUSTOM_ID.
- (should
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include.org::#ah\"" org-test-dir)
- (org-export-expand-include-keyword)
- (goto-char (point-min))
- (looking-at "* Another heading")))
- ;; Named objects can be included.
- (should
- (equal
- "| 1 |\n"
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include.org::tbl\" :only-contents t"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; Including non-existing elements should result in an error.
- (should-error
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include.org::*non-existing heading\""
- org-test-dir)
- (org-export-expand-include-keyword)))
- ;; Lines work relatively to an included element.
- (should
- (equal
- "2\n3\n"
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include.org::#ah\" :only-contents t \
- :lines \"2-3\""
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; Properties should be dropped from headlines.
- (should
- (equal
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include.org::#ht\" :only-contents t"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include.org::tbl\"" org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; Properties should be dropped, drawers should not be.
- (should
- (equal
- ":LOGBOOK:\ndrawer\n:END:\ncontent\n"
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include.org::#dh\" :only-contents t"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; Adjacent INCLUDE-keywords should have the same :minlevel if unspecified.
- (should
- (cl-every (lambda (level) (zerop (1- level)))
- (org-test-with-temp-text
- (concat
- (format "#+INCLUDE: \"%s/examples/include.org::#ah\"\n"
- org-test-dir)
- (format "#+INCLUDE: \"%s/examples/include.org::*Heading\""
- org-test-dir))
- (org-export-expand-include-keyword)
- (org-element-map (org-element-parse-buffer) 'headline
- (lambda (head) (org-element-property :level head))))))
- ;; INCLUDE does not insert induced :minlevel for src-blocks.
- (should-not
- (equal
- (org-test-with-temp-text
- (format "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))
- (org-test-with-temp-text
- (format
- "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp :minlevel 1"
- org-test-dir)
- (org-export-expand-include-keyword)
- (buffer-string))))
- ;; INCLUDE assigns the relative :minlevel conditional on narrowing.
- (should
- (org-test-with-temp-text-in-file
- (format "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\""
- org-test-dir)
- (narrow-to-region (point) (point-max))
- (org-export-expand-include-keyword)
- (eq 2 (org-current-level))))
- ;; If :minlevel is present do not alter it.
- (should
- (org-test-with-temp-text
- (format
- "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\" :minlevel 3"
- org-test-dir)
- (narrow-to-region (point) (point-max))
- (org-export-expand-include-keyword)
- (eq 3 (org-current-level)))))
- (ert-deftest test-org-export/expand-include/links ()
- "Test links modifications when including files."
- ;; Preserve relative plain links.
- (should
- (string-prefix-p
- "file:org-includee-"
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "file:foo.org" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-expand-include-keyword)
- (org-trim (buffer-string)))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer)))))))
- ;; Preserve relative angular links.
- (should
- (string-prefix-p
- "<file:org-includee-"
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "<file:foo.org>" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-expand-include-keyword)
- (org-trim (buffer-string)))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer)))))))
- ;; Preserve relative bracket links without description.
- (should
- (string-prefix-p
- "[[file:org-includee-"
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "[[file:foo.org]]" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-expand-include-keyword)
- (org-trim (buffer-string)))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer)))))))
- ;; Preserve blanks after the link.
- (should
- (string-suffix-p
- "foo.org]] :tag:"
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "[[file:foo.org]] :tag:" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-expand-include-keyword)
- (org-trim (buffer-string)))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer)))))))
- ;; Preserve relative bracket links with description.
- (should
- (string-prefix-p
- "[[file:org-includee-"
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "[[file:foo.org][description]]" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-expand-include-keyword)
- (org-trim (buffer-string)))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer)))))))
- ;; Preserve absolute links.
- (should
- (string=
- "[[file:/foo/bar.org]]"
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "[[file:/foo/bar.org]]" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-expand-include-keyword)
- (org-trim (buffer-string)))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer)))))))
- ;; Pathological case: Do not error when fixing a path in a headline.
- (should
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "* [[file:foo.org]]" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-expand-include-keyword)
- (org-trim (buffer-string)))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer)))))))
- (ert-deftest test-org-export/expand-macro ()
- "Test macro expansion in an Org buffer."
- (require 'ox-org)
- ;; 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)))))
- ;; Include global macros. However, local macros override them.
- (should
- (equal "global\n"
- (org-test-with-temp-text "{{{M}}}"
- (let ((org-export-global-macros '(("M" . "global"))))
- (org-export-as (org-test-default-backend))))))
- (should
- (equal "global arg\n"
- (org-test-with-temp-text "{{{M(arg)}}}"
- (let ((org-export-global-macros '(("M" . "global $1"))))
- (org-export-as (org-test-default-backend))))))
- (should
- (equal "2\n"
- (org-test-with-temp-text "{{{M}}}"
- (let ((org-export-global-macros '(("M" . "(eval (+ 1 1))"))))
- (org-export-as (org-test-default-backend))))))
- (should
- (equal "#+macro: M local\nlocal\n"
- (org-test-with-temp-text "#+macro: M local\n{{{M}}}"
- (let ((org-export-global-macros '(("M" . "global"))))
- (org-export-as (org-test-default-backend))))))
- ;; Allow macro in parsed keywords and associated properties.
- ;; Standard macro expansion.
- (should
- (string-match
- "#\\+k: value"
- (let ((backend (org-export-create-backend
- :parent 'org
- :options '((:k "K" nil nil parse)))))
- (org-test-with-temp-text "#+MACRO: macro value\n#+K: {{{macro}}}"
- (org-export-as backend)))))
- (should
- (string-match
- ":EXPORT_K: v"
- (let ((backend (org-export-create-backend
- :parent 'org
- :options '((:k "K" nil nil parse)))))
- (org-test-with-temp-text
- "#+macro: m v\n* H\n:PROPERTIES:\n:EXPORT_K: {{{m}}}\n:END:"
- (org-export-as backend nil nil nil '(:with-properties t))))))
- ;; 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))))))
- ;; Date macro takes a optional formatting argument
- (should
- (equal "09-02-15\n"
- (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02-09>"
- (org-export-as (org-test-default-backend)))))
- ;; Only single timestamps are formatted
- (should
- (equal "<2015-02x-09>\n"
- (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02x-09>"
- (org-export-as (org-test-default-backend)))))
- ;; Throw an error when a macro definition is missing.
- (should-error
- (org-test-with-temp-text "{{{missing}}}"
- (org-export-as (org-test-default-backend))))
- ;; Inline source blocks generate {{{results}}} macros. Evaluate
- ;; those.
- (should
- (equal "=2=\n"
- (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
- (let ((org-export-use-babel t)
- (org-babel-inline-result-wrap "=%s="))
- (org-export-as (org-test-default-backend))))))
- ;; If inline source block is already associated to a "results"
- ;; macro, do not duplicate it.
- (should
- (equal "src_emacs-lisp{(+ 1 1)} {{{results(=2=)}}}"
- (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)} {{{results(=2=)}}}"
- (let ((org-export-use-babel t)
- (org-babel-inline-result-wrap "=%s="))
- (org-export-as (org-test-default-backend)))
- (buffer-string)))))
- (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))))))
- (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
- '((verbatim . (lambda (text contents info) "Failure"))))
- (org-export-define-backend 'test2
- '((verbatim . (lambda (text contents info) "Success"))))
- (org-export-with-backend 'test2 '(verbatim (:value "=Test="))))))
- ;; Corner case: plain-text transcoders have a different arity.
- (should
- (equal "Success"
- (org-export-with-backend
- (org-export-create-backend
- :transcoders '((plain-text . (lambda (text info) "Success"))))
- "Test")))
- ;; Provide correct back-end if transcoder needs to use recursive
- ;; calls.
- (should
- (equal "Success\n"
- (let ((test-back-end
- (org-export-create-backend
- :transcoders
- (list (cons 'headline
- (lambda (headline _contents info)
- (org-export-data
- (org-element-property :title headline)
- info)))
- (cons 'plain-text (lambda (_text _info) "Success"))))))
- (org-export-string-as
- "* Test"
- (org-export-create-backend
- :transcoders
- (list (cons '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)))))
- ;;; Comments
- (ert-deftest test-org-export/comments ()
- "Test comments handling during export.
- In particular, structure of the document mustn't be altered after
- comments removal."
- (should
- (equal "Para1\n\nPara2\n"
- (org-test-with-temp-text
- "Para1
- # Comment
- # Comment
- Para2"
- (org-export-as (org-test-default-backend)))))
- (should
- (equal "Para1\n\nPara2\n"
- (org-test-with-temp-text
- "Para1
- # Comment
- Para2"
- (org-export-as (org-test-default-backend)))))
- (should
- (equal "[fn:1] Para1\n\n\nPara2\n"
- (org-test-with-temp-text
- "[fn:1] Para1
- # Inside definition
- # Outside definition
- Para2"
- (org-export-as (org-test-default-backend)))))
- (should
- (equal "[fn:1] Para1\n\nPara2\n"
- (org-test-with-temp-text
- "[fn:1] Para1
- # Inside definition
- # Inside definition
- Para2"
- (org-export-as (org-test-default-backend)))))
- (should
- (equal "[fn:1] Para1\n\nPara2\n"
- (org-test-with-temp-text
- "[fn:1] Para1
- # Inside definition
- Para2"
- (org-export-as (org-test-default-backend)))))
- (should
- (equal "[fn:1] Para1\n\nPara2\n"
- (org-test-with-temp-text
- "[fn:1] Para1
- # Inside definition
- Para2"
- (org-export-as (org-test-default-backend)))))
- (should
- (equal "- item 1\n\n- item 2\n"
- (org-test-with-temp-text
- "- item 1
- # Comment
- - item 2"
- (org-export-as (org-test-default-backend))))))
- ;;; Export blocks
- (ert-deftest test-org-export/export-block ()
- "Test export blocks transcoding."
- (should
- (equal "Success!\n"
- (org-test-with-temp-text
- "#+BEGIN_EXPORT backend\nSuccess!\n#+END_EXPORT"
- (org-export-as
- (org-export-create-backend
- :transcoders '((export-block . (lambda (b _c _i)
- (org-element-property :value b)))
- (section . (lambda (_s c _i) c))))))))
- (should
- (equal "Success!\n"
- (org-test-with-temp-text
- "#+BEGIN_EXPORT backend\nSuccess!\n#+END_EXPORT"
- (org-export-as
- (org-export-create-backend
- :transcoders
- (list
- (cons 'export-block
- (lambda (b _c _i)
- (and (equal (org-element-property :type b) "BACKEND")
- (org-element-property :value b))))
- (cons 'section (lambda (_s c _i) c)))))))))
- ;;; 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)))))
- ;;; Filters
- (ert-deftest test-org-export/filter-apply-functions ()
- "Test `org-export-filter-apply-functions' specifications."
- ;; Functions are applied in order and return values are reduced.
- (should
- (equal "210"
- (org-export-filter-apply-functions
- (list (lambda (value &rest _) (concat "1" value))
- (lambda (value &rest _) (concat "2" value)))
- "0" nil)))
- ;; Functions returning nil are skipped.
- (should
- (equal "20"
- (org-export-filter-apply-functions
- (list #'ignore (lambda (value &rest _) (concat "2" value)))
- "0" nil)))
- ;; If all functions are skipped, return the initial value.
- (should
- (equal "0"
- (org-export-filter-apply-functions (list #'ignore) "0" nil)))
- ;; If any function returns the empty string, final value is the
- ;; empty string.
- (should
- (equal ""
- (org-export-filter-apply-functions
- (list (lambda (_value &rest _) "")
- (lambda (value &rest _) (concat "2" value)))
- "0" nil)))
- ;; Any function returning the empty string short-circuits the
- ;; process.
- (should
- (org-export-filter-apply-functions
- (list (lambda (_value &rest _) "")
- (lambda (_value &rest _) (error "This shouldn't happen")))
- "0" nil)))
- ;;; Footnotes
- (ert-deftest test-org-export/footnote-first-reference-p ()
- "Test `org-export-footnote-first-reference-p' specifications."
- (should
- (equal
- '(t nil)
- (org-test-with-temp-text "Text[fn:1][fn:1]\n\n[fn:1] Definition"
- (let (result)
- (org-export-as
- (org-export-create-backend
- :transcoders
- `(,(cons 'footnote-reference
- (lambda (f _c i)
- (push (org-export-footnote-first-reference-p f i)
- result)
- ""))
- (section . (lambda (s c i) c))
- (paragraph . (lambda (p c i) c))))
- nil nil nil '(:with-footnotes t))
- (nreverse result)))))
- ;; Limit check to DATA, when non-nil.
- (should
- (equal
- '(nil t)
- (org-test-with-parsed-data "Text[fn:1]\n* H\nText[fn:1]\n\n[fn:1] D1"
- (let (result)
- (org-element-map tree 'footnote-reference
- (lambda (ref)
- (push
- (org-export-footnote-first-reference-p
- ref info (org-element-map tree 'headline #'identity info t))
- result))
- info)
- (nreverse result)))))
- (should
- (equal
- '(t nil)
- (org-test-with-parsed-data "Text[fn:1]\n* H\nText[fn:1]\n\n[fn:1] D1"
- (let (result)
- (org-element-map tree 'footnote-reference
- (lambda (ref)
- (push (org-export-footnote-first-reference-p ref info) result))
- info)
- (nreverse result)))))
- ;; If optional argument BODY-FIRST is non-nil, first find footnote
- ;; in the main body of the document. Otherwise, enter footnote
- ;; definitions when they are encountered.
- (should
- (equal
- '(t nil)
- (org-test-with-temp-text
- ":BODY:\nText[fn:1][fn:2]\n:END:\n\n[fn:1] Definition[fn:2]\n\n[fn:2] Inner"
- (let (result)
- (org-export-as
- (org-export-create-backend
- :transcoders
- `(,(cons 'footnote-reference
- (lambda (f _c i)
- (when (org-element-lineage f '(drawer))
- (push (org-export-footnote-first-reference-p f i nil)
- result))
- ""))
- (drawer . (lambda (d c i) c))
- (footnote-definition . (lambda (d c i) c))
- (section . (lambda (s c i) c))
- (paragraph . (lambda (p c i) c))))
- nil nil nil '(:with-footnotes t))
- (nreverse result)))))
- (should
- (equal
- '(t t)
- (org-test-with-temp-text
- ":BODY:\nText[fn:1][fn:2]\n:END:\n\n[fn:1] Definition[fn:2]\n\n[fn:2] Inner"
- (let (result)
- (org-export-as
- (org-export-create-backend
- :transcoders
- `(,(cons 'footnote-reference
- (lambda (f _c i)
- (when (org-element-lineage f '(drawer))
- (push (org-export-footnote-first-reference-p f i nil t)
- result))
- ""))
- (drawer . (lambda (d c i) c))
- (footnote-definition . (lambda (d c i) c))
- (section . (lambda (s c i) c))
- (paragraph . (lambda (p c i) c))))
- nil nil nil '(:with-footnotes t))
- (nreverse result))))))
- (ert-deftest test-org-export/get-footnote-number ()
- "Test `org-export-get-footnote-number' specifications."
- (should
- (equal '(1 2 1)
- (org-test-with-parsed-data
- "Text[fn:1][fn:2][fn:1]\n\n[fn:1] Def\n[fn:2] Def"
- (org-element-map tree 'footnote-reference
- (lambda (ref) (org-export-get-footnote-number ref info))
- info))))
- ;; Anonymous footnotes all get a new number.
- (should
- (equal '(1 2)
- (org-test-with-parsed-data
- "Text[fn::anon1][fn::anon2]"
- (org-element-map tree 'footnote-reference
- (lambda (ref) (org-export-get-footnote-number ref info))
- info))))
- ;; Test nested footnotes order.
- (should
- (equal
- '((1 . "1") (2 . "2") (3 . "3") (3 . "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)
- (cons (org-export-get-footnote-number ref info)
- (org-element-property :label ref)))
- info))))
- ;; Limit number to provided DATA, when non-nil.
- (should
- (equal
- '(1)
- (org-test-with-parsed-data
- "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
- (org-element-map tree 'footnote-reference
- (lambda (ref)
- (org-export-get-footnote-number
- ref info (org-element-map tree 'headline #'identity info t)))
- info))))
- (should
- (equal
- '(1 2)
- (org-test-with-parsed-data
- "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2]"
- (org-element-map tree 'footnote-reference
- (lambda (ref) (org-export-get-footnote-number ref info))
- info))))
- ;; With a non-nil BODY-FIRST optional argument, first check body,
- ;; then footnote definitions.
- (should
- (equal
- '(("1" . 1) ("2" . 2) ("3" . 3) ("3" . 3))
- (org-test-with-parsed-data
- "Text[fn:1][fn:2][fn:3]\n\n[fn:1] Def[fn:3]\n[fn:2] Def\n[fn:3] Def"
- (org-element-map tree 'footnote-reference
- (lambda (ref)
- (cons (org-element-property :label ref)
- (org-export-get-footnote-number ref info nil t)))
- info))))
- (should
- (equal
- '(("1" . 1) ("2" . 3) ("3" . 2) ("3" . 2))
- (org-test-with-parsed-data
- "Text[fn:1][fn:2][fn:3]\n\n[fn:1] Def[fn:3]\n[fn:2] Def\n[fn:3] Def"
- (org-element-map tree 'footnote-reference
- (lambda (ref)
- (cons (org-element-property :label ref)
- (org-export-get-footnote-number ref info nil)))
- info)))))
- (ert-deftest test-org-export/get-footnote-definition ()
- "Test `org-export-get-footnote-definition' specifications."
- ;; Standard test.
- (should
- (equal "A\n"
- (org-element-interpret-data
- (org-test-with-parsed-data "Text[fn:1]\n\n[fn:1] A"
- (org-export-get-footnote-definition
- (org-element-map tree 'footnote-reference #'identity nil t)
- info)))))
- ;; Raise an error if no definition is found.
- (should-error
- (org-test-with-parsed-data "Text[fn:1]"
- (org-export-get-footnote-definition
- (org-element-map tree 'footnote-reference #'identity nil t)
- info)))
- ;; Find inline definitions.
- (should
- (equal "A"
- (org-element-interpret-data
- (org-test-with-parsed-data "Text[fn:1:A]"
- (org-export-get-footnote-definition
- (org-element-map tree 'footnote-reference #'identity nil t)
- info)))))
- ;; Find anonymous definitions.
- (should
- (equal "A"
- (org-element-interpret-data
- (org-test-with-parsed-data "Text[fn::A]"
- (org-export-get-footnote-definition
- (org-element-map tree 'footnote-reference #'identity nil t)
- info)))))
- ;; Find empty definitions.
- (should
- (equal ""
- (org-element-interpret-data
- (org-test-with-parsed-data "Text[fn:1]\n\n[fn:1]"
- (org-export-get-footnote-definition
- (org-element-map tree 'footnote-reference #'identity nil t)
- info)))))
- (should
- (equal ""
- (org-element-interpret-data
- (org-test-with-parsed-data "Text[fn:1:]"
- (org-export-get-footnote-definition
- (org-element-map tree 'footnote-reference #'identity nil t)
- info)))))
- (should
- (equal ""
- (org-element-interpret-data
- (org-test-with-parsed-data "Text[fn::]"
- (org-export-get-footnote-definition
- (org-element-map tree 'footnote-reference #'identity nil t)
- info))))))
- (ert-deftest test-org-export/collect-footnote-definitions ()
- "Test `org-export-collect-footnote-definitions' specifications."
- (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 info)))))
- ;; Limit number to provided DATA, when non-nil.
- (should
- (equal
- '((1 "2"))
- (org-test-with-parsed-data
- "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
- (mapcar #'butlast
- (org-export-collect-footnote-definitions
- info (org-element-map tree 'headline #'identity info t))))))
- (should
- (equal
- '((1 "1") (2 "2"))
- (org-test-with-parsed-data
- "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
- (mapcar #'butlast (org-export-collect-footnote-definitions info)))))
- ;; With optional argument BODY-FIRST, first check body, then
- ;; footnote definitions.
- (should
- (equal '("1" "3" "2" nil)
- (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
- \[fn:2] B [fn:3] [fn::D].
- \[fn:3] C."
- (mapcar (lambda (e) (nth 1 e))
- (org-export-collect-footnote-definitions info nil t)))))
- (should-not
- (equal '("1" "3" "2" nil)
- (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
- \[fn:2] B [fn:3] [fn::D].
- \[fn:3] C."
- (mapcar (lambda (e) (nth 1 e))
- (org-export-collect-footnote-definitions info))))))
- (ert-deftest test-org-export/footnotes ()
- "Miscellaneous tests on footnotes."
- (let ((org-footnote-section nil)
- (org-export-with-footnotes t))
- ;; Read every type of footnote.
- (should
- (equal
- '((1 . "A\n") (2 . "C") (3 . "D"))
- (org-test-with-parsed-data
- "Text[fn:1] [fn:label:C] [fn::D]\n\n[fn:1] A\n"
- (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))))
- ;; Export nested footnote in invisible definitions.
- (should
- (= 2
- (org-test-with-temp-text "Text[fn:1]\n\n[fn:1] B [fn:2]\n\n[fn:2] C."
- (narrow-to-region (point) (line-end-position))
- (catch 'exit
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((section
- .
- (lambda (s c i)
- (throw 'exit (length
- (org-export-collect-footnote-definitions
- i))))))))))))
- ;; Export footnotes defined outside parsing scope.
- (should
- (string-match
- "Out of scope"
- (org-test-with-temp-text "[fn:1] Out of scope
- * Title
- <point>Paragraph[fn:1]"
- (org-export-as (org-test-default-backend) 'subtree))))
- (should
- (string-match
- "Out of scope"
- (org-test-with-temp-text "[fn:1] Out of scope
- * Title
- <point>Paragraph[fn:1]"
- (narrow-to-region (point) (point-max))
- (org-export-as (org-test-default-backend)))))
- ;; Export nested footnotes defined outside parsing scope.
- (should
- (string-match
- "Very out of scope"
- (org-test-with-temp-text "
- \[fn:1] Out of scope[fn:2]
- \[fn:2] Very out of scope
- * Title
- <point>Paragraph[fn:1]"
- (org-export-as (org-test-default-backend) 'subtree))))
- (should
- (string-match
- "Very out of scope"
- (org-test-with-temp-text "
- \[fn:1] Out of scope[fn:2]
- \[fn:2] Very out of scope
- * Title
- <point>Paragraph[fn:1]"
- (narrow-to-region (point) (point-max))
- (org-export-as (org-test-default-backend)))))
- (should
- (string-match
- "D2"
- (org-test-with-temp-text "
- \[fn:1] Out of scope[fn:2:D2]
- * Title
- <point>Paragraph[fn:1]"
- (narrow-to-region (point) (point-max))
- (org-export-as (org-test-default-backend)))))
- ;; Export footnotes in pruned parts of tree.
- (should
- (string-match
- "Definition"
- (let ((org-export-exclude-tags '("noexport")))
- (org-test-with-temp-text
- "* H\nText[fn:1]\n* H2 :noexport:\n[fn:1] Definition"
- (org-export-as (org-test-default-backend))))))
- (should
- (string-match
- "Definition"
- (let ((org-export-select-tags '("export")))
- (org-test-with-temp-text
- "* H :export:\nText[fn:1]\n* H2\n[fn:1] Definition"
- (org-export-as (org-test-default-backend))))))
- ;; Export nested footnotes in pruned parts of tree.
- (should
- (string-match
- "D2"
- (let ((org-export-exclude-tags '("noexport")))
- (org-test-with-temp-text
- "* H\nText[fn:1]\n* H2 :noexport:\n[fn:1] D1[fn:2]\n\n[fn:2] D2"
- (org-export-as (org-test-default-backend))))))
- (should
- (string-match
- "D2"
- (let ((org-export-select-tags '("export")))
- (org-test-with-temp-text
- "* H :export:\nText[fn:1]\n* H2\n[fn:1] D1[fn:2]\n\n[fn:2] D2"
- (org-export-as (org-test-default-backend))))))
- ;; Handle uninterpreted data in pruned footnote definitions.
- (should-not
- (string-match
- "|"
- (let ((org-export-with-tables nil))
- (org-test-with-temp-text
- "* H\nText[fn:1]\n* H2 :noexport:\n[fn:1]\n| a |"
- (org-export-as (org-test-default-backend))))))
- ;; Footnotes without a definition should throw an error.
- (should-error
- (org-test-with-parsed-data "Text[fn:1]"
- (org-export-get-footnote-definition
- (org-element-map tree 'footnote-reference #'identity info t) info)))
- ;; 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))))
- ;; With #+OPTIONS: num:nil all headlines are unnumbered.
- (should-not
- (org-test-with-parsed-data "* H\n#+OPTIONS: num:nil"
- (org-export-numbered-headline-p
- (org-element-map tree 'headline 'identity info t)
- info)))
- ;; Headlines with a non-nil UNNUMBERED property are not numbered.
- (should-not
- (org-test-with-parsed-data "* H\n:PROPERTIES:\n:UNNUMBERED: t\n:END:"
- (org-export-numbered-headline-p
- (org-element-map tree 'headline #'identity info t)
- info)))
- ;; UNNUMBERED is inherited.
- (should
- (equal '(unnumbered numbered unnumbered)
- (org-test-with-parsed-data
- "* H
- :PROPERTIES:
- :UNNUMBERED: t
- :END:
- ** H2
- :PROPERTIES:
- :UNNUMBERED: nil
- :END:
- ** H3"
- (org-element-map tree 'headline
- (lambda (h)
- (if (org-export-numbered-headline-p h info) 'numbered
- 'unnumbered))
- info)))))
- (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."
- ;; 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)))
- ;; Tags provided in the optional argument are 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 "* H\n** H 2\n** H 3"
- (org-element-map tree 'headline
- (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
- info))))
- (should
- (equal '(yes no)
- (org-test-with-parsed-data "- item\n\n para"
- (org-element-map tree 'paragraph
- (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
- info))))
- ;; Ignore sections for headlines.
- (should
- (equal '(yes yes)
- (org-test-with-parsed-data "* H\nSection\n** H 2"
- (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))))
- (should
- (equal '(no yes)
- (org-test-with-parsed-data "- item\n\n para"
- (org-element-map tree 'paragraph
- (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)))))
- ;; Handle gracefully discontinuous headings.
- (should
- (equal '(yes yes)
- (org-test-with-parsed-data "** S\n* H"
- (org-element-map tree 'headline
- (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no)))))))
- (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-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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-export-filter-body-functions
- org-export-filter-final-output-functions)
- (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/custom-protocol-maybe ()
- "Test `org-export-custom-protocol-maybe' specifications."
- (should
- (string-match
- "success"
- (progn
- (org-link-set-parameters "foo" :export (lambda (_p _d _f _i) "success"))
- (org-export-string-as
- "[[foo:path]]"
- (org-export-create-backend
- :name 'test
- :transcoders
- '((section . (lambda (s c i) c))
- (paragraph . (lambda (p c i) c))
- (link . (lambda (l c i)
- (or (org-export-custom-protocol-maybe l c 'test i)
- "failure")))))))))
- (should-not
- (string-match
- "success"
- (progn
- (org-link-set-parameters
- "foo" :export (lambda (_p _d f _i) (and (eq f 'test) "success")))
- (org-export-string-as
- "[[foo:path]]"
- (org-export-create-backend
- :name 'no-test
- :transcoders
- '((section . (lambda (s c i) c))
- (paragraph . (lambda (p c i) c))
- (link . (lambda (l c i)
- (or (org-export-custom-protocol-maybe l c 'no-test i)
- "failure")))))))))
- ;; Ignore anonymous back-ends.
- (should-not
- (string-match
- "success"
- (progn
- (org-link-set-parameters
- "foo" :export (lambda (_p _d f _i) (and (eq f 'test) "success")))
- (org-export-string-as
- "[[foo:path]]"
- (org-export-create-backend
- :transcoders
- '((section . (lambda (s c i) c))
- (paragraph . (lambda (p c i) c))
- (link . (lambda (l c i)
- (or (org-export-custom-protocol-maybe l c nil i)
- "failure"))))))))))
- (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/insert-image-links ()
- "Test `org-export-insert-image-links' specifications."
- (should-not
- (member "file"
- (org-test-with-parsed-data "[[https://orgmode.org][file:image.png]]"
- (org-element-map tree 'link
- (lambda (l) (org-element-property :type l))))))
- (should
- (member "file"
- (org-test-with-parsed-data "[[https://orgmode.org][file:image.png]]"
- (org-element-map (org-export-insert-image-links tree info) 'link
- (lambda (l) (org-element-property :type l))))))
- ;; Properly set `:parent' property when replace contents with image
- ;; link.
- (should
- (memq 'link
- (org-test-with-parsed-data "[[https://orgmode.org][file:image.png]]"
- (org-element-map (org-export-insert-image-links tree info) 'link
- (lambda (l)
- (org-element-type (org-element-property :parent l)))))))
- ;; With optional argument RULES, recognize different links as
- ;; images.
- (should-not
- (member "file"
- (org-test-with-parsed-data "[[https://orgmode.org][file:image.xxx]]"
- (org-element-map (org-export-insert-image-links tree info) 'link
- (lambda (l) (org-element-property :type l))))))
- (should
- (member "file"
- (org-test-with-parsed-data "[[https://orgmode.org][file:image.xxx]]"
- (org-element-map
- (org-export-insert-image-links tree info '(("file" . "xxx")))
- 'link
- (lambda (l) (org-element-property :type l))))))
- ;; If an image link was included from another file, make sure to
- ;; shift any relative path accordingly.
- (should
- (string-prefix-p
- "file:org-includee-"
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "file:foo.png" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((section . (lambda (_s c _i) c))
- (paragraph . (lambda (_p c _i) c))
- (link . (lambda (l c _i) (org-element-link-interpreter l c))))
- :filters
- '((:filter-parse-tree
- (lambda (d _b i) (org-export-insert-image-links d i)))))))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer)))))))
- (should
- (string-match-p
- "file:org-includee-.+?foo\\.png"
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "[[https://orgmode.org][file:foo.png]]" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((section . (lambda (_s c _i) c))
- (paragraph . (lambda (_p c _i) c))
- (link . (lambda (l c _i) (org-element-link-interpreter l c))))
- :filters
- '((:filter-parse-tree
- (lambda (d _b i) (org-export-insert-image-links d i)))))))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer)))))))
- (should
- (string-match-p
- "file:org-includee.+?file:org-includee"
- (let* ((subdir (make-temp-file "org-includee-" t))
- (includee (expand-file-name "includee.org" subdir))
- (includer (make-temp-file "org-includer-")))
- (write-region "[[file:bar.png][file:foo.png]]" nil includee)
- (write-region (format "#+INCLUDE: %S"
- (file-relative-name includee
- temporary-file-directory))
- nil includer)
- (let ((buffer (find-file-noselect includer t)))
- (unwind-protect
- (with-current-buffer buffer
- (org-export-as
- (org-export-create-backend
- :transcoders
- '((section . (lambda (_s c _i) c))
- (paragraph . (lambda (_p c _i) c))
- (link . (lambda (l c _i) (org-element-link-interpreter l c))))
- :filters
- '((:filter-parse-tree
- (lambda (d _b i) (org-export-insert-image-links d i)))))))
- (when (buffer-live-p buffer)
- (with-current-buffer buffer (set-buffer-modified-p nil))
- (kill-buffer buffer))
- (when (file-exists-p subdir) (delete-directory subdir t))
- (when (file-exists-p includer) (delete-file includer))))))))
- (ert-deftest test-org-export/fuzzy-link ()
- "Test fuzzy links specifications."
- ;; Link to an headline should return headline's number.
- (should
- ;; Note: Headline's number is in fact a list of numbers.
- (equal '(2)
- (org-test-with-parsed-data
- "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]"
- (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.
- (should
- ;; Note: Item's number is in fact a list of numbers.
- (equal '(1 2)
- (org-test-with-parsed-data
- "- Item1\n - Item11\n - <<test>>Item12\n- Item2\n\n\n[[test]]"
- (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.
- (should
- (equal '(2 3)
- (org-test-with-parsed-data "
- Paragraph[fn:1][fn:2][fn:lbl3:C<<target>>][[test]][[target]]
- \[fn:1] A
- \[fn:2] <<test>>B"
- (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.
- (should
- (= 2
- (org-test-with-parsed-data
- "#+NAME: tbl1\n|1|2|\n#+NAME: tbl2\n|3|4|\n#+NAME: tbl3\n|5|6|\n[[tbl2]]"
- (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.
- (should
- (equal '(2)
- (org-test-with-parsed-data
- "* Head1\n* Head2\nParagraph<<target>>\n* Head3\n[[target]]"
- (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))))
- (ert-deftest test-org-export/resolve-link ()
- "Test `org-export-resolve-link' specifications."
- (should
- ;; Match ID links
- (equal
- "Headline1"
- (org-test-with-parsed-data "* Headline1
- :PROPERTIES:
- :ID: aaaa
- :END:
- * Headline2"
- (org-element-property
- :raw-value (org-export-resolve-link "#aaaa" info)))))
- ;; Match Custom ID links
- (should
- (equal
- "Headline1"
- (org-test-with-parsed-data
- "* Headline1
- :PROPERTIES:
- :CUSTOM_ID: test
- :END:
- * Headline2"
- (org-element-property
- :raw-value (org-export-resolve-link "#test" info)))))
- ;; Match fuzzy links
- (should
- (equal
- "B"
- (org-test-with-parsed-data
- "* A\n* B\n* C"
- (org-element-property
- :raw-value (org-export-resolve-link "B" info))))))
- (defun test-org-gen-loc-list(text type)
- (org-test-with-parsed-data text
- (org-element-map tree type
- (lambda (el) (or (org-export-get-loc el info) 'no-loc)))))
- (ert-deftest test-org-export/get-loc ()
- "Test `org-export-get-loc' specifications."
- (should
- ;; "-n" resets line number.
- (equal '(0)
- (test-org-gen-loc-list "#+BEGIN_EXAMPLE -n\n Text\n#+END_EXAMPLE"
- 'example-block)))
- ;; The first "+n" has 0 lines before it
- (should
- (equal '(0)
- (test-org-gen-loc-list "#+BEGIN_EXAMPLE +n\n Text\n#+END_EXAMPLE"
- 'example-block)))
- ;; "-n 10" resets line number but has "9 lines" before it.
- (should
- (equal '(9)
- (test-org-gen-loc-list "#+BEGIN_EXAMPLE -n 10\n Text\n#+END_EXAMPLE"
- 'example-block)))
- ;; -n10 with two lines then +n 15
- (should
- (equal '(9 25)
- (test-org-gen-loc-list "
- #+BEGIN_EXAMPLE -n 10
- Text_10
- Second line(11)
- #+END_EXAMPLE
- #+BEGIN_EXAMPLE +n 15
- Text line (11 + 15)
- #+END_EXAMPLE"
- 'example-block)))
- (should
- (equal '(9 19 0)
- (test-org-gen-loc-list "
- #+BEGIN_EXAMPLE -n 10
- Text
- #+END_EXAMPLE
- #+BEGIN_EXAMPLE +n 10
- Text
- #+END_EXAMPLE
- #+BEGIN_EXAMPLE -n
- Text
- #+END_EXAMPLE"
- 'example-block)))
- ;; an Example Block without -n does not add to the line count.
- (should
- (equal '(9 no-loc 19)
- (test-org-gen-loc-list "
- #+BEGIN_EXAMPLE -n 10
- Text
- #+END_EXAMPLE
- #+BEGIN_EXAMPLE
- Text
- #+END_EXAMPLE
- #+BEGIN_EXAMPLE +n 10
- Text
- #+END_EXAMPLE"
- 'example-block)))
- ;; "-n" resets line number.
- (should
- (equal
- '(0)
- (test-org-gen-loc-list "#+BEGIN_SRC emacs-lisp -n \n (- 1 1) \n#+END_SRC"
- 'src-block)))
- ;; The first "+n" has 0 lines before it.
- (should
- (equal '(0)
- (test-org-gen-loc-list
- "#+BEGIN_SRC emacs-lisp +n \n (+ 0 (- 1 1))\n#+END_SRC"
- 'src-block)))
- ;; "-n 10" resets line number but has "9 lines" before it.
- (should
- (equal '(9)
- (test-org-gen-loc-list
- "#+BEGIN_SRC emacs-lisp -n 10\n (- 10 1)\n#+END_SRC"
- 'src-block)))
- (should
- (equal '(9 25)
- (test-org-gen-loc-list "
- #+BEGIN_SRC emacs-lisp -n 10
- (- 10 1)
- (+ (- 10 1) 1)
- #+END_SRC
- #+BEGIN_SRC emacs-lisp +n 15
- (+ (- 10 1) 2 (- 15 1))
- #+END_SRC"
- 'src-block)))
- (should
- (equal '(9 19 0)
- (test-org-gen-loc-list "
- #+BEGIN_SRC emacs-lisp -n 10
- (- 10 1)
- #+END_SRC
- #+BEGIN_SRC emacs-lisp +n 10
- (+ (- 10 1) 1 (- 10 1))
- #+END_SRC
- #+BEGIN_SRC emacs-lisp -n
- (- 1 1)
- #+END_SRC"
- 'src-block)))
- ;; A SRC Block without -n does not add to the line count.
- (should
- (equal '(9 no-loc 19)
- (test-org-gen-loc-list
- "#+BEGIN_SRC emacs-lisp -n 10
- (+ (-10 1) 1)
- #+END_SRC
- #+BEGIN_SRC emacs-lisp
- (+ 2 2)
- #+END_SRC
- #+BEGIN_SRC emacs-lisp +n 10
- (+ (- 10 1) 1 (- 10 1))
- #+END_SRC"
- 'src-block))))
- (ert-deftest test-org-export/resolve-coderef ()
- "Test `org-export-resolve-coderef' specifications."
- (let ((org-coderef-label-format "(ref:%s)"))
- ;; A link to a "-n -k -r" block returns line number.
- (should
- (= 1
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE -n -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 10
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE -n 10 -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 135
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE -n 10 -k -r\nText \n#+END_EXAMPLE\n
- #+BEGIN_EXAMPLE +n 125 -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 1
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp -n -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 10
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp -n 10 -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 135
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp -n 10 -k -r\n(+ 1 1) \n#+END_SRC\n
- #+BEGIN_SRC emacs-lisp +n 125 -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
- (org-export-resolve-coderef "coderef" info))))
- ;; A link to a "-n -r" block returns line number.
- (should
- (= 1
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE -n -r\nText (ref:coderef)\n#+END_EXAMPLE"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 10
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE -n 10 -r\nText (ref:coderef)\n#+END_EXAMPLE"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 135
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE +n 10 -r\nText \n#+END_EXAMPLE
- #+BEGIN_EXAMPLE +n 125 -r\nText (ref:coderef)\n#+END_EXAMPLE"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 1
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 10
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp -n10 -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 135
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp -n10 -r\n(+ 1 1) \n#+END_SRC
- #+BEGIN_SRC emacs-lisp +n125 -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
- (org-export-resolve-coderef "coderef" info))))
- ;; A link to a "-n" block returns coderef.
- (should
- (equal "coderef"
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1) (ref:coderef)\n#+END_SRC"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (equal "coderef"
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE -n\nText (ref:coderef)\n#+END_EXAMPLE"
- (org-export-resolve-coderef "coderef" info))))
- ;; A link to a "-r" block returns line number.
- (should
- (= 1
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
- (org-export-resolve-coderef "coderef" info))))
- (should
- (= 1
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE -r\nText (ref:coderef)\n#+END_EXAMPLE"
- (org-export-resolve-coderef "coderef" info))))
- ;; A link to a block without a switch returns coderef.
- (should
- (equal "coderef"
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp\n(+ 1 1) (ref:coderef)\n#+END_SRC"
- (org-export-resolve-coderef "coderef" info))))
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE\nText (ref:coderef)\n#+END_EXAMPLE"
- (should (equal (org-export-resolve-coderef "coderef" info) "coderef")))
- ;; 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.
- (should
- (equal '(2 1)
- (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"
- (list (org-export-resolve-coderef "addition" info)
- (org-export-resolve-coderef "text" info)))))
- ;; Recognize coderef with user-specified syntax.
- (should
- (equal
- "text"
- (org-test-with-parsed-data
- "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText. [ref:text]\n#+END_EXAMPLE"
- (org-export-resolve-coderef "text" info))))
- ;; Unresolved coderefs raise a `org-link-broken' signal.
- (should
- (condition-case nil
- (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
- (org-export-resolve-coderef "unknown" info))
- (org-link-broken t)))))
- (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 headline titles.
- (should
- (eq 'target
- (org-test-with-parsed-data "* target\n<<target>>[[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)))))
- ;; Raise a `org-link-broken' signal if no match.
- (should
- (org-test-with-parsed-data "[[target]]"
- (condition-case nil
- (org-export-resolve-fuzzy-link
- (org-element-map tree 'link #'identity info t) info)
- (org-link-broken t))))
- ;; 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)))))
- ;; Handle escaped fuzzy links.
- (should
- (org-test-with-parsed-data "* [foo]\n[[\\[foo\\]]]"
- (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."
- ;; Regular test for custom-id link.
- (should
- (equal '("Headline1")
- (org-test-with-parsed-data "* Headline1
- :PROPERTIES:
- :CUSTOM_ID: test
- :END:
- * Headline 2
- \[[#test]]"
- (org-element-property
- :title
- (org-export-resolve-id-link
- (org-element-map tree 'link 'identity info t) info)))))
- ;; Raise a `org-link-broken' signal on failing searches.
- (should
- (org-test-with-parsed-data "* Headline1
- :PROPERTIES:
- :CUSTOM_ID: test
- :END:
- * Headline 2
- \[[#no-match]]"
- (condition-case nil
- (org-export-resolve-id-link
- (org-element-map tree 'link #'identity info t) info)
- (org-link-broken t))))
- ;; Test for internal id target.
- (should
- (equal '("Headline1")
- (org-test-with-parsed-data "* Headline1
- :PROPERTIES:
- :ID: aaaa
- :END:
- * Headline 2
- \[[id:aaaa]]"
- (org-element-property
- :title
- (org-export-resolve-id-link
- (org-element-map tree 'link 'identity info t) info)))))
- ;; Test for external id target.
- (should
- (equal
- "external-file"
- (org-test-with-parsed-data "[[id:aaaa]]"
- (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)))))
- (ert-deftest test-org-export/file-uri ()
- "Test `org-export-file-uri' specifications."
- ;; Preserve relative filenames.
- (should (equal "relative.org" (org-export-file-uri "relative.org")))
- ;; Local files start with "file://"
- (should (equal (concat (if (memq system-type '(windows-nt cygwin)) "file:///" "file://") (expand-file-name "/local.org"))
- (org-export-file-uri "/local.org")))
- ;; Remote files start with "file://"
- (should (equal "file://ssh:myself@some.where:papers/last.pdf"
- (org-export-file-uri "/ssh:myself@some.where:papers/last.pdf")))
- (should (equal "file://localhost/etc/fstab"
- (org-export-file-uri "//localhost/etc/fstab")))
- ;; Expand filename starting with "~".
- (should (equal (org-export-file-uri "~/file.org")
- (concat (if (memq system-type '(windows-nt cygwin)) "file:///" "file://") (expand-file-name "~/file.org")))))
- (ert-deftest test-org-export/get-reference ()
- "Test `org-export-get-reference' specifications."
- (should
- (org-test-with-parsed-data "* Headline"
- (org-export-get-reference (org-element-map tree 'headline #'identity nil t)
- info)))
- ;; For a given element always return the same reference.
- (should
- (org-test-with-parsed-data "* Headline"
- (let ((headline (org-element-map tree 'headline #'identity nil t)))
- (equal (org-export-get-reference headline info)
- (org-export-get-reference headline info)))))
- ;; References get through local export back-ends.
- (should
- (org-test-with-parsed-data "* Headline"
- (let ((headline (org-element-map tree 'headline #'identity nil t))
- (backend
- (org-export-create-backend
- :transcoders
- '((headline . (lambda (h _c i) (org-export-get-reference h i)))))))
- (equal (org-trim (org-export-data-with-backend headline backend info))
- (org-export-get-reference headline info)))))
- (should
- (org-test-with-parsed-data "* Headline"
- (let ((headline (org-element-map tree 'headline #'identity nil t))
- (backend
- (org-export-create-backend
- :transcoders
- '((headline . (lambda (h _c i) (org-export-get-reference h i)))))))
- (equal (org-export-with-backend backend headline nil info)
- (org-export-get-reference headline info)))))
- ;; Use search cells defined in `:crossrefs'. However, handle
- ;; duplicate search cells.
- (should
- (equal "org0000001"
- (org-test-with-parsed-data "* Headline"
- (let* ((headline (org-element-map tree 'headline #'identity nil t))
- (search-cell (car (org-export-search-cells headline))))
- (setq info
- (plist-put info :crossrefs (list (cons search-cell 1))))
- (org-export-get-reference headline info)))))
- (should-not
- (equal '("org0000001" "org0000001")
- (org-test-with-parsed-data "* H\n** H"
- (org-element-map tree 'headline
- (lambda (h)
- (let* ((search-cell (car (org-export-search-cells h)))
- (info (plist-put info :crossrefs
- (list (cons search-cell 1)))))
- (org-export-get-reference h info))))))))
- ;;; Pseudo objects and pseudo elements
- (ert-deftest test-org-export/pseudo-elements ()
- "Test exporting pseudo-elements."
- ;; Handle blank lines after pseudo-elements. In particular, do not
- ;; replace them with white spaces.
- (should
- (equal "contents\n\nparagraph\n"
- (let ((backend (org-export-create-backend
- :transcoders
- '((pseudo-element . (lambda (_p c _i) c))
- (paragraph . (lambda (_p c _i) c))
- (plain-text . (lambda (c _i) c)))))
- (element '(pseudo-element (:post-blank 1) "contents"))
- (paragraph '(paragraph nil "paragraph"))
- (data '(org-data nil)))
- (org-element-adopt-elements data element paragraph)
- (org-export-data-with-backend data backend nil)))))
- (ert-deftest test-org-export/pseudo-objects ()
- "Test exporting pseudo-objects."
- ;; Handle blank spaces after pseudo-objects. In particular, do not
- ;; replace them with newlines.
- (should
- (equal "begin x end\n"
- (let ((backend (org-export-create-backend
- :transcoders
- '((pseudo-object . (lambda (_p c _i) c))
- (paragraph . (lambda (_p c _i) c))
- (plain-text . (lambda (c _i) c)))))
- (object '(pseudo-object (:post-blank 1) "x"))
- (paragraph '(paragraph nil)))
- (org-element-adopt-elements paragraph "begin " object "end")
- (org-export-data-with-backend paragraph backend nil)))))
- ;;; Raw objects
- (ert-deftest test-org-export/raw-strings ()
- "Test exporting raw objects."
- (should
- (equal "foo"
- (let ((backend (org-export-create-backend))
- (object (org-export-raw-string "foo")))
- (org-export-data-with-backend object backend nil)))))
- ;;; 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)")
- (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)" (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)" (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)" (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."
- ;; Preserve blank lines, even when code is empty.
- (should
- (equal "\n\n"
- (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))))
- ;; Likewise, preserve leading and trailing blank lines in the code.
- (should
- (equal "\n(+ 1 1)\n"
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp\n\n(+ 1 1)\n#+END_SRC"
- (org-export-format-code-default
- (org-element-map tree 'src-block #'identity info t) info))))
- (should
- (equal "(+ 1 1)\n\n"
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\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))))
- ;; Numbering includes blank lines.
- (should
- (equal "1 \n2 a\n3 \n4 b\n5 \n"
- (org-test-with-parsed-data
- "#+BEGIN_SRC emacs-lisp +n\n\na\n\nb\n\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))))))
- (ert-deftest test-org-export/latex-src-block-verbatim-caption ()
- "Test `org-latex-src-block' caption for verbatim environment.
- Check that percent sign does not become a part of format.
- This test does not cover listings and custom environments."
- (let ((export
- (lambda (buffer-text)
- (org-test-with-parsed-data
- buffer-text
- (let* ((backend (org-export-get-backend 'latex))
- (info (org-combine-plists
- (org-export--get-export-attributes backend)
- (org-export-get-environment backend)))
- (result (org-latex-src-block
- (org-element-map tree 'src-block #'identity info t)
- t info)))
- ;; Remove properties to make failure reports more clear.
- (set-text-properties 0 (length result) nil result)
- result)))))
- (should (equal
- "\
- \\begin{verbatim}
- \"No float, no listings, 20%S\"
- \\end{verbatim}
- \\captionof{figure}{Caption of verbatim is below, 20\\%s}
- "
- (funcall export
- "\
- #+CAPTION: Caption of verbatim is below, 20%s
- #+BEGIN_SRC emacs-lisp
- \"No float, no listings, 20%S\"
- #+END_SRC")))
- ;; `org-latex-caption-above' has no associated property or keyword.
- (should (equal
- "\
- \\captionof{figure}{Caption of verbatim is above, 40\\%s}
- \\begin{verbatim}
- \"No float, no listings, 40%S\"
- \\end{verbatim}"
- (let ((org-latex-caption-above t))
- (funcall export
- "\
- #+CAPTION: Caption of verbatim is above, 40%s
- #+BEGIN_SRC emacs-lisp
- \"No float, no listings, 40%S\"
- #+END_SRC"))))
- (should (equal
- "\
- \\begin{figure*}[tp]
- \\caption{Caption is above, 60\\%s}
- \\begin{verbatim}
- \"Float, no listings, 60%S\"
- \\end{verbatim}
- \\end{figure*}"
- (let ((org-latex-caption-above t)
- (org-latex-default-figure-position "tp"))
- (funcall export
- "\
- #+CAPTION: Caption is above, 60%s
- #+ATTR_LATEX: :float multicolumn
- #+BEGIN_SRC emacs-lisp
- \"Float, no listings, 60%S\"
- #+END_SRC"))))
- (should (equal
- "\
- \\begin{figure*}[tp]
- \\begin{verbatim}
- \"Float, no lang, listings, 80%S\"
- \\end{verbatim}
- \\caption{Caption is below, 60\\%s}
- \\end{figure*}"
- (let ((org-latex-src-block-backend 'minted) ; inactive due to missing lang
- (org-latex-default-figure-position "tp"))
- ;; Namely "multicolumn" value to get just figure environment
- ;; looks like a bug.
- (funcall export
- "\
- #+CAPTION: Caption is below, 60%s
- #+ATTR_LATEX: :float multicolumn
- #+BEGIN_SRC
- \"Float, no lang, listings, 80%S\"
- #+END_SRC"))))
- (should (equal
- "\
- \\begin{verbatim}
- \"No caption, no float, no listings, 100%S\"
- \\end{verbatim}"
- (funcall export
- "\
- #+BEGIN_SRC emacs-lisp
- \"No caption, no float, no listings, 100%S\"
- #+END_SRC")))))
- ;;; Smart Quotes
- (ert-deftest test-org-export/activate-smart-quotes ()
- "Test `org-export-activate-smart-quotes' specifications."
- ;; Double quotes: standard test.
- (should
- (equal
- '("some “quoted” text")
- (let ((org-export-default-language "en"))
- (org-test-with-parsed-data "some \"quoted\" text"
- (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
- '("“quoted” text")
- (let ((org-export-default-language "en"))
- (org-test-with-parsed-data "=verb= \"quoted\" text"
- (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
- '("Quoted “text”")
- (let ((org-export-default-language "en"))
- (org-test-with-parsed-data "Quoted \"text\""
- (org-element-map tree 'plain-text
- (lambda (s) (org-export-activate-smart-quotes s :html info))
- info)))))
- ;; Inner quotes: standard test.
- (should
- (equal '("« outer « inner » outer »")
- (let ((org-export-default-language "fr"))
- (org-test-with-parsed-data "\"outer 'inner' outer\""
- (org-element-map tree 'plain-text
- (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
- info)))))
- ;; Inner quotes: close to special symbols.
- (should
- (equal '("« outer (« inner ») outer »")
- (let ((org-export-default-language "fr"))
- (org-test-with-parsed-data "\"outer ('inner') outer\""
- (org-element-map tree 'plain-text
- (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
- info)))))
- (should
- (equal '("« « inner » »")
- (let ((org-export-default-language "fr"))
- (org-test-with-parsed-data "\"'inner'\""
- (org-element-map tree 'plain-text
- (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
- info)))))
- ;; Apostrophe: standard test.
- (should
- (equal '("It « shouldn’t » fail")
- (let ((org-export-default-language "fr"))
- (org-test-with-parsed-data "It \"shouldn't\" fail"
- (org-element-map tree 'plain-text
- (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
- info)))))
- (should
- (equal '("It shouldn’t fail")
- (let ((org-export-default-language "fr"))
- (org-test-with-parsed-data "It shouldn't fail"
- (org-element-map tree 'plain-text
- (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
- info)))))
- ;; Apostrophe: before an object.
- (should
- (equal
- '("« a’" " »")
- (let ((org-export-default-language "fr"))
- (org-test-with-parsed-data "\"a'=b=\""
- (org-element-map tree 'plain-text
- (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
- info)))))
- ;; Apostrophe: after an object.
- (should
- (equal '("« " "’s »")
- (let ((org-export-default-language "fr"))
- (org-test-with-parsed-data "\"=code='s\""
- (org-element-map tree 'plain-text
- (lambda (s) (org-export-activate-smart-quotes s :utf-8 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)))))
- ;; Smart quotes within objects.
- (should
- (equal '("“foo”")
- (let ((org-export-default-language "en"))
- (org-test-with-parsed-data "| \"foo\" |"
- (org-element-map tree 'plain-text
- (lambda (s) (org-export-activate-smart-quotes s :html info))
- info nil nil t)))))
- ;; FIXME: Test failing non-interactively.
- ;;
- ;; (should
- ;; (equal '("“foo”")
- ;; (let ((org-export-default-language "en"))
- ;; (org-test-with-parsed-data "*\"foo\"*"
- ;; (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."
- ;; With an header.
- (should
- (org-test-with-parsed-data "
- | a | b |
- |---+---|
- | c | d |"
- (org-export-table-has-header-p
- (org-element-map tree 'table 'identity info 'first-match)
- info)))
- ;; With a multi-line header.
- (should
- (org-test-with-parsed-data "
- | a | b |
- | 0 | 1 |
- |---+---|
- | a | w |"
- (org-export-table-has-header-p
- (org-element-map tree 'table 'identity info 'first-match)
- info)))
- ;; Without an header.
- (should-not
- (org-test-with-parsed-data "
- | a | b |
- | c | d |"
- (org-export-table-has-header-p
- (org-element-map tree 'table 'identity info 'first-match)
- info)))
- ;; Don't get fooled with starting and ending rules.
- (should-not
- (org-test-with-parsed-data "
- |---+---|
- | a | b |
- | c | d |
- |---+---|"
- (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."
- ;; 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)))))))
- ;; 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))))
- ;; 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."
- ;; Width is primarily determined by width cookies. If no cookie is
- ;; found, cell's width is nil.
- (should
- (equal '(nil 6 7)
- (org-test-with-parsed-data "
- | / | <l> | <6> | <l7> |
- | | a | b | c |"
- (mapcar (lambda (cell) (org-export-table-cell-width cell info))
- (org-element-map tree 'table-cell 'identity info)))))
- ;; Valid width cookies must have a specific row.
- (should
- (equal '(nil nil)
- (org-test-with-parsed-data "| <6> | cell |"
- (mapcar (lambda (cell) (org-export-table-cell-width cell info))
- (org-element-map tree 'table-cell 'identity)))))
- ;; Do not error on malformed tables.
- (should
- (org-test-with-parsed-data "
- | a |
- | b | c |"
- (mapcar (lambda (cell) (org-export-table-cell-width cell info))
- (org-element-map tree 'table-cell 'identity info)))))
- (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-in-header-p ()
- "Test `org-export-table-row-in-header-p' specifications."
- ;; Standard test. Separators are always nil.
- (should
- (equal
- '(yes no no)
- (org-test-with-parsed-data "| a |\n|---|\n| b |"
- (org-element-map tree 'table-row
- (lambda (row)
- (if (org-export-table-row-in-header-p row info) 'yes 'no)) info))))
- ;; Nil when there is no header.
- (should
- (equal
- '(no no)
- (org-test-with-parsed-data "| a |\n| b |"
- (org-element-map tree 'table-row
- (lambda (row)
- (if (org-export-table-row-in-header-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
- (equal '("H1" "H2")
- (org-test-with-parsed-data "* H1\n** H2"
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info)))))
- ;; Do not collect headlines below optional argument.
- (should
- (equal '("H1")
- (org-test-with-parsed-data "* H1\n** H2"
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info 1)))))
- ;; Never collect headlines below maximum headline level.
- (should
- (equal '("H1")
- (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info)))))
- (should
- (equal '("H1")
- (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info 2)))))
- ;; Do not collect footnote section.
- (should
- (equal '("H1")
- (let ((org-footnote-section "Footnotes"))
- (org-test-with-parsed-data "* H1\n** Footnotes"
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info))))))
- ;; Do not collect headlines with UNNUMBERED property set to "notoc".
- ;; Headlines with another value for the property are still
- ;; collected. UNNUMBERED property is inherited.
- (should
- (equal '("H1")
- (org-test-with-parsed-data
- "* H1\n* H2\n:PROPERTIES:\n:UNNUMBERED: notoc\n:END:"
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info)))))
- (should-not
- (org-test-with-parsed-data
- "* H1\n:PROPERTIES:\n:UNNUMBERED: notoc\n:END:\n** H2"
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info))))
- (should
- (equal '("H1" "H2")
- (org-test-with-parsed-data
- "* H1\n* H2\n:PROPERTIES:\n:UNNUMBERED: t\n:END:"
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info)))))
- ;; Collect headlines locally.
- (should
- (equal '("H2" "H3")
- (org-test-with-parsed-data "* H1\n** H2\n** H3"
- (let ((scope (org-element-map tree 'headline #'identity info t)))
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info nil scope))))))
- ;; Collect headlines from a scope specified by a fuzzy match
- (should
- (equal '("H3" "H4")
- (org-test-with-parsed-data "* HA
- ** H1
- ** H2
- * Target
- :PROPERTIES:
- :CUSTOM_ID: TargetSection
- :END:
- ** H3
- ** H4
- * HB
- ** H5
- "
- (mapcar
- (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines
- info
- nil
- (org-export-resolve-fuzzy-link
- (with-temp-buffer
- (save-excursion (insert "[[Target]]"))
- (org-element-link-parser))
- info))))))
- ;; Collect headlines from a scope specified by CUSTOM_ID
- (should
- (equal '("H3" "H4")
- (org-test-with-parsed-data "* Not this section
- ** H1
- ** H2
- * Target
- :PROPERTIES:
- :CUSTOM_ID: TargetSection
- :END:
- ** H3
- ** H4
- * Another
- ** H5
- "
- (mapcar
- (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines
- info
- nil
- (org-export-resolve-id-link
- (with-temp-buffer
- (save-excursion (insert "[[#TargetSection]]"))
- (org-element-link-parser))
- info))))))
- ;; When collecting locally, optional level is relative.
- (should
- (equal '("H2")
- (org-test-with-parsed-data "* H1\n** H2\n*** H3"
- (let ((scope (org-element-map tree 'headline #'identity info t)))
- (mapcar (lambda (h) (org-element-property :raw-value h))
- (org-export-collect-headlines info 1 scope)))))))
- (ert-deftest test-org-export/excluded-from-toc-p ()
- "Test `org-export-excluded-from-toc-p' specifications."
- ;; By default, headlines are not excluded.
- (should-not
- (org-test-with-parsed-data "* H1"
- (org-element-map tree 'headline
- (lambda (h) (org-export-excluded-from-toc-p h info)) info t)))
- ;; Exclude according to a maximum level.
- (should
- (equal '(in out)
- (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
- (org-element-map tree 'headline
- (lambda (h) (if (org-export-excluded-from-toc-p h info) 'out 'in))
- info))))
- ;; Exclude according to UNNUMBERED property.
- (should
- (org-test-with-parsed-data "* H1\n:PROPERTIES:\n:UNNUMBERED: notoc\n:END:"
- (org-element-map tree 'headline
- (lambda (h) (org-export-excluded-from-toc-p h info)) info t)))
- ;; UNNUMBERED property is inherited, so is "notoc" value.
- (should
- (equal '(out out)
- (org-test-with-parsed-data
- "* H1\n:PROPERTIES:\n:UNNUMBERED: notoc\n:END:\n** H2"
- (org-element-map tree 'headline
- (lambda (h) (if (org-export-excluded-from-toc-p h info) 'out 'in))
- info)))))
- (ert-deftest test-org-export/toc-entry-backend ()
- "Test `org-export-toc-entry-backend' specifications."
- ;; Ignore targets.
- (should
- (equal "H \n"
- (org-test-with-temp-text "* H <<target>>"
- (let (org-export-registered-backends)
- (org-export-define-backend 'test
- '((headline . (lambda (h _c i) (org-export-data-with-backend
- (org-element-property :title h)
- (org-export-toc-entry-backend 'test)
- i)))))
- (org-export-as 'test)))))
- ;; Ignore footnote references.
- (should
- (equal "H \n"
- (org-test-with-temp-text "[fn:1] Definition\n* H [fn:1]"
- (let (org-export-registered-backends)
- (org-export-define-backend 'test
- '((headline . (lambda (h _c i) (org-export-data-with-backend
- (org-element-property :title h)
- (org-export-toc-entry-backend 'test)
- i)))))
- (org-export-as 'test)))))
- ;; Replace plain links with contents, or with path.
- (should
- (equal "H Org mode\n"
- (org-test-with-temp-text "* H [[https://orgmode.org][Org mode]]"
- (let (org-export-registered-backends)
- (org-export-define-backend 'test
- '((headline . (lambda (h _c i) (org-export-data-with-backend
- (org-element-property :title h)
- (org-export-toc-entry-backend 'test)
- i)))))
- (org-export-as 'test)))))
- (should
- (equal "H https://orgmode.org\n"
- (org-test-with-temp-text "* H [[https://orgmode.org]]"
- (let (org-export-registered-backends)
- (org-export-define-backend 'test
- '((headline . (lambda (h _c i) (org-export-data-with-backend
- (org-element-property :title h)
- (org-export-toc-entry-backend 'test)
- i)))))
- (org-export-as 'test)))))
- ;; Replace radio targets with contents.
- (should
- (equal "H radio\n"
- (org-test-with-temp-text "* H <<<radio>>>"
- (let (org-export-registered-backends)
- (org-export-define-backend 'test
- '((headline . (lambda (h _c i) (org-export-data-with-backend
- (org-element-property :title h)
- (org-export-toc-entry-backend 'test)
- i)))))
- (org-export-as 'test)))))
- ;; With optional argument TRANSCODERS, specify other
- ;; transformations.
- (should
- (equal "H bold\n"
- (org-test-with-temp-text "* H *bold*"
- (let (org-export-registered-backends)
- (org-export-define-backend 'test
- '((headline . (lambda (h _c i) (org-export-data-with-backend
- (org-element-property :title h)
- (org-export-toc-entry-backend 'test
- '(bold . (lambda (_b c _i) c)))
- i)))))
- (org-export-as 'test))))))
- ;;; 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
|