node.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import Model from '../../src/model/model';
  6. import DocumentFragment from '../../src/model/documentfragment';
  7. import Node from '../../src/model/node';
  8. import Element from '../../src/model/element';
  9. import Text from '../../src/model/text';
  10. import count from '@ckeditor/ckeditor5-utils/src/count';
  11. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  12. describe( 'Node', () => {
  13. let doc, root, node,
  14. one, two, three,
  15. textBA, textR, img;
  16. beforeEach( () => {
  17. const model = new Model();
  18. node = new Node();
  19. one = new Element( 'one' );
  20. two = new Element( 'two', null, [ new Text( 'ba' ), new Element( 'img' ), new Text( 'r' ) ] );
  21. textBA = two.getChild( 0 );
  22. img = two.getChild( 1 );
  23. textR = two.getChild( 2 );
  24. three = new Element( 'three' );
  25. doc = model.document;
  26. root = doc.createRoot();
  27. root._appendChild( [ one, two, three ] );
  28. } );
  29. describe( 'should have a correct property', () => {
  30. it( 'root', () => {
  31. expect( root ).to.have.property( 'root' ).that.equals( root );
  32. expect( one ).to.have.property( 'root' ).that.equals( root );
  33. expect( two ).to.have.property( 'root' ).that.equals( root );
  34. expect( three ).to.have.property( 'root' ).that.equals( root );
  35. expect( textBA ).to.have.property( 'root' ).that.equals( root );
  36. expect( img ).to.have.property( 'root' ).that.equals( root );
  37. expect( textR ).to.have.property( 'root' ).that.equals( root );
  38. expect( node ).to.have.property( 'root' ).that.equals( node );
  39. } );
  40. it( 'nextSibling', () => {
  41. expect( root ).to.have.property( 'nextSibling' ).that.is.null;
  42. expect( one ).to.have.property( 'nextSibling' ).that.equals( two );
  43. expect( two ).to.have.property( 'nextSibling' ).that.equals( three );
  44. expect( three ).to.have.property( 'nextSibling' ).that.is.null;
  45. expect( textBA ).to.have.property( 'nextSibling' ).that.deep.equals( img );
  46. expect( img ).to.have.property( 'nextSibling' ).that.deep.equals( textR );
  47. expect( textR ).to.have.property( 'nextSibling' ).that.is.null;
  48. expect( node ).to.have.property( 'nextSibling' ).that.is.null;
  49. } );
  50. it( 'previousSibling', () => {
  51. expect( root ).to.have.property( 'previousSibling' ).that.is.null;
  52. expect( one ).to.have.property( 'previousSibling' ).that.is.null;
  53. expect( two ).to.have.property( 'previousSibling' ).that.equals( one );
  54. expect( three ).to.have.property( 'previousSibling' ).that.equals( two );
  55. expect( textBA ).to.have.property( 'previousSibling' ).that.is.null;
  56. expect( img ).to.have.property( 'previousSibling' ).that.deep.equals( textBA );
  57. expect( textR ).to.have.property( 'previousSibling' ).that.deep.equals( img );
  58. expect( node ).to.have.property( 'previousSibling' ).that.is.null;
  59. } );
  60. it( 'document', () => {
  61. expect( root ).to.have.property( 'document' ).that.equals( doc );
  62. expect( one ).to.have.property( 'document' ).that.equals( doc );
  63. expect( two ).to.have.property( 'document' ).that.equals( doc );
  64. expect( three ).to.have.property( 'document' ).that.equals( doc );
  65. expect( textBA ).to.have.property( 'document' ).that.equals( doc );
  66. expect( img ).to.have.property( 'document' ).that.equals( doc );
  67. expect( textR ).to.have.property( 'document' ).that.equals( doc );
  68. expect( node ).to.have.property( 'document' ).that.is.null;
  69. // DocumentFragment does not have document property, so node's document property should be null.
  70. const docFrag = new DocumentFragment();
  71. docFrag._appendChild( node );
  72. expect( node ).to.have.property( 'document' ).that.is.null;
  73. } );
  74. } );
  75. describe( 'constructor()', () => {
  76. it( 'should create empty attribute list if no parameters were passed', () => {
  77. expect( count( node.getAttributes() ) ).to.equal( 0 );
  78. } );
  79. it( 'should initialize attribute list with passed attributes', () => {
  80. const foo = new Node( { foo: true, bar: false } );
  81. expect( count( foo.getAttributes() ) ).to.equal( 2 );
  82. expect( foo.getAttribute( 'foo' ) ).to.equal( true );
  83. expect( foo.getAttribute( 'bar' ) ).to.equal( false );
  84. } );
  85. } );
  86. describe( 'getIndex()', () => {
  87. it( 'should return null if the parent is null', () => {
  88. expect( root.index ).to.be.null;
  89. } );
  90. it( 'should return index in the parent', () => {
  91. expect( one.index ).to.equal( 0 );
  92. expect( two.index ).to.equal( 1 );
  93. expect( three.index ).to.equal( 2 );
  94. expect( textBA.index ).to.equal( 0 );
  95. expect( img.index ).to.equal( 1 );
  96. expect( textR.index ).to.equal( 2 );
  97. } );
  98. it( 'should throw an error if parent does not contain element', () => {
  99. node.parent = new Element( 'parent' );
  100. expectToThrowCKEditorError( () => {
  101. node.index;
  102. }, /model-node-not-found-in-parent/, node.parent );
  103. } );
  104. } );
  105. describe( '_clone()', () => {
  106. it( 'should return a copy of cloned node', () => {
  107. const node = new Node( { foo: 'bar' } );
  108. const copy = node._clone();
  109. expect( copy ).not.to.equal( node );
  110. expect( Array.from( copy.getAttributes() ) ).to.deep.equal( Array.from( node.getAttributes() ) );
  111. } );
  112. } );
  113. describe( '_remove()', () => {
  114. it( 'should remove node from it\'s parent', () => {
  115. const element = new Element( 'p' );
  116. element._appendChild( node );
  117. node._remove();
  118. expect( element.childCount ).to.equal( 0 );
  119. expect( node.parent ).to.be.null;
  120. } );
  121. it( 'should throw if node does not have a parent', () => {
  122. expect( () => {
  123. node._remove();
  124. } ).to.throw;
  125. } );
  126. } );
  127. describe( 'is()', () => {
  128. it( 'should return true for node', () => {
  129. expect( node.is( 'node' ) ).to.be.true;
  130. expect( node.is( 'model:node' ) ).to.be.true;
  131. } );
  132. it( 'should return false for incorrect values', () => {
  133. expect( node.is( 'model' ) ).to.be.false;
  134. expect( node.is( 'model:text' ) ).to.be.false;
  135. expect( node.is( 'text' ) ).to.be.false;
  136. expect( node.is( 'element', 'paragraph' ) ).to.be.false;
  137. } );
  138. } );
  139. describe( 'startOffset', () => {
  140. it( 'should return null if the parent is null', () => {
  141. expect( root.startOffset ).to.be.null;
  142. } );
  143. it( 'should return offset in the parent', () => {
  144. expect( one.startOffset ).to.equal( 0 );
  145. expect( two.startOffset ).to.equal( 1 );
  146. expect( three.startOffset ).to.equal( 2 );
  147. expect( textBA.startOffset ).to.equal( 0 );
  148. expect( img.startOffset ).to.equal( 2 );
  149. expect( textR.startOffset ).to.equal( 3 );
  150. } );
  151. it( 'should throw an error if parent does not contain element', () => {
  152. node.parent = new Element( 'parent' );
  153. expectToThrowCKEditorError( () => {
  154. node.startOffset;
  155. }, /model-node-not-found-in-parent/, node.parent );
  156. } );
  157. } );
  158. describe( 'endOffset', () => {
  159. it( 'should return null if the parent is null', () => {
  160. expect( root.endOffset ).to.be.null;
  161. } );
  162. it( 'should return offset at which the node ends', () => {
  163. expect( one.endOffset ).to.equal( 1 );
  164. expect( two.endOffset ).to.equal( 2 );
  165. expect( three.endOffset ).to.equal( 3 );
  166. expect( textBA.endOffset ).to.equal( 2 );
  167. expect( img.endOffset ).to.equal( 3 );
  168. expect( textR.endOffset ).to.equal( 4 );
  169. } );
  170. } );
  171. describe( 'getPath()', () => {
  172. it( 'should return proper path', () => {
  173. expect( root.getPath() ).to.deep.equal( [] );
  174. expect( one.getPath() ).to.deep.equal( [ 0 ] );
  175. expect( two.getPath() ).to.deep.equal( [ 1 ] );
  176. expect( three.getPath() ).to.deep.equal( [ 2 ] );
  177. expect( textBA.getPath() ).to.deep.equal( [ 1, 0 ] );
  178. expect( img.getPath() ).to.deep.equal( [ 1, 2 ] );
  179. expect( textR.getPath() ).to.deep.equal( [ 1, 3 ] );
  180. } );
  181. } );
  182. describe( 'getAncestors()', () => {
  183. it( 'should return proper array of ancestor nodes', () => {
  184. expect( root.getAncestors() ).to.deep.equal( [] );
  185. expect( two.getAncestors() ).to.deep.equal( [ root ] );
  186. expect( textBA.getAncestors() ).to.deep.equal( [ root, two ] );
  187. } );
  188. it( 'should include itself if includeSelf option is set to true', () => {
  189. expect( root.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root ] );
  190. expect( two.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two ] );
  191. expect( textBA.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two, textBA ] );
  192. expect( img.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two, img ] );
  193. expect( textR.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two, textR ] );
  194. } );
  195. it( 'should reverse order if parentFirst option is set to true', () => {
  196. expect( root.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ root ] );
  197. expect( two.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ two, root ] );
  198. expect( textBA.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ textBA, two, root ] );
  199. expect( img.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ img, two, root ] );
  200. expect( textR.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ textR, two, root ] );
  201. } );
  202. } );
  203. describe( 'getCommonAncestor()', () => {
  204. it( 'should return the parent element for the same node', () => {
  205. expect( img.getCommonAncestor( img ) ).to.equal( two );
  206. } );
  207. it( 'should return the given node for the same node if includeSelf is used', () => {
  208. expect( img.getCommonAncestor( img, { includeSelf: true } ) ).to.equal( img );
  209. } );
  210. it( 'should return null for detached subtrees', () => {
  211. const detached = new Element( 'foo' );
  212. expect( img.getCommonAncestor( detached ) ).to.be.null;
  213. expect( detached.getCommonAncestor( img ) ).to.be.null;
  214. expect( img.getCommonAncestor( detached, { includeSelf: true } ) ).to.be.null;
  215. expect( detached.getCommonAncestor( img, { includeSelf: true } ) ).to.be.null;
  216. } );
  217. it( 'should return null when one of the nodes is a tree root itself', () => {
  218. expect( root.getCommonAncestor( img ) ).to.be.null;
  219. expect( img.getCommonAncestor( root ) ).to.be.null;
  220. expect( root.getCommonAncestor( root ) ).to.be.null;
  221. } );
  222. it( 'should return root when one of the nodes is a tree root itself and includeSelf is used', () => {
  223. expect( root.getCommonAncestor( img, { includeSelf: true } ) ).to.equal( root );
  224. expect( img.getCommonAncestor( root, { includeSelf: true } ) ).to.equal( root );
  225. expect( root.getCommonAncestor( root, { includeSelf: true } ) ).to.equal( root );
  226. } );
  227. it( 'should return parent of the nodes at the same level', () => {
  228. expect( img.getCommonAncestor( textBA ), 1 ).to.equal( two );
  229. expect( textR.getCommonAncestor( textBA ), 2 ).to.equal( two );
  230. expect( img.getCommonAncestor( textBA, { includeSelf: true } ), 3 ).to.equal( two );
  231. expect( textR.getCommonAncestor( textBA, { includeSelf: true } ), 4 ).to.equal( two );
  232. } );
  233. it( 'should return proper element for nodes in different branches and on different levels', () => {
  234. const foo = new Text( 'foo' );
  235. const bar = new Text( 'bar' );
  236. const bom = new Text( 'bom' );
  237. const d = new Element( 'd', null, [ bar ] );
  238. const c = new Element( 'c', null, [ foo, d ] );
  239. const b = new Element( 'b', null, [ c ] );
  240. const e = new Element( 'e', null, [ bom ] );
  241. const a = new Element( 'a', null, [ b, e ] );
  242. // <a><b><c>foo<d>bar</d></c></b><e>bom</e></a>
  243. expect( bar.getCommonAncestor( foo ), 1 ).to.equal( c );
  244. expect( foo.getCommonAncestor( d ), 2 ).to.equal( c );
  245. expect( c.getCommonAncestor( b ), 3 ).to.equal( a );
  246. expect( bom.getCommonAncestor( d ), 4 ).to.equal( a );
  247. expect( b.getCommonAncestor( bom ), 5 ).to.equal( a );
  248. expect( b.getCommonAncestor( bar ), 6 ).to.equal( a );
  249. expect( bar.getCommonAncestor( foo, { includeSelf: true } ), 11 ).to.equal( c );
  250. expect( foo.getCommonAncestor( d, { includeSelf: true } ), 12 ).to.equal( c );
  251. expect( c.getCommonAncestor( b, { includeSelf: true } ), 13 ).to.equal( b );
  252. expect( bom.getCommonAncestor( d, { includeSelf: true } ), 14 ).to.equal( a );
  253. expect( b.getCommonAncestor( bom, { includeSelf: true } ), 15 ).to.equal( a );
  254. expect( b.getCommonAncestor( bar, { includeSelf: true } ), 16 ).to.equal( b );
  255. } );
  256. it( 'should return document fragment', () => {
  257. const foo = new Text( 'foo' );
  258. const bar = new Text( 'bar' );
  259. const df = new DocumentFragment( [ foo, bar ] );
  260. expect( foo.getCommonAncestor( bar ) ).to.equal( df );
  261. } );
  262. } );
  263. describe( 'isBefore()', () => {
  264. // Model is: <root><one></one><two>ba<img></img>r</two><three></three>
  265. it( 'should return true if the element is before given element', () => {
  266. expect( one.isBefore( two ) ).to.be.true;
  267. expect( one.isBefore( img ) ).to.be.true;
  268. expect( two.isBefore( textBA ) ).to.be.true;
  269. expect( two.isBefore( textR ) ).to.be.true;
  270. expect( two.isBefore( three ) ).to.be.true;
  271. expect( root.isBefore( one ) ).to.be.true;
  272. } );
  273. it( 'should return false if the element is after given element', () => {
  274. expect( two.isBefore( one ) ).to.be.false;
  275. expect( img.isBefore( one ) ).to.be.false;
  276. expect( textBA.isBefore( two ) ).to.be.false;
  277. expect( textR.isBefore( two ) ).to.be.false;
  278. expect( three.isBefore( two ) ).to.be.false;
  279. expect( one.isBefore( root ) ).to.be.false;
  280. } );
  281. it( 'should return false if the same element is given', () => {
  282. expect( one.isBefore( one ) ).to.be.false;
  283. } );
  284. it( 'should return false if elements are in different roots', () => {
  285. const otherRoot = new Element( 'root' );
  286. const otherElement = new Element( 'element' );
  287. otherRoot._appendChild( otherElement );
  288. expect( otherElement.isBefore( three ) ).to.be.false;
  289. } );
  290. } );
  291. describe( 'isAfter()', () => {
  292. // Model is: <root><one></one><two>ba<img></img>r</two><three></three>
  293. it( 'should return true if the element is after given element', () => {
  294. expect( two.isAfter( one ) ).to.be.true;
  295. expect( img.isAfter( one ) ).to.be.true;
  296. expect( textBA.isAfter( two ) ).to.be.true;
  297. expect( textR.isAfter( two ) ).to.be.true;
  298. expect( three.isAfter( two ) ).to.be.true;
  299. expect( one.isAfter( root ) ).to.be.true;
  300. } );
  301. it( 'should return false if the element is before given element', () => {
  302. expect( one.isAfter( two ) ).to.be.false;
  303. expect( one.isAfter( img ) ).to.be.false;
  304. expect( two.isAfter( textBA ) ).to.be.false;
  305. expect( two.isAfter( textR ) ).to.be.false;
  306. expect( two.isAfter( three ) ).to.be.false;
  307. expect( root.isAfter( one ) ).to.be.false;
  308. } );
  309. it( 'should return false if the same element is given', () => {
  310. expect( one.isAfter( one ) ).to.be.false;
  311. } );
  312. it( 'should return false if elements are in different roots', () => {
  313. const otherRoot = new Element( 'root' );
  314. const otherElement = new Element( 'element' );
  315. otherRoot._appendChild( otherElement );
  316. expect( three.isAfter( otherElement ) ).to.be.false;
  317. } );
  318. } );
  319. describe( 'attributes interface', () => {
  320. const node = new Node( { foo: 'bar' } );
  321. describe( 'hasAttribute', () => {
  322. it( 'should return true if element contains attribute with given key', () => {
  323. expect( node.hasAttribute( 'foo' ) ).to.be.true;
  324. } );
  325. it( 'should return false if element does not contain attribute with given key', () => {
  326. expect( node.hasAttribute( 'bar' ) ).to.be.false;
  327. } );
  328. } );
  329. describe( 'getAttribute', () => {
  330. it( 'should return attribute value for given key if element contains given attribute', () => {
  331. expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' );
  332. } );
  333. it( 'should return undefined if element does not contain given attribute', () => {
  334. expect( node.getAttribute( 'bar' ) ).to.be.undefined;
  335. } );
  336. } );
  337. describe( 'getAttributes', () => {
  338. it( 'should return an iterator that iterates over all attributes set on the element', () => {
  339. expect( Array.from( node.getAttributes() ) ).to.deep.equal( [ [ 'foo', 'bar' ] ] );
  340. } );
  341. } );
  342. describe( '_setAttribute', () => {
  343. it( 'should set given attribute on the element', () => {
  344. node._setAttribute( 'foo', 'bar' );
  345. expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' );
  346. } );
  347. } );
  348. describe( '_setAttributesTo', () => {
  349. it( 'should remove all attributes set on element and set the given ones', () => {
  350. node._setAttribute( 'abc', 'xyz' );
  351. node._setAttributesTo( { foo: 'bar' } );
  352. expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' );
  353. expect( node.getAttribute( 'abc' ) ).to.be.undefined;
  354. } );
  355. } );
  356. describe( '_removeAttribute', () => {
  357. it( 'should remove attribute set on the element and return true', () => {
  358. node._setAttribute( 'foo', 'bar' );
  359. const result = node._removeAttribute( 'foo' );
  360. expect( node.getAttribute( 'foo' ) ).to.be.undefined;
  361. expect( result ).to.be.true;
  362. } );
  363. it( 'should return false if element does not contain given attribute', () => {
  364. const result = node._removeAttribute( 'foo' );
  365. expect( result ).to.be.false;
  366. } );
  367. } );
  368. describe( '_clearAttributes', () => {
  369. it( 'should remove all attributes from the element', () => {
  370. node._setAttribute( 'foo', 'bar' );
  371. node._setAttribute( 'abc', 'xyz' );
  372. node._clearAttributes();
  373. expect( node.getAttribute( 'foo' ) ).to.be.undefined;
  374. expect( node.getAttribute( 'abc' ) ).to.be.undefined;
  375. } );
  376. } );
  377. } );
  378. } );