node.js 14 KB

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