node.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  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 CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  11. import count from '@ckeditor/ckeditor5-utils/src/count';
  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. expect(
  101. () => {
  102. node.index;
  103. }
  104. ).to.throw( CKEditorError, /model-node-not-found-in-parent/ );
  105. } );
  106. } );
  107. describe( '_clone()', () => {
  108. it( 'should return a copy of cloned node', () => {
  109. const node = new Node( { foo: 'bar' } );
  110. const copy = node._clone();
  111. expect( copy ).not.to.equal( node );
  112. expect( Array.from( copy.getAttributes() ) ).to.deep.equal( Array.from( node.getAttributes() ) );
  113. } );
  114. } );
  115. describe( '_remove()', () => {
  116. it( 'should remove node from it\'s parent', () => {
  117. const element = new Element( 'p' );
  118. element._appendChild( node );
  119. node._remove();
  120. expect( element.childCount ).to.equal( 0 );
  121. expect( node.parent ).to.be.null;
  122. } );
  123. it( 'should throw if node does not have a parent', () => {
  124. expect( () => {
  125. node._remove();
  126. } ).to.throw;
  127. } );
  128. } );
  129. describe( 'is()', () => {
  130. it( 'should return true for node', () => {
  131. expect( node.is( 'node' ) ).to.be.true;
  132. } );
  133. } );
  134. describe( 'startOffset', () => {
  135. it( 'should return null if the parent is null', () => {
  136. expect( root.startOffset ).to.be.null;
  137. } );
  138. it( 'should return offset in the parent', () => {
  139. expect( one.startOffset ).to.equal( 0 );
  140. expect( two.startOffset ).to.equal( 1 );
  141. expect( three.startOffset ).to.equal( 2 );
  142. expect( textBA.startOffset ).to.equal( 0 );
  143. expect( img.startOffset ).to.equal( 2 );
  144. expect( textR.startOffset ).to.equal( 3 );
  145. } );
  146. it( 'should throw an error if parent does not contain element', () => {
  147. node.parent = new Element( 'parent' );
  148. expect(
  149. () => {
  150. node.startOffset;
  151. }
  152. ).to.throw( CKEditorError, /model-node-not-found-in-parent/ );
  153. } );
  154. } );
  155. describe( 'endOffset', () => {
  156. it( 'should return null if the parent is null', () => {
  157. expect( root.endOffset ).to.be.null;
  158. } );
  159. it( 'should return offset at which the node ends', () => {
  160. expect( one.endOffset ).to.equal( 1 );
  161. expect( two.endOffset ).to.equal( 2 );
  162. expect( three.endOffset ).to.equal( 3 );
  163. expect( textBA.endOffset ).to.equal( 2 );
  164. expect( img.endOffset ).to.equal( 3 );
  165. expect( textR.endOffset ).to.equal( 4 );
  166. } );
  167. } );
  168. describe( 'getPath()', () => {
  169. it( 'should return proper path', () => {
  170. expect( root.getPath() ).to.deep.equal( [] );
  171. expect( one.getPath() ).to.deep.equal( [ 0 ] );
  172. expect( two.getPath() ).to.deep.equal( [ 1 ] );
  173. expect( three.getPath() ).to.deep.equal( [ 2 ] );
  174. expect( textBA.getPath() ).to.deep.equal( [ 1, 0 ] );
  175. expect( img.getPath() ).to.deep.equal( [ 1, 2 ] );
  176. expect( textR.getPath() ).to.deep.equal( [ 1, 3 ] );
  177. } );
  178. } );
  179. describe( 'getAncestors()', () => {
  180. it( 'should return proper array of ancestor nodes', () => {
  181. expect( root.getAncestors() ).to.deep.equal( [] );
  182. expect( two.getAncestors() ).to.deep.equal( [ root ] );
  183. expect( textBA.getAncestors() ).to.deep.equal( [ root, two ] );
  184. } );
  185. it( 'should include itself if includeSelf option is set to true', () => {
  186. expect( root.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root ] );
  187. expect( two.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two ] );
  188. expect( textBA.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two, textBA ] );
  189. expect( img.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two, img ] );
  190. expect( textR.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two, textR ] );
  191. } );
  192. it( 'should reverse order if parentFirst option is set to true', () => {
  193. expect( root.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ root ] );
  194. expect( two.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ two, root ] );
  195. expect( textBA.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ textBA, two, root ] );
  196. expect( img.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ img, two, root ] );
  197. expect( textR.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ textR, two, root ] );
  198. } );
  199. } );
  200. describe( 'getCommonAncestor()', () => {
  201. it( 'should return the parent element for the same node', () => {
  202. expect( img.getCommonAncestor( img ) ).to.equal( two );
  203. } );
  204. it( 'should return the given node for the same node if includeSelf is used', () => {
  205. expect( img.getCommonAncestor( img, { includeSelf: true } ) ).to.equal( img );
  206. } );
  207. it( 'should return null for detached subtrees', () => {
  208. const detached = new Element( 'foo' );
  209. expect( img.getCommonAncestor( detached ) ).to.be.null;
  210. expect( detached.getCommonAncestor( img ) ).to.be.null;
  211. expect( img.getCommonAncestor( detached, { includeSelf: true } ) ).to.be.null;
  212. expect( detached.getCommonAncestor( img, { includeSelf: true } ) ).to.be.null;
  213. } );
  214. it( 'should return null when one of the nodes is a tree root itself', () => {
  215. expect( root.getCommonAncestor( img ) ).to.be.null;
  216. expect( img.getCommonAncestor( root ) ).to.be.null;
  217. expect( root.getCommonAncestor( root ) ).to.be.null;
  218. } );
  219. it( 'should return root when one of the nodes is a tree root itself and includeSelf is used', () => {
  220. expect( root.getCommonAncestor( img, { includeSelf: true } ) ).to.equal( root );
  221. expect( img.getCommonAncestor( root, { includeSelf: true } ) ).to.equal( root );
  222. expect( root.getCommonAncestor( root, { includeSelf: true } ) ).to.equal( root );
  223. } );
  224. it( 'should return parent of the nodes at the same level', () => {
  225. expect( img.getCommonAncestor( textBA ), 1 ).to.equal( two );
  226. expect( textR.getCommonAncestor( textBA ), 2 ).to.equal( two );
  227. expect( img.getCommonAncestor( textBA, { includeSelf: true } ), 3 ).to.equal( two );
  228. expect( textR.getCommonAncestor( textBA, { includeSelf: true } ), 4 ).to.equal( two );
  229. } );
  230. it( 'should return proper element for nodes in different branches and on different levels', () => {
  231. const foo = new Text( 'foo' );
  232. const bar = new Text( 'bar' );
  233. const bom = new Text( 'bom' );
  234. const d = new Element( 'd', null, [ bar ] );
  235. const c = new Element( 'c', null, [ foo, d ] );
  236. const b = new Element( 'b', null, [ c ] );
  237. const e = new Element( 'e', null, [ bom ] );
  238. const a = new Element( 'a', null, [ b, e ] );
  239. // <a><b><c>foo<d>bar</d></c></b><e>bom</e></a>
  240. expect( bar.getCommonAncestor( foo ), 1 ).to.equal( c );
  241. expect( foo.getCommonAncestor( d ), 2 ).to.equal( c );
  242. expect( c.getCommonAncestor( b ), 3 ).to.equal( a );
  243. expect( bom.getCommonAncestor( d ), 4 ).to.equal( a );
  244. expect( b.getCommonAncestor( bom ), 5 ).to.equal( a );
  245. expect( b.getCommonAncestor( bar ), 6 ).to.equal( a );
  246. expect( bar.getCommonAncestor( foo, { includeSelf: true } ), 11 ).to.equal( c );
  247. expect( foo.getCommonAncestor( d, { includeSelf: true } ), 12 ).to.equal( c );
  248. expect( c.getCommonAncestor( b, { includeSelf: true } ), 13 ).to.equal( b );
  249. expect( bom.getCommonAncestor( d, { includeSelf: true } ), 14 ).to.equal( a );
  250. expect( b.getCommonAncestor( bom, { includeSelf: true } ), 15 ).to.equal( a );
  251. expect( b.getCommonAncestor( bar, { includeSelf: true } ), 16 ).to.equal( b );
  252. } );
  253. it( 'should return document fragment', () => {
  254. const foo = new Text( 'foo' );
  255. const bar = new Text( 'bar' );
  256. const df = new DocumentFragment( [ foo, bar ] );
  257. expect( foo.getCommonAncestor( bar ) ).to.equal( df );
  258. } );
  259. } );
  260. describe( 'isBefore()', () => {
  261. // Model is: <root><one></one><two>ba<img></img>r</two><three></three>
  262. it( 'should return true if the element is before given element', () => {
  263. expect( one.isBefore( two ) ).to.be.true;
  264. expect( one.isBefore( img ) ).to.be.true;
  265. expect( two.isBefore( textBA ) ).to.be.true;
  266. expect( two.isBefore( textR ) ).to.be.true;
  267. expect( two.isBefore( three ) ).to.be.true;
  268. expect( root.isBefore( one ) ).to.be.true;
  269. } );
  270. it( 'should return false if the element is after given element', () => {
  271. expect( two.isBefore( one ) ).to.be.false;
  272. expect( img.isBefore( one ) ).to.be.false;
  273. expect( textBA.isBefore( two ) ).to.be.false;
  274. expect( textR.isBefore( two ) ).to.be.false;
  275. expect( three.isBefore( two ) ).to.be.false;
  276. expect( one.isBefore( root ) ).to.be.false;
  277. } );
  278. it( 'should return false if the same element is given', () => {
  279. expect( one.isBefore( one ) ).to.be.false;
  280. } );
  281. it( 'should return false if elements are in different roots', () => {
  282. const otherRoot = new Element( 'root' );
  283. const otherElement = new Element( 'element' );
  284. otherRoot._appendChild( otherElement );
  285. expect( otherElement.isBefore( three ) ).to.be.false;
  286. } );
  287. } );
  288. describe( 'isAfter()', () => {
  289. // Model is: <root><one></one><two>ba<img></img>r</two><three></three>
  290. it( 'should return true if the element is after given element', () => {
  291. expect( two.isAfter( one ) ).to.be.true;
  292. expect( img.isAfter( one ) ).to.be.true;
  293. expect( textBA.isAfter( two ) ).to.be.true;
  294. expect( textR.isAfter( two ) ).to.be.true;
  295. expect( three.isAfter( two ) ).to.be.true;
  296. expect( one.isAfter( root ) ).to.be.true;
  297. } );
  298. it( 'should return false if the element is before given element', () => {
  299. expect( one.isAfter( two ) ).to.be.false;
  300. expect( one.isAfter( img ) ).to.be.false;
  301. expect( two.isAfter( textBA ) ).to.be.false;
  302. expect( two.isAfter( textR ) ).to.be.false;
  303. expect( two.isAfter( three ) ).to.be.false;
  304. expect( root.isAfter( one ) ).to.be.false;
  305. } );
  306. it( 'should return false if the same element is given', () => {
  307. expect( one.isAfter( one ) ).to.be.false;
  308. } );
  309. it( 'should return false if elements are in different roots', () => {
  310. const otherRoot = new Element( 'root' );
  311. const otherElement = new Element( 'element' );
  312. otherRoot._appendChild( otherElement );
  313. expect( three.isAfter( otherElement ) ).to.be.false;
  314. } );
  315. } );
  316. describe( 'attributes interface', () => {
  317. const node = new Node( { foo: 'bar' } );
  318. describe( 'hasAttribute', () => {
  319. it( 'should return true if element contains attribute with given key', () => {
  320. expect( node.hasAttribute( 'foo' ) ).to.be.true;
  321. } );
  322. it( 'should return false if element does not contain attribute with given key', () => {
  323. expect( node.hasAttribute( 'bar' ) ).to.be.false;
  324. } );
  325. } );
  326. describe( 'getAttribute', () => {
  327. it( 'should return attribute value for given key if element contains given attribute', () => {
  328. expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' );
  329. } );
  330. it( 'should return undefined if element does not contain given attribute', () => {
  331. expect( node.getAttribute( 'bar' ) ).to.be.undefined;
  332. } );
  333. } );
  334. describe( 'getAttributes', () => {
  335. it( 'should return an iterator that iterates over all attributes set on the element', () => {
  336. expect( Array.from( node.getAttributes() ) ).to.deep.equal( [ [ 'foo', 'bar' ] ] );
  337. } );
  338. } );
  339. describe( '_setAttribute', () => {
  340. it( 'should set given attribute on the element', () => {
  341. node._setAttribute( 'foo', 'bar' );
  342. expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' );
  343. } );
  344. } );
  345. describe( '_setAttributesTo', () => {
  346. it( 'should remove all attributes set on element and set the given ones', () => {
  347. node._setAttribute( 'abc', 'xyz' );
  348. node._setAttributesTo( { foo: 'bar' } );
  349. expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' );
  350. expect( node.getAttribute( 'abc' ) ).to.be.undefined;
  351. } );
  352. } );
  353. describe( '_removeAttribute', () => {
  354. it( 'should remove attribute set on the element and return true', () => {
  355. node._setAttribute( 'foo', 'bar' );
  356. const result = node._removeAttribute( 'foo' );
  357. expect( node.getAttribute( 'foo' ) ).to.be.undefined;
  358. expect( result ).to.be.true;
  359. } );
  360. it( 'should return false if element does not contain given attribute', () => {
  361. const result = node._removeAttribute( 'foo' );
  362. expect( result ).to.be.false;
  363. } );
  364. } );
  365. describe( '_clearAttributes', () => {
  366. it( 'should remove all attributes from the element', () => {
  367. node._setAttribute( 'foo', 'bar' );
  368. node._setAttribute( 'abc', 'xyz' );
  369. node._clearAttributes();
  370. expect( node.getAttribute( 'foo' ) ).to.be.undefined;
  371. expect( node.getAttribute( 'abc' ) ).to.be.undefined;
  372. } );
  373. } );
  374. } );
  375. } );