| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331 |
- /**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import Schema from '../../src/model/schema';
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- import Element from '../../src/model/element';
- import Position from '../../src/model/position';
- import Text from '../../src/model/text';
- 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.getRule( 'foo' ) ).to.be.an( 'object' );
- } );
- it( 'copies rules', () => {
- const rules = {};
- schema.register( 'foo', rules );
- rules.isBlock = true;
- expect( schema.getRules().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 rules', () => {
- schema.register( 'foo' );
- schema.extend( 'foo', {
- isBlock: true
- } );
- expect( schema.getRule( 'foo' ) ).to.have.property( 'isBlock', true );
- } );
- it( 'copies rules', () => {
- schema.register( 'foo', {} );
- const rules = {};
- schema.extend( 'foo', rules );
- rules.isBlock = true;
- expect( schema.getRules().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( 'getRules()', () => {
- it( 'returns compiled rules', () => {
- schema.register( '$root' );
- schema.register( 'foo', {
- allowIn: '$root'
- } );
- schema.extend( 'foo', {
- isBlock: true
- } );
- const rules = schema.getRules();
- expect( rules.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 rules = schema.getRules();
- expect( rules.foo ).to.have.property( 'isBlock', true );
- expect( rules.foo ).to.have.property( 'isFoo', false );
- expect( rules.foo ).to.have.property( 'isBar', true );
- } );
- it( 'does not recompile rules if not needed', () => {
- schema.register( 'foo' );
- expect( schema.getRules() ).to.equal( schema.getRules() );
- } );
- it( 'ensures no duplicates in allowIn', () => {
- schema.register( '$root' );
- schema.register( 'foo', {
- allowIn: '$root'
- } );
- schema.extend( 'foo', {
- allowIn: '$root'
- } );
- const rules = schema.getRules();
- expect( rules.foo ).to.deep.equal( {
- name: 'foo',
- allowIn: [ '$root' ],
- allowAttributes: []
- } );
- } );
- it( 'ensures no unregistered items in allowIn', () => {
- schema.register( 'foo', {
- allowIn: '$root'
- } );
- const rules = schema.getRules();
- expect( rules.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 rules = schema.getRules();
- expect( rules.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 rules = schema.getRules();
- expect( rules.paragraph ).to.deep.equal( {
- name: 'paragraph',
- allowIn: [],
- allowAttributes: [ 'foo' ]
- } );
- } );
- } );
- describe( 'getRule()', () => {
- // TODO
- } );
- 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;
- } );
- } );
- 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;
- } );
- } );
- 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 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;
- } );
- } );
- 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 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;
- } );
- } );
- 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 position as a context', () => {
- const posInRoot = Position.createAt( root1 );
- const posInParagraph = Position.createAt( r1p1 );
- 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;
- } );
- // TODO checks fires event
- // TODO checks with a custom context array
- } );
- 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;
- } );
- // TODO checks fires event
- // TODO checks with a custom context array
- } );
- describe( 'rules 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.appendChildren( 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.appendChildren( div );
- expect( schema.checkChild( div, div ) ).to.be.true;
- } );
- it( 'rejects $root>paragraph – unregistered 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 rules 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 rules 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;
- } );
- // TODO we need to make it possible to disallow bQ in bQ.
- 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 rules in a pretty naive way.
- // To make chains like this work we'd need to repeat compilation of allowContentOf rules
- // 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 rule 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( '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( '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 rules which might use
- // optional elements (elements which might not have been registered).
- describe( 'missing structure rules', () => {
- 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 unregistered elements', () => {
- const foo404 = new Element( 'foo404' );
- root1.appendChildren( 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 unregistered 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 unregistered 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 unregistered 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 unregistered 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 rules', () => {
- it( 'does not crash when checking an attribute of a unregistered element', () => {
- expect( schema.checkAttribute( r1p1, 'align' ) ).to.be.false;
- } );
- it( 'does not crash when inheriting attributes of a unregistered element', () => {
- schema.register( 'paragraph', {
- allowAttributesOf: '$block'
- } );
- expect( schema.checkAttribute( r1p1, 'whatever' ) ).to.be.false;
- } );
- it( 'does not crash when inheriting all from a unregistered element', () => {
- schema.register( 'paragraph', {
- allowAttributesOf: '$block'
- } );
- expect( schema.checkAttribute( r1p1, 'whatever' ) ).to.be.false;
- } );
- } );
- } );
- describe( 'real scenarios', () => {
- let r1bQi, r1i, r1lI, r1h, r1bQlI;
- const rules = [
- () => {
- schema.register( 'paragraph', {
- allowWhere: '$block',
- allowContentOf: '$block',
- allowAttributesOf: '$block'
- } );
- },
- () => {
- schema.register( 'heading1', {
- allowWhere: '$block',
- allowContentOf: '$block',
- allowAttributesOf: '$block'
- } );
- },
- () => {
- schema.register( 'listItem', {
- allowWhere: '$block',
- allowContentOf: '$block',
- allowAttributes: [ 'indent', 'type' ],
- allowAttributesOf: '$block'
- } );
- },
- () => {
- schema.register( 'blockQuote', {
- allowWhere: '$block',
- allowContentOf: '$root'
- } );
- // Disallow blockQuote in blockQuote.
- schema.on( 'checkChild', ( evt, args ) => {
- const context = args[ 0 ];
- const child = args[ 1 ];
- const childRule = schema.getRule( child );
- if ( childRule.name == 'blockQuote' && context[ context.length - 1 ].name == 'blockQuote' ) {
- evt.stop();
- evt.return = false;
- }
- }, { priority: 'high' } );
- },
- () => {
- schema.register( 'image', {
- allowWhere: '$block',
- allowAttributes: [ 'src', 'alt' ]
- } );
- },
- () => {
- schema.register( 'caption', {
- allowIn: 'image',
- allowContentOf: '$block'
- } );
- },
- () => {
- schema.extend( '$text', {
- allowAttributes: [ 'bold', 'italic' ]
- } );
- // Disallow bold in heading1.
- schema.on( 'checkAttribute', ( evt, args ) => {
- const context = args[ 0 ];
- const contextLast = context[ context.length - 1 ];
- const contextSecondToLast = context[ context.length - 2 ];
- const attributeName = args[ 1 ];
- if ( contextLast.name == '$text' && contextSecondToLast.name == 'heading1' && attributeName == 'bold' ) {
- evt.stop();
- evt.return = false;
- }
- }, { priority: 'high' } );
- },
- () => {
- schema.extend( '$block', {
- allowAttributes: 'alignment'
- } );
- }
- ];
- beforeEach( () => {
- schema.register( '$root' );
- schema.register( '$block', {
- allowIn: '$root'
- } );
- schema.register( '$text', {
- allowIn: '$block'
- } );
- for ( const rule of rules ) {
- rule();
- }
- // or...
- //
- // Use the below code to shuffle the rules.
- // Don't look here, Szymon!
- //
- // const rulesCopy = rules.slice();
- //
- // while ( rulesCopy.length ) {
- // const r = Math.floor( Math.random() * rulesCopy.length );
- // rulesCopy.splice( r, 1 )[ 0 ]();
- // }
- root1 = new Element( '$root', null, [
- new Element( 'paragraph', null, 'foo' ),
- new Element( 'paragraph', { alignment: 'right' }, 'bar' ),
- new Element( 'listItem', { type: 'x', indent: 0 }, 'foo' ),
- new Element( 'heading1', null, 'foo' ),
- new Element( 'blockQuote', null, [
- new Element( 'paragraph', null, 'foo' ),
- new Element( 'listItem', { type: 'x', indent: 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.appendChildren( 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, 'indent' ) ).to.be.true;
- } );
- it( 'accepts attribute $root>listItem[type]', () => {
- expect( schema.checkAttribute( r1lI, 'type' ) ).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, 'indent' ) ).to.be.false;
- } );
- it( 'rejects attribute $root>paragraph[indent]', () => {
- expect( schema.checkAttribute( r1p1, 'indent' ) ).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, 'indent' ) ).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, 'indent' ) ).to.be.false;
- } );
- it( 'rejects attribute $root>image[alignment]', () => {
- expect( schema.checkAttribute( r1i, 'alignment' ) ).to.be.false;
- } );
- } );
- // TODO:
- // * getValidRanges
- // * checkAttributeInSelection
- // * getLimitElement
- // * removeDisallowedAttributes
- // * test checkChild()'s both params normalization
- // * and see insertContent's _checkIsObject()
- // * add normalization to isObject(), isLimit(), isBlock(), isRegistered() and improve the existing code
- // * inheritAllFrom should also inherit is* props (see tests documentselection getNearestSelectionRange())
- // * test the default abstract entities (in model.js)
- // * see clipboardHolder definition (and rename it to the pastebin)
- // * review insertContent's _tryAutoparagraphing()
- } );
|