model.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  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( 'main', '$root' );
  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. } );
  42. describe( 'setData', () => {
  43. it( 'should use parse method', () => {
  44. const parseSpy = sandbox.spy( setData, '_parse' );
  45. const options = {};
  46. const data = '<b>btext</b>text';
  47. setData( document, data, options );
  48. expect( getData( document, { withoutSelection: true } ) ).to.equal( data );
  49. sinon.assert.calledOnce( parseSpy );
  50. const args = parseSpy.firstCall.args;
  51. expect( args[ 0 ] ).to.equal( data );
  52. } );
  53. it( 'should use parse method with selection', () => {
  54. const parseSpy = sandbox.spy( setData, '_parse' );
  55. const options = {};
  56. const data = '<selection><b>btext</b></selection>';
  57. setData( document, data, options );
  58. expect( getData( document ) ).to.equal( data );
  59. sinon.assert.calledOnce( parseSpy );
  60. const args = parseSpy.firstCall.args;
  61. expect( args[ 0 ] ).to.equal( data );
  62. } );
  63. } );
  64. describe( 'stringify', () => {
  65. it( 'should stringify text', () => {
  66. const text = new Text( 'text', { underline: true, bold: true } );
  67. expect( stringify( text ) ).to.equal( '<$text bold=true underline=true>text</$text>' );
  68. } );
  69. it( 'should stringify element', () => {
  70. const element = new Element( 'a', null, [ new Element( 'b', null, 'btext' ), 'atext' ] );
  71. expect( stringify( element ) ).to.equal( '<a><b>btext</b>atext</a>' );
  72. } );
  73. it( 'should stringify document fragment', () => {
  74. const fragment = new DocumentFragment( [ new Element( 'b', null, 'btext' ), 'atext' ] );
  75. expect( stringify( fragment ) ).to.equal( '<b>btext</b>atext' );
  76. } );
  77. it( 'writes elements and texts', () => {
  78. root.appendChildren( [
  79. new Element( 'a', null, 'atext' ),
  80. new Element( 'b', null, [
  81. new Element( 'c1' ),
  82. 'ctext',
  83. new Element( 'c2' )
  84. ] ),
  85. new Element( 'd' )
  86. ] );
  87. expect( stringify( root ) ).to.equal(
  88. '<a>atext</a><b><c1></c1>ctext<c2></c2></b><d></d>'
  89. );
  90. } );
  91. it( 'writes element attributes', () => {
  92. root.appendChildren(
  93. new Element( 'a', { foo: true, bar: 1, car: false }, [
  94. new Element( 'b', { fooBar: 'x y', barFoo: { x: 1, y: 2 } } )
  95. ] )
  96. );
  97. // Note: attributes are written in a very simplistic way, because they are not to be parsed. They are just
  98. // to be compared in the tests with some patterns.
  99. expect( stringify( root ) ).to.equal(
  100. '<a bar=1 car=false foo=true><b barFoo={"x":1,"y":2} fooBar="x y"></b></a>'
  101. );
  102. } );
  103. it( 'writes text attributes', () => {
  104. root.appendChildren( [
  105. new Text( 'foo', { bold: true } ),
  106. 'bar',
  107. new Text( 'bom', { bold: true, italic: true } ),
  108. new Element( 'a', null, [
  109. new Text( 'pom', { underline: true, bold: true } )
  110. ] )
  111. ] );
  112. expect( stringify( root ) ).to.equal(
  113. '<$text bold=true>foo</$text>' +
  114. 'bar' +
  115. '<$text bold=true italic=true>bom</$text>' +
  116. '<a><$text bold=true underline=true>pom</$text></a>'
  117. );
  118. } );
  119. describe( 'selection', () => {
  120. let elA, elB;
  121. beforeEach( () => {
  122. elA = new Element( 'a' );
  123. elB = new Element( 'b' );
  124. root.appendChildren( [
  125. elA,
  126. 'foo',
  127. new Text( 'bar', { bold: true } ),
  128. elB
  129. ] );
  130. } );
  131. it( 'writes selection in an empty root', () => {
  132. const root = document.createRoot( 'empty', '$root' );
  133. selection.collapse( root );
  134. expect( stringify( root, selection ) ).to.equal(
  135. '<selection />'
  136. );
  137. } );
  138. it( 'writes selection collapsed in an element', () => {
  139. selection.collapse( root );
  140. expect( stringify( root, selection ) ).to.equal(
  141. '<selection /><a></a>foo<$text bold=true>bar</$text><b></b>'
  142. );
  143. } );
  144. it( 'writes selection collapsed in a text', () => {
  145. selection.collapse( root, 3 );
  146. expect( stringify( root, selection ) ).to.equal(
  147. '<a></a>fo<selection />o<$text bold=true>bar</$text><b></b>'
  148. );
  149. } );
  150. it( 'writes selection collapsed at the text left boundary', () => {
  151. selection.collapse( elA, 'AFTER' );
  152. expect( stringify( root, selection ) ).to.equal(
  153. '<a></a><selection />foo<$text bold=true>bar</$text><b></b>'
  154. );
  155. } );
  156. it( 'writes selection collapsed at the text right boundary', () => {
  157. selection.collapse( elB, 'BEFORE' );
  158. expect( stringify( root, selection ) ).to.equal(
  159. '<a></a>foo<$text bold=true>bar</$text><selection bold=true /><b></b>'
  160. );
  161. } );
  162. it( 'writes selection collapsed at the end of the root', () => {
  163. selection.collapse( root, 'END' );
  164. // Needed due to https://github.com/ckeditor/ckeditor5-engine/issues/320.
  165. selection.clearAttributes();
  166. expect( stringify( root, selection ) ).to.equal(
  167. '<a></a>foo<$text bold=true>bar</$text><b></b><selection />'
  168. );
  169. } );
  170. it( 'writes selection attributes', () => {
  171. selection.collapse( root );
  172. selection.setAttributesTo( { italic: true, bold: true } );
  173. expect( stringify( root, selection ) ).to.equal(
  174. '<selection bold=true italic=true /><a></a>foo<$text bold=true>bar</$text><b></b>'
  175. );
  176. } );
  177. it( 'writes selection collapsed selection in a text with attributes', () => {
  178. selection.collapse( root, 5 );
  179. expect( stringify( root, selection ) ).to.equal(
  180. '<a></a>foo<$text bold=true>b<selection bold=true />ar</$text><b></b>'
  181. );
  182. } );
  183. it( 'writes flat selection containing couple of nodes', () => {
  184. selection.addRange(
  185. Range.createFromParentsAndOffsets( root, 0, root, 4 )
  186. );
  187. expect( stringify( root, selection ) ).to.equal(
  188. '<selection><a></a>foo</selection><$text bold=true>bar</$text><b></b>'
  189. );
  190. } );
  191. it( 'writes flat selection within text', () => {
  192. selection.addRange(
  193. Range.createFromParentsAndOffsets( root, 2, root, 3 )
  194. );
  195. expect( stringify( root, selection ) ).to.equal(
  196. '<a></a>f<selection>o</selection>o<$text bold=true>bar</$text><b></b>'
  197. );
  198. } );
  199. it( 'writes multi-level selection', () => {
  200. selection.addRange(
  201. Range.createFromParentsAndOffsets( elA, 0, elB, 0 )
  202. );
  203. expect( stringify( root, selection ) ).to.equal(
  204. '<a><selection></a>foo<$text bold=true>bar</$text><b></selection></b>'
  205. );
  206. } );
  207. it( 'writes backward selection', () => {
  208. selection.addRange(
  209. Range.createFromParentsAndOffsets( elA, 0, elB, 0 ),
  210. true
  211. );
  212. expect( stringify( root, selection ) ).to.equal(
  213. '<a><selection backward></a>foo<$text bold=true>bar</$text><b></selection></b>'
  214. );
  215. } );
  216. it( 'uses range and coverts it to selection', () => {
  217. const range = Range.createFromParentsAndOffsets( elA, 0, elB, 0 );
  218. expect( stringify( root, range ) ).to.equal(
  219. '<a><selection></a>foo<$text bold=true>bar</$text><b></selection></b>'
  220. );
  221. } );
  222. it( 'uses position and converts it to collapsed selection', () => {
  223. const position = new Position( root, [ 0 ] );
  224. expect( stringify( root, position ) ).to.equal(
  225. '<selection /><a></a>foo<$text bold=true>bar</$text><b></b>'
  226. );
  227. } );
  228. } );
  229. } );
  230. describe( 'parse', () => {
  231. test( 'creates elements', {
  232. data: '<a></a><b><c></c></b>'
  233. } );
  234. test( 'creates text nodes', {
  235. data: 'foo<a>bar</a>bom'
  236. } );
  237. test( 'sets elements attributes', {
  238. data: '<a foo=1 bar=true car="x y"><b x="y"></b></a>',
  239. output: '<a bar=true car="x y" foo=1><b x="y"></b></a>',
  240. check( root ) {
  241. expect( root.getChild( 0 ).getAttribute( 'car' ) ).to.equal( 'x y' );
  242. }
  243. } );
  244. test( 'sets complex attributes', {
  245. data: '<a foo={"a":1,"b":"c"}></a>',
  246. check( root ) {
  247. expect( root.getChild( 0 ).getAttribute( 'foo' ) ).to.have.property( 'a', 1 );
  248. }
  249. } );
  250. test( 'sets text attributes', {
  251. data: '<$text bold=true italic=true>foo</$text><$text bold=true>bar</$text>bom',
  252. check( root ) {
  253. expect( root.getChildCount() ).to.equal( 9 );
  254. expect( root.getChild( 0 ) ).to.have.property( 'character', 'f' );
  255. expect( root.getChild( 0 ).getAttribute( 'italic' ) ).to.equal( true );
  256. }
  257. } );
  258. it( 'throws when unexpected closing tag', () => {
  259. expect( () => {
  260. parse( '<a><b></a></b>' );
  261. } ).to.throw( Error, 'Parse error - unexpected closing tag.' );
  262. } );
  263. it( 'throws when unexpected attribute', () => {
  264. expect( () => {
  265. parse( '<a ?></a>' );
  266. } ).to.throw( Error, 'Parse error - unexpected token: ?.' );
  267. } );
  268. it( 'throws when incorrect tag', () => {
  269. expect( () => {
  270. parse( '<a' );
  271. } ).to.throw( Error, 'Parse error - unexpected token: <a.' );
  272. } );
  273. it( 'throws when missing closing tag', () => {
  274. expect( () => {
  275. parse( '<a><b></b>' );
  276. } ).to.throw( Error, 'Parse error - missing closing tags: a.' );
  277. } );
  278. it( 'throws when missing opening tag for text', () => {
  279. expect( () => {
  280. parse( '</$text>' );
  281. } ).to.throw( Error, 'Parse error - unexpected closing tag.' );
  282. } );
  283. it( 'throws when missing closing tag for text', () => {
  284. expect( () => {
  285. parse( '<$text>' );
  286. } ).to.throw( Error, 'Parse error - missing closing tags: $text.' );
  287. } );
  288. describe( 'selection', () => {
  289. test( 'sets collapsed selection in an element', {
  290. data: '<a><selection /></a>',
  291. check( root, selection ) {
  292. expect( selection.getFirstPosition().parent ).to.have.property( 'name', 'a' );
  293. }
  294. } );
  295. test( 'sets collapsed selection between elements', {
  296. data: '<a></a><selection /><b></b>'
  297. } );
  298. test( 'sets collapsed selection before a text', {
  299. data: '<a></a><selection />foo'
  300. } );
  301. test( 'sets collapsed selection after a text', {
  302. data: 'foo<selection />'
  303. } );
  304. test( 'sets collapsed selection within a text', {
  305. data: 'foo<selection />bar',
  306. check( root ) {
  307. expect( root.getChildCount() ).to.equal( 6 );
  308. }
  309. } );
  310. test( 'sets selection attributes', {
  311. data: 'foo<selection bold=true italic=true />bar',
  312. check( root, selection ) {
  313. expect( selection.getAttribute( 'italic' ) ).to.be.true;
  314. }
  315. } );
  316. test( 'sets collapsed selection between text and text with attributes', {
  317. data: 'foo<selection /><$text bold=true>bar</$text>',
  318. check( root, selection ) {
  319. expect( root.getChildCount() ).to.equal( 6 );
  320. expect( selection.getAttribute( 'bold' ) ).to.be.undefined;
  321. }
  322. } );
  323. test( 'sets selection containing an element', {
  324. data: 'x<selection><a></a></selection>'
  325. } );
  326. test( 'sets selection with attribute containing an element', {
  327. data: 'x<selection bold=true><a></a></selection>'
  328. } );
  329. test( 'sets a backward selection containing an element', {
  330. data: 'x<selection backward bold=true><a></a></selection>'
  331. } );
  332. test( 'sets selection within a text', {
  333. data: 'x<selection bold=true>y</selection>z'
  334. } );
  335. test( 'sets selection within a text with different attributes', {
  336. data: '<$text bold=true>fo<selection bold=true>o</$text>ba</selection>r'
  337. } );
  338. it( 'throws when missing selection start', () => {
  339. expect( () => {
  340. parse( 'foo</selection>' );
  341. } ).to.throw( Error, 'Parse error - missing selection start.' );
  342. } );
  343. it( 'throws when missing selection end', () => {
  344. expect( () => {
  345. parse( '<selection>foo' );
  346. } ).to.throw( Error, 'Parse error - missing selection end.' );
  347. } );
  348. } );
  349. function test( title, options ) {
  350. it( title, () => {
  351. const output = options.output || options.data;
  352. const data = parse( options.data );
  353. let model, selection;
  354. if ( data.selection && data.model ) {
  355. model = data.model;
  356. selection = data.selection;
  357. } else {
  358. model = data;
  359. }
  360. expect( stringify( model, selection ) ).to.equal( output );
  361. if ( options.check ) {
  362. options.check( model, selection );
  363. }
  364. } );
  365. }
  366. } );
  367. } );