imagecaptionengine.js 14 KB

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