| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import Schema, { SchemaContext } from '../../src/model/schema';
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- import Model from '../../src/model/model';
- import DocumentFragment from '../../src/model/documentfragment';
- import Element from '../../src/model/element';
- import Text from '../../src/model/text';
- import TextProxy from '../../src/model/textproxy';
- import Position from '../../src/model/position';
- import Range from '../../src/model/range';
- import { getData, setData, stringify, parse } from '../../src/dev-utils/model';
- import AttributeOperation from '../../src/model/operation/attributeoperation';
- describe( 'Schema', () => {
- let schema, root1, r1p1, r1p2, r1bQ, r1bQp, root2;
- beforeEach( () => {
- schema = new Schema();
- root1 = new Element( '$root', null, [
- new Element( 'paragraph', null, 'foo' ),
- new Element( 'paragraph', { align: 'right' }, 'bar' ),
- new Element( 'blockQuote', null, [
- new Element( 'paragraph', null, 'foo' )
- ] )
- ] );
- r1p1 = root1.getChild( 0 );
- r1p2 = root1.getChild( 1 );
- r1bQ = root1.getChild( 2 );
- r1bQp = r1bQ.getChild( 0 );
- root2 = new Element( '$root2' );
- } );
- describe( 'register()', () => {
- it( 'allows registering an item', () => {
- schema.register( 'foo' );
- expect( schema.getDefinition( 'foo' ) ).to.be.an( 'object' );
- } );
- it( 'copies definitions', () => {
- const definitions = {};
- schema.register( 'foo', definitions );
- definitions.isBlock = true;
- expect( schema.getDefinitions().foo ).to.not.have.property( 'isBlock' );
- } );
- it( 'throws when trying to register for a single item twice', () => {
- schema.register( 'foo' );
- expect( () => {
- schema.register( 'foo' );
- } ).to.throw( CKEditorError, /^schema-cannot-register-item-twice:/ );
- } );
- } );
- describe( 'extend()', () => {
- it( 'allows extending item\'s definitions', () => {
- schema.register( 'foo' );
- schema.extend( 'foo', {
- isBlock: true
- } );
- expect( schema.getDefinition( 'foo' ) ).to.have.property( 'isBlock', true );
- } );
- it( 'copies definitions', () => {
- schema.register( 'foo', {} );
- const definitions = {};
- schema.extend( 'foo', definitions );
- definitions.isBlock = true;
- expect( schema.getDefinitions().foo ).to.not.have.property( 'isBlock' );
- } );
- it( 'throws when trying to extend a not yet registered item', () => {
- expect( () => {
- schema.extend( 'foo' );
- } ).to.throw( CKEditorError, /^schema-cannot-extend-missing-item:/ );
- } );
- } );
- describe( 'getDefinitions()', () => {
- it( 'returns compiled definitions', () => {
- schema.register( '$root' );
- schema.register( 'foo', {
- allowIn: '$root'
- } );
- schema.extend( 'foo', {
- isBlock: true
- } );
- const definitions = schema.getDefinitions();
- expect( definitions.foo ).to.deep.equal( {
- name: 'foo',
- allowIn: [ '$root' ],
- allowAttributes: [],
- isBlock: true
- } );
- } );
- it( 'copies all is* types', () => {
- schema.register( 'foo', {
- isBlock: true,
- isFoo: true
- } );
- schema.extend( 'foo', {
- isBar: true,
- isFoo: false // Just to check that the last one wins.
- } );
- const definitions = schema.getDefinitions();
- expect( definitions.foo ).to.have.property( 'isBlock', true );
- expect( definitions.foo ).to.have.property( 'isFoo', false );
- expect( definitions.foo ).to.have.property( 'isBar', true );
- } );
- it( 'does not recompile definitions if not needed', () => {
- schema.register( 'foo' );
- expect( schema.getDefinitions() ).to.equal( schema.getDefinitions() );
- } );
- it( 'ensures no duplicates in allowIn', () => {
- schema.register( '$root' );
- schema.register( 'foo', {
- allowIn: '$root'
- } );
- schema.extend( 'foo', {
- allowIn: '$root'
- } );
- const definitions = schema.getDefinitions();
- expect( definitions.foo ).to.deep.equal( {
- name: 'foo',
- allowIn: [ '$root' ],
- allowAttributes: []
- } );
- } );
- it( 'ensures no non-registered items in allowIn', () => {
- schema.register( 'foo', {
- allowIn: '$root'
- } );
- const definitions = schema.getDefinitions();
- expect( definitions.foo ).to.deep.equal( {
- name: 'foo',
- allowIn: [],
- allowAttributes: []
- } );
- } );
- it( 'ensures no duplicates in allowAttributes', () => {
- schema.register( 'paragraph', {
- allowAttributes: 'foo'
- } );
- schema.extend( 'paragraph', {
- allowAttributes: 'foo'
- } );
- const definitions = schema.getDefinitions();
- expect( definitions.paragraph ).to.deep.equal( {
- name: 'paragraph',
- allowIn: [],
- allowAttributes: [ 'foo' ]
- } );
- } );
- it( 'ensures no duplicates in allowAttributes duplicated by allowAttributesOf', () => {
- schema.register( 'paragraph', {
- allowAttributes: 'foo',
- allowAttributesOf: '$block'
- } );
- schema.register( '$block', {
- allowAttributes: 'foo'
- } );
- const definitions = schema.getDefinitions();
- expect( definitions.paragraph ).to.deep.equal( {
- name: 'paragraph',
- allowIn: [],
- allowAttributes: [ 'foo' ]
- } );
- } );
- } );
- describe( 'getDefinition()', () => {
- it( 'returns a definition based on an item name', () => {
- schema.register( 'foo', {
- isMe: true
- } );
- expect( schema.getDefinition( 'foo' ).isMe ).to.be.true;
- } );
- it( 'returns a definition based on an element name', () => {
- schema.register( 'foo', {
- isMe: true
- } );
- expect( schema.getDefinition( new Element( 'foo' ) ).isMe ).to.be.true;
- } );
- it( 'returns a definition based on a text node', () => {
- schema.register( '$text', {
- isMe: true
- } );
- expect( schema.getDefinition( new Text( 'foo' ) ).isMe ).to.be.true;
- } );
- it( 'returns a definition based on a text proxy', () => {
- schema.register( '$text', {
- isMe: true
- } );
- const text = new Text( 'foo' );
- const textProxy = new TextProxy( text, 0, 1 );
- expect( schema.getDefinition( textProxy ).isMe ).to.be.true;
- } );
- it( 'returns a definition based on a schema context item', () => {
- schema.register( 'foo', {
- isMe: true
- } );
- const ctx = new SchemaContext( [ '$root', 'foo' ] );
- expect( schema.getDefinition( ctx.last ).isMe ).to.be.true;
- } );
- it( 'returns undefined when trying to get an non-registered item', () => {
- expect( schema.getDefinition( '404' ) ).to.be.undefined;
- } );
- } );
- describe( 'isRegistered()', () => {
- it( 'returns true if an item was registered', () => {
- schema.register( 'foo' );
- expect( schema.isRegistered( 'foo' ) ).to.be.true;
- } );
- it( 'returns false if an item was not registered', () => {
- expect( schema.isRegistered( 'foo' ) ).to.be.false;
- } );
- it( 'uses getDefinition()\'s item to definition normalization', () => {
- const stub = sinon.stub( schema, 'getDefinition' ).returns( {} );
- expect( schema.isRegistered( 'foo' ) ).to.be.true;
- expect( stub.calledOnce ).to.be.true;
- } );
- } );
- describe( 'isBlock()', () => {
- it( 'returns true if an item was registered as a block', () => {
- schema.register( 'foo', {
- isBlock: true
- } );
- expect( schema.isBlock( 'foo' ) ).to.be.true;
- } );
- it( 'returns false if an item was not registered as a block', () => {
- schema.register( 'foo' );
- expect( schema.isBlock( 'foo' ) ).to.be.false;
- } );
- it( 'returns false if an item was not registered at all', () => {
- expect( schema.isBlock( 'foo' ) ).to.be.false;
- } );
- it( 'uses getDefinition()\'s item to definition normalization', () => {
- const stub = sinon.stub( schema, 'getDefinition' ).returns( { isBlock: true } );
- expect( schema.isBlock( 'foo' ) ).to.be.true;
- expect( stub.calledOnce ).to.be.true;
- } );
- } );
- describe( 'isLimit()', () => {
- it( 'returns true if an item was registered as a limit element', () => {
- schema.register( 'foo', {
- isLimit: true
- } );
- expect( schema.isLimit( 'foo' ) ).to.be.true;
- } );
- it( 'returns true if an item was registered as an object element (because all objects are limits too)', () => {
- schema.register( 'foo', {
- isObject: true
- } );
- expect( schema.isLimit( 'foo' ) ).to.be.true;
- } );
- it( 'returns false if an item was not registered as a limit element', () => {
- schema.register( 'foo' );
- expect( schema.isLimit( 'foo' ) ).to.be.false;
- } );
- it( 'returns false if an item was not registered at all', () => {
- expect( schema.isLimit( 'foo' ) ).to.be.false;
- } );
- it( 'uses getDefinition()\'s item to definition normalization', () => {
- const stub = sinon.stub( schema, 'getDefinition' ).returns( { isLimit: true } );
- expect( schema.isLimit( 'foo' ) ).to.be.true;
- expect( stub.calledOnce ).to.be.true;
- } );
- } );
- describe( 'isObject()', () => {
- it( 'returns true if an item was registered as an object', () => {
- schema.register( 'foo', {
- isObject: true
- } );
- expect( schema.isObject( 'foo' ) ).to.be.true;
- } );
- it( 'returns false if an item was registered as a limit (because not all limits are objects)', () => {
- schema.register( 'foo', {
- isLimit: true
- } );
- expect( schema.isObject( 'foo' ) ).to.be.false;
- } );
- it( 'returns false if an item was not registered as an object', () => {
- schema.register( 'foo' );
- expect( schema.isObject( 'foo' ) ).to.be.false;
- } );
- it( 'returns false if an item was not registered at all', () => {
- expect( schema.isObject( 'foo' ) ).to.be.false;
- } );
- it( 'uses getDefinition()\'s item to definition normalization', () => {
- const stub = sinon.stub( schema, 'getDefinition' ).returns( { isObject: true } );
- expect( schema.isObject( 'foo' ) ).to.be.true;
- expect( stub.calledOnce ).to.be.true;
- } );
- } );
- describe( 'checkChild()', () => {
- beforeEach( () => {
- schema.register( '$root' );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- schema.register( '$text', {
- allowIn: 'paragraph'
- } );
- } );
- it( 'accepts an element as a context and a node name as a child', () => {
- expect( schema.checkChild( root1, 'paragraph' ) ).to.be.true;
- expect( schema.checkChild( root1, '$text' ) ).to.be.false;
- } );
- it( 'accepts a schemaContext instance as a context', () => {
- const rootContext = new SchemaContext( Position._createAt( root1, 0 ) );
- const paragraphContext = new SchemaContext( Position._createAt( r1p1, 0 ) );
- expect( schema.checkChild( rootContext, 'paragraph' ) ).to.be.true;
- expect( schema.checkChild( rootContext, '$text' ) ).to.be.false;
- expect( schema.checkChild( paragraphContext, '$text' ) ).to.be.true;
- expect( schema.checkChild( paragraphContext, 'paragraph' ) ).to.be.false;
- } );
- it( 'accepts a position as a context', () => {
- const posInRoot = Position._createAt( root1, 0 );
- const posInParagraph = Position._createAt( r1p1, 0 );
- expect( schema.checkChild( posInRoot, 'paragraph' ) ).to.be.true;
- expect( schema.checkChild( posInRoot, '$text' ) ).to.be.false;
- expect( schema.checkChild( posInParagraph, '$text' ) ).to.be.true;
- expect( schema.checkChild( posInParagraph, 'paragraph' ) ).to.be.false;
- } );
- // This is a temporary feature which is needed to make the current V->M conversion works.
- // It should be removed once V->M conversion uses real positions.
- // Of course, real positions have this advantage that we know element attributes at this point.
- it( 'accepts an array of element names as a context', () => {
- const contextInRoot = [ '$root' ];
- const contextInParagraph = [ '$root', 'paragraph' ];
- expect( schema.checkChild( contextInRoot, 'paragraph' ) ).to.be.true;
- expect( schema.checkChild( contextInRoot, '$text' ) ).to.be.false;
- expect( schema.checkChild( contextInParagraph, '$text' ) ).to.be.true;
- expect( schema.checkChild( contextInParagraph, 'paragraph' ) ).to.be.false;
- } );
- it( 'accepts an array of elements as a context', () => {
- const contextInRoot = [ root1 ];
- const contextInParagraph = [ root1, r1p1 ];
- expect( schema.checkChild( contextInRoot, 'paragraph' ) ).to.be.true;
- expect( schema.checkChild( contextInRoot, '$text' ) ).to.be.false;
- expect( schema.checkChild( contextInParagraph, '$text' ) ).to.be.true;
- expect( schema.checkChild( contextInParagraph, 'paragraph' ) ).to.be.false;
- } );
- // Again, this is needed temporarily to handle current V->M conversion
- it( 'accepts a mixed array of elements and strings as a context', () => {
- const contextInParagraph = [ '$root', r1p1 ];
- expect( schema.checkChild( contextInParagraph, '$text' ) ).to.be.true;
- expect( schema.checkChild( contextInParagraph, 'paragraph' ) ).to.be.false;
- } );
- it( 'accepts a node as a child', () => {
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- expect( schema.checkChild( root1, new Text( 'foo' ) ) ).to.be.false;
- } );
- it( 'fires the checkChild event with already normalized params', done => {
- schema.on( 'checkChild', ( evt, [ ctx, child ] ) => {
- expect( ctx ).to.be.instanceof( SchemaContext );
- expect( child ).to.equal( schema.getDefinition( 'paragraph' ) );
- done();
- }, { priority: 'highest' } );
- schema.checkChild( root1, r1p1 );
- } );
- } );
- describe( 'checkAttribute()', () => {
- beforeEach( () => {
- schema.register( 'paragraph', {
- allowAttributes: 'align'
- } );
- schema.register( '$text', {
- allowAttributes: 'bold'
- } );
- } );
- it( 'accepts an element as a context', () => {
- expect( schema.checkAttribute( r1p1, 'align' ) ).to.be.true;
- expect( schema.checkAttribute( r1p1, 'bold' ) ).to.be.false;
- } );
- it( 'accepts a text as a context', () => {
- expect( schema.checkAttribute( new Text( 'foo' ), 'bold' ) ).to.be.true;
- expect( schema.checkAttribute( new Text( 'foo' ), 'align' ) ).to.be.false;
- } );
- it( 'accepts a position as a context', () => {
- const posInRoot = Position._createAt( root1, 0 );
- const posInParagraph = Position._createAt( r1p1, 0 );
- expect( schema.checkAttribute( posInRoot, 'align' ) ).to.be.false;
- expect( schema.checkAttribute( posInParagraph, 'align' ) ).to.be.true;
- } );
- it( 'accepts a schemaContext instance as a context', () => {
- const rootContext = new SchemaContext( Position._createAt( root1, 0 ) );
- const paragraphContext = new SchemaContext( Position._createAt( r1p1, 0 ) );
- expect( schema.checkAttribute( rootContext, 'align' ) ).to.be.false;
- expect( schema.checkAttribute( paragraphContext, 'align' ) ).to.be.true;
- } );
- it( 'accepts an array of node names as a context', () => {
- const contextInRoot = [ '$root' ];
- const contextInParagraph = [ '$root', 'paragraph' ];
- const contextInText = [ '$root', 'paragraph', '$text' ];
- expect( schema.checkAttribute( contextInRoot, 'align' ) ).to.be.false;
- expect( schema.checkAttribute( contextInParagraph, 'align' ) ).to.be.true;
- expect( schema.checkAttribute( contextInText, 'bold' ) ).to.be.true;
- } );
- it( 'accepts an array of nodes as a context', () => {
- const contextInRoot = [ root1 ];
- const contextInParagraph = [ root1, r1p1 ];
- const contextInText = [ root1, r1p1, r1p1.getChild( 0 ) ];
- expect( schema.checkAttribute( contextInRoot, 'align' ) ).to.be.false;
- expect( schema.checkAttribute( contextInParagraph, 'align' ) ).to.be.true;
- expect( schema.checkAttribute( contextInText, 'bold' ) ).to.be.true;
- } );
- it( 'fires the checkAttribute event with already normalized context', done => {
- schema.on( 'checkAttribute', ( evt, [ ctx, attributeName ] ) => {
- expect( ctx ).to.be.instanceof( SchemaContext );
- expect( attributeName ).to.equal( 'bold' );
- done();
- }, { priority: 'highest' } );
- schema.checkAttribute( r1p1, 'bold' );
- } );
- } );
- describe( 'addChildCheck()', () => {
- beforeEach( () => {
- schema.register( '$root' );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- } );
- it( 'adds a high-priority listener', () => {
- const order = [];
- schema.on( 'checkChild', () => {
- order.push( 'checkChild:high-before' );
- }, { priority: 'high' } );
- schema.addChildCheck( () => {
- order.push( 'addChildCheck' );
- } );
- schema.on( 'checkChild', () => {
- order.push( 'checkChild:high-after' );
- }, { priority: 'high' } );
- schema.checkChild( root1, r1p1 );
- expect( order.join() ).to.equal( 'checkChild:high-before,addChildCheck,checkChild:high-after' );
- } );
- it( 'stops the event and overrides the return value when callback returned true', () => {
- schema.register( '$text' );
- expect( schema.checkChild( root1, '$text' ) ).to.be.false;
- schema.addChildCheck( () => {
- return true;
- } );
- schema.on( 'checkChild', () => {
- throw new Error( 'the event should be stopped' );
- }, { priority: 'high' } );
- expect( schema.checkChild( root1, '$text' ) ).to.be.true;
- } );
- it( 'stops the event and overrides the return value when callback returned false', () => {
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- schema.addChildCheck( () => {
- return false;
- } );
- schema.on( 'checkChild', () => {
- throw new Error( 'the event should be stopped' );
- }, { priority: 'high' } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.false;
- } );
- it( 'receives context and child definition as params', () => {
- schema.addChildCheck( ( ctx, childDef ) => {
- expect( ctx ).to.be.instanceOf( SchemaContext );
- expect( childDef ).to.equal( schema.getDefinition( 'paragraph' ) );
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- } );
- it( 'is not called when checking a non-registered element', () => {
- expect( schema.getDefinition( 'foo' ) ).to.be.undefined;
- schema.addChildCheck( () => {
- throw new Error( 'callback should not be called' );
- } );
- expect( schema.checkChild( root1, 'foo' ) ).to.be.false;
- } );
- } );
- describe( 'addAttributeCheck()', () => {
- beforeEach( () => {
- schema.register( 'paragraph', {
- allowAttributes: 'foo'
- } );
- } );
- it( 'adds a high-priority listener', () => {
- const order = [];
- schema.on( 'checkAttribute', () => {
- order.push( 'checkAttribute:high-before' );
- }, { priority: 'high' } );
- schema.addAttributeCheck( () => {
- order.push( 'addAttributeCheck' );
- } );
- schema.on( 'checkAttribute', () => {
- order.push( 'checkAttribute:high-after' );
- }, { priority: 'high' } );
- schema.checkAttribute( r1p1, 'foo' );
- expect( order.join() ).to.equal( 'checkAttribute:high-before,addAttributeCheck,checkAttribute:high-after' );
- } );
- it( 'stops the event and overrides the return value when callback returned true', () => {
- expect( schema.checkAttribute( r1p1, 'bar' ) ).to.be.false;
- schema.addAttributeCheck( () => {
- return true;
- } );
- schema.on( 'checkAttribute', () => {
- throw new Error( 'the event should be stopped' );
- }, { priority: 'high' } );
- expect( schema.checkAttribute( r1p1, 'bar' ) ).to.be.true;
- } );
- it( 'stops the event and overrides the return value when callback returned false', () => {
- expect( schema.checkAttribute( r1p1, 'foo' ) ).to.be.true;
- schema.addAttributeCheck( () => {
- return false;
- } );
- schema.on( 'checkAttribute', () => {
- throw new Error( 'the event should be stopped' );
- }, { priority: 'high' } );
- expect( schema.checkAttribute( r1p1, 'foo' ) ).to.be.false;
- } );
- it( 'receives context and attribute name as params', () => {
- schema.addAttributeCheck( ( ctx, attributeName ) => {
- expect( ctx ).to.be.instanceOf( SchemaContext );
- expect( attributeName ).to.equal( 'foo' );
- } );
- expect( schema.checkAttribute( r1p1, 'foo' ) ).to.be.true;
- } );
- } );
- describe( 'checkMerge()', () => {
- beforeEach( () => {
- schema.register( '$root' );
- schema.register( '$block', {
- allowIn: '$root',
- isBlock: true
- } );
- schema.register( '$text', {
- allowIn: '$block'
- } );
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- schema.register( 'listItem', {
- inheritAllFrom: '$block'
- } );
- schema.register( 'blockQuote', {
- allowWhere: '$block',
- allowContentOf: '$root'
- } );
- } );
- it( 'returns false if a block cannot be merged with other block (disallowed element is the first child)', () => {
- const paragraph = new Element( 'paragraph', null, [
- new Text( 'xyz' )
- ] );
- const blockQuote = new Element( 'blockQuote', null, [ paragraph ] );
- const listItem = new Element( 'listItem' );
- expect( schema.checkMerge( listItem, blockQuote ) ).to.be.false;
- } );
- it( 'returns false if a block cannot be merged with other block (disallowed element is not the first child)', () => {
- const paragraph = new Element( 'paragraph', null, [
- new Text( 'foo' )
- ] );
- const blockQuote = new Element( 'blockQuote', null, [
- new Text( 'bar', { bold: true } ),
- new Text( 'xyz' ),
- paragraph
- ] );
- const listItem = new Element( 'listItem' );
- expect( schema.checkMerge( listItem, blockQuote ) ).to.be.false;
- } );
- it( 'returns true if a block can be merged with other block', () => {
- const listItem = new Element( 'listItem' );
- const listItemToMerge = new Element( 'listItem', null, [
- new Text( 'xyz' )
- ] );
- expect( schema.checkMerge( listItem, listItemToMerge ) ).to.be.true;
- } );
- it( 'return true if two elements between the position can be merged', () => {
- const listItem = new Element( 'listItem', null, [
- new Text( 'foo' )
- ] );
- const listItemToMerge = new Element( 'listItem', null, [
- new Text( 'bar' )
- ] );
- // eslint-disable-next-line no-new
- new Element( '$root', null, [
- listItem, listItemToMerge
- ] );
- const position = Position._createAfter( listItem );
- expect( schema.checkMerge( position ) ).to.be.true;
- } );
- it( 'throws an error if there is no element before the position', () => {
- const listItem = new Element( 'listItem', null, [
- new Text( 'foo' )
- ] );
- // eslint-disable-next-line no-new
- new Element( '$root', null, [
- listItem
- ] );
- const position = Position._createBefore( listItem );
- expect( () => {
- expect( schema.checkMerge( position ) );
- } ).to.throw( CKEditorError, /^schema-check-merge-no-element-before:/ );
- } );
- it( 'throws an error if the node before the position is not the element', () => {
- const listItem = new Element( 'listItem', null, [
- new Text( 'foo' )
- ] );
- // eslint-disable-next-line no-new
- new Element( '$root', null, [
- new Text( 'bar' ),
- listItem
- ] );
- const position = Position._createBefore( listItem );
- expect( () => {
- expect( schema.checkMerge( position ) );
- } ).to.throw( CKEditorError, /^schema-check-merge-no-element-before:/ );
- } );
- it( 'throws an error if there is no element after the position', () => {
- const listItem = new Element( 'listItem', null, [
- new Text( 'foo' )
- ] );
- // eslint-disable-next-line no-new
- new Element( '$root', null, [
- listItem
- ] );
- const position = Position._createAfter( listItem );
- expect( () => {
- expect( schema.checkMerge( position ) );
- } ).to.throw( CKEditorError, /^schema-check-merge-no-element-after:/ );
- } );
- it( 'throws an error if the node after the position is not the element', () => {
- const listItem = new Element( 'listItem', null, [
- new Text( 'foo' )
- ] );
- // eslint-disable-next-line no-new
- new Element( '$root', null, [
- listItem,
- new Text( 'bar' )
- ] );
- const position = Position._createBefore( listItem );
- expect( () => {
- expect( schema.checkMerge( position ) );
- } ).to.throw( CKEditorError, /^schema-check-merge-no-element-before:/ );
- } );
- // This is an invalid case by definition – the baseElement should not contain disallowed elements
- // in the first place. However, the check is focused on the elementToMerge's children so let's make sure
- // that only them counts.
- it( 'returns true if element to merge contains a valid content but base element contains disallowed elements', () => {
- const listItem = new Element( 'listItem', null, [
- new Text( 'foo' ),
- new Element( 'paragraph', null, [
- new Text( 'bar' )
- ] )
- ] );
- const listItemToMerge = new Element( 'listItem', null, [
- new Text( 'xyz' )
- ] );
- expect( schema.checkMerge( listItem, listItemToMerge ) ).to.be.true;
- } );
- // The checkMerge() method should also check whether all ancestors of elementToMerge are allowed in their new
- // context (now, we check only immediate children), but for now we ignore these cases.
- } );
- describe( 'getLimitElement()', () => {
- let model, doc, root;
- beforeEach( () => {
- model = new Model();
- doc = model.document;
- schema = model.schema;
- root = doc.createRoot();
- schema.register( 'div', {
- inheritAllFrom: '$block'
- } );
- schema.register( 'article', {
- inheritAllFrom: '$block',
- allowIn: 'section'
- } );
- schema.register( 'section', {
- inheritAllFrom: '$block',
- allowIn: 'div'
- } );
- schema.register( 'paragraph', {
- inheritAllFrom: '$block',
- allowIn: 'article'
- } );
- schema.register( 'widget', {
- inheritAllFrom: '$block',
- allowIn: 'div'
- } );
- schema.register( 'image', {
- inheritAllFrom: '$block',
- allowIn: 'widget'
- } );
- schema.register( 'caption', {
- inheritAllFrom: '$block',
- allowIn: 'image'
- } );
- } );
- it( 'always returns $root element if any other limit was not defined', () => {
- schema.extend( '$root', {
- isLimit: false
- } );
- expect( schema.isLimit( '$root' ) ).to.be.false;
- setData( model, '<div><section><article><paragraph>foo[]bar</paragraph></article></section></div>' );
- expect( schema.getLimitElement( doc.selection ) ).to.equal( root );
- } );
- it( 'returns the limit element which is the closest element to common ancestor for collapsed selection', () => {
- schema.extend( 'article', { isLimit: true } );
- schema.extend( 'section', { isLimit: true } );
- setData( model, '<div><section><article><paragraph>foo[]bar</paragraph></article></section></div>' );
- const article = root.getNodeByPath( [ 0, 0, 0 ] );
- expect( schema.getLimitElement( doc.selection ) ).to.equal( article );
- } );
- it( 'returns the limit element which is the closest element to common ancestor for non-collapsed selection', () => {
- schema.extend( 'article', { isLimit: true } );
- schema.extend( 'section', { isLimit: true } );
- model.enqueueChange( 'transparent', () => {
- setData( model, '<div><section><article>[foo</article><article>bar]</article></section></div>' );
- const section = root.getNodeByPath( [ 0, 0 ] );
- expect( schema.getLimitElement( doc.selection ) ).to.equal( section );
- } );
- } );
- it( 'works fine with multi-range selections', () => {
- schema.extend( 'article', { isLimit: true } );
- schema.extend( 'widget', { isLimit: true } );
- schema.extend( 'div', { isLimit: true } );
- setData(
- model,
- '<div>' +
- '<section>' +
- '<article>' +
- '<paragraph>[foo]</paragraph>' +
- '</article>' +
- '</section>' +
- '<widget>' +
- '<image>' +
- '<caption>b[a]r</caption>' +
- '</image>' +
- '</widget>' +
- '</div>'
- );
- const div = root.getNodeByPath( [ 0 ] );
- expect( schema.getLimitElement( doc.selection ) ).to.equal( div );
- } );
- it( 'works fine with multi-range selections even if limit elements are not defined', () => {
- setData(
- model,
- '<div>' +
- '<section>' +
- '<article>' +
- '<paragraph>[foo]</paragraph>' +
- '</article>' +
- '</section>' +
- '</div>' +
- '<section>b[]ar</section>'
- );
- expect( schema.getLimitElement( doc.selection ) ).to.equal( root );
- } );
- it( 'works fine with multi-range selections if the first range has the root element as a limit element', () => {
- setData(
- model,
- '<image>' +
- '<caption>[Foo</caption>' +
- '</image>' +
- '<article>' +
- '<paragraph>Paragraph in article]</paragraph>' +
- '</article>' +
- '<paragraph>Paragraph item 1</paragraph>' +
- '<paragraph>Paragraph [item 2]</paragraph>'
- );
- expect( schema.getLimitElement( doc.selection ) ).to.equal( root );
- } );
- it( 'works fine with multi-range selections if the last range has the root element as a limit element', () => {
- setData(
- model,
- '<paragraph>Paragraph item 1</paragraph>' +
- '<paragraph>Paragraph [item 2]</paragraph>' +
- '<image>' +
- '<caption>[Foo</caption>' +
- '</image>' +
- '<article>' +
- '<paragraph>Paragraph in article]</paragraph>' +
- '</article>'
- );
- expect( schema.getLimitElement( doc.selection ) ).to.equal( root );
- } );
- it( 'accepts range as an argument', () => {
- schema.extend( 'article', { isLimit: true } );
- schema.extend( 'section', { isLimit: true } );
- const data = '<div><section><article><paragraph>foobar</paragraph></article></section></div>';
- const parsedModel = parse( data, model.schema, { context: [ root.name ] } );
- model.change( writer => {
- writer.insert( parsedModel, root );
- } );
- const article = root.getNodeByPath( [ 0, 0, 0 ] );
- expect( schema.getLimitElement( new Range( new Position( root, [ 0, 0, 0, 0, 2 ] ) ) ) ).to.equal( article );
- } );
- it( 'accepts position as an argument', () => {
- schema.extend( 'article', { isLimit: true } );
- schema.extend( 'section', { isLimit: true } );
- const data = '<div><section><article><paragraph>foobar</paragraph></article></section></div>';
- const parsedModel = parse( data, model.schema, { context: [ root.name ] } );
- model.change( writer => {
- writer.insert( parsedModel, root );
- } );
- const article = root.getNodeByPath( [ 0, 0, 0 ] );
- expect( schema.getLimitElement( new Position( root, [ 0, 0, 0, 0, 2 ] ) ) ).to.equal( article );
- } );
- } );
- describe( 'checkAttributeInSelection()', () => {
- const attribute = 'bold';
- let model, doc, schema;
- beforeEach( () => {
- model = new Model();
- doc = model.document;
- doc.createRoot();
- schema = model.schema;
- schema.register( 'p', { inheritAllFrom: '$block' } );
- schema.register( 'h1', { inheritAllFrom: '$block' } );
- schema.register( 'img', { allowWhere: '$text' } );
- schema.register( 'figure', {
- allowIn: '$root',
- allowAttributes: [ 'name', 'title' ]
- } );
- schema.extend( '$text', {
- allowAttributes: [ 'italic' ]
- } );
- schema.addAttributeCheck( ( ctx, attributeName ) => {
- // Allow 'bold' on p>$text.
- if ( ctx.endsWith( 'p $text' ) && attributeName == 'bold' ) {
- return true;
- }
- // Allow 'bold' on $root>p.
- if ( ctx.endsWith( '$root p' ) && attributeName == 'bold' ) {
- return true;
- }
- // Disallow 'italic' on $text that has 'bold' already.
- if ( inTextWithBold( ctx ) && attributeName == 'italic' ) {
- return false;
- }
- function inTextWithBold( context ) {
- return context.endsWith( '$text' ) && context.last.getAttribute( 'bold' );
- }
- } );
- } );
- describe( 'when selection is collapsed', () => {
- it( 'should return true if characters with the attribute can be placed at caret position', () => {
- setData( model, '<p>f[]oo</p>' );
- expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true;
- } );
- it( 'should return false if characters with the attribute cannot be placed at caret position', () => {
- setData( model, '<h1>[]</h1>' );
- expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.false;
- setData( model, '[]' );
- expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.false;
- } );
- it( 'should check attributes of the selection (selection inside the $text[bold])', () => {
- setData( model, '<p><$text bold="true">f[]oo</$text></p>' );
- expect( schema.checkAttributeInSelection( doc.selection, 'italic' ) ).to.be.false;
- model.change( writer => {
- writer.removeSelectionAttribute( 'bold' );
- } );
- expect( schema.checkAttributeInSelection( doc.selection, 'italic' ) ).to.be.true;
- } );
- it( 'should check attributes of the selection (attribute set manually on selection)', () => {
- setData( model, '<p>foo[]bar</p>' );
- expect( schema.checkAttributeInSelection( doc.selection, 'italic' ) ).to.be.true;
- model.change( writer => {
- writer.setSelectionAttribute( 'bold', true );
- } );
- expect( schema.checkAttributeInSelection( doc.selection, 'italic' ) ).to.be.false;
- } );
- it( 'should pass all selection\'s attributes to checkAttribute()', done => {
- schema.on( 'checkAttribute', ( evt, args ) => {
- const context = args[ 0 ];
- const attributeName = args[ 1 ];
- expect( attributeName ).to.equal( 'italic' );
- expect( Array.from( context.last.getAttributeKeys() ) ).to.deep.equal( [ 'bold', 'underline' ] );
- done();
- }, { priority: 'highest' } );
- setData( model, '<p>foo[]bar</p>' );
- model.change( writer => {
- writer.setSelectionAttribute( 'bold', true );
- writer.setSelectionAttribute( 'underline', true );
- } );
- expect( schema.checkAttributeInSelection( doc.selection, 'italic' ) ).to.be.false;
- } );
- } );
- describe( 'when selection is not collapsed', () => {
- it( 'should return true if there is at least one node in selection that can have the attribute', () => {
- // Simple selection on a few characters.
- setData( model, '<p>[foo]</p>' );
- expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true;
- // Selection spans over characters but also include nodes that can't have attribute.
- setData( model, '<p>fo[o<img />b]ar</p>' );
- expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true;
- // Selection on whole root content. Characters in P can have an attribute so it's valid.
- setData( model, '[<p>foo<img />bar</p><h1></h1>]' );
- expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true;
- // Selection on empty P. P can have the attribute.
- setData( model, '[<p></p>]' );
- expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true;
- } );
- it( 'should return false if there are no nodes in selection that can have the attribute', () => {
- // Selection on DIV which can't have bold text.
- setData( model, '[<h1></h1>]' );
- expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.false;
- // Selection on two images which can't be bold.
- setData( model, '<p>foo[<img /><img />]bar</p>' );
- expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.false;
- } );
- it( 'should return true when checking element with required attribute', () => {
- setData( model, '[<figure name="figure"></figure>]' );
- expect( schema.checkAttributeInSelection( doc.selection, 'title' ) ).to.be.true;
- } );
- it( 'should return true when checking element when attribute is already present', () => {
- setData( model, '[<figure name="figure" title="title"></figure>]' );
- expect( schema.checkAttributeInSelection( doc.selection, 'title' ) ).to.be.true;
- } );
- it( 'should check attributes of text', () => {
- setData( model, '<p><$text bold="true">f[o]o</$text></p>' );
- expect( schema.checkAttributeInSelection( doc.selection, 'italic' ) ).to.be.false;
- } );
- } );
- } );
- describe( 'getValidRanges()', () => {
- let model, doc, root, schema;
- beforeEach( () => {
- model = new Model();
- doc = model.document;
- schema = model.schema;
- root = doc.createRoot();
- schema.register( 'p', { inheritAllFrom: '$block' } );
- schema.register( 'img', { allowWhere: '$text' } );
- // This is a "hack" to allow setting any ranges in `setData` util.
- schema.extend( '$text', { allowIn: '$root' } );
- } );
- function testValidRangesForAttribute( input, attribute, output ) {
- setData( model, input );
- const validRanges = schema.getValidRanges( doc.selection.getRanges(), attribute );
- const sel = model.createSelection( validRanges );
- expect( stringify( root, sel ) ).to.equal( output );
- }
- it( 'should return a range with p for an attribute allowed only on p', () => {
- schema.extend( 'p', { allowAttributes: 'foo' } );
- testValidRangesForAttribute(
- '[<p>foo<img></img>bar</p>]',
- 'foo',
- '[<p>foo<img></img>bar</p>]'
- );
- } );
- it( 'should return ranges on text nodes for an attribute allowed only on text', () => {
- schema.extend( '$text', { allowAttributes: 'bold' } );
- testValidRangesForAttribute(
- '[<p>foo<img></img>bar</p>]',
- 'bold',
- '<p>[foo]<img></img>[bar]</p>'
- );
- } );
- it( 'should return a range on img for an attribute allowed only on img', () => {
- schema.extend( 'img', { allowAttributes: 'src' } );
- testValidRangesForAttribute(
- '[<p>foo<img></img>bar</p>]',
- 'src',
- '<p>foo[<img></img>]bar</p>'
- );
- } );
- it( 'should return a range containing all children for an attribute allowed on all children', () => {
- schema.extend( '$text', { allowAttributes: 'bold' } );
- schema.extend( 'img', { allowAttributes: 'bold' } );
- testValidRangesForAttribute(
- '[<p>foo<img></img>bar</p>]',
- 'bold',
- '<p>[foo<img></img>bar]</p>'
- );
- } );
- it( 'should return a range with p and a range on all children for an attribute allowed on p and its children', () => {
- schema.extend( 'p', { allowAttributes: 'foo' } );
- schema.extend( '$text', { allowAttributes: 'foo' } );
- schema.extend( 'img', { allowAttributes: 'foo' } );
- setData( model, '[<p>foo<img></img>bar</p>]' );
- const validRanges = Array.from( schema.getValidRanges( doc.selection.getRanges(), 'foo' ) );
- expect( validRanges.length ).to.equal( 2 );
- expect( validRanges[ 0 ].start.path ).to.deep.equal( [ 0, 0 ] );
- expect( validRanges[ 0 ].end.path ).to.deep.equal( [ 0, 7 ] );
- expect( validRanges[ 1 ].start.path ).to.deep.equal( [ 0 ] );
- expect( validRanges[ 1 ].end.path ).to.deep.equal( [ 1 ] );
- } );
- it( 'should not break a range if children are not allowed to have the attribute', () => {
- schema.extend( 'p', { allowAttributes: 'foo' } );
- testValidRangesForAttribute(
- '[<p>foo</p><p>bar</p>]',
- 'foo',
- '[<p>foo</p><p>bar</p>]'
- );
- } );
- it( 'should search deeply', () => {
- schema.extend( '$text', { allowAttributes: 'bold', allowIn: 'img' } );
- testValidRangesForAttribute(
- '[<p>foo<img>xxx</img>bar</p>]',
- 'bold',
- '<p>[foo]<img>[xxx]</img>[bar]</p>'
- );
- } );
- it( 'should work with multiple ranges', () => {
- schema.extend( '$text', { allowAttributes: 'bold' } );
- testValidRangesForAttribute(
- '[<p>a</p><p>b</p>]<p>c</p><p>[d]</p>',
- 'bold',
- '<p>[a]</p><p>[b]</p><p>c</p><p>[d]</p>'
- );
- } );
- it( 'should work with non-flat ranges', () => {
- schema.extend( '$text', { allowAttributes: 'bold' } );
- testValidRangesForAttribute(
- '[<p>a</p><p>b</p><p>c]</p><p>d</p>',
- 'bold',
- '<p>[a]</p><p>[b]</p><p>[c]</p><p>d</p>'
- );
- } );
- it( 'should not leak beyond the given ranges', () => {
- schema.extend( '$text', { allowAttributes: 'bold' } );
- testValidRangesForAttribute(
- '[<p>foo</p><p>b]a[r</p><p>x]yz</p>',
- 'bold',
- '<p>[foo]</p><p>[b]a[r]</p><p>[x]yz</p>'
- );
- } );
- it( 'should correctly handle a range which ends in a disallowed position', () => {
- schema.extend( '$text', { allowAttributes: 'bold', allowIn: 'img' } );
- // Disallow bold on text inside image.
- schema.addAttributeCheck( ( ctx, attributeName ) => {
- if ( ctx.endsWith( 'img $text' ) && attributeName == 'bold' ) {
- return false;
- }
- } );
- testValidRangesForAttribute(
- '[<p>foo<img>xx]x</img>bar</p>',
- 'bold',
- '<p>[foo]<img>xxx</img>bar</p>'
- );
- } );
- } );
- describe( 'getNearestSelectionRange()', () => {
- let selection, model, doc;
- beforeEach( () => {
- model = new Model();
- doc = model.document;
- schema = model.schema;
- model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
- model.schema.register( 'emptyBlock', { allowIn: '$root' } );
- model.schema.register( 'widget', {
- allowIn: '$root',
- isObject: true
- } );
- model.schema.register( 'blockWidget', {
- allowIn: '$root',
- allowContentOf: '$block',
- isObject: true
- } );
- doc.createRoot();
- selection = doc.selection;
- } );
- test(
- 'should return collapsed range if text node can be placed at that position - both',
- '<paragraph>[]</paragraph>',
- 'both',
- '<paragraph>[]</paragraph>'
- );
- test(
- 'should return collapsed range if text node can be placed at that position - forward',
- '<paragraph>[]</paragraph>',
- 'forward',
- '<paragraph>[]</paragraph>'
- );
- test(
- 'should return collapsed range if text node can be placed at that position - backward',
- '<paragraph>[]</paragraph>',
- 'backward',
- '<paragraph>[]</paragraph>'
- );
- test( 'should return null in empty document - both', '', 'both', null );
- test( 'should return null in empty document - backward', '', 'backward', null );
- test( 'should return null in empty document - forward', '', 'forward', null );
- test(
- 'should find range before when searching both ways',
- '<paragraph></paragraph>[]<paragraph></paragraph>',
- 'both',
- '<paragraph>[]</paragraph><paragraph></paragraph>'
- );
- test(
- 'should find range before when searching backward',
- '<paragraph></paragraph>[]<paragraph></paragraph>',
- 'backward',
- '<paragraph>[]</paragraph><paragraph></paragraph>'
- );
- test(
- 'should find range after when searching forward',
- '<paragraph></paragraph>[]<paragraph></paragraph>',
- 'forward',
- '<paragraph></paragraph><paragraph>[]</paragraph>'
- );
- test(
- 'should find range after when searching both ways when it is closer',
- '<paragraph></paragraph><emptyBlock></emptyBlock>[]<paragraph></paragraph>',
- 'both',
- '<paragraph></paragraph><emptyBlock></emptyBlock><paragraph>[]</paragraph>'
- );
- test(
- 'should find range before when searching both ways when it is closer',
- '<paragraph></paragraph><emptyBlock></emptyBlock>[]<emptyBlock></emptyBlock><emptyBlock></emptyBlock><paragraph></paragraph>',
- 'both',
- '<paragraph>[]</paragraph><emptyBlock></emptyBlock><emptyBlock></emptyBlock><emptyBlock></emptyBlock><paragraph></paragraph>'
- );
- test(
- 'should return null if there is no valid range',
- '[]<emptyBlock></emptyBlock>',
- 'both',
- null
- );
- test(
- 'should return null if there is no valid range in given direction - backward',
- '[]<paragraph></paragraph>',
- 'backward',
- null
- );
- test(
- 'should return null if there is no valid range in given direction - forward',
- '<paragraph></paragraph>[]',
- 'forward',
- null
- );
- test(
- 'should move forward when placed at root start',
- '[]<paragraph></paragraph><paragraph></paragraph>',
- 'both',
- '<paragraph>[]</paragraph><paragraph></paragraph>'
- );
- test(
- 'should move backward when placed at root end',
- '<paragraph></paragraph><paragraph></paragraph>[]',
- 'both',
- '<paragraph></paragraph><paragraph>[]</paragraph>'
- );
- describe( 'in case of objects which do not allow text inside', () => {
- test(
- 'should select nearest object (o[]o) - both',
- '<widget></widget>[]<widget></widget>',
- 'both',
- '[<widget></widget>]<widget></widget>'
- );
- test(
- 'should select nearest object (o[]o) - forward',
- '<widget></widget>[]<widget></widget>',
- 'forward',
- '<widget></widget>[<widget></widget>]'
- );
- test(
- 'should select nearest object (o[]o) - backward',
- '<widget></widget>[]<widget></widget>',
- 'both',
- '[<widget></widget>]<widget></widget>'
- );
- test(
- 'should select nearest object (p[]o) - forward',
- '<paragraph></paragraph>[]<widget></widget>',
- 'forward',
- '<paragraph></paragraph>[<widget></widget>]'
- );
- test(
- 'should select nearest object (o[]p) - both',
- '<widget></widget>[]<paragraph></paragraph>',
- 'both',
- '[<widget></widget>]<paragraph></paragraph>'
- );
- test(
- 'should select nearest object (o[]p) - backward',
- '<widget></widget>[]<paragraph></paragraph>',
- 'backward',
- '[<widget></widget>]<paragraph></paragraph>'
- );
- test(
- 'should select nearest object ([]o) - both',
- '[]<widget></widget><paragraph></paragraph>',
- 'both',
- '[<widget></widget>]<paragraph></paragraph>'
- );
- test(
- 'should select nearest object ([]o) - forward',
- '[]<widget></widget><paragraph></paragraph>',
- 'forward',
- '[<widget></widget>]<paragraph></paragraph>'
- );
- test(
- 'should select nearest object (o[]) - both',
- '<paragraph></paragraph><widget></widget>[]',
- 'both',
- '<paragraph></paragraph>[<widget></widget>]'
- );
- test(
- 'should select nearest object (o[]) - backward',
- '<paragraph></paragraph><widget></widget>[]',
- 'both',
- '<paragraph></paragraph>[<widget></widget>]'
- );
- } );
- describe( 'in case of objects which allow text inside', () => {
- test(
- 'should select nearest object which allows text (o[]o) - both',
- '<blockWidget></blockWidget>[]<blockWidget></blockWidget>',
- 'both',
- '[<blockWidget></blockWidget>]<blockWidget></blockWidget>'
- );
- test(
- 'should select nearest object (o[]p) - both',
- '<blockWidget></blockWidget>[]<paragraph></paragraph>',
- 'both',
- '[<blockWidget></blockWidget>]<paragraph></paragraph>'
- );
- test(
- 'should select nearest object which allows text ([]o) - both',
- '[]<blockWidget></blockWidget><paragraph></paragraph>',
- 'both',
- '[<blockWidget></blockWidget>]<paragraph></paragraph>'
- );
- } );
- function test( testName, data, direction, expected ) {
- it( testName, () => {
- let range;
- model.enqueueChange( 'transparent', () => {
- setData( model, data );
- range = schema.getNearestSelectionRange( selection.anchor, direction );
- } );
- if ( expected === null ) {
- expect( range ).to.be.null;
- } else {
- model.change( writer => {
- writer.setSelection( range );
- } );
- expect( getData( model ) ).to.equal( expected );
- }
- } );
- }
- } );
- describe( 'findAllowedParent()', () => {
- beforeEach( () => {
- schema.register( '$root' );
- schema.register( 'blockQuote', {
- allowIn: '$root'
- } );
- schema.register( 'paragraph', {
- allowIn: 'blockQuote'
- } );
- schema.register( '$text', {
- allowIn: 'paragraph'
- } );
- } );
- it( 'should return position ancestor that allows to insert given node to it', () => {
- const node = new Element( 'paragraph' );
- const allowedParent = schema.findAllowedParent( node, Position._createAt( r1bQp, 0 ) );
- expect( allowedParent ).to.equal( r1bQ );
- } );
- it( 'should return position ancestor that allows to insert given node to it - works with a string too', () => {
- const allowedParent = schema.findAllowedParent( 'paragraph', Position._createAt( r1bQp, 0 ) );
- expect( allowedParent ).to.equal( r1bQ );
- } );
- it( 'should return position ancestor that allows to insert given node to it when position is already i such an element', () => {
- const node = new Text( 'text' );
- const parent = schema.findAllowedParent( node, Position._createAt( r1bQp, 0 ) );
- expect( parent ).to.equal( r1bQp );
- } );
- it( 'should return null when limit element is reached before allowed parent', () => {
- schema.extend( 'blockQuote', {
- isLimit: true
- } );
- schema.register( 'div', {
- allowIn: '$root'
- } );
- const node = new Element( 'div' );
- const parent = schema.findAllowedParent( node, Position._createAt( r1bQp, 0 ) );
- expect( parent ).to.null;
- } );
- it( 'should return null when object element is reached before allowed parent', () => {
- schema.extend( 'blockQuote', {
- isObject: true
- } );
- schema.register( 'div', {
- allowIn: '$root'
- } );
- const node = new Element( 'div' );
- const parent = schema.findAllowedParent( node, Position._createAt( r1bQp, 0 ) );
- expect( parent ).to.null;
- } );
- it( 'should return null when there is no allowed ancestor for given position', () => {
- const node = new Element( 'section' );
- const parent = schema.findAllowedParent( node, Position._createAt( r1bQp, 0 ) );
- expect( parent ).to.null;
- } );
- it( 'should return null when there is no allowed ancestor for given position – works with a string too', () => {
- const parent = schema.findAllowedParent( 'section', Position._createAt( r1bQp, 0 ) );
- expect( parent ).to.null;
- } );
- } );
- describe( 'removeDisallowedAttributes()', () => {
- let model, doc, root;
- beforeEach( () => {
- model = new Model();
- doc = model.document;
- root = doc.createRoot();
- schema = model.schema;
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- schema.register( 'div', {
- inheritAllFrom: '$block'
- } );
- schema.register( 'image', {
- isObject: true
- } );
- schema.extend( '$block', {
- allowIn: 'div'
- } );
- } );
- it( 'should filter out disallowed attributes from given nodes', () => {
- schema.extend( '$text', { allowAttributes: 'a' } );
- schema.extend( 'image', { allowAttributes: 'b' } );
- const text = new Text( 'foo', { a: 1, b: 1 } );
- const image = new Element( 'image', { a: 1, b: 1 } );
- root._appendChild( [ text, image ] );
- model.change( writer => {
- schema.removeDisallowedAttributes( root.getChildren(), writer );
- expect( Array.from( text.getAttributeKeys() ) ).to.deep.equal( [ 'a' ] );
- expect( Array.from( image.getAttributeKeys() ) ).to.deep.equal( [ 'b' ] );
- expect( writer.batch.operations ).to.length( 2 );
- expect( writer.batch.operations[ 0 ] ).to.instanceof( AttributeOperation );
- expect( writer.batch.operations[ 1 ] ).to.instanceof( AttributeOperation );
- expect( getData( model, { withoutSelection: true } ) )
- .to.equal( '<$text a="1">foo</$text><image b="1"></image>' );
- } );
- } );
- it( 'should filter out disallowed attributes from all descendants of given nodes', () => {
- schema.addAttributeCheck( ( ctx, attributeName ) => {
- // Allow 'a' on div>$text.
- if ( ctx.endsWith( 'div $text' ) && attributeName == 'a' ) {
- return true;
- }
- // Allow 'b' on div>paragraph>$text.
- if ( ctx.endsWith( 'div paragraph $text' ) && attributeName == 'b' ) {
- return true;
- }
- // Allow 'a' on div>image.
- if ( ctx.endsWith( 'div image' ) && attributeName == 'a' ) {
- return true;
- }
- // Allow 'b' on div>paragraph>image.
- if ( ctx.endsWith( 'div paragraph image' ) && attributeName == 'b' ) {
- return true;
- }
- } );
- const foo = new Text( 'foo', { a: 1, b: 1 } );
- const bar = new Text( 'bar', { a: 1, b: 1 } );
- const imageInDiv = new Element( 'image', { a: 1, b: 1 } );
- const imageInParagraph = new Element( 'image', { a: 1, b: 1 } );
- const paragraph = new Element( 'paragraph', [], [ foo, imageInParagraph ] );
- const div = new Element( 'div', [], [ paragraph, bar, imageInDiv ] );
- root._appendChild( [ div ] );
- model.change( writer => {
- schema.removeDisallowedAttributes( root.getChildren(), writer );
- expect( writer.batch.operations ).to.length( 4 );
- expect( writer.batch.operations[ 0 ] ).to.instanceof( AttributeOperation );
- expect( writer.batch.operations[ 1 ] ).to.instanceof( AttributeOperation );
- expect( writer.batch.operations[ 2 ] ).to.instanceof( AttributeOperation );
- expect( writer.batch.operations[ 3 ] ).to.instanceof( AttributeOperation );
- expect( getData( model, { withoutSelection: true } ) )
- .to.equal(
- '<div>' +
- '<paragraph>' +
- '<$text b="1">foo</$text>' +
- '<image b="1"></image>' +
- '</paragraph>' +
- '<$text a="1">bar</$text>' +
- '<image a="1"></image>' +
- '</div>'
- );
- } );
- } );
- } );
- describe( 'definitions compilation', () => {
- describe( 'allowIn cases', () => {
- it( 'passes $root>paragraph', () => {
- schema.register( '$root' );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- } );
- it( 'passes $root>paragraph and $root2>paragraph – support for array values', () => {
- schema.register( '$root' );
- schema.register( '$root2' );
- schema.register( 'paragraph', {
- allowIn: [ '$root', '$root2' ]
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- expect( schema.checkChild( root2, r1p1 ) ).to.be.true;
- } );
- it( 'passes $root>paragraph[align] – attributes does not matter', () => {
- schema.register( '$root' );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( root1, r1p2 ) ).to.be.true;
- } );
- it( 'passes $root>div>div – in case of circular refs', () => {
- schema.register( '$root' );
- schema.register( 'div', {
- allowIn: [ '$root', 'div' ]
- } );
- const div = new Element( 'div' );
- root1._appendChild( div );
- const div2 = new Element( 'div' );
- expect( schema.checkChild( div, div2 ) ).to.be.true;
- } );
- it( 'passes $root>div>div – in case of circular refs, when div1==div2', () => {
- schema.register( '$root' );
- schema.register( 'div', {
- allowIn: [ '$root', 'div' ]
- } );
- const div = new Element( 'div' );
- root1._appendChild( div );
- expect( schema.checkChild( div, div ) ).to.be.true;
- } );
- it( 'rejects $root>paragraph – non-registered paragraph', () => {
- schema.register( '$root' );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.false;
- } );
- it( 'rejects $root>paragraph – registered different item', () => {
- schema.register( '$root' );
- schema.register( 'paragraph' );
- schema.register( 'listItem', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.false;
- } );
- it( 'rejects $root>paragraph – paragraph allowed in different context', () => {
- schema.register( '$root' );
- schema.register( '$fancyRoot' );
- schema.register( 'paragraph', {
- allowIn: '$fancyRoot'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.false;
- } );
- it( 'rejects $root>blockQuote>paragraph – since paragraph is only allowed in $root', () => {
- schema.register( '$root' );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( r1bQ, r1bQp ) ).to.be.false;
- } );
- it( 'rejects $root>blockQuote>paragraph – since paragraph is only allowed in $root v2', () => {
- schema.register( '$root' );
- schema.register( 'blockQuote', {
- allowIn: '$root'
- } );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( r1bQ, r1bQp ) ).to.be.false;
- } );
- it( 'rejects $root>blockQuote>paragraph>$text - since paragraph is not allowed in blockQuote', () => {
- schema.register( '$root' );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- schema.register( '$text', {
- allowIn: 'paragraph'
- } );
- expect( schema.checkChild( root1, r1bQp.getChild( 0 ) ) ).to.be.false;
- } );
- it( 'rejects $root>blockQuote>paragraph>$text - since blockQuote is not allowed in $root', () => {
- schema.register( '$root' );
- schema.register( 'blockQuote' );
- schema.register( 'paragraph', {
- allowIn: [ 'blockQuote', '$root' ]
- } );
- schema.register( '$text', {
- allowIn: 'paragraph'
- } );
- expect( schema.checkChild( root1, r1bQp.getChild( 0 ) ) ).to.be.false;
- } );
- } );
- describe( 'allowWhere cases', () => {
- it( 'passes $root>paragraph – paragraph inherits from $block', () => {
- schema.register( '$root' );
- schema.register( '$block', {
- allowIn: '$root'
- } );
- schema.register( 'paragraph', {
- allowWhere: '$block'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- } );
- it( 'supports the array syntax', () => {
- schema.register( '$root' );
- schema.register( '$root2' );
- schema.register( '$block', {
- allowIn: '$root'
- } );
- schema.register( '$block2', {
- allowIn: '$root2'
- } );
- schema.register( 'paragraph', {
- allowWhere: [ '$block', '$block2' ]
- } );
- expect( schema.checkChild( root1, r1p1 ), '$root' ).to.be.true;
- expect( schema.checkChild( root2, r1p1 ), '$root2' ).to.be.true;
- } );
- // This checks if some inapropriate caching or preprocessing isn't applied by register().
- it( 'passes $root>paragraph – paragraph inherits from $block, order of definitions does not matter', () => {
- schema.register( '$root' );
- schema.register( 'paragraph', {
- allowWhere: '$block'
- } );
- schema.register( '$block', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- } );
- it( 'passes $root>paragraph – paragraph inherits from $specialBlock which inherits from $block', () => {
- schema.register( '$root' );
- schema.register( '$block', {
- allowIn: '$root'
- } );
- schema.register( '$specialBlock', {
- allowWhere: '$block'
- } );
- schema.register( 'paragraph', {
- allowWhere: '$specialBlock'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- } );
- it( 'rejects $root>paragraph – paragraph inherits from $block but $block is not allowed in $root', () => {
- schema.register( '$root' );
- schema.register( '$block' );
- schema.register( 'paragraph', {
- allowWhere: '$block'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.false;
- } );
- it( 'rejects $root>paragraph>$text – paragraph inherits from $block but $block is not allowed in $root', () => {
- schema.register( '$root' );
- schema.register( '$block' );
- schema.register( 'paragraph', {
- allowWhere: '$block'
- } );
- schema.register( '$text', {
- allowIn: 'paragraph'
- } );
- expect( schema.checkChild( root1, r1p1.getChild( 0 ) ) ).to.be.false;
- } );
- } );
- describe( 'allowContentOf cases', () => {
- it( 'passes $root2>paragraph – $root2 inherits from $root', () => {
- schema.register( '$root' );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- schema.register( '$root2', {
- allowContentOf: '$root'
- } );
- expect( schema.checkChild( root2, r1p1 ) ).to.be.true;
- } );
- it( 'supports the array syntax', () => {
- schema.register( '$root' );
- schema.register( '$root2' );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- schema.register( 'heading1', {
- allowIn: '$root2'
- } );
- schema.register( '$root3', {
- allowContentOf: [ '$root', '$root2' ]
- } );
- const root3 = new Element( '$root3' );
- const heading1 = new Element( 'heading1' );
- expect( schema.checkChild( root3, r1p1 ), 'paragraph' ).to.be.true;
- expect( schema.checkChild( root3, heading1 ), 'heading1' ).to.be.true;
- } );
- it( 'passes $root2>paragraph – $root2 inherits from $root, order of definitions does not matter', () => {
- schema.register( '$root' );
- schema.register( '$root2', {
- allowContentOf: '$root'
- } );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( root2, r1p1 ) ).to.be.true;
- } );
- it( 'passes $root>paragraph>$text – paragraph inherits content of $block', () => {
- schema.register( '$root' );
- schema.register( '$block' );
- schema.register( 'paragraph', {
- allowIn: '$root',
- allowContentOf: '$block'
- } );
- schema.register( '$text', {
- allowIn: '$block'
- } );
- expect( schema.checkChild( r1p1, r1p1.getChild( 0 ) ) ).to.be.true;
- } );
- it( 'passes $root>blockQuote>paragraph – blockQuote inherits content of $root', () => {
- schema.register( '$root' );
- schema.register( 'blockQuote', {
- allowIn: '$root',
- allowContentOf: '$root'
- } );
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( r1bQ, r1bQp ) ).to.be.true;
- } );
- it( 'rejects $root2>paragraph – $root2 inherits from $root, but paragraph is not allowed there anyway', () => {
- schema.register( '$root' );
- schema.register( 'paragraph' );
- schema.register( '$root2', {
- allowContentOf: '$root'
- } );
- expect( schema.checkChild( root2, r1p1 ) ).to.be.false;
- } );
- } );
- describe( 'mix of allowContentOf and allowWhere', () => {
- it( 'passes $root>paragraph>$text – paragraph inherits all from $block', () => {
- schema.register( '$root' );
- schema.register( '$block', {
- allowIn: '$root'
- } );
- schema.register( 'paragraph', {
- allowContentOf: '$block',
- allowWhere: '$block'
- } );
- schema.register( '$text', {
- allowIn: '$block'
- } );
- expect( schema.checkChild( r1p1, r1p1.getChild( 0 ) ) ).to.be.true;
- } );
- it( 'passes $root>paragraph and $root2>paragraph – where $root2 inherits content of $root' +
- 'and paragraph inherits allowWhere from $block', () => {
- schema.register( '$root' );
- schema.register( '$root2', {
- allowContentOf: '$root'
- } );
- schema.register( '$block', {
- allowIn: '$root'
- } );
- schema.register( 'paragraph', {
- allowWhere: '$block'
- } );
- expect( schema.checkChild( root1, 'paragraph' ), 'root1' ).to.be.true;
- expect( schema.checkChild( root2, 'paragraph' ), 'root2' ).to.be.true;
- } );
- it( 'passes d>a where d inherits content of c which inherits content of b', () => {
- schema.register( 'b' );
- schema.register( 'a', { allowIn: 'b' } );
- schema.register( 'c', { allowContentOf: 'b' } );
- schema.register( 'd', { allowContentOf: 'c' } );
- const d = new Element( 'd' );
- expect( schema.checkChild( d, 'a' ) ).to.be.true;
- } );
- // This case won't pass becuase we compile the definitions in a pretty naive way.
- // To make chains like this work we'd need to repeat compilation of allowContentOf definitions
- // as long as the previous iteration found something to compile.
- // This way, even though we'd not compile d<-c in the first run, we'd still find b<-c
- // and since we've found something, we'd now try d<-c which would work.
- //
- // We ignore those situations for now as they are very unlikely to happen and would
- // significantly raised the complexity of definition compilation.
- //
- // it( 'passes d>a where d inherits content of c which inherits content of b', () => {
- // schema.register( 'b' );
- // schema.register( 'a', { allowIn: 'b' } );
- // schema.register( 'd', { allowContentOf: 'c' } );
- // schema.register( 'c', { allowContentOf: 'b' } );
- //
- // const d = new Element( 'd' );
- //
- // expect( schema.checkChild( d, 'a' ) ).to.be.true;
- // } );
- } );
- describe( 'inheritTypesFrom', () => {
- it( 'inherit properties of another item', () => {
- schema.register( '$block', {
- isBlock: true,
- isLimit: true
- } );
- schema.register( 'paragraph', {
- inheritTypesFrom: '$block'
- } );
- expect( schema.getDefinition( 'paragraph' ).isBlock ).to.be.true;
- expect( schema.getDefinition( 'paragraph' ).isLimit ).to.be.true;
- } );
- it( 'inherit properties of other items – support for arrays', () => {
- schema.register( '$block', {
- isBlock: true
- } );
- schema.register( '$block2', {
- isLimit: true
- } );
- schema.register( 'paragraph', {
- inheritTypesFrom: [ '$block', '$block2' ]
- } );
- expect( schema.getDefinition( 'paragraph' ).isBlock ).to.be.true;
- expect( schema.getDefinition( 'paragraph' ).isLimit ).to.be.true;
- } );
- it( 'does not override existing props', () => {
- schema.register( '$block', {
- isBlock: true,
- isLimit: true
- } );
- schema.register( 'paragraph', {
- inheritTypesFrom: '$block',
- isLimit: false
- } );
- expect( schema.getDefinition( 'paragraph' ).isBlock ).to.be.true;
- expect( schema.getDefinition( 'paragraph' ).isLimit ).to.be.false;
- } );
- } );
- describe( 'inheritAllFrom', () => {
- it( 'passes $root>paragraph – paragraph inherits allowIn from $block', () => {
- schema.register( '$root' );
- schema.register( '$block', {
- allowIn: '$root'
- } );
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- } );
- it( 'paragraph inherit properties of $block', () => {
- schema.register( '$block', {
- isBlock: true
- } );
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- expect( schema.isBlock( r1p1 ) ).to.be.true;
- } );
- it( 'passes $root>paragraph>$text – paragraph inherits allowed content of $block', () => {
- schema.register( '$root' );
- schema.register( '$block', {
- allowIn: '$root'
- } );
- schema.register( '$text', {
- allowIn: '$block'
- } );
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- expect( schema.checkChild( r1p1, r1p1.getChild( 0 ) ) ).to.be.true;
- } );
- it( 'passes $root>paragraph>$text – paragraph inherits allowIn from $block through $block\'s allowWhere', () => {
- schema.register( '$root' );
- schema.register( '$blockProto', {
- allowIn: '$root'
- } );
- schema.register( '$block', {
- allowWhere: '$blockProto'
- } );
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.true;
- } );
- it( 'passes $root>paragraph>$text – paragraph inherits allowIn from $block through $block\'s allowWhere', () => {
- schema.register( '$root' );
- schema.register( '$blockProto' );
- schema.register( '$block', {
- allowContentOf: '$blockProto',
- allowIn: '$root'
- } );
- schema.register( '$text', {
- allowIn: '$blockProto'
- } );
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- expect( schema.checkChild( r1p1, r1p1.getChild( 0 ) ) ).to.be.true;
- } );
- } );
- // We need to handle cases where some independent features registered definitions which might use
- // optional elements (elements which might not have been registered).
- describe( 'missing structure definitions', () => {
- it( 'does not break when trying to check a child which is not registered', () => {
- schema.register( '$root' );
- expect( schema.checkChild( root1, 'foo404' ) ).to.be.false;
- } );
- it( 'does not break when trying to check registered child in a context which contains non-registered elements', () => {
- const foo404 = new Element( 'foo404' );
- root1._appendChild( foo404 );
- schema.register( '$root' );
- schema.register( '$text', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( foo404, '$text' ) ).to.be.false;
- } );
- it( 'does not break when used allowedIn pointing to an non-registered element', () => {
- schema.register( '$root' );
- schema.register( '$text', {
- allowIn: 'foo404'
- } );
- expect( schema.checkChild( root1, '$text' ) ).to.be.false;
- } );
- it( 'does not break when used allowWhere pointing to an non-registered element', () => {
- schema.register( '$root' );
- schema.register( '$text', {
- allowWhere: 'foo404'
- } );
- expect( schema.checkChild( root1, '$text' ) ).to.be.false;
- } );
- it( 'does not break when used allowContentOf pointing to an non-registered element', () => {
- schema.register( '$root', {
- allowContentOf: 'foo404'
- } );
- schema.register( '$text', {
- allowIn: '$root'
- } );
- expect( schema.checkChild( root1, '$text' ) ).to.be.true;
- } );
- it( 'checks whether allowIn uses a registered element', () => {
- schema.register( 'paragraph', {
- allowIn: '$root'
- } );
- // $root isn't registered!
- expect( schema.checkChild( root1, 'paragraph' ) ).to.be.false;
- } );
- it( 'does not break when inheriting all from an non-registered element', () => {
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- expect( schema.checkChild( root1, r1p1 ) ).to.be.false;
- } );
- } );
- describe( 'allowAttributes', () => {
- it( 'passes paragraph[align]', () => {
- schema.register( 'paragraph', {
- allowAttributes: 'align'
- } );
- expect( schema.checkAttribute( r1p1, 'align' ) ).to.be.true;
- } );
- it( 'passes paragraph[align] and paragraph[dir] – support for array values', () => {
- schema.register( 'paragraph', {
- allowAttributes: [ 'align', 'dir' ]
- } );
- expect( schema.checkAttribute( r1p1, 'align' ), 'align' ).to.be.true;
- expect( schema.checkAttribute( r1p1, 'dir' ), 'dir' ).to.be.true;
- } );
- it( 'passes paragraph>$text[bold]', () => {
- schema.register( 'paragraph' );
- schema.register( '$text', {
- allowIn: 'paragraph',
- allowAttributes: 'bold'
- } );
- expect( schema.checkAttribute( r1p1.getChild( 0 ), 'bold' ) ).to.be.true;
- } );
- } );
- describe( 'allowAttributesOf', () => {
- it( 'passes paragraph[align] – paragraph inherits from $block', () => {
- schema.register( '$block', {
- allowAttributes: 'align'
- } );
- schema.register( 'paragraph', {
- allowAttributesOf: '$block'
- } );
- expect( schema.checkAttribute( r1p1, 'align' ) ).to.be.true;
- } );
- it( 'passes paragraph[align] and paragraph[dir] – support for array values', () => {
- schema.register( '$block', {
- allowAttributes: 'align'
- } );
- schema.register( '$block2', {
- allowAttributes: 'dir'
- } );
- schema.register( 'paragraph', {
- allowAttributesOf: [ '$block', '$block2' ]
- } );
- expect( schema.checkAttribute( r1p1, 'align' ), 'align' ).to.be.true;
- expect( schema.checkAttribute( r1p1, 'dir' ), 'dir' ).to.be.true;
- } );
- it( 'passes paragraph[align] and paragraph[dir] – support for combined allowAttributes and allowAttributesOf', () => {
- schema.register( '$block', {
- allowAttributes: 'align'
- } );
- schema.register( 'paragraph', {
- allowAttributes: 'dir',
- allowAttributesOf: '$block'
- } );
- expect( schema.checkAttribute( r1p1, 'align' ), 'align' ).to.be.true;
- expect( schema.checkAttribute( r1p1, 'dir' ), 'dir' ).to.be.true;
- } );
- // The support for allowAttributesOf is broken in the similar way as for allowContentOf (see the comment above).
- // However, those situations are rather theoretical, so we're not going to waste time on them now.
- } );
- describe( 'inheritAllFrom', () => {
- it( 'passes paragraph[align] – paragraph inherits attributes of $block', () => {
- schema.register( '$block', {
- allowAttributes: 'align'
- } );
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- expect( schema.checkAttribute( r1p1, 'align' ) ).to.be.true;
- } );
- it( 'passes paragraph[align] – paragraph inherits attributes of $block through allowAttributesOf', () => {
- schema.register( '$blockProto', {
- allowAttributes: 'align'
- } );
- schema.register( '$block', {
- allowAttributesOf: '$blockProto'
- } );
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- expect( schema.checkAttribute( r1p1, 'align' ) ).to.be.true;
- } );
- } );
- describe( 'missing attribute definitions', () => {
- it( 'does not crash when checking an attribute of a non-registered element', () => {
- expect( schema.checkAttribute( r1p1, 'align' ) ).to.be.false;
- } );
- it( 'does not crash when inheriting attributes of a non-registered element', () => {
- schema.register( 'paragraph', {
- allowAttributesOf: '$block'
- } );
- expect( schema.checkAttribute( r1p1, 'whatever' ) ).to.be.false;
- } );
- it( 'does not crash when inheriting all from a non-registered element', () => {
- schema.register( 'paragraph', {
- allowAttributesOf: '$block'
- } );
- expect( schema.checkAttribute( r1p1, 'whatever' ) ).to.be.false;
- } );
- } );
- describe( 'missing types definitions', () => {
- it( 'does not crash when inheriting types of an non-registered element', () => {
- schema.register( 'paragraph', {
- inheritTypesFrom: '$block'
- } );
- expect( schema.getDefinition( 'paragraph' ) ).to.be.an( 'object' );
- } );
- } );
- } );
- describe( 'real scenarios', () => {
- let r1bQi, r1i, r1lI, r1h, r1bQlI;
- const definitions = [
- () => {
- schema.register( 'paragraph', {
- inheritAllFrom: '$block'
- } );
- },
- () => {
- schema.register( 'heading1', {
- inheritAllFrom: '$block'
- } );
- },
- () => {
- schema.register( 'listItem', {
- inheritAllFrom: '$block',
- allowAttributes: [ 'listIndent', 'listType' ]
- } );
- },
- () => {
- schema.register( 'blockQuote', {
- allowWhere: '$block',
- allowContentOf: '$root'
- } );
- // Disallow blockQuote in blockQuote.
- schema.addChildCheck( ( ctx, childDef ) => {
- if ( childDef.name == 'blockQuote' && ctx.endsWith( 'blockQuote' ) ) {
- return false;
- }
- } );
- },
- () => {
- schema.register( 'image', {
- allowWhere: '$block',
- allowAttributes: [ 'src', 'alt' ],
- isObject: true,
- isBlock: true
- } );
- },
- () => {
- schema.register( 'caption', {
- allowIn: 'image',
- allowContentOf: '$block',
- isLimit: true
- } );
- },
- () => {
- schema.extend( '$text', {
- allowAttributes: [ 'bold', 'italic' ]
- } );
- // Disallow bold in heading1.
- schema.addAttributeCheck( ( ctx, attributeName ) => {
- if ( ctx.endsWith( 'heading1 $text' ) && attributeName == 'bold' ) {
- return false;
- }
- } );
- },
- () => {
- schema.extend( '$block', {
- allowAttributes: 'alignment'
- } );
- }
- ];
- beforeEach( () => {
- schema.register( '$root', {
- isLimit: true
- } );
- schema.register( '$block', {
- allowIn: '$root',
- isBlock: true
- } );
- schema.register( '$text', {
- allowIn: '$block'
- } );
- for ( const definition of definitions ) {
- definition();
- }
- // or...
- //
- // Use the below code to shuffle the definitions.
- // Don't look here, Szymon!
- //
- // const definitionsCopy = definitions.slice();
- //
- // while ( definitionsCopy.length ) {
- // const r = Math.floor( Math.random() * definitionsCopy.length );
- // definitionsCopy.splice( r, 1 )[ 0 ]();
- // }
- root1 = new Element( '$root', null, [
- new Element( 'paragraph', null, 'foo' ),
- new Element( 'paragraph', { alignment: 'right' }, 'bar' ),
- new Element( 'listItem', { listType: 'x', listIndent: 0 }, 'foo' ),
- new Element( 'heading1', null, 'foo' ),
- new Element( 'blockQuote', null, [
- new Element( 'paragraph', null, 'foo' ),
- new Element( 'listItem', { listType: 'x', listIndent: 0 }, 'foo' ),
- new Element( 'image', null, [
- new Element( 'caption', null, 'foo' )
- ] )
- ] ),
- new Element( 'image', null, [
- new Element( 'caption', null, 'foo' )
- ] )
- ] );
- r1p1 = root1.getChild( 0 );
- r1p2 = root1.getChild( 1 );
- r1lI = root1.getChild( 2 );
- r1h = root1.getChild( 3 );
- r1bQ = root1.getChild( 4 );
- r1i = root1.getChild( 5 );
- r1bQp = r1bQ.getChild( 0 );
- r1bQlI = r1bQ.getChild( 1 );
- r1bQi = r1bQ.getChild( 2 );
- } );
- it( 'passes $root>paragraph', () => {
- expect( schema.checkChild( root1, 'paragraph' ) ).to.be.true;
- } );
- it( 'passes $root>paragraph>$text', () => {
- expect( schema.checkChild( r1p1, '$text' ), 'paragraph' ).to.be.true;
- expect( schema.checkChild( r1p2, '$text' ), 'paragraph[alignment]' ).to.be.true;
- } );
- it( 'passes $root>listItem', () => {
- expect( schema.checkChild( root1, 'listItem' ) ).to.be.true;
- } );
- it( 'passes $root>listItem>$text', () => {
- expect( schema.checkChild( r1lI, '$text' ) ).to.be.true;
- } );
- it( 'passes $root>blockQuote>paragraph', () => {
- expect( schema.checkChild( r1bQ, 'paragraph' ) ).to.be.true;
- } );
- it( 'passes $root>blockQuote>paragraph>$text', () => {
- expect( schema.checkChild( r1bQp, '$text' ) ).to.be.true;
- } );
- it( 'passes $root>blockQuote>listItem', () => {
- expect( schema.checkChild( r1bQ, 'listItem' ) ).to.be.true;
- } );
- it( 'passes $root>blockQuote>listItem>$text', () => {
- expect( schema.checkChild( r1bQlI, '$text' ) ).to.be.true;
- } );
- it( 'passes $root>blockQuote>image', () => {
- expect( schema.checkChild( r1bQ, 'image' ) ).to.be.true;
- } );
- it( 'passes $root>blockQuote>image>caption', () => {
- expect( schema.checkChild( r1bQi, 'caption' ) ).to.be.true;
- } );
- it( 'passes $root>blockQuote>image>caption>$text', () => {
- expect( schema.checkChild( r1bQi.getChild( 0 ), '$text' ) ).to.be.true;
- } );
- it( 'passes $root>image', () => {
- expect( schema.checkChild( root1, 'image' ) ).to.be.true;
- } );
- it( 'passes $root>image>caption', () => {
- expect( schema.checkChild( r1i, 'caption' ) ).to.be.true;
- } );
- it( 'passes $root>image>caption>$text', () => {
- expect( schema.checkChild( r1i.getChild( 0 ), '$text' ) ).to.be.true;
- } );
- it( 'rejects $root>$root', () => {
- expect( schema.checkChild( root1, '$root' ) ).to.be.false;
- } );
- it( 'rejects $root>$text', () => {
- expect( schema.checkChild( root1, '$text' ) ).to.be.false;
- } );
- it( 'rejects $root>caption', () => {
- expect( schema.checkChild( root1, 'caption' ) ).to.be.false;
- } );
- it( 'rejects $root>paragraph>paragraph', () => {
- expect( schema.checkChild( r1p1, 'paragraph' ) ).to.be.false;
- } );
- it( 'rejects $root>paragraph>paragraph>$text', () => {
- // Edge case because p>p should not exist in the first place.
- // But it's good to know that it blocks also this.
- const p = new Element( 'p' );
- r1p1._appendChild( p );
- expect( schema.checkChild( p, '$text' ) ).to.be.false;
- } );
- it( 'rejects $root>paragraph>$block', () => {
- expect( schema.checkChild( r1p1, '$block' ) ).to.be.false;
- } );
- it( 'rejects $root>paragraph>blockQuote', () => {
- expect( schema.checkChild( r1p1, 'blockQuote' ) ).to.be.false;
- } );
- it( 'rejects $root>paragraph>image', () => {
- expect( schema.checkChild( r1p1, 'image' ) ).to.be.false;
- } );
- it( 'rejects $root>paragraph>caption', () => {
- expect( schema.checkChild( r1p1, 'caption' ) ).to.be.false;
- } );
- it( 'rejects $root>blockQuote>blockQuote', () => {
- expect( schema.checkChild( r1bQ, 'blockQuote' ) ).to.be.false;
- } );
- it( 'rejects $root>blockQuote>caption', () => {
- expect( schema.checkChild( r1p1, 'image' ) ).to.be.false;
- } );
- it( 'rejects $root>blockQuote>$text', () => {
- expect( schema.checkChild( r1bQ, '$text' ) ).to.be.false;
- } );
- it( 'rejects $root>image>$text', () => {
- expect( schema.checkChild( r1i, '$text' ) ).to.be.false;
- } );
- it( 'rejects $root>image>paragraph', () => {
- expect( schema.checkChild( r1i, 'paragraph' ) ).to.be.false;
- } );
- it( 'rejects $root>image>caption>paragraph', () => {
- expect( schema.checkChild( r1i.getChild( 0 ), 'paragraph' ) ).to.be.false;
- } );
- it( 'rejects $root>image>caption>blockQuote', () => {
- expect( schema.checkChild( r1i.getChild( 0 ), 'blockQuote' ) ).to.be.false;
- } );
- it( 'accepts attribute $root>paragraph[alignment]', () => {
- expect( schema.checkAttribute( r1p1, 'alignment' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>paragraph>$text[bold]', () => {
- expect( schema.checkAttribute( r1p1.getChild( 0 ), 'bold' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>heading1>$text[italic]', () => {
- expect( schema.checkAttribute( r1h.getChild( 0 ), 'italic' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>blockQuote>paragraph>$text[bold]', () => {
- expect( schema.checkAttribute( r1bQp.getChild( 0 ), 'bold' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>listItem[alignment]', () => {
- expect( schema.checkAttribute( r1lI, 'alignment' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>listItem[indent]', () => {
- expect( schema.checkAttribute( r1lI, 'listIndent' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>listItem[type]', () => {
- expect( schema.checkAttribute( r1lI, 'listType' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>image[src]', () => {
- expect( schema.checkAttribute( r1i, 'src' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>image[alt]', () => {
- expect( schema.checkAttribute( r1i, 'alt' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>image>caption>$text[bold]', () => {
- expect( schema.checkAttribute( r1i.getChild( 0 ).getChild( 0 ), 'bold' ) ).to.be.true;
- } );
- it( 'rejects attribute $root[indent]', () => {
- expect( schema.checkAttribute( root1, 'listIndent' ) ).to.be.false;
- } );
- it( 'rejects attribute $root>paragraph[indent]', () => {
- expect( schema.checkAttribute( r1p1, 'listIndent' ) ).to.be.false;
- } );
- it( 'accepts attribute $root>heading1>$text[bold]', () => {
- expect( schema.checkAttribute( r1h.getChild( 0 ), 'bold' ) ).to.be.false;
- } );
- it( 'rejects attribute $root>paragraph>$text[alignment]', () => {
- expect( schema.checkAttribute( r1p1.getChild( 0 ), 'alignment' ) ).to.be.false;
- } );
- it( 'rejects attribute $root>blockQuote[indent]', () => {
- expect( schema.checkAttribute( r1bQ, 'listIndent' ) ).to.be.false;
- } );
- it( 'rejects attribute $root>blockQuote[alignment]', () => {
- expect( schema.checkAttribute( r1bQ, 'alignment' ) ).to.be.false;
- } );
- it( 'rejects attribute $root>image[indent]', () => {
- expect( schema.checkAttribute( r1i, 'listIndent' ) ).to.be.false;
- } );
- it( 'rejects attribute $root>image[alignment]', () => {
- expect( schema.checkAttribute( r1i, 'alignment' ) ).to.be.false;
- } );
- it( '$root is limit', () => {
- expect( schema.isLimit( '$root' ) ).to.be.true;
- expect( schema.isBlock( '$root' ) ).to.be.false;
- expect( schema.isObject( '$root' ) ).to.be.false;
- } );
- it( 'paragraph is block', () => {
- expect( schema.isLimit( 'paragraph' ) ).to.be.false;
- expect( schema.isBlock( 'paragraph' ) ).to.be.true;
- expect( schema.isObject( 'paragraph' ) ).to.be.false;
- } );
- it( 'heading1 is block', () => {
- expect( schema.isLimit( 'heading1' ) ).to.be.false;
- expect( schema.isBlock( 'heading1' ) ).to.be.true;
- expect( schema.isObject( 'heading1' ) ).to.be.false;
- } );
- it( 'listItem is block', () => {
- expect( schema.isLimit( 'listItem' ) ).to.be.false;
- expect( schema.isBlock( 'listItem' ) ).to.be.true;
- expect( schema.isObject( 'listItem' ) ).to.be.false;
- } );
- it( 'image is block object', () => {
- expect( schema.isLimit( 'image' ) ).to.be.true;
- expect( schema.isBlock( 'image' ) ).to.be.true;
- expect( schema.isObject( 'image' ) ).to.be.true;
- } );
- it( 'caption is limit', () => {
- expect( schema.isLimit( 'caption' ) ).to.be.true;
- expect( schema.isBlock( 'caption' ) ).to.be.false;
- expect( schema.isObject( 'caption' ) ).to.be.false;
- } );
- } );
- describe( 'createContext()', () => {
- it( 'should return SchemaContext instance', () => {
- const ctx = schema.createContext( [ 'a', 'b', 'c' ] );
- expect( ctx ).to.be.instanceof( SchemaContext );
- } );
- } );
- } );
- describe( 'SchemaContext', () => {
- let root;
- beforeEach( () => {
- root = new Element( '$root', null, [
- new Element( 'blockQuote', { foo: 1 }, [
- new Element( 'paragraph', { align: 'left' }, [
- new Text( 'foo', { bold: true, italic: true } )
- ] )
- ] )
- ] );
- } );
- describe( 'constructor()', () => {
- it( 'creates context based on an array of strings', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- expect( ctx.length ).to.equal( 3 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'a', 'b', 'c' ] );
- expect( ctx.getItem( 0 ).name ).to.equal( 'a' );
- expect( Array.from( ctx.getItem( 0 ).getAttributeKeys() ) ).to.be.empty;
- expect( ctx.getItem( 0 ).getAttribute( 'foo' ) ).to.be.undefined;
- } );
- it( 'creates context based on an array of elements', () => {
- const blockQuote = root.getChild( 0 );
- const text = blockQuote.getChild( 0 ).getChild( 0 );
- const ctx = new SchemaContext( [ blockQuote, text ] );
- expect( ctx.length ).to.equal( 2 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'blockQuote', '$text' ] );
- expect( ctx.getItem( 0 ).name ).to.equal( 'blockQuote' );
- expect( Array.from( ctx.getItem( 1 ).getAttributeKeys() ).sort() ).to.deep.equal( [ 'bold', 'italic' ] );
- expect( ctx.getItem( 1 ).getAttribute( 'bold' ) ).to.be.true;
- } );
- it( 'creates context based on a mixed array of strings and elements', () => {
- const blockQuote = root.getChild( 0 );
- const text = blockQuote.getChild( 0 ).getChild( 0 );
- const ctx = new SchemaContext( [ blockQuote, 'paragraph', text ] );
- expect( ctx.length ).to.equal( 3 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'blockQuote', 'paragraph', '$text' ] );
- } );
- it( 'creates context based on a root element', () => {
- const ctx = new SchemaContext( root );
- expect( ctx.length ).to.equal( 1 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ '$root' ] );
- expect( Array.from( ctx.getItem( 0 ).getAttributeKeys() ) ).to.be.empty;
- expect( ctx.getItem( 0 ).getAttribute( 'foo' ) ).to.be.undefined;
- } );
- it( 'creates context based on a nested element', () => {
- const ctx = new SchemaContext( root.getChild( 0 ).getChild( 0 ) );
- expect( ctx.length ).to.equal( 3 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ '$root', 'blockQuote', 'paragraph' ] );
- expect( Array.from( ctx.getItem( 1 ).getAttributeKeys() ) ).to.deep.equal( [ 'foo' ] );
- expect( ctx.getItem( 1 ).getAttribute( 'foo' ) ).to.equal( 1 );
- expect( Array.from( ctx.getItem( 2 ).getAttributeKeys() ) ).to.deep.equal( [ 'align' ] );
- expect( ctx.getItem( 2 ).getAttribute( 'align' ) ).to.equal( 'left' );
- } );
- it( 'creates context based on a text node', () => {
- const ctx = new SchemaContext( root.getChild( 0 ).getChild( 0 ).getChild( 0 ) );
- expect( ctx.length ).to.equal( 4 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ '$root', 'blockQuote', 'paragraph', '$text' ] );
- expect( Array.from( ctx.getItem( 3 ).getAttributeKeys() ).sort() ).to.deep.equal( [ 'bold', 'italic' ] );
- expect( ctx.getItem( 3 ).getAttribute( 'bold' ) ).to.be.true;
- } );
- it( 'creates context based on a text proxy', () => {
- const text = root.getChild( 0 ).getChild( 0 ).getChild( 0 );
- const textProxy = new TextProxy( text, 0, 1 );
- const ctx = new SchemaContext( textProxy );
- expect( ctx.length ).to.equal( 4 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ '$root', 'blockQuote', 'paragraph', '$text' ] );
- expect( Array.from( ctx.getItem( 3 ).getAttributeKeys() ).sort() ).to.deep.equal( [ 'bold', 'italic' ] );
- expect( ctx.getItem( 3 ).getAttribute( 'bold' ) ).to.be.true;
- } );
- it( 'creates context based on a position', () => {
- const pos = Position._createAt( root.getChild( 0 ).getChild( 0 ), 0 );
- const ctx = new SchemaContext( pos );
- expect( ctx.length ).to.equal( 3 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ '$root', 'blockQuote', 'paragraph' ] );
- expect( Array.from( ctx.getItem( 2 ).getAttributeKeys() ).sort() ).to.deep.equal( [ 'align' ] );
- } );
- it( 'creates context based on a string', () => {
- const ctx = new SchemaContext( 'paragraph' );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'paragraph' ] );
- } );
- it( 'creates context based on a SchemaContext instance', () => {
- const previousCtx = new SchemaContext( [ 'a', 'b', 'c' ] );
- const ctx = new SchemaContext( previousCtx );
- expect( ctx ).to.equal( previousCtx );
- } );
- it( 'filters out DocumentFragment when it is a first item of context - array', () => {
- const ctx = new SchemaContext( [ new DocumentFragment(), 'paragraph' ] );
- expect( ctx.length ).to.equal( 1 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'paragraph' ] );
- } );
- it( 'filters out DocumentFragment when it is a first item of context - element', () => {
- const p = new Element( 'paragraph' );
- const docFrag = new DocumentFragment();
- docFrag._appendChild( p );
- const ctx = new SchemaContext( p );
- expect( ctx.length ).to.equal( 1 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'paragraph' ] );
- } );
- it( 'filters out DocumentFragment when it is a first item of context - position', () => {
- const p = new Element( 'paragraph' );
- const docFrag = new DocumentFragment();
- docFrag._appendChild( p );
- const ctx = new SchemaContext( new Position( docFrag, [ 0, 0 ] ) );
- expect( ctx.length ).to.equal( 1 );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'paragraph' ] );
- } );
- } );
- describe( 'length', () => {
- it( 'gets the number of items', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- expect( ctx.length ).to.equal( 3 );
- } );
- } );
- describe( 'last', () => {
- it( 'gets the last item', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- expect( ctx.last ).to.be.an( 'object' );
- expect( ctx.last.name ).to.equal( 'c' );
- } );
- } );
- describe( 'Symbol.iterator', () => {
- it( 'exists', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- expect( ctx[ Symbol.iterator ] ).to.be.a( 'function' );
- expect( Array.from( ctx ).map( item => item.name ) ).to.deep.equal( [ 'a', 'b', 'c' ] );
- } );
- } );
- describe( 'getItem()', () => {
- it( 'returns item by index', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- expect( ctx.getItem( 1 ) ).to.be.an( 'object' );
- expect( ctx.getItem( 1 ).name ).to.equal( 'b' );
- } );
- it( 'returns undefined if index exceeds the range', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- expect( ctx.getItem( 3 ) ).to.be.undefined;
- } );
- } );
- describe( 'push()', () => {
- it( 'creates new SchemaContext instance with new item - #string', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- const newCtx = ctx.push( 'd' );
- expect( newCtx ).to.instanceof( SchemaContext );
- expect( newCtx ).to.not.equal( ctx );
- expect( Array.from( newCtx.getNames() ) ).to.deep.equal( [ 'a', 'b', 'c', 'd' ] );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'a', 'b', 'c' ] );
- } );
- it( 'creates new SchemaContext instance with new item - #text', () => {
- const node = new Text( 'd' );
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- const newCtx = ctx.push( node );
- expect( newCtx ).to.instanceof( SchemaContext );
- expect( newCtx ).to.not.equal( ctx );
- expect( Array.from( newCtx.getNames() ) ).to.deep.equal( [ 'a', 'b', 'c', '$text' ] );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'a', 'b', 'c' ] );
- } );
- it( 'creates new SchemaContext instance with new item - #element', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- const parent = new Element( 'parent', null, new Element( 'd' ) );
- const newCtx = ctx.push( parent.getChild( 0 ) );
- expect( newCtx ).to.instanceof( SchemaContext );
- expect( newCtx ).to.not.equal( ctx );
- expect( Array.from( newCtx.getNames() ) ).to.deep.equal( [ 'a', 'b', 'c', 'd' ] );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'a', 'b', 'c' ] );
- } );
- } );
- describe( 'getNames()', () => {
- it( 'returns an iterator', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- expect( ctx.getNames().next ).to.be.a( 'function' );
- } );
- it( 'returns an iterator which returns all item names', () => {
- const ctx = new SchemaContext( [ 'a', 'b', 'c' ] );
- expect( Array.from( ctx.getNames() ) ).to.deep.equal( [ 'a', 'b', 'c' ] );
- } );
- } );
- describe( 'endsWith()', () => {
- it( 'returns true if the end of the context matches the query - 1 item', () => {
- const ctx = new SchemaContext( [ 'foo', 'bar', 'bom', 'dom' ] );
- expect( ctx.endsWith( 'dom' ) ).to.be.true;
- } );
- it( 'returns true if the end of the context matches the query - 2 items', () => {
- const ctx = new SchemaContext( [ 'foo', 'bar', 'bom', 'dom' ] );
- expect( ctx.endsWith( 'bom dom' ) ).to.be.true;
- } );
- it( 'returns true if the end of the context matches the query - full match of 3 items', () => {
- const ctx = new SchemaContext( [ 'foo', 'bar', 'bom' ] );
- expect( ctx.endsWith( 'foo bar bom' ) ).to.be.true;
- } );
- it( 'returns true if the end of the context matches the query - full match of 1 items', () => {
- const ctx = new SchemaContext( [ 'foo' ] );
- expect( ctx.endsWith( 'foo' ) ).to.be.true;
- } );
- it( 'returns true if not only the end of the context matches the query', () => {
- const ctx = new SchemaContext( [ 'foo', 'foo', 'foo', 'foo' ] );
- expect( ctx.endsWith( 'foo foo' ) ).to.be.true;
- } );
- it( 'returns false if query matches the middle of the context', () => {
- const ctx = new SchemaContext( [ 'foo', 'bar', 'bom', 'dom' ] );
- expect( ctx.endsWith( 'bom' ) ).to.be.false;
- } );
- it( 'returns false if query matches the start of the context', () => {
- const ctx = new SchemaContext( [ 'foo', 'bar', 'bom', 'dom' ] );
- expect( ctx.endsWith( 'foo' ) ).to.be.false;
- } );
- it( 'returns false if query does not match', () => {
- const ctx = new SchemaContext( [ 'foo', 'bar', 'bom', 'dom' ] );
- expect( ctx.endsWith( 'dom bar' ) ).to.be.false;
- } );
- it( 'returns false if query is longer than context', () => {
- const ctx = new SchemaContext( [ 'foo' ] );
- expect( ctx.endsWith( 'bar', 'foo' ) ).to.be.false;
- } );
- } );
- } );
|