model.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. 'use strict';
  6. import { stringify, parse, getData, setData } from '/tests/engine/_utils/model.js';
  7. import Document from '/ckeditor5/engine/model/document.js';
  8. import DocumentFragment from '/ckeditor5/engine/model/documentfragment.js';
  9. import Element from '/ckeditor5/engine/model/element.js';
  10. import Text from '/ckeditor5/engine/model/text.js';
  11. import Range from '/ckeditor5/engine/model/range.js';
  12. import Position from '/ckeditor5/engine/model/position.js';
  13. describe( 'model test utils', () => {
  14. let document, root, selection, sandbox;
  15. beforeEach( () => {
  16. document = new Document();
  17. root = document.createRoot();
  18. selection = document.selection;
  19. sandbox = sinon.sandbox.create();
  20. selection.removeAllRanges();
  21. } );
  22. afterEach( () => {
  23. sandbox.restore();
  24. } );
  25. describe( 'getData', () => {
  26. it( 'should use stringify method', () => {
  27. const stringifySpy = sandbox.spy( getData, '_stringify' );
  28. root.appendChildren( new Element( 'b', null, [ 'btext' ] ) );
  29. expect( getData( document, { withoutSelection: true } ) ).to.equal( '<b>btext</b>' );
  30. sinon.assert.calledOnce( stringifySpy );
  31. sinon.assert.calledWithExactly( stringifySpy, root );
  32. } );
  33. it( 'should use stringify method with selection', () => {
  34. const stringifySpy = sandbox.spy( getData, '_stringify' );
  35. root.appendChildren( new Element( 'b', null, [ 'btext' ] ) );
  36. document.selection.addRange( Range.createFromParentsAndOffsets( root, 0, root, 1 ) );
  37. expect( getData( document ) ).to.equal( '<selection><b>btext</b></selection>' );
  38. sinon.assert.calledOnce( stringifySpy );
  39. sinon.assert.calledWithExactly( stringifySpy, root, document.selection );
  40. } );
  41. it( 'should throw an error when passing invalid document', () => {
  42. expect( () => {
  43. getData( { invalid: 'document' } );
  44. } ).to.throw( TypeError, 'Document needs to be an instance of engine.model.Document.' );
  45. } );
  46. } );
  47. describe( 'setData', () => {
  48. it( 'should use parse method', () => {
  49. const parseSpy = sandbox.spy( setData, '_parse' );
  50. const options = {};
  51. const data = '<b>btext</b>text';
  52. setData( document, data, options );
  53. expect( getData( document, { withoutSelection: true } ) ).to.equal( data );
  54. sinon.assert.calledOnce( parseSpy );
  55. const args = parseSpy.firstCall.args;
  56. expect( args[ 0 ] ).to.equal( data );
  57. } );
  58. it( 'should use parse method with selection', () => {
  59. const parseSpy = sandbox.spy( setData, '_parse' );
  60. const options = {};
  61. const data = '<selection><b>btext</b></selection>';
  62. setData( document, data, options );
  63. expect( getData( document ) ).to.equal( data );
  64. sinon.assert.calledOnce( parseSpy );
  65. const args = parseSpy.firstCall.args;
  66. expect( args[ 0 ] ).to.equal( data );
  67. } );
  68. it( 'should throw an error when passing invalid document', () => {
  69. expect( () => {
  70. setData( { invalid: 'document' } );
  71. } ).to.throw( TypeError, 'Document needs to be an instance of engine.model.Document.' );
  72. } );
  73. } );
  74. describe( 'stringify', () => {
  75. it( 'should stringify text', () => {
  76. const text = new Text( 'text', { underline: true, bold: true } );
  77. expect( stringify( text ) ).to.equal( '<$text bold=true underline=true>text</$text>' );
  78. } );
  79. it( 'should stringify element', () => {
  80. const element = new Element( 'a', null, [ new Element( 'b', null, 'btext' ), 'atext' ] );
  81. expect( stringify( element ) ).to.equal( '<a><b>btext</b>atext</a>' );
  82. } );
  83. it( 'should stringify document fragment', () => {
  84. const fragment = new DocumentFragment( [ new Element( 'b', null, 'btext' ), 'atext' ] );
  85. expect( stringify( fragment ) ).to.equal( '<b>btext</b>atext' );
  86. } );
  87. it( 'writes elements and texts', () => {
  88. root.appendChildren( [
  89. new Element( 'a', null, 'atext' ),
  90. new Element( 'b', null, [
  91. new Element( 'c1' ),
  92. 'ctext',
  93. new Element( 'c2' )
  94. ] ),
  95. new Element( 'd' )
  96. ] );
  97. expect( stringify( root ) ).to.equal(
  98. '<a>atext</a><b><c1></c1>ctext<c2></c2></b><d></d>'
  99. );
  100. } );
  101. it( 'writes element attributes', () => {
  102. root.appendChildren(
  103. new Element( 'a', { foo: true, bar: 1, car: false }, [
  104. new Element( 'b', { fooBar: 'x y', barFoo: { x: 1, y: 2 } } )
  105. ] )
  106. );
  107. // Note: attributes are written in a very simplistic way, because they are not to be parsed. They are just
  108. // to be compared in the tests with some patterns.
  109. expect( stringify( root ) ).to.equal(
  110. '<a bar=1 car=false foo=true><b barFoo={"x":1,"y":2} fooBar="x y"></b></a>'
  111. );
  112. } );
  113. it( 'writes text attributes', () => {
  114. root.appendChildren( [
  115. new Text( 'foo', { bold: true } ),
  116. 'bar',
  117. new Text( 'bom', { bold: true, italic: true } ),
  118. new Element( 'a', null, [
  119. new Text( 'pom', { underline: true, bold: true } )
  120. ] )
  121. ] );
  122. expect( stringify( root ) ).to.equal(
  123. '<$text bold=true>foo</$text>' +
  124. 'bar' +
  125. '<$text bold=true italic=true>bom</$text>' +
  126. '<a><$text bold=true underline=true>pom</$text></a>'
  127. );
  128. } );
  129. describe( 'selection', () => {
  130. let elA, elB;
  131. beforeEach( () => {
  132. elA = new Element( 'a' );
  133. elB = new Element( 'b' );
  134. root.appendChildren( [
  135. elA,
  136. 'foo',
  137. new Text( 'bar', { bold: true } ),
  138. elB
  139. ] );
  140. } );
  141. it( 'writes selection in an empty root', () => {
  142. const root = document.createRoot( '$root', 'empty' );
  143. selection.collapse( root );
  144. expect( stringify( root, selection ) ).to.equal(
  145. '<selection />'
  146. );
  147. } );
  148. it( 'writes only requested element', () => {
  149. expect( stringify( elA ) ).to.equal( '<a></a>' );
  150. } );
  151. it( 'writes selection collapsed in an element', () => {
  152. selection.collapse( root );
  153. expect( stringify( root, selection ) ).to.equal(
  154. '<selection /><a></a>foo<$text bold=true>bar</$text><b></b>'
  155. );
  156. } );
  157. it( 'writes selection collapsed in a text', () => {
  158. selection.collapse( root, 3 );
  159. expect( stringify( root, selection ) ).to.equal(
  160. '<a></a>fo<selection />o<$text bold=true>bar</$text><b></b>'
  161. );
  162. } );
  163. it( 'writes selection collapsed at the text left boundary', () => {
  164. selection.collapse( elA, 'after' );
  165. expect( stringify( root, selection ) ).to.equal(
  166. '<a></a><selection />foo<$text bold=true>bar</$text><b></b>'
  167. );
  168. } );
  169. it( 'writes selection collapsed at the text right boundary', () => {
  170. selection.collapse( elB, 'before' );
  171. expect( stringify( root, selection ) ).to.equal(
  172. '<a></a>foo<$text bold=true>bar</$text><selection bold=true /><b></b>'
  173. );
  174. } );
  175. it( 'writes selection collapsed at the end of the root', () => {
  176. selection.collapse( root, 'end' );
  177. // Needed due to https://github.com/ckeditor/ckeditor5-engine/issues/320.
  178. selection.clearAttributes();
  179. expect( stringify( root, selection ) ).to.equal(
  180. '<a></a>foo<$text bold=true>bar</$text><b></b><selection />'
  181. );
  182. } );
  183. it( 'writes selection attributes', () => {
  184. selection.collapse( root );
  185. selection.setAttributesTo( { italic: true, bold: true } );
  186. expect( stringify( root, selection ) ).to.equal(
  187. '<selection bold=true italic=true /><a></a>foo<$text bold=true>bar</$text><b></b>'
  188. );
  189. } );
  190. it( 'writes selection collapsed selection in a text with attributes', () => {
  191. selection.collapse( root, 5 );
  192. expect( stringify( root, selection ) ).to.equal(
  193. '<a></a>foo<$text bold=true>b<selection bold=true />ar</$text><b></b>'
  194. );
  195. } );
  196. it( 'writes flat selection containing couple of nodes', () => {
  197. selection.addRange(
  198. Range.createFromParentsAndOffsets( root, 0, root, 4 )
  199. );
  200. expect( stringify( root, selection ) ).to.equal(
  201. '<selection><a></a>foo</selection><$text bold=true>bar</$text><b></b>'
  202. );
  203. } );
  204. it( 'writes flat selection within text', () => {
  205. selection.addRange(
  206. Range.createFromParentsAndOffsets( root, 2, root, 3 )
  207. );
  208. expect( stringify( root, selection ) ).to.equal(
  209. '<a></a>f<selection>o</selection>o<$text bold=true>bar</$text><b></b>'
  210. );
  211. } );
  212. it( 'writes multi-level selection', () => {
  213. selection.addRange(
  214. Range.createFromParentsAndOffsets( elA, 0, elB, 0 )
  215. );
  216. expect( stringify( root, selection ) ).to.equal(
  217. '<a><selection></a>foo<$text bold=true>bar</$text><b></selection></b>'
  218. );
  219. } );
  220. it( 'writes backward selection', () => {
  221. selection.addRange(
  222. Range.createFromParentsAndOffsets( elA, 0, elB, 0 ),
  223. true
  224. );
  225. expect( stringify( root, selection ) ).to.equal(
  226. '<a><selection backward></a>foo<$text bold=true>bar</$text><b></selection></b>'
  227. );
  228. } );
  229. it( 'uses range and coverts it to selection', () => {
  230. const range = Range.createFromParentsAndOffsets( elA, 0, elB, 0 );
  231. expect( stringify( root, range ) ).to.equal(
  232. '<a><selection></a>foo<$text bold=true>bar</$text><b></selection></b>'
  233. );
  234. } );
  235. it( 'uses position and converts it to collapsed selection', () => {
  236. const position = new Position( root, [ 0 ] );
  237. expect( stringify( root, position ) ).to.equal(
  238. '<selection /><a></a>foo<$text bold=true>bar</$text><b></b>'
  239. );
  240. } );
  241. } );
  242. } );
  243. describe( 'parse', () => {
  244. test( 'creates empty DocumentFragment from empty string', {
  245. data: '',
  246. check( fragment ) {
  247. expect( fragment ).to.be.instanceOf( DocumentFragment );
  248. }
  249. } );
  250. test( 'creates empty DocumentFragment with selection', {
  251. data: '<selection />',
  252. check( fragment, selection ) {
  253. expect( fragment ).to.be.instanceOf( DocumentFragment );
  254. expect( fragment.getChildCount() ).to.equal( 0 );
  255. expect( selection.rangeCount ).to.equal( 1 );
  256. expect( selection.getFirstRange().isEqual( Range.createFromParentsAndOffsets( fragment, 0, fragment, 0 ) ) ).to.be.true;
  257. }
  258. } );
  259. test( 'returns Element if range is around single element', {
  260. data: '<selection><a></a></selection>',
  261. check( el, selection ) {
  262. const fragment = el.parent;
  263. expect( el ).to.be.instanceOf( Element );
  264. expect( fragment ).to.be.instanceOf( DocumentFragment );
  265. expect( selection.rangeCount ).to.equal( 1 );
  266. expect( selection.getFirstRange().isEqual( Range.createFromParentsAndOffsets( fragment, 0, fragment, 1 ) ) ).to.be.true;
  267. }
  268. } );
  269. test( 'returns DocumentFragment when multiple elements on root', {
  270. data: '<a></a><b></b>',
  271. check( fragment ) {
  272. expect( fragment ).to.be.instanceOf( DocumentFragment );
  273. expect( fragment.getChildCount() ).to.equal( 2 );
  274. }
  275. } );
  276. test( 'creates elements', {
  277. data: '<a></a><b><c></c></b>'
  278. } );
  279. test( 'creates text nodes', {
  280. data: 'foo<a>bar</a>bom'
  281. } );
  282. test( 'sets elements attributes', {
  283. data: '<a foo=1 bar=true car="x y"><b x="y"></b></a>',
  284. output: '<a bar=true car="x y" foo=1><b x="y"></b></a>',
  285. check( a ) {
  286. expect( a.getAttribute( 'car' ) ).to.equal( 'x y' );
  287. }
  288. } );
  289. test( 'sets complex attributes', {
  290. data: '<a foo={"a":1,"b":"c"}></a>',
  291. check( a ) {
  292. expect( a.getAttribute( 'foo' ) ).to.have.property( 'a', 1 );
  293. }
  294. } );
  295. test( 'sets text attributes', {
  296. data: '<$text bold=true italic=true>foo</$text><$text bold=true>bar</$text>bom',
  297. check( root ) {
  298. expect( root.getChildCount() ).to.equal( 9 );
  299. expect( root.getChild( 0 ) ).to.have.property( 'character', 'f' );
  300. expect( root.getChild( 0 ).getAttribute( 'italic' ) ).to.equal( true );
  301. }
  302. } );
  303. test( 'returns single parsed element', {
  304. data: '<paragraph></paragraph>',
  305. check( p ) {
  306. expect( p instanceof Element ).to.be.true;
  307. }
  308. } );
  309. test( 'returns DocumentFragment for multiple parsed elements', {
  310. data: '<paragraph></paragraph><paragraph></paragraph>',
  311. check( fragment ) {
  312. expect( fragment instanceof DocumentFragment ).to.be.true;
  313. }
  314. } );
  315. it( 'throws when unexpected closing tag', () => {
  316. expect( () => {
  317. parse( '<a><b></a></b>' );
  318. } ).to.throw( Error, 'Parse error - unexpected closing tag.' );
  319. } );
  320. it( 'throws when unexpected attribute', () => {
  321. expect( () => {
  322. parse( '<a ?></a>' );
  323. } ).to.throw( Error, 'Parse error - unexpected token: ?.' );
  324. } );
  325. it( 'throws when incorrect tag', () => {
  326. expect( () => {
  327. parse( '<a' );
  328. } ).to.throw( Error, 'Parse error - unexpected token: <a.' );
  329. } );
  330. it( 'throws when missing closing tag', () => {
  331. expect( () => {
  332. parse( '<a><b></b>' );
  333. } ).to.throw( Error, 'Parse error - missing closing tags: a.' );
  334. } );
  335. it( 'throws when missing opening tag for text', () => {
  336. expect( () => {
  337. parse( '</$text>' );
  338. } ).to.throw( Error, 'Parse error - unexpected closing tag.' );
  339. } );
  340. it( 'throws when missing closing tag for text', () => {
  341. expect( () => {
  342. parse( '<$text>' );
  343. } ).to.throw( Error, 'Parse error - missing closing tags: $text.' );
  344. } );
  345. describe( 'selection', () => {
  346. test( 'sets collapsed selection in an element', {
  347. data: '<a><selection /></a>',
  348. check( root, selection ) {
  349. expect( selection.getFirstPosition().parent ).to.have.property( 'name', 'a' );
  350. }
  351. } );
  352. test( 'sets collapsed selection between elements', {
  353. data: '<a></a><selection /><b></b>'
  354. } );
  355. test( 'sets collapsed selection before a text', {
  356. data: '<a></a><selection />foo'
  357. } );
  358. test( 'sets collapsed selection after a text', {
  359. data: 'foo<selection />'
  360. } );
  361. test( 'sets collapsed selection within a text', {
  362. data: 'foo<selection />bar',
  363. check( root ) {
  364. expect( root.getChildCount() ).to.equal( 6 );
  365. }
  366. } );
  367. test( 'sets selection attributes', {
  368. data: 'foo<selection bold=true italic=true />bar',
  369. check( root, selection ) {
  370. expect( selection.getAttribute( 'italic' ) ).to.be.true;
  371. }
  372. } );
  373. test( 'sets collapsed selection between text and text with attributes', {
  374. data: 'foo<selection /><$text bold=true>bar</$text>',
  375. check( root, selection ) {
  376. expect( root.getChildCount() ).to.equal( 6 );
  377. expect( selection.getAttribute( 'bold' ) ).to.be.undefined;
  378. }
  379. } );
  380. test( 'sets selection containing an element', {
  381. data: 'x<selection><a></a></selection>'
  382. } );
  383. test( 'sets selection with attribute containing an element', {
  384. data: 'x<selection bold=true><a></a></selection>'
  385. } );
  386. test( 'sets a backward selection containing an element', {
  387. data: 'x<selection backward bold=true><a></a></selection>'
  388. } );
  389. test( 'sets selection within a text', {
  390. data: 'x<selection bold=true>y</selection>z'
  391. } );
  392. test( 'sets selection within a text with different attributes', {
  393. data: '<$text bold=true>fo<selection bold=true>o</$text>ba</selection>r'
  394. } );
  395. it( 'throws when missing selection start', () => {
  396. expect( () => {
  397. parse( 'foo</selection>' );
  398. } ).to.throw( Error, 'Parse error - missing selection start.' );
  399. } );
  400. it( 'throws when missing selection end', () => {
  401. expect( () => {
  402. parse( '<selection>foo' );
  403. } ).to.throw( Error, 'Parse error - missing selection end.' );
  404. } );
  405. } );
  406. function test( title, options ) {
  407. it( title, () => {
  408. const output = options.output || options.data;
  409. const data = parse( options.data );
  410. let model, selection;
  411. if ( data.selection && data.model ) {
  412. model = data.model;
  413. selection = data.selection;
  414. } else {
  415. model = data;
  416. }
  417. expect( stringify( model, selection ) ).to.equal( output );
  418. if ( options.check ) {
  419. options.check( model, selection );
  420. }
  421. } );
  422. }
  423. } );
  424. } );