8
0

imagecaptionengine.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  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" data-placeholder="Enter image caption">' +
  86. 'Foo bar baz.' +
  87. '</figcaption>' +
  88. '</figure>'
  89. );
  90. } );
  91. it( 'should convert caption to element with proper CSS class if it\'s empty', () => {
  92. setModelData( document, '<image src="img.png"><caption></caption></image>' );
  93. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
  94. '<figure class="image ck-widget" contenteditable="false">' +
  95. '<img src="img.png"></img>' +
  96. '<figcaption class="ck-placeholder ck-editable ck-editable_hidden" contenteditable="true" data-placeholder="Enter image caption">' +
  97. '</figcaption>' +
  98. '</figure>'
  99. );
  100. } );
  101. it( 'should not convert caption from other elements', () => {
  102. setModelData( document, '<widget>foo bar<caption></caption></widget>' );
  103. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal( '<widget>foo bar</widget>' );
  104. } );
  105. it( 'should not convert when element is already consumed', () => {
  106. editor.editing.modelToView.on(
  107. 'insert:caption',
  108. ( evt, data, consumable, conversionApi ) => {
  109. consumable.consume( data.item, 'insert' );
  110. const imageFigure = conversionApi.mapper.toViewElement( data.range.start.parent );
  111. const viewElement = new ViewAttributeElement( 'span' );
  112. const viewPosition = ViewPosition.createAt( imageFigure, 'end' );
  113. conversionApi.mapper.bindElements( data.item, viewElement );
  114. viewWriter.insert( viewPosition, viewElement );
  115. },
  116. { priority: 'high' }
  117. );
  118. setModelData( document, '<image src="img.png"><caption>Foo bar baz.</caption></image>' );
  119. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
  120. '<figure class="image ck-widget" contenteditable="false"><img src="img.png"></img><span></span>Foo bar baz.</figure>'
  121. );
  122. } );
  123. } );
  124. } );
  125. describe( 'inserting image to document', () => {
  126. it( 'should add caption element if image does not have it', () => {
  127. const image = new ModelElement( 'image', { src: '', alt: '' } );
  128. const batch = document.batch();
  129. document.enqueueChanges( () => {
  130. batch.insert( new ModelPosition( document.getRoot(), [ 0 ] ), image );
  131. } );
  132. expect( getModelData( document ) ).to.equal(
  133. '[]<image alt="" src=""><caption></caption></image>'
  134. );
  135. expect( getViewData( viewDocument ) ).to.equal(
  136. '[]<figure class="image ck-widget" contenteditable="false">' +
  137. '<img alt="" src=""></img>' +
  138. '<figcaption class="ck-placeholder ck-editable ck-editable_hidden" contenteditable="true" data-placeholder="Enter image caption">' +
  139. '</figcaption>' +
  140. '</figure>'
  141. );
  142. } );
  143. it( 'should not add caption element if image already have it', () => {
  144. const caption = new ModelElement( 'caption', null, 'foo bar' );
  145. const image = new ModelElement( 'image', { src: '', alt: '' }, caption );
  146. const batch = document.batch();
  147. document.enqueueChanges( () => {
  148. batch.insert( new ModelPosition( document.getRoot(), [ 0 ] ), image );
  149. } );
  150. expect( getModelData( document ) ).to.equal(
  151. '[]<image alt="" src=""><caption>foo bar</caption></image>'
  152. );
  153. expect( getViewData( viewDocument ) ).to.equal(
  154. '[]<figure class="image ck-widget" contenteditable="false">' +
  155. '<img alt="" src=""></img>' +
  156. '<figcaption class="ck-editable" contenteditable="true" data-placeholder="Enter image caption">' +
  157. 'foo bar' +
  158. '</figcaption>' +
  159. '</figure>'
  160. );
  161. } );
  162. it( 'should do nothing for other changes than insert', () => {
  163. setModelData( document, '<image src=""><caption>foo bar</caption></image>' );
  164. const image = document.getRoot().getChild( 0 );
  165. const batch = document.batch();
  166. document.enqueueChanges( () => {
  167. batch.setAttribute( image, 'alt', 'alt text' );
  168. } );
  169. expect( getModelData( document, { withoutSelection: true } ) ).to.equal(
  170. '<image alt="alt text" src=""><caption>foo bar</caption></image>'
  171. );
  172. } );
  173. } );
  174. describe( 'editing view', () => {
  175. it( 'image should have empty figcaption element when is selected', () => {
  176. setModelData( document, '[<image src=""><caption></caption></image>]' );
  177. expect( getViewData( viewDocument ) ).to.equal(
  178. '[<figure class="image ck-widget ck-widget_selected" contenteditable="false">' +
  179. '<img src=""></img>' +
  180. '<figcaption class="ck-placeholder ck-editable" contenteditable="true" data-placeholder="Enter image caption">' +
  181. '</figcaption>' +
  182. '</figure>]'
  183. );
  184. } );
  185. it( 'image should have empty figcaption element with hidden class when not selected', () => {
  186. setModelData( document, '[]<image src=""><caption></caption></image>' );
  187. expect( getViewData( viewDocument ) ).to.equal(
  188. '[]<figure class="image ck-widget" contenteditable="false">' +
  189. '<img src=""></img>' +
  190. '<figcaption class="ck-placeholder ck-editable ck-editable_hidden" contenteditable="true" data-placeholder="Enter image caption">' +
  191. '</figcaption>' +
  192. '</figure>'
  193. );
  194. } );
  195. it( 'should not add additional figcaption if one is already present', () => {
  196. setModelData( document, '[<image src=""><caption>foo bar</caption></image>]' );
  197. expect( getViewData( viewDocument ) ).to.equal(
  198. '[<figure class="image ck-widget ck-widget_selected" contenteditable="false">' +
  199. '<img src=""></img>' +
  200. '<figcaption class="ck-editable" contenteditable="true" data-placeholder="Enter image caption">foo bar</figcaption>' +
  201. '</figure>]'
  202. );
  203. } );
  204. it( 'should add hidden class to figcaption when caption is empty and image is no longer selected', () => {
  205. setModelData( document, '[<image src=""><caption></caption></image>]' );
  206. document.enqueueChanges( () => {
  207. document.selection.removeAllRanges();
  208. } );
  209. expect( getViewData( viewDocument ) ).to.equal(
  210. '[]<figure class="image ck-widget" contenteditable="false">' +
  211. '<img src=""></img>' +
  212. '<figcaption class="ck-placeholder ck-editable ck-editable_hidden" contenteditable="true" data-placeholder="Enter image caption">' +
  213. '</figcaption>' +
  214. '</figure>'
  215. );
  216. } );
  217. it( 'should not remove figcaption when selection is inside it even when it is empty', () => {
  218. setModelData( document, '<image src=""><caption>[foo bar]</caption></image>' );
  219. document.enqueueChanges( () => {
  220. document.batch().remove( document.selection.getFirstRange() );
  221. } );
  222. expect( getViewData( viewDocument ) ).to.equal(
  223. '<figure class="image ck-widget" contenteditable="false">' +
  224. '<img src=""></img>' +
  225. '<figcaption class="ck-editable ck-placeholder" contenteditable="true" data-placeholder="Enter image caption">' +
  226. '[]' +
  227. '</figcaption>' +
  228. '</figure>'
  229. );
  230. } );
  231. it( 'should not remove figcaption when selection is moved from it to its image', () => {
  232. setModelData( document, '<image src=""><caption>[foo bar]</caption></image>' );
  233. const image = document.getRoot().getChild( 0 );
  234. document.enqueueChanges( () => {
  235. document.batch().remove( document.selection.getFirstRange() );
  236. document.selection.setRanges( [ ModelRange.createOn( image ) ] );
  237. } );
  238. expect( getViewData( viewDocument ) ).to.equal(
  239. '[<figure class="image ck-widget ck-widget_selected" contenteditable="false">' +
  240. '<img src=""></img>' +
  241. '<figcaption class="ck-editable ck-placeholder" contenteditable="true" data-placeholder="Enter image caption"></figcaption>' +
  242. '</figure>]'
  243. );
  244. } );
  245. it( 'should not remove figcaption when selection is moved from it to other image', () => {
  246. setModelData( document, '<image src=""><caption>[foo bar]</caption></image><image src=""><caption></caption></image>' );
  247. const image = document.getRoot().getChild( 1 );
  248. document.enqueueChanges( () => {
  249. document.selection.setRanges( [ ModelRange.createOn( image ) ] );
  250. } );
  251. expect( getViewData( viewDocument ) ).to.equal(
  252. '<figure class="image ck-widget" contenteditable="false">' +
  253. '<img src=""></img>' +
  254. '<figcaption class="ck-editable" contenteditable="true" data-placeholder="Enter image caption">foo bar</figcaption>' +
  255. '</figure>' +
  256. '[<figure class="image ck-widget ck-widget_selected" contenteditable="false">' +
  257. '<img src=""></img>' +
  258. '<figcaption class="ck-placeholder ck-editable" contenteditable="true" data-placeholder="Enter image caption"></figcaption>' +
  259. '</figure>]'
  260. );
  261. } );
  262. describe( 'undo/redo integration', () => {
  263. it( 'should create view element after redo', () => {
  264. setModelData( document, '<image src=""><caption>[foo bar baz]</caption></image>' );
  265. const modelRoot = document.getRoot();
  266. const modelImage = modelRoot.getChild( 0 );
  267. const modelCaption = modelImage.getChild( 0 );
  268. // Remove text and selection from caption.
  269. document.enqueueChanges( () => {
  270. const batch = document.batch();
  271. batch.remove( ModelRange.createIn( modelCaption ) );
  272. document.selection.removeAllRanges();
  273. } );
  274. // Check if there is no figcaption in the view.
  275. expect( getViewData( viewDocument ) ).to.equal(
  276. '[]<figure class="image ck-widget" contenteditable="false">' +
  277. '<img src=""></img>' +
  278. '<figcaption class="ck-editable ck-editable_hidden ck-placeholder" contenteditable="true" data-placeholder="Enter image caption">' +
  279. '</figcaption>' +
  280. '</figure>'
  281. );
  282. editor.execute( 'undo' );
  283. // Check if figcaption is back with contents.
  284. expect( getViewData( viewDocument ) ).to.equal(
  285. '<figure class="image ck-widget" contenteditable="false">' +
  286. '<img src=""></img>' +
  287. '<figcaption class="ck-editable" contenteditable="true" data-placeholder="Enter image caption">' +
  288. '{foo bar baz}' +
  289. '</figcaption>' +
  290. '</figure>'
  291. );
  292. } );
  293. it( 'undo should work after inserting the image', () => {
  294. const image = new ModelElement( 'image' );
  295. setModelData( document, '[]' );
  296. document.enqueueChanges( () => {
  297. const batch = document.batch();
  298. batch.insert( document.selection.anchor, image );
  299. } );
  300. editor.execute( 'undo' );
  301. expect( getModelData( document ) ).to.equal(
  302. '[]'
  303. );
  304. } );
  305. } );
  306. } );
  307. } );