imagecaptionengine.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  6. import ViewAttributeElement from '@ckeditor/ckeditor5-engine/src/view/attributeelement';
  7. import ViewPosition from '@ckeditor/ckeditor5-engine/src/view/position';
  8. import viewWriter from '@ckeditor/ckeditor5-engine/src/view/writer';
  9. import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
  10. import ModelRange from '@ckeditor/ckeditor5-engine/src/model/range';
  11. import ModelPosition from '@ckeditor/ckeditor5-engine/src/model/position';
  12. import ImageCaptionEngine from '../../src/imagecaption/imagecaptionengine';
  13. import ImageEngine from '../../src/image/imageengine';
  14. import UndoEngine from '@ckeditor/ckeditor5-undo/src/undoengine';
  15. import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  16. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  17. import buildViewConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildviewconverter';
  18. import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter';
  19. describe( 'ImageCaptionEngine', () => {
  20. let editor, document, viewDocument;
  21. beforeEach( () => {
  22. return VirtualTestEditor.create( {
  23. plugins: [ ImageCaptionEngine, ImageEngine, UndoEngine ]
  24. } )
  25. .then( newEditor => {
  26. editor = newEditor;
  27. document = editor.document;
  28. viewDocument = editor.editing.view;
  29. document.schema.registerItem( 'widget' );
  30. document.schema.allow( { name: 'widget', inside: '$root' } );
  31. document.schema.allow( { name: 'caption', inside: 'widget' } );
  32. document.schema.allow( { name: '$inline', inside: 'widget' } );
  33. buildViewConverter().for( editor.data.viewToModel ).fromElement( 'widget' ).toElement( 'widget' );
  34. buildModelConverter().for( editor.data.modelToView, editor.editing.modelToView ).fromElement( 'widget' ).toElement( 'widget' );
  35. } );
  36. } );
  37. it( 'should be loaded', () => {
  38. expect( editor.plugins.get( ImageCaptionEngine ) ).to.be.instanceOf( ImageCaptionEngine );
  39. } );
  40. it( 'should set proper schema rules', () => {
  41. expect( document.schema.check( { name: 'caption', iniside: 'image' } ) ).to.be.true;
  42. expect( document.schema.check( { name: '$inline', inside: 'caption' } ) ).to.be.true;
  43. expect( document.schema.limits.has( 'caption' ) );
  44. } );
  45. describe( 'data pipeline', () => {
  46. describe( 'view to model', () => {
  47. it( 'should convert figcaption inside image figure', () => {
  48. editor.setData( '<figure class="image"><img src="foo.png"/><figcaption>foo bar</figcaption></figure>' );
  49. expect( getModelData( document, { withoutSelection: true } ) )
  50. .to.equal( '<image src="foo.png"><caption>foo bar</caption></image>' );
  51. } );
  52. it( 'should add empty caption if there is no figcaption', () => {
  53. editor.setData( '<figure class="image"><img src="foo.png"/></figure>' );
  54. expect( getModelData( document, { withoutSelection: true } ) )
  55. .to.equal( '<image src="foo.png"><caption></caption></image>' );
  56. } );
  57. it( 'should not convert figcaption inside other elements than image', () => {
  58. editor.setData( '<widget><figcaption>foobar</figcaption></widget>' );
  59. expect( getModelData( document, { withoutSelection: true } ) )
  60. .to.equal( '<widget>foobar</widget>' );
  61. } );
  62. } );
  63. describe( 'model to view', () => {
  64. it( 'should convert caption element to figcaption', () => {
  65. setModelData( document, '<image src="img.png"><caption>Foo bar baz.</caption></image>' );
  66. expect( editor.getData() ).to.equal( '<figure class="image"><img src="img.png"><figcaption>Foo bar baz.</figcaption></figure>' );
  67. } );
  68. it( 'should convert caption to figcaption with hidden class if it\'s empty', () => {
  69. setModelData( document, '<image src="img.png"><caption></caption></image>' );
  70. expect( editor.getData() ).to.equal( '<figure class="image"><img src="img.png"></figure>' );
  71. } );
  72. it( 'should not convert caption from other elements', () => {
  73. setModelData( document, '<widget>foo bar<caption></caption></widget>' );
  74. expect( editor.getData() ).to.equal( '<widget>foo bar</widget>' );
  75. } );
  76. } );
  77. } );
  78. describe( 'editing pipeline', () => {
  79. describe( 'model to view', () => {
  80. it( 'should convert caption element to figcaption contenteditable', () => {
  81. setModelData( document, '<image src="img.png"><caption>Foo bar baz.</caption></image>' );
  82. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
  83. '<figure class="image ck-widget" contenteditable="false">' +
  84. '<img src="img.png"></img>' +
  85. '<figcaption class="ck-editable" contenteditable="true">Foo bar baz.</figcaption>' +
  86. '</figure>'
  87. );
  88. } );
  89. it( 'should convert caption to element with proper CSS class if it\'s empty', () => {
  90. setModelData( document, '<image src="img.png"><caption></caption></image>' );
  91. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
  92. '<figure class="image ck-widget" contenteditable="false">' +
  93. '<img src="img.png"></img>' +
  94. '<figcaption class="ck-editable ck-hidden" contenteditable="true"></figcaption>' +
  95. '</figure>'
  96. );
  97. } );
  98. it( 'should not convert caption from other elements', () => {
  99. setModelData( document, '<widget>foo bar<caption></caption></widget>' );
  100. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal( '<widget>foo bar</widget>' );
  101. } );
  102. it( 'should not convert when element is already consumed', () => {
  103. editor.editing.modelToView.on(
  104. 'insert:caption',
  105. ( evt, data, consumable, conversionApi ) => {
  106. consumable.consume( data.item, 'insert' );
  107. const imageFigure = conversionApi.mapper.toViewElement( data.range.start.parent );
  108. const viewElement = new ViewAttributeElement( 'span' );
  109. const viewPosition = ViewPosition.createAt( imageFigure, 'end' );
  110. conversionApi.mapper.bindElements( data.item, viewElement );
  111. viewWriter.insert( viewPosition, viewElement );
  112. },
  113. { priority: 'high' }
  114. );
  115. setModelData( document, '<image src="img.png"><caption>Foo bar baz.</caption></image>' );
  116. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
  117. '<figure class="image ck-widget" contenteditable="false"><img src="img.png"></img><span></span>Foo bar baz.</figure>'
  118. );
  119. } );
  120. it( 'should show caption when something is inserted inside', () => {
  121. setModelData( document, '<image src="img.png"><caption></caption></image>' );
  122. const image = document.getRoot().getChild( 0 );
  123. const caption = image.getChild( 0 );
  124. document.enqueueChanges( () => {
  125. const batch = document.batch();
  126. batch.insert( ModelPosition.createAt( caption ), 'foo bar' );
  127. } );
  128. expect( getViewData( viewDocument ) ).to.equal(
  129. '[]<figure class="image ck-widget" contenteditable="false">' +
  130. '<img src="img.png"></img>' +
  131. '<figcaption class="ck-editable" contenteditable="true">foo bar</figcaption>' +
  132. '</figure>'
  133. );
  134. } );
  135. it( 'should hide when everything is removed from caption', () => {
  136. setModelData( document, '<image src="img.png"><caption>foo bar baz</caption></image>' );
  137. const image = document.getRoot().getChild( 0 );
  138. const caption = image.getChild( 0 );
  139. document.enqueueChanges( () => {
  140. const batch = document.batch();
  141. batch.remove( ModelRange.createIn( caption ) );
  142. } );
  143. expect( getViewData( viewDocument ) ).to.equal(
  144. '[]<figure class="image ck-widget" contenteditable="false">' +
  145. '<img src="img.png"></img>' +
  146. '<figcaption class="ck-editable ck-hidden" contenteditable="true"></figcaption>' +
  147. '</figure>'
  148. );
  149. } );
  150. } );
  151. } );
  152. describe( 'inserting image to document', () => {
  153. it( 'should add caption element if image does not have it', () => {
  154. const image = new ModelElement( 'image', { src: '', alt: '' } );
  155. const batch = document.batch();
  156. document.enqueueChanges( () => {
  157. batch.insert( new ModelPosition( document.getRoot(), [ 0 ] ), image );
  158. } );
  159. expect( getModelData( document ) ).to.equal(
  160. '[]<image alt="" src=""><caption></caption></image>'
  161. );
  162. expect( getViewData( viewDocument ) ).to.equal(
  163. '[]<figure class="image ck-widget" contenteditable="false">' +
  164. '<img alt="" src=""></img>' +
  165. '<figcaption class="ck-editable ck-hidden" contenteditable="true"></figcaption>' +
  166. '</figure>'
  167. );
  168. } );
  169. it( 'should not add caption element if image already have it', () => {
  170. const caption = new ModelElement( 'caption', null, 'foo bar' );
  171. const image = new ModelElement( 'image', { src: '', alt: '' }, caption );
  172. const batch = document.batch();
  173. document.enqueueChanges( () => {
  174. batch.insert( new ModelPosition( document.getRoot(), [ 0 ] ), image );
  175. } );
  176. expect( getModelData( document ) ).to.equal(
  177. '[]<image alt="" src=""><caption>foo bar</caption></image>'
  178. );
  179. expect( getViewData( viewDocument ) ).to.equal(
  180. '[]<figure class="image ck-widget" contenteditable="false">' +
  181. '<img alt="" src=""></img>' +
  182. '<figcaption class="ck-editable" contenteditable="true">foo bar</figcaption>' +
  183. '</figure>'
  184. );
  185. } );
  186. it( 'should do nothing for other changes than insert', () => {
  187. setModelData( document, '<image src=""><caption>foo bar</caption></image>' );
  188. const image = document.getRoot().getChild( 0 );
  189. const batch = document.batch();
  190. document.enqueueChanges( () => {
  191. batch.setAttribute( image, 'alt', 'alt text' );
  192. } );
  193. expect( getModelData( document, { withoutSelection: true } ) ).to.equal(
  194. '<image alt="alt text" src=""><caption>foo bar</caption></image>'
  195. );
  196. } );
  197. } );
  198. describe( 'editing view', () => {
  199. it( 'image should have empty figcaption element when is selected', () => {
  200. setModelData( document, '[<image src=""><caption></caption></image>]' );
  201. expect( getViewData( viewDocument ) ).to.equal(
  202. '[<figure class="image ck-widget ck-widget_selected" contenteditable="false">' +
  203. '<img src=""></img>' +
  204. '<figcaption class="ck-editable" contenteditable="true"></figcaption>' +
  205. '</figure>]'
  206. );
  207. } );
  208. it( 'image should have empty figcaption element with hidden class when not selected', () => {
  209. setModelData( document, '[]<image src=""><caption></caption></image>' );
  210. expect( getViewData( viewDocument ) ).to.equal(
  211. '[]<figure class="image ck-widget" contenteditable="false">' +
  212. '<img src=""></img>' +
  213. '<figcaption class="ck-editable ck-hidden" contenteditable="true"></figcaption>' +
  214. '</figure>'
  215. );
  216. } );
  217. it( 'should not add additional figcaption if one is already present', () => {
  218. setModelData( document, '[<image src=""><caption>foo bar</caption></image>]' );
  219. expect( getViewData( viewDocument ) ).to.equal(
  220. '[<figure class="image ck-widget ck-widget_selected" contenteditable="false">' +
  221. '<img src=""></img>' +
  222. '<figcaption class="ck-editable" contenteditable="true">foo bar</figcaption>' +
  223. '</figure>]'
  224. );
  225. } );
  226. it( 'should add hidden class to figcaption when caption is empty and image is no longer selected', () => {
  227. setModelData( document, '[<image src=""><caption></caption></image>]' );
  228. document.enqueueChanges( () => {
  229. document.selection.removeAllRanges();
  230. } );
  231. expect( getViewData( viewDocument ) ).to.equal(
  232. '[]<figure class="image ck-widget" contenteditable="false">' +
  233. '<img src=""></img>' +
  234. '<figcaption class="ck-editable ck-hidden" contenteditable="true"></figcaption>' +
  235. '</figure>'
  236. );
  237. } );
  238. it( 'should not remove figcaption when selection is inside it even when it is empty', () => {
  239. setModelData( document, '<image src=""><caption>[foo bar]</caption></image>' );
  240. document.enqueueChanges( () => {
  241. document.batch().remove( document.selection.getFirstRange() );
  242. } );
  243. expect( getViewData( viewDocument ) ).to.equal(
  244. '<figure class="image ck-widget" contenteditable="false">' +
  245. '<img src=""></img>' +
  246. '<figcaption class="ck-editable" contenteditable="true">[]</figcaption>' +
  247. '</figure>'
  248. );
  249. } );
  250. it( 'should not remove figcaption when selection is moved from it to its image', () => {
  251. setModelData( document, '<image src=""><caption>[foo bar]</caption></image>' );
  252. const image = document.getRoot().getChild( 0 );
  253. document.enqueueChanges( () => {
  254. document.batch().remove( document.selection.getFirstRange() );
  255. document.selection.setRanges( [ ModelRange.createOn( image ) ] );
  256. } );
  257. expect( getViewData( viewDocument ) ).to.equal(
  258. '[<figure class="image ck-widget ck-widget_selected" contenteditable="false">' +
  259. '<img src=""></img>' +
  260. '<figcaption class="ck-editable" contenteditable="true"></figcaption>' +
  261. '</figure>]'
  262. );
  263. } );
  264. it( 'should not remove figcaption when selection is moved from it to other image', () => {
  265. setModelData( document, '<image src=""><caption>[foo bar]</caption></image><image src=""><caption></caption></image>' );
  266. const image = document.getRoot().getChild( 1 );
  267. document.enqueueChanges( () => {
  268. document.selection.setRanges( [ ModelRange.createOn( image ) ] );
  269. } );
  270. expect( getViewData( viewDocument ) ).to.equal(
  271. '<figure class="image ck-widget" contenteditable="false">' +
  272. '<img src=""></img>' +
  273. '<figcaption class="ck-editable" contenteditable="true">foo bar</figcaption>' +
  274. '</figure>' +
  275. '[<figure class="image ck-widget ck-widget_selected" contenteditable="false">' +
  276. '<img src=""></img>' +
  277. '<figcaption class="ck-editable" contenteditable="true"></figcaption>' +
  278. '</figure>]'
  279. );
  280. } );
  281. describe( 'undo/redo integration', () => {
  282. it( 'should create view element after redo', () => {
  283. setModelData( document, '<image src=""><caption>[foo bar baz]</caption></image>' );
  284. const modelRoot = document.getRoot();
  285. const modelImage = modelRoot.getChild( 0 );
  286. const modelCaption = modelImage.getChild( 0 );
  287. // Remove text and selection from caption.
  288. document.enqueueChanges( () => {
  289. const batch = document.batch();
  290. batch.remove( ModelRange.createIn( modelCaption ) );
  291. document.selection.removeAllRanges();
  292. } );
  293. // Check if there is no figcaption in the view.
  294. expect( getViewData( viewDocument ) ).to.equal(
  295. '[]<figure class="image ck-widget" contenteditable="false">' +
  296. '<img src=""></img>' +
  297. '<figcaption class="ck-editable ck-hidden" contenteditable="true"></figcaption>' +
  298. '</figure>'
  299. );
  300. editor.execute( 'undo' );
  301. // Check if figcaption is back with contents.
  302. expect( getViewData( viewDocument ) ).to.equal(
  303. '<figure class="image ck-widget" contenteditable="false">' +
  304. '<img src=""></img>' +
  305. '<figcaption class="ck-editable" contenteditable="true">{foo bar baz}</figcaption>' +
  306. '</figure>'
  307. );
  308. } );
  309. it( 'undo should work after inserting the image', () => {
  310. const image = new ModelElement( 'image' );
  311. setModelData( document, '[]' );
  312. document.enqueueChanges( () => {
  313. const batch = document.batch();
  314. batch.insert( document.selection.anchor, image );
  315. } );
  316. editor.execute( 'undo' );
  317. expect( getModelData( document ) ).to.equal(
  318. '[]'
  319. );
  320. } );
  321. } );
  322. } );
  323. } );