node.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  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._appendChildren( [ 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._appendChildren( 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._appendChildren( 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( 'startOffset', () => {
  130. it( 'should return null if the parent is null', () => {
  131. expect( root.startOffset ).to.be.null;
  132. } );
  133. it( 'should return offset in the parent', () => {
  134. expect( one.startOffset ).to.equal( 0 );
  135. expect( two.startOffset ).to.equal( 1 );
  136. expect( three.startOffset ).to.equal( 2 );
  137. expect( textBA.startOffset ).to.equal( 0 );
  138. expect( img.startOffset ).to.equal( 2 );
  139. expect( textR.startOffset ).to.equal( 3 );
  140. } );
  141. it( 'should throw an error if parent does not contain element', () => {
  142. node.parent = new Element( 'parent' );
  143. expect(
  144. () => {
  145. node.startOffset;
  146. }
  147. ).to.throw( CKEditorError, /model-node-not-found-in-parent/ );
  148. } );
  149. } );
  150. describe( 'endOffset', () => {
  151. it( 'should return null if the parent is null', () => {
  152. expect( root.endOffset ).to.be.null;
  153. } );
  154. it( 'should return offset at which the node ends', () => {
  155. expect( one.endOffset ).to.equal( 1 );
  156. expect( two.endOffset ).to.equal( 2 );
  157. expect( three.endOffset ).to.equal( 3 );
  158. expect( textBA.endOffset ).to.equal( 2 );
  159. expect( img.endOffset ).to.equal( 3 );
  160. expect( textR.endOffset ).to.equal( 4 );
  161. } );
  162. } );
  163. describe( 'getPath()', () => {
  164. it( 'should return proper path', () => {
  165. expect( root.getPath() ).to.deep.equal( [] );
  166. expect( one.getPath() ).to.deep.equal( [ 0 ] );
  167. expect( two.getPath() ).to.deep.equal( [ 1 ] );
  168. expect( three.getPath() ).to.deep.equal( [ 2 ] );
  169. expect( textBA.getPath() ).to.deep.equal( [ 1, 0 ] );
  170. expect( img.getPath() ).to.deep.equal( [ 1, 2 ] );
  171. expect( textR.getPath() ).to.deep.equal( [ 1, 3 ] );
  172. } );
  173. } );
  174. describe( 'getAncestors()', () => {
  175. it( 'should return proper array of ancestor nodes', () => {
  176. expect( root.getAncestors() ).to.deep.equal( [] );
  177. expect( two.getAncestors() ).to.deep.equal( [ root ] );
  178. expect( textBA.getAncestors() ).to.deep.equal( [ root, two ] );
  179. } );
  180. it( 'should include itself if includeSelf option is set to true', () => {
  181. expect( root.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root ] );
  182. expect( two.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two ] );
  183. expect( textBA.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two, textBA ] );
  184. expect( img.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two, img ] );
  185. expect( textR.getAncestors( { includeSelf: true } ) ).to.deep.equal( [ root, two, textR ] );
  186. } );
  187. it( 'should reverse order if parentFirst option is set to true', () => {
  188. expect( root.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ root ] );
  189. expect( two.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ two, root ] );
  190. expect( textBA.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ textBA, two, root ] );
  191. expect( img.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ img, two, root ] );
  192. expect( textR.getAncestors( { includeSelf: true, parentFirst: true } ) ).to.deep.equal( [ textR, two, root ] );
  193. } );
  194. } );
  195. describe( 'getCommonAncestor()', () => {
  196. it( 'should return the parent element for the same node', () => {
  197. expect( img.getCommonAncestor( img ) ).to.equal( two );
  198. } );
  199. it( 'should return the given node for the same node if includeSelf is used', () => {
  200. expect( img.getCommonAncestor( img, { includeSelf: true } ) ).to.equal( img );
  201. } );
  202. it( 'should return null for detached subtrees', () => {
  203. const detached = new Element( 'foo' );
  204. expect( img.getCommonAncestor( detached ) ).to.be.null;
  205. expect( detached.getCommonAncestor( img ) ).to.be.null;
  206. expect( img.getCommonAncestor( detached, { includeSelf: true } ) ).to.be.null;
  207. expect( detached.getCommonAncestor( img, { includeSelf: true } ) ).to.be.null;
  208. } );
  209. it( 'should return null when one of the nodes is a tree root itself', () => {
  210. expect( root.getCommonAncestor( img ) ).to.be.null;
  211. expect( img.getCommonAncestor( root ) ).to.be.null;
  212. expect( root.getCommonAncestor( root ) ).to.be.null;
  213. } );
  214. it( 'should return root when one of the nodes is a tree root itself and includeSelf is used', () => {
  215. expect( root.getCommonAncestor( img, { includeSelf: true } ) ).to.equal( root );
  216. expect( img.getCommonAncestor( root, { includeSelf: true } ) ).to.equal( root );
  217. expect( root.getCommonAncestor( root, { includeSelf: true } ) ).to.equal( root );
  218. } );
  219. it( 'should return parent of the nodes at the same level', () => {
  220. expect( img.getCommonAncestor( textBA ), 1 ).to.equal( two );
  221. expect( textR.getCommonAncestor( textBA ), 2 ).to.equal( two );
  222. expect( img.getCommonAncestor( textBA, { includeSelf: true } ), 3 ).to.equal( two );
  223. expect( textR.getCommonAncestor( textBA, { includeSelf: true } ), 4 ).to.equal( two );
  224. } );
  225. it( 'should return proper element for nodes in different branches and on different levels', () => {
  226. const foo = new Text( 'foo' );
  227. const bar = new Text( 'bar' );
  228. const bom = new Text( 'bom' );
  229. const d = new Element( 'd', null, [ bar ] );
  230. const c = new Element( 'c', null, [ foo, d ] );
  231. const b = new Element( 'b', null, [ c ] );
  232. const e = new Element( 'e', null, [ bom ] );
  233. const a = new Element( 'a', null, [ b, e ] );
  234. // <a><b><c>foo<d>bar</d></c></b><e>bom</e></a>
  235. expect( bar.getCommonAncestor( foo ), 1 ).to.equal( c );
  236. expect( foo.getCommonAncestor( d ), 2 ).to.equal( c );
  237. expect( c.getCommonAncestor( b ), 3 ).to.equal( a );
  238. expect( bom.getCommonAncestor( d ), 4 ).to.equal( a );
  239. expect( b.getCommonAncestor( bom ), 5 ).to.equal( a );
  240. expect( b.getCommonAncestor( bar ), 6 ).to.equal( a );
  241. expect( bar.getCommonAncestor( foo, { includeSelf: true } ), 11 ).to.equal( c );
  242. expect( foo.getCommonAncestor( d, { includeSelf: true } ), 12 ).to.equal( c );
  243. expect( c.getCommonAncestor( b, { includeSelf: true } ), 13 ).to.equal( b );
  244. expect( bom.getCommonAncestor( d, { includeSelf: true } ), 14 ).to.equal( a );
  245. expect( b.getCommonAncestor( bom, { includeSelf: true } ), 15 ).to.equal( a );
  246. expect( b.getCommonAncestor( bar, { includeSelf: true } ), 16 ).to.equal( b );
  247. } );
  248. it( 'should return document fragment', () => {
  249. const foo = new Text( 'foo' );
  250. const bar = new Text( 'bar' );
  251. const df = new DocumentFragment( [ foo, bar ] );
  252. expect( foo.getCommonAncestor( bar ) ).to.equal( df );
  253. } );
  254. } );
  255. describe( 'attributes interface', () => {
  256. const node = new Node( { foo: 'bar' } );
  257. describe( 'hasAttribute', () => {
  258. it( 'should return true if element contains attribute with given key', () => {
  259. expect( node.hasAttribute( 'foo' ) ).to.be.true;
  260. } );
  261. it( 'should return false if element does not contain attribute with given key', () => {
  262. expect( node.hasAttribute( 'bar' ) ).to.be.false;
  263. } );
  264. } );
  265. describe( 'getAttribute', () => {
  266. it( 'should return attribute value for given key if element contains given attribute', () => {
  267. expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' );
  268. } );
  269. it( 'should return undefined if element does not contain given attribute', () => {
  270. expect( node.getAttribute( 'bar' ) ).to.be.undefined;
  271. } );
  272. } );
  273. describe( 'getAttributes', () => {
  274. it( 'should return an iterator that iterates over all attributes set on the element', () => {
  275. expect( Array.from( node.getAttributes() ) ).to.deep.equal( [ [ 'foo', 'bar' ] ] );
  276. } );
  277. } );
  278. describe( '_setAttribute', () => {
  279. it( 'should set given attribute on the element', () => {
  280. node._setAttribute( 'foo', 'bar' );
  281. expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' );
  282. } );
  283. } );
  284. describe( '_setAttributesTo', () => {
  285. it( 'should remove all attributes set on element and set the given ones', () => {
  286. node._setAttribute( 'abc', 'xyz' );
  287. node._setAttributesTo( { foo: 'bar' } );
  288. expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' );
  289. expect( node.getAttribute( 'abc' ) ).to.be.undefined;
  290. } );
  291. } );
  292. describe( '_removeAttribute', () => {
  293. it( 'should remove attribute set on the element and return true', () => {
  294. node._setAttribute( 'foo', 'bar' );
  295. const result = node._removeAttribute( 'foo' );
  296. expect( node.getAttribute( 'foo' ) ).to.be.undefined;
  297. expect( result ).to.be.true;
  298. } );
  299. it( 'should return false if element does not contain given attribute', () => {
  300. const result = node._removeAttribute( 'foo' );
  301. expect( result ).to.be.false;
  302. } );
  303. } );
  304. describe( '_clearAttributes', () => {
  305. it( 'should remove all attributes from the element', () => {
  306. node._setAttribute( 'foo', 'bar' );
  307. node._setAttribute( 'abc', 'xyz' );
  308. node._clearAttributes();
  309. expect( node.getAttribute( 'foo' ) ).to.be.undefined;
  310. expect( node.getAttribute( 'abc' ) ).to.be.undefined;
  311. } );
  312. } );
  313. } );
  314. } );